omniauth-medpass 1.0.0

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in omniauth-medpass.gemspec
+gemspec
+
+group :example do
+  gem 'sinatra'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Karol Sarnacki
+
+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/README.md

@@ -0,0 +1,138 @@
+# OmniAuth Medpass  [![Build Status](https://secure.travis-ci.org/connectmedica/omniauth-medpass.png)][travis] [![Dependency Status](https://gemnasium.com/connectmedica/omniauth-medpass.png?travis)][gemnasium]
+
+Medpass OAuth2 Strategy for [OmniAuth 1.0](https://github.com/intridea/omniauth) authentication system.
+
+[travis]: http://travis-ci.org/connectmedica/omniauth-medpass
+[gemnasium]: https://gemnasium.com/connectmedica/omniauth-medpass
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'omniauth-medpass'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-medpass
+
+## Quick start
+
+    $ MEDPASS_API_KEY="your_medpass_api_key" ruby examples/sinatra.rb
+
+## Configuration
+
+```ruby
+require 'omniauth-medpass'
+require 'openid/store/filesystem'
+
+use Rack::Session::Cookie
+use OmniAuth::Strategies::Medpass, ENV['MEDPASS_API_KEY'], :store => OpenID::Store::Filesystem.new('/tmp')
+```
+
+Block style:
+
+```ruby
+require 'omniauth-medpass'
+require 'openid/store/filesystem'
+
+use OmniAuth::Builder do
+  provider :medpass, 'YOUR_MEDPASS_API_KEY', :store => OpenID::Store::Filesystem.new('/tmp')
+end
+```
+
+*Medpass API Key* is optional - you do not need it to successfully authenticate user - but if you provide it, you will have access to full Auth Hash data.
+
+For more information about configuring OpenID strategy, see [original documentation](https://github.com/intridea/omniauth-openid).
+
+Note that default OpenID stores (`memory` and `filesystem`) will not work on clustered servers (unless they all share same store path).
+
+## Usage
+
+```html
+<a href="/auth/medpass">Sign in with Medpass</a>
+```
+
+...and then retrieve authenticated user data in callback (here using Sinatra):
+
+```ruby
+post '/auth/unipass/callback' do
+  User.create(:id => request.env['omniauth.auth'].id)
+end
+```
+
+## Auth Hash
+
+Exemplary Auth Hash obtained after successful authentication:
+
+```ruby
+{
+  'provider' => 'medpass',
+  'id' => 'eilda.bleet',
+  'info' => {
+    'name'        => 'Eilda Bleet',
+    'email'       => 'eilda@bleet.com',
+    'nickname'    => 'anonimowy użytkownik', # user can hide his display_name
+    'first_name'  => 'Eilda',
+    'last_name'   => 'Bleet',
+    'location'    => 'Poznań',
+    'description' => 'Absolwentka wyższej szkoły organizacji turystyki i hotelarstwa.',
+    'image'       => 'http://medpass.pl/profile/get_avatar?login=eilda.bleet&size=small',
+    'phone'       => nil,
+    'urls'        => {
+      'medpass' => 'http://eilda.bleet.medpass.pl'
+    }
+  },
+  'extra' => {
+    'raw_info' => {
+      'medpass_id'       => 123,
+      'login'            => 'eilda.bleet',
+      'firstname'        => 'Eilda',
+      'lastname'         => 'Bleet',
+      'title'            => 'Dr',
+      'display_name'     => 'anonimowy użytkownik',
+      'email'            => 'eilda@bleet.com'
+      'group'            => 2,
+      'group_key'        => 'DOC',
+      'city'             => 'Poznań',
+      'address'          => 'Lipna 27',
+      'postcode'         => '01-234',
+      'mobile_phone'     => '521324354',
+      'phone'            => '229876543',
+      'skype'            => 'eilda1717',
+      'gadu'             => nil,
+      'pwz'              => '696969',
+      'speciality'       => nil,
+      'about'            => 'I love pancakes!',
+      'gender'           => 1,
+      'company_name'     => 'Activeweb',
+      'company_address'  => 'Wiatru w polu 3',
+      'company_city'     => 'Gdynia',
+      'company_postcode' => nil,
+      'company_province' => 'śląskodąbrowskie',
+      'company_phone'    => nil,
+      'is_superviewer'   => false,
+      'province' => {
+        'province' => {
+          'name' => 'mazowieckie',
+          'code' => '14',
+          'id'   => 7
+        }
+      }
+    }
+  }
+}
+```
+
+Note that this information is available only if you provide valid Medpass API Key.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/examples/sinatra.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.setup :default, :development, :example
+
+require 'sinatra'
+require 'omniauth-medpass'
+
+use Rack::Session::Cookie
+use OmniAuth::Strategies::Medpass, ENV['MEDPASS_API_KEY']
+
+get '/' do
+  <<-HTML
+  <ul>
+    <li><a href='/auth/medpass'>Sign in with Medpass</a></li>
+  </ul>
+  HTML
+end
+
+[:get, :post].each do |method|
+  send method, '/auth/:provider/callback' do
+    '<dl>' + request.env['omniauth.auth'].info.map{ |k, v| "<dt>#{k}</dt><dd>#{v.inspect}</dd>" }.join + '</dl>'
+  end
+end

data/lib/omniauth-medpass.rb

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

data/lib/omniauth-medpass/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module Medpass
+    VERSION = '1.0.0'
+  end
+end

data/lib/omniauth/strategies/medpass.rb

@@ -0,0 +1,106 @@
+require 'omniauth/strategies/open_id'
+require 'multi_json'
+
+module OmniAuth
+  module Strategies
+    class Medpass < OmniAuth::Strategies::OpenID
+      URI_SCHEME_REGEXP = /[#{URI::REGEXP::PATTERN::ALPHA}][-+.#{URI::REGEXP::PATTERN::ALPHA}\d]*/
+
+      args :api_key
+
+      option :api_key, nil
+      option :name, :medpass
+      option :site, 'http://medpass.pl'
+      option :openid_url_scheme, 'http://%{login}.medpass.pl'
+      option :identifier_param, 'login'
+
+      uid { openid_response.display_identifier }
+
+      info do
+        {
+            'email'       => raw_info['email'],
+            'nickname'    => raw_info['display_name'], # Also available: openid_response.display_identifier
+            'first_name'  => raw_info['firstname'],
+            'last_name'   => raw_info['lastname'],
+            'location'    => raw_info['city'], # Also available: address, postcode, province
+            'description' => raw_info['about'],
+            'image'       => user_avatar_uri.to_s,
+            'phone'       => raw_info['phone'], # Also available: mobile_phone
+            'urls'        => {
+                options.name.to_s => openid_url
+            }
+        }
+      end
+
+      extra do
+        { 'raw_info' => raw_info }
+      end
+
+      def get_identifier
+        f = OmniAuth::Form.new(:title => 'Medpass Authentication')
+        f.label_field('Medpass Identifier', options.identifier_param)
+        f.input_field('url', options.identifier_param)
+        f.to_response
+      end
+
+      def identifier
+        i = request.params[options.identifier_param.to_s]
+        i = i !~ /\S/ ? nil : openid_url_from_login(i)
+        i
+      end
+
+      private
+
+      def raw_info
+        @raw_info ||= options.api_key ? MultiJson.decode(Net::HTTP.get(user_profile_uri)) : {}
+      end
+
+      def user_profile_uri
+        @user_profile_uri ||= URI.parse("#{options.site}/resource_api/users/#{encode_login(login)}?api_key=#{options.api_key}&full_profile=1")
+      end
+
+      def user_avatar_uri
+        @user_avatar_uri ||= URI.parse("#{options.site}/profile/get_avatar?login=#{login}&size=small") # "Small" = 50x50
+      end
+
+      def login
+        @login ||= login_from_openid_url(openid_response.display_identifier)
+      end
+
+      def openid_url
+        @openid_url ||= openid_url_from_login(openid_response.display_identifier)
+      end
+
+      def login_from_openid_url(openid_url)
+        return nil if openid_url !~ /\S/
+
+        # Remove parts guessed from options[:openid_url_scheme]
+        parts = options.openid_url_scheme.rpartition('%{login}')
+        openid_url.gsub!(/^#{parts.first}/, '')
+        openid_url.gsub!(/#{parts.last}$/, '')
+
+        # Remove host and port guessed from options[:site]
+        uri = URI.parse(options.site)
+        openid_url.gsub!(/\.#{uri.host}(?::\d*)?\/*$/, '')
+
+        # Remove some common parts - scheme and trailing slashes
+        openid_url.gsub!(/^#{URI_SCHEME_REGEXP}:\/\//, '')
+        openid_url.gsub!(/\/+$/, '')
+
+        openid_url
+      end
+
+      def openid_url_from_login(login)
+        return nil if login !~ /\S/
+
+        options.openid_url_scheme % {:login => login_from_openid_url(login)}
+      end
+
+      def encode_login(login)
+        login.to_s.gsub('.', '-dot-')
+      end
+
+    end
+  end
+end
+

data/omniauth-medpass.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/omniauth-medpass/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Karol Sarnacki']
+  gem.email         = ['sodercober@gmail.com']
+  gem.description   = %q{Medpass OpenID Strategy for OmniAuth 1.0}
+  gem.summary       = %q{Medpass OpenID Strategy for OmniAuth 1.0}
+  gem.homepage      = 'https://github.com/connectmedica/omniauth-medpass'
+
+  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-medpass'
+  gem.require_paths = ['lib']
+  gem.version       = Omniauth::Medpass::VERSION
+
+  gem.add_runtime_dependency 'multi_json'
+  gem.add_runtime_dependency 'omniauth-openid', '~> 1.0.0'
+
+  gem.add_development_dependency 'rack-test'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec', '~> 2.8.0'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'webmock'
+end

data/spec/omniauth/strategies/medpass_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::Medpass, :type => :strategy do
+
+  def app
+    strat = OmniAuth::Strategies::Medpass
+    Rack::Builder.new {
+      use Rack::Session::Cookie
+      use strat
+      run lambda{ |env| [404, {'Content-Type' => 'text/plain'}, [nil || env.key?('omniauth.auth').to_s]] }
+    }.to_app
+  end
+
+  def expired_query_string
+    'openid=consumer&janrain_nonce=2011-07-21T20%3A14%3A56ZJ8LP3T&openid.assoc_handle=%7BHMAC-SHA1%7D%7B4e284c39%7D%7B9nvQeg%3D%3D%7D&openid.claimed_id=http%3A%2F%2Flocalhost%3A1123%2Fjohn.doe%3Fopenid.success%3Dtrue&openid.identity=http%3A%2F%2Flocalhost%3A1123%2Fjohn.doe%3Fopenid.success%3Dtrue&openid.mode=id_res&openid.ns=http%3A%2F%2Fspecs.openid.net%2Fauth%2F2.0&openid.op_endpoint=http%3A%2F%2Flocalhost%3A1123%2Fserver%2F%3Fopenid.success%3Dtrue&openid.response_nonce=2011-07-21T20%3A14%3A56Zf9gC8S&openid.return_to=http%3A%2F%2Flocalhost%3A8888%2FDevelopment%2FWordpress%2Fwp_openid%2F%3Fopenid%3Dconsumer%26janrain_nonce%3D2011-07-21T20%253A14%253A56ZJ8LP3T&openid.sig=GufV13SUJt8VgmSZ92jGZCFBEvQ%3D&openid.signed=assoc_handle%2Cclaimed_id%2Cidentity%2Cmode%2Cns%2Cop_endpoint%2Cresponse_nonce%2Creturn_to%2Csigned'
+  end
+
+  describe '/auth/medpass without an identifier URL' do
+    before do
+      get '/auth/medpass'
+    end
+
+    it 'responds with OK' do
+      last_response.should be_ok
+    end
+
+    it 'responds with HTML' do
+      last_response.content_type.should == 'text/html'
+    end
+
+    it 'renders an identifier URL input' do
+      last_response.body.should =~ %r{<input[^>]*login}
+    end
+  end
+
+  describe 'followed by /auth/open_id/callback' do
+    context 'successful' do
+      #before do
+      #  @identifier_url = 'http://me.example.org'
+      #  # TODO: change this mock to actually return some sort of OpenID response
+      #  stub_request(:get, @identifier_url)
+      #  get '/auth/open_id/callback'
+      #end
+
+      it 'sets provider to medpass'
+      it 'creates auth_hash based on sreg'
+      it 'creates auth_hash based on Medpass Resource API'
+
+      #it 'calls through to the master app' do
+      #  last_response.body.should == 'true'
+      #end
+    end
+
+    context 'unsuccessful' do
+      describe 'returning with expired credentials' do
+        before do
+          # get '/auth/open_id/callback?' + expired_query_string
+        end
+
+        it 'it redirects to invalid credentials' do
+          pending
+          last_response.should be_redirect
+          last_response.headers['Location'].should =~ %r{invalid_credentials}
+        end
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'bundler/setup'
+
+require 'simplecov'
+SimpleCov.start
+
+require 'rspec'
+require 'rack/test'
+require 'webmock/rspec'
+require 'omniauth-medpass'
+
+RSpec.configure do |config|
+  config.include WebMock::API
+  config.include Rack::Test::Methods
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-medpass
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Karol Sarnacki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &70361615718160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70361615718160
+- !ruby/object:Gem::Dependency
+  name: omniauth-openid
+  requirement: &70361615717660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70361615717660
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: &70361615717240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70361615717240
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70361615716780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70361615716780
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70361615716280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *70361615716280
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70361615715860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70361615715860
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70361615715400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70361615715400
+description: Medpass OpenID Strategy for OmniAuth 1.0
+email:
+- sodercober@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- examples/sinatra.rb
+- lib/omniauth-medpass.rb
+- lib/omniauth-medpass/version.rb
+- lib/omniauth/strategies/medpass.rb
+- omniauth-medpass.gemspec
+- spec/omniauth/strategies/medpass_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/connectmedica/omniauth-medpass
+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'
+      segments:
+      - 0
+      hash: 2705916791591618707
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2705916791591618707
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Medpass OpenID Strategy for OmniAuth 1.0
+test_files:
+- spec/omniauth/strategies/medpass_spec.rb
+- spec/spec_helper.rb