Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shreyanjain9/xrpc
A small library for working with XRPC requests from Ruby, designed for use as part of Bskyrb
https://github.com/shreyanjain9/xrpc
atproto bluesky xrpc
Last synced: about 2 months ago
JSON representation
A small library for working with XRPC requests from Ruby, designed for use as part of Bskyrb
- Host: GitHub
- URL: https://github.com/shreyanjain9/xrpc
- Owner: ShreyanJain9
- License: mit
- Created: 2023-05-15T04:26:47.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-03-01T17:03:15.000Z (10 months ago)
- Last Synced: 2024-11-16T22:56:30.954Z (about 2 months ago)
- Topics: atproto, bluesky, xrpc
- Language: Ruby
- Homepage: https://github.com/ShreyanJain9/bskyrb
- Size: 402 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# XRPC
This Gem provides the ability to use BlueSky's XRPC from Ruby! :)
It's designed for use as a part of Bskyrb, but can be used independently, since there's nothing Bskyrb-specific in it.
## Installation
Install the gem and add to the application's Gemfile by executing:
$ bundle add xrpc
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install xrpc
## What is XRPC?
Learn at the [AT Protocol docs](https://atproto.com/specs/xrpc).
## Usage
The below is an example of how to use this XRPC Ruby library to resolve BlueSky handles to DIDs.
```ruby
bluesky = XRPC::Client.new("https://bsky.social")
bluesky.get.com.atproto.identity.resolveHandle[handle: "shreyan.bsky.social"]
```
## 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 `bash ./install-local.sh`. To release a new version, run `bash ./deploy.sh`, which will update the version number in `version.rb` and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/ShreyanJain9/xrpc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ShreyanJain9/xrpc/blob/master/CODE_OF_CONDUCT.md).
## 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 Bskyrb codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ShreyanJain9/xrpc/blob/master/CODE_OF_CONDUCT.md).