RubyGems - omniauth-swagger - Versions diffs - 0.1.2 → 0.1.3 - Mend

omniauth-swagger 0.1.2 → 0.1.3

Files changed (15) hide show

checksums.yaml +4 -4
data/examples/.gitignore +1 -1
data/examples/Gemfile +0 -1
data/examples/app.rb +26 -30
data/examples/harvest.json +39 -0
data/examples/providers.yml.sample +16 -0
data/lib/omniauth/strategies/swagger.rb +59 -26
data/lib/omniauth/swagger/default_provider_lookup.rb +41 -0
data/lib/omniauth/swagger/oauth2_definition.rb +26 -7
data/lib/omniauth/swagger/provider_defaults.rb +17 -0
data/lib/omniauth/swagger/providers.yml +11 -0
data/lib/omniauth/swagger/version.rb +1 -1
data/omniauth-swagger.gemspec +1 -1
metadata +10 -5
data/examples/providers.netrc.sample +0 -9

checksums.yaml CHANGED

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e1568fcbf66c910ad1a3648caed82f65d8af2e3
-  data.tar.gz: 32b02fd206aae5a77f2358e6be6f63f936a5a395
+  metadata.gz: c266f0f11e17f0aeb7f34f1b3f2971ef18206ffa
+  data.tar.gz: 0f9c87ee827001095f6b367bc38a44735dc0c97f
 SHA512:
-  metadata.gz: 29da50639770dda96792c50215cc83dcafcc2cb284ea0d96e37aead4cb2b73cf0aa8a0f5c882bb354d648bb1ae75ebe0a16feb6bb226b88e09c5e37ce32c73e0
-  data.tar.gz: 7406d06a2f5ada47552f35341a8718a45dcd0d5ea604ff472605fc305456c5c17d52c00456e8cf55b35f5a02f165de84ce05931e54b15ae759837d04a906128f
+  metadata.gz: d87d183a03d750de7271d8d779ba6f639417f77074c0cc1e0e73bdbb4da598c2d6e2ca22cf1821123029d5ed0bf1f5c891a4da319e74f8626c514a870beb329f
+  data.tar.gz: 7b16a79d6f61e3647591941afe6060e2ca74418b6ec735da239fedc9b3cdad0f98f82ff8dc46594623c9866deff0400c3b21cb70db22cf919965ce99a10c715a

data/examples/.gitignore CHANGED

	@@ -1 +1 @@
1	- providers.~~netrc~~
1	+ providers.yml

data/examples/Gemfile CHANGED

@@ -4,4 +4,3 @@ source "https://rubygems.org"
 gem 'sinatra', '~> 1.4.6'
 gem 'omniauth-swagger', path: '..'
 gem 'pry-byebug'
-gem 'netrc'

data/examples/app.rb CHANGED

@@ -1,49 +1,37 @@
 require 'sinatra'
 require 'omniauth-swagger'
 require 'pry'
-require 'netrc'
+# Callback URL will look like this: http://localhost:4567/auth/swagger/callback
 # Store client_id as the login, secret as password
-n = Netrc.read(File.join(File.dirname(__FILE__), 'providers.netrc'))
+providers_config = YAML.load_file(File.join(File.dirname(__FILE__), "providers.yml"))
+providers_config.keys.each do |key|
+  providers_config[key][:uri] = File.join(File.dirname(__FILE__), "#{key}.json")
+end
 configure do
   enable :sessions
   use OmniAuth::Builder do
-    provider :swagger, providers: {
-      github: {
-        uri: File.join(File.dirname(__FILE__), 'github.json'),
-        client_id: n['github'][0],
-        client_secret: n['github'][1],
-        scope: 'user',
-        uid: "get_user#id"
-      },
-      slack: {
-        uri: File.join(File.dirname(__FILE__), 'slack.json'),
-        client_id: n['slack'][0],
-        client_secret: n['slack'][1],
-        scope: 'identity',
-        uid: "test_auth#user_id"
-      },
-      stripe_connect: {
-        uri: File.join(File.dirname(__FILE__), 'stripe_connect.json'),
-        client_id: n['stripe_connect'][0],
-        client_secret: n['stripe_connect'][1],
-        uid: { param: "stripe_user_id" }
-      }
-    }
+    providers_config = YAML.load_file(File.join(File.dirname(__FILE__), "providers.yml"))
+    providers_config.keys.each do |key|
+      providers_config[key][:uri] = File.join(File.dirname(__FILE__), "#{key}.json")
+    end
+    provider :swagger, providers: providers_config
   end
 end
 get '/' do
+  links = providers_config.keys.map do |key|
+    <<-HTML
+      <li><a href="/auth/swagger?provider=#{key}">#{key}</a></li>
+    HTML
+  end
   <<-HTML
     <html>
     <body>
-      <ol>
-        <li><a href="/auth/swagger?provider=github">Github</a></li>
-        <li><a href="/auth/swagger?provider=slack">Slack</a></li>
-        <li><a href="/auth/swagger?provider=stripe_connect">Stripe Connect</a></li>
-      </ol>
+      <ol> #{links.join} </ol>
     </body>
     </html>
   HTML
@@ -55,7 +43,15 @@ get '/auth/:provider/callback' do
     <html>
     <body>
       Provider: #{params['provider']}<br>
-      UID: #{auth['uid']}
+      UID: #{auth['uid']}<br>
+      Token: #{auth['credentials']['token']}<br>
+      Secret: #{auth['credentials']['token']}<br>
+      Expires: #{auth['credentials']['expires']}<br>
+      Expires At: #{auth['credentials']['expires_at']}<br>
+      Raw Info:<br>
+      <pre>
+        #{auth["extra"]["raw_info"]}
+      </pre>
     </body>
     </html>
   HTML

data/examples/harvest.json ADDED

@@ -0,0 +1,39 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "title": "Mandrill",
+    "version": "1.0"
+  },
+  "x-base-host": "harvestapp.com",
+  "basePath": "/",
+  "schemes": ["https"],
+  "produces": ["application/json", "application/xml"],
+  "securityDefinitions": {
+    "oauth2": {
+      "type": "oauth2",
+      "flow": "accessCode",
+      "authorizationUrl": "/oauth2/authorize",
+      "tokenUrl": "/oauth2/token",
+      "scopes": {}
+    }
+  },
+  "security": {
+    "oauth2": []
+  },
+  "paths": {
+    "/account/who_am_i": {
+      "get": {
+        "summary": "User and account information for current user",
+        "operationId": "whoAmI"
+      }
+    }
+  }
+}

data/examples/providers.yml.sample ADDED

@@ -0,0 +1,16 @@
+---
+github:
+  client_id: GITHUB_CLIENT_ID
+  client_secret: GITHUB_CLIENT_SECRET
+  scope: user
+slack:
+  client_id: SLACK_CLIENT_ID
+  client_secret: SLACK_CLIENT_SECRET
+  scope: identity
+stripe_connect:
+  client_id: STRIPE_CONNECT_CLIENT_ID
+  client_secret: STRIPE_CONNECT_CLIENT_SECRET
+harvest
+  client_id: HARVEST_CLIENT_ID
+  client_secret: HARVEST_CLIENT_SECRET
+  subdomain: HARVEST_SUBDOMAIN

data/lib/omniauth/strategies/swagger.rb CHANGED

@@ -1,6 +1,6 @@
 require 'omniauth-oauth2'
-require 'open-uri'
 require 'omniauth/swagger/oauth2_definition'
+require 'omniauth/swagger/default_provider_lookup'
 require 'diesel'
 module OmniAuth
@@ -8,7 +8,15 @@ module OmniAuth
     class Swagger < OmniAuth::Strategies::OAuth2
-      option :providers, {}
+      OPTION_UID = 'uid'.freeze
+      OPTION_UID_API = 'api'.freeze
+      OPTION_UID_PARAM = 'param'.freeze
+      OPTION_SPECIFICATION = 'specification'.freeze
+      OPTION_SUBDOMAIN = 'subdomain'.freeze
+      option :providers, nil
+      option :provider_lookup, nil
+      option :provider_param, 'provider'
       def setup_phase
         load_definition
@@ -32,45 +40,75 @@ module OmniAuth
       def callback_url
         url = super
-        url + (url.index('?') ? '&' : '?') + "provider=#{request.params['provider']}"
+        url + (url.index('?') ? '&' : '?') + "#{options[:provider_param]}=#{provider_name}"
       end
       uid do
-        uid_option = provider_options[:uid]
-        if uid_option.kind_of? Hash
-          if uid_option[:api]
-            uid_from_api(uid_option[:api])
-          elsif uid_option[:param]
-            access_token.params[uid_option[:param]]
+        if uid_api
+          operation, key = uid_api.split('#')
+          value = key.split('.').reduce(raw_info) { |memo, key| memo[key] }
+          value.to_s
+        else
+          uid_option = provider_options[OPTION_UID]
+          if uid_option[OPTION_UID_PARAM]
+            access_token.params[uid_option[OPTION_UID_PARAM]]
           else
             raise "Unsupported UID option: #{uid_option.inspect}"
           end
-        else
-          uid_from_api(uid_option)
         end
       end
+      extra do
+        { "raw_info" => raw_info }
+      end
       protected
+        def provider_name
+          @provider_name ||= request.params[options[:provider_param]].to_sym
+        end
         def provider_options
-          @provider_options ||= options[:providers][request.params['provider']]
+          @provider_options ||= provider_lookup.get(provider_name, env)
         end
-        def uid_from_api(signature)
-          operation, key = signature.split('#')
-          raw_info[key].to_s
+        def provider_lookup
+          @provider_lookup ||= begin
+                                 if lookup_opt = options[:provider_lookup]
+                                   if lookup_opt.kind_of? Class
+                                     lookup_opt.new
+                                   else
+                                     lookup_opt
+                                   end
+                                 else
+                                   OmniAuth::Swagger::DefaultProviderLookup.new(options[:providers])
+                                 end
+                               end
+        end
+        def uid_api
+          opt = provider_options[OPTION_UID]
+          opt.kind_of?(Hash) ? opt[OPTION_UID_API] : opt
         end
         def raw_info
-          api_class = Diesel.build_api(specification)
-          api = api_class.new(@definition.oauth2_key => {token: access_token.token})
-          operation, key = provider_options[:uid].split('#')
-          api.__send__(operation, {})
+          if uid_api
+            api_options = {@definition.oauth2_key => {token: access_token.token}}
+            if provider_options[OPTION_SUBDOMAIN]
+              api_options[:subdomain] = provider_options[OPTION_SUBDOMAIN]
+            end
+            api_class = Diesel.build_api(specification)
+            api = api_class.new(api_options)
+            operation, key = uid_api.split('#')
+            api.__send__(operation, {})
+          else
+            {}
+          end
         end
         def load_definition
           specification.security_definitions.each_pair do |name, definition|
             if definition.type == 'oauth2'
-              @definition = OmniAuth::Swagger::OAuth2Definition.new(definition, provider_options)
+              @definition = OmniAuth::Swagger::OAuth2Definition.new(definition, specification, provider_options)
             end
           end
           nil
@@ -81,12 +119,7 @@ module OmniAuth
         end
         def load_specification
-          uri = provider_options[:uri]
-          spec = nil
-          open(uri) do |f|
-            spec = Diesel::Swagger::Parser.new.parse(f)
-          end
-          spec
+          provider_options[OPTION_SPECIFICATION].call
         end
     end

data/lib/omniauth/swagger/default_provider_lookup.rb ADDED

@@ -0,0 +1,41 @@
+require 'omniauth/swagger/provider_defaults'
+require 'open-uri'
+module OmniAuth
+  module Swagger
+    class DefaultProviderLookup
+      include ProviderDefaults
+      OPTION_URI = 'uri'.freeze
+      def initialize(providers_config)
+        @config = providers_config
+      end
+      def get(provider_name, env)
+        defaults = provider_defaults[provider_name] || {}
+        if cfg = @config[provider_name]
+          opts = defaults.merge(cfg)
+          configure_spec_loader(opts)
+          opts
+        else
+          defaults
+        end
+      end
+      protected
+        def configure_spec_loader(opts)
+          uri = opts.delete(OPTION_URI)
+          opts[OmniAuth::Strategies::Swagger::OPTION_SPECIFICATION] = Proc.new{
+            spec = nil
+            open(uri) do |f|
+              spec = Diesel::Swagger::Parser.new.parse(f)
+            end
+            spec
+          }
+        end
+    end
+  end
+end

data/lib/omniauth/swagger/oauth2_definition.rb CHANGED

@@ -3,18 +3,25 @@ module OmniAuth
     class OAuth2Definition
+      OPTION_CLIENT_ID = 'client_id'.freeze
+      OPTION_CLIENT_SECRET = 'client_secret'.freeze
+      OPTION_AUTHORIZE_URL = 'authorize_url'.freeze
+      OPTION_TOKEN_URL = 'token_url'.freeze
+      OPTION_SCOPE = 'scope'.freeze
+      OPTION_SUBDOMAIN = 'subdomain'.freeze
       attr_reader :client_id, :client_secret, :client_options
-      def initialize(security_def, options)
-        @security_def, @options = security_def, options
+      def initialize(security_def, spec, options)
+        @security_def, @spec, @options = security_def, spec, options
       end
       def load_options(options)
-        options[:client_id] = @options[:client_id]
-        options[:client_secret] = @options[:client_secret]
-        options[:client_options][:authorize_url] = @security_def.authorization_url
-        options[:client_options][:token_url] = @security_def.token_url
-        options[:scope] = @options[:scope]
+        options[:client_id] = @options[OPTION_CLIENT_ID]
+        options[:client_secret] = @options[OPTION_CLIENT_SECRET]
+        options[:client_options][OPTION_AUTHORIZE_URL] = prepare_url(@security_def.authorization_url)
+        options[:client_options][OPTION_TOKEN_URL] = prepare_url(@security_def.token_url)
+        options[:scope] = @options[OPTION_SCOPE]
       end
       def oauth2_key
@@ -28,6 +35,18 @@ module OmniAuth
       def authorize_params
         @security_def.extensions[:authorize_parameters]
       end
+      protected
+        def prepare_url(url)
+          if (base_host = @spec.extensions[:base_host]) &&
+              (subdomain = @options[OPTION_SUBDOMAIN]) &&
+              !url.match(/^https?\/\//)
+            "https://#{subdomain}.#{base_host}#{url}"
+          else
+            url
+          end
+        end
     end
   end

data/lib/omniauth/swagger/provider_defaults.rb ADDED

@@ -0,0 +1,17 @@
+require 'yaml'
+module OmniAuth
+  module Swagger
+    module ProviderDefaults
+      def provider_defaults
+        @provider_defaults ||= YAML.load_file(defaults_file)
+      end
+      def defaults_file
+        File.join(File.dirname(__FILE__), 'providers.yml')
+      end
+    end
+  end
+end

data/lib/omniauth/swagger/providers.yml ADDED

@@ -0,0 +1,11 @@
+---
+:github:
+  uid: get_user#id
+:slack:
+  uid: test_auth#user_id
+:stripe_connect:
+  uid:
+    param: stripe_user_id
+:harvest:
+  uid: who_am_i#user.id

data/lib/omniauth/swagger/version.rb CHANGED

@@ -1,5 +1,5 @@
 module Omniauth
   module Swagger
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
   end
 end

data/omniauth-swagger.gemspec CHANGED

@@ -23,5 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_dependency "omniauth-oauth2", "~> 1.3.0"
-  spec.add_dependency "diesel-api-dsl", ">= 0.1.3"
+  spec.add_dependency "diesel-api-dsl", ">= 0.1.5"
 end

metadata CHANGED

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-swagger
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Calvin Yu
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2015-06-03 00:00:00.000000000 Z
+date: 2015-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.1.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.1.5
 description: Uses a spec's security definition information to build the oauth2 strategy
 email:
 - me@sourcebender.com
@@ -88,13 +88,17 @@ files:
 - examples/Gemfile.lock
 - examples/app.rb
 - examples/github.json
-- examples/providers.netrc.sample
+- examples/harvest.json
+- examples/providers.yml.sample
 - examples/slack.json
 - examples/stripe_connect.json
 - lib/omniauth-swagger.rb
 - lib/omniauth/strategies/swagger.rb
 - lib/omniauth/swagger.rb
+- lib/omniauth/swagger/default_provider_lookup.rb
 - lib/omniauth/swagger/oauth2_definition.rb
+- lib/omniauth/swagger/provider_defaults.rb
+- lib/omniauth/swagger/providers.yml
 - lib/omniauth/swagger/version.rb
 - omniauth-swagger.gemspec
 homepage: http://github.com/incominghq/omniauth-swagger
@@ -122,3 +126,4 @@ signing_key:
 specification_version: 4
 summary: OmniAuth strategy for authenticating from Swagger specifications
 test_files: []
+has_rdoc:

data/examples/providers.netrc.sample DELETED

@@ -1,9 +0,0 @@
-machine github
-        login GITHUB_CLIENT_ID
-        password GITHUB_CLIENT_SECRET
-machine slack
-        login SLACK_CLIENT_ID
-        password SLACK_CLIENT_SECRET
-machine stripe_connect
-        login STRIPE_CONNECT_CLIENT_ID
-        password STRIPE_CONNECT_CLIENT_SECRET