sso_clyent 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OWMyNDc3OTAwNzJmZGEwM2IyMzg4Yjc4N2UxMTA0ZTZjOTMxOWM3YQ==
+  data.tar.gz: !binary |-
+    OTgwZjRiYTk4NDFkZjBmZDQ1ZTFiZDA4YWFmZjhjYzU3MDBjYmY4OQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NGI5NWU2ZDk5YzhmMTliZGVkNDMyMjA3OGNmMWNjNjEzY2JjOWU4MWI2YzM4
+    NDdlNmRiMjg3N2I1NjM0NmFkMTI3YTlhYTVmNzU0MWJiMGIxMTIzMDAxMmI3
+    NmZmMWE4MzUwMzA3OWNlMjY4OWRiZjI0MmYwNWE3ZGE4YTVjMzg=
+  data.tar.gz: !binary |-
+    NTQxNTAwNWZjYTUzNWRmNGM5MGI5NTgwZjY0NTA4MzI4ODIyNjY0MmVmODBh
+    NWVmYWZmZWJkY2JlM2JkMjA4YmYyNzkzMzk5MzkxMmQ5NmM2NWRlN2JlZTA0
+    MDBlNzNjZGQxZGJjOWJkNjBhMDcwM2ZjMmMyOTZiZTg2MjA1NDk=

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 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.rdoc

@@ -0,0 +1,111 @@
+gem 'sso_clyent'    
+---   
+   
+Setup following config variables (app.config)
+---
+
+config.sso_clyent = {
+  :path                => "/sso",   # ex '/' - the path where you want to mount the sso_clyent_engine
+  :user_class          =>  "User",  # ex: User - the class where you store your users info
+  :unique_id           =>  "uid",   # ex: :uid - the attr of the user model that allows you to identify a user
+  :after_sign_in_path  => '/',      # ex '/' - the path where you want your users to be redirected by default after sign in
+
+  :provyder            => {         # info for the omniauth strategy connecting to omniauth_provider
+    
+                            :url              => "http://localhost:3000#{options[:path_prefix]}",     # url of the sso provider
+                            :authorize_path   => '/oauth/authorize',                                  # auth path @ the sso provider
+                            :token_path       => '/oauth/token',                                      # token path @ the sso provider
+                            :user             => {  :path           => "/auth/user",                  # path to user info @ the sso provider
+                                                    :uid            => "id",                          # name of attribute to correspond to id
+                                                    :info           => %w(email),                     # info to retrieve from provider response
+                                                    :extras         => %w()         }                 # extras
+                            :app_id           => 'YOURAPPID',                                         # your app id to identify @ the provider
+                            :app_secret       => 'YOURAPPSECRET',                                     # your app secret to identify @ the provider
+                          }
+}
+      
+You can overwrite following methods in your controllers
+---      
+# def login_required     
+#   if !current_user       
+#     respond_to do |format|       
+#       format.html { redirect_to "#{SsoClyent.path}/auth/sso" }       
+#       format.json { render :json => { 'error' => 'Access Denied' }.to_json }       
+#     end       
+#   end       
+# end       
+#       
+# def current_user       
+#   return nil unless session[:user_id]       
+#   users = user_klass       
+#   uid = userid       
+#   if users.respond_to?(:"find_by_#{uid}")       
+#     @current_user ||= users.send(:"find_by_#{uid}", session[:user_id]['uid'])       
+#   end       
+# end       
+#        
+# def user_klass       
+#   SsoClyent.user_class       
+# end       
+#        
+# def userid       
+#   SsoClyent.unique_id       
+# end       
+
+
+
+
+OLD DOCS !      
+      
+# A Rails Engine providing an Omniauth client with single sign on features in a minute.
+# 
+# See sso_provyder for the provider part. 
+# Based on Devise, Authentifyd and joshsoftware/sso-devise-omniauth-client. Parts directly taken from https://github.com/joshsoftware/sso-devise-omniauth-client
+#   
+# install the gem  
+#   
+# add a config/intializers/sso_clyent.rb file with the following:  
+#   
+#   # Provide sso_clyent with the user_class you use to store your users
+#   SsoClyent.user_class = "User"
+#     
+#   # ... and the name of the attribute / field you use to identify your user 
+#   # across services 
+#   SsoClyent.unique_id = "unique_id"
+#   
+#   # Also provide sso_clyent with the sso_provider you want to target
+#   #
+#   # * url, 
+#   # * authorizeurl, and
+#   # * access_token url
+#   # * user
+#   #   + where to get user_info from provider
+#   #   + the unique id you expect from provider  
+#   #   + the info you expect from provider  
+#   #   + the extra_info you expect from provider
+#   #
+#   # NB: the provider is expected to respond_to [:user][:path].json
+#   #
+#   SsoClyent.sso_provider = {
+#     :url            => 'http://localhost:3000',
+#     :authorize_path => '/auth/sso/authorize',
+#     :token_path     => '/auth/sso/access_token',
+#     :user           => {  :path           => "/auth/sso/user"
+#                           :uid            => "id",
+#                           :info           => %w(email),
+#                           :extras         => %w()         } }
+# 
+# add a config/intializers/omniauth.rb file with the following:  
+#   
+#   # Change this omniauth configuration to point to your registered provider
+#   # Since this is a registered application, add the app id and secret here
+#   APP_ID = 'YE0NYveQGoFsNLX220Dy5g'
+#   APP_SECRET = 'aqpGBedDnHFyp5MmgT8KErr9D015ScmaY8r3vHg5C0'
+# 
+#   Rails.application.config.middleware.use OmniAuth::Builder do
+#     provider :sso_server, APP_ID, APP_SECRET
+#   end
+#   
+# add the following line to your controllers  
+#   
+#   before_filter :login_required

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SsoClyent'
+  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
+
+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/assets/javascripts/sso_clyent/application.js

@@ -0,0 +1,15 @@
+// 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 vendor/assets/javascripts of plugins, if any, 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
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/sso_clyent/application.css

@@ -0,0 +1,13 @@
+/*
+ * 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 vendor/assets/stylesheets of plugins, if any, 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/sso_clyent/application_controller.rb

@@ -0,0 +1,5 @@
+module SsoClyent
+  class ApplicationController < ActionController::Base
+    protect_from_forgery
+  end
+end

data/app/controllers/sso_clyent/user_sessions_controller.rb

@@ -0,0 +1,41 @@
+class SsoClyent::UserSessionsController < SsoClyent::ApplicationController
+  before_filter :login_required, :only => [ :destroy ]
+
+  respond_to :html
+
+  # omniauth callback method
+  def create
+    omniauth = env['omniauth.auth']
+    logger.debug "+++ #{omniauth}"
+
+    user = user_klass.send("find_by_#{userid}", omniauth['uid'])
+    if not user
+      # New user registration
+      user = user_klass.new(:"#{userid}" => omniauth['uid'])
+    end
+    user.save
+
+    # Currently storing all the info
+    session[:user_id] = omniauth
+
+    flash[:notice] = "Successfully logged in"
+    redirect_to SsoClyent.after_sign_in_path
+  end
+
+  # Omniauth failure callback
+  def failure
+    flash[:notice] = params[:message]
+
+  end
+
+  # logout - Clear our rack session BUT essentially redirect to the provider
+  # to clean up the Devise session from there too !
+  def destroy
+    session[:user_id] = nil
+
+    flash[:notice] = 'You have successfully signed out!'
+    redirect_to "#{OmniAuth::Strategies::Sso._provider[:url]}/logout?callback_url=#{root_url}"
+  end
+
+  private
+end

data/app/helpers/sso_clyent/application_helper.rb

@@ -0,0 +1,4 @@
+module SsoClyent
+  module ApplicationHelper
+  end
+end

data/app/views/layouts/sso_clyent/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>SsoClyent</title>
+  <%= stylesheet_link_tag    "sso_clyent/application", :media => "all" %>
+  <%= javascript_include_tag "sso_clyent/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,10 @@
+SsoClyent::Engine.routes.draw do
+  root :to => redirect('/')
+
+  # omniauth
+  match "auth/:provider/callback", :controller => "UserSessions", :action => "create"
+  match "auth/failure", :controller => "UserSessions", :action => "failure"
+  # Custom logout
+  match "logout", :controller => "UserSessions", :action => "destroy"
+
+end

data/lib/sso_clyent/base.rb

@@ -0,0 +1 @@
+require 'sso_clyent/controllers/current_user_helpers'

data/lib/sso_clyent/controllers/current_user_helpers.rb

@@ -0,0 +1,28 @@
+module CurrentUserHelpers
+  def login_required
+    if !current_user
+      respond_to do |format|
+        format.html { redirect_to "#{SsoClyent.path}/auth/sso" }
+        format.json { render :json => { 'error' => 'Access Denied' }.to_json }
+      end
+    end
+  end
+
+  def current_user
+    return nil unless session[:user_id]
+    users = user_klass
+    uid = userid
+    if users.respond_to?(:"find_by_#{uid}")
+      @current_user ||= users.send(:"find_by_#{uid}", session[:user_id]['uid'])
+    end
+  end
+
+  def user_klass
+    SsoClyent.user_class
+  end
+
+  def userid
+    SsoClyent.unique_id
+  end
+end
+ActionController::Base.send :include, CurrentUserHelpers

data/lib/sso_clyent/engine.rb

@@ -0,0 +1,24 @@
+module SsoClyent
+  class Engine < ::Rails::Engine
+    isolate_namespace SsoClyent
+
+    config.generators do |g|
+          g.test_framework :rspec, :view_specs => false
+    end
+
+    config.sso_clyent = ActiveSupport::OrderedOptions.new
+
+    initializer "sso_client.configure" do |app|
+      SsoClyent.configure(app.config.sso_clyent)
+
+      require 'sso_clyent/omniauth/strategies/sso'
+
+      app.config.middleware.use OmniAuth::Builder do
+        provider :sso, SsoClyent.provyder[:app_id], SsoClyent.provyder[:app_secret],
+          :callback_path => "#{SsoClyent.path}/auth/sso/callback",
+          :path_prefix => "#{SsoClyent.path}/auth"
+      end
+    end
+    
+  end
+end

data/lib/sso_clyent/omniauth/strategies/sso.rb

@@ -0,0 +1,36 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class Sso < OmniAuth::Strategies::OAuth2
+
+      def raw_info
+        @raw_info ||= access_token.get("#{_provider[:user_url]}.json?oauth_token=#{access_token.token}").parsed
+      end
+
+      def self._provider; SsoClyent.provyder;end
+      def _provider; SsoClyent.provyder;end
+
+      option :client_options, {
+        :site =>  _provider[:url],
+        :authorize_url => _provider[:authorize_url],
+        :token_url => _provider[:access_token_url]
+      }
+      option :provider_ignores_state, true
+
+      uid { raw_info[_provider[:user][:uid]] }
+
+      info do
+        _provider[:user][:info].inject({}) do |h,inf|
+          h.merge({inf.to_sym => raw_info.send(:[], inf)})
+        end
+      end
+
+      extra do
+        _provider[:user][:extras].inject({}) do |h,inf|
+          h.merge({inf.to_sym => raw_info['extra'].try(:[], inf)})
+        end
+      end
+    end
+  end
+end

data/lib/sso_clyent/version.rb

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

data/lib/sso_clyent.rb

@@ -0,0 +1,43 @@
+require "sso_clyent/engine"
+
+module SsoClyent
+
+  mattr_accessor :user_class, :unique_id
+  mattr_accessor :after_sign_in_path
+  mattr_accessor :path
+  mattr_accessor :provyder
+
+  def self.configure(config)
+    @@user_class = config[:user_class]
+    @@unique_id = config[:unique_id]
+    @@after_sign_in_path = config[:after_sign_in_path] || "/"
+    @@path = config[:path] || "/sso"
+    @@provyder = complete_provyder(config[:provyder])
+  end
+
+  def self.user_class
+    @@user_class.constantize
+  end
+
+  private
+
+  def self.complete_provyder(_provider=nil)
+    options = _provider || {}
+    base = options.reverse_merge({
+      :url            => "http://localhost:3000#{options[:path_prefix]}",
+      :authorize_path => '/oauth/authorize',
+      :token_path     => '/oauth/token',
+      :user           => {  :path           => "/user",
+                            :uid            => "id",
+                            :info           => %w(email),
+                            :extras         => %w()         } })
+    base.reverse_merge({
+      :authorize_url  => "#{base[:url]}#{base[:authorize_path]}",
+      :access_token_url  => "#{base[:url]}#{base[:token_path]}",
+      :user_url => "#{base[:url]}#{base[:user][:path]}"
+      })
+  end
+
+end
+
+require 'sso_clyent/base'

data/lib/tasks/sso_clyent_tasks.rake

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