pco_api 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 98876042745a7cd20d3682c5c55b9fab8a92a465
-  data.tar.gz: edcdf7afa5cdf072b108b04f14a7be227764dfa3
+  metadata.gz: fdf363aaf74caadf35c535566554358fbabe8a86
+  data.tar.gz: b1222c3d2349a5617827b3256e63f53ac908d938
 SHA512:
-  metadata.gz: f14acb70bde82951bbe7734cba538330a244c6008bc8a345895d8b843fa135f04a8e0231d6ff6885b1f481699cfc045ef08f055872c62d5cbf156d6c2f6b0d77
-  data.tar.gz: db31e5122f5f2853cba8d16a1d0701b15d8905e5c89e4c3f9272c7c1aaa73e5b90ac31b6beeb395011b2a05dcc3bc19d976b68faf1d294e4724bb8d6f0fc89e4
+  metadata.gz: f2d8c40236d7c1cc27c3e51858aa42586fdfbc779143707da8293d960d2618b107ed8cd1a44a7d4be01b6b8cd929c48504ddd8f731e61d627879c783123c242a
+  data.tar.gz: 0d75528107787fb437955582c5492aa57d7585ddbec65ebc40f2e1435a20b4e01d908fce67a8d7235f4c41780f0dd619b83e1fd11dd8daa3244d9e0ed3f65fad

data/README.md

@@ -1,6 +1,8 @@
 # pco_api
 
-`pco_api` is a Rubygem that provides a simple wrapper around our RESTful JSON api at https://api.planningcenteronline.com.
+[![Circle CI](https://circleci.com/gh/planningcenter/pco_api_ruby/tree/master.svg?style=svg)](https://circleci.com/gh/planningcenter/pco_api_ruby/tree/master)
+
+`pco_api` is a Rubygem that provides a simple wrapper around our RESTful JSON API at https://api.planningcenteronline.com.
 
 ## Installation
 
@@ -22,22 +24,22 @@ gem install pco_api
 2. Chain path elements together as method calls.
 
     ```ruby
-    api.people.v1.households
-    # /people/v1/households
+    api.people.v2.households
+    # /people/v2/households
     ```
 
 3. For IDs, treat the object like a hash (use square brackets).
 
     ```ruby
-    api.people.v1.households[1]
-    # /people/v1/households/1
+    api.people.v2.households[1]
+    # /people/v2/households/1
     ```
 
 4. To execute the request, use `get`, `post`, `patch`, or `delete`, optionally passing arguments.
 
     ```ruby
-    api.people.v1.households.get(order: 'name')
-    # GET /people/v1/households?order=name
+    api.people.v2.households.get(order: 'name')
+    # GET /people/v2/households?order=name
     ```
 
 ## Example
@@ -45,8 +47,8 @@ gem install pco_api
 ```ruby
 require 'pco_api'
 
-api = PCO::API.new(auth_token: 'token', auth_secret: 'secret')
-api.people.v1.people.get(order: 'last_name')
+api = PCO::API.new(basic_auth_token: 'token', basic_auth_secret: 'secret')
+api.people.v2.people.get(order: 'last_name')
 ```
 
 ...which returns something like:
@@ -54,8 +56,8 @@ api.people.v1.people.get(order: 'last_name')
 ```ruby
 {
   "links" => {
-    "self" => "https://api.planningcenteronline.com/people/v1/people?order=last_name",
-    "next" => "https://api.planningcenteronline.com/people/v1/people?offset=25&order=last_name"
+    "self" => "https://api.planningcenteronline.com/people/v2/people?order=last_name",
+    "next" => "https://api.planningcenteronline.com/people/v2/people?offset=25&order=last_name"
   },
   "data"=> [
     {
@@ -78,7 +80,7 @@ api.people.v1.people.get(order: 'last_name')
       "updated_at" => "2015-04-10T18:59:51Z",
       "avatar" => nil,
       "links" => {
-        "self" => "https://api.planningcenteronline.com/people/v1/people/271"
+        "self" => "https://api.planningcenteronline.com/people/v2/people/271"
       }
     },
     # ...
@@ -146,11 +148,11 @@ api.people.v1.people.get(order: 'last_name')
 
 ```ruby
 # collection
-api.people.v1.people.get(order: 'last_name')
+api.people.v2.people.get(order: 'last_name')
 # => { data: array_of_resources }
 
 # single resource
-api.people.v1.people[1].get
+api.people.v2.people[1].get
 # => { data: resource_hash }
 ```
 
@@ -160,7 +162,7 @@ api.people.v1.people[1].get
 a `{ data: { ... } }` hash.
 
 ```ruby
-api.people.v1.people.post(data: { first_name: 'Tim', last_name: 'Morgan' })
+api.people.v2.people.post(data: { type: 'Person', attributes: { first_name: 'Tim', last_name: 'Morgan' } })
 # => { data: resource_hash }
 ```
 
@@ -170,7 +172,7 @@ api.people.v1.people.post(data: { first_name: 'Tim', last_name: 'Morgan' })
 a `{ data: { ... } }` hash.
 
 ```ruby
-api.people.v1.people[1].patch(data: { first_name: 'Tim', last_name: 'Morgan' })
+api.people.v2.people[1].patch(data: { type: 'Person', id: 1, attributes: { first_name: 'Tim', last_name: 'Morgan' } })
 # => { data: resource_hash }
 ```
 
@@ -179,13 +181,13 @@ api.people.v1.people[1].patch(data: { first_name: 'Tim', last_name: 'Morgan' })
 `delete()` sends a DELETE request to delete an existing resource. This method returns `true` if the delete was successful.
 
 ```ruby
-api.people.v1.people[1].delete
+api.people.v2.people[1].delete
 # => true
 ```
 
 ## Errors
 
-The following errors may be raised, which you should rescue in most circumstances.
+The following errors may be raised by the library, depending on the API response status code.
 
 | HTTP Status Codes   | Error Class                                                               |
 | ------------------- | ------------------------------------------------------------------------- |
@@ -199,15 +201,17 @@ The following errors may be raised, which you should rescue in most circumstance
 | 500                 | `PCO::API::Errors::InternalServerError` < `PCO::API::Errors::ServerError` |
 | other 5xx errors    | `PCO::API::Errors::ServerError`                                           |
 
-The exception class has the following methods:
+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 body of the response returned by the server |
+The `message` should be a simple string given by the API, e.g. "Resource Not Found".
 
-The `message` will usually be a hash (produced by parsing the response JSON),
-but in the case of some server errors, may be a string containing the raw response.
+Alternatively, you may rescue `PCO::API::Errors::BaseError` and branch your code based on
+the status code returned by calling `error.status`.
 
 ## Copyright & License
 

data/lib/pco/api/errors.rb

@@ -8,7 +8,7 @@ module PCO
 
         def initialize(response)
           @status = response.status
-          @message = response.body
+          @message = response.body.is_a?(Hash) && response.body['message'] || response.body.to_s
         end
 
         def to_s

data/lib/pco/api/version.rb

@@ -1,5 +1,5 @@
 module PCO
   module API
-    VERSION = '1.1.0'
+    VERSION = '1.1.1'
   end
 end

data/spec/pco/api/endpoint_spec.rb

@@ -2,35 +2,35 @@ require_relative '../../spec_helper'
 require 'json'
 
 describe PCO::API::Endpoint do
-  let(:base) { described_class.new(auth_token: 'token', auth_secret: 'secret') }
+  let(:base) { described_class.new(basic_auth_token: 'token', basic_auth_secret: 'secret') }
 
   subject { base }
 
   describe '#method_missing' do
     before do
-      @result = subject.people.v1
+      @result = subject.people.v2
     end
 
     it 'returns a wrapper object with updated url' do
       expect(@result).to be_a(described_class)
-      expect(@result.url).to match(%r{/people/v1$})
+      expect(@result.url).to match(%r{/people/v2$})
     end
   end
 
   describe '#[]' do
     before do
-      @result = subject.people.v1.people[1]
+      @result = subject.people.v2.people[1]
     end
 
     it 'returns a wrapper object with updated url' do
       expect(@result).to be_a(described_class)
-      expect(@result.url).to match(%r{/people/v1/people/1$})
+      expect(@result.url).to match(%r{/people/v2/people/1$})
     end
   end
 
   describe '#get' do
     context 'given a good URL' do
-      subject { base.people.v1 }
+      subject { base.people.v2 }
 
       let(:result) do
         {
@@ -42,7 +42,7 @@ describe PCO::API::Endpoint do
       end
 
       before do
-        stub_request(:get, 'https://api.planningcenteronline.com/people/v1')
+        stub_request(:get, 'https://api.planningcenteronline.com/people/v2')
           .to_return(status: 200, body: { data: result }.to_json, headers: { 'Content-Type' => 'application/vnd.api+json' })
         @result = subject.get
       end
@@ -54,7 +54,7 @@ describe PCO::API::Endpoint do
     end
 
     context 'given a non-existent URL' do
-      subject { base.people.v1.non_existent }
+      subject { base.people.v2.non_existent }
 
       let(:result) do
         {
@@ -64,19 +64,23 @@ describe PCO::API::Endpoint do
       end
 
       before do
-        stub_request(:get, 'https://api.planningcenteronline.com/people/v1/non_existent')
+        stub_request(:get, 'https://api.planningcenteronline.com/people/v2/non_existent')
           .to_return(status: 404, body: result.to_json, headers: { 'Content-Type' => 'application/vnd.api+json' })
       end
 
       it 'raises a NotFound error' do
-        expect {
-          subject.get
-        }.to raise_error(PCO::API::Errors::NotFound)
+        error = begin
+                  subject.get
+                rescue PCO::API::Errors::NotFound => e
+                  e
+                end
+        expect(error.status).to eq(404)
+        expect(error.message).to eq('Resource Not Found')
       end
     end
 
     context 'given a client error' do
-      subject { base.people.v1.error }
+      subject { base.people.v2.error }
 
       let(:result) do
         {
@@ -86,7 +90,7 @@ describe PCO::API::Endpoint do
       end
 
       before do
-        stub_request(:get, 'https://api.planningcenteronline.com/people/v1/error')
+        stub_request(:get, 'https://api.planningcenteronline.com/people/v2/error')
           .to_return(status: 400, body: result.to_json, headers: { 'Content-Type' => 'application/vnd.api+json' })
       end
 
@@ -98,7 +102,7 @@ describe PCO::API::Endpoint do
     end
 
     context 'given a server error' do
-      subject { base.people.v1.error }
+      subject { base.people.v2.error }
 
       let(:result) do
         {
@@ -108,7 +112,7 @@ describe PCO::API::Endpoint do
       end
 
       before do
-        stub_request(:get, 'https://api.planningcenteronline.com/people/v1/error')
+        stub_request(:get, 'https://api.planningcenteronline.com/people/v2/error')
           .to_return(status: 500, body: result.to_json, headers: { 'Content-Type' => 'application/vnd.api+json' })
       end
 
@@ -121,7 +125,7 @@ describe PCO::API::Endpoint do
   end
 
   describe '#post' do
-    subject { base.people.v1.people }
+    subject { base.people.v2.people }
 
     let(:resource) do
       {
@@ -141,7 +145,7 @@ describe PCO::API::Endpoint do
     end
 
     before do
-      stub_request(:post, 'https://api.planningcenteronline.com/people/v1/people')
+      stub_request(:post, 'https://api.planningcenteronline.com/people/v2/people')
         .to_return(status: 201, body: { data: result }.to_json, headers: { 'Content-Type' => 'application/vnd.api+json' })
       @result = subject.post(data: resource)
     end
@@ -153,7 +157,7 @@ describe PCO::API::Endpoint do
   end
 
   describe '#patch' do
-    subject { base.people.v1.people[1] }
+    subject { base.people.v2.people[1] }
 
     let(:resource) do
       {
@@ -173,7 +177,7 @@ describe PCO::API::Endpoint do
     end
 
     before do
-      stub_request(:patch, 'https://api.planningcenteronline.com/people/v1/people/1')
+      stub_request(:patch, 'https://api.planningcenteronline.com/people/v2/people/1')
         .to_return(status: 200, body: { data: result }.to_json, headers: { 'Content-Type' => 'application/vnd.api+json' })
       @result = subject.patch(data: resource)
     end
@@ -185,10 +189,10 @@ describe PCO::API::Endpoint do
   end
 
   describe '#delete' do
-    subject { base.people.v1.people[1] }
+    subject { base.people.v2.people[1] }
 
     before do
-      stub_request(:delete, 'https://api.planningcenteronline.com/people/v1/people/1')
+      stub_request(:delete, 'https://api.planningcenteronline.com/people/v2/people/1')
         .to_return(status: 204, body: '')
       @result = subject.delete
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pco_api
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Planning Center Online
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-05 00:00:00.000000000 Z
+date: 2015-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -42,14 +42,14 @@ dependencies:
   name: excon
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.30.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.30.0
 - !ruby/object:Gem::Dependency
@@ -58,44 +58,46 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.21.0
+        version: '1.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.21.0
+        version: '1.21'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.1
-description: Ruby wrapper for api.planningcenteronline.com
-email: 
+        version: '0.10'
+description: pco_api is a gem for working with the RESTful JSON API at api.planningcenteronline.com
+  using HTTP basic auth or OAuth 2.0. This library can talk to any endpoint the API
+  provides, since it is written to build endpoint URLs dynamically using method_missing.
+email: support@planningcenteronline.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -109,7 +111,8 @@ files:
 - spec/pco/api/endpoint_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/planningcenter/pco_api_ruby
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -119,7 +122,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -130,7 +133,7 @@ rubyforge_project:
 rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: Ruby wrapper for api.planningcenteronline.com
+summary: API wrapper for api.planningcenteronline.com
 test_files:
 - spec/pco/api/endpoint_spec.rb
 - spec/spec_helper.rb