pco_api 1.1.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fdf363aaf74caadf35c535566554358fbabe8a86
-  data.tar.gz: b1222c3d2349a5617827b3256e63f53ac908d938
+SHA256:
+  metadata.gz: cb681a310a78eeb3ac455edc7ab2b4696a246e74a54077b1f0c5ce26e9a31c10
+  data.tar.gz: fe3398a9fd3c50f784e139fd65879a31cdf56d210a97e3e46e5f66309058b0f6
 SHA512:
-  metadata.gz: f2d8c40236d7c1cc27c3e51858aa42586fdfbc779143707da8293d960d2618b107ed8cd1a44a7d4be01b6b8cd929c48504ddd8f731e61d627879c783123c242a
-  data.tar.gz: 0d75528107787fb437955582c5492aa57d7585ddbec65ebc40f2e1435a20b4e01d908fce67a8d7235f4c41780f0dd619b83e1fd11dd8daa3244d9e0ed3f65fad
+  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
@@ -63,22 +70,24 @@ api.people.v2.people.get(order: 'last_name')
     {
       "type" => "Person",
       "id" => "271",
-      "first_name" => "Jean",
-      "middle_name" => nil,
-      "last_name" => "Abernathy",
-      "birthdate" => "1885-01-01",
-      "anniversary" => nil,
-      "gender" => "F",
-      "grade" => -1,
-      "child" => false,
-      "status" => "active",
-      "school_type" => nil,
-      "graduation_year" => nil,
-      "site_administrator" => false,
-      "people_permissions" => nil,
-      "created_at" => "2015-04-01T20:18:22Z",
-      "updated_at" => "2015-04-10T18:59:51Z",
-      "avatar" => nil,
+      "attributes" => {
+        "first_name" => "Jean",
+        "middle_name" => nil,
+        "last_name" => "Abernathy",
+        "birthdate" => "1885-01-01",
+        "anniversary" => nil,
+        "gender" => "F",
+        "grade" => -1,
+        "child" => false,
+        "status" => "active",
+        "school_type" => nil,
+        "graduation_year" => nil,
+        "site_administrator" => false,
+        "people_permissions" => nil,
+        "created_at" => "2015-04-01T20:18:22Z",
+        "updated_at" => "2015-04-10T18:59:51Z",
+        "avatar" => nil,
+      },
       "links" => {
         "self" => "https://api.planningcenteronline.com/people/v2/people/271"
       }
@@ -91,7 +100,7 @@ api.people.v2.people.get(order: 'last_name')
     "next" => {
       "offset" => 25
     },
-    "orderable_by" => [
+    "can_order_by" => [
       "first_name",
       "middle_name",
       "last_name",
@@ -108,7 +117,7 @@ api.people.v2.people.get(order: 'last_name')
       "created_at",
       "updated_at"
     ],
-    "filterable_by" => [
+    "can_query_by" => [
       "first_name",
       "middle_name",
       "last_name",
@@ -137,7 +146,11 @@ api.people.v2.people.get(order: 'last_name')
       "name_suffix",
       "field_data",
       "apps"
-    ]
+    ],
+    "parent" => {
+      "id" => "1",
+      "type" => "Organization"
+    }
   }
 }
 ```
@@ -203,16 +216,19 @@ The following errors may be raised by the library, depending on the API response
 
 The exception object has the following methods:
 
-| Method  | Content                                 |
-| ------- | --------------------------------------- |
-| status  | HTTP status code returned by the server |
-| message | the message returned by the API         |
+| Method  | Content                                     |
+| ------- | ------------------------------------------- |
+| status  | HTTP status code returned by the server     |
+| message | the message returned by the API             |
+| detail  | the full error response returned by the API |
 
 The `message` should be a simple string given by the API, e.g. "Resource Not Found".
 
+In the case of validation errors, the `message` is a summary string built from the raw `detail`.
+
 Alternatively, you may rescue `PCO::API::Errors::BaseError` and branch your code based on
 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
@@ -116,7 +124,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 +132,7 @@ 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
     end

data/lib/pco/api/errors.rb

@@ -4,32 +4,59 @@ module PCO
       class AuthRequiredError < StandardError; end
 
       class BaseError < StandardError
-        attr_reader :status
+        attr_reader :status, :detail, :headers
 
         def initialize(response)
           @status = response.status
-          @message = response.body.is_a?(Hash) && response.body['message'] || response.body.to_s
+          @detail = response.body
+          @headers = response.headers
         end
 
         def to_s
-          @message
+          message
+        end
+
+        def message
+          return detail.to_s unless detail.is_a?(Hash)
+          detail['message'] || validation_message || detail.to_s
         end
 
         def inspect
-          "<#{self.class.name} status=#{@status} message=#{@message}>"
+          "<#{self.class.name} status=#{status} message=#{message.inspect} detail=#{detail.inspect}>"
+        end
+
+        private
+
+        def validation_message
+          return if Array(detail['errors']).empty?
+          errors = detail['errors'].map do |error|
+            error_to_string(error)
+          end
+          errors.uniq.join('; ')
+        end
+
+        def error_to_string(error)
+          return unless error.is_a?(Hash)
+          [
+            "#{error['title']}:",
+            error.fetch('meta', {})['resource'],
+            error.fetch('source', {})['parameter'],
+            error['detail']
+          ].compact.join(' ')
         end
       end
 
-      class ClientError              < BaseError;   end # 400..499
-      class BadRequest               < ClientError; end # 400
-      class Unauthorized             < ClientError; end # 401
-      class Forbidden                < ClientError; end # 403
-      class NotFound                 < ClientError; end # 404
-      class MethodNotAllowed         < ClientError; end # 405
-      class UnprocessableEntity      < ClientError; end # 422
+      class ClientError         < BaseError;   end # 400..499
+      class BadRequest          < ClientError; end # 400
+      class Unauthorized        < ClientError; end # 401
+      class Forbidden           < ClientError; end # 403
+      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
+      class ServerError         < BaseError;   end # 500..599
+      class InternalServerError < ServerError; end # 500
     end
   end
 end

data/lib/pco/api/version.rb

@@ -1,5 +1,5 @@
 module PCO
   module API
-    VERSION = '1.1.1'
+    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.1.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Planning Center Online
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-06-06 00:00:00.000000000 Z
+date: 2020-09-21 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.30.0
+        version: 0.71.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.30.0
+        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.4.6
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: API wrapper for api.planningcenteronline.com
 test_files: