Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shreyanjain9/bskyrb

Ruby Gem for interacting with BlueSky/AT Protocol
https://github.com/shreyanjain9/bskyrb

atproto atprotocol bluesky ruby

Last synced: 14 days ago
JSON representation

Ruby Gem for interacting with BlueSky/AT Protocol

Awesome Lists containing this project

README 

        
# Bskyrb

![](https://img.shields.io/github/actions/workflow/status/ShreyanJain9/bskyrb/ruby.yml?style=plastic)



- [Installation](#installation)

- [Usage](#usage)

- [Development](#development)

- [Code generation](#code-generation)

  - [Type checking](#type-checking)

  - [Tests](#tests)

  - [Formatting](#formatting)

- [Contributing](#contributing)

  - [TODO](#todo)

- [Contributors](#contributors)

- [License](#license)

- [Code of Conduct](#code-of-conduct)



## Installation



Install the gem and add to the application's Gemfile by executing:



    $ bundle add bskyrb



If bundler is not being used to manage dependencies, install the gem by executing:



    $ gem install bskyrb

    

You can also install the gem by cloning this repository and running `./install-local.sh`.



## Usage



Create a new session:



```ruby

require 'bskyrb'

username = 'your_username'

password = 'your_password'

pds_url = 'https://bsky.social'



credentials = Bskyrb::Credentials.new(username, password)

session = Bskyrb::Session.new(credentials, pds_url)

bsky = Bskyrb::RecordManager.new(session)

post_uri = bsky.create_post("Hello world from bskyrb!")["uri"]

bsky.like(post_uri)

bsky.repost(post_uri)

bsky.create_reply(post_uri, "Replying to post from bskyrb")

```



## Development



After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.



To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, run `./deploy.sh` and you will be guided through updating the version number, bundling the gem, and pushing it to RubyGems. You must be signed in with a RubyGems account that has push access to bskyrb.



And configure the type checker:



## Code generation



We are working on a script to generate classes from the atproto lexicon. So far we have made non-query objects. To recreate them:



```

git submodule add https://github.com/bluesky-social/atproto.git

# or just clone it!

bin/codegen

```



This crawls the lexicon directory in your newly-cloned atproto repo, and generates formatted classes based on the json schemas embedded in the files. You can then hydrate them like so:



```ruby

# make your RecordManager, then...



post_by_url = manager.get_post_by_url("https://staging.bsky.app/profile/naia.bsky.social/post/3jszsrnruws27")



my_post = Bskyrb::AppBskyFeedDefs::PostView.from_hash post_by_url["thread"]["post"]



=>

#"did:plc:scx5mrfxxrqlfzkjcpbt3xfr",

   "handle"=>"naia.bsky.social",

   "displayName"=>"naia",

   "avatar"=>

    "https://cdn.bsky.social/imgproxy/0uv5pCOimHKw44PfnCt5_XpnOICHz1KeHCl8dknI_ZY/rs:fill:1000:1000:1:0/plain/bafkreibabes4xznjzdwxqj4hzirg7lofhl2detvabroibakewssfkr

      "alt"=>""}]},

 @indexedAt="2023-04-10T16:51:21.391Z",

 @labels=[],

 @likeCount=27,

 @record=

  {"text"=>"gm from the new deck chair i built yesterday\n\nthe sky is very blue",

   "$type"=>"app.bsky.feed.post",

   "embed"=>

    {"$type"=>"app.bsky.embed.images",

     "images"=>

      [{"alt"=>"",

        "image"=>{"$type"=>"blob", "ref"=>{"$link"=>"bafkreif52k6kev6xgy2ydptub5oryss3gsscajrec6zh5r2els4si2yj7i"}, "mimeType"=>"image/jpeg", "size"=>796921}}]},

   "createdAt"=>"2023-04-10T16:51:21.049Z"},

 @replyCount=4,

 @repostCount=2,

 @uri="at://did:plc:scx5mrfxxrqlfzkjcpbt3xfr/app.bsky.feed.post/3jszsrnruws27",

 @viewer={}>

```



Next steps:



- Recursion--hydrate the classes embedded in the classes. Some parsing to enable this already happens in `LexiconParser`.

- Generate classes for queries and other unusual object types.

- Integrate our new classes into the API call methods.



### Type checking



bskyrb uses [.rbs type definitions](https://github.com/ruby/rbs). To check for accuracy, run `bin/typecheck`. Not all of the output will be useful, especially during rapid development, but it is a good idea to have types at least for the bluesky objects.



Use the [`rbs collection` tool](https://github.com/ruby/rbs/blob/master/docs/collection.md) to manage definitions for third-party dependencies, for example HTTParty. Use `bundle exec rbs collection install` to download third-party definitions (**you will need to do this before `bin/typecheck` will work**).



### Tests



Run the test suite with:



    $ bundle exec rake test



### Formatting



So nobody has to argue about formatting, bskyrb uses the `standard` gem. Run `bin/format` to format the code in this repo.



## Contributing



Please do!



### TODO



- Build

- More/better tests

- (Eventually) Publish/release pipeline

- Split into separate modules for XRPC, Lexicon, ATProto, etc



## Contributors





  




## License



The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).



## Code of Conduct



Everyone interacting in the Bskyrb project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/bskyrb/blob/master/CODE_OF_CONDUCT.md).