pixnet-sso 0.0.1 → 0.0.2

data/README.md

@@ -15,7 +15,9 @@ Clients for PIXNET SSO
 
     gem install pixnet-sso 
 
-## CONFIG:
+## ENABLE PIXNET SSO:
+
+### CONFIG:
 
 Create a `config/initializers/pixnet-sso.rb` that looks like:
 
@@ -23,10 +25,28 @@ Create a `config/initializers/pixnet-sso.rb` that looks like:
         config.user_model = 'User'
         config.sso_key = ENV['SSO_KEY']
         config.sso_secret = ENV['SSO_SECRET']
+        # option: openid
+        config.openid_model = 'OpenidAssociate'
+        config.openid_enabled = true
     end
 
 And set your PIXNET SSO key pair to your ENV.
 
+### MODEL AND MIGRATIONS:
+
+You should have models to store user/openid data.
+
+### LOAD SCIRPTS IN YOUR LAYOUT:
+
+Add `<%= pixnet_sso_scripts %>` in your `layout/application.html.erb` to enable PIXNET SSO.
+
+### ADD CONTROLLER METHODS IN YOUR APPLCATION
+
+Add code in your `app/controllers/application_controller`:
+
+include Pixnet::SSO::ControllerMethods
+include Pixnet::SSO::OpenidControllerMethods
+
 ## LICENSE:
 
 Apache License 2.0

data/app/controllers/pixauth_controller.rb

@@ -8,7 +8,7 @@ class PixauthController < ApplicationController
 
     if info["info"]
       self.current_user = sso.get_user(info["msg"]["user_name"])
-      #self.current_openid_user = get_openid_user(info)
+      self.current_openid_user = sso.get_openid_user(info) if Pixnet::SSO::Config.openid_enabled
 
       redirect_to done_site
     else

data/lib/generators/pixnet_sso/install_generator.rb

@@ -0,0 +1,52 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module PixnetSso
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    source_root File.expand_path('../templates', __FILE__)
+
+
+    # Implement the required interface for Rails::Generators::Migration.
+    # taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
+    def self.next_migration_number(dirname) #:nodoc:
+      if ActiveRecord::Base.timestamped_migrations
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      else
+        "%.3d" % (current_migration_number(dirname) + 1)
+      end
+    end
+
+    def create_migration_file
+      template 'user.rb', "app/models/#{user_model.singularize.underscore}.rb"
+      migration_template 'migration.rb', "db/migrate/create_#{user_model.tableize}.rb"
+
+
+      if openid_enabled?
+        template 'openid_associate.rb', "app/models/#{openid_model.singularize.underscore}.rb"
+        migration_template 'migration_openid.rb', "db/migrate/create_#{openid_model.tableize}.rb"
+      end
+
+      template 'config.rb', 'config/initializers/pixnet-sso.rb'
+    end
+
+    def user_model
+      @user_model ||= ask('What is your user model name?').classify
+    end
+
+    def openid_model
+      return '' unless openid_enabled?
+      @openid_model ||= ask('What is your openid model name?').classify
+    end
+
+    def openid_enabled
+      @openid_enabled ||= ask("Would you want to enable OpenID ?(y/N)")
+    end
+
+    def openid_enabled?
+      openid_enabled.downcase == 'y'
+    end
+  end
+end
+
+

data/lib/generators/pixnet_sso/templates/config.rb

@@ -0,0 +1,9 @@
+Pixnet::SSO.config do |config|
+  config.user_model   = '<%= user_model.classify %>'
+  config.sso_key = ENV['SSO_KEY']
+  config.sso_secret = ENV['SSO_SECRET']
+<% if openid_enabled? -%>
+  config.openid_model = '<%= openid_model.classify %>'
+  config.openid_enabled = <%= openid_enabled? ? 'true' : 'false' %>
+<% end -%>
+end

data/lib/generators/pixnet_sso/templates/migration.rb

@@ -0,0 +1,15 @@
+class Create<%= user_model %>s < ActiveRecord::Migration
+  def self.up
+    create_table :<%= user_model.tableize %> do |t|
+      t.string :login, :limit => 32
+      t.timestamps
+    end
+
+    add_index :<%= user_model.tableize %>, [:login], :unique => true
+  end
+
+  def self.down
+    drop_table :<%= user_model.tableize %>
+  end
+end
+

data/lib/generators/pixnet_sso/templates/migration_openid.rb

@@ -0,0 +1,19 @@
+class Create<%= openid_model %>s < ActiveRecord::Migration
+  def self.up
+    create_table :<%= openid_model.tableize %> do |t|
+      t.string   "openid"
+      t.string   "provider",   :limit => 32
+      t.text     "extra"
+      t.datetime "created_at"
+      t.datetime "updated_at"
+    end
+
+    add_index :<%= openid_model.tableize %>, ["openid"], :unique => true
+    add_index :<%= openid_model.tableize %>, ["provider"]
+  end
+
+  def self.down
+    drop_table :<%= openid_model.tableize %>
+  end
+end
+

data/lib/generators/pixnet_sso/templates/openid_associate.rb

@@ -0,0 +1,32 @@
+class <%= openid_model %> < ActiveRecord::Base
+
+  def email
+    extra_data['value.email']
+  end
+
+  def fullname
+    extra_data['value.fullname'] or "#{extra_data['value.firstname']} #{extra_data['value.lastname']}"
+  end
+
+  def avatar
+    extra_data['value.avatar'] or "http://s.pixfs.net/f.pixnet.net/comment/images/avatar-#{provider.downcase}.jpg"
+  end
+
+  def nick
+    extra_data['value.nickname'] or fullname
+  end
+
+  def link
+    case provider
+    when "facebook"
+      return extra_data['value.facebook']
+    else
+      return false
+    end
+    return false
+  end
+
+  def extra_data
+    return JSON.parse(extra)
+  end
+end

data/lib/generators/pixnet_sso/templates/user.rb

@@ -0,0 +1,3 @@
+class <%= user_model %> < ActiveRecord::Base
+
+end

data/lib/pixnet-sso/app.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 require 'openssl'
+require 'open-uri'
 
 module Pixnet
   module SSO
@@ -27,6 +28,17 @@ module Pixnet
         end
       end
 
+      def get_openid_user(info)
+        return false if info['msg']['openid'].blank?
+        openid_user = Pixnet::SSO::Config.openid_klass.find_or_initialize_by_openid(info['msg']['openid'])
+        if openid_user.new_record?
+          openid_user.provider = info['msg']['openid_type']
+          openid_user.extra = info['msg']['openid_data'].to_json
+          openid_user.save
+        end
+        return openid_user
+      end
+
       def show_error
         return @error_message
       end

data/lib/pixnet-sso/config.rb

@@ -5,6 +5,12 @@ module Pixnet
       mattr_accessor :user_model
       @@user_model = "User"
 
+      mattr_accessor :openid_model
+      @@openid_model = "OpenidAssociate"
+
+      mattr_accessor :openid_enabled
+      @@openid_enabled = false
+
       # SSO Key
       mattr_accessor :sso_key
 
@@ -14,6 +20,10 @@ module Pixnet
       def self.user_klass
         user_model.to_s.constantize
       end
+
+      def self.openid_klass
+        openid_model.to_s.constantize
+      end
     end
   end
 end

data/lib/pixnet-sso/controller_methods.rb

@@ -15,7 +15,7 @@ module Pixnet
       end
 
       def login_from_session
-        self.current_user = User.find(session[:user_id]) if session[:user_id]
+        self.current_user = Pixnet::SSO::Config.user_klass.find(session[:user_id]) if session[:user_id]
       end
 
       def login_required
@@ -27,7 +27,6 @@ module Pixnet
         end
       end
 
-
       def self.included(base)
         base.helper_method :logged_in?
         base.helper_method :current_user

data/lib/pixnet-sso/helper.rb

@@ -1,4 +1,7 @@
 # encoding: utf-8
+
+require 'uuid'
+
 module Pixnet
   module SSO
     module Helper
@@ -7,6 +10,10 @@ module Pixnet
         unique = Zlib.crc32(UUID.generate).to_s
         user_name = current_user.blank? ? "" : current_user.login
         login_name = "#{user_name}.pixnet.net#{unique}#{now}"
+
+        if Pixnet::SSO::Config.openid_enabled and current_openid_user
+          login_name = "#{login_name}#{current_openid_user.openid}"
+        end
         html = <<MSG
 <script type="text/javascript">
   <!--

data/lib/pixnet-sso/openid_controller_methods.rb

@@ -0,0 +1,22 @@
+module Pixnet
+  module SSO
+    module OpenidControllerMethods
+      def current_openid_user=(openid_user)
+        session[:openid_user_id] = openid_user ? openid_user.id : nil
+        @current_openid_user =  openid_user || false
+      end
+
+      def current_openid_user
+        @current_openid_user ||= openid_login_from_session unless @current_openid_user == false
+      end
+
+      def openid_login_from_session
+        self.current_openid_user = Pixnet::SSO::Config.openid_klass.find(session[:openid_user_id]) if session[:openid_user_id]
+      end
+
+      def self.included(base)
+        base.helper_method :current_openid_user
+      end
+    end
+  end
+end

data/lib/pixnet-sso.rb

@@ -9,6 +9,7 @@ module Pixnet
   module SSO
 
     autoload :ControllerMethods, 'pixnet-sso/controller_methods'
+    autoload :OpenidControllerMethods, 'pixnet-sso/openid_controller_methods'
 
     def self.config
       yield Pixnet::SSO::Config

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: pixnet-sso
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Manic Chuang
@@ -73,13 +73,20 @@ extra_rdoc_files: []
 files: 
 - app/controllers/pixauth_controller.rb
 - config/routes.rb
-- lib/tasks/pixnet-sso_tasks.rake
-- lib/pixnet-sso.rb
-- lib/pixnet-sso/helper.rb
-- lib/pixnet-sso/railtie.rb
 - lib/pixnet-sso/controller_methods.rb
-- lib/pixnet-sso/app.rb
+- lib/pixnet-sso/railtie.rb
+- lib/pixnet-sso/openid_controller_methods.rb
 - lib/pixnet-sso/config.rb
+- lib/pixnet-sso/helper.rb
+- lib/pixnet-sso/app.rb
+- lib/pixnet-sso.rb
+- lib/generators/pixnet_sso/install_generator.rb
+- lib/generators/pixnet_sso/templates/config.rb
+- lib/generators/pixnet_sso/templates/openid_associate.rb
+- lib/generators/pixnet_sso/templates/migration_openid.rb
+- lib/generators/pixnet_sso/templates/user.rb
+- lib/generators/pixnet_sso/templates/migration.rb
+- lib/tasks/pixnet-sso_tasks.rake
 - MIT-LICENSE
 - Rakefile
 - README.md