Gems
====
Ruby wrapper for the RubyGems.org API.
Installation
------------
gem install gems
Documentation
-------------
[http://rdoc.info/gems/gems](http://rdoc.info/gems/gems)
Continuous Integration
----------------------
[](http://travis-ci.org/rubygems/gems)
Usage Examples
--------------
require 'rubygems'
require 'gems'
# Returns some basic information about rails.
puts Gems.info 'rails'
# Returns an array of active gems that match the query.
puts Gems.search 'cucumber'
# Returns an array of version details for coulda.
puts Gems.versions 'coulda'
# Returns the total number of downloads for rails_admin 0.0.0.
# Defaults to the latest version if no version is specified.
# Defaults to RubyGems.org if no gem name is specified.
puts Gems.downloads 'rails_admin', '0.0.0'
# Returns the number of downloads by day for coulda 0.6.3 for the past 90 days.
# Defaults to the latest version if no version is specified.
puts Gems.downloads 'coulda', '0.6.3'
# Returns the number of downloads by day for coulda 0.6.3 for the past year.
puts Gems.downloads 'coulda', '0.6.3', Date.today - 365, Date.today
# Returns an array of gem dependency details for all versions of all the given gems.
puts Gems.dependencies ['rails', 'thor']
# Retrieve your API key using HTTP basic authentication.
Gems.configure do |config|
config.username = 'nick@gemcutter.org'
config.password = 'schwwwwing'
end
puts Gems.api_key
# The following methods require authentication.
# By default, we load your API key from ~/.gem/credentails
# You can override this default by specifying a custom API key.
Gems.configure do |config|
config.key '701243f217cdf23b1370c7b66b65ca97'
end
# List all gems that you own.
puts Gems.gems
# View all owners of a gem that you own.
puts Gems.owners 'gemcutter'
# Add an owner to a RubyGem you own, giving that user permission to manage it.
Gems.add_owner 'josh@technicalpickles.com', 'gemcutter'
# Remove a user's permission to manage a RubyGem you own.
Gems.remove_owner 'josh@technicalpickles.com', 'gemcutter'
# List the webhooks registered under your account.
puts Gems.web_hooks
# Add a webhook.
Gems.add_web_hook 'rails', 'http://example.com'
# Remove a webhook.
Gems.remove_web_hook 'rails', 'http://example.com'
# Test fire a webhook.
Gems.fire_web_hook 'rails', 'http://example.com'
# Submit a gem to RubyGems.org.
Gems.push File.new 'gemcutter-0.2.1.gem'
# Remove a gem from RubyGems.org's index.
# Defaults to the latest version if no version is specified.
Gems.yank 'bills', '0.0.1'
# Update a previously yanked gem back into RubyGems.org's index.
# Defaults to the latest version if no version is specified.
Gems.unyank 'bills', '0.0.1'
Contributing
------------
In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.
Here are some ways *you* can contribute:
* by using alpha, beta, and prerelease versions
* by reporting bugs
* by suggesting new features
* by writing or editing documentation
* by writing specifications
* by writing code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace)
* by refactoring code
* by closing [issues](https://github.com/rubygems/gems/issues)
* by reviewing patches
Submitting an Issue
-------------------
We use the [GitHub issue tracker](https://github.com/rubygems/gems/issues) to track bugs and
features. Before submitting a bug report or feature request, check to make sure it hasn't already
been submitted. You can indicate support for an existing issuse by voting it up. When submitting a
bug report, please include a [Gist](https://gist.github.com/) that includes a stack trace and any
details that may be necessary to reproduce the bug, including your gem version, Ruby version, and
operating system. Ideally, a bug report should include a pull request with failing specs.
Submitting a Pull Request
-------------------------
1. Fork the project.
2. Create a topic branch.
3. Implement your feature or bug fix.
4. Add documentation for your feature or bug fix.
5. Run bundle exec rake doc:yard. If your changes are not 100% documented, go back to step 4.
6. Add specs for your feature or bug fix.
7. Run bundle exec rake spec. If your changes are not 100% covered, go back to step 6.
8. Commit and push your changes.
9. Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)
Supported Rubies
----------------
This library aims to support and is [tested
against](http://travis-ci.org/rubygems/gems) the following Ruby
implementations:
* Ruby 1.9.1
* Ruby 1.9.2
If something doesn't work on one of these interpreters, it should be considered
a bug.
This library may inadvertently work (or seem to work) on other Ruby
implementations, however support will only be provided for the versions listed
above.
If you would like this library to support another Ruby version, you may
volunteer to be a maintainer. Being a maintainer entails making sure all tests
run and pass on that implementation. When something breaks on your
implementation, you will be personally responsible for providing patches in a
timely fashion. If critical issues for a particular implementation exist at the
time of a major release, support for that Ruby version may be dropped.
Copyright
---------
Copyright (c) 2011 Erik Michaels-Ober.
See [LICENSE](https://github.com/rubygems/gems/blob/master/LICENSE.md) for details.