foobara-ruby-gems-api provides Foobara commands that invoke the RubyGems.org REST API endpoints.
Add gem "foobara-ruby-gems-api" to your Gemfile or .gemspec file and bundle install.
Or even just gem install foobara-ruby-gems-api if just playing with it directly in the scripts.
Require the library and run one of its commands.
For example to fetch details about a given gem, run the command below:
require "foobara/ruby_gems_api"
outcome = Foobara::RubyGemsApi::GetGem.run(gem_name: "rake")
if outcome.success?
gem_details = outcome.result
puts "#{gem_details.name}, #{gem_details.version}, (#{gem_details.downloads} downloads)"
else
puts "Failed: #{outcome.errors_hash}"
endThe above code will output the current version and download numbers for the rake gem.
| Command | Required input | RubyGems.org endpoint | Result |
|---|---|---|---|
Foobara::RubyGemsApi::Search |
query |
/api/v1/search.json |
Array of Gem models |
Foobara::RubyGemsApi::GetGem |
gem_name |
/api/v1/gems/{gem_name}.json |
Gem model |
Foobara::RubyGemsApi::GetVersions |
gem_name |
/api/v1/versions/{gem_name}.json |
Array of Version models |
Foobara::RubyGemsApi::GetOwners |
gem_name |
/api/v1/gems/{gem_name}/owners.json |
Array of User models |
Bug reports and pull requests are always welcome at foobara/ruby-gems-api.
To work on an existing issue or submit a Pull Request:
- Fork the repository and clone it to your local machine
- Run
bundle installto install dependencies - Run
raketo ensure that everything works as expected before making any changes. - Implement your changes
- Re-run
raketo make sure that all tests and Rubocop pass - Commit your changes, push to GitHub and open a Pull Request for review
This project is licensed under the MPL-2.0 license. Please see LICENSE.txt for more information.