techlahoma_auth 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0bd244067505003b209416f560249e723beac813
+  data.tar.gz: 679703eeda49d72355f91de45caced5b273c9319
+SHA512:
+  metadata.gz: 948c572dfded567b9ba05abbcd431c956345d3611aeb6e9a6396e2380d72a6799169651ea2b2823494acdb6d43a62af9f06869896c76daa3da60a29357ae4249
+  data.tar.gz: 172702a568d7844212b4449a7c44794387ab6995f3235f5f12b398ab36cf2d7d13e2b9e8a60120ced61c8f938b9184cfce8a5c46a1f042f819836a906bcfa83c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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,129 @@
+# TechlahomaAuth
+
+A Rails engine that makes it easy to delegate authentication for a Rails site to
+[Techlahoma](https://github.com/techlahoma/techlahomar).
+See the [Techlahoma Donations](https://github.com/techlahoma_donations)
+project for an example of using this gem.
+
+This is based on the SoAuth projects. See [http://www.octolabs.com/so-auth](http://www.octolabs.com/so-auth)
+for more details.
+
+Usage
+==============
+
+## Add `techlahoma_auth` to the `Gemfile`
+
+```ruby
+gem 'techlahoma_auth'
+```
+
+## Generate an initializer
+
+Run this command
+
+```bash
+rails generate techlahoma_auth:install
+```
+
+This will create the following files
+
+```
+config/initializers/omniauth.rb
+```
+
+## Create a new application in your `TechlahomaAuthProvider` instance
+
+Go to the `/oauth/applications` endpoint on the `Techlahoma`
+installation that you want to integrate with.  For development this will
+probably be `http://localhost:3000/oauth/applications`.
+
+Create a new application, and set the callback URL to
+`http://localhost:3001/auth/so/callback`. Change the port if you
+plan to run your client app on a different port. (See the optional
+section below.)
+
+After creating the app make note of the Application Id and the
+Secret.
+
+## Set some environment variables for your client
+
+In your new client project (where you installed this gem), you should
+set some environment variables.  Using something like `foreman` is
+probably the best so that you can just set them in a `.env` file.
+
+```
+AUTH_PROVIDER_URL=http://localhost:3000
+AUTH_PROVIDER_APPLICATION_ID=1234
+AUTH_PROVIDER_SECRET=5678
+AUTH_PROVIDER_ME_URL=/oauth/me.json
+```
+
+Be sure to use the Application Id you got in the last step as
+`AUTH_PROVIDER_APPLICATION_ID` and the Secret as `AUTH_PROVIDER_SECRET`.
+
+## Create a `User` model
+
+If you haven't already done it, you should create a `User` model
+
+```bash
+rails generate model user email:string
+```
+
+Then be sure to run migrations.
+
+```bash
+rake db:migrate; rake db:test:prepare
+```
+
+## Update `ApplicationController`
+
+Change your `ApplicationController` to inherit from
+`TechlahomaAuth::ApplicationController`. The first line should look like this.
+
+```ruby
+class ApplicationController < TechlahomaAuth::ApplicationController
+```
+
+## Protect some stuff in a controller
+
+Use a `before_filter` to protect some controller actions.
+
+```ruby
+before_filter :login_required
+```
+
+## OPTIONAL : Change the default port of your new project
+
+Since we're relying on `techlahoma_auth_provider` to provide authentication, we need
+to run our new project on a different port in development.  Open up `config/boot.rb`
+and add this to the bottom of the file.  If you want to use a port other
+than `3001` just change the port as appropriate.
+
+```ruby
+# Setting default port to 3001
+require 'rails/commands/server'
+module Rails
+  class Server
+    alias :default_options_alias :default_options
+    def default_options
+      default_options_alias.merge!(:Port => 3001)
+    end
+  end
+end
+```
+
+Or you could just run your development server on a different port:
+
+```
+rails s -p 3001
+```
+
+or
+
+```
+unicorn -p 3001 -c ./config/unicorn.rb
+```
+
+or whatever.
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,23 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TechlahomaAuth'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/controllers/techlahoma_auth/application_controller.rb

@@ -0,0 +1,66 @@
+module TechlahomaAuth
+  class ApplicationController < ActionController::Base
+
+    protect_from_forgery
+
+    before_filter :check_cookie
+    def check_cookie
+      if !cookie_valid?
+        session[:user_id] = nil
+      end
+    end
+
+    def cookie_valid?
+      cookies[:so_auth].present? && session[:user_id].present? && cookies[:so_auth].to_s == session[:user_id].to_s
+    end
+
+    def login_required
+      if !current_user
+        not_authorized
+      end
+    end
+
+    def not_authorized
+      respond_to do |format|
+        format.html{ auth_redirect }
+        format.json{ head :unauthorized }
+      end
+    end
+
+    def auth_redirect
+      observable_redirect_to "/auth/so?origin=#{request.protocol}#{request.host_with_port}#{request.fullpath}"
+    end
+
+    def current_user
+      return nil unless session[:user_id]
+      @current_user ||= User.find_by_id(session[:user_id])
+    end
+
+    def signed_in?
+      current_user.present?
+    end
+
+    helper_method :signed_in?
+    helper_method :current_user
+
+
+
+
+    private
+
+    # These two methods help with testing
+    def integration_test?
+      Rails.env.test? && defined?(Cucumber::Rails)
+    end
+
+    def observable_redirect_to(url)
+      if integration_test?
+        render :text => "If this wasn't an integration test, you'd be redirected to: #{url}"
+      else
+        redirect_to url
+      end
+    end
+
+  end
+end
+

data/app/controllers/techlahoma_auth/user_sessions_controller.rb

@@ -0,0 +1,40 @@
+class TechlahomaAuth::UserSessionsController < TechlahomaAuth::ApplicationController
+  before_filter :login_required, :only => [ :destroy ]
+
+  respond_to :html
+
+  # omniauth callback method
+  def create
+    omniauth = env['omniauth.auth']
+
+    user = User.find_by_id(omniauth['uid'])
+    if not user
+      # New user registration
+      user = User.new
+      user.id = omniauth['uid']
+    end
+    user.email = omniauth['info']['email'] if user.respond_to?(:email)
+    user.save
+
+    session[:user_id] = user.id
+
+    flash[:notice] = "Successfully logged in"
+    redirect_to request.env['omniauth.origin'] || root_path
+  end
+
+  # Omniauth failure callback
+  def failure
+    flash[:notice] = params[:message]
+    redirect_to root_path
+  end
+
+  # logout - Clear our rack session BUT essentially redirect to the provider
+  # to clean up the Devise session from there too !
+  def destroy
+    reset_session
+    flash[:notice] = 'You have successfully signed out!'
+    redirect_to "#{ENV['AUTH_PROVIDER_URL']}/users/sign_out"
+  end
+
+end
+

data/config/cucumber.yml

@@ -0,0 +1,8 @@
+<%
+rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
+rerun_opts = rerun.to_s.strip.empty? ? "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}"
+std_opts = "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} --strict --tags ~@wip"
+%>
+default: <%= std_opts %> features
+wip: --tags @wip:3 --wip features
+rerun: <%= rerun_opts %> --format rerun --out rerun.txt --strict --tags ~@wip

data/config/routes.rb

@@ -0,0 +1,8 @@
+Rails.application.routes.draw do
+  # omniauth
+  get '/auth/:provider/callback', :to => 'techlahoma_auth/user_sessions#create'
+  get '/auth/failure', :to => 'techlahoma_auth/user_sessions#failure'
+
+  # Custom logout
+  post '/logout', :to => 'techlahoma_auth/user_sessions#destroy'
+end

data/lib/generators/techlahoma_auth/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generate config and initializer for a client of TechlahomaAuthProvider.
+
+Example:
+    rails generate so_auth:install
+
+    This will create:
+        config/initializers/omniauth.rb

data/lib/generators/techlahoma_auth/install/install_generator.rb

@@ -0,0 +1,8 @@
+class TechlahomaAuth::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def copy_initializer_file
+    copy_file "omniauth.rb", "config/initializers/omniauth.rb"
+  end
+
+end

data/lib/generators/techlahoma_auth/install/templates/omniauth.rb

@@ -0,0 +1,8 @@
+# If you need to pull the app_id and app_secret from a different spot
+# this is the place to do it
+APP_ID = ENV['AUTH_PROVIDER_APPLICATION_ID'] || "not_a_real_id"
+APP_SECRET = ENV['AUTH_PROVIDER_SECRET'] || "not_a_real_secret"
+
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :so, APP_ID, APP_SECRET
+end

data/lib/omniauth/strategies/so.rb

@@ -0,0 +1,41 @@
+require 'omniauth-oauth2'
+module OmniAuth
+  module Strategies
+    class So < OmniAuth::Strategies::OAuth2
+
+      CUSTOM_PROVIDER_URL = ENV['AUTH_PROVIDER_URL'] || "http://custom-provider-goes-here"
+      CUSTOM_PROVIDER_ME_URL = ENV['AUTH_PROVIDER_ME_URL'] || "/oauth/me.json"
+
+      option :client_options, {
+        :site =>  CUSTOM_PROVIDER_URL,
+        :authorize_url => "#{CUSTOM_PROVIDER_URL}/oauth/authorize",
+        :access_token_url => "#{CUSTOM_PROVIDER_URL}/oauth/token"
+      }
+
+      uid {
+        raw_info['id'] 
+      }
+
+      info do
+        {
+          :email => raw_info['email'],
+          :admin => raw_info['admin']
+        }
+      end
+
+      extra do
+        {
+          #:current_sign_in_at => raw_info['extra']['current_sign_in_at'],
+          #:name => raw_info['extra']['name']
+          #:first_name => raw_info['extra']['first_name'],
+          #:last_name  => raw_info['extra']['last_name']
+        }
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get(CUSTOM_PROVIDER_ME_URL).parsed
+      end
+    end
+  end
+end
+

data/lib/tasks/cucumber.rake

@@ -0,0 +1,65 @@
+# IMPORTANT: This file is generated by cucumber-rails - edit at your own peril.
+# It is recommended to regenerate this file in the future when you upgrade to a
+# newer version of cucumber-rails. Consider adding your own code to a new file
+# instead of editing this one. Cucumber will automatically load all features/**/*.rb
+# files.
+
+
+unless ARGV.any? {|a| a =~ /^gems/} # Don't load anything when running the gems:* tasks
+
+vendored_cucumber_bin = Dir["#{Rails.root}/vendor/{gems,plugins}/cucumber*/bin/cucumber"].first
+$LOAD_PATH.unshift(File.dirname(vendored_cucumber_bin) + '/../lib') unless vendored_cucumber_bin.nil?
+
+begin
+  require 'cucumber/rake/task'
+
+  namespace :cucumber do
+    Cucumber::Rake::Task.new({:ok => 'test:prepare'}, 'Run features that should pass') do |t|
+      t.binary = vendored_cucumber_bin # If nil, the gem's binary is used.
+      t.fork = true # You may get faster startup if you set this to false
+      t.profile = 'default'
+    end
+
+    Cucumber::Rake::Task.new({:wip => 'test:prepare'}, 'Run features that are being worked on') do |t|
+      t.binary = vendored_cucumber_bin
+      t.fork = true # You may get faster startup if you set this to false
+      t.profile = 'wip'
+    end
+
+    Cucumber::Rake::Task.new({:rerun => 'test:prepare'}, 'Record failing features and run only them if any exist') do |t|
+      t.binary = vendored_cucumber_bin
+      t.fork = true # You may get faster startup if you set this to false
+      t.profile = 'rerun'
+    end
+
+    desc 'Run all features'
+    task :all => [:ok, :wip]
+
+    task :statsetup do
+      require 'rails/code_statistics'
+      ::STATS_DIRECTORIES << %w(Cucumber\ features features) if File.exist?('features')
+      ::CodeStatistics::TEST_TYPES << "Cucumber features" if File.exist?('features')
+    end
+  end
+  desc 'Alias for cucumber:ok'
+  task :cucumber => 'cucumber:ok'
+
+  task :default => :cucumber
+
+  task :features => :cucumber do
+    STDERR.puts "*** The 'features' task is deprecated. See rake -T cucumber ***"
+  end
+
+  # In case we don't have the generic Rails test:prepare hook, append a no-op task that we can depend upon.
+  task 'test:prepare' do
+  end
+
+  task :stats => 'cucumber:statsetup'
+rescue LoadError
+  desc 'cucumber rake task not available (cucumber not installed)'
+  task :cucumber do
+    abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
+  end
+end
+
+end

data/lib/tasks/techlahoma_auth_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :techlahoma_auth do
+#   # Task goes here
+# end

data/lib/techlahoma_auth/engine.rb

@@ -0,0 +1,4 @@
+module TechlahomaAuth
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/techlahoma_auth/version.rb

@@ -0,0 +1,3 @@
+module TechlahomaAuth
+  VERSION = "0.0.2"
+end

data/lib/techlahoma_auth.rb

@@ -0,0 +1,6 @@
+require "techlahoma_auth/engine"
+require 'omniauth-oauth2'
+require 'omniauth/strategies/so'
+
+module TechlahomaAuth
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: techlahoma_auth
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Jeremy Green
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.4
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.2
+- !ruby/object:Gem::Dependency
+  name: cucumber-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+description: A gem that allows a Rails app to be an client of TechlahomaAuthProvider.
+email:
+- jeremy@octolabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/techlahoma_auth/application_controller.rb
+- app/controllers/techlahoma_auth/user_sessions_controller.rb
+- config/cucumber.yml
+- config/routes.rb
+- lib/generators/techlahoma_auth/install/USAGE
+- lib/generators/techlahoma_auth/install/install_generator.rb
+- lib/generators/techlahoma_auth/install/templates/omniauth.rb
+- lib/omniauth/strategies/so.rb
+- lib/tasks/cucumber.rake
+- lib/tasks/techlahoma_auth_tasks.rake
+- lib/techlahoma_auth.rb
+- lib/techlahoma_auth/engine.rb
+- lib/techlahoma_auth/version.rb
+homepage: https://github.com/jagthedrummer/techlahoma_auth
+licenses: []
+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.1
+signing_key: 
+specification_version: 4
+summary: A gem that allows a Rails app to be an client of TechlahomaAuthProvider.
+test_files: []