omniauth-prestodoctor 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 29dbe24561580e63333f17ac1015c4a3175b6e87
+  data.tar.gz: 030f7531763ffc4b3c87376248a1b61525f0f387
+SHA512:
+  metadata.gz: 6d750ae39dae3424c359853c4d47779a10e7bb35ff37cf780cb52e39b8445e6ac23f490ff44da6e15c1a96db4ad302c09e90eb78be91bf8fdf291d2c0faed2d2
+  data.tar.gz: 78ceb5d1e2303b23650406d9f57c52021e4cb8081247743f434b6ed3dc69f40fea742ab082f7fd01c7c31f2b9e89f71aa934bac477152e0cd442d41d5b2af67a

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+coverage
+.idea/

data/.rspec

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

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem 'rake'
+gem 'pry'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015, Kyle Powers - PrestoDoctor
+
+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,74 @@
+# OmniAuth PrestoDoctor Strategy
+
+OmniAuth 2 strategy for [PrestoDoctor](https://prestodoctor.com/)
+
+For more details, read the [PrestoDoctor API Reference](https://prestodoctor.com/docs)
+
+# Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "omniauth-prestodoctor"
+```
+
+then bundle install
+
+# Usage & Configuration
+
+Here's an example, adding the middleware to a Rails app in config/initializers/omniauth.rb:
+
+You can configure permissions/scope (as a space separated string),
+which you pass in to the `provider` method after your `PRESTO_APP_ID` and `PRESTO_SECRET`:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :presto_doctor, ENV['PRESTO_APP_ID'], ENV['PRESTO_SECRET'], scope: 'user_info recommendation photo_id'
+end
+```
+
+Available scopes are:
+
+- `user_info`
+- `recommendation`
+- `photo_id`
+
+If you don't include any `scope` it will default to only `user_info`.
+
+NOTE: While developing your application, if you change the scope in the initializer you will need to restart your app server.
+
+You can now access the OmniAuth PrestoDoctor OAuth2 URL: /auth/prestodoctor
+
+# Usage with Devise
+
+In your app/initializers/devise.rb, in the omniauth section, add a line using similar syntax and configuration:
+
+```ruby
+config.omniauth :presto_doctor, ENV['PRESTO_APP_ID'], ENV['PRESTO_SECRET'], scope: 'user_info recommendation photo_id'
+```
+
+## Add to your User model
+
+For a user to be able to log in via PrestoDoctor, you will need to set on your User model:
+
+```ruby
+devise :omniauthable, :omniauth_providers => [:prestodoctor]
+```
+
+## Including in Views
+
+You will now be able to link to the PrestoDoctor authorization path, like so:
+
+```erb
+<%= link_to user_omniauth_authorize_path(:prestodoctor) do %>
+  <%= image_tag 'prestodoctor-login.png' %>
+<% end %>
+```
+
+# Callbacks
+
+You will need to set up a callback path that we can call with the generated token
+
+You can see an example of this here: https://github.com/PrestoDoctor/prestodoctor-oauth
+
+(look at `app/controllers/users/omniauth/callbacks_controller.rb` and it's related entry in `routes.rb`)

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new
+
+desc 'Default: run specs.'
+task :default => :spec

data/lib/omniauth-prestodoctor.rb

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

data/lib/omniauth-prestodoctor/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module PrestoDoctor
+    VERSION = "0.5.0"
+  end
+end

data/lib/omniauth/strategies/prestodoctor.rb

@@ -0,0 +1,54 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class PrestoDoctor < OmniAuth::Strategies::OAuth2
+      BASE_USER_API = '/api/v1/user'
+      SCOPES = {
+          USER_INFO: 'user_info',
+          RECOMMENDATION: 'recommendation',
+          PHOTO_ID: 'photo_id'
+      }
+
+      option :name, :prestodoctor
+
+      option :client_options, {
+                                site: 'https://prestodoctor.com',
+                                authorize_url: '/oauth/authorize'
+                            }
+
+      uid { raw_info['id'] }
+
+      info do
+        raw_info
+      end
+
+      extra do
+        {
+            recommendation: recommendation,
+            photo_id: photo_id
+        }
+      end
+
+      def raw_info
+        @raw_info ||= has_scope?(SCOPES[:USER_INFO]) ? access_token.get(BASE_USER_API).parsed : nil
+      end
+
+      def recommendation
+        @raw_rec ||= has_scope?(SCOPES[:RECOMMENDATION]) ? access_token.get(BASE_USER_API + '/recommendation').parsed : nil
+      end
+
+      def photo_id
+        @raw_photo_id ||= has_scope?(SCOPES[:PHOTO_ID]) ? access_token.get(BASE_USER_API + '/photo_id').parsed : nil
+      end
+
+      private
+
+      def has_scope?(scope_name)
+        return false unless access_token.params['scope']
+        scopes = access_token.params['scope'].split(' ')
+        scopes.include? scope_name
+      end
+    end
+  end
+end

data/omniauth-prestodoctor.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "omniauth-prestodoctor/version"
+
+Gem::Specification.new do |s|
+  s.name        = "omniauth-prestodoctor"
+  s.version     = OmniAuth::PrestoDoctor::VERSION
+  s.authors     = ["Kyle Powers"]
+  s.email       = ["kyle@prestodoctor.com"]
+  s.homepage    = "https://github.com/PrestoDoctor/omniauth-prestodoctor"
+  s.summary     = %q{OmniAuth strategy for PrestoDoctor}
+  s.description = %q{OmniAuth strategy for PrestoDoctor}
+  s.licenses    = ['MIT']
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'multi_json', '~> 1.3'
+  s.add_runtime_dependency 'omniauth-oauth2', '~> 1.2'
+  s.add_development_dependency 'rspec', '~> 2.7'
+  s.add_development_dependency 'rack-test', '~> 0.6'
+  s.add_development_dependency 'simplecov', '~> 0.10'
+  s.add_development_dependency 'webmock', '~> 1.20'
+end

data/spec/omniauth/strategies/prestodoctor_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::PrestoDoctor do
+  subject do
+    OmniAuth::Strategies::PrestoDoctor.new({})
+  end
+
+  context 'client options' do
+    it 'should have correct name' do
+      expect(subject.options.name).to eq(:prestodoctor)
+    end
+
+    it 'should have correct site' do
+      expect(subject.options.client_options.site).to eq('https://prestodoctor.com')
+    end
+
+    it 'should have correct authorize url' do
+      expect(subject.options.client_options.authorize_url).to eq('/oauth/authorize')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'simplecov'
+SimpleCov.start
+require 'rspec'
+require 'rack/test'
+require 'webmock/rspec'
+require 'omniauth'
+require 'omniauth-prestodoctor'
+
+RSpec.configure do |config|
+  config.include WebMock::API
+  config.include Rack::Test::Methods
+  config.extend  OmniAuth::Test::StrategyMacros, :type => :strategy
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-prestodoctor
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Kyle Powers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+description: OmniAuth strategy for PrestoDoctor
+email:
+- kyle@prestodoctor.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/omniauth-prestodoctor.rb
+- lib/omniauth-prestodoctor/version.rb
+- lib/omniauth/strategies/prestodoctor.rb
+- omniauth-prestodoctor.gemspec
+- spec/omniauth/strategies/prestodoctor_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/PrestoDoctor/omniauth-prestodoctor
+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.4.5
+signing_key: 
+specification_version: 4
+summary: OmniAuth strategy for PrestoDoctor
+test_files:
+- spec/omniauth/strategies/prestodoctor_spec.rb
+- spec/spec_helper.rb