plangrade-ruby 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb7fed01df975dd638af267527af1a719395e374
-  data.tar.gz: d670aeca677569a9ca64cdbd929ebc935586f018
+  metadata.gz: e619eacc7d4a878d10fec701d501d8bf0ef296b4
+  data.tar.gz: 236a3735f4ce32ba02db731335bbeab08b80633c
 SHA512:
-  metadata.gz: 0a9538c366ca0155f591587aae4769945ac4cd40b276121b53f0715dab701dd4ff76de6e7d2aec4c7469f12c7e1716c1f9b04cd49b52b83d393f001c466d6c65
-  data.tar.gz: 78d5952db9f81ca1e191b10034f149281f7ae325db55a86416b4ce4415a59eb9ed0b61ff2077f8dc57a377bf54f85617c93eddcaafcc0f76b7c1b84a9a369833
+  metadata.gz: 288c51bd0973e2380d1ebc1b78736c3f6b53d44ec8c6f5d21cd1da6b2ceac48c1fd54d83ea13d04a896999feff3d038a4de17ec0ac60200cf74c27f8e4bfefab
+  data.tar.gz: d1fcfe4ff3e727c1c5b90477df4fb53db1c9561ace5d3ceb0696b2a9347ba0bd4f94f1b4f0ae47146511c434b4624af0df9104966c65af03e1288270c5b66214

data/README.md

@@ -1,24 +1,28 @@
-# Plangrade::Ruby
+# plangrade API Gem
+[![Gem Version](https://badge.fury.io/rb/plangrade-ruby.svg)](http://badge.fury.io/rb/plangrade-ruby)
+[![Code Climate](https://codeclimate.com/github/topherreynoso/plangrade-ruby/badges/gpa.svg)](https://codeclimate.com/github/topherreynoso/plangrade-ruby)
 
-TODO: Write a gem description
+Ruby wrapper for the plangrade API.
+Supports OAuth 2.0 authentication, including `refresh_token`. Read the [plangrade docs](https://docs.plangrade.com/#authentication) for more details. Additionally, this may be used in conjunction with [omniauth-plangrade](https://github.com/topherreynoso/omniauth-plangrade) in order to facilitate authentication and obtaining a valid `access_token` and `refresh_token` pair for use with this gem to access plangrade API endpoints.
+This README provides only a basic overview of how to use this gem. For more information about the API endpoints, look at the [plangrade docs](https://docs.plangrade.com/#authentication).
 
-## Installation
+## Installing
 
-Add this line to your application's Gemfile:
+Add oauth2 and this line to your application's Gemfile:
 
     gem 'plangrade-ruby'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
-Or install it yourself as:
+## Configuration
 
-    $ gem install plangrade-ruby
+The plangrade API requires authentication for access to certain endpoints. Below are the basic steps to get this done.
 
-## Usage
+### Register your application
 
-TODO: Write usage instructions here
+Setup a plangrade client application at the [plangrade developer site](https://plangrade.com/oauth/applications). 
 
 ## Contributing
 
@@ -27,3 +31,87 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+
+
+plangrade OAuth2 strategy for OmniAuth.  
+Supports the OAuth 2.0 server-side and client-side flows. Read the plangrade docs for more details: [docs.plangrade.com](https://docs.plangrade.com/#authentication). Additionally, this may be used in conjunction with [plangrade-ruby](https://github.com/topherreynoso/plangrade-ruby) in order to refresh tokens and access plangrade API endpoints.
+
+## Installing
+
+Add omniauth-oauth2 and this line to your application's Gemfile:
+
+    gem 'omniauth-plangrade'
+
+Then execute:
+
+    $ bundle install
+
+## Usage
+
+`OmniAuth::Strategies::Plangrade` is simply a Rack middleware. Read the OmniAuth docs for detailed instructions: [https://github.com/intridea/omniauth](https://github.com/intridea/omniauth).
+
+Here's a quick example, adding the middleware to a Rails app in `config/initializers/omniauth.rb`:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :plangrade, ENV['PLANGRADE_CLIENT_ID'], ENV['PLANGRADE_CLIENT_SECRET']
+end
+```
+
+[See the example rails app for full examples](https://github.com/topherreynoso/plangrade-ruby-client) of both the server and client-side flows.
+
+## Auth Hash
+
+Here's an example *Auth Hash* available in `request.env['omniauth.auth']`:
+
+```ruby
+{
+  :provider => 'plangrade',
+  :uid => '1234567',
+  :info => {
+    :name => 'Compliance Man',
+    :email => 'compliance@plangrade.com',
+  },
+  :credentials => {
+    :token => 'ABCDEF...', # OAuth 2.0 access_token, which you may wish to store
+    :refresh_token => 'ABCDEF...', #OAuth 2.0 refresh_token, which you may wish to store
+    :expires_at => 1321747205, # when the access token expires (it always will)
+    :expires => true # this will always be true
+  },
+  :extra => {
+    :raw_info => {
+      :id => '1234567',
+      :name => 'Compliance Man',
+      :email => 'compliance@plangrade.com',
+    }
+  }
+}
+```
+
+### How it Works
+
+The client-side flow is supported by parsing the authorization code from the signed request which plangrade places in a cookie.
+
+When you call `/auth/plangrade/callback`, the success callback will pass the cookie back to the server. omniauth-plangrade will see this cookie and:
+
+1. parse it,
+2. extract the authorization code contained in it,
+3. and hit plangrade and obtain an access token which will get placed in the `request.env['omniauth.auth']['credentials']` hash.
+
+## Token Expiry
+
+The expiration time of the access token you obtain is 2 hours.
+The refresh_token, however, has no expiration and may be used until a user revokes your app's access.
+
+## License
+
+Copyright (c) 2014 Christopher Reynoso
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/plangrade/api/company.rb

@@ -6,7 +6,7 @@ module Plangrade
       end
 
       def update_company(id, opts={})
-        put("/api/v1/companies/#{id}", opts)
+        put("/api/v1/companies/#{id}", opts).body[:company]
       end
 
       def delete_company(id)

data/lib/plangrade/api/participant.rb

@@ -6,7 +6,7 @@ module Plangrade
       end
 
       def update_participant(id, opts={})
-        put("/api/v1/participants/#{id}", opts)
+        put("/api/v1/participants/#{id}", opts).body[:participant]
       end
 
       def delete_participant(id)
@@ -14,7 +14,7 @@ module Plangrade
       end
 
       def archive_participant(id)
-        get("api/v1/participants/archive?participant_id=#{id}").body
+        get("api/v1/participants/archive?participant_id=#{id}")
       end
 
       def get_participant(id)

data/lib/plangrade/api/user.rb

@@ -6,7 +6,7 @@ module Plangrade
       end
 
       def update_user(id, opts={})
-        put("/api/v1/users/#{id}", opts)
+        put("/api/v1/users/#{id}", opts).body[:user]
       end
 
       def delete_user(id)

data/lib/plangrade/oauth2_client.rb

@@ -72,7 +72,6 @@ module Plangrade
     #  client_id={client_id}&code=G3Y6jU3a&grant_type=authorization_code&
     #  redirect_uri=http%3A%2F%2Flocalhost%3A3000%2Fauth%2Fplangrade%2Fcallback&client_secret={client_secret}
     def access_token_from_authorization_code(code, opts={})
-      opts[:authenticate] ||= :body
       authorization_code.get_token(code, opts)
     end
 

data/lib/plangrade/ruby/version.rb

@@ -1,5 +1,5 @@
 module Plangrade
   module Ruby
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data.tar.gz.sig

@@ -1,6 +1 @@
->Οq�r����D�w��E\��8O�W�8j6\i�wc��ty
-���KfWj2��
���3#Ă���75�qm:����8�~�ß
-PI�[Y�|6;��9̬ۤq����j۰FA�L#N�������|ڽ�=��"0�
-eZ^c�
-�
-�u�⾟�󎳚p�v��pd����\T4tu�M��`|�}@!뇒�⚻f��m�A�mo=�ŧK
+����؄7�Ba%����VU?:J{�y�#|+���q��@1�ھi�������bVb��7Ƹ�K���ĝ8oi8䫗l�����ݽ�7�\���'��G�1���N�4`�1�g{n�D4Zy	)nL��>Sx_j*���U�jГ�~WB������޺P4y����E;�K㊵��`�� �۸�����j���p�}�H�{�

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plangrade-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Christopher Reynoso
@@ -30,7 +30,7 @@ cert_chain:
   ELzPS5fItQUB4UE0DT9qDr7LmfnG1tLPIeDgMScUes6zSSckWtaXKjQRy7OG7yGu
   2YveeRgxu2nn/J4Q6Obf7PqMvpR0z5T8SUptXcRVhHBZDUzrBpNvtNM=
   -----END CERTIFICATE-----
-date: 2014-11-10 00:00:00.000000000 Z
+date: 2014-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -264,4 +264,3 @@ test_files:
 - test/fixtures/one_user.yml
 - test/test_helper.rb
 - test/user/user_test.rb
-has_rdoc: