pco_api 1.3.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eee1d9d3e7b4407dfc0b5f183021246c34a1467936fb77743c4cd45a1767b9b7
-  data.tar.gz: 014ec30ad0b2c1b814b10da5ee26716f55cea5bf85a782e4230feaadf7f0c260
+  metadata.gz: 6e9b56ec41159e601c1afb0b4fa004797f91d0ae845ba396e09617738f98cdea
+  data.tar.gz: 931ed18a093f13ba313d6070b2307d888db9d38fe434308f76e6b0b5b0cf9715
 SHA512:
-  metadata.gz: b36cca693f502f4c4b123aa22c61b72d41ccd51457eee7c2aef87454559d1fb7ffe85241ec97ab8832925830f864e773ce22b319d278f474245826f44bfe20e1
-  data.tar.gz: 3c16320118da5aee58fcec347cae41df8c215d176331863d61d079a0b47bbc23998816ff09dbecbce888177faa7847da2f13f66fe4c984622fb74cb641eb9372
+  metadata.gz: 21f690d99a0ea0896ab49a416d64ae802c7f993a6f63afa725b7e6ab098a2049a6d7aad3e1dc7b0f230eb2db4bb2faceba7760d054b0c8595138708438348a66
+  data.tar.gz: cc5b2478ae1de0b2911594483573266d9f3447078b81529c97e9765c209d49af7b9c99f80a14a089d6c92d0c7d5be3e33cde7a17a4d25cfc4ad64e0f0d030e37

data/README.md

@@ -231,6 +231,17 @@ In the case of validation errors, the `message` is a summary string built from t
 Alternatively, you may rescue `PCO::API::Errors::BaseError` and branch your code based on
 the status code returned by calling `error.status`.
 
+### TooManyRequests Error
+
+By default, PCO::API::Endpoint will sleep and retry a request that fails with TooManyRequests due
+to rate limiting. If you would rather catch and handle such errors yourself, you can disable this
+behavior like this:
+
+```ruby
+api = PCO::API.new(...)
+api.retry_when_rate_limited = false
+```
+
 ## Copyright & License
 
 Copyright Ministry Centered Technologies. Licensed MIT.

data/lib/pco/api.rb

@@ -3,9 +3,10 @@ require_relative 'api/errors'
 
 module PCO
   module API
-    module_function
-    def new(**args)
-      Endpoint.new(**args)
+    class << self
+      def new(**args)
+        Endpoint.new(**args)
+      end
     end
   end
 end

data/lib/pco/api/endpoint.rb

@@ -12,6 +12,8 @@ module PCO
     class Endpoint
       attr_reader :url, :last_result
 
+      attr_accessor :retry_when_rate_limited
+
       def initialize(url: URL, oauth_access_token: nil, basic_auth_token: nil, basic_auth_secret: nil, connection: nil)
         @url = url
         @oauth_access_token = oauth_access_token
@@ -19,6 +21,7 @@ module PCO
         @basic_auth_secret = basic_auth_secret
         @connection = connection || _build_connection
         @cache = {}
+        @retry_when_rate_limited = true
       end
 
       def method_missing(method_name, *_args)
@@ -29,7 +32,7 @@ module PCO
         _build_endpoint(id.to_s)
       end
 
-      def respond_to?(method_name)
+      def respond_to?(method_name, _include_all = false)
         endpoint = _build_endpoint(method_name.to_s)
         begin
           endpoint.get
@@ -43,6 +46,8 @@ module PCO
       def get(params = {})
         @last_result = @connection.get(@url, params)
         _build_response(@last_result)
+      rescue Errors::TooManyRequests => e
+        _retry_after_timeout?(e) ? retry : raise
       end
 
       def post(body = {})
@@ -50,6 +55,8 @@ module PCO
           req.body = _build_body(body)
         end
         _build_response(@last_result)
+      rescue Errors::TooManyRequests => e
+        _retry_after_timeout?(e) ? retry : raise
       end
 
       def patch(body = {})
@@ -57,6 +64,8 @@ module PCO
           req.body = _build_body(body)
         end
         _build_response(@last_result)
+      rescue Errors::TooManyRequests => e
+        _retry_after_timeout?(e) ? retry : raise
       end
 
       def delete
@@ -66,6 +75,8 @@ module PCO
         else
           _build_response(@last_result)
         end
+      rescue Errors::TooManyRequests => e
+        _retry_after_timeout?(e) ? retry : raise
       end
 
       private
@@ -135,6 +146,16 @@ module PCO
           faraday.adapter :excon
         end
       end
+
+      def _retry_after_timeout?(e)
+        if @retry_when_rate_limited
+          secs = e.headers['Retry-After']
+          Kernel.sleep(secs ? secs.to_i : 1)
+          true
+        else
+          false
+        end
+      end
     end
   end
 end

data/lib/pco/api/version.rb

@@ -1,5 +1,5 @@
 module PCO
   module API
-    VERSION = '1.3.1'
+    VERSION = '2.0.0'
   end
 end

data/spec/pco/api/endpoint_spec.rb

@@ -124,6 +124,48 @@ describe PCO::API::Endpoint do
         }.to raise_error(PCO::API::Errors::ServerError)
       end
     end
+
+    context 'given a 429 error due to rate limiting' do
+      subject { base.people.v2 }
+
+      let(:result) do
+        {
+          'type'  => 'Organization',
+          'id'    => '1',
+          'name'  => 'Ministry Centered Technologies',
+          'links' => {}
+        }
+      end
+
+      before do
+        stub_request(:get, 'https://api.planningcenteronline.com/people/v2')
+          .to_return([
+            { status: 429, headers: { 'retry-after' => '2' } },
+            { status: 200, body: { data: result }.to_json, headers: { 'Content-Type' => 'application/vnd.api+json' } }
+          ])
+      end
+
+      context 'given retry_when_rate_limited is true' do
+        before do
+          subject.retry_when_rate_limited = true
+        end
+
+        it 'sleeps, then makes the call again' do
+          expect(Kernel).to receive(:sleep).with(2)
+          expect(subject.get).to be_a(Hash)
+        end
+      end
+
+      context 'given retry_when_rate_limited is false' do
+        before do
+          subject.retry_when_rate_limited = false
+        end
+
+        it 'raises the TooManyRequests error' do
+          expect { subject.get }.to raise_error(PCO::API::Errors::TooManyRequests)
+        end
+      end
+    end
   end
 
   describe '#post' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pco_api
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Planning Center Online