omniauth-plangrade 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 971880782792ea5433e4db1bfcfcdd68d3f7170a
-  data.tar.gz: e789c6fb47d311e080408688983b71c52a372e4d
+  metadata.gz: 3d523a80b7f14c752d07284bff285f756588fe17
+  data.tar.gz: b22c3073713a4410dab81e8b18b5a7f1dfdfc085
 SHA512:
-  metadata.gz: 17ca6edfc3661c0e51462484576b02ea187fd4b8c22ecc0c084332abc386dca09180f5f4911e29ff4d6767462361d6a5180810feed4332b6e159d6865dc8ff51
-  data.tar.gz: ab04a76030ed98e42e4848b27c8402d10d921bad0529f02a265f174daea1bd4b5617c8fce79cee65a09d0d50820e73b98cd5f4f899cbe98ce724ca4c861583c6
+  metadata.gz: ab52cc22f976648fedc20d209799ac578c7c8306d7ebbe5488f8a653cf2369469694beb591978eaa832fc233536c1d398ff540968da6817888865428d69f3fac
+  data.tar.gz: ea400ef43125b12f0c973ec2af46bf746d372128f207349e770ba964cd5927c7ffe8084c99d7821fec92e8a75ef4bc0b120118ecbcb5f0480651b7f6b5b45354

data/.gitignore

@@ -20,3 +20,4 @@ tmp
 *.o
 *.a
 mkmf.log
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - jruby
+
+notifications:
+  email:
+    recipients:
+      - topherreynoso@gmail.com
+    on_failure: change
+    on_success: never

data/Gemfile

@@ -1,7 +1,6 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in omniauth-plangrade.gemspec
-gemspec
+gem 'rake'
 
-gem 'oauth2'
-gem 'omniauth-oauth2'
+# Specify your gem's dependencies in omniauth-twitter.gemspec
+gemspec

data/README.md

@@ -1,31 +1,85 @@
-# Omniauth::Plangrade
+# OmniAuth plangrade
+[![Gem Version](https://badge.fury.io/rb/omniauth-plangrade.svg)](http://badge.fury.io/rb/omniauth-plangrade)
+[![Code Climate](https://codeclimate.com/github/topherreynoso/omniauth-plangrade/badges/gpa.svg)](https://codeclimate.com/github/topherreynoso/omniauth-plangrade)
 
-Omniauth Strategy for plangrade. Find out more about the plangrade API at docs.plangrade.com
+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.
 
-## Installation
+## Installing
 
 Add omniauth-oauth2 and this line to your application's Gemfile:
 
-    gem 'omniauth-plangrade', git: 'https://github.com/topherreynoso/omniauth-plangrade'
+    gem 'omniauth-plangrade'
 
-And then execute:
+Then execute:
 
     $ bundle install
 
 ## Usage
 
-You need to add the following to your `config/initializers/omniauth.rb`:
+`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, "your_key", "your_secret", redirect_uri: "redirect_uri"
+  provider :plangrade, ENV['PLANGRADE_CLIENT_ID'], ENV['PLANGRADE_CLIENT_SECRET']
 end
 ```
 
-## Contributing
+[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.
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+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/Rakefile

@@ -1,2 +1,8 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
 
+desc "Run specs"
+RSpec::Core::RakeTask.new
+
+desc 'Default: run specs.'
+task :default => :spec

data/lib/omniauth/plangrade/version.rb

@@ -1,5 +1,5 @@
 module Omniauth
   module Plangrade
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
   end
 end

data/omniauth-plangrade.gemspec

@@ -18,6 +18,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
+  spec.add_dependency 'multi_json', '~> 1.3'
+  spec.add_runtime_dependency 'oauth2'
+  spec.add_runtime_dependency 'omniauth'
+  spec.add_runtime_dependency 'omniauth-oauth2'
+  spec.add_development_dependency 'rspec', '~> 2.7'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'webmock'
 end

data/spec/omniauth/strategies/plangrade_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::Plangrade do
+  let(:request) { double('Request', :params => {}, :cookies => {}, :env => {}) }
+
+  subject do
+    args = ['appid', 'secret', @options || {}].compact
+    OmniAuth::Strategies::Plangrade.new(*args).tap do |strategy|
+      allow(strategy).to receive(:request) {
+        request
+      }
+    end
+  end
+
+  describe 'client options' do
+    it 'should have correct name' do
+      expect(subject.options.name).to eq(:plangrade)
+    end
+
+    it 'should have correct site' do
+      expect(subject.options.client_options.site).to eq('https://plangrade.com')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'simplecov'
+SimpleCov.start
+require 'rspec'
+require 'rack/test'
+require 'webmock/rspec'
+require 'oauth2'
+require 'omniauth'
+require 'omniauth-oauth2'
+require 'omniauth/plangrade'
+
+RSpec.configure do |config|
+  config.include WebMock::API
+  config.include Rack::Test::Methods
+  config.extend  OmniAuth::Test::StrategyMacros, :type => :strategy
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -1,31 +1,115 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-plangrade
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Christopher Reynoso
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-09 00:00:00.000000000 Z
+date: 2014-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -47,6 +131,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -55,6 +141,8 @@ files:
 - lib/omniauth/plangrade/version.rb
 - lib/omniauth/strategies/plangrade.rb
 - omniauth-plangrade.gemspec
+- spec/omniauth/strategies/plangrade_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/topherreynoso/omniauth-plangrade
 licenses:
 - MIT
@@ -79,4 +167,6 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Omniauth Strategy for plangrade
-test_files: []
+test_files:
+- spec/omniauth/strategies/plangrade_spec.rb
+- spec/spec_helper.rb