rails_sso 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c8245291e6e960c35dfa2e46a034e44ba3ee1d0
-  data.tar.gz: acbd5d0746f35fcdb1e9bf0ff2ba727a00393d4c
+  metadata.gz: 5d21cea945bc44cb3fb84f1d2da048091d6f4661
+  data.tar.gz: 9f4bef5ac2353b226593a063a301cad4f618818a
 SHA512:
-  metadata.gz: 207514bc02f2ed7fbede366398fb45b79d76341b7173e92c78a937ddbb7b3afcf75d9a11d1020a5d6e470c05f06e77d74c7acf74a9492bc9a38ab458665fa4e3
-  data.tar.gz: 2326dd8b701d1797e3c970c6436d09c428c08cc60cf39c82f28c4928b3fe948d599ed8f469f52bec7682d94acf30d5bb192967833b8024724116a5eb169be568
+  metadata.gz: 8a2dd465782b4e9372594fbfd531edf0d769f0f285fbf663e8e2855ad12c348cfb0e8614ba75dc573b8d0fcd622ff0f7946efcc6e0b306cd24db7f56c26b9799
+  data.tar.gz: 8efb688b7383bcb5aa783e610d94317ecd22fb7aa5f514d829da0cde7836f76ed3a42a5567a17a88516fb38b96314ace659d81bd829eec0e514c49c8691e694f

data/README.md

@@ -1,5 +1,12 @@
 # SSO client Rails Engine
 
+[![Dependency Status](https://gemnasium.com/monterail/rails_sso.svg)](https://gemnasium.com/monterail/rails_sso)
+[![Gem Version](https://badge.fury.io/rb/rails_sso.svg)](http://badge.fury.io/rb/rails_sso)
+
+## About
+
+*SOON*
+
 ## Installation
 
 Add engine and [omniauth](https://github.com/intridea/omniauth-oauth2) provider gems to your project:
@@ -26,6 +33,8 @@ RailsSso.configure do |config|
   config.provider_profile_path = '/api/v1/profile'
   # set if you support single sign out
   config.provider_sign_out_path = '/api/v1/session'
+  # enable cache (will use Rails.cache store)
+  config.use_cache = Rails.application.config.action_controller.perform_caching
 
   # user fields to synchronize from API
   config.user_fields = [
@@ -56,9 +65,11 @@ Available helpers for controllers and views:
 * `current_user`
 * `user_signed_in?`
 
-Available filters for controllers:
+Available filters and helpers for controllers:
 
 * `authenticate_user!`
+* `save_access_token!`
+* `invalidate_access_token!`
 
 Available helpers for views:
 
@@ -69,11 +80,11 @@ Available helpers for views:
 
 Required methods:
 
-* `find_by({ key: value })`
-* `create_with_id(id, attrs)`
+* `find_by_sso_id(id)`
+* `create_with_sso_id(id, attrs)`
 * `update(record, attrs)`
 
-Example:
+Example with `ActiveRecord` user model:
 
 ```ruby
 # app/repositories/user_repository.rb
@@ -85,13 +96,13 @@ class UserRepository
     self.adapter = adapter
   end
 
-  def find_by(attrs)
-    adapter.find_by(attrs)
+  def find_by_sso_id(id)
+    adapter.find_by(sso_id: id)
   end
 
-  def create_with_id(id, attrs)
+  def create_with_sso_id(id, attrs)
     adapter.new(attrs) do |user|
-      user.id = id
+      user.sso_id = id
       user.save!
     end
   end

data/Rakefile

@@ -4,21 +4,6 @@ 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'

data/app/controllers/rails_sso/sessions_controller.rb

@@ -3,14 +3,13 @@ module RailsSso
     skip_before_action :authenticate_user!, only: [:create]
 
     def create
-      session[:access_token] = auth_hash.credentials.token
-      session[:refresh_token] = auth_hash.credentials.refresh_token
+      save_access_token!(auth_hash.credentials)
 
       redirect_to root_path
     end
 
     def destroy
-      invalidate_user!
+      invalidate_access_token!
 
       redirect_to root_path
     end

data/app/services/rails_sso/fetch_user.rb

@@ -0,0 +1,19 @@
+module RailsSso
+  class FetchUser
+    def initialize(access_token)
+      @access_token = access_token
+    end
+
+    def call
+      yield(get)
+    end
+
+    private
+
+    attr_reader :access_token
+
+    def get
+      access_token.get(RailsSso.provider_profile_path).parsed
+    end
+  end
+end

data/{lib → app/services}/rails_sso/update_user.rb

@@ -1,16 +1,16 @@
 module RailsSso
   class UpdateUser
     def initialize(data, options = {})
-      @id, @data = data.delete('id'), data
+      @id, @data = data['id'], data.except('id')
       @fields, @repository = options.values_at(:fields, :repository)
     end
 
     def call
-      if user = repository.find_by(id: id)
+      if user = repository.find_by_sso_id(id)
         repository.update(user, params)
         user
       else
-        repository.create_with_id(id, params)
+        repository.create_with_sso_id(id, params)
       end
     end
 

data/lib/rails_sso/access_token.rb

@@ -0,0 +1,52 @@
+require 'faraday-http-cache'
+
+module RailsSso
+  class AccessToken
+    attr_reader :token, :refresh_token
+
+    delegate :get, :patch, :post, :put, :delete, to: :access_token
+
+    def self.from_access_token(access_token)
+      new(access_token.token, access_token.refresh_token)
+    end
+
+    def initialize(token, refresh_token)
+      @token, @refresh_token = token, refresh_token
+    end
+
+    def refresh!
+      self.class.from_access_token(access_token.refresh!)
+    end
+
+    def access_token
+      @access_token ||= OAuth2::AccessToken.new(client, token, {
+        refresh_token: refresh_token
+      })
+    end
+
+    private
+
+    def client
+      strategy.client.tap do |c|
+        if RailsSso.use_cache
+          c.options[:connection_build] = Proc.new do |conn|
+            conn.use :http_cache,
+              store: Rails.cache,
+              logger: Rails.logger,
+              shared_cache: false
+
+            conn.adapter Faraday.default_adapter
+          end
+        end
+      end
+    end
+
+    def strategy
+      @strategy ||= strategy_class.new(nil, RailsSso.provider_key, RailsSso.provider_secret)
+    end
+
+    def strategy_class
+      "OmniAuth::Strategies::#{RailsSso.provider_name.classify}".constantize
+    end
+  end
+end

data/lib/rails_sso/helpers.rb

@@ -7,7 +7,9 @@ module RailsSso
     end
 
     def current_user
-      @current_user ||= fetch_user
+      @current_user ||= fetch_user do |user|
+        update_user(user).call
+      end
     end
 
     def user_signed_in?
@@ -18,7 +20,11 @@ module RailsSso
       redirect_to sign_in_path unless user_signed_in?
     end
 
-    def invalidate_user!
+    def access_token
+      RailsSso::AccessToken.new(session[:access_token], session[:refresh_token])
+    end
+
+    def invalidate_access_token!
       if RailsSso.provider_sign_out_path
         access_token.delete(RailsSso.provider_sign_out_path)
       end
@@ -26,32 +32,40 @@ module RailsSso
       reset_session
     end
 
-    private
+    def save_access_token!(access_token)
+      session[:access_token] = access_token.token
+      session[:refresh_token] = access_token.refresh_token
+    end
 
-    def fetch_user
-      return unless session[:access_token]
+    def refresh_access_token!
+      save_access_token!(access_token.refresh!)
 
-      RailsSso::FetchUser.new(access_token, session).get_and_cache
+      yield if block_given?
     rescue ::OAuth2::Error
       nil
     end
 
-    def access_token
-      OAuth2::AccessToken.new(oauth_client, session[:access_token], {
-        refresh_token: session[:refresh_token]
-      })
-    end
+    private
 
-    def oauth_client
-      oauth_strategy.client
+    def fetch_user(&block)
+      return unless session[:access_token]
+
+      RailsSso::FetchUser.new(access_token).call(&block)
+    rescue ::OAuth2::Error
+      refresh_access_token! do
+        RailsSso::FetchUser.new(access_token).call(&block)
+      end
     end
 
-    def oauth_strategy
-      oauth_strategy_class.new(nil, RailsSso.provider_key, RailsSso.provider_secret)
+    def update_user(data)
+      RailsSso::UpdateUser.new(data, update_user_options).call
     end
 
-    def oauth_strategy_class
-      "OmniAuth::Strategies::#{RailsSso.provider_name.classify}".constantize
+    def update_user_options
+      {
+        fields: RailsSso.user_fields,
+        repository: RailsSso.user_repository.new
+      }
     end
   end
 end

data/lib/rails_sso/version.rb

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

data/lib/rails_sso.rb

@@ -14,6 +14,9 @@ module RailsSso
   mattr_accessor :user_fields
   @@user_fields = [:email]
 
+  mattr_accessor :use_cache
+  @@use_cache = false
+
   def self.configure
     yield self
   end
@@ -27,8 +30,8 @@ module RailsSso
   end
 end
 
+require 'omniauth-oauth2'
 require 'rails_sso/version'
 require 'rails_sso/engine'
 require 'rails_sso/helpers'
-require 'rails_sso/update_user'
-require 'rails_sso/fetch_user'
+require 'rails_sso/access_token'

data/test/controllers/rails_sso/sessions_controller_test.rb

@@ -0,0 +1,43 @@
+require 'test_helper'
+
+class RailsSso::SessionsControllerTest < ActionController::TestCase
+  def setup
+    @routes = RailsSso::Engine.routes
+
+    @auth_hash = OmniAuth::AuthHash.new({
+      provider: 'developer',
+      uid: '1',
+      name: 'Kowalski',
+      email: 'jan@kowalski.pl',
+      key: 'value'
+    })
+
+    OmniAuth.config.mock_auth[:developer] = @auth_hash
+
+    request.env['omniauth.auth'] = OmniAuth.config.mock_auth[:developer]
+  end
+
+  def teardown
+    OmniAuth.config.mock_auth[:developer] = nil
+  end
+
+  test 'create should save access token and  redirect to root path' do
+    @controller.expects(:save_access_token!).with(@auth_hash.credentials).once
+
+    get :create, { provider: 'developer' }
+
+    assert_redirected_to main_app.root_path
+  end
+
+  test 'destroy should invalidate access token and redirect to root path' do
+    @controller.expects(:invalidate_access_token!).once
+
+    delete :destroy, {}, { access_token: 'abc', refresh_token: 'def' }
+
+    assert_redirected_to main_app.root_path
+  end
+
+  def main_app
+    Rails.application.class.routes.url_helpers
+  end
+end

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

@@ -2,4 +2,8 @@ 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
+
+  def index
+    render text: 'Hello'
+  end
 end

data/test/dummy/config/initializers/sso.rb

@@ -0,0 +1,13 @@
+RailsSso.configure do |config|
+  config.provider_name = 'developer'
+  config.provider_key = 'key'
+  config.provider_secret = 'secret'
+  config.provider_profile_path = '/api/v1/me'
+  config.provider_sign_out_path = '/api/v1/me'
+  config.use_cache = false
+  config.user_fields = [
+    :email,
+    :name
+  ]
+  config.user_repository = 'UserRepository'
+end

data/test/dummy/config/routes.rb

@@ -1,4 +1,5 @@
 Rails.application.routes.draw do
+  mount RailsSso::Engine => '/sso', as: 'sso'
   # The priority is based upon order of creation: first created -> highest priority.
   # See how all your routes lay out with "rake routes".
 
@@ -53,4 +54,5 @@ Rails.application.routes.draw do
   #     # (app/controllers/admin/products_controller.rb)
   #     resources :products
   #   end
+  root to: 'application#index'
 end