pco_api 1.3.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb681a310a78eeb3ac455edc7ab2b4696a246e74a54077b1f0c5ce26e9a31c10
-  data.tar.gz: fe3398a9fd3c50f784e139fd65879a31cdf56d210a97e3e46e5f66309058b0f6
+  metadata.gz: 80591277ecc37d298f7a7c68c35d32cd9f5d117f401ee6c811a417aab5b9e494
+  data.tar.gz: 756f395bb87741e0786452d1391a47c08bc3a36df064f8fa6d368706e49128de
 SHA512:
-  metadata.gz: 41d1955114ffe087506d63c3907ebad24f9c0a34e9e3784d620bc2be8080bf309b3eb0fbed52a60b5805e1e2cf0ccfe07d6adcc0072a48f78336461d9e7ca14b
-  data.tar.gz: 1ead2832a8c2f62c13845b5c7c28254494efdbdedf404b6e70ccbd9791fd12ee9932acfad3ed9255dc9d3451eaf4dd4841cb2a1ed99721304a15fc5260c1301d
+  metadata.gz: a64b77f5502cb0e7a83b3841596002402ed6484738185f0397d4bd9fccd451c3b3494e95a7e9c13a22f9123e20509c484b77528db19a2b972e8bfc61db43ff3d
+  data.tar.gz: a7c05f672220939fc491e20e334ba5511173ac4ed50e3bf3969530d7f1556cd7ed8147b0172dc1d727ed9696e134c32ab4a7cb3564585cfd96abea2743a8ff26

data/README.md

@@ -210,6 +210,7 @@ The following errors may be raised by the library, depending on the API response
 | 404                 | `PCO::API::Errors::NotFound` < `PCO::API::Errors::ClientError`            |
 | 405                 | `PCO::API::Errors::MethodNotAllowed` < `PCO::API::Errors::ClientError`    |
 | 422                 | `PCO::API::Errors::UnprocessableEntity` < `PCO::API::Errors::ClientError` |
+| 429                 | `PCO::API::Errors::TooManyRequests` < `PCO::API::Errors::ClientError`     |
 | other 4xx errors    | `PCO::API::Errors::ClientError`                                           |
 | 500                 | `PCO::API::Errors::InternalServerError` < `PCO::API::Errors::ServerError` |
 | other 5xx errors    | `PCO::API::Errors::ServerError`                                           |
@@ -221,6 +222,7 @@ The exception object has the following methods:
 | status  | HTTP status code returned by the server     |
 | message | the message returned by the API             |
 | detail  | the full error response returned by the API |
+| headers | hash of HTTP headers returned by the API    |
 
 The `message` should be a simple string given by the API, e.g. "Resource Not Found".
 
@@ -229,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/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
@@ -126,15 +137,25 @@ module PCO
         Faraday.new(url: url) do |faraday|
           faraday.response :json, content_type: /\bjson$/
           if @basic_auth_token && @basic_auth_secret
-            faraday.basic_auth @basic_auth_token, @basic_auth_secret
+            faraday.request :basic_auth, @basic_auth_token, @basic_auth_secret
           elsif @oauth_access_token
-            faraday.headers['Authorization'] = "Bearer #{@oauth_access_token}"
+            faraday.request :authorization, 'Bearer', @oauth_access_token
           else
             fail Errors::AuthRequiredError, "You must specify either HTTP basic auth credentials or an OAuth2 access token."
           end
           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
+end

data/lib/pco/api/version.rb

@@ -1,5 +1,5 @@
 module PCO
   module API
-    VERSION = '1.3.0'
+    VERSION = '2.0.1'
   end
 end

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/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

data/spec/pco/api_spec.rb

@@ -0,0 +1,9 @@
+require_relative '../spec_helper'
+
+describe PCO::API do
+  describe '.new' do
+    it 'creates a new Endpoint instance' do
+      expect(described_class.new(basic_auth_token: 'abc123', basic_auth_secret: 'xyz789').class).to eq(PCO::API::Endpoint)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pco_api
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Planning Center Online
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-21 00:00:00.000000000 Z
+date: 2022-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: excon
   requirement: !ruby/object:Gem::Requirement
@@ -109,12 +109,13 @@ files:
 - lib/pco/api/version.rb
 - lib/pco_api.rb
 - spec/pco/api/endpoint_spec.rb
+- spec/pco/api_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/planningcenter/pco_api_ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -129,10 +130,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: API wrapper for api.planningcenteronline.com
 test_files:
+- spec/pco/api_spec.rb
 - spec/pco/api/endpoint_spec.rb
 - spec/spec_helper.rb