Repository navigation
Update README.md file
#3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,25 +1,56 @@ | ||
| # Foobara::RubyGemsApi | ||
|
|
||
| Provides commands that invoke the rubygems.org REST HTTP API endpoints. | ||
| `foobara-ruby-gems-api` provides Foobara commands that invoke the RubyGems.org REST API endpoints. | ||
|
|
||
| ## Installation | ||
|
|
||
| TODO | ||
| 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. | ||
|
|
||
| ## Usage | ||
|
|
||
| TODO | ||
| Require the library and run one of its commands. | ||
|
|
||
| For example to fetch details about a given gem, run the command below: | ||
|
|
||
| ```ruby | ||
| require "foobara/ruby_gems_api" | ||
|
|
||
| outcome = Foobara::RubyGemsApi::GetGem.run(gem_name: "rake") | ||
|
|
||
| ## Development | ||
| if outcome.success? | ||
| gem_details = outcome.result | ||
| puts "#{gem_details.name}, #{gem_details.version}, (#{gem_details.downloads} downloads)" | ||
| else | ||
| puts "Failed: #{outcome.errors_hash}" | ||
| end | ||
| ``` | ||
|
|
||
| TODO | ||
| The above code will output the current version and download numbers for the `rake` gem. | ||
|
|
||
| ### Some available commands are: | ||
|
|
||
| | 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 | | ||
|
|
||
| ## Contributing | ||
|
|
||
| Bug reports and pull requests are welcome on GitHub | ||
| at https://github.com/[USERNAME]/foobara-empty_ruby_project_generator. | ||
| Bug reports and pull requests are always welcome at [foobara/ruby-gems-api](https://github.com/foobara/ruby-gems-api/). | ||
|
|
||
| To work on an existing issue or submit a Pull Request: | ||
|
|
||
| 1. Fork the repository and clone it to your local machine | ||
| 2. Run `bundle install` to install dependencies | ||
| 3. Run `rake` to ensure that everything works as expected before making any changes. | ||
| 4. Implement your changes | ||
| 5. Re-run `rake` to make sure that all tests and Rubocop pass | ||
| 6. Commit your changes, push to GitHub and open a Pull Request for review | ||
|
|
||
| ## License | ||
|
|
||
| The files in this project are licensed under the | ||
| Mozilla Public License Version 2.0. Please see LICENSE.txt for more info. | ||
| This project is licensed under the MPL-2.0 license. Please see [LICENSE.txt](LICENSE.txt) for more information. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not something we should do in this PR, but perhaps we could instead put a line of code here that automatically outputs this info.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure what this meant. When i was going through the commands, i don't remember seeing one which outputs all that info at once.
The stuff i included in the table was gotten from reading the source code if i remember coreectly