omniauth-swagger 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4aa3af53aab27a9991c8f201469871134fa03057
+  data.tar.gz: 7bc9587063ef297622882e10973910f86efd5867
+SHA512:
+  metadata.gz: 903dc9cea95cfc2cd683ff585c901b933524618572d5a6cd8c1d6153bb4d330934caf56a59bcbf6b7eabda5a143668f3abd782a1c855c79414d2f0d62b48ed88
+  data.tar.gz: 9e4f1d0d9b818ab07d678b52f0a20cf28a4e5cdf484a2192454b290403080ae8456510f41f4f3aa62d45c4f0995451e599917bf718d6e3b744de8b836241cc0f

data/.gitignore

@@ -0,0 +1,29 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+*.swp

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 incominghq
+
+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,39 @@
+# Omniauth::Swagger
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/omniauth/swagger`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-swagger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-swagger
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/omniauth-swagger/fork )
+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 a new Pull Request

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "omniauth/swagger"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/.gitignore

@@ -0,0 +1 @@
+providers.netrc

data/examples/Gemfile

@@ -0,0 +1,7 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+gem 'sinatra', '~> 1.4.6'
+gem 'omniauth-swagger', path: '..'
+gem 'pry-byebug'
+gem 'netrc'

data/examples/app.rb

@@ -0,0 +1,62 @@
+require 'sinatra'
+require 'omniauth-swagger'
+require 'pry'
+require 'netrc'
+
+# Store client_id as the login, secret as password
+n = Netrc.read(File.join(File.dirname(__FILE__), 'providers.netrc'))
+
+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" }
+      }
+    }
+  end
+end
+
+get '/' do
+  <<-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>
+    </body>
+    </html>
+  HTML
+end
+
+get '/auth/:provider/callback' do
+  auth = request.env['omniauth.auth']
+  <<-HTML
+    <html>
+    <body>
+      Provider: #{params['provider']}<br>
+      UID: #{auth['uid']}
+    </body>
+    </html>
+  HTML
+end

data/examples/github.json

@@ -0,0 +1,56 @@
+{
+  "swagger": "2.0",
+
+  "info": {
+    "title": "Github",
+    "version":  "3"
+  },
+
+  "host": "api.github.com",
+
+  "basePath": "/",
+
+  "schemes": ["https"],
+
+  "produces": ["application/json"],
+
+  "securityDefinitions": {
+    "oauth2": {
+      "type": "oauth2",
+      "flow": "accessCode",
+      "authorizationUrl": "https://github.com/login/oauth/authorize",
+      "tokenUrl": "https://github.com/login/oauth/access_token",
+      "scopes": {
+        "user": "Grants read/write access to profile info only.",
+        "user:email": "Grants read access to a user’s email addresses.",
+        "user:follow": "Grants access to follow or unfollow other users.",
+        "public_repo": "Grants read/write access to code, commit statuses, collaborators, and deployment statuses for public repositories and organizations.",
+        "repo": "Grants read/write access to code, commit statuses, collaborators, and deployment statuses for public and private repositories and organizations.",
+        "repo_deployment": "Grants access to deployment statuses for public and private repositories.",
+        "repo:status": "Grants read/write access to public and private repository commit statuses.",
+        "delete_repo": "Grants access to delete adminable repositories.",
+        "notifications": "Grants read access to a user’s notifications.",
+        "gist": "Grants write access to gists.",
+        "read:repo_hook": "Grants read and ping access to hooks in public or private repositories.",
+        "write:repo_hook": "Grants read, write, and ping access to hooks in public or private repositories.",
+        "admin:repo_hook": "Grants read, write, ping, and delete access to hooks in public or private repositories.",
+        "admin:org_hook": "Grants read, write, ping, and delete access to organization hooks.",
+        "read:org": "Read-only access to organization, teams, and membership.",
+        "write:org": "Publicize and unpublicize organization membership.",
+        "admin:org": "Fully manage organization, teams, and memberships.",
+        "read:public_key": "List and view details for public keys.",
+        "write:public_key": "Create, list, and view details for public keys.",
+        "admin:public_key": "Fully manage public keys."
+      }
+    }
+  },
+
+  "paths": {
+    "/user": {
+      "get": {
+        "summary": "Get the authenticated user",
+        "operationId": "getUser"
+      }
+    }
+  }
+}

data/examples/providers.netrc.sample

@@ -0,0 +1,4 @@
+machine github
+        login GITHUB_CLIENT_ID
+        password GITHUB_CLIENT_SECRET
+

data/examples/slack.json

@@ -0,0 +1,46 @@
+{
+  "swagger": "2.0",
+
+  "info": {
+    "title": "Slack Web API",
+    "version":  "1.0"
+  },
+
+  "host": "slack.com",
+
+  "basePath": "/api",
+
+  "schemes": ["https"],
+
+  "produces": ["application/json"],
+
+  "securityDefinitions": {
+    "oauth2": {
+      "type": "oauth2",
+      "flow": "accessCode",
+      "in": "query",
+      "name": "token",
+      "authorizationUrl": "https://slack.com/oauth/authorize",
+      "tokenUrl": "https://slack.com/api/oauth.access",
+      "scopes": {
+        "identify": "Allows applications to confirm your identity.",
+        "read": "Allows applications to read any messages and state that the user can see.",
+        "post": "Allows applications to write messages and create content on behalf of the user.",
+        "client": "Allows applications to connect to slack as a client, and post messages on behalf of the user.",
+        "admin": "Allows applications to perform administrative actions, requires the authed user is an admin."
+      },
+      "x-authorizeParameters": [
+        "team"
+      ]
+    }
+  },
+
+  "paths": {
+    "/auth.test": {
+      "get": {
+        "summary": "Checks authentication & identity.",
+        "operationId": "testAuth"
+      }
+    }
+  }
+}

data/examples/stripe_connect.json

@@ -0,0 +1,38 @@
+{
+  "swagger": "2.0",
+
+  "info": {
+    "title": "Stripe Connect",
+    "version":  "1.0"
+  },
+
+  "host": "api.stripe.com",
+
+  "basePath": "/v1",
+
+  "schemes": ["https"],
+
+  "produces": ["application/json"],
+
+  "securityDefinitions": {
+    "oauth2": {
+      "type": "oauth2",
+      "flow": "accessCode",
+      "in": "query",
+      "name": "token",
+      "authorizationUrl": "https://connect.stripe.com/oauth/authorize",
+      "tokenUrl": "https://connect.stripe.com/oauth/token",
+      "scopes": {
+        "read_only": "Allows read only access.",
+        "read_write": "Allows read/write access."
+      },
+      "x-authorizeParameters": [
+        "stripe_landing",
+        "always_prompt"
+      ]
+    }
+  },
+
+  "paths": {}
+}
+

data/lib/omniauth-swagger.rb

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

data/lib/omniauth/strategies/swagger.rb

@@ -0,0 +1,96 @@
+require 'omniauth-oauth2'
+require 'open-uri'
+require 'omniauth/swagger/oauth2_definition'
+require 'diesel'
+
+module OmniAuth
+  module Strategies
+
+    class Swagger < OmniAuth::Strategies::OAuth2
+
+      option :providers, {}
+
+      def setup_phase
+        load_definition
+        @definition.load_options(options)
+        super
+      end
+
+      def authorize_params
+        super.tap do |params|
+          passthru_params = @definition.authorize_params || []
+          if @definition.scopes != nil && @definition.scopes.any?
+            passthru_params << 'scope'
+          end
+          passthru_params.each do |v|
+            if request.params[v]
+              params[v.to_sym] = request.params[v]
+            end
+          end
+        end
+      end
+
+      def callback_url
+        url = super
+        url + (url.index('?') ? '&' : '?') + "provider=#{request.params['provider']}"
+      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]]
+          else
+            raise "Unsupported UID option: #{uid_option.inspect}"
+          end
+        else
+          uid_from_api(uid_option)
+        end
+      end
+
+      protected
+        def provider_options
+          @provider_options ||= options[:providers][request.params['provider']]
+        end
+
+        def uid_from_api(signature)
+          operation, key = signature.split('#')
+          raw_info[key].to_s
+        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, {})
+        end
+
+        def load_definition
+          specification.security_definitions.each_pair do |name, definition|
+            if definition.type == 'oauth2'
+              @definition = OmniAuth::Swagger::OAuth2Definition.new(definition, provider_options)
+            end
+          end
+          nil
+        end
+
+        def specification
+          @specification ||= load_specification
+        end
+
+        def load_specification
+          uri = provider_options[:uri]
+          spec = nil
+          open(uri) do |f|
+            spec = Diesel::Swagger::Parser.new.parse(f)
+          end
+          spec
+        end
+
+    end
+
+  end
+end
+

data/lib/omniauth/swagger.rb

@@ -0,0 +1,7 @@
+require "omniauth/swagger/version"
+
+module Omniauth
+  module Swagger
+    # Your code goes here...
+  end
+end

data/lib/omniauth/swagger/oauth2_definition.rb

@@ -0,0 +1,34 @@
+module OmniAuth
+  module Swagger
+
+    class OAuth2Definition
+
+      attr_reader :client_id, :client_secret, :client_options
+
+      def initialize(security_def, options)
+        @security_def, @options = security_def, 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]
+      end
+
+      def oauth2_key
+        @security_def.id.to_sym
+      end
+
+      def scopes
+        @security_def.scopes ? @security_def.scopes.keys : []
+      end
+
+      def authorize_params
+        @security_def.extensions[:authorize_parameters]
+      end
+    end
+
+  end
+end

data/lib/omniauth/swagger/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module Swagger
+    VERSION = "0.1.1"
+  end
+end

data/omniauth-swagger.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth/swagger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-swagger"
+  spec.version       = Omniauth::Swagger::VERSION
+  spec.authors       = ["Calvin Yu"]
+  spec.email         = ["me@sourcebender.com"]
+
+  spec.summary       = %q{OmniAuth strategy for authenticating from Swagger specifications}
+  spec.description   = %q{Uses a spec's security definition information to build the oauth2 strategy}
+  spec.homepage      = "http://github.com/incominghq/omniauth-swagger"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "omniauth-oauth2", "~> 1.3.0"
+  spec.add_dependency "diesel-api-dsl", ">= 0.1.3"
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-swagger
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Calvin Yu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: diesel-api-dsl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+description: Uses a spec's security definition information to build the oauth2 strategy
+email:
+- me@sourcebender.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/.gitignore
+- examples/Gemfile
+- examples/Gemfile.lock
+- examples/app.rb
+- examples/github.json
+- examples/providers.netrc.sample
+- examples/slack.json
+- examples/stripe_connect.json
+- lib/omniauth-swagger.rb
+- lib/omniauth/strategies/swagger.rb
+- lib/omniauth/swagger.rb
+- lib/omniauth/swagger/oauth2_definition.rb
+- lib/omniauth/swagger/version.rb
+- omniauth-swagger.gemspec
+homepage: http://github.com/incominghq/omniauth-swagger
+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 authenticating from Swagger specifications
+test_files: []