atproto_api 0.2.0

A simple ATProto implementation in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

> [!NOTE]
> This code is mostly useable. A few things are missing, like `.post()` and some other minor methods, but the majority is complete. 

# atproto_api
[![Crates.io](https://img.shields.io/crates/v/atproto_api)](https://crates.io/crates/atproto_api)

A simple [ATProto](https://atproto.com) implementation in Rust

## `AtpAgent`
`AtpAgent` is meant for general AT Protocol operations.

### Initialization
It can be initialized like this:

<!--1. [`default()`](https://git.sr.ht/~jordanreger/atproto_api/tree/main/item/examples/default.rs)
```rs
use atproto_api::{Agent, AtpAgent};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
  let agent = AtpAgent::default();

  println!("{:?}", agent);

  Ok(())
}

// AtpAgent { service: "https://bsky.social/", session: None }
```
2. [`new()`](https://git.sr.ht/~jordanreger/atproto_api/tree/main/item/examples/new.rs)-->
```rs
#[macro_use]
extern crate dotenv_codegen;
use serde_json::json
use atproto_api::{Agent, AtpAgent};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
  let agent = AtpAgent::new("https://fjall.net".to_string());

  println!("{:?}", agent);

  Ok(())
}

// AtpAgent { service: "https://fjall.net/", session: None }
```

### Get request
You can perform a get request by doing the following:
```rs
// macros
use dotenv_codegen::dotenv;
use serde_json::json;

use atproto_api::{Agent, AtpAgent};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
  let agent = AtpAgent::new("https://bsky.social".to_string());

  let agent = agent
    .login(
      dotenv!("BLUESKY_IDENTIFIER").to_string(),
      dotenv!("BLUESKY_PASSWORD").to_string(),
    )
    .await?;

  let record = json!({
    "repo": "fjall.net",
    "collection": "app.bsky.feed.post",
    "rkey": "3k653jvvxlw2v"
  });

  let res = agent
    .get("com.atproto.repo.getRecord".to_string(), record)
    .await?;

  println!("{:?}", res);

  Ok(())
}
```

The first parameter is a [lexicon](https://atproto.com/guides/lexicon), the specific ones you can view by scrolling down to the bottom of the page and looking through the "Lexicons" section. The second parameter is a record, which is a JSON object that contains the other important information (in the case of `com.atproto.repo.getRecord`, that's `repo`, `collection`, and `rkey`).


## `BskyAgent`
> [!NOTE]
> `BskyAgent` is currently on the backburner, as it's a superset of `AtpAgent`. If for some reason you're using this library *now*, please use `AtpAgent` instead of `BskyAgent` for the time being.


## License
This code is licensed under the BSD 3-Clause license. You can view the license [here](https://git.sr.ht/~jordanreger/atproto_api/tree/main/item/LICENSE).