sinatra_auth_oauthed 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 353b360d0464204e9c6dff56f78882898bdcc30d
+  data.tar.gz: ba37ca3332426e2afe16f4dc8f86e15a98a7a411
+SHA512:
+  metadata.gz: cd95a837e02574e1ec23a2d9996772a6226ca5e9a673e779356d4cc51c653a054e0eb26a2380ac8e84b196f721896add1dacba15fdea4b577db30733c8909e52
+  data.tar.gz: b433beb0a42b3edbe59d4663d99e7ba3b06459d097b940a20ee3243c12905eb51dd09488ca987f9dd280e0470b24398e95bd884f0ac23cdbc4b38b6b1b105482

data/.gitignore

@@ -0,0 +1,15 @@
+coverage
+.bundle
+pkg
+.DS_Store
+Gemfile.lock
+vendor/gems
+*.gem
+.rbenv-version
+bin/
+tags
+.ruby-*
+.sass-cache
+*.swp
+*.swo
+.ruby-*

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Documentation:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+ruby '2.2.2'
+
+gemspec

data/Guardfile

@@ -0,0 +1,11 @@
+group :red_green_refactor, halt_on_fail: true do
+  guard :rspec, cmd: 'bundle exec rspec' do
+    watch(%r{^spec/.+_spec\.rb$})
+    watch(%r{^config/(.+)\.rb$}) { |m| "spec/#{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 Seth Herr
+
+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,65 @@
+### A [Sinatra](http://www.sinatrarb.com/) template for [Grape-Doorkeep applications](https://github.com/sethherr/grape-doorkeeper)
+
+A template application for building mini web sites/services authenticated with OAuth2.
+
+- No database required
+- [warden-oauth](https://github.com/Zensaburou/warden-oauthed) for authentication
+- [Includes rails assets for bower package management](#rails-assets)
+
+[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)
+
+## Using it:
+
+1. Fork or clone this repository
+2. Update the values in [.env](.env) with [your values](#env-values)
+3. Go to the directory this is contained in the terminal
+4. Use `rerun rackup` to start the server 
+5. The above command will print out something like `WEBrick::HTTPServer#start: pid=62447 port=9292`. Go to localhost:{that_port_number} - e.g. [http://localhost:9292](http://localhost:9292). 
+6. Go there to the above url to see the app! :sparkles:
+
+## Env Values
+
+The `.env` file references the app you are using. You will need to create an app on the provider you're using.
+
+The callback url for this sinatra template is `localhost:9292/auth/oauthed/callback` - change localhost:9292 to reflect your local conditions - e.g., if you're running on a different port, or if you deploy this to something with a domain name. You will have to add this to the application on the provider.
+
+After you've created an application on the provider, add the client id and the client secret of it to the `.env` file.
+
+For the `APPLICATION_SCOPES_REQUESTED`, separate scopes with whitespace
+For `USER_ATTRIBUTES`, separate values with whitespace
+
+## Directories / files
+
+*The directory structure of this app is set up to loosely resemble rails*
+
+- `assets`
+  - javascript, coffeescript, css, scss - compiled, minified, concatenated.
+- `views`
+  - haml, erb or html files. `layout.haml` is the layout file that wraps everything else up.
+- `public` 
+  - files in here are served directly from the base url
+- `config/routes.rb`
+  - the routes for the app
+
+
+## Rails Assets
+
+This template includes [rails-assets](https://rails-assets.org/), which makes it easy to use [bower](http://bower.io/) packages.
+
+**View [the list of bower packages](http://bower.io/search/)** 
+
+Add bower packages to the Gemfile by putting them in the Bower packages block in this format:
+
+    gem 'rails-assets-BOWER_PACKAGE_NAME'`.
+
+Since Javascript packages change quickly, it's a particularly good idea to lock the packages with a loose version after you `bundle install`. e.g. for the jQuery version currently installed,
+
+    `gem 'rails-assets-jquery', '~> 2.1.4'`
+
+*(which means >= 2.1.4 and < 2.2.0).*
+
+So you can safely update your packages with `bundle update`
+
+=======
+
+Many thanks to [sinatra_auth_github](https://github.com/atmos/sinatra_auth_github) :shipit: from which this draws inspiration.

data/Rakefile

@@ -0,0 +1,8 @@
+task default: [:spec]
+require 'rspec/core/rake_task'
+require 'dotenv/tasks'
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end

data/config.ru

@@ -0,0 +1,9 @@
+ENV['RACK_ENV'] ||= 'development'
+require 'bundler'
+require 'bundler/setup'
+
+$LOAD_PATH << File.dirname(__FILE__) + '/lib'
+require File.expand_path(File.join(File.dirname(__FILE__), 'lib', 'sinatra_auth_oauthed'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec', 'app'))
+
+run Example::App

data/lib/sinatra/auth/oauthed.rb

@@ -0,0 +1,111 @@
+require 'sinatra/base'
+require 'warden-oauthed'
+
+module Sinatra
+  module Auth
+    module Oauthed
+      class BadAuthentication < Sinatra::Base
+        enable :raise_errors
+        disable :show_exceptions
+
+        helpers do
+          def unauthorized_template
+            @unauthenticated_template ||= File.read(File.join(File.dirname(__FILE__), 'views', '401.html'))
+          end
+        end
+
+        get '/unauthenticated' do
+          status 403
+          unauthorized_template
+        end
+      end
+
+      module Helpers
+        def warden
+          env['warden']
+        end
+
+        def authenticate!(*args)
+          warden.authenticate!(*args)
+        end
+
+        def authenticated?(*args)
+          warden.authenticated?(*args)
+        end
+
+        def logout!
+          warden.logout
+        end
+
+        # The authenticated user object
+        def oauthed_user
+          warden.user
+        end
+
+        # Send a API GET request to the path defined in .env
+        #
+        # path - the path on api.github.com to hit
+        #
+        # Returns a rest client response object
+        #
+        # Examples
+        #   oauthed_raw_request("/user")
+        #   # => RestClient::Response
+        def oauthed_raw_request(path)
+          oauthed_user.oauthed_raw_request(path)
+        end
+
+        # Send a API GET request to the path defined in .env and parse the response body
+        #
+        # path - the path on api.github.com to hit
+        #
+        # Returns a parsed JSON response
+        #
+        # Examples
+        #   oauthed_request("/user")
+        #   # => { 'login' => 'atmos', ... }
+        def oauthed_request(path)
+          oauthed_user.oauthed_request(path)
+        end
+
+        def _relative_url_for(path)
+          request.script_name + path
+        end
+      end
+
+      def self.registered(app)
+        app.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
+
+        # Sign cookie sessions in with AS::Verifier
+        ENV['WARDEN_OAUTHED_VERIFIER_SECRET'] ||= ENV['OAUTHED_VERIFIER_SECRET']
+
+        unless ENV['WARDEN_OAUTHED_VERIFIER_SECRET']
+          warn 'No WARDEN_OAUTHED_VERIFIER_SECRET environmental variable found.'
+          warn 'Your sessions are likely being stored insecurely.'
+        end
+
+        app.helpers Helpers
+
+        app.get '/auth/oauthed/callback' do
+          if params['error']
+            redirect '/unauthenticated'
+          else
+            authenticate!
+            redirect '/'
+            return_to = session.delete('return_to') || _relative_url_for('/')
+            redirect return_to
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sinatra/auth/oauthed/version.rb

@@ -0,0 +1,7 @@
+module Sinatra
+  module Auth
+    module Oauthed
+      VERSION = '0.0.1'
+    end
+  end
+end

data/lib/sinatra/auth/oauthed/views/401.html

@@ -0,0 +1 @@
+<html>YOU CAN't HAVES permission </html>

data/lib/sinatra_auth_oauthed.rb

@@ -0,0 +1 @@
+require 'sinatra/auth/oauthed'

data/sinatra_auth_oauthed.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'sinatra/auth/oauthed/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'sinatra_auth_oauthed'
+  s.version     = Sinatra::Auth::Oauthed::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Seth Herr', 'David Jaress']
+  s.homepage    = 'http://github.com/zensaburou/sinatra_auth_oauthed'
+  s.summary     = 'A sinatra extension for easy oauth integration with oauth providers'
+  s.license     = 'MIT'
+  s.description = s.summary
+
+  s.add_dependency 'sinatra', '~>1.0'
+  s.add_dependency 'warden-oauthed', '~>0.0.0'
+
+  s.add_development_dependency 'rake', '~> 10.4', '>=10.4.2'
+  s.add_development_dependency 'rspec', '~>2.4', '>=2.4.0'
+  s.add_development_dependency 'shotgun', '~> 0.9', '>=0.9.1'
+  s.add_development_dependency 'randexp', '~>0.1.5'
+  s.add_development_dependency 'rack-test', '~>0.5.3'
+  s.add_development_dependency 'addressable', '~>2.3', '>=2.3.8'
+
+  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

data/spec/app.rb

@@ -0,0 +1,17 @@
+module Example
+  class App < Sinatra::Base
+    enable :sessions
+    register Sinatra::Auth::Oauthed
+
+    get '/logout' do
+      logout!
+      'Peace!'
+    end
+
+    get '/' do
+      authenticate!
+      @user = oauthed_user
+      "authenticated: #{@user.email}"
+    end
+  end
+end

data/spec/app_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Example::App do
+  def app
+    @app ||= Example::App
+  end
+
+  describe "GET '/'" do
+    it 'redirects to redirect uri when requesting a url requiring authentication' do
+      response = get '/'
+
+      uri = Addressable::URI.parse(response.headers['Location'])
+
+      uri.scheme.should eql('http')
+      uri.host.should eql('localhost')
+
+      params = uri.query_values
+      expect(params['response_type']).to eq 'code'
+      expect(params['scope']).to eq 'public'
+      expect(params['client_id']).to match(/\w{20}/)
+      expect(params['redirect_uri']).to eq 'http://example.org/auth/oauthed/callback'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+ENV['APPLICATION_CLIENT_ID'] = 'dddc188f84e348ddae69f17dd63e758ded4cc24abed435a53db9525db2cd7af45f0'
+ENV['APPLICATION_CLIENT_SECRET'] = 'e35b8e02901a3ca1b5b1e0c4cf3e1e6dbd1855de4684bd95175721428816ae96'
+ENV['APPLICATION_SCOPES_REQUESTED'] = 'public'
+ENV['OAUTH_BASE_URL'] = 'http://localhost:3000'
+ENV['OAUTHED_VERIFIER_SECRET'] = 'MyStu9GTLJX7vhF0LKQ9dQ-cjjTwMFWTkHV6VqE7ipBpwdwwamVdJx1AXkCuOu4g'
+ENV['USER_ATTRIBUTES'] = 'id full_name email'
+ENV['RACK_ENV'] = 'test'
+
+require 'bundler'
+require 'rubygems' unless defined?(Gem)
+Bundler.require(:default, ENV['RACK_ENV'].to_sym)
+require 'addressable/uri'
+require 'pp'
+require 'rack/test'
+require 'sinatra/auth/oauthed'
+require 'app'
+
+RSpec.configure do |conf|
+  conf.include Rack::Test::Methods
+end

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: sinatra_auth_oauthed
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Seth Herr
+- David Jaress
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  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: warden-oauthed
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: shotgun
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: randexp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+- !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
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.8
+description: A sinatra extension for easy oauth integration with oauth providers
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- config.ru
+- lib/sinatra/auth/oauthed.rb
+- lib/sinatra/auth/oauthed/version.rb
+- lib/sinatra/auth/oauthed/views/401.html
+- lib/sinatra_auth_oauthed.rb
+- sinatra_auth_oauthed.gemspec
+- spec/app.rb
+- spec/app_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/zensaburou/sinatra_auth_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 sinatra extension for easy oauth integration with oauth providers
+test_files:
+- spec/app.rb
+- spec/app_spec.rb
+- spec/spec_helper.rb