omniauth-mydigipass 1.0.0

data/.gitignore

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in omniauth-mydigipass.gemspec
+gemspec
+

data/README.md

@@ -0,0 +1,89 @@
+# OmniAuth Mydigipass.com
+
+This is an OmniAuth strategy for authenticating with MYDIGIPASS.COM.
+
+If you want to integrate your website with MYDIGIPASS.COM, you will need to
+sign up on http://developer.mydigipass.com and connect your site there.
+There you will get a `client_id` and `client_secret` you need to fill in here.
+
+
+## Basic Usage
+
+If you are testing your application in the sandbox environment, write
+
+    use OmniAuth::Builder do
+      provider :mydigipass, ENV['MYDIGIPASS_CLIENT_ID'], ENV['MYDIGIPASS_CLIENT_SECRET'],
+                            :client_options => OmniAuth::Strategies::Mydigipass.default_client_urls(:sandbox => true)
+    end
+
+Once your application goes in production, you can just write:
+
+    use OmniAuth::Builder do
+      provider :mydigipass, ENV['MYDIGIPASS_CLIENT_ID'], ENV['MYDIGIPASS_CLIENT_SECRET']
+    end
+
+## Example Application
+
+I have added a small working example application, check it out how it should work. To integrate into rails you should
+
+* add the
+
+## Example Integrating with Rails
+
+Inside your `config/application.rb` add the following (e.g. at the bottom, inside the configuration block) :
+
+    # enable omniauth strategies
+    Rails.application.config.middleware.use OmniAuth::Builder do
+      provider :mydigipass, APP_CONFIG[:client_id], APP_CONFIG[:client_secret]
+    end
+
+And then you just have to make sure you have something listening at `/auth/:provider/callback`.
+Suppose you add the following routes:
+
+  match '/auth/:provider/callback', :to => 'home#auth_create'
+  match '/auth/failure', :to => 'home#auth_failure'
+
+Then, inside your `HomeController` you could write:
+
+    def auth_failure
+      set_flash_message(:notice, "OAuth error: #{params[:message]}")
+      redirect_to root_path
+    end
+
+    def auth_create
+      user = User.find_or_create_from_auth_hash(request.env['omniauth.auth'].with_indifferent_access)
+      logger.debug "Found or created user: #{user.email} [#{user.id}]"
+      if user.sign_in_count == 0
+        set_flash_message(:notice, "Welcome #{user.email}, thank you for signing up using your dP+ account!")
+      else
+        set_flash_message(:notice, "Succesfully logged in!")
+      end
+      sign_in(:user, user, :bypass => true)
+      redirect_to dashboard_path
+    end
+
+When a user signs in through MYDIGIPASS.COM, it could be a new user (signing up), or an existing user.
+The function `find_or_create_from_auth_hash` handles that for me:
+
+    def self.from_auth_hash(auth_hash)
+      logger.debug "User.from_auth_hash: auth_hash = #{auth_hash.inspect} "
+      received_uuid = auth_hash[:extra][:raw_info][:uuid]
+      received_email = auth_hash[:extra][:raw_info][:email]
+
+      user = User.find_by_uuid(received_uuid) || User.find_by_email(received_email)
+      user = user.nil? ? create_from_auth_hash(received_uuid, received_email) : prevent_login_with_normal_password(user, received_uuid)
+    end
+
+I try to find the user, by `uuid` or `email`. If I find the user by `uuid`, she has logged on before with MYDIGIPASS.COM
+If I find a matching mail, link the uuid to that user. If I do not find a user, create one with the given `email` and `uuid`.
+I also made sure that users can then only login with their MYDIGIPASS.COM and no longer normally, but that is optional of course.
+
+## License
+
+Copyright (c) 2012 Nathan Van der Auwera
+
+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,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new
+
+desc 'Default: Run specs'
+task :default => :spec

data/example/Gemfile

@@ -0,0 +1,6 @@
+source :rubygems
+
+gem 'rack', '~> 1.3.6'
+
+gem 'sinatra'
+gem 'omniauth-mydigipass', :path => '../'

data/example/config.ru

@@ -0,0 +1,34 @@
+require 'bundler/setup'
+require 'sinatra'
+require 'omniauth'
+require 'omniauth-mydigipass'
+
+
+class App < Sinatra::Base
+  get '/' do
+    content_type 'text/html'
+    <<-HTML
+      <h1>Test OAuth2 with MYDIGIPASS.COM</h1>
+      <script  type="text/javascript" src="https://sandbox.mydigipass.com/dp_connect.js"></script>
+      <a class="dpplus-connect" data-client-id="2z4z3zn6ezuov82e4dfu73q3z" data-redirect-uri="http://localhost:3002/auth/mydigipass/callback" href="#">connect with mydigipass.com</a>
+    HTML
+  end
+
+  get '/auth/:name/callback' do
+    @auth = request.env['omniauth.auth']
+    erb :callback
+  end
+
+  get '/auth/failure' do
+    @request = request
+    erb :failure
+  end
+end
+
+use Rack::Session::Cookie
+use OmniAuth::Builder do
+  provider :mydigipass, '2z4z3zn6ezuov82e4dfu73q3z', '1mcskxim7nomrafvfg7s36pjv',
+           :client_options => OmniAuth::Strategies::Mydigipass.default_client_urls(:sandbox => true)
+end
+
+run App.new

data/example/views/callback.erb

@@ -0,0 +1,14 @@
+<html>
+  <body>
+    <h1>Authentication Successfull via <%= @auth.provider %></h1>
+    <h2>info:</h2>
+    <ul>
+      <%- @auth.info.each do |key, value| %>
+        <li><strong><%= key %>:</strong> <%= value.inspect %></li>
+      <% end %>
+    </ul>
+    <a href='/'>Sign out</a>
+    <h2>raw auth:</h2>
+    <pre style="white-space: pre-wrap"><%= Rack::Utils.escape_html @auth.inspect %></pre>
+  </body>
+</html>

data/example/views/failure.erb

@@ -0,0 +1,6 @@
+<html>
+  <body>
+    <h1>There was an error:</h1>
+    <pre style="white-space: pre-wrap"><%= Rack::Utils.escape_html @request.inspect %></pre>
+  </body>
+</html>

data/lib/omniauth-mydigipass.rb

@@ -0,0 +1,2 @@
+require "omniauth-mydigipass/version"
+require 'omniauth/strategies/mydigipass'

data/lib/omniauth-mydigipass/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Mydigipass
+    VERSION = "1.0.0"
+  end
+end

data/lib/omniauth/strategies/mydigipass.rb

@@ -0,0 +1,61 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class Mydigipass < OmniAuth::Strategies::OAuth2
+
+      def self.default_client_urls(options = {})
+        local_base_uri = options[:sandbox] ? 'https://sandbox.mydigipass.com' : 'https://mydigipass.com'
+        {
+          :site          => local_base_uri,
+          :authorize_url => local_base_uri + '/oauth/authenticate',
+          :token_url     => local_base_uri + '/oauth/token'
+        }
+      end
+
+
+      # Give your strategy a name.
+      option :name, "mydigipass"
+
+      # for the sandbox environment, use http://sandbox.mydigipass.com
+      option :base_uri, "https://mydigipass.com"
+
+      #option :client_options, {
+      #          :site          => base_uri,
+      #          :authorize_url => base_uri + '/oauth/authenticate',
+      #          :token_url     => base_uri + '/oauth/token'
+      #        }
+
+      option :client_options, default_client_urls
+
+
+      # These are called after authentication has succeeded.
+      uid { raw_info['uuid'] }
+
+      info do
+        {
+          :name => "#{raw_info['first_name']} #{raw_info['last_name']}",
+          :email => raw_info['email'],
+          :nickname => raw_info['login'],
+          :first_name => raw_info['first_name'],
+          :last_name => raw_info['last_name'],
+          :location => "#{raw_info['address_1']}, #{raw_info['zip']} #{raw_info['city']}, #{raw_info['country']}",
+        }
+      end
+
+      extra do
+        {'raw_info' => raw_info}
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get('/oauth/user_data').parsed
+      end
+
+      def base_uri
+        default_options[:base_uri]
+      end
+
+
+    end
+  end
+end

data/omniauth-mydigipass.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/omniauth-mydigipass/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Nathan Van der Auwera"]
+  gem.email         = ["nathan@dixis.com"]
+  gem.summary       = %Q{OmniAuth strategy for MYDIGIPASS.COM}
+  gem.description   = %Q{OmniAuth strategy for MYDIGIPASS.COM, which can be used for sandbox or production}
+  gem.homepage      = "https://github.com/nathanvda/omniauth-mydigipass"
+
+  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 -- {test,spec,features}/*`.split("\n")
+  gem.name          = "omniauth-mydigipass"
+  gem.require_paths = ["lib"]
+  gem.version       = OmniAuth::Mydigipass::VERSION
+
+  gem.add_dependency 'omniauth', '~> 1.0'
+  gem.add_dependency 'omniauth-oauth2', '~> 1.0'
+  gem.add_development_dependency 'rspec', '~> 2.7'
+  gem.add_development_dependency 'rack-test'
+  gem.add_development_dependency 'simplecov'
+end

data/spec/omniauth/strategies/mydigipass_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'omniauth-mydigipass'
+
+describe OmniAuth::Strategies::Mydigipass do
+  subject do
+    OmniAuth::Strategies::Mydigipass.new(nil, @options || {})
+  end
+
+  it_should_behave_like 'an oauth2 strategy'
+
+  describe '#client' do
+    it 'should have the correct mydigipass.com site' do
+      subject.client.site.should eq("https://mydigipass.com")
+    end
+
+    it 'should have the correct authorization url' do
+      subject.client.options[:authorize_url].should eq("https://mydigipass.com/oauth/authenticate")
+    end
+
+    it 'should have the correct token url' do
+      subject.client.options[:token_url].should eq('https://mydigipass.com/oauth/token')
+    end
+  end
+
+  describe '#callback_path' do
+    it 'should have the correct callback path' do
+      subject.callback_path.should eq('/auth/mydigipass/callback')
+    end
+  end
+
+  context "when connecting to the sandbox" do
+    it 'should have the correct mydigipass.com site' do
+      @options = { :client_options => OmniAuth::Strategies::Mydigipass.default_client_urls(:sandbox => true) }
+      subject.client.site.should eq("https://sandbox.mydigipass.com")
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'simplecov'
+SimpleCov.start
+require 'rspec'
+require 'rack/test'
+require 'omniauth'
+require 'omniauth-mydigipass'
+
+Dir[File.expand_path('../support/**/*', __FILE__)].each { |f| require f }
+
+RSpec.configure do |config|
+  config.include Rack::Test::Methods
+  config.extend  OmniAuth::Test::StrategyMacros, :type => :strategy
+end
+

data/spec/support/shared_examples.rb

@@ -0,0 +1,39 @@
+# NOTE it would be useful if this lived in omniauth-oauth2 eventually
+# Thanks to Josh Ellithorpe for this file -Will
+
+shared_examples 'an oauth2 strategy' do
+  describe '#client' do
+    it 'should be initialized with symbolized client_options' do
+      @options = { :client_options => { 'authorize_url' => 'https://example.com' } }
+      subject.client.options[:authorize_url].should == 'https://example.com'
+    end
+  end
+
+  describe '#authorize_params' do
+    it 'should include any authorize params passed in the :authorize_params option' do
+      @options = { :authorize_params => { :foo => 'bar', :baz => 'zip' } }
+      subject.authorize_params['foo'].should eq('bar')
+      subject.authorize_params['baz'].should eq('zip')
+    end
+
+    it 'should include top-level options that are marked as :authorize_options' do
+      @options = { :authorize_options => [:scope, :foo], :scope => 'bar', :foo => 'baz' }
+      subject.authorize_params['scope'].should eq('bar')
+      subject.authorize_params['foo'].should eq('baz')
+    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
+
+    it 'should include top-level options that are marked as :token_options' do
+      @options = { :token_options => [:scope, :foo], :scope => 'bar', :foo => 'baz' }
+      subject.token_params['scope'].should eq('bar')
+      subject.token_params['foo'].should eq('baz')
+    end
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-mydigipass
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Nathan Van der Auwera
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: &15842580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *15842580
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: &15842000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *15842000
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &15841420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: *15841420
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: &15840960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *15840960
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &15840420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *15840420
+description: OmniAuth strategy for MYDIGIPASS.COM, which can be used for sandbox or
+  production
+email:
+- nathan@dixis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- example/Gemfile
+- example/config.ru
+- example/views/callback.erb
+- example/views/failure.erb
+- lib/omniauth-mydigipass.rb
+- lib/omniauth-mydigipass/version.rb
+- lib/omniauth/strategies/mydigipass.rb
+- omniauth-mydigipass.gemspec
+- spec/omniauth/strategies/mydigipass_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+homepage: https://github.com/nathanvda/omniauth-mydigipass
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: OmniAuth strategy for MYDIGIPASS.COM
+test_files: []