pco_api 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b68b2a46a5e0f3b3c6f50d5d08ec6ef55ee62ec5
-  data.tar.gz: 9878875451998da55659e8302aedc68268ca5007
+SHA256:
+  metadata.gz: cb681a310a78eeb3ac455edc7ab2b4696a246e74a54077b1f0c5ce26e9a31c10
+  data.tar.gz: fe3398a9fd3c50f784e139fd65879a31cdf56d210a97e3e46e5f66309058b0f6
 SHA512:
-  metadata.gz: c017053bd53b307354404f3b27d112fa7c7533e6a08179c02082ecf78bd6ded3bcee21472ac4f894e88422160614ef52238d99b4e4024d266d711ac52590616f
-  data.tar.gz: 856dfbb6b547dcf5e1700b03cf26381c563ba1b0d42156d7ca70ae71ce0a154c4e0a847b74170b97d8b201a522a7901926dd0d94648ab41ae8cfbb8dd6cbf5d1
+  metadata.gz: 41d1955114ffe087506d63c3907ebad24f9c0a34e9e3784d620bc2be8080bf309b3eb0fbed52a60b5805e1e2cf0ccfe07d6adcc0072a48f78336461d9e7ca14b
+  data.tar.gz: 1ead2832a8c2f62c13845b5c7c28254494efdbdedf404b6e70ccbd9791fd12ee9932acfad3ed9255dc9d3451eaf4dd4841cb2a1ed99721304a15fc5260c1301d

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
@@ -224,4 +231,4 @@ the status code returned by calling `error.status`.
 
 ## Copyright & License
 
-Copyright 2015, Ministry Centered Technologies. Licensed MIT.
+Copyright Ministry Centered Technologies. Licensed MIT.

data/lib/pco/api/endpoint.rb

@@ -5,6 +5,10 @@ module PCO
   module API
     URL = 'https://api.planningcenteronline.com'
 
+    class Response < Hash
+      attr_accessor :headers
+    end
+
     class Endpoint
       attr_reader :url, :last_result
 
@@ -69,7 +73,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 +88,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

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.2'
+    VERSION = '1.3.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
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pco_api
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Planning Center Online
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-08-17 00:00:00.000000000 Z
+date: 2020-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -42,16 +42,16 @@ dependencies:
   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
@@ -114,7 +114,7 @@ homepage: https://github.com/planningcenter/pco_api_ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -129,9 +129,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: API wrapper for api.planningcenteronline.com
 test_files: