pco_api 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2a0b33bcc7a92d15c4bc6aac5fb0056c6d06aeb
-  data.tar.gz: d679b3d3923bba077c046e80b273a6f72a82ab74
+  metadata.gz: d1dc3d66fb23d3d8a8c5c76b90518ffc7782d797
+  data.tar.gz: 45679ff9c0d32e87f7f29004295070d85db456df
 SHA512:
-  metadata.gz: 2b814cf14e00f50caecb6676e1064bfe2e218b8dc46ea41e495a67edf1a5ad2daf2bb693c54afbbbbd74301c415bf5509e450d394f743729a731c90ed2226a5e
-  data.tar.gz: 305313b12a741a953a3f82f945e07dffcc70c3b86395212227b7d3a5046f6e6f33bca80815f5e994e3ea236022fdf64579cdb654670534c49cdcbf8fc3c63b2a
+  metadata.gz: 336847bc5528ccc12b316646a889b72475aad57e8ad27f7eae91e13c53444733517c4bf8564f32719255f1abe30182babe9ac97adf30742f9ddafd2284258f25
+  data.tar.gz: 9ebecfee7f1c1006047bfc967d28693e0cd6eef8a1fbed23e781b14e8290cd270bd9beb8338c05e8a9e05312f38d8a3bf7077f072d235fc78c91d6ffe14c4001

data/README.md

@@ -63,22 +63,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 +93,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 +110,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 +139,11 @@ api.people.v2.people.get(order: 'last_name')
       "name_suffix",
       "field_data",
       "apps"
-    ]
+    ],
+    "parent" => {
+      "id" => "1",
+      "type" => "Organization"
+    }
   }
 }
 ```
@@ -203,13 +209,16 @@ 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`.
 

data/lib/pco/api/errors.rb

@@ -4,32 +4,57 @@ module PCO
       class AuthRequiredError < StandardError; end
 
       class BaseError < StandardError
-        attr_reader :status
+        attr_reader :status, :detail
 
         def initialize(response)
           @status = response.status
-          @message = response.body.is_a?(Hash) && response.body['message'] || response.body.to_s
+          @detail = response.body
         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 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.2'
+    VERSION = '1.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pco_api
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Planning Center Online
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-08 00:00:00.000000000 Z
+date: 2015-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -130,10 +130,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: API wrapper for api.planningcenteronline.com
 test_files:
 - spec/pco/api/endpoint_spec.rb
 - spec/spec_helper.rb
+has_rdoc: