angellist_api 1.0.5 → 1.0.6

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## Master
 
+## 1.0.6 - 14 April, 2013
+
+- Properly raise a `TooManyRequests` error when a 403 contains a JSON error
+  object indicating rate limit overage (`EnhanceYourCalm` error aliased for
+  backwards compatibility) ([Ches Martin])
+- Add missing options parameters for passing pagination params to endpoints that
+  support them ([Ches Martin])
+
 ## 1.0.5 - 27 March, 2013
 
 - Fix inability to pass direction param for startup_roles ([Ches Martin])

data/lib/angellist_api/client/activity_feeds.rb

@@ -11,11 +11,18 @@ module AngellistApi
       # paginated and ordered by most recent story first.
       #
       # @requires_authentication Optional
+      # @paginated By explicit timestamp cursor
       #
       # @param options [Hash] A customizable set of options.
       # @option options [Integer] :personalized If set to 1 and a user is
       #   authenticated, only activity from the authenticated user's social graph
       #   is returned.
+      # @option options [Integer] :since If a Unix timestamp is passed in via
+      #   this parameter, only activity since that timestamp will be returned. A
+      #   maximum of 25 items will be returned, starting with the oldest item. A
+      #   cursor variable is also returned, which is the timestamp of the last
+      #   item. You may call /feed again with since set to this value to get the
+      #   next page of activity.
       #
       # @example
       #   AngellistApi.get_feed

data/lib/angellist_api/client/follows.rb

@@ -38,6 +38,7 @@ module AngellistApi
       # follow ids, such as those from the activity feed.
       #
       # @requires_authentication Optional
+      # @paginated No
       #
       # @param ids [Array] IDs of the follows to fetch.
       #
@@ -52,26 +53,30 @@ module AngellistApi
       # follower first.
       #
       # @requires_authentication No
+      # @paginated Yes
       #
       # @param [Integer] id The id of the given user.
+      # @param [Hash] options A customizable set of options.
       #
       # @example Get followers of user with ID 12345.
       #   AngellistApi.get_user_followers(12345)
-      def get_user_followers(id)
-        get("1/users/#{id}/followers")
+      def get_user_followers(id, options={})
+        get("1/users/#{id}/followers", options)
       end
 
       # Return the ids of the given user's followers, paginated and ordered by
       # most recent follower first.
       #
       # @requires_authentication No
+      # @paginated Yes
       #
       # @param [Integer] id The id of the given user.
+      # @param [Hash] options A customizable set of options.
       #
       # @example Get IDs of the followers of user with ID 12345.
       #   AngellistApi.get_user_follower_ids(12345)
-      def get_user_follower_ids(id)
-        get("1/users/#{id}/followers/ids")
+      def get_user_follower_ids(id, options={})
+        get("1/users/#{id}/followers/ids", options)
       end
 
       # Return objects that the given user is following, paginated and ordered
@@ -79,6 +84,7 @@ module AngellistApi
       # class of objects to return.
       #
       # @requires_authentication Optional
+      # @paginated Yes
       #
       # @param [Integer] id The id of the given user.
       # @param [Hash] options A customizable set of options.
@@ -96,6 +102,7 @@ module AngellistApi
       # /users/:id/followers/ids.
       #
       # @requires_authentication Optional
+      # @paginated Yes
       #
       # @param [Integer] id The id of the given user.
       # @param [Hash] options A customizable set of options.
@@ -111,26 +118,30 @@ module AngellistApi
       # recent follower first. Responds like GET /users/:id/followers.
       #
       # @requires_authentication Optional
+      # @paginated Yes
       #
       # @param [Integer] id The id of the given startup.
+      # @param [Hash] options A customizable set of options.
       #
       # @example Get followers of startup with ID 1234.
       #   AngellistApi.get_startup_followers(1234)
-      def get_startup_followers(id)
-        get("1/startups/#{id}/followers")
+      def get_startup_followers(id, options={})
+        get("1/startups/#{id}/followers", options)
       end
 
       # Returns the ids of the given startup's followers, paginated and ordered
       # by most recent follower first. Responds like GET /users/:id/followers.
       #
       # @requires_authentication Optional
+      # @paginated Yes
       #
       # @param [Integer] id The id of the given user.
+      # @param [Hash] options A customizable set of options.
       #
       # @example Get IDs of followers of startup with ID 1234.
       #   AngellistApi.get_startup_follower_ids(1234)
-      def get_startup_follower_ids(id)
-        get("1/startups/#{id}/followers/ids")
+      def get_startup_follower_ids(id, options={})
+        get("1/startups/#{id}/followers/ids", options)
       end
     end
   end

data/lib/angellist_api/client/messages.rb

@@ -8,7 +8,8 @@ module AngellistApi
       # Returns threads that the authenticated user is involved in. A "thread"
       # is a conversation between two users, where each message is tagged with
       # the same thread_id. If the authenticated user has any unread messages 
-      #in the thread, the viewed attribute will be false. Requires scope "message".
+      # in the thread, the viewed attribute will be false. Requires scope
+      # "message".
       #
       # @requires_authentication Yes
       # @paginated Yes

data/lib/angellist_api/client/paths.rb

@@ -13,6 +13,7 @@ module AngellistApi
       # - do not use user_ids and startup_ids at the same time
       #
       # @requires_authentication Yes
+      # @paginated No
       #
       # @param options [Hash] A customizable set of options.
       # @option options [Array<Integer>] :user_ids Show paths between you and

data/lib/angellist_api/client/press.rb

@@ -23,3 +23,4 @@ module AngellistApi
     end
   end
 end
+

data/lib/angellist_api/client/reviews.rb

@@ -9,6 +9,7 @@ module AngellistApi
       # Also returns the total count of positive reviews.
       #
       # @requires_authentication Optional
+      # @paginated Yes
       #
       # @param [Hash] options A customizable set of options.
       # @option options [Integer] :user_id user_id of the desired user. If none

data/lib/angellist_api/client/tags.rb

@@ -21,28 +21,32 @@ module AngellistApi
       # descending.
       #
       # @requires_authentication No
+      # @paginated Yes
       #
       # @param [Integer] id The id of the desired tag. Currently only works for
       #   tags of type MarketTag or LocationTag.
+      # @param [Hash] options A customizable set of options.
       #
       # @example Get children of a tag.
       #   AngellistApi.get_tag_children(1654)
-      def get_tag_children(id)
-        get("1/tags/#{id}/children")
+      def get_tag_children(id, options={})
+        get("1/tags/#{id}/children", options)
       end
 
       # Returns parents of the given tag. For more details, see the
       # documentation for GET /tags/:id/children.
       #
       # @requires_authentication No
+      # @paginated Yes
       #
       # @param [Integer] id The id of the desired tag. Currently only works for
       #   tags of type MarketTag or LocationTag.
+      # @param [Hash] options A customizable set of options.
       #
       # @example Get parents of a tag.
       #   AngellistApi.get_tag_parents(1654)
-      def get_tag_parents(id)
-        get("1/tags/#{id}/parents")
+      def get_tag_parents(id, options={})
+        get("1/tags/#{id}/parents", options)
       end
 
       # Returns startups that are tagged with the given tag or a child of the
@@ -50,6 +54,7 @@ module AngellistApi
       # parameter.
       #
       # @requires_authentication Optional
+      # @paginated Yes
       #
       # @param [Hash] options A customizable set of options.
       # @option options [String] :order May be one of popularity, asc or desc.

data/lib/angellist_api/client/users.rb

@@ -19,6 +19,7 @@ module AngellistApi
       # Get information for a batch of up to 50 users given a list of user IDs.
       #
       # @requires_authentication No
+      # @pagination No
       #
       # @param [Array] ids IDs of the users to fetch.
       #
@@ -32,6 +33,7 @@ module AngellistApi
       # Search for a user given a URL slug. Responds like GET /users/:id.
       #
       # @requires_authentication No
+      # @pagination No
       #
       # @param [Hash] options A customizable set of options.
       # @option options [String] :slug The URL slug of the desired user.

data/lib/angellist_api/error.rb

@@ -8,29 +8,33 @@ module AngellistApi
     # @param [String] message
     # @param [Hash] http_headers
     # @return [AngellistApi::Error]
-    def initialize(message, http_headers)
-      @http_headers = Hash[http_headers]
+    def initialize(message, http_headers={})
+      @http_headers = http_headers
       super message
     end
 
     # @return [Time]
     def ratelimit_reset
-      Time.at(@http_headers.values_at('x-ratelimit-reset', 'X-RateLimit-Reset').detect{|value| value}.to_i)
+      reset = http_headers['x-ratelimit-reset']
+      Time.at(reset.to_i) if reset
     end
 
     # @return [Integer]
     def ratelimit_limit
-      @http_headers.values_at('x-ratelimit-limit', 'X-RateLimit-Limit').detect{|value| value}.to_i
+      limit = http_headers['x-ratelimit-limit']
+      limit.to_i if limit
     end
 
     # @return [Integer]
     def ratelimit_remaining
-      @http_headers.values_at('x-ratelimit-remaining', 'X-RateLimit-Remaining').detect{|value| value}.to_i
+      remaining = http_headers['x-ratelimit-remaining']
+      remaining.to_i if remaining
     end
 
     # @return [Integer]
     def retry_after
-      [(ratelimit_reset - Time.now).ceil, 0].max
+      [(ratelimit_reset - Time.now).ceil, 0].max if ratelimit_reset
     end
   end
 end
+

data/lib/angellist_api/error/too_many_requests.rb

@@ -0,0 +1,26 @@
+require 'angellist_api/error'
+
+module AngellistApi
+  # Raised when AngellistApi returns the HTTP status code 403 with "over_limit"
+  # in the response.
+  #
+  # @note We've inquired with the AngelList API team about using a 429 status
+  #   in the future.
+  class Error
+    class TooManyRequests < AngellistApi::Error
+      # The number of seconds your application should wait before requesting data
+      # from the API again.
+      #
+      # This may not be supported by AngelList currently but is suggested in RFC
+      # 6585 for the 429 status code.
+      def retry_after
+        retry_after = http_headers['retry-after']
+        retry_after.to_i if retry_after
+      end
+    end
+
+    # Backwards compatability
+    EnhanceYourCalm = TooManyRequests
+  end
+end
+

data/lib/angellist_api/response/raise_client_error.rb

@@ -1,6 +1,6 @@
 require 'faraday'
 require 'angellist_api/error/bad_request'
-require 'angellist_api/error/enhance_your_calm'
+require 'angellist_api/error/too_many_requests'
 require 'angellist_api/error/forbidden'
 require 'angellist_api/error/not_acceptable'
 require 'angellist_api/error/not_found'
@@ -16,13 +16,15 @@ module AngellistApi
         when 401
           raise AngellistApi::Error::Unauthorized.new(error_message(env), env[:response_headers])
         when 403
-          raise AngellistApi::Error::Forbidden.new(error_message(env), env[:response_headers])
+          if env[:body]['error'] == 'over_limit'
+            raise AngellistApi::Error::TooManyRequests.new(error_message(env), env[:response_headers])
+          else
+            raise AngellistApi::Error::Forbidden.new(error_message(env), env[:response_headers])
+          end
         when 404
           raise AngellistApi::Error::NotFound.new(error_message(env), env[:response_headers])
         when 406
           raise AngellistApi::Error::NotAcceptable.new(error_message(env), env[:response_headers])
-        when 420
-          raise AngellistApi::Error::EnhanceYourCalm.new(error_message(env), env[:response_headers])
         end
       end
 
@@ -49,3 +51,4 @@ module AngellistApi
     end
   end
 end
+

data/lib/angellist_api/version.rb

@@ -1,4 +1,4 @@
 module AngellistApi
-  VERSION = '1.0.5'
+  VERSION = '1.0.6'
 end
 

data/spec/fixtures/cassettes/errors/forbidden.yml

@@ -0,0 +1,53 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.angel.co/1/me
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      User-Agent:
+      - AngellistApi Ruby Gem 1.0.5
+      Authorization:
+      - Bearer <ANGELLIST_ACCESS_TOKEN>
+  response:
+    status:
+      code: 403
+      message: !!null 
+    headers:
+      server:
+      - nginx/1.0.6
+      date:
+      - Sun, 14 Apr 2013 06:45:44 GMT
+      content-type:
+      - application/json; charset=utf-8
+      transfer-encoding:
+      - chunked
+      connection:
+      - close
+      vary:
+      - Accept-Encoding, Accept-Encoding
+      status:
+      - '403'
+      x-ratelimit-limit:
+      - '2000'
+      x-ratelimit-remaining:
+      - '2000'
+      x-thanks:
+      - For using AngelList. Rock on.
+      x-runtime:
+      - '35'
+      etag:
+      - ! '"0c13384ccaf0ae7c9e1ff289e0070619"'
+      cache-control:
+      - private, max-age=0, must-revalidate
+    body:
+      encoding: ASCII-8BIT
+      string: ! '{"error":"forbidden","error_description":""}'
+    http_version: !!null 
+  recorded_at: Sun, 14 Apr 2013 06:45:44 GMT
+recorded_with: VCR 2.4.0
+

data/spec/fixtures/cassettes/errors/too_many_requests.yml

@@ -0,0 +1,53 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.angel.co/1/me
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      User-Agent:
+      - AngellistApi Ruby Gem 1.0.5
+      Authorization:
+      - Bearer <ANGELLIST_ACCESS_TOKEN>
+  response:
+    status:
+      code: 403
+      message: !!null 
+    headers:
+      server:
+      - nginx/1.0.6
+      date:
+      - Sun, 14 Apr 2013 06:45:44 GMT
+      content-type:
+      - application/json; charset=utf-8
+      transfer-encoding:
+      - chunked
+      connection:
+      - close
+      vary:
+      - Accept-Encoding, Accept-Encoding
+      status:
+      - '403'
+      x-ratelimit-limit:
+      - '2000'
+      x-ratelimit-remaining:
+      - '0'
+      x-thanks:
+      - For using AngelList. Rock on.
+      x-runtime:
+      - '35'
+      etag:
+      - ! '"0c13384ccaf0ae7c9e1ff289e0070619"'
+      cache-control:
+      - private, max-age=0, must-revalidate
+    body:
+      encoding: ASCII-8BIT
+      string: ! '{"error":"over_limit","error_description":"You are currently over your rate limit."}'
+    http_version: !!null 
+  recorded_at: Sun, 14 Apr 2013 06:45:44 GMT
+recorded_with: VCR 2.4.0
+

data/spec/integration/errors_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe 'Errors' do
+  let(:client) { AngellistApi::Client.new }
+
+  describe AngellistApi::Error::TooManyRequests do
+    context 'when response is an over rate limit error',
+      :vcr => { :cassette_name => 'errors/too_many_requests' } do
+
+      it 'is raised' do
+        expect { client.me }.to raise_error described_class
+      end
+    end
+
+    context 'when response is some other 403 Forbidden error',
+      :vcr => { :cassette_name => 'errors/forbidden' } do
+
+      it 'is not raised' do
+        expect { client.me }.to raise_error AngellistApi::Error::Forbidden
+      end
+    end
+  end
+end
+

data/spec/support/http_headers.rb

@@ -0,0 +1,8 @@
+module HttpHeaders
+  # Faraday response headers are wrapped with a utility Hash subclass that
+  # normalizes case, underscored Symbols, etc.
+  def headerize(hash)
+    Faraday::Utils::Headers.new(hash)
+  end
+end
+

data/spec/unit/lib/angellist_api/client/follows_spec.rb

@@ -32,7 +32,9 @@ describe AngellistApi::Client::Follows do
   describe "#get_user_followers" do
     it "gets 1/users/<id>/followers" do
       id = "123"
-      client.should_receive(:get).with("1/users/#{id}/followers").and_return("success")
+      client.should_receive(:get).
+        with("1/users/#{id}/followers", {}).
+        and_return("success")
       client.get_user_followers(id).should == "success"
     end
   end
@@ -40,7 +42,9 @@ describe AngellistApi::Client::Follows do
   describe "#get_user_follower_ids" do
     it "gets 1/users/<id>/followers/ids" do
       id = "123"
-      client.should_receive(:get).with("1/users/#{id}/followers/ids").and_return("success")
+      client.should_receive(:get).
+        with("1/users/#{id}/followers/ids", {}).
+        and_return("success")
       client.get_user_follower_ids(id).should == "success"
     end
   end
@@ -66,7 +70,9 @@ describe AngellistApi::Client::Follows do
   describe "#get_startup_followers" do
     it "gets 1/startups/<id>/followers" do
       id = "123"
-      client.should_receive(:get).with("1/startups/#{id}/followers").and_return("success")
+      client.should_receive(:get).
+        with("1/startups/#{id}/followers", {}).
+        and_return("success")
       client.get_startup_followers(id).should == "success"
     end
   end
@@ -74,7 +80,9 @@ describe AngellistApi::Client::Follows do
   describe "#get_startup_follower_ids" do
     it "gets 1/startups/<id>/followers/ids" do
       id = "123"
-      client.should_receive(:get).with("1/startups/#{id}/followers/ids").and_return("success")
+      client.should_receive(:get).
+        with("1/startups/#{id}/followers/ids", {}).
+        and_return("success")
       client.get_startup_follower_ids(id).should == "success"
     end
   end

data/spec/unit/lib/angellist_api/client/tags_spec.rb

@@ -14,7 +14,9 @@ describe AngellistApi::Client::Tags do
   describe "#get_tag_children" do
     it "gets 1/tags/<id>/children" do
       id = "123"
-      client.should_receive(:get).with("1/tags/#{id}/children").and_return("success")
+      client.should_receive(:get).
+        with("1/tags/#{id}/children", {}).
+        and_return("success")
       client.get_tag_children(id).should == "success"
     end
   end
@@ -22,7 +24,9 @@ describe AngellistApi::Client::Tags do
   describe "#get_tag_parents" do
     it "gets 1/tags/<id>/parents" do
       id = "123"
-      client.should_receive(:get).with("1/tags/#{id}/parents").and_return("success")
+      client.should_receive(:get).
+        with("1/tags/#{id}/parents", {}).
+        and_return("success")
       client.get_tag_parents(id).should == "success"
     end
   end

data/spec/unit/lib/angellist_api/error_spec.rb

@@ -1,124 +1,133 @@
 require 'spec_helper'
 
 describe AngellistApi::Error do
+  include HttpHeaders
 
-  describe "#initialize" do
-    context "message parameter" do
-      it "does not raise an error if it is nil" do
-        expect { AngellistApi::Error.new(nil, :header => "data") }.to_not raise_error
-      end
-
-      it "builds an error with the given message" do
-        error = AngellistApi::Error.new("bad data", :header => 'data')
-        error.message.should == "bad data"
-      end
+  describe '#new' do
+    specify 'message parameter can be nil' do
+      expect { AngellistApi::Error.new(nil, :header => 'data') }.to_not raise_error
     end
 
-    context "http_headers parameter" do
-      it "raises an exception if no http headers are passed" do
-        expect { AngellistApi::Error.new("some message", nil) }.to raise_error(ArgumentError, "odd number of arguments for Hash")
-      end
-
-      it "raises an exception if the params cant be converted to a hash" do
-        expect { AngellistApi::Error.new("some message", "header") }.to raise_error(ArgumentError, "odd number of arguments for Hash")
-      end
+    it 'builds an error with the given message' do
+      error = AngellistApi::Error.new('bad data', :header => 'data')
+      error.message.should == 'bad data'
+    end
 
-      it "is set with the params" do
-        error = AngellistApi::Error.new("some message", :some => "value")
-        error.http_headers.should == { :some => "value" }
-      end
+    it 'sets http_headers attribute' do
+      error = AngellistApi::Error.new('some message', :some => 'value')
+      error.http_headers.should == { :some => 'value' }
     end
   end
 
-  describe "#ratelimit_reset" do
-    it "returns the time set as x-rate-limit-reset if it's set" do
-      time1 = Time.now.to_i
-      time2 = time1 + 3600
-      error = AngellistApi::Error.new("message", {'x-ratelimit-reset' => time1, 'X-RateLimit-Reset' => time2})
-      error.ratelimit_reset.should == Time.at(time1)
-    end
+  # NOTE: AngelList doesn't actually support this yet...
+  describe '#ratelimit_reset' do
+    subject { described_class.new('message', headers).ratelimit_reset }
+
+    context 'with X-RateLimit-Reset header set' do
+      let(:unixtime) { Time.now.to_i }
+      let(:headers) { headerize('X-RateLimit-Reset' => unixtime) }
 
-    it "returns the time set as X-RateLimit-Reset if x-rate-limit-reset is empty" do
-      time = Time.now.to_i
-      error = AngellistApi::Error.new("message", {'x-ratelimit-reset' => nil, 'X-RateLimit-Reset' => time})
-      error.ratelimit_reset.should == Time.at(time)
+      it 'returns the time of reset' do
+        subject.should == Time.at(unixtime)
+      end
     end
 
-    it "returns 0 if both X-RateLimit-Reset or x-rate-limit-reset are not set" do
-      error = AngellistApi::Error.new("message", {})
-      error.ratelimit_reset.should == Time.at(0)
+    context 'with X-RateLimit-Reset unset' do
+      let(:headers) { headerize({}) }
+      it { should be_nil }
     end
   end
 
-  describe "#ratelimit_limit" do
-    it "returns the number set as x-rate-limit-limit if it's set" do
-      error = AngellistApi::Error.new("message", {'x-ratelimit-limit' => 500, 'X-RateLimit-Limit' => 400})
-      error.ratelimit_limit.should == 500
-    end
+  describe '#ratelimit_limit' do
+    subject { described_class.new('message', headers).ratelimit_limit }
 
-    it "returns the number set as X-RateLimit-Limit if x-rate-limit-limit is empty" do
-      error = AngellistApi::Error.new("message", {'x-ratelimit-limit' => nil, 'X-RateLimit-Limit' => 600})
-      error.ratelimit_limit.should == 600
+    context 'with X-RateLimit-Limit header set' do
+      let(:limit) { '1000' }
+      let(:headers) { headerize('X-RateLimit-Limit' => limit) }
+
+      it 'returns the limit as an integer' do
+        subject.should eq 1000
+      end
     end
 
-    it "returns 0 if both X-RateLimit-Limit or x-rate-limit-limit are not set" do
-      error = AngellistApi::Error.new("message", {})
-      error.ratelimit_limit.should == 0
+    context 'with X-RateLimit-Limit unset' do
+      let(:headers) { headerize({}) }
+      it { should be_nil }
     end
   end
 
-  describe "#ratelimit_remaining" do
-    it "returns the number set as x-rate-limit-remaining if it's set" do
-      error = AngellistApi::Error.new("message", {'x-ratelimit-remaining' => 22, 'X-RateLimit-Remaining' => 23})
-      error.ratelimit_remaining.should == 22
-    end
+  describe '#ratelimit_remaining' do
+    subject { described_class.new('message', headers).ratelimit_remaining }
+
+    context 'with X-RateLimit-Remaining header set' do
+      let(:remaining) { '22' }
+      let(:headers) { headerize('X-RateLimit-Remaining' => remaining) }
 
-    it "returns the number set as X-RateLimit-Remaining if x-rate-limit-remaining is empty" do
-      error = AngellistApi::Error.new("message", {'x-ratelimit-remaining' => nil, 'X-RateLimit-Remaining' => 32})
-      error.ratelimit_remaining.should == 32
+      it 'returns remaining request count as an integer' do
+        subject.should eq 22
+      end
     end
 
-    it "returns 0 if both X-RateLimit-Remaining or x-rate-limit-remaining are not set" do
-      error = AngellistApi::Error.new("message", {})
-      error.ratelimit_remaining.should == 0
+    context 'with X-RateLimit-Remaining unset' do
+      let(:headers) { headerize({}) }
+      it { should be_nil }
     end
   end
 
-  describe "#retry_after" do
-    context "a normal Error object" do
-      let(:error) { AngellistApi::Error.new("message", {}) }
+  # NOTE: AngelList doesn't actually support this yet...
+  describe '#retry_after' do
+    subject { described_class.new('message', headerize({})).retry_after }
+    let(:now) { Time.now }
+
+    before { Timecop.freeze(now) }
+    after  { Timecop.return }
 
-      it "give you the time in seconds when it is acceptable to make another call" do
-        Timecop.freeze(Time.now) do
-          error.should_receive(:ratelimit_reset) { Time.now + 3600 }
-          error.retry_after.should == 3600
-        end
+    context 'when limit reset time is known' do
+      let(:reset_at) { now + 3600 }
+
+      before do
+        described_class.any_instance.stub(:ratelimit_reset).and_return(reset_at)
       end
 
-      it "return 0 if the ratelimit_reset time is in the past" do
-        Timecop.freeze(Time.now) do
-          error.should_receive(:ratelimit_reset) { Time.now - 3600 }
-          error.retry_after.should == 0
-        end
+      it 'gives time in seconds until it is acceptable to make another call' do
+        subject.should eq reset_at - now
       end
     end
 
-    context "an EnhanceYourCalm Error object" do
-      it "return the number of seconds set as retry-after if it's set" do
-        error = AngellistApi::Error::EnhanceYourCalm.new("message", {'retry-after' => 12, 'Retry-After' => 13})
-        error.retry_after.should == 12
-      end
+    context 'when limit reset time is not known' do
+      it { should be_nil }
+    end
 
-      it "return the number set as Retry-After if retry-after is empty" do
-        error = AngellistApi::Error::EnhanceYourCalm.new("message", {'retry-after' => nil, 'Retry-After' => 16})
-        error.retry_after.should == 16
-      end
+    context 'when limit reset time is past' do
+      let(:reset_at) { now - 3600 }
 
-      it "return 0 if both Retry-After or retry-after are not set" do
-        error = AngellistApi::Error::EnhanceYourCalm.new("message", {})
-        error.retry_after.should == 0
+      before do
+        described_class.any_instance.stub(:ratelimit_reset).and_return(reset_at)
       end
+
+      it { should be_zero }
+    end
+  end
+end
+
+# NOTE: AngelList doesn't actually support this yet...
+describe AngellistApi::Error::TooManyRequests do
+  include HttpHeaders
+
+  subject { described_class.new('message', headers).retry_after }
+
+  context 'with Retry-After header set' do
+    let(:wait) { '12' }
+    let(:headers) { headerize('Retry-After' => wait) }
+
+    it 'returns the seconds to wait until retrying' do
+      subject.should == 12
     end
   end
+
+  context 'with Retry-After unset' do
+    let(:headers) { headerize({}) }
+    it { should be_nil }
+  end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: angellist_api
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-27 00:00:00.000000000 Z
+date: 2013-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -203,12 +203,12 @@ files:
 - lib/angellist_api/core_ext/hash.rb
 - lib/angellist_api/error/bad_gateway.rb
 - lib/angellist_api/error/bad_request.rb
-- lib/angellist_api/error/enhance_your_calm.rb
 - lib/angellist_api/error/forbidden.rb
 - lib/angellist_api/error/internal_server_error.rb
 - lib/angellist_api/error/not_acceptable.rb
 - lib/angellist_api/error/not_found.rb
 - lib/angellist_api/error/service_unavailable.rb
+- lib/angellist_api/error/too_many_requests.rb
 - lib/angellist_api/error/unauthorized.rb
 - lib/angellist_api/error.rb
 - lib/angellist_api/request/angellist_api_oauth.rb
@@ -224,6 +224,8 @@ files:
 - README.md
 - CHANGELOG.md
 - spec/fixtures/cassettes/activity_feeds.yml
+- spec/fixtures/cassettes/errors/forbidden.yml
+- spec/fixtures/cassettes/errors/too_many_requests.yml
 - spec/fixtures/cassettes/follows.yml
 - spec/fixtures/cassettes/jobs.yml
 - spec/fixtures/cassettes/messages.yml
@@ -237,6 +239,7 @@ files:
 - spec/fixtures/cassettes/tags.yml
 - spec/fixtures/cassettes/users.yml
 - spec/integration/activity_feeds_spec.rb
+- spec/integration/errors_spec.rb
 - spec/integration/follows_spec.rb
 - spec/integration/jobs_spec.rb
 - spec/integration/messages_spec.rb
@@ -251,6 +254,7 @@ files:
 - spec/integration/users_spec.rb
 - spec/spec_helper.rb
 - spec/support/authentication.rb
+- spec/support/http_headers.rb
 - spec/support/vcr.rb
 - spec/unit/lib/angellist_api/api_spec.rb
 - spec/unit/lib/angellist_api/authentication_spec.rb
@@ -285,7 +289,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 704109515206394600
+      hash: 74367016323838857
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -294,7 +298,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 704109515206394600
+      hash: 74367016323838857
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -303,6 +307,8 @@ specification_version: 3
 summary: Ruby wrapper for the Angellist API.
 test_files:
 - spec/fixtures/cassettes/activity_feeds.yml
+- spec/fixtures/cassettes/errors/forbidden.yml
+- spec/fixtures/cassettes/errors/too_many_requests.yml
 - spec/fixtures/cassettes/follows.yml
 - spec/fixtures/cassettes/jobs.yml
 - spec/fixtures/cassettes/messages.yml
@@ -316,6 +322,7 @@ test_files:
 - spec/fixtures/cassettes/tags.yml
 - spec/fixtures/cassettes/users.yml
 - spec/integration/activity_feeds_spec.rb
+- spec/integration/errors_spec.rb
 - spec/integration/follows_spec.rb
 - spec/integration/jobs_spec.rb
 - spec/integration/messages_spec.rb
@@ -330,6 +337,7 @@ test_files:
 - spec/integration/users_spec.rb
 - spec/spec_helper.rb
 - spec/support/authentication.rb
+- spec/support/http_headers.rb
 - spec/support/vcr.rb
 - spec/unit/lib/angellist_api/api_spec.rb
 - spec/unit/lib/angellist_api/authentication_spec.rb

data/lib/angellist_api/error/enhance_your_calm.rb

@@ -1,13 +0,0 @@
-require 'angellist_api/error'
-
-module AngellistApi
-  # Raised when AngellistApi returns the HTTP status code 420
-  class Error::EnhanceYourCalm < AngellistApi::Error
-    # The number of seconds your application should wait before requesting date
-    # from the API again
-    def retry_after
-      @http_headers.values_at('retry-after', 'Retry-After').detect {|value| value }.to_i
-    end
-  end
-end
-