omniauth-samaritan 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 39ec2609e204a96eecec459fb575fa152b8e5484
+  data.tar.gz: 5e87c91a899a30a09cae65920e32817009ddfd7e
+SHA512:
+  metadata.gz: 39ec5703b47370b3bee69db37d67761fe711cfbca001bd03ec36bfbfa8b2469e6ab389ceeee852f82e9c016557854253520f46ca6a57236caf6a79d8e250db67
+  data.tar.gz: 21e6ab94e157144082d22a1029f879a4ec5c78cc23b7d6bc1d9bb50c96a21f0bdd53f17b99e874ae4a214e8212a2f100eb939131e3928c004bdcfd7abf0e884a

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.ruby-gemset
+.ruby-version
+.rvmrc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.powenv
+.idea/

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :example do
+  gem 'sinatra'
+end

data/README.md

@@ -0,0 +1,15 @@
+# OmniAuth Samaritan OAuth2 Strategy
+
+Strategy to authenticate with Samaritan via OAuth2 in OmniAuth.
+
+#For more information on usage and configuration, visit our [documentation site](http://docs.samaritanministries.org/ruby-oauth/).
+
+## License
+
+Copyright (c) 2014 by Samaritan Ministries International
+
+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/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require File.join('bundler', 'gem_tasks')
+require File.join('rspec', 'core', 'rake_task')
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/omniauth/samaritan/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Samaritan
+    VERSION = "0.0.5"
+  end
+end

data/lib/omniauth/samaritan.rb

@@ -0,0 +1 @@
+require File.join('omniauth', 'strategies', 'samaritan')

data/lib/omniauth/strategies/samaritan.rb

@@ -0,0 +1,93 @@
+require 'omniauth/strategies/oauth2'
+
+module OmniAuth
+  module Strategies
+    class Samaritan < OmniAuth::Strategies::OAuth2
+
+      option :name, 'samaritan'
+      option :environment
+
+      option :client_options, {}
+
+      option :sandbox_client_options, {
+          :site          => 'https://sandbox.smchcn.net/',
+          :authorize_url => '/asrv/smi/oauth/authorize',
+          :token_url     => '/asrv/smi/oauth/token',
+          :identity_url  => '/SmiIdentity/api/identity/mine'}
+
+      option :production_client_options, {
+          :site          => 'https://api.smchcn.net/',
+          :authorize_url => '/asrv/smi/oauth/authorize',
+          :token_url     => '/asrv/smi/oauth/token',
+          :identity_url  => '/SmiIdentity/api/identity/mine'}
+
+      def client_options
+        client_options = options.client_options
+        client_options = options.sandbox_client_options if options.environment == :sandbox
+        client_options = options.production_client_options if options.environment == :production
+        client_options
+      end
+
+      def request_phase
+        if request.params['access_token']
+          self.access_token = build_access_token_from_params(request.params)
+          env['omniauth.auth'] = auth_hash
+          call_app!
+        else
+          super
+        end
+      end
+
+      def client
+        ::OAuth2::Client.new(options.client_id, options.client_secret, deep_symbolize(client_options))
+      end
+
+      def token_params
+        super.merge({:headers => {'Authorization' => authorization(options.client_id, options.client_secret)}})
+      end
+
+      def authorization(client_id, client_secret)
+        'Basic ' + Base64.encode64(client_id + ':' + client_secret).gsub("\n", '')
+      end
+
+      uid { raw_info['id'] }
+
+      info do
+        prune!({
+          :name                   => raw_info['nickname'],
+          :email                  => raw_info['email_address'],
+          :member_id              => raw_info['member_id'],
+          :membership_id          => raw_info['context'],
+          :is_approved            => raw_info['is_approved'],
+          :has_claimed_membership => raw_info['has_claimed_membership'],
+          :is_locked_out          => raw_info['is_locked_out']
+        })
+      end
+
+      extra do
+        hash = {}
+        hash[:raw_info] = raw_info unless skip_info?
+        prune! hash
+      end
+
+      def raw_info
+        identity_endpoint = client_options[:site].to_s.gsub(/\/\z/, '') + client_options[:identity_url].to_s
+        @raw_info ||= access_token.get(identity_endpoint).parsed
+      end
+
+      private
+
+      def build_access_token_from_params(params)
+        ::OAuth2::AccessToken.new(client, params['access_token'])
+      end
+
+      def prune!(hash)
+        hash.delete_if do |_, v|
+          prune!(v) if v.is_a?(Hash)
+          v.nil? || (v.respond_to?(:empty?) && v.empty?)
+        end
+      end
+
+    end
+  end
+end

data/lib/omniauth-samaritan.rb

@@ -0,0 +1 @@
+require File.join('omniauth', 'samaritan')

data/omniauth-samaritan.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path(File.join('..', 'lib', 'omniauth', 'samaritan', 'version'), __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.add_dependency 'omniauth', '~> 1.0'
+
+  gem.authors       = ["Doug Bradbury", "Ben Voss"]
+  gem.email         = ["smi@8thlight.com"]
+  gem.description   = %q{A Samaritan OAuth2 strategy for OmniAuth 1.x.}
+  gem.summary       = %q{A Samaritan OAuth2 strategy for OmniAuth 1.x}
+  gem.homepage      = "http://docs.samaritanministries.org/ruby-oauth/"
+  gem.licenses      = ['MIT']
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  gem.name          = "omniauth-samaritan"
+  gem.require_paths = ["lib"]
+  gem.version       = OmniAuth::Samaritan::VERSION
+
+  gem.add_runtime_dependency 'omniauth-oauth2', '~> 1.1', '>= 1.1.2'
+
+  gem.add_development_dependency 'rspec', '~> 2.6.0', '>= 2.6.0'
+  gem.add_development_dependency 'rake', '~> 0'
+end

data/spec/omniauth/strategies/samaritan_spec.rb

@@ -0,0 +1,145 @@
+require 'spec_helper'
+require 'omniauth-samaritan'
+
+describe OmniAuth::Strategies::Samaritan do
+  let(:request) { double('Request', :params => {}, :cookies => {}, :env => {}) }
+  let(:app) {
+    lambda do
+      [200, {}, ["Hello."]]
+    end
+  }
+
+  subject do
+    OmniAuth::Strategies::Samaritan.new(app, 'appid', 'secret', @options || {}).tap do |strategy|
+      strategy.stub(:request) {
+        request
+      }
+    end
+  end
+
+  before do
+    OmniAuth.config.test_mode = true
+  end
+
+  after do
+    OmniAuth.config.test_mode = false
+  end
+
+  describe '#client_options' do
+    it 'has correct site for sandbox' do
+      @options = {:environment => :sandbox}
+      subject.client.site.should eq('https://sandbox.smchcn.net/')
+    end
+
+    it 'has correct site for production' do
+      @options = {:environment => :production}
+      subject.client.site.should eq('https://api.smchcn.net/')
+    end
+
+    it 'has correct authorize_url' do
+      @options = {:environment => :production}
+      subject.client.options[:authorize_url].should eq('/asrv/smi/oauth/authorize')
+    end
+
+    it 'has correct token_url' do
+      @options = {:environment => :production}
+      subject.client.options[:token_url].should eq('/asrv/smi/oauth/token')
+    end
+
+    describe "overrides" do
+      it 'should allow overriding the site' do
+        @options = {:client_options => {'site' => 'https://example.com'}}
+        subject.client.site.should == 'https://example.com'
+      end
+
+      it 'should allow overriding the authorize_url' do
+        @options = {:client_options => {'authorize_url' => 'https://example.com'}}
+        subject.client.options[:authorize_url].should == 'https://example.com'
+      end
+
+      it 'should allow overriding the token_url' do
+        @options = {:client_options => {'token_url' => 'https://example.com'}}
+        subject.client.options[:token_url].should == 'https://example.com'
+      end
+    end
+  end
+
+  describe '#token_params' do
+    it 'should include any token params passed in the :token_params option' do
+      @options = {:token_params => {:foo => 'bar', :baz => 'zip'}}
+      subject.token_params['foo'].should eq('bar')
+      subject.token_params['baz'].should eq('zip')
+    end
+  end
+
+  describe "#token_options" do
+    it 'should include top-level options that are marked as :token_options' do
+      @options = {:token_options => [:scope, :foo], :scope => 'bar', :foo => 'baz', :bad => 'not_included'}
+      subject.token_params['scope'].should eq('bar')
+      subject.token_params['foo'].should eq('baz')
+      subject.token_params['bad'].should eq(nil)
+    end
+  end
+
+  describe '#callback_path' do
+    it 'has the correct callback path' do
+      subject.callback_path.should eq('/auth/samaritan/callback')
+    end
+  end
+
+  describe '#extra' do
+    let(:client) do
+      OAuth2::Client.new('abc', 'def') do |builder|
+        builder.request :url_encoded
+        builder.adapter :test do |stub|
+          stub.get('/SmiIdentity/api/identity/mine') {|env| [200, {'content-type' => 'application/json'}, '{"id": "12345"}']}
+        end
+      end
+    end
+    let(:access_token) { OAuth2::AccessToken.from_hash(client, {}) }
+
+    before do
+      @options = { :environment => :sandbox }
+      subject.stub(:access_token => access_token)
+    end
+
+
+    describe 'raw_info' do
+      context 'when skip_info is false' do
+
+        it 'should include raw_info' do
+          subject.extra[:raw_info].should eq('id' => '12345')
+        end
+      end
+    end
+
+  end
+
+  describe 'populate auth hash urls' do
+    it 'should populate url map in auth hash if link present in raw_info' do
+      subject.stub(:raw_info){{"id" => "765b1357-8cb5-4b3e-a4bb-239e3af38399","email_address"=>"gotteo@gmail.com","is_approved"=>true,"is_locked_out"=>false,"sub"=>"765b1357-8cb5-4b3e-a4bb-239e3af38399","member_id"=>"44561","context"=>"14470","has_claimed_membership"=>true,"nickname"=>"Greg Otte"}}
+      subject.info.should_not have_key(:urls)
+      subject.info[:name].should == "Greg Otte"
+      subject.info[:email].should == "gotteo@gmail.com"
+      subject.info[:is_approved].should == true
+      subject.info[:has_claimed_membership].should == true
+      subject.info[:is_locked_out].should == false
+      subject.info[:member_id].should == "44561"
+      subject.info[:membership_id].should == "14470"
+    end
+
+  end
+
+  describe "pre-authorized" do
+    it "should create an access token" do
+      subject.stub(:env){ {}}
+      subject.should_receive(:call_app!)
+      subject.stub(:raw_info){{"id" => "765b1357-8cb5-4b3e-a4bb-239e3af38399","email_address"=>"gotteo@gmail.com","is_approved"=>true,"is_locked_out"=>false,"sub"=>"765b1357-8cb5-4b3e-a4bb-239e3af38399","member_id"=>"44561","context"=>"14470","has_claimed_membership"=>true,"nickname"=>"Greg Otte"}}
+      request.params["access_token"] = "1234567890"
+      subject.request_phase
+      subject.access_token.should_not be_nil
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require File.join('bundler', 'setup')
+require 'rspec'

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-samaritan
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Doug Bradbury
+- Ben Voss
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: A Samaritan OAuth2 strategy for OmniAuth 1.x.
+email:
+- smi@8thlight.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/omniauth-samaritan.rb
+- lib/omniauth/samaritan.rb
+- lib/omniauth/samaritan/version.rb
+- lib/omniauth/strategies/samaritan.rb
+- omniauth-samaritan.gemspec
+- spec/omniauth/strategies/samaritan_spec.rb
+- spec/spec_helper.rb
+homepage: http://docs.samaritanministries.org/ruby-oauth/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: A Samaritan OAuth2 strategy for OmniAuth 1.x
+test_files: []