warden-oauthed 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 64c088c6e02a7eab994121ca4286c1c8781de98e
+  data.tar.gz: d003d2b5b10efdf72085430bf4ceb2d34344b02f
+SHA512:
+  metadata.gz: 53e16a72196c8d91f039a4f46ee3c3a0b73dcf8a1d4b1d3c83e02d47b4a0e3c161e0779afaee6cd254b3b413aa700f7869178c77750d918556b208500954a86a
+  data.tar.gz: c3419bc56224d7b5375bef5ca25c9ead6408d033e5aad2c52d861b6ffa0f4b59a31add90f8dbba833e468dbccde695400085b9ed5e2598a09cfe7dc4b0d9e630

data/.gitignore

@@ -0,0 +1,11 @@
+coverage
+.bundle
+pkg
+.DS_Store
+Gemfile.lock
+vendor/gems
+*.gem
+.rbenv-version
+bin/
+tags
+.ruby-*

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--order rand

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - ree
+  - ruby-head

data/Gemfile

@@ -0,0 +1,27 @@
+source 'https://rubygems.org'
+ruby '2.2.2'
+
+gem 'json',   '~>1.5'
+gem 'warden', '~>1.0'
+gem 'oauth2', '~>0.5.2'
+gem 'rack',   '~>1.6.0'
+gem 'rake'
+gem 'sinatra'
+
+group :development, :test do
+  gem 'rubocop'
+  gem 'rerun'
+  gem 'rspec', '~> 2.7'
+  gem 'guard'
+  gem 'guard-rubocop'
+  gem 'guard-rspec', '4.2.8'
+  gem 'guard-livereload'
+end
+
+group :test do 
+  gem 'shotgun'
+  gem 'addressable', '~>2.2.0'
+  gem 'rack-test',   '~>0.5.3'
+  gem 'webrat'
+end
+  

data/Guardfile

@@ -0,0 +1,10 @@
+group :red_green_refactor, halt_on_fail: true do
+  guard :rspec, cmd: "bundle exec rspec", failed_mode: 'focus' do
+    watch(%r{^spec/.+_spec\.rb$})
+    watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  end
+  guard :rubocop, all_on_start: false do
+    watch(/.+\.rb$/)
+    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2015 David Jaress
+
+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,9 @@
+# warden-oauthed
+
+A [warden](https://github.com/hassox/warden) strategy that provides OAuth authentication to OAuth2 providers set up similarly to the [grape-doorkeeper](https://github.com/sethherr/grape-doorkeeper) template.
+
+Check out [sinatra_oauthed_template](https://github.com/sethherr/sinatra_oauthed_template), a sinatra template that uses this strategy to set up authentication without a database.
+
+---
+
+Draws inspiration from [warden-github](https://github.com/Zensaburou/warden-github/)

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems/package_task'
+require 'rubygems/specification'
+require 'date'
+require 'bundler'
+
+task :default => [:spec]
+
+require 'rspec/core/rake_task'
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end

data/config.ru

@@ -0,0 +1,17 @@
+ENV['RACK_ENV'] ||= 'development'
+
+begin
+  require File.expand_path('../.bundle/environment', __FILE__)
+rescue LoadError
+  require 'rubygems'
+  require 'bundler'
+  Bundler.setup
+end
+
+Bundler.require(:runtime)
+
+$LOAD_PATH << File.dirname(__FILE__) + '/lib'
+require File.expand_path(File.join(File.dirname(__FILE__), 'lib', 'warden-oauthed'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec', 'app'))
+
+run Example.app

data/lib/warden-oauthed/proxy.rb

@@ -0,0 +1,39 @@
+module Warden
+  module Oauthed
+    module Oauth
+      class Proxy
+        attr_accessor :client_id, :secret, :scopes, :oauth_domain, :callback_url
+        def initialize(client_id, secret, scopes, oauth_domain, callback_url)
+          @client_id, @secret, @scopes, @oauth_domain, @callback_url = client_id, secret, scopes, oauth_domain, callback_url
+        end
+
+        def ssl_options
+          ca_file = "/usr/lib/ssl/certs/ca-certificates.crt"
+          if File.exists?(ca_file)
+            { :ca_file => ca_file }
+          else
+            { :ca_file => ''}
+          end
+        end
+
+        def client
+          @client ||= OAuth2::Client.new(@client_id, @secret,
+                                         :ssl           => ssl_options,
+                                         :site          => oauth_domain,
+                                         :authorize_url => '/oauth/authorize')
+        end
+
+        def api_for(code)
+          client.auth_code.get_token(code, :redirect_uri => callback_url)
+        end
+
+        def authorize_url
+          client.auth_code.authorize_url(
+            :scope        => scopes,
+            :redirect_uri => callback_url
+          )
+        end
+      end
+    end
+  end
+end

data/lib/warden-oauthed/strategy.rb

@@ -0,0 +1,65 @@
+Warden::Strategies.add(:oauthed) do
+  # Need to make sure that we have a pure representation of the query string.
+  # Rails adds an "action" parameter which causes the openid gem to error
+  def params
+    @params ||= Rack::Utils.parse_query(request.query_string)
+  end
+
+  def authenticate!
+    if params['code']
+      begin
+        api = api_for(params['code'])
+
+        resp = api.get '/api/v1/me' do |request|
+          request.params['access_token'] = api.token
+        end.body
+
+        user = JSON.parse(resp)
+        success!(Warden::Oauthed::Oauth::User.new(user['user'], api.token))
+      rescue OAuth2::Error
+        %(<p>Outdated ?code=#{params['code']}:</p><p>#{$!}</p><p><a href="/auth/oauthed">Retry</a></p>)
+      end
+    else
+      env['rack.session']['return_to'] = env['REQUEST_URI']
+      throw(:warden, [ 302, {'Location' => authorize_url}, [ ]])
+    end
+  end
+
+  private
+
+  def oauth_client
+    oauth_proxy.client
+  end
+
+  def authorize_url
+    oauth_proxy.authorize_url
+  end
+
+  def api_for(code)
+    oauth_proxy.api_for(code)
+  end
+
+  def oauth_proxy
+    @oauth_proxy ||= Warden::Oauthed::Oauth::Proxy.new(env['warden'].config[:oauthed_client_id],
+      env['warden'].config[:oauthed_secret],
+      env['warden'].config[:oauthed_scopes],
+      env['warden'].config[:oauthed_oauth_domain],
+      callback_url)
+  end
+
+  def callback_url
+    absolute_url(request, env['warden'].config[:oauthed_callback_url], env['HTTP_X_FORWARDED_PROTO'])
+  end
+
+  def absolute_url(request, suffix = nil, proto = "http")
+    port_part = 
+      case request.scheme
+      when "http"
+        request.port == 80 ? "" : ":#{request.port}"
+      when "https"
+        request.port == 443 ? "" : ":#{request.port}"
+      end
+    proto = "http" if proto.nil?
+    "#{proto}://#{request.host}#{port_part}#{suffix}"
+  end
+end

data/lib/warden-oauthed/user.rb

@@ -0,0 +1,15 @@
+module Warden
+  module Oauthed
+    module Oauth
+      class User < Struct.new(:attribs, :token)
+        ATTRIBUTES = %w[id full_name email].freeze
+
+        
+        ATTRIBUTES.each do |name|
+          define_method(name) { attribs[name] }
+        end
+        
+      end
+    end
+  end
+end

data/lib/warden-oauthed/version.rb

@@ -0,0 +1,5 @@
+module Warden
+  module Oauthed
+    VERSION = '0.0.1'
+  end
+end

data/lib/warden-oauthed.rb

@@ -0,0 +1,14 @@
+require 'warden'
+require 'oauth2'
+require 'json'
+
+module Warden
+  module Oauthed
+    class OauthedMisconfiguredError < StandardError; end
+  end
+end
+
+require 'warden-oauthed/user'
+require 'warden-oauthed/proxy'
+require 'warden-oauthed/version'
+require 'warden-oauthed/strategy'

data/spec/app.rb

@@ -0,0 +1,64 @@
+require 'sinatra'
+
+module Example
+  class App < Sinatra::Base
+    enable  :sessions
+    enable  :raise_errors
+    disable :show_exceptions
+
+    use Warden::Manager do |manager|
+      manager.default_strategies :oauthed
+      manager.failure_app = BadAuthentication
+      manager[:oauthed_client_id]    = ENV['APPLICATION_CLIENT_ID']
+      manager[:oauthed_secret]       = ENV['APPLICATION_CLIENT_SECRET']
+      manager[:oauthed_scopes]       = ENV['APPLICATION_SCOPES_REQUESTED']
+      manager[:oauthed_oauth_domain] = ENV['OAUTH_BASE_URL']
+      manager[:oauthed_callback_url] = '/auth/oauthed/callback'
+    end
+
+    helpers do
+      def ensure_authenticated
+        unless env['warden'].authenticate!
+          throw(:warden)
+        end
+      end
+
+      def user
+        env['warden'].user
+      end
+    end
+
+    get '/' do
+      ensure_authenticated
+      "Hello There,\n<pre>#{user.token}</pre>"
+    end
+
+    get '/redirect_to' do
+      ensure_authenticated
+      "Hello There, #{user.name}! return_to is working!"
+    end
+
+    get '/auth/oauthed/callback' do
+      ensure_authenticated
+      redirect '/'
+    end
+
+    get '/logout' do
+      env['warden'].logout
+      "Peace!"
+    end
+  end
+
+  class BadAuthentication < Sinatra::Base
+    get '/unauthenticated' do
+      status 403
+      "Unable to authenticate, sorry bud."
+    end
+  end
+
+  def self.app
+    @app ||= Rack::Builder.new do
+      run App
+    end
+  end
+end

data/spec/oauth_spec.rb

@@ -0,0 +1,18 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe 'Warden::Oauthed' do
+  it 'requesting an url that requires authentication redirects to github' do
+    response = get '/'
+
+    uri = Addressable::URI.parse(response.headers['Location'])
+
+    uri.scheme.should eql('http')
+    uri.host.should eql('localhost')
+
+    params = uri.query_values
+    params['response_type'].should eql('code')
+    params['scope'].should eql('public')
+    params['client_id'].should match(/\w{20}/)
+    params['redirect_uri'].should eql('http://example.org/auth/oauthed/callback')
+  end
+end

data/spec/proxy_spec.rb

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe 'Warden::Oauthed::Oauth::Proxy' do
+  before(:all) do
+    sha = Digest::SHA1.hexdigest(Time.now.to_s)
+    @proxy =  Warden::Oauthed::Oauth::Proxy.new(sha[0..19], sha[0..39],
+      'public',
+      'http://localhost:3000',
+      'http://example.org/auth/oauthed/callback')
+  end
+
+  it 'returns an authorize url' do
+    uri = Addressable::URI.parse(@proxy.authorize_url)
+
+    uri.scheme.should eql('http')
+    uri.host.should eql('localhost')
+
+    params = uri.query_values
+    params['response_type'].should eql('code')
+    params['scope'].should eql('public')
+    params['client_id'].should match(/\w{20}/)
+    params['redirect_uri'].should eql('http://example.org/auth/oauthed/callback')
+  end
+
+  it "has a client object" do
+    @proxy.client.should_not be_nil
+  end
+
+  # it "returns access tokens" do
+  #  lambda { @proxy.access_token_for(/\w{20}/.gen) }.should_not raise_error  
+  # end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+Bundler.require(:default, :runtime, :test)
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'warden-oauthed')
+require File.join(File.dirname(__FILE__), 'app')
+require 'rack/test'
+require 'webrat'
+require 'addressable/uri'
+
+require 'pp'
+
+Webrat.configure do |config|
+  config.mode = :rack
+  config.application_port = 4567
+end
+
+RSpec.configure do |config|
+  config.include(Rack::Test::Methods)
+  config.include(Webrat::Methods)
+  config.include(Webrat::Matchers)
+
+  config.before(:each) do
+  end
+
+  def app
+    Example.app
+  end
+end

data/warden-oauthed.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'warden-oauthed/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'warden-oauthed'
+  s.version     = Warden::Oauthed::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['David Jaress', 'Seth Herr']
+  s.homepage    = 'https://github.com/Zensaburou/warden-oauthed'
+  s.summary     = 'A warden strategy for easy oauth integration with OAuth2 provided by Doorkeeper'
+  s.license     = 'MIT'
+  s.description = s.summary
+
+  s.add_dependency 'json',   '~>1.5'
+  s.add_dependency 'warden', '~>1.0'
+  s.add_dependency 'oauth2', '~>0.5.2'
+
+  s.add_development_dependency 'rack',      '~>1.6.0'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rerun'
+  s.add_development_dependency 'rspec',     '~>2.8.0'
+  s.add_development_dependency 'webrat'
+  s.add_development_dependency 'sinatra'
+  s.add_development_dependency 'shotgun'
+  s.add_development_dependency 'addressable', '~>2.2.0'
+  s.add_development_dependency 'rack-test',   '~>0.5.3'
+
+  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"]
+end

metadata

@@ -0,0 +1,236 @@
+--- !ruby/object:Gem::Specification
+name: warden-oauthed
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David Jaress
+- Seth Herr
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  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: warden
+  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: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rerun
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: webrat
+  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'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  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'
+- !ruby/object:Gem::Dependency
+  name: shotgun
+  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'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+description: A warden strategy for easy oauth integration with OAuth2 provided by
+  Doorkeeper
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- config.ru
+- lib/warden-oauthed.rb
+- lib/warden-oauthed/proxy.rb
+- lib/warden-oauthed/strategy.rb
+- lib/warden-oauthed/user.rb
+- lib/warden-oauthed/version.rb
+- spec/app.rb
+- spec/oauth_spec.rb
+- spec/proxy_spec.rb
+- spec/spec_helper.rb
+- warden-oauthed.gemspec
+homepage: https://github.com/Zensaburou/warden-oauthed
+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.8
+signing_key: 
+specification_version: 4
+summary: A warden strategy for easy oauth integration with OAuth2 provided by Doorkeeper
+test_files:
+- spec/app.rb
+- spec/oauth_spec.rb
+- spec/proxy_spec.rb
+- spec/spec_helper.rb