omniauth-drchrono-oauth2 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 11d425d7ab8ab3a9b65a3bcc0b2c630306ed1ad5
+  data.tar.gz: 9c22adc8d8d2840b87cd0c26b0ac85e51a28844d
+SHA512:
+  metadata.gz: 3f0c86745b5e77457fc55d4d6f537f8185d4e1f4184980c1df173ffe00b659e8f4737f66a5a27999a4aa535d0d5e9ca70698fbe4739baf03eca4093d32255118
+  data.tar.gz: b722a39e3161012ec55d5af09a6c8319282cd69d2cf875afa7298bde45e2296f9e060ed08a3af55629036899f8d137cc5559fd978a7a28b0479dc86f427712b4

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2019 Eric Shelley
+
+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,56 @@
+# OmniAuth DrChrono OAuth2 Strategy
+
+[![Build Status](https://travis-ci.org/bartimaeus/omniauth-drchrono-oauth2.svg?branch=master)](https://travis-ci.org/bartimaeus/omniauth-drchrono-oauth2)
+
+A DrChrono OAuth2 strategy for OmniAuth.
+
+For more details, read the DrChrono documentation: https://www.drchrono.com/api/
+
+I found out after I pushed version 1 of this gem that another omniauth strategy already exists for DrChrono [https://github.com/johnnadeau/omniauth-drchrono](omniauth-drchrono). I renamed this project to `omniauth-drchrono-oauth2` to avoid confusion.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'omniauth-drchrono-oauth2'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-drchrono-oauth2
+
+## Usage
+
+Register your application with DrChrono to receive an API key: https://www.drchrono.com/api/
+
+This is an example that you might put into a Rails initializer at `config/initializers/omniauth.rb`:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :drchrono, ENV['DRCHRONO_CLIENT_ID'], ENV['DRCHRONO_CLIENT_SECRET'], :scope => 'user:read patients:read patients:summary:read'
+end
+```
+
+You can now access the OmniAuth DrChrono OAuth2 URL: `/auth/drchrono`.
+
+## Granting Member Permissions to Your Application
+
+With the DrChrono API, you have the ability to specify which permissions you want users to grant your application.
+For more details, read the DrChrono documentation: https://www.drchrono.com/api/
+
+You can configure the scope option:
+
+```ruby
+provider :drchrono, ENV['DRCHRONO_CLIENT_ID'], ENV['DRCHRONO_CLIENT_SECRET'], :scope => 'user:read'
+```
+
+## Contributing
+
+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

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/example/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'sinatra'
+gem 'omniauth-drchrono-oauth2'

data/example/config.ru

@@ -0,0 +1,31 @@
+# Sample app for DrChrono OAuth2 Strategy
+# Make sure to setup the ENV variables DRCHRONO_CLIENT_ID and DRCHRONO_CLIENT_SECRET
+# Run with "bundle exec rackup"
+
+require 'bundler/setup'
+require 'sinatra/base'
+require 'omniauth-drchrono'
+
+class App < Sinatra::Base
+  get '/' do
+    redirect '/auth/drchrono'
+  end
+
+  get '/auth/:provider/callback' do
+    content_type 'application/json'
+    MultiJson.encode(request.env['omniauth.auth'])
+  end
+
+  get '/auth/failure' do
+    content_type 'application/json'
+    MultiJson.encode(request.env)
+  end
+end
+
+use Rack::Session::Cookie, :secret => 'change_me'
+
+use OmniAuth::Builder do
+  provider :drchrono, ENV['DRCHRONO_CLIENT_ID'], ENV['DRCHRONO_CLIENT_SECRET'], scope: 'user:read'
+end
+
+run App.new

data/lib/omniauth-drchrono-oauth2.rb

@@ -0,0 +1,2 @@
+require "omniauth-drchrono-oauth2/version"
+require "omniauth/strategies/drchrono"

data/lib/omniauth-drchrono-oauth2/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module DrChronoOauth2
+    VERSION = '1.0.0'
+  end
+end

data/lib/omniauth/strategies/drchrono.rb

@@ -0,0 +1,76 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class DrChrono < OmniAuth::Strategies::OAuth2
+      option :name, 'drchrono'
+
+      option :client_options, {
+        :site => 'https://drchrono.com/api',
+        :authorize_url => 'https://drchrono.com/o/authorize',
+        :token_url => 'https://drchrono.com/o/token/'
+      }
+
+      option :scope, 'user:read'
+
+      uid do
+        raw_info['id']
+      end
+
+      info do
+        {
+          'auth' => oauth2_access_token,
+          'doctor' => doctor,
+          'offices' => offices
+        }
+      end
+
+      extra do
+        {
+          'raw_info' => raw_info
+        }
+      end
+
+      def callback_url
+        full_host + script_name + callback_path
+      end
+
+      alias :oauth2_access_token :access_token
+
+      def access_token
+        ::OAuth2::AccessToken.new(client, oauth2_access_token.token, {
+          :expires_in => oauth2_access_token.expires_in,
+          :expires_at => oauth2_access_token.expires_at
+        })
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get(profile_endpoint).parsed
+      end
+
+      def doctor
+        @doctor ||= access_token.get(doctors_endpoint).parsed
+      end
+
+      def offices
+        @offices ||= access_token.get(offices_endpoint).parsed['results']
+      end
+
+      private
+
+      def profile_endpoint
+        '/users/current'
+      end
+
+      def doctors_endpoint
+        "/doctors/#{raw_info['doctor']}"
+      end
+
+      def offices_endpoint
+        '/offices'
+      end
+    end
+  end
+end
+
+OmniAuth.config.add_camelization 'drchrono', 'DrChrono'

data/omniauth-drchrono-oauth2.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth-drchrono-oauth2/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "omniauth-drchrono-oauth2"
+  gem.version       = OmniAuth::DrChronoOauth2::VERSION
+  gem.authors       = ["Eric Shelley"]
+  gem.email         = ["eric@webdesignbakery.com"]
+  gem.description   = %q{DrChrono OAuth2 strategy for OmniAuth.}
+  gem.summary       = %q{DrChrono OAuth2 strategy for OmniAuth.}
+  gem.homepage      = "https://github.com/bartimaeus/omniauth-drchrono-oauth2"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'omniauth-oauth2', '~> 1.2'
+
+  gem.add_development_dependency 'bundler', '~> 1.16'
+  gem.add_development_dependency 'rake', '~> 12.3'
+
+  gem.add_development_dependency 'rspec', '~> 3.6'
+  gem.add_development_dependency 'simplecov', '~> 0.16'
+end

data/spec/omniauth/strategies/drchrono_spec.rb

@@ -0,0 +1,122 @@
+require 'spec_helper'
+require 'omniauth-drchrono-oauth2'
+
+describe OmniAuth::Strategies::DrChrono do
+  subject { OmniAuth::Strategies::DrChrono.new(nil) }
+
+  it 'adds camelization for itself' do
+    expect(OmniAuth::Utils.camelize('drchrono')).to eq('DrChrono')
+  end
+
+  describe '#client' do
+    it 'has correct DrChrono site' do
+      expect(subject.client.site).to eq('https://drchrono.com/api')
+    end
+
+    it 'has correct `authorize_url`' do
+      expect(subject.client.options[:authorize_url]).to eq('https://drchrono.com/o/authorize')
+    end
+
+    it 'has correct `token_url`' do
+      expect(subject.client.options[:token_url]).to eq('https://drchrono.com/o/token/')
+    end
+  end
+
+  describe '#callback_path' do
+    it 'has the correct callback path' do
+      expect(subject.callback_path).to eq('/auth/drchrono/callback')
+    end
+  end
+
+  describe '#uid' do
+    before :each do
+      allow(subject).to receive(:raw_info) { Hash['id' => 'uid'] }
+    end
+
+    it 'returns the id from raw_info' do
+      expect(subject.uid).to eq('uid')
+    end
+  end
+
+  describe '#info / #raw_info' do
+    let(:access_token) { instance_double OAuth2::AccessToken }
+
+    let(:parsed_response) { Hash['doctor' => 14234, 'id' => 43456, 'is_doctor' => true, 'is_staff' => false, 'practice_group' => 8765544, 'username' => 'drchrono'] }
+
+    let(:doctors_endpoint) { "/doctors/14234" }
+    let(:offices_endpoint) { '/offices' }
+    let(:profile_endpoint) { '/users/current' }
+
+    let(:doctors_response) { instance_double OAuth2::Response, parsed: parsed_response }
+    let(:offices_response) { instance_double OAuth2::Response, parsed: parsed_response }
+    let(:profile_response) { instance_double OAuth2::Response, parsed: parsed_response }
+
+    before :each do
+      allow(subject).to receive(:access_token).and_return access_token
+
+      allow(access_token).to receive(:get)
+        .with(doctors_endpoint)
+        .and_return(doctors_response)
+
+      allow(access_token).to receive(:get)
+        .with(offices_endpoint)
+        .and_return(offices_response)
+
+      allow(access_token).to receive(:get)
+        .with(profile_endpoint)
+        .and_return(profile_response)
+    end
+
+    it 'returns parsed responses using access token' do
+      expect(subject.info).to have_key 'auth'
+      expect(subject.info).to have_key 'doctor'
+      expect(subject.info).to have_key 'offices'
+
+      expect(subject.raw_info['doctor']).to eq(14234)
+      expect(subject.raw_info['id']).to eq(43456)
+      expect(subject.raw_info['is_doctor']).to be_truthy
+      expect(subject.raw_info['is_staff']).to be_falsey
+      expect(subject.raw_info['practice_group']).to eq(8765544)
+      expect(subject.raw_info['username']).to eq('drchrono')
+    end
+  end
+
+  describe '#extra' do
+    let(:raw_info) { Hash[:foo => 'bar'] }
+
+    before :each do
+      allow(subject).to receive(:raw_info).and_return raw_info
+    end
+
+    specify { expect(subject.extra['raw_info']).to eq raw_info }
+  end
+
+  describe '#access_token' do
+    let(:expires_in) { 3600 }
+    let(:expires_at) { 946688400 }
+    let(:token) { 'token' }
+    let(:access_token) do
+      instance_double OAuth2::AccessToken, :expires_in => expires_in,
+        :expires_at => expires_at, :token => token
+    end
+
+    before :each do
+      allow(subject).to receive(:oauth2_access_token).and_return access_token
+    end
+
+    specify { expect(subject.access_token.expires_in).to eq expires_in }
+    specify { expect(subject.access_token.expires_at).to eq expires_at }
+  end
+
+  describe '#authorize_params' do
+    describe 'scope' do
+      before :each do
+        allow(subject).to receive(:session).and_return({})
+      end
+
+      it 'sets default scope' do
+        expect(subject.authorize_params['scope']).to eq('user:read')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'simplecov'
+SimpleCov.start
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-drchrono-oauth2
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Eric Shelley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: DrChrono OAuth2 strategy for OmniAuth.
+email:
+- eric@webdesignbakery.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- example/Gemfile
+- example/config.ru
+- lib/omniauth-drchrono-oauth2.rb
+- lib/omniauth-drchrono-oauth2/version.rb
+- lib/omniauth/strategies/drchrono.rb
+- omniauth-drchrono-oauth2.gemspec
+- spec/omniauth/strategies/drchrono_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bartimaeus/omniauth-drchrono-oauth2
+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.5.2.3
+signing_key: 
+specification_version: 4
+summary: DrChrono OAuth2 strategy for OmniAuth.
+test_files:
+- spec/omniauth/strategies/drchrono_spec.rb
+- spec/spec_helper.rb