omniauth-practicefusion 2.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5648b53f57eb785f9d3ab77ea18dcd6d0784e6df
+  data.tar.gz: 0ad8b7b987221e15113a6a480905cac1934b03ab
+SHA512:
+  metadata.gz: f3279e687df651a49fd482409053b694516527e7b65ed701fd8191012459c11eacd37c9c87a62321dd8915f00b8acdf94a7d83cbb80d4c048b856bfc033f9b88
+  data.tar.gz: 222877ff3c0448268b24631feed9bf8510ab9b3799af2cff558ab011b9de554586a9d9041c4040c247b389fc7ec92443d671ff613560276de1094272f915d5e2

data/.gitignore

@@ -0,0 +1,28 @@
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+*.gem
+mkmf.log
+
+/.idea/
+
+/.ruby-version
+
+/omniauth-practicefusion.iml

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in omniauth-practicefusion.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Sam Contapay
+
+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,131 @@
+# Omniauth::PracticeFusion
+
+OAuth 2 strategy for Practice Fusion. Redundant description :\
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    source 'http://gems.hq.practicefusion.com'
+    gem 'omniauth-practicefusion' 
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+This works with Devise and Omniauth. 
+Get an App ID and Secret from Ken. 
+Give him your callback URL (/users/auth/practicefusion/callback).
+
+## Configuration
+
+```
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider OmniAuth::Strategies::PracticeFusion, ENV['PF_OAUTH_CLIENT_ID'], ENV['PF_OAUTH_CLIENT_SECRET'], {
+      scope: ENV['PF_OAUTH_SCOPE'],
+      path_prefix: '/providers/auth',
+      client_options: {
+        site: ENV['PF_OAUTH_SITE_URL'],
+      }
+  }
+end
+```
+
+## Sample Hash
+
+```
+{
+       "provider" => "practicefusion",
+            "uid" => "3cbbbd62-159d-4c40-be4c-2cdf784d6c7d",
+           "info" => {
+                "title" => "Dr",
+           "first_name" => "Sam",
+            "last_name" => "Withnoname",
+        "practice_guid" => "9571286c-c379-4053-9fa3-04caeb62fb69",
+                "email" => "sam@dev.practicefusion.com"
+    },
+    "credentials" => {
+                "token" => "3hvHj7PyVFH9TGyDFXaq",
+        "refresh_token" => "VqycQpxuBS5tjP_Kaab-",
+           "expires_at" => 1412279343,
+              "expires" => true
+    },
+          "extra" => {
+        "raw_info" => {
+                        "title" => "Dr",
+                    "firstName" => "Sam",
+                     "lastName" => "Withnoname",
+                 "practiceGuid" => "9571286c-c379-4053-9fa3-04caeb62fb69",
+                  "ehrUserGuid" => "3cbbbd62-159d-4c40-be4c-2cdf784d6c7d",
+            "loginEmailAddress" => "sam@dev.practicefusion.com"
+        }
+    }
+}
+```
+
+### Devise
+
+First define your application id and secret in "config/initializers/devise.rb" your scope maybe different. TODO add all available scopes.
+
+```ruby
+config.omniauth :practicefusion, ENV['PF_APP_ID'], ENV['PF_APP_SECRET'], {
+                                                                                      scope: 'user:r_basic',
+                                                                                      response_type: 'code'
+                                                                                  }
+```
+
+Then add the following to 'config/routes.rb' so the callback routes are defined.
+
+```ruby
+devise_for :users, :controllers => { :omniauth_callbacks => "users/omniauth_callbacks" }
+```
+f
+Devise default callback URL is '/users/auth/practicefusion/callback' with the above route.
+
+Make sure your model is omniauthable. Generally this is "/app/models/user.rb"
+
+```ruby
+devise :omniauthable, :omniauth_providers => [:practicefusion]
+```
+
+Then make sure your callbacks controller is setup.
+
+```ruby
+class Users::OmniauthCallbacksController < Devise::OmniauthCallbacksController
+  def practicefusion
+        @user = User.find_for_practicefusion(request.env['omniauth.auth'], current_user)
+    
+        if @user.persisted?
+          sign_in_and_redirect @user, event: :authentication
+        else
+          redirect_to new_user_registration_url
+        end     
+  end
+end
+```
+
+and bind to or create the user
+
+```ruby
+def self.find_for_practicefusion(access_token, signed_in_resource = nil)
+    user = User.where(ehr_user_guid: access_token['uid']).first
+      unless user
+        user = User.create(name: access_token['info']['first_name'] + ' ' + access_token['info']['last_name'], ehr_user_guid: access_token['uid'], email: access_token['info']['email'], password: Devise.friendly_token[0,20])
+      end
+    user
+end
+```
+
+For your views you can login using:
+
+```ruby
+<%= link_to "Sign in with Practice Fusion", user_omniauth_authorize_path(:practicefusion) %>
+```
+
+
+
+## Contributing
+
+YES PLEASE LIKE SPECS

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/omniauth-practicefusion.rb

@@ -0,0 +1,2 @@
+require 'omniauth/practicefusion'
+

data/lib/omniauth/practicefusion.rb

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

data/lib/omniauth/practicefusion/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module PracticeFusion
+    VERSION = '2.2.0'
+  end
+end

data/lib/omniauth/strategies/practicefusion.rb

@@ -0,0 +1,127 @@
+require 'omniauth/strategies/oauth2'
+require 'jwt'
+
+module OmniAuth
+  module Strategies
+    class PracticeFusion < OmniAuth::Strategies::OAuth2
+
+      option :name, 'practicefusion'
+
+      option :authorize_options, [:response_type, :client_id, :redirect_uri, :Fauthcode, :scope]
+      option :client_options, {
+        site: 'https://api.practicefusion.com',
+        authorize_url: '/ehr/oauth2/auth',
+        token_url: '/ehr/oauth2/token'
+      }
+
+      uid { raw_info['ehrUserGuid'] }
+
+      info do
+        prune!({
+          title: value_or_blank(raw_info['title']),
+          first_name: value_or_blank(raw_info['firstName']),
+          last_name: value_or_blank(raw_info['lastName']),
+          provider_guid: value_or_blank(raw_info['providerGuid']),
+          practice_guid: value_or_blank(raw_info['practiceGuid']),
+          email: value_or_blank(raw_info['loginEmailAddress'])
+        })
+      end
+
+      extra do
+        hash = {}
+        hash[:raw_info] = raw_info
+        prune! hash
+      end
+
+      credentials do
+        # these are copy-paste from OmniAuth::Strategy::OAuth2
+        hash = {'token' => access_token.token}
+        hash.merge!('refresh_token' => access_token.refresh_token) if access_token.expires? && access_token.refresh_token
+        hash.merge!('expires_at' => access_token.expires_at) if access_token.expires?
+        hash.merge!('expires' => access_token.expires?)
+
+        # additional parameters returned by Practice Fusion
+        hash.merge!('token_type' => access_token['token_type'])
+        hash.merge!('scope' => access_token['scope'])
+        hash.merge!('resource_owner' => access_token['resource_owner'])
+        hash.merge!('resource_owner_authority' => access_token['resource_owner_authority'])
+        hash.merge!('pf_session_token' => access_token['pf_session_token']) if access_token.params.key?('pf_session_token')
+        hash
+      end
+
+      # override callback_url so we don't include query parameters
+      # See https://github.com/intridea/omniauth-oauth2/issues/81 for more details
+      def callback_url
+        full_host + script_name + callback_path
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get('/ehr/v1/users/me').parsed
+      end
+
+      # add the 'authCookie' parameter to the outbound request
+      # the 'state' parameter becomes an encrypted JWT of the session
+      def authorize_params
+        super.merge(session['omniauth.params'].slice('authCookie')).tap do |authz_params|
+          # so omniauth decided (in their infinite wisdom) that instead of setting the
+          # omniauth.origin parameter using their session method, they were gonna access
+          # env['rack.session'] directly, so we need to pull that out into the session
+          session['omniauth.origin'] = env['rack.session']['omniauth.origin']
+          authz_params[:state] = JWT.encode(session, options.client_secret)
+        end
+      end
+
+      # override the callback_phase so we can validate the state token signature
+      def callback_phase
+        # If decode_state_parameter returns the correct state token, then
+        #   request.params['state'] == session['omniauth.state']
+        # which passes the CSRF check of omniauth-oauth2
+
+        # If decode_state_parameter returns nil, then this is true:
+        #   request.params['state'].to_s.empty?
+        # which fails the CSRF check of omniauth-oauth2
+        request.params['state'] = decode_state_parameter
+
+        # omniauth sets the environment up _before_ the callback_phase
+        # begins, but we need to set it up after we've decoded the session
+        @env['omniauth.origin'] = session.delete('omniauth.origin')
+        @env['omniauth.origin'] = nil if env['omniauth.origin'] == ''
+        @env['omniauth.params'] = session.delete('omniauth.params')
+
+        # And now back to our regularly scheduled program
+        super
+      end
+
+      # instead of using the session store, just collect into a hash
+      def session
+        @fake_session ||= {}
+      end
+
+      def session=(obj)
+        @fake_session = obj
+      end
+
+      private
+
+      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
+
+      def value_or_blank(value)
+        (value.blank?) ? '' : value
+      end
+
+      def decode_state_parameter
+        # this will throw an exception if the state parameter is not valid ciphertext
+        # otherwise, decode the JWT and stick the object back into our fake session
+        self.session, _jwt = JWT.decode(request.params["state"].to_s, options.client_secret)
+        session['omniauth.state']
+      rescue JWT::VerificationError, JWT::DecodeError
+        nil
+      end
+    end
+  end
+end

data/omniauth-practicefusion.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth/practicefusion/version'
+
+Gem::Specification.new do |spec|
+  spec.add_dependency 'omniauth', '> 1.0'
+
+  spec.name          = "omniauth-practicefusion"
+  spec.version       = OmniAuth::PracticeFusion::VERSION
+  spec.authors       = ["Sam Contapay, Shaun Guth"]
+  spec.email         = ["scontapay@practicefusion.com", "sguth@practicefusion.com"]
+  spec.summary       = %q{omniauth strategy for Practice Fusion}
+  spec.description   = %q{Lets you use Practice Fusion as a strategy for your omniauth login flows}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'omniauth-oauth2', '~> 1.5'
+  spec.add_runtime_dependency 'json-jwt', '~> 1.0', '>= 1.0.3'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-practicefusion
+version: !ruby/object:Gem::Version
+  version: 2.2.0
+platform: ruby
+authors:
+- Sam Contapay, Shaun Guth
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-29 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.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: json-jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: Lets you use Practice Fusion as a strategy for your omniauth login flows
+email:
+- scontapay@practicefusion.com
+- sguth@practicefusion.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/omniauth-practicefusion.rb
+- lib/omniauth/practicefusion.rb
+- lib/omniauth/practicefusion/version.rb
+- lib/omniauth/strategies/practicefusion.rb
+- omniauth-practicefusion.gemspec
+homepage: ''
+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.6.11
+signing_key: 
+specification_version: 4
+summary: omniauth strategy for Practice Fusion
+test_files: []