openstax_connect 0.0.2 → 0.0.3

data/README.md

@@ -39,6 +39,22 @@ Make sure to install the engine's migrations:
 
     rake openstax_connect:install:migrations
 
+You also need to create your own User and AnonymousUser models.  Once you do this, include concerns from the connect gem to get their baseline functionality.
+
+    class User < ActiveRecord::Base
+      include OpenStax::Connect::Models::User
+      ...
+    end
+
+and
+
+    class AnonymousUser < ActiveRecord::Base
+      include OpenStax::Connect::Models::AnonymousUser
+      ...
+    end
+
+Check out the engine code in app/concerns to see what this gets you.
+
 Example Application
 -------------------
 

data/app/controllers/openstax/connect/application_controller.rb

@@ -1,9 +1,13 @@
 # References:
 #  http://edgeguides.rubyonrails.org/engines.html#using-a-class-provided-by-the-application
 
-# Inherit from the applications ApplicationController to share some methods
-class OpenStax::Connect::ApplicationController < ApplicationController
+module OpenStax
+  module Connect
 
-  include Lev::HandleWith
+    # Inherit from the applications ApplicationController to share some methods
+    class ApplicationController < ::ApplicationController
+      include Lev::HandleWith
+    end
 
+  end
 end

data/app/controllers/openstax/connect/dev/dev_controller.rb

@@ -5,6 +5,8 @@ module OpenStax
     module Dev
       class DevController < ApplicationController
 
+        skip_before_filter :authenticate_user!
+
         before_filter Proc.new{ 
           raise SecurityTransgression unless !Rails.env.production? || 
                                              current_user.is_administrator? 

data/app/controllers/openstax/connect/sessions_controller.rb

@@ -4,6 +4,8 @@ module OpenStax
   module Connect
     class SessionsController < ApplicationController
 
+      skip_before_filter :authenticate_user!
+
       def new
         session[:return_to] = request.referrer
         redirect_to RouteHelper.get_path(:login)
@@ -12,7 +14,7 @@ module OpenStax
       def omniauth_authenticated
         handle_with(SessionsOmniauthAuthenticated,
                     complete: lambda { 
-                      sign_in(@results[:user_to_sign_in])
+                      connect_sign_in(@handler_result.outputs[:connect_user_to_sign_in])
                       redirect_to return_path(true)
                     })
       end

data/app/handlers/openstax/connect/dev/users_create.rb

@@ -1,31 +1,28 @@
-class OpenStax::Connect::Dev::UsersCreate
-  include Lev::Handler
+module OpenStax::Connect::Dev
+  class UsersCreate
+    lev_handler
 
-protected
+  protected
 
-  def setup
-  end
-
-  def authorized?
-    !Rails.env.production?
-  end
-
-  def exec
-    u = User.create do |user|
-      user.first_name = params[:register][:first_name]
-      user.last_name = params[:register][:last_name]
-      user.username = params[:register][:username]
-      user.is_administrator = params[:register][:is_administrator]
-      user.openstax_uid = available_openstax_uid
+    def authorized?
+      !Rails.env.production?
     end
-  
-    transfer_errors_from(u, :register)
 
-    results[:user] = u
-  end
+    def handle
+      outputs[:user] = User.create do |user|
+        user.first_name = params[:register][:first_name]
+        user.last_name = params[:register][:last_name]
+        user.username = params[:register][:username]
+        user.is_administrator = params[:register][:is_administrator]
+        user.openstax_uid = available_openstax_uid
+      end
+    
+      transfer_errors_from(outputs[:user], {scope: :register})
+    end
 
-  def available_openstax_uid
-    (User.order("openstax_uid DESC").first.try(:openstax_uid) || 0) + 1
-  end
+    def available_openstax_uid
+      (User.order("openstax_uid DESC").first.try(:openstax_uid) || 0) + 1
+    end
 
-end 
+  end 
+end

data/app/handlers/openstax/connect/dev/users_generate.rb

@@ -1,6 +1,6 @@
 module OpenStax::Connect::Dev
   class UsersGenerate
-    include Lev::Handler
+    lev_handler
 
   protected
 
@@ -14,7 +14,7 @@ module OpenStax::Connect::Dev
       !Rails.env.production?
     end
 
-    def exec
+    def handle
       generate_params.count.times do 
         while !(User.where(:username => (username = SecureRandom.hex(4))).empty?) do; end
 
@@ -25,6 +25,8 @@ module OpenStax::Connect::Dev
           user.is_administrator = false
           user.openstax_uid = available_openstax_uid
         end
+
+        result.outputs.add(:users, u)
       end
     end
 

data/app/handlers/openstax/connect/dev/users_search.rb

@@ -1,8 +1,8 @@
 module OpenStax::Connect::Dev
   class UsersSearch
 
-    include Lev::Handler
-
+    lev_handler transaction: :no_transaction
+    
     paramify :search do
       attribute :search_type, type: String
       validates :search_type, presence: true,
@@ -13,7 +13,9 @@ module OpenStax::Connect::Dev
       validates :search_terms, presence: true                               
     end
 
-    uses_routine OpenStax::Connect::SearchUsers, as: :search_users
+    uses_routine OpenStax::Connect::SearchUsers, 
+                 as: :search_users,
+                 translations: { outputs: {type: :verbatim} }
 
   protected
 
@@ -21,11 +23,11 @@ module OpenStax::Connect::Dev
       !Rails.env.production? || caller.is_administrator?
     end
 
-    def exec
+    def handle
       terms = search_params.search_terms
       type = search_params.search_type
 
-      results[:users] = run(:search_users, terms, type.downcase.to_sym)
+      run(:search_users, terms, type.downcase.to_sym)
     end
 
   end

data/app/handlers/openstax/connect/sessions_omniauth_authenticated.rb

@@ -1,7 +1,7 @@
 module OpenStax::Connect
 
   class SessionsOmniauthAuthenticated
-    include Lev::Handler
+    lev_handler
 
   protected
 
@@ -13,8 +13,8 @@ module OpenStax::Connect
       @auth_data.provider == "openstax"
     end
 
-    def exec
-      results[:user_to_sign_in] = user_to_sign_in
+    def handle
+      outputs[:connect_user_to_sign_in] = user_to_sign_in
     end
 
     def user_to_sign_in
@@ -26,9 +26,16 @@ module OpenStax::Connect
       existing_user = User.where(openstax_uid: @auth_data.uid).first
       return existing_user if !existing_user.nil?
 
-      return User.create do |user|
+      new_user = User.create do |user|
         user.openstax_uid = @auth_data.uid
+        user.username     = @auth_data.info.username
+        user.first_name   = @auth_data.info.first_name
+        user.last_name    = @auth_data.info.last_name
       end
+
+      transfer_errors_from(new_user, {type: :verbatim})
+
+      new_user
     end
   end
 

data/app/helpers/openstax/connect/application_helper.rb

@@ -3,7 +3,7 @@ module OpenStax
     module ApplicationHelper
 
       def unless_errors(options={}, &block)
-        options[:errors] ||= @errors
+        options[:errors] ||= @handler_result.errors
         options[:errors_html_id] ||= OpenStax::Connect.configuration.default_errors_html_id
         options[:errors_partial] ||= OpenStax::Connect.configuration.default_errors_partial
         options[:trigger] ||= OpenStax::Connect.configuration.default_errors_added_trigger

data/app/models/openstax/connect/user.rb

@@ -0,0 +1,40 @@
+module OpenStax::Connect
+  class User < ActiveRecord::Base
+
+    validates :username, uniqueness: true
+    validates :username, presence: true
+    validates :openstax_uid, presence: true
+
+    # first and last names are not required
+
+    def name
+      (first_name || last_name) ? [first_name, last_name].compact.join(" ") : username
+    end
+
+    def casual_name
+      first_name || username
+    end    
+
+    def is_anonymous?
+      is_anonymous == true
+    end
+
+    attr_accessor :is_anonymous
+
+    def self.anonymous
+      @@anonymous ||= AnonymousUser.new
+    end
+
+    class AnonymousUser < User
+      before_save { false } 
+      def initialize(attributes=nil)
+        super
+        self.is_anonymous = true
+        self.first_name   = 'Guest'
+        self.last_name    = 'User'
+        self.openstax_uid = nil
+      end
+    end
+
+  end
+end

data/app/{algorithms → routines}/openstax/connect/search_users.rb

@@ -1,7 +1,7 @@
 module OpenStax::Connect
 
   class SearchUsers
-    include Lev::Algorithm
+    lev_routine transaction: :no_transaction
 
   protected
 
@@ -21,7 +21,7 @@ module OpenStax::Connect
         end
       when :username
         query = terms.gsub('%', '') + '%'
-        users = where{username =~ query}
+        users = User.where{username =~ query}
       when :any
         users = User.scoped
         terms.gsub(/[%,]/, '').split.each do |t|
@@ -32,10 +32,10 @@ module OpenStax::Connect
                       (username =~ query)}
         end
       else
-        raise IllegalArgument, "Unknown user search type: #{type.to_s}"
+        fatal_error(:unknown_user_search_type, data: type)
       end
 
-      return users
+      outputs[:users] = users
     end
 
   end

data/app/views/openstax/connect/dev/users/index.html.erb

@@ -3,8 +3,7 @@
   <%= error.translate %>
 <% end %>
 
-<%= osu_section_block "Register a new user" do %>
-
+<%= osu.section_block "Register a new user" do %>
 
   <%= lev_form_for :register, url: dev_users_create_path do |f| %>
 
@@ -18,14 +17,14 @@
 
 <% end %>
 
-<%= osu_section_block "Generate new users" do %>
+<%= osu.section_block "Generate new users" do %>
     <%= lev_form_for :generate, url: dev_users_generate_path do |f| %>
       Generate <%= f.text_field :count, style: 'width:30px' %> user(s) <%= submit_tag 'Do it now!' %>
     <% end %>
 <% end %>
 
-<%= osu_section_block "Login as an existing user" do %>
+<%= osu.section_block "Login as an existing user" do %>
 
   <%= render 'openstax/connect/users/action_search', action_search_path: dev_users_search_path %>
 
-<% end %>
+<% end %>

data/app/views/openstax/connect/dev/users/search.js.erb

@@ -1,7 +1,7 @@
 
 <%= render template: 'openstax/connect/users/action_search',
            locals: {
-             users: @results[:users],
+             users: @handler_result.outputs[:users],
              list: OpenStax::Connect::ActionList.new(
                      headings: ['First Name', 'Last Name', 'Username', ''],
                      widths: ['25%', '25%', '25%', '25%'],

data/config/initializers/01_requires.rb

@@ -0,0 +1 @@
+require 'lev'

data/config/initializers/02_extend_builtins.rb

@@ -2,42 +2,68 @@ class ActionController::Base
   # References:
   #   http://railscasts.com/episodes/356-dangers-of-session-hijacking
 
-  # Always return an object
+  # Returns the current app user
   def current_user
-    if !request.ssl? || cookies.signed[:secure_user_id] == "secure#{session[:user_id]}"
-      @current_user ||= AnonymousUser.instance
-
-      if @current_user.is_anonymous? && session[:user_id]
-        # Use current_user= to clear out bad state if any
-        self.current_user = User.where(id: session[:user_id]).first
-      end
+    current_connect_user
+    @current_app_user
+  end
 
-      @current_user
+  # Quasi "private" method that returns the current connect user, refreshing it if needed
+  def current_connect_user
+    if request.ssl? && cookies.signed[:secure_user_id] != "secure#{session[:user_id]}"
+      sign_out! # hijacked
+    else
+      @current_connect_user ||= OpenStax::Connect::User.anonymous
+      connect_sign_in(OpenStax::Connect::User.where(id: session[:user_id]).first) \
+        if @current_connect_user.is_anonymous? && session[:user_id]
     end
-  end
+
+    @current_connect_user
+  end  
  
+  # Sets (signs in) the provided app user.
   def current_user=(user)
-    @current_user = user || AnonymousUser.instance
-    if user.is_anonymous?
+    self.current_connect_user = OpenStax::Connect.configuration.user_provider.app_user_to_connect_user(user)
+    @current_app_user
+  end
+
+  # Quasi "private" method that sets the current connect user, also updates the cache
+  # of the current app user.
+  def current_connect_user=(user)
+    @current_connect_user = user || OpenStax::Connect::User.anonymous
+    if @current_connect_user.is_anonymous?
       session[:user_id] = nil
       cookies.delete(:secure_user_id)
     else
-      session[:user_id] = user.id
-      cookies.signed[:secure_user_id] = {secure: true, value: "secure#{user.id}"}
+      session[:user_id] = @current_connect_user.id
+      cookies.signed[:secure_user_id] = {secure: true, value: "secure#{@current_connect_user.id}"}
     end
-    @current_user
+    @current_app_user = OpenStax::Connect.configuration.user_provider.connect_user_to_app_user(@current_connect_user)
+    @current_connect_user
   end
 
+  # Signs in the given app user
   def sign_in(user)
     self.current_user = user
   end
 
+  def connect_sign_in(user)
+    self.current_connect_user = user
+  end
+
+  # Signs out the user
   def sign_out!
-    self.current_user = AnonymousUser.instance
+    self.current_connect_user =  OpenStax::Connect::User.anonymous
   end
 
+  # Returns true iff there is a user signed in
   def signed_in?
-    !current_user.is_anonymous?
+    !current_connect_user.is_anonymous?
+  end
+
+  # Useful in before_filters
+  def authenticate_user!
+    redirect_to openstax_connect.login_path unless signed_in?
   end
 
 protected

data/db/migrate/20130729213800_create_openstax_connect_users.rb

@@ -0,0 +1,15 @@
+class CreateOpenStaxConnectUsers < ActiveRecord::Migration
+  def change
+    create_table :openstax_connect_users do |t|
+      t.integer :openstax_uid
+      t.string  :first_name
+      t.string  :last_name
+      t.string  :username
+
+      t.timestamps
+    end
+
+    add_index :openstax_connect_users, :openstax_uid, :unique => true
+    add_index :openstax_connect_users, :username, :unique => true
+  end
+end

data/lib/omniauth/strategies/openstax.rb

@@ -11,11 +11,13 @@ module OmniAuth
         :authorize_url => "/oauth/authorize"
       }
 
-      uid { raw_info["uid"] }
+      uid        { raw_info["uid"] }
 
       info do
         {
-          :username => raw_info["username"]
+          username: raw_info["username"],
+          first_name: raw_info["first_name"],
+          last_name: raw_info["last_name"]
           # and anything else you want to return to your API consumers
         }
       end

data/lib/openstax/connect/engine.rb

@@ -10,8 +10,9 @@ module OpenStax
     class Engine < ::Rails::Engine
       isolate_namespace OpenStax::Connect
 
-      config.autoload_paths << File.expand_path("../../../app/algorithms", __FILE__)
+      config.autoload_paths << File.expand_path("../../../app/routines", __FILE__)
       config.autoload_paths << File.expand_path("../../../app/handlers", __FILE__)
+      config.autoload_paths << File.expand_path("../../../app/concerns", __FILE__)
 
       config.generators do |g|
         g.test_framework :rspec, :view_specs => false

data/lib/openstax/connect/exceptions.rb

@@ -0,0 +1,3 @@
+module OpenStax::Connect
+  class SecurityTransgression < StandardError; end
+end

data/lib/openstax/connect/user_provider.rb

@@ -0,0 +1,13 @@
+module OpenStax::Connect
+  class UserProvider
+
+    def self.connect_user_to_app_user(connect_user)
+      connect_user
+    end
+
+    def self.app_user_to_connect_user(app_user)
+      app_user
+    end
+
+  end
+end

data/lib/openstax/connect/version.rb

@@ -1,5 +1,5 @@
 module OpenStax
   module Connect
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/lib/openstax_connect.rb

@@ -1,8 +1,10 @@
-require "openstax/connect/engine"
 require "openstax/connect/version"
+require "openstax/connect/exceptions"
+require "openstax/connect/engine"
 require "openstax/connect/utilities"
 require "openstax/connect/route_helper"
 require "openstax/connect/action_list"
+require "openstax/connect/user_provider"
 
 module OpenStax
   module Connect
@@ -42,6 +44,44 @@ module OpenStax
         attr_accessor :default_errors_partial
         attr_accessor :default_errors_html_id
         attr_accessor :default_errors_added_trigger
+        attr_accessor :security_transgression_exception
+
+        # OpenStax Connect provides you with an OpenStax::Connect::User object.  You can
+        # use this as your app's User object without modification, you can modify it to suit
+        # your app's needs (not recommended), or you can provide your own custom User object
+        # that references the OpenStax Connect User object.  
+        #
+        # OpenStax Connect also provides you methods for getting and setting the current 
+        # signed in user (current_user and current_user= methods).  If you choose to create 
+        # your own custom User object that references the User object provide by Connect, 
+        # you can teach OpenStax Connect how to translate between your app's custom User 
+        # object and OpenStax Connect's built-in User object.
+        #
+        # To do this, you need to set a "user_provider" in this configuration.  
+        #
+        #   config.user_provider = MyUserProvider
+        #
+        # The user_provider is a class that provides two class methods:
+        #
+        #   def self.connect_user_to_app_user(connect_user)
+        #     # converts the given connect user to an app user
+        #     # if you want to cache the connect_user in the app user
+        #     # this is the place to do it.
+        #     # If no app user exists for this connect user, one should
+        #     # be created.
+        #   end
+        #
+        #   def self.app_user_to_connect_user(app_user)
+        #     # converts the given app user to a connect user
+        #   end 
+        #
+        # Connect users are never nil.  When a user is signed out, the current connect user 
+        # is an anonymous user (responding true is "is_anonymous?").  You can follow the same
+        # pattern in your app or you can use nil for the current user.  Just remember to check
+        # the anonymous status of connect users when doing your connect <-> app translations.
+        #
+        # The default user_provider just uses OpenStax::Connect::User as the app user.
+        attr_accessor :user_provider
 
         def openstax_services_url=(url)
           url.gsub!(/https|http/,'https') if !(url =~ /localhost/)
@@ -58,6 +98,8 @@ module OpenStax
           @default_errors_partial = 'openstax/connect/shared/attention'
           @default_errors_html_id = 'openstax-connect-attention'
           @default_errors_added_trigger = 'openstax-connect-errors-added'
+          @security_transgression_exception = OpenStax::Connect::SecurityTransgression
+          @user_provider = OpenStax::Connect::UserProvider
           super
         end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openstax_connect
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-19 00:00:00.000000000 Z
+date: 2013-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -82,7 +82,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 2.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -90,7 +90,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -130,7 +130,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- app/algorithms/openstax/connect/search_users.rb
 - app/assets/javascripts/openstax/connect/application.js
 - app/assets/javascripts/openstax/connect/sessions.js
 - app/assets/stylesheets/openstax/connect/application.css
@@ -138,7 +137,6 @@ files:
 - app/assets/stylesheets/openstax/connect/sessions.css
 - app/controllers/openstax/connect/application_controller.rb
 - app/controllers/openstax/connect/dev/dev_controller.rb
-- app/controllers/openstax/connect/dev/sessions_controller.rb
 - app/controllers/openstax/connect/dev/users_controller.rb
 - app/controllers/openstax/connect/sessions_controller.rb
 - app/handlers/openstax/connect/dev/users_create.rb
@@ -147,8 +145,8 @@ files:
 - app/handlers/openstax/connect/sessions_omniauth_authenticated.rb
 - app/helpers/openstax/connect/application_helper.rb
 - app/helpers/openstax/connect/sessions_helper.rb
-- app/models/anonymous_user.rb
-- app/models/user.rb
+- app/models/openstax/connect/user.rb
+- app/routines/openstax/connect/search_users.rb
 - app/views/layouts/openstax/connect/application.html.erb
 - app/views/openstax/connect/dev/users/index.html.erb
 - app/views/openstax/connect/dev/users/search.js.erb
@@ -159,14 +157,16 @@ files:
 - app/views/openstax/connect/users/_action_list.html.erb
 - app/views/openstax/connect/users/_action_search.html.erb
 - app/views/openstax/connect/users/action_search.js.erb
+- config/initializers/01_requires.rb
 - config/initializers/02_extend_builtins.rb
 - config/routes.rb
-- db/migrate/20130729213800_create_users.rb
-- db/migrate/20130909215452_add_fields_to_user.rb
+- db/migrate/20130729213800_create_openstax_connect_users.rb
 - lib/omniauth/strategies/openstax.rb
 - lib/openstax/connect/action_list.rb
 - lib/openstax/connect/engine.rb
+- lib/openstax/connect/exceptions.rb
 - lib/openstax/connect/route_helper.rb
+- lib/openstax/connect/user_provider.rb
 - lib/openstax/connect/utilities.rb
 - lib/openstax/connect/version.rb
 - lib/openstax_connect.rb
@@ -188,7 +188,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 28024144982429715
+      hash: 2014906712606740384
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -197,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 28024144982429715
+      hash: 2014906712606740384
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25

data/app/controllers/openstax/connect/dev/sessions_controller.rb

@@ -1,21 +0,0 @@
-module OpenStax
-  module Connect
-    module Dev
-      class SessionsController < DevController
-        
-        # def new
-
-        # end
-        
-        # def create; end
-
-        # def search
-        #   handle_with(Dev::SessionsUserSearch,
-        #               params: params,
-        #               complete: lambda { render 'search' })
-        # end
-
-      end
-    end
-  end
-end

data/app/models/anonymous_user.rb

@@ -1,40 +0,0 @@
-require 'singleton'
-
-class AnonymousUser
-  include Singleton
-
-  def is_administrator?
-    false
-  end
-
-  def is_anonymous?
-    true
-  end
-
-  def id
-    nil
-  end
-
-  # Necessary if an anonymous user ever runs into an Exception
-  # or else the developer email doesn't work
-  def username
-    'anonymous'
-  end
-
-  def first_name
-    'Guest User'
-  end
-
-  def last_name
-    'Guest User'
-  end
-
-  def name
-    'Guest User'
-  end
-
-  def openstax_uid
-    nil
-  end
-
-end

data/app/models/user.rb

@@ -1,21 +0,0 @@
-class User < ActiveRecord::Base
-
-  validates :username, uniqueness: true
-  validates :username, presence: true
-  validates :openstax_uid, presence: true
-  validates :first_name, presence: true
-  validates :last_name, presence: true
-
-  def is_administrator?
-    self.is_administrator
-  end
-
-  def is_anonymous?
-    false
-  end
-
-  def name
-    "#{first_name} #{last_name}"
-  end
-  
-end

data/db/migrate/20130729213800_create_users.rb

@@ -1,9 +0,0 @@
-class CreateUsers < ActiveRecord::Migration
-  def change
-    create_table :users do |t|
-      t.integer :openstax_uid
-
-      t.timestamps
-    end
-  end
-end

data/db/migrate/20130909215452_add_fields_to_user.rb

@@ -1,11 +0,0 @@
-class AddFieldsToUser < ActiveRecord::Migration
-  def change
-    add_column :users, :first_name, :string
-    add_column :users, :last_name, :string
-    add_column :users, :username, :string
-    add_column :users, :is_administrator, :boolean, :default => false
-
-    add_index :users, :openstax_uid, :unique => true
-    add_index :users, :username, :unique => true
-  end
-end