pco_api 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d1dc3d66fb23d3d8a8c5c76b90518ffc7782d797
-  data.tar.gz: 45679ff9c0d32e87f7f29004295070d85db456df
+SHA256:
+  metadata.gz: 6e9b56ec41159e601c1afb0b4fa004797f91d0ae845ba396e09617738f98cdea
+  data.tar.gz: 931ed18a093f13ba313d6070b2307d888db9d38fe434308f76e6b0b5b0cf9715
 SHA512:
-  metadata.gz: 336847bc5528ccc12b316646a889b72475aad57e8ad27f7eae91e13c53444733517c4bf8564f32719255f1abe30182babe9ac97adf30742f9ddafd2284258f25
-  data.tar.gz: 9ebecfee7f1c1006047bfc967d28693e0cd6eef8a1fbed23e781b14e8290cd270bd9beb8338c05e8a9e05312f38d8a3bf7077f072d235fc78c91d6ffe14c4001
+  metadata.gz: 21f690d99a0ea0896ab49a416d64ae802c7f993a6f63afa725b7e6ab098a2049a6d7aad3e1dc7b0f230eb2db4bb2faceba7760d054b0c8595138708438348a66
+  data.tar.gz: cc5b2478ae1de0b2911594483573266d9f3447078b81529c97e9765c209d49af7b9c99f80a14a089d6c92d0c7d5be3e33cde7a17a4d25cfc4ad64e0f0d030e37

data/README.md

@@ -42,6 +42,13 @@ gem install pco_api
     # GET /people/v2/households?order=name
     ```
 
+5. To query dataset according to `can_query_by` variables:
+
+    ```ruby
+    api.people.v2.people.get('where[membership]': 'Member')
+    # GET /people/v2/people?where[membership]=Member
+    ```
+
 ## Example
 
 ```ruby
@@ -203,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`                                           |
@@ -214,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".
 
@@ -222,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 2015, Ministry Centered Technologies. Licensed MIT.
+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

@@ -5,9 +5,15 @@ module PCO
   module API
     URL = 'https://api.planningcenteronline.com'
 
+    class Response < Hash
+      attr_accessor :headers
+    end
+
     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
@@ -15,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)
@@ -25,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
@@ -39,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 = {})
@@ -46,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 = {})
@@ -53,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
@@ -62,6 +75,8 @@ module PCO
         else
           _build_response(@last_result)
         end
+      rescue Errors::TooManyRequests => e
+        _retry_after_timeout?(e) ? retry : raise
       end
 
       private
@@ -69,7 +84,9 @@ module PCO
       def _build_response(result)
         case result.status
         when 200..299
-          result.body
+          res = Response[result.body]
+          res.headers = result.headers
+          res
         when 400
           fail Errors::BadRequest, result
         when 401
@@ -82,6 +99,8 @@ module PCO
           fail Errors::MethodNotAllowed, result
         when 422
           fail Errors::UnprocessableEntity, result
+        when 429
+          fail Errors::TooManyRequests, result
         when 400..499
           fail Errors::ClientError, result
         when 500
@@ -116,7 +135,6 @@ module PCO
 
       def _build_connection
         Faraday.new(url: url) do |faraday|
-          faraday.adapter :excon
           faraday.response :json, content_type: /\bjson$/
           if @basic_auth_token && @basic_auth_secret
             faraday.basic_auth @basic_auth_token, @basic_auth_secret
@@ -125,6 +143,17 @@ module PCO
           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

data/lib/pco/api/errors.rb

@@ -4,11 +4,12 @@ module PCO
       class AuthRequiredError < StandardError; end
 
       class BaseError < StandardError
-        attr_reader :status, :detail
+        attr_reader :status, :detail, :headers
 
         def initialize(response)
           @status = response.status
           @detail = response.body
+          @headers = response.headers
         end
 
         def to_s
@@ -52,6 +53,7 @@ module PCO
       class NotFound            < ClientError; end # 404
       class MethodNotAllowed    < ClientError; end # 405
       class UnprocessableEntity < ClientError; end # 422
+      class TooManyRequests     < ClientError; end # 429
 
       class ServerError         < BaseError;   end # 500..599
       class InternalServerError < ServerError; end # 500

data/lib/pco/api/version.rb

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

data/spec/pco/api/endpoint_spec.rb

@@ -50,6 +50,7 @@ describe PCO::API::Endpoint do
       it 'returns the result of making a GET request to the endpoint' do
         expect(@result).to be_a(Hash)
         expect(@result['data']).to eq(result)
+        expect(@result.headers).to eq('Content-Type' => 'application/vnd.api+json')
       end
     end
 
@@ -76,6 +77,7 @@ describe PCO::API::Endpoint do
                 end
         expect(error.status).to eq(404)
         expect(error.message).to eq('Resource Not Found')
+        expect(error.headers).to eq('Content-Type' => 'application/vnd.api+json')
       end
     end
 
@@ -122,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.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Planning Center Online
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-23 00:00:00.000000000 Z
+date: 2021-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: excon
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.45.3
+        version: 0.71.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.45.3
+        version: 0.71.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -109,6 +109,7 @@ 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:
@@ -129,12 +130,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.0.3
 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
-has_rdoc: