popit 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 288679ecd99d837bbce6221def9efc09ed239df6
-  data.tar.gz: 4ebff4b12ee6e79ce02635c66b5a27578c5bc315
+  metadata.gz: 9e107fa8a67b9fb91253acc05db2c906befc9463
+  data.tar.gz: 5acea070cae8ef2839b9463406d0a8e00de81938
 SHA512:
-  metadata.gz: 742c8c9428d52ad353afef5e377c365022e5f003b3967ea2862df55b3e23fcc985b2911da387f1ba81663fe4e75103c00c6adc3cf23e9f59e4de7b90aa8bf1bd
-  data.tar.gz: 62e57d47b2e26309385a539dd2fee7b8184b3fa1a3947a5cb6e4d9296cc966e423b1103783daacb661ae32cd91066c8f72db46caff4c7c59be391bccc5ef850f
+  metadata.gz: 41a16756393b990c236499ca3ca00ca63ed2cfc1c564543212c1206b17e24d1432af99cc382e6383c2ab34128beceeb825b3dfafc71c4c0f6ed541f2ca77bd66
+  data.tar.gz: 6a5a620436db1c783ca726cb94d68968c80de9fdd9d523317b91398eeb9908936cc51cc5058338e2c9b08bdf579bb224a4dcef030ad3bb288fe0746ddacb23bc

data/lib/popit/version.rb

@@ -1,3 +1,3 @@
 class PopIt
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/lib/popit.rb

@@ -39,6 +39,8 @@ class PopIt
   attr_reader :username
   # The user's password.
   attr_reader :password
+  # The maximum number of retries in case of HTTP 503 Service Unavailable errors.
+  attr_reader :max_retries
 
   # Initializes a PopIt API client.
   #
@@ -49,17 +51,21 @@ class PopIt
   # @option opts [String] :version the PopIt API version, eg "v1"
   # @option opts [String] :user a user name
   # @option opts [String] :password the user's password
+  # @option opts [String] :max_retries the maximum number of retries in case of
+  #  HTTP 503 Service Unavailable errors
   def initialize(opts = {})
     unless opts.has_key?(:instance_name)
       raise ArgumentError, 'Missing key :instance_name'
     end
 
     @instance_name = opts[:instance_name]
-    @host_name     = opts[:host_name] || 'popit.mysociety.org'
-    @port          = opts[:port]      || 80
-    @version       = opts[:version]   || 'v0.1'
+    @host_name     = opts[:host_name]   || 'popit.mysociety.org'
+    @port          = opts[:port]        || 80
+    @version       = opts[:version]     || 'v0.1'
     @username      = opts[:user]
     @password      = opts[:password]
+    @max_retries   = opts[:max_retries] || 0
+
   end
 
   # Sends a GET request.
@@ -101,6 +107,8 @@ class PopIt
 private
 
   def request(http_method, path, opts = {})
+    attempts ||= 0
+
     path = "http://#{instance_name}.#{host_name}:#{port}/api/#{version}/#{path}"
 
     response = case http_method
@@ -138,6 +146,14 @@ private
     end
 
     response.parsed_response && response.parsed_response['result']
+  rescue PopIt::ServiceUnavailable
+    attempts += 1
+    if attempts <= max_retries
+      sleep attempts ** 2
+      retry
+    else
+      raise
+    end
   end
 
   def method_missing(*args)

data/spec/popit_spec.rb

@@ -7,7 +7,7 @@ require 'yaml'
 # @see https://github.com/mysociety/popit/blob/master/lib/apps/api/api_v1.js
 describe PopIt do
   let :unauthenticated do
-    PopIt.new :instance_name => 'tttest'
+    PopIt.new(:instance_name => 'tttest')
   end
 
   let :authenticated do
@@ -18,13 +18,17 @@ describe PopIt do
     })
   end
 
+  let :exponential_backoff do
+    PopIt.new(:instance_name => 'tttest', :max_retries => 2)
+  end
+
   it 'should fail to send a request to a bad instance' do
-    api = PopIt.new :instance_name => '47cc67093475061e3d95369d'
+    api = PopIt.new(:instance_name => '47cc67093475061e3d95369d')
     expect { api.persons.get }.to raise_error(PopIt::PageNotFound)
   end
 
   it 'should fail to send a request to a bad version' do
-    api = PopIt.new :instance_name => 'tttest', :version => 'v0'
+    api = PopIt.new(:instance_name => 'tttest', :version => 'v0')
     expect { api.persons.get }.to raise_error(PopIt::PageNotFound, 'page not found')
   end
 
@@ -48,7 +52,7 @@ describe PopIt do
       end
 
       it 'should get one item by name' do
-        response = unauthenticated.persons.get :name => 'Foo'
+        response = unauthenticated.persons.get(:name => 'Foo')
         response.should be_an(Array)
       end
 
@@ -68,11 +72,11 @@ describe PopIt do
       end
 
       it 'should fail to create an item' do
-        expect {unauthenticated.persons.post :name => 'John Doe', :slug => 'john-doe'}.to raise_error(PopIt::NotAuthenticated, 'not authenticated')
+        expect {unauthenticated.persons.post(:name => 'John Doe', :slug => 'john-doe')}.to raise_error(PopIt::NotAuthenticated, 'not authenticated')
       end
 
       it 'should fail to update an item' do
-        expect {unauthenticated.persons(id).put :id => id, :name => 'John Doe', :slug => 'john-doe'}.to raise_error(PopIt::NotAuthenticated, 'not authenticated')
+        expect {unauthenticated.persons(id).put(:id => id, :name => 'John Doe', :slug => 'john-doe')}.to raise_error(PopIt::NotAuthenticated, 'not authenticated')
       end
 
       it 'should fail to delete an item' do
@@ -82,12 +86,12 @@ describe PopIt do
 
     context 'when authenticated' do
       it 'should create, update and delete an item' do
-        response = authenticated.persons.post :name => 'John Smith', :slug => 'john-smith', :contact_details => [{:type => 'email', :value => 'test@example.com'}]
+        response = authenticated.persons.post(:name => 'John Smith', :slug => 'john-smith', :contact_details => [{:type => 'email', :value => 'test@example.com'}])
         id = response['id']
         contact_detail_id = response['contact_details'][0]['id']
         response['name'].should == 'John Smith'
 
-        response = authenticated.persons(id).put :id => id, :name => 'John Doe', :slug => 'john-doe'
+        response = authenticated.persons(id).put(:id => id, :name => 'John Doe', :slug => 'john-doe')
         response.should == {
           'id'              => id,
           'name'            => 'John Doe',
@@ -111,5 +115,27 @@ describe PopIt do
         expect {authenticated.persons(id).get}.to raise_error(PopIt::PageNotFound, "id '#{id}' not found")
       end
     end
+
+    context 'when service unavailable' do
+      before :each do
+        PopIt.stub(:get) do
+          response = Net::HTTPServiceUnavailable.new('1.1', 503, 'Service Unavailable')
+          response.stub(:body => '', :code => '503')
+          HTTParty::Response.new(HTTParty::Request.new(Net::HTTP::Get, '/'), response, lambda {})
+        end
+      end
+
+      it 'should fail immediately' do
+        time = Time.now
+        expect {unauthenticated.persons.get}.to raise_error(PopIt::ServiceUnavailable)
+        Time.now.should be_within(1).of(time)
+      end
+
+      it 'should backoff exponentially' do
+        time = Time.now
+        expect {exponential_backoff.persons.get}.to raise_error(PopIt::ServiceUnavailable)
+        Time.now.should_not be_within(5).of(time)
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: popit
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Open North
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-08 00:00:00.000000000 Z
+date: 2014-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty