rails_sso 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6c8245291e6e960c35dfa2e46a034e44ba3ee1d0
+  data.tar.gz: acbd5d0746f35fcdb1e9bf0ff2ba727a00393d4c
+SHA512:
+  metadata.gz: 207514bc02f2ed7fbede366398fb45b79d76341b7173e92c78a937ddbb7b3afcf75d9a11d1020a5d6e470c05f06e77d74c7acf74a9492bc9a38ab458665fa4e3
+  data.tar.gz: 2326dd8b701d1797e3c970c6436d09c428c08cc60cf39c82f28c4928b3fe948d599ed8f469f52bec7682d94acf30d5bb192967833b8024724116a5eb169be568

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Jan Dudulski
+
+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,111 @@
+# SSO client Rails Engine
+
+## Installation
+
+Add engine and [omniauth](https://github.com/intridea/omniauth-oauth2) provider gems to your project:
+
+```ruby
+# Gemfile
+
+gem 'omniauth-example'
+gem 'rails_sso'
+```
+
+Configure it:
+
+```ruby
+# conifg/initializers/sso.rb
+
+RailsSso.configure do |config|
+  # name of oauth2 provider
+  config.provider_name = 'example'
+  # oauth keys for omniauth-example
+  config.provider_key = ENV['PROVIDER_KEY']
+  config.provider_secret = ENV['PROVIDER_SECRET']
+  # path for fetching user data
+  config.provider_profile_path = '/api/v1/profile'
+  # set if you support single sign out
+  config.provider_sign_out_path = '/api/v1/session'
+
+  # user fields to synchronize from API
+  config.user_fields = [
+    :email,
+    :name,
+    :roles
+  ]
+
+  # user repository class name
+  config.user_repository = 'UserRepository'
+end
+```
+
+And mount it:
+
+```ruby
+# config/routes.rb
+
+Rails.application.routes.draw do
+  mount RailsSso::Engine => '/sso', as: 'sso'
+end
+```
+
+## Usage
+
+Available helpers for controllers and views:
+
+* `current_user`
+* `user_signed_in?`
+
+Available filters for controllers:
+
+* `authenticate_user!`
+
+Available helpers for views:
+
+* `sso.sign_in_path`
+* `sso.sign_out_path`
+
+## User Repository
+
+Required methods:
+
+* `find_by({ key: value })`
+* `create_with_id(id, attrs)`
+* `update(record, attrs)`
+
+Example:
+
+```ruby
+# app/repositories/user_repository.rb
+
+class UserRepository
+  attr_accessor :adapter
+
+  def initialize(adapter = User)
+    self.adapter = adapter
+  end
+
+  def find_by(attrs)
+    adapter.find_by(attrs)
+  end
+
+  def create_with_id(id, attrs)
+    adapter.new(attrs) do |user|
+      user.id = id
+      user.save!
+    end
+  end
+
+  def update(record, attrs)
+    adapter.update(record.id, attrs)
+  end
+end
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,34 @@
+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    = 'RailsSso'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/controllers/rails_sso/sessions_controller.rb

@@ -0,0 +1,24 @@
+module RailsSso
+  class SessionsController < RailsSso.application_controller.constantize
+    skip_before_action :authenticate_user!, only: [:create]
+
+    def create
+      session[:access_token] = auth_hash.credentials.token
+      session[:refresh_token] = auth_hash.credentials.refresh_token
+
+      redirect_to root_path
+    end
+
+    def destroy
+      invalidate_user!
+
+      redirect_to root_path
+    end
+
+    protected
+
+    def auth_hash
+      request.env['omniauth.auth']
+    end
+  end
+end

data/config/initializers/omniauth.rb

@@ -0,0 +1,6 @@
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider RailsSso.provider_name,
+    RailsSso.provider_key,
+    RailsSso.provider_secret,
+    callback_path: RailsSso.provider_callback_path
+end

data/config/routes.rb

@@ -0,0 +1,8 @@
+RailsSso::Engine.routes.draw do
+  scope module: 'rails_sso' do
+    get '/:provider/callback', to: 'sessions#create'
+    delete '/sign_out', to: 'sessions#destroy', as: :sign_out
+
+    root to: redirect("/auth/#{RailsSso.provider_name}"), as: :sign_in
+  end
+end

data/lib/rails_sso/engine.rb

@@ -0,0 +1,9 @@
+module RailsSso
+  class Engine < Rails::Engine
+    initializer 'sso.helpers' do
+      ActiveSupport.on_load(:action_controller) do
+        include RailsSso::Helpers
+      end
+    end
+  end
+end

data/lib/rails_sso/fetch_user.rb

@@ -0,0 +1,45 @@
+module RailsSso
+  class FetchUser
+    def initialize(access_token, storage)
+      @access_token, @storage = access_token, storage
+    end
+
+    def get_and_cache
+      updater(get).call
+    end
+
+    private
+
+    attr_reader :access_token, :storage
+
+    def get(tries = 1)
+      access_token.get(RailsSso.provider_profile_path).parsed
+    rescue ::OAuth2::Error => e
+      if tries > 0
+        refresh_token!
+
+        get(0)
+      else
+        raise e
+      end
+    end
+
+    def updater(data)
+      RailsSso::UpdateUser.new(data, updater_options)
+    end
+
+    def updater_options
+      {
+        fields: RailsSso.user_fields,
+        repository: RailsSso.user_repository.new
+      }
+    end
+
+    def refresh_token!
+      @access_token = access_token.refresh!
+
+      storage[:access_token] = access_token.token
+      storage[:refresh_token] = access_token.refresh_token
+    end
+  end
+end

data/lib/rails_sso/helpers.rb

@@ -0,0 +1,57 @@
+module RailsSso
+  module Helpers
+    def self.included(base)
+      base.class_eval do
+        helper_method :current_user, :user_signed_in?
+      end
+    end
+
+    def current_user
+      @current_user ||= fetch_user
+    end
+
+    def user_signed_in?
+      !!current_user
+    end
+
+    def authenticate_user!
+      redirect_to sign_in_path unless user_signed_in?
+    end
+
+    def invalidate_user!
+      if RailsSso.provider_sign_out_path
+        access_token.delete(RailsSso.provider_sign_out_path)
+      end
+
+      reset_session
+    end
+
+    private
+
+    def fetch_user
+      return unless session[:access_token]
+
+      RailsSso::FetchUser.new(access_token, session).get_and_cache
+    rescue ::OAuth2::Error
+      nil
+    end
+
+    def access_token
+      OAuth2::AccessToken.new(oauth_client, session[:access_token], {
+        refresh_token: session[:refresh_token]
+      })
+    end
+
+    def oauth_client
+      oauth_strategy.client
+    end
+
+    def oauth_strategy
+      oauth_strategy_class.new(nil, RailsSso.provider_key, RailsSso.provider_secret)
+    end
+
+    def oauth_strategy_class
+      "OmniAuth::Strategies::#{RailsSso.provider_name.classify}".constantize
+    end
+  end
+end

data/lib/rails_sso/update_user.rb

@@ -0,0 +1,29 @@
+module RailsSso
+  class UpdateUser
+    def initialize(data, options = {})
+      @id, @data = data.delete('id'), data
+      @fields, @repository = options.values_at(:fields, :repository)
+    end
+
+    def call
+      if user = repository.find_by(id: id)
+        repository.update(user, params)
+        user
+      else
+        repository.create_with_id(id, params)
+      end
+    end
+
+    private
+
+    attr_reader :id, :data, :repository
+
+    def fields
+      @fields.map(&:to_s)
+    end
+
+    def params
+      data.slice(*fields)
+    end
+  end
+end

data/lib/rails_sso/version.rb

@@ -0,0 +1,3 @@
+module RailsSso
+  VERSION = "0.0.1"
+end

data/lib/rails_sso.rb

@@ -0,0 +1,34 @@
+module RailsSso
+  mattr_accessor :application_controller
+  @@application_controller = 'ApplicationController'
+
+  mattr_accessor :provider_name
+  mattr_accessor :provider_key
+  mattr_accessor :provider_secret
+
+  mattr_accessor :provider_profile_path
+  mattr_accessor :provider_sign_out_path
+
+  mattr_accessor :user_repository
+
+  mattr_accessor :user_fields
+  @@user_fields = [:email]
+
+  def self.configure
+    yield self
+  end
+
+  def self.user_repository
+    @@user_repository.constantize
+  end
+
+  def self.provider_callback_path
+    "/sso/#{self.provider_name}/callback"
+  end
+end
+
+require 'rails_sso/version'
+require 'rails_sso/engine'
+require 'rails_sso/helpers'
+require 'rails_sso/update_user'
+require 'rails_sso/fetch_user'

data/lib/tasks/rails_sso_tasks.rake

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

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/test/dummy/config/application.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "rails_sso"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,41 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end