rails_sso 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4d48903a72cbc4b17e174fc2c9d9086d62e5787
-  data.tar.gz: cd2858884d2731c62463f479d632d69732f745ff
+  metadata.gz: 870097ffd20610b11d2b2818e02be874f32f7a6b
+  data.tar.gz: 0d13485c9589191716ae0f067ecfebfdd8a6785e
 SHA512:
-  metadata.gz: 635bfda00322076a73614662f89e7b5a40f557988ba1bddbe8de47cab90ac22f3b929ed36e6c991e6848f7466be6e871ab13b7e76aa309e6c251c4a0fb62f18b
-  data.tar.gz: c2c3973789ff1a34cabadf07c3edf2778e0fc45560e4ec7f7fb8a8b5f4a8d3e22d478acf23b61f20531c8eefa787baa9e0c0a4c0f5476c82d9cab600c71fc448
+  metadata.gz: 9d06d4ed43b361abc3d727f5673c55f7cbcf94858993d5b3a9f349b63191fcddc7a509ca6ad1be8270c2adef37f164e1a326ae27bc29c2291061bce8f39cd590
+  data.tar.gz: 5c9b79893b2475cad864fa469b23205327b36c0601a1ff2515d1d0992042f58c6ec4c8a5bc7ff3537a68ded052a3d1992b66bf375204939f98723cc2266bee0f

data/README.md

@@ -1,7 +1,10 @@
 # SSO client Rails Engine
 
+[![Circle CI](https://circleci.com/gh/monterail/rails_sso/tree/master.svg?style=shield&circle-token=237c44548fb2c2597bcd0bc7b1dd99c81329e574)](https://circleci.com/gh/monterail/rails_sso/tree/master)
 [![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)
+[![Code Climate](https://codeclimate.com/github/monterail/rails_sso/badges/gpa.svg)](https://codeclimate.com/github/monterail/rails_sso)
+[![Test Coverage](https://codeclimate.com/github/monterail/rails_sso/badges/coverage.svg)](https://codeclimate.com/github/monterail/rails_sso)
 
 ## About
 
@@ -18,12 +21,20 @@ gem 'omniauth-example'
 gem 'rails_sso'
 ```
 
-Configure it:
+Install initializer and mount routes:
+
+```bash
+bin/rails generate rails_sso
+```
+
+Configure initializer:
 
 ```ruby
 # conifg/initializers/sso.rb
 
 RailsSso.configure do |config|
+  # url of entity provider
+  config.provider_url = 'https://example.com'
   # name of oauth2 provider
   config.provider_name = 'example'
   # oauth keys for omniauth-example

data/app/services/rails_sso/fetch_user.rb

@@ -1,15 +1,30 @@
+require 'json'
+
 module RailsSso
   class FetchUser
-    def initialize(access_token)
-      @access_token = access_token
+    def initialize(client)
+      @client = client
     end
 
     def call
-      access_token.get(RailsSso.provider_profile_path).parsed
+      response = client.get(RailsSso.provider_profile_path)
+
+      case response.status
+      when 200
+        begin
+          JSON.parse(response.body)
+        rescue
+          response.body
+        end
+      when 401
+        raise ResponseError.new(:unauthenticated)
+      else
+        raise ResponseError.new(:unknown)
+      end
     end
 
     private
 
-    attr_reader :access_token
+    attr_reader :client
   end
 end

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+en:
+  rails_sso:
+    errors:
+      unauthenticated: "You're not authenticated"
+      unknown: "Something wrong happened"

data/lib/generators/rails_sso_generator.rb

@@ -0,0 +1,13 @@
+class RailsSsoGenerator < Rails::Generators::Base
+  source_root File.expand_path("../templates", __FILE__)
+
+  desc "Creates RailsSso initializer and mount sso routes."
+
+  def copy_initializer
+    template "sso.rb", "config/initializers/sso.rb"
+  end
+
+  def add_sso_routes
+    route "mount RailsSso::Engine => '/sso', as: 'sso'"
+  end
+end

data/lib/generators/templates/sso.rb

@@ -0,0 +1,15 @@
+RailsSso.configure do |config|
+  # url of entity provider
+  config.provider_url = 'https://example.com'
+  # 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'
+  # enable cache (will use Rails.cache store)
+  config.use_cache = Rails.application.config.action_controller.perform_caching
+end

data/lib/rails_sso/client.rb

@@ -0,0 +1,50 @@
+require 'faraday'
+require 'faraday-http-cache'
+
+module RailsSso
+  class Client
+    def initialize(url, &block)
+      @connection = Faraday.new(url, &block)
+    end
+
+    def token!(token)
+      @token = token
+
+      self
+    end
+
+    def get(url, params = {})
+      request(:get, url, params)
+    end
+
+    def post(url, params = {})
+      request(:post, url, params)
+    end
+
+    def put(url, params = {})
+      request(:put, url, params)
+    end
+
+    def delete(url, params = {})
+      request(:delete, url, params)
+    end
+
+    def patch(url, params = {})
+      request(:patch, url, params)
+    end
+
+    private
+
+    attr_reader :connection, :token
+
+    def request(verb, url, params = {})
+      connection.send(verb) do |req|
+        req.headers['Authorization'] = "Bearer #{token}"
+        req.headers['Content-Type'] = 'application/json'
+
+        req.url(url)
+        req.body = params.to_json
+      end
+    end
+  end
+end

data/lib/rails_sso/helpers.rb

@@ -19,7 +19,9 @@ module RailsSso
     end
 
     def access_token
-      RailsSso::AccessToken.new(session[:access_token], session[:refresh_token])
+      OAuth2::AccessToken.new(oauth2_strategy.client, session[:access_token], {
+        refresh_token: session[:refresh_token]
+      })
     end
 
     def invalidate_access_token!
@@ -45,14 +47,35 @@ module RailsSso
 
     private
 
+    def oauth2_strategy
+       oauth2_strategy_class.new(nil, RailsSso.provider_key, RailsSso.provider_secret)
+    end
+
+    def oauth2_strategy_class
+      "OmniAuth::Strategies::#{RailsSso.provider_name.camelize}".constantize
+    end
+
+    def provider_client
+      @provider_client ||= RailsSso::Client.new(RailsSso.provider_url) do |conn|
+        if RailsSso.use_cache
+          conn.use :http_cache,
+            store: Rails.cache,
+            logger: Rails.logger,
+            shared_cache: false
+        end
+
+        conn.adapter Faraday.default_adapter
+      end
+    end
+
     def fetch_user_data
       return unless session[:access_token]
 
-      RailsSso::FetchUser.new(access_token).call
-    rescue ::OAuth2::Error
+      RailsSso::FetchUser.new(provider_client.token!(session[:access_token])).call
+    rescue ResponseError => e
       refresh_access_token! do
-        RailsSso::FetchUser.new(access_token).call
-      end
+        RailsSso::FetchUser.new(provider_client.token!(session[:access_token])).call
+      end if e.code == :unauthenticated
     end
   end
 end

data/lib/rails_sso/response_error.rb

@@ -0,0 +1,11 @@
+module RailsSso
+  class ResponseError < StandardError
+    attr_reader :code
+
+    def initialize(code)
+      @code = code
+
+      super(I18n.t("rails_sso.errors.#{code}"))
+    end
+  end
+end

data/lib/rails_sso/version.rb

@@ -1,3 +1,3 @@
 module RailsSso
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/rails_sso.rb

@@ -2,6 +2,7 @@ module RailsSso
   mattr_accessor :application_controller
   @@application_controller = 'ApplicationController'
 
+  mattr_accessor :provider_url
   mattr_accessor :provider_name
   mattr_accessor :provider_key
   mattr_accessor :provider_secret
@@ -29,4 +30,5 @@ require 'omniauth-oauth2'
 require 'rails_sso/version'
 require 'rails_sso/engine'
 require 'rails_sso/helpers'
-require 'rails_sso/access_token'
+require 'rails_sso/client'
+require 'rails_sso/response_error'

data/test/dummy/config/application.rb

@@ -1,6 +1,16 @@
 require File.expand_path('../boot', __FILE__)
 
-require 'rails/all'
+%w(
+  action_controller
+  action_view
+  rails/test_unit
+  sprockets
+).each do |framework|
+  begin
+    require "#{framework}/railtie"
+  rescue LoadError
+  end
+end
 
 Bundler.require(*Rails.groups)
 require "rails_sso"
@@ -20,7 +30,7 @@ module Dummy
     # config.i18n.default_locale = :de
 
     # Do not swallow errors in after_commit/after_rollback callbacks.
-    config.active_record.raise_in_transactional_callbacks = true
+    # config.active_record.raise_in_transactional_callbacks = true
   end
 end
 

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

@@ -14,13 +14,13 @@ Rails.application.configure do
   config.action_controller.perform_caching = false
 
   # Don't care if the mailer can't send.
-  config.action_mailer.raise_delivery_errors = false
+  # 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
+  # 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

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

@@ -75,5 +75,5 @@ Rails.application.configure do
   config.log_formatter = ::Logger::Formatter.new
 
   # Do not dump schema after migrations.
-  config.active_record.dump_schema_after_migration = false
+  # config.active_record.dump_schema_after_migration = false
 end

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

@@ -29,7 +29,7 @@ Rails.application.configure do
   # Tell Action Mailer not to deliver emails to the real world.
   # The :test delivery method accumulates sent emails in the
   # ActionMailer::Base.deliveries array.
-  config.action_mailer.delivery_method = :test
+  # config.action_mailer.delivery_method = :test
 
   # Randomize the order test cases are executed.
   config.active_support.test_order = :random

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

@@ -1,4 +1,5 @@
 RailsSso.configure do |config|
+  config.provider_url = 'http://example.com'
   config.provider_name = 'developer'
   config.provider_key = 'key'
   config.provider_secret = 'secret'

data/test/dummy/log/development.log

@@ -0,0 +1,4 @@
+   (11.2ms)  CREATE TABLE "schema_migrations" ("version" varchar NOT NULL) 
+   (0.1ms)  select sqlite_version(*)
+   (15.7ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+  ActiveRecord::SchemaMigration Load (0.1ms)  SELECT "schema_migrations".* FROM "schema_migrations"