gems 0.6.0 → 0.7.0

data/.gitignore

@@ -1,5 +1,4 @@
 *.rbc
-.DS_Store
 .bundle
 .config
 .yardoc

data/.travis.yml

@@ -1,8 +1,10 @@
-before_install: "gem update --system 1.3.7"
+language: ruby
 rvm:
+  - rbx-18mode
+  - rbx-19mode
+  - jruby-18mode
+  - jruby-19mode
   - 1.8.7
   - 1.9.2
   - 1.9.3
-  - jruby
-  - rbx
-  - ree
+  - ruby-head

data/README.md

@@ -4,59 +4,68 @@ Ruby wrapper for the RubyGems.org API.
 [travis]: http://travis-ci.org/rubygems/gems
 [gemnasium]: https://gemnasium.com/rubygems/gems
 
-## <a name="installation"></a>Installation
+## Installation
     gem install gems
 
-## <a name="documentation"></a>Documentation
+## Documentation
 [http://rdoc.info/gems/gems](http://rdoc.info/gems/gems)
 
-# <a name="examples"></a>Usage Examples
+# Usage Examples
     require 'rubygems'
     require 'gems'
 
-    # Returns some basic information about rails.
-    puts Gems.info 'rails'
+    # Return some basic information about rails.
+    Gems.info 'rails'
 
-    # Returns an array of active gems that match the query.
-    puts Gems.search 'cucumber'
+    # Return an array of active gems that match the query.
+    Gems.search 'cucumber'
 
-    # Returns an array of version details for coulda.
-    puts Gems.versions 'coulda'
+    # Return all gems that you own.
+    Gems.gems
 
-    # Returns the total number of downloads for rails_admin 0.0.0.
+    # Return all gems owned by Erik Michaels-Ober.
+    Gems.gems("sferik")
+
+    # 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.
-    # Defaults to RubyGems.org if no gem name is specified.
-    puts Gems.downloads 'rails_admin', '0.0.0'
+    Gems.yank 'bills', '0.0.1'
 
-    # Returns the number of downloads by day for coulda 0.6.3 for the past 90 days.
+    # Update a previously yanked gem back into RubyGems.org's index.
     # Defaults to the latest version if no version is specified.
-    puts Gems.downloads 'coulda', '0.6.3'
+    Gems.unyank 'bills', '0.0.1'
 
-    # 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
+    # Return an array of version details for coulda.
+    Gems.versions 'coulda'
 
-    # Returns an array of gem dependency details for all versions of all the given gems.
-    puts Gems.dependencies ['rails', 'thor']
+    # Return an array of version details for coulda.
+    Gems.versions 'coulda'
 
-    # 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
+    # Return the total number of downloads for rails_admin 0.0.1.
+    # (Defaults to the latest version if no version is specified.)
+    Gems.total_downloads 'rails_admin', '0.0.1'
 
-    # 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
+    # Returns an array containing the top 50 downloaded gem versions for today.
+    Gems.most_downloaded_today
+
+    # Returns an array containing the top 50 downloaded gem versions of all time.
+    Gems.most_downloaded
+
+    # Return the total number of downloads by day for rails_admin 0.0.1.
+    # (Defaults to the latest version if no version is specified.)
+    Gems.downloads 'rails_admin', '0.0.1'
+
+    # Return 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.)
+    Gems.downloads 'coulda', '0.6.3'
 
-    # List all gems that you own.
-    puts Gems.gems
+    # Return the number of downloads by day for coulda 0.6.3 for the past year.
+    Gems.downloads 'coulda', '0.6.3', Date.today - 365, Date.today
 
     # View all owners of a gem that you own.
-    puts Gems.owners 'gemcutter'
+    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'
@@ -64,8 +73,8 @@ Ruby wrapper for the RubyGems.org API.
     # 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
+    # Return all the webhooks registered under your account.
+    Gems.web_hooks
 
     # Add a webhook.
     Gems.add_web_hook 'rails', 'http://example.com'
@@ -76,18 +85,30 @@ Ruby wrapper for the RubyGems.org API.
     # 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'
+    # Returns the 50 gems most recently added to RubyGems.org
+    Gems.latest
 
-    # Remove a gem from RubyGems.org's index.
-    # Defaults to the latest version if no version is specified.
-    Gems.yank 'bills', '0.0.1'
+    # Returns the 50 most recently updated gems
+    Gems.just_updated
 
-    # 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'
+    # Retrieve your API key using HTTP basic authentication.
+    Gems.configure do |config|
+      config.username = 'nick@gemcutter.org'
+      config.password = 'schwwwwing'
+    end
+    Gems.api_key
+
+    # Return an array of gem dependency details for all versions of all the given gems.
+    Gems.dependencies ['rails', 'thor']
+
+    # 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
 
-## <a name="contributing"></a>Contributing
+## 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:
@@ -97,31 +118,41 @@ Here are some ways *you* can contribute:
 * 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 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
 
-## <a name="issues"></a>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 issue 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.
-
-## <a name="pulls"></a>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 <tt>bundle exec rake doc:yard</tt>. If your changes are not 100% documented, go back to step 4.
-6. Add specs for your feature or bug fix.
-7. Run <tt>bundle exec rake spec</tt>. 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.)
-
-## <a name="versions"></a>Supported Ruby Versions
+## 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. 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 repository.][fork]
+2. [Create a topic branch.][branch]
+3. Add specs for your unimplemented feature or bug fix.
+4. Run `bundle exec rake spec`. If your specs pass, return to step 3.
+5. Implement your feature or bug fix.
+6. Run `bundle exec rake spec`. If your specs fail, return to step 5.
+7. Run `open coverage/index.html`. If your changes are not completely covered
+   by your tests, return to step 3.
+8. Add documentation for your feature or bug fix.
+9. Run `bundle exec rake doc:yard`. If your changes are not 100% documented, go
+   back to step 8.
+10. Add, commit, and push your changes.
+11. [Submit a pull request.][pr]
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: http://learn.github.com/p/branching.html
+[pr]: http://help.github.com/send-pull-requests/
+
+## Supported Ruby Versions
 This library aims to support and is [tested against][travis] the following Ruby
 implementations:
 
@@ -130,11 +161,9 @@ implementations:
 * Ruby 1.9.3
 * [JRuby][]
 * [Rubinius][]
-* [Ruby Enterprise Edition][ree]
 
 [jruby]: http://www.jruby.org/
 [rubinius]: http://rubini.us/
-[ree]: http://www.rubyenterpriseedition.com/)
 
 If something doesn't work on one of these interpreters, it should be considered
 a bug.
@@ -150,7 +179,7 @@ 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.
 
-## <a name="copyright"></a>Copyright
+## Copyright
 Copyright (c) 2011 Erik Michaels-Ober. See [LICENSE][] for details.
 
 [license]: https://github.com/rubygems/gems/blob/master/LICENSE.md

data/Rakefile

@@ -1,5 +1,3 @@
-#!/usr/bin/env rake
-
 require 'bundler'
 Bundler::GemHelper.install_tasks
 

data/gems.gemspec

@@ -2,12 +2,12 @@
 require File.expand_path('../lib/gems/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.add_development_dependency 'rake', '~> 0.9'
-  gem.add_development_dependency 'rdiscount', '~> 1.6'
-  gem.add_development_dependency 'rspec', '~> 2.6'
-  gem.add_development_dependency 'simplecov', '~> 0.4'
-  gem.add_development_dependency 'webmock', '~> 1.7'
-  gem.add_development_dependency 'yard', '~> 0.7'
+  gem.add_development_dependency 'maruku'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'yard'
   gem.authors     = ["Erik Michaels-Ober"]
   gem.description = %q{Ruby wrapper for the RubyGems.org API}
   gem.email       = ['sferik@gmail.com']

data/lib/gems/client.rb

@@ -39,6 +39,63 @@ module Gems
       YAML.load(response)
     end
 
+    # List all gems that you own
+    #
+    # @authenticated true
+    # @param user_handle [String] The handle of a user.
+    # @return [Array]
+    # @example
+    #   Gems.gems
+    def gems(user_handle=nil)
+      response = if user_handle
+        get("/api/v1/owners/#{user_handle}/gems.yaml")
+      else
+        get("/api/v1/gems.yaml")
+      end
+      YAML.load(response)
+    end
+
+    # Submit a gem to RubyGems.org
+    #
+    # @authenticated true
+    # @param gem [File] A built gem.
+    # @return [String]
+    # @example
+    #   Gems.push File.new 'pkg/gemcutter-0.2.1.gem'
+    def push(gem)
+      post("/api/v1/gems", gem.read, 'application/octet-stream')
+    end
+
+    # Remove a gem from RubyGems.org's index
+    #
+    # @authenticated true
+    # @param gem_name [String] The name of a gem.
+    # @param gem_version [String] The version of a gem.
+    # @param options [Hash] A customizable set of options.
+    # @option options [String] :platform
+    # @return [String]
+    # @example
+    #   Gems.yank "gemcutter", "0.2.1", {:platform => "x86-darwin-10"}
+    def yank(gem_name, gem_version=nil, options={})
+      gem_version ||= info(gem_name)['version']
+      delete("/api/v1/gems/yank", options.merge(:gem_name => gem_name, :version => gem_version))
+    end
+
+    # Update a previously yanked gem back into RubyGems.org's index
+    #
+    # @authenticated true
+    # @param gem_name [String] The name of a gem.
+    # @param gem_version [String] The version of a gem.
+    # @param options [Hash] A customizable set of options.
+    # @option options [String] :platform
+    # @return [String]
+    # @example
+    #   Gems.unyank "gemcutter", "0.2.1", {:platform => "x86-darwin-10"}
+    def unyank(gem_name, gem_version=nil, options={})
+      gem_version ||= info(gem_name)['version']
+      put("/api/v1/gems/unyank", options.merge(:gem_name => gem_name, :version => gem_version))
+    end
+
     # Returns an array of gem version details
     #
     # @authenticated false
@@ -58,26 +115,37 @@ module Gems
     # @param gem_version [String] The version of a gem.
     # @return [Hash]
     # @example
-    #   Gems.total_downloads 'rails_admin', '0.0.0'
+    #   Gems.total_downloads 'rails_admin', '0.0.1'
     def total_downloads(gem_name=nil, gem_version=nil)
-      if gem_name
+      response = if gem_name
         gem_version ||= info(gem_name)['version']
-        response = get("/api/v1/downloads/#{gem_name}-#{gem_version}.yaml")
+        get("/api/v1/downloads/#{gem_name}-#{gem_version}.yaml")
       else
-        response = get("/api/v1/downloads.yaml")
+        get("/api/v1/downloads.yaml")
       end
       YAML.load(response)
     end
 
-    # Returns an array of the most downloaded gem versions of all time
+    # Returns an array containing the top 50 downloaded gem versions for today
     #
     # @authenticated false
-    # @return [Hash]
+    # @return [Array]
+    # @example
+    #   Gems.most_downloaded_today
+    def most_downloaded_today
+      response = get("/api/v1/downloads/top.yaml")
+      YAML.load(response)[:gems]
+    end
+
+    # Returns an array containing the top 50 downloaded gem versions of all time
+    #
+    # @authenticated false
+    # @return [Array]
     # @example
     #   Gems.most_downloaded
     def most_downloaded
       response = get("/api/v1/downloads/all.yaml")
-      YAML.load(response)
+      YAML.load(response)[:gems]
     end
 
     # Returns the number of downloads by day for a particular gem version
@@ -100,43 +168,6 @@ module Gems
       YAML.load(response)
     end
 
-    # Returns an array of hashes for all versions of given gems
-    #
-    # @authenticated false
-    # @param gems [Array] A list of gem names
-    # @return [Array]
-    # @example
-    #   Gems.dependencies 'rails', 'thor'
-    def dependencies(*gems)
-      response = get('/api/v1/dependencies', {:gems => gems.join(',')})
-      Marshal.load(response)
-    end
-
-    # Retrieve your API key using HTTP basic auth
-    #
-    # @authenticated true
-    # @return [String]
-    # @example
-    #   Gems.configure do |config|
-    #     config.username = 'nick@gemcutter.org'
-    #     config.password = 'schwwwwing'
-    #   end
-    #   Gems.api_key
-    def api_key
-      get('/api/v1/api_key')
-    end
-
-    # List all gems that you own
-    #
-    # @authenticated true
-    # @return [Array]
-    # @example
-    #   Gems.gems
-    def gems
-      response = get("/api/v1/gems.yaml")
-      YAML.load(response)
-    end
-
     # View all owners of a gem that you own
     #
     # @authenticated true
@@ -220,48 +251,7 @@ module Gems
       post("/api/v1/web_hooks/fire", {:gem_name => gem_name, :url => url})
     end
 
-    # Submit a gem to RubyGems.org
-    #
-    # @authenticated true
-    # @param gem [File] A built gem.
-    # @return [String]
-    # @example
-    #   Gems.push File.new 'pkg/gemcutter-0.2.1.gem'
-    def push(gem)
-      post("/api/v1/gems", gem.read, 'application/octet-stream')
-    end
-
-    # Remove a gem from RubyGems.org's index
-    #
-    # @authenticated true
-    # @param gem_name [String] The name of a gem.
-    # @param gem_version [String] The version of a gem.
-    # @param options [Hash] A customizable set of options.
-    # @option options [String] :platform
-    # @return [String]
-    # @example
-    #   Gems.yank "gemcutter", "0.2.1", {:platform => "x86-darwin-10"}
-    def yank(gem_name, gem_version=nil, options={})
-      gem_version ||= info(gem_name)['version']
-      delete("/api/v1/gems/yank", options.merge(:gem_name => gem_name, :version => gem_version))
-    end
-
-    # Update a previously yanked gem back into RubyGems.org's index
-    #
-    # @authenticated true
-    # @param gem_name [String] The name of a gem.
-    # @param gem_version [String] The version of a gem.
-    # @param options [Hash] A customizable set of options.
-    # @option options [String] :platform
-    # @return [String]
-    # @example
-    #   Gems.unyank "gemcutter", "0.2.1", {:platform => "x86-darwin-10"}
-    def unyank(gem_name, gem_version=nil, options={})
-      gem_version ||= info(gem_name)['version']
-      put("/api/v1/gems/unyank", options.merge(:gem_name => gem_name, :version => gem_version))
-    end
-
-    # Pulls the 50 gems most recently added to RubyGems.org (for the first time). Returns an array of the XML or JSON representation of the gems
+    # Returns the 50 gems most recently added to RubyGems.org (for the first time)
     #
     # @authenticated false
     # @param options [Hash] A customizable set of options.
@@ -273,7 +263,7 @@ module Gems
       YAML.load(response)
     end
 
-    # Pulls the 50 most recently updated gems. Returns an array of the XML or JSON representation of the gem versions
+    # Returns the 50 most recently updated gems
     #
     # @authenticated false
     # @param options [Hash] A customizable set of options.
@@ -285,5 +275,31 @@ module Gems
       YAML.load(response)
     end
 
+    # Retrieve your API key using HTTP basic auth
+    #
+    # @authenticated true
+    # @return [String]
+    # @example
+    #   Gems.configure do |config|
+    #     config.username = 'nick@gemcutter.org'
+    #     config.password = 'schwwwwing'
+    #   end
+    #   Gems.api_key
+    def api_key
+      get('/api/v1/api_key')
+    end
+
+    # Returns an array of hashes for all versions of given gems
+    #
+    # @authenticated false
+    # @param gems [Array] A list of gem names
+    # @return [Array]
+    # @example
+    #   Gems.dependencies 'rails', 'thor'
+    def dependencies(*gems)
+      response = get('/api/v1/dependencies', {:gems => gems.join(',')})
+      Marshal.load(response)
+    end
+
   end
 end