gems 0.0.5 → 0.0.6

data/README.md

@@ -29,22 +29,26 @@ Usage Examples
     puts Gems.versions 'coulda'
 
     # Returns the number of downloads by day for a particular gem version
+    # for the past 90 days
     puts Gems.downloads 'coulda', '0.6.3'
 
+    # Returns the number of downloads by day for a particular gem version
+    # 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 given gems
     puts Gems.dependencies ['rails', 'thor']
 
-    # The following method requires password authentication
+    # Retrieve your API key using HTTP basic authentication
     Gems.configure do |config|
-      config.format = :xml
       config.username = 'nick@gemcutter.org'
       config.password = 'schwwwwing'
     end
-
-    # Retrieve your API key using HTTP basic auth
     Gems.api_key
 
-    # The following methods require authentication
+    # You can also find your API key at https://rubygems.org/profile/edit
+    # We will attempt to load your API key from ~/.gem/credentails
+    # You may also specify a custom API key
     Gems.configure do |config|
       config.key '701243f217cdf23b1370c7b66b65ca97'
     end
@@ -53,34 +57,34 @@ Usage Examples
     puts Gems.gems
 
     # View all owners of a gem that you own
-    puts Gems.owners 'gemcutter' [TODO]
+    puts Gems.owners 'gemcutter'
 
     # Add an owner to a RubyGem you own, giving that user permission to manage it
-    puts Gems.add_owner 'josh@technicalpickles.com', 'gemcutter' [TODO]
+    Gems.add_owner 'josh@technicalpickles.com', 'gemcutter' [TODO]
 
     # Remove a user's permission to manage a RubyGem you own
-    puts Gems.remove_owner 'josh@technicalpickles.com', 'gemcutter' [TODO]
+    Gems.remove_owner 'josh@technicalpickles.com', 'gemcutter' [TODO]
 
     # List the webhooks registered under your account
-    puts Gems.web_hooks [TODO]
+    puts Gems.web_hooks
 
     # Add a webhook
-    puts Gems.add_web_hook 'rails', 'http://example.com' [TODO]
+    Gems.add_web_hook 'rails', 'http://example.com' [TODO]
 
     # Remove a webhook
-    puts Gems.remove_web_hook 'rails', 'http://example.com' [TODO]
+    Gems.remove_web_hook 'rails', 'http://example.com' [TODO]
 
     # Test fire a webhook.
-    puts Gems.fire_web_hook 'rails', 'http://example.com' [TODO]
+    Gems.fire_web_hook 'rails', 'http://example.com' [TODO]
 
     # Submit a gem to RubyGems.org
-    puts Gems.push File.new 'gemcutter-0.2.1.gem' [TODO]
+    Gems.push File.new 'gemcutter-0.2.1.gem' [TODO]
 
     # Remove a gem from RubyGems.org's index
-    puts Gems.yank 'bills', '0.0.1', :platform => 'x86-darwin-10' [TODO]
+    Gems.yank 'bills', '0.0.1', :platform => 'x86-darwin-10' [TODO]
 
     # Update a previously yanked gem back into RubyGems.org's index
-    puts Gems.unyank 'bills', '0.0.1', :platform => 'x86-darwin-10' [TODO]
+    Gems.unyank 'bills', '0.0.1', :platform => 'x86-darwin-10' [TODO]
 
 Contributing
 ------------

data/lib/gems/client.rb

@@ -1,3 +1,4 @@
+require 'date'
 require 'gems/configuration'
 require 'gems/connection'
 require 'gems/request'
@@ -51,11 +52,17 @@ module Gems
     #
     # @param gem [String] The name of a gem.
     # @param version [String] The version of a gem.
+    # @param from [Date] Search start date.
+    # @param to [Date] Search end date.
     # @return [Hashie::Mash]
     # @example
-    #   Gems.downloads 'coulda', '0.6.3'
-    def downloads(gem, version)
-      get("/api/v1/versions/#{gem}-#{version}/downloads", {}, :json)
+    #   Gems.downloads 'coulda', '0.6.3', Date.today - 30, Date.today
+    def downloads(gem, version, from=nil, to=Date.today)
+      if from
+        get("/api/v1/versions/#{gem}-#{version}/downloads/search", {:from => from.to_s, :to => to.to_s}, :json)
+      else
+        get("/api/v1/versions/#{gem}-#{version}/downloads", {}, :json)
+      end
     end
 
     # Returns an array of hashes for all versions of given gems
@@ -93,5 +100,30 @@ module Gems
       response = get("/api/v1/gems")
       format.to_s.downcase == 'xml' ? response['rubygems'] : response
     end
+
+    # View all owners of a gem that you own
+    #
+    # @param gem [String] The name of a gem.
+    # @return [Array]
+    # @example
+    #   Gems.configure do |config|
+    #     config.key = '701243f217cdf23b1370c7b66b65ca97'
+    #   end
+    #   Gems.owners('gemcutter')
+    def owners(gem)
+      get("/api/v1/gems/#{gem}/owners", {}, :json)
+    end
+
+    # List the webhooks registered under your account
+    #
+    # @return [Hashie::Mash]
+    # @example
+    #   Gems.configure do |config|
+    #     config.key = '701243f217cdf23b1370c7b66b65ca97'
+    #   end
+    #   Gems.web_hooks
+    def web_hooks
+      get("/api/v1/web_hooks", {}, :json)
+    end
   end
 end

data/lib/gems/configuration.rb

@@ -1,4 +1,5 @@
 require 'gems/version'
+require 'yaml'
 
 module Gems
   module Configuration
@@ -16,6 +17,13 @@ module Gems
     # @note JSON is preferred over XML because it is more concise and faster to parse.
     DEFAULT_FORMAT = :json
 
+    # Attempt to automatically load credentials
+    DEFAULT_KEY = begin
+      YAML.load(File.read(File.expand_path("~/.gem/credentials")))[:rubygems_api_key]
+    rescue Errno::ENOENT
+      nil
+    end
+
     # The value sent in the 'User-Agent' header if none is set
     DEFAULT_USER_AGENT = "Gems #{Gems::VERSION}".freeze
 
@@ -41,7 +49,7 @@ module Gems
     # Reset all configuration options to defaults
     def reset
       self.format     = DEFAULT_FORMAT
-      self.key        = nil
+      self.key        = DEFAULT_KEY
       self.password   = nil
       self.user_agent = DEFAULT_USER_AGENT
       self.username   = nil

data/lib/gems/version.rb

@@ -1,3 +1,3 @@
 module Gems
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/fixtures/web_hooks.json

@@ -0,0 +1 @@
+{"all gems":[{"url":"http://gemwhisperer.heroku.com","failure_count":1}],"rails":[{"url":"http://example.com","failure_count": 0}]}

data/spec/gems/client_spec.rb

@@ -61,16 +61,50 @@ describe Gems::Client do
       end
 
       describe ".downloads" do
-        before do
-          stub_get("/api/v1/versions/coulda-0.6.3/downloads.json").
-            to_return(:body => fixture("downloads.json"))
+        context "with no dates specified" do
+          before do
+            stub_get("/api/v1/versions/coulda-0.6.3/downloads.json").
+              to_return(:body => fixture("downloads.json"))
+          end
+
+          it "should return the number of downloads by day for a particular gem version" do
+            downloads = Gems.downloads 'coulda', '0.6.3'
+            a_get("/api/v1/versions/coulda-0.6.3/downloads.json").
+              should have_been_made
+            downloads["2011-06-22"].should == 8
+          end
         end
 
-        it "should return the number of downloads by day for a particular gem version" do
-          downloads = Gems.downloads 'coulda', '0.6.3'
-          a_get("/api/v1/versions/coulda-0.6.3/downloads.json").
-            should have_been_made
-          downloads["2011-06-22"].should == 8
+        context "with from date specified" do
+          before do
+            stub_get("/api/v1/versions/coulda-0.6.3/downloads/search.json").
+              with(:query => {"from" => "2011-01-01", "to" => Date.today.to_s}).
+              to_return(:body => fixture("downloads.json"))
+          end
+
+          it "should return the number of downloads by day for a particular gem version" do
+            downloads = Gems.downloads 'coulda', '0.6.3', Date.parse('2011-01-01')
+            a_get("/api/v1/versions/coulda-0.6.3/downloads/search.json").
+              with(:query => {"from" => "2011-01-01", "to" => Date.today.to_s}).
+              should have_been_made
+            downloads["2011-06-22"].should == 8
+          end
+        end
+
+        context "with from and to dates specified" do
+          before do
+            stub_get("/api/v1/versions/coulda-0.6.3/downloads/search.json").
+              with(:query => {"from" => "2011-01-01", "to" => "2011-06-28"}).
+              to_return(:body => fixture("downloads.json"))
+          end
+
+          it "should return the number of downloads by day for a particular gem version" do
+            downloads = Gems.downloads 'coulda', '0.6.3', Date.parse('2011-01-01'), Date.parse('2011-06-28')
+            a_get("/api/v1/versions/coulda-0.6.3/downloads/search.json").
+              with(:query => {"from" => "2011-01-01", "to" => "2011-06-28"}).
+              should have_been_made
+            downloads["2011-06-22"].should == 8
+          end
         end
       end
 
@@ -117,6 +151,34 @@ describe Gems::Client do
           gems.first.name.should == "congress"
         end
       end
+
+      describe ".owners" do
+        before do
+          stub_get("/api/v1/gems/gems/owners.json").
+            to_return(:body => fixture("owners.json"))
+        end
+
+        it "should list all owners of a gem" do
+          owners = Gems.owners("gems")
+          a_get("/api/v1/gems/gems/owners.json").
+            should have_been_made
+          owners.first.email.should == "sferik@gmail.com"
+        end
+      end
+
+      describe ".web_hooks" do
+        before do
+          stub_get("/api/v1/web_hooks.json").
+            to_return(:body => fixture("web_hooks.json"))
+        end
+
+        it "should list the webhooks registered under your account" do
+          web_hooks = Gems.web_hooks
+          a_get("/api/v1/web_hooks.json").
+            should have_been_made
+          web_hooks.rails.first.url.should == "http://example.com"
+        end
+      end
     end
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: gems
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors: 
 - Erik Michaels-Ober
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-28 00:00:00 -07:00
+date: 2011-06-30 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -182,6 +182,7 @@ files:
 - spec/fixtures/rails.xml
 - spec/fixtures/search.json
 - spec/fixtures/search.xml
+- spec/fixtures/web_hooks.json
 - spec/gems/client_spec.rb
 - spec/gems_spec.rb
 - spec/helper.rb
@@ -225,6 +226,7 @@ test_files:
 - spec/fixtures/rails.xml
 - spec/fixtures/search.json
 - spec/fixtures/search.xml
+- spec/fixtures/web_hooks.json
 - spec/gems/client_spec.rb
 - spec/gems_spec.rb
 - spec/helper.rb