gems 0.0.8 → 0.1.0

data/README.md

@@ -19,72 +19,70 @@ Usage Examples
     require 'rubygems'
     require 'gems'
 
-    # Returns some basic information about the rails gem
+    # Returns some basic information about rails.
     puts Gems.info 'rails'
 
-    # Returns an array of active gems that match the query
+    # Returns an array of active gems that match the query.
     puts Gems.search 'cucumber'
 
-    # Returns an array of gem version details
+    # Returns an array of version details for coulda.
     puts Gems.versions 'coulda'
 
-    # Returns the number of downloads by day for a particular gem version
-    # for the past 90 days
+    # Returns the number of downloads by day for a particular gem version 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 a particular gem version
-    # for the past year
+    # 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
+    # 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
+    # Retrieve your API key using HTTP basic authentication.
     Gems.configure do |config|
       config.username = 'nick@gemcutter.org'
       config.password = 'schwwwwing'
     end
     Gems.api_key
 
-    # 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
+    # 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
+    # List all gems that you own.
     puts Gems.gems
 
-    # View all owners of a gem that you own
+    # 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
+    # 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
+    # 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
+    # List the webhooks registered under your account.
     puts Gems.web_hooks
 
-    # Add a webhook
+    # Add a webhook.
     Gems.add_web_hook 'rails', 'http://example.com'
 
-    # Remove a webhook
+    # 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' [TODO]
+    # Remove a gem from RubyGems.org's index.
+    # Defaults to the latest version if no version is specified.
+    Gems.yank 'bills', '0.0.1'
 
-    # Remove a gem from RubyGems.org's index
-    Gems.yank 'bills', '0.0.1', :platform => 'x86-darwin-10' [TODO]
-
-    # Update a previously yanked gem back into RubyGems.org's index
-    Gems.unyank 'bills', '0.0.1', :platform => 'x86-darwin-10' [TODO]
+    # 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
 ------------

data/lib/gems/client.rb

@@ -57,7 +57,8 @@ module Gems
     # @return [Hashie::Mash]
     # @example
     #   Gems.downloads 'coulda', '0.6.3', Date.today - 30, Date.today
-    def downloads(gem_name, gem_version, from=nil, to=Date.today)
+    def downloads(gem_name, gem_version=nil, from=nil, to=Date.today)
+      gem_version ||= info(gem_name).version
       if from
         get("/api/v1/versions/#{gem_name}-#{gem_version}/downloads/search", {:from => from.to_s, :to => to.to_s}, :json)
       else
@@ -171,5 +172,33 @@ module Gems
     def fire_web_hook(gem_name, url)
       post("/api/v1/web_hooks/fire", {:gem_name => gem_name, :url => url}, :raw)
     end
+
+    # Remove a gem from RubyGems.org's index
+    #
+    # @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), :raw)
+    end
+
+    # Update a previously yanked gem back into RubyGems.org's index
+    #
+    # @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), :raw)
+    end
   end
 end

data/lib/gems/configuration.rb

@@ -1,4 +1,5 @@
 require 'gems/version'
+require 'rubygems'
 require 'yaml'
 
 module Gems
@@ -12,19 +13,15 @@ module Gems
       :username,
     ]
 
-    # The response format appended to the path if none is set
+    # Set the default response format appended to the path
     #
     # @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
+    # Set the default credentials
+    DEFAULT_KEY = Gem.configuration.rubygems_api_key
 
-    # The value sent in the 'User-Agent' header if none is set
+    # Set the default value sent in the 'User-Agent' header
     DEFAULT_USER_AGENT = "Gems #{Gems::VERSION}".freeze
 
     attr_accessor *VALID_OPTIONS_KEYS

data/lib/gems/request.rb

@@ -12,6 +12,10 @@ module Gems
       request(:post, path, options, format)
     end
 
+    def put(path, options={}, format=format)
+      request(:put, path, options, format)
+    end
+
     private
 
     def request(method, path, options, format)
@@ -19,7 +23,7 @@ module Gems
         case method
         when :delete, :get
           request.url(formatted_path(path, format), options)
-        when :post
+        when :post, :put
           request.path = formatted_path(path, format)
           request.body = options unless options.empty?
         end

data/lib/gems/version.rb

@@ -1,3 +1,3 @@
 module Gems
-  VERSION = "0.0.8"
+  VERSION = "0.1.0" unless defined? ::Gems::VERSION
 end

data/spec/fixtures/unyank

@@ -0,0 +1 @@
+Successfully unyanked gem: gems (0.0.8)

data/spec/fixtures/yank

@@ -0,0 +1 @@
+Successfully yanked gem: gems (0.0.8)

data/spec/gems/client_spec.rb

@@ -68,6 +68,22 @@ describe Gems::Client do
   end
 
   describe ".downloads" do
+    context "with no dates or version specified" do
+      before do
+        stub_get("/api/v1/gems/coulda.json").
+          to_return(:body => fixture("rails.json"))
+        stub_get("/api/v1/versions/coulda-3.0.9/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'
+        a_get("/api/v1/versions/coulda-3.0.9/downloads.json").
+          should have_been_made
+        downloads["2011-06-22"].should == 8
+      end
+    end
+
     context "with no dates specified" do
       before do
         stub_get("/api/v1/versions/coulda-0.6.3/downloads.json").
@@ -276,4 +292,76 @@ describe Gems::Client do
       fire_web_hook.should == "Successfully deployed webhook for gemcutter to http://example.com"
     end
   end
+
+  describe ".yank" do
+    context "with no version specified" do
+      before do
+        stub_get("/api/v1/gems/gems.json").
+          to_return(:body => fixture("rails.json"))
+        stub_delete("/api/v1/gems/yank").
+          with(:query => {:gem_name => "gems", :version => "3.0.9"}).
+          to_return(:body => fixture("yank"))
+      end
+
+      it "should remove a gem from RubyGems.org's index" do
+        yank = Gems.yank("gems")
+        a_delete("/api/v1/gems/yank").
+          with(:query => {:gem_name => "gems", :version => "3.0.9"}).
+          should have_been_made
+        yank.should == "Successfully yanked gem: gems (0.0.8)"
+      end
+    end
+
+    context "with a version specified" do
+      before do
+        stub_delete("/api/v1/gems/yank").
+          with(:query => {:gem_name => "gems", :version => "0.0.8"}).
+          to_return(:body => fixture("yank"))
+      end
+
+      it "should remove a gem from RubyGems.org's index" do
+        yank = Gems.yank("gems", "0.0.8")
+        a_delete("/api/v1/gems/yank").
+          with(:query => {:gem_name => "gems", :version => "0.0.8"}).
+          should have_been_made
+        yank.should == "Successfully yanked gem: gems (0.0.8)"
+      end
+    end
+  end
+
+  describe ".unyank" do
+    context "with no version specified" do
+      before do
+        stub_get("/api/v1/gems/gems.json").
+          to_return(:body => fixture("rails.json"))
+        stub_put("/api/v1/gems/unyank").
+          with(:body => {:gem_name => "gems", :version => "3.0.9"}).
+          to_return(:body => fixture("unyank"))
+      end
+
+      it "should update a previously yanked gem back into RubyGems.org's index" do
+        unyank = Gems.unyank("gems")
+        a_put("/api/v1/gems/unyank").
+          with(:body => {:gem_name => "gems", :version => "3.0.9"}).
+          should have_been_made
+        unyank.should == "Successfully unyanked gem: gems (0.0.8)"
+      end
+    end
+
+    context "with a version specified" do
+      before do
+        stub_put("/api/v1/gems/unyank").
+          with(:body => {:gem_name => "gems", :version => "0.0.8"}).
+          to_return(:body => fixture("unyank"))
+      end
+
+      it "should update a previously yanked gem back into RubyGems.org's index" do
+        unyank = Gems.unyank("gems", "0.0.8")
+        a_put("/api/v1/gems/unyank").
+          with(:body => {:gem_name => "gems", :version => "0.0.8"}).
+          should have_been_made
+        unyank.should == "Successfully unyanked gem: gems (0.0.8)"
+      end
+    end
+  end
 end

data/spec/helper.rb

@@ -18,6 +18,10 @@ def a_post(path)
   a_request(:post, 'https://nick%40gemcutter.org:schwwwwing@rubygems.org' + path)
 end
 
+def a_put(path)
+  a_request(:put, 'https://nick%40gemcutter.org:schwwwwing@rubygems.org' + path)
+end
+
 def stub_delete(path)
   stub_request(:delete, 'https://nick%40gemcutter.org:schwwwwing@rubygems.org' + path)
 end
@@ -30,6 +34,10 @@ def stub_post(path)
   stub_request(:post, 'https://nick%40gemcutter.org:schwwwwing@rubygems.org' + path)
 end
 
+def stub_put(path)
+  stub_request(:put, 'https://nick%40gemcutter.org:schwwwwing@rubygems.org' + path)
+end
+
 def fixture_path
   File.expand_path('../fixtures', __FILE__)
 end

metadata

@@ -2,7 +2,7 @@
 name: gems
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.8
+  version: 0.1.0
 platform: ruby
 authors: 
   - Erik Michaels-Ober
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-01 00:00:00 -07:00
+date: 2011-07-02 00:00:00 -07:00
 default_executable: 
 dependencies: 
   - !ruby/object:Gem::Dependency 
@@ -188,7 +188,9 @@ files:
   - spec/fixtures/remove_web_hook
   - spec/fixtures/search.json
   - spec/fixtures/search.xml
+  - spec/fixtures/unyank
   - spec/fixtures/web_hooks.json
+  - spec/fixtures/yank
   - spec/gems/client_spec.rb
   - spec/gems_spec.rb
   - spec/helper.rb
@@ -238,7 +240,9 @@ test_files:
   - spec/fixtures/remove_web_hook
   - spec/fixtures/search.json
   - spec/fixtures/search.xml
+  - spec/fixtures/unyank
   - spec/fixtures/web_hooks.json
+  - spec/fixtures/yank
   - spec/gems/client_spec.rb
   - spec/gems_spec.rb
   - spec/helper.rb