openstax_connect 0.0.1

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

@@ -0,0 +1,31 @@
+
+<% handler_errors.each do |error| %>
+  <%= error.translate %>
+<% end %>
+
+<%= osu_section_block "Register a new user" do %>
+
+
+  <%= lev_form_for :register, url: dev_users_create_path do |f| %>
+
+    First name <%= f.text_field :first_name %><br/>
+    Last name <%= f.text_field :last_name %><br/>
+    Username <%= f.text_field :username %><br/>
+    Admin? <%= f.check_box :is_administrator %><br/>
+
+    <%= submit_tag 'Register' %>
+  <% end %>
+
+<% end %>
+
+<%= 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 %>
+
+  <%= render 'openstax/connect/users/action_search', action_search_path: dev_users_search_path %>
+
+<% end %>

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

@@ -0,0 +1,21 @@
+
+<%= render template: 'openstax/connect/users/action_search',
+           locals: {
+             users: @results[:users],
+             list: OpenStax::Connect::ActionList.new(
+                     headings: ['First Name', 'Last Name', 'Username', ''],
+                     widths: ['25%', '25%', '25%', '25%'],
+                     data_procs:
+                       [
+                         Proc.new { |user| user.first_name },
+                         Proc.new { |user| user.last_name },
+                         Proc.new { |user| user.username },
+                         Proc.new { |user| 
+                          link_to 'Sign in as', 
+                                  sessions_become_path(:user_id => user.id), 
+                                  method: :post 
+                         }
+                       ]
+                   )
+           }
+%>

data/app/views/openstax/connect/sessions/create.html.erb

@@ -0,0 +1,10 @@
+<h1>Sessions#create</h1>
+<p>Find me in app/views/openstax/connect/sessions/create.html.erb</p>
+
+<hr/>
+
+<%= request.env['omniauth.auth'] %>
+
+<hr/>
+
+<%= session.inspect %>

data/app/views/openstax/connect/shared/_attention.html.erb

@@ -0,0 +1,3 @@
+<% handler_errors.each do |error| %>
+  <%= error.translate %>
+<% end %>

data/app/views/openstax/connect/users/_action_create_form.html.erb

@@ -0,0 +1,9 @@
+<%# Copyright 2011-2012 Rice University. Licensed under the Affero General Public 
+    License version 3 or later.  See the COPYRIGHT file for details. %>
+
+<%# Callers must supply a 'user' local variable %>
+
+<%= form_for target, :method => :post, :remote => true do |f| %>
+  <%= f.hidden_field :user_id, :value => user.id %>
+  <%= f.submit "Add", :onclick => please_wait_js %>
+<% end %>

data/app/views/openstax/connect/users/_action_dialog.html.erb

@@ -0,0 +1,10 @@
+<%# Copyright 2011-2012 Rice University. Licensed under the Affero General Public 
+    License version 3 or later.  See the COPYRIGHT file for details. %>
+
+<div id="user_action_dialog" style="display:none" title="<%= @action_dialog_title %>">
+  <div id="user_action_dialog_errors"></div>
+  
+  <%= render :partial => 'users/action_search', 
+             :locals => { :action_search_path => @action_search_path } %>
+                          
+</div>

data/app/views/openstax/connect/users/_action_list.html.erb

@@ -0,0 +1,33 @@
+<%# Copyright 2011-2012 Rice University. Licensed under the Affero General Public 
+    License version 3 or later.  See the COPYRIGHT file for details. %>
+
+<%
+  users ||= []
+%>
+
+<% if list.num_columns > 0 %>
+  <table class="list" width="100%">
+    <% if list.has_headings? %>
+      <tr>  
+        <% for ii in 0..list.num_columns - 1 %>
+          <th><%= list.get_heading(ii) %></th>
+        <% end %>
+      </tr>
+    <% end %>
+
+    <% if users.empty? %>
+      <tr>
+        <td colspan="<%= list.num_columns %>">No results</td>
+      </tr>
+    <% else %>
+      <% users.all.each_with_index do |user, uu| %>
+        <tr>
+          <% for cc in 0..list.num_columns - 1 %>
+            <% width = uu == 0 ? list.get_width(cc) : nil %>
+            <td <%= "width=#{width}" if width %>><%= list.get_data(cc, user) %></td>
+          <% end %>
+        </tr>
+      <% end %>
+    <% end %>
+  </table>
+<% end %>

data/app/views/openstax/connect/users/_action_search.html.erb

@@ -0,0 +1,25 @@
+<%# Copyright 2011-2012 Rice University. Licensed under the Affero General Public 
+    License version 3 or later.  See the COPYRIGHT file for details. %>
+
+<%
+   # Clients of this partial must supply the following variables:
+   #   action_search_path  
+%>
+
+<div id="action-search-errors"></div>
+
+<%= lev_form_for :search, 
+                 url: action_search_path, 
+                 id: 'action_search_form',
+                 remote: true do |f| %>
+
+  Search for 
+  <%= f.text_field :search_terms, style: 'width:300px' %> 
+  in         
+  <%= f.select :search_type, options_for_select(['Any', 'Name', 'Username']) %>
+
+  <%= submit_tag 'Search' %>
+
+<% end %>
+
+<div id="action-search-results-list"></div>

data/app/views/openstax/connect/users/action_search.js.erb

@@ -0,0 +1,8 @@
+<%= unless_errors errors_html_id: (errors_html_id ||= 'action-search-errors') do %>
+  <% contents = render 'openstax/connect/users/action_list', 
+                       users: users, 
+                       list: list %>
+  
+  $("#action-search-results-list").html("<%= j(contents) %>");  
+<% end %>
+

data/config/initializers/02_extend_builtins.rb

@@ -0,0 +1,48 @@
+class ActionController::Base
+  # References:
+  #   http://railscasts.com/episodes/356-dangers-of-session-hijacking
+
+  # Always return an object
+  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_user
+    end
+  end
+ 
+  def current_user=(user)
+    @current_user = user || AnonymousUser.instance
+    if 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}"}
+    end
+    @current_user
+  end
+
+  def sign_in(user)
+    self.current_user = user
+  end
+
+  def sign_out!
+    self.current_user = AnonymousUser.instance
+  end
+
+  def signed_in?
+    !current_user.is_anonymous?
+  end
+
+protected
+
+  helper_method :current_user, :current_user=, :signed_in?
+
+end
+

data/config/routes.rb

@@ -0,0 +1,32 @@
+OpenStax::Connect::Engine.routes.draw do
+  match '/auth/openstax/callback', to: 'sessions#omniauth_authenticated' #omniauth route
+  get '/auth/openstax', :as => 'openstax_login'
+  get 'sessions/new', :as => 'login'
+  post 'sessions/become'
+  
+  # See https://github.com/plataformatec/devise/commit/f3385e96abf50e80d2ae282e1fb9bdad87a83d3c
+  match 'sessions/destroy', :as => 'logout', :via => OpenStax::Connect.configuration.logout_via
+
+  if OpenStax::Connect.configuration.enable_stubbing?
+    namespace :dev do
+      # get 'sessions/new'
+      # post 'sessions/create'
+      # post 'sessions/search'
+      get 'users', to: 'users#index'
+      post 'users/create'
+      post 'users/generate'
+      post 'users/search'
+    end
+  end
+end
+
+
+module OpenStax
+  module Connect
+    hh = Engine.routes.url_helpers
+
+    RouteHelper.register_path(:login, hh.openstax_login_path) { hh.dev_users_path }
+  end
+end
+
+

data/db/migrate/20130729213800_create_users.rb

@@ -0,0 +1,9 @@
+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

@@ -0,0 +1,11 @@
+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

data/lib/omniauth/strategies/openstax.rb

@@ -0,0 +1,28 @@
+require 'omniauth'
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class Openstax < OAuth2
+      option :name, "openstax"
+
+      option :client_options, {
+        :site => OpenStax::Connect.configuration.openstax_services_url,
+        :authorize_url => "/oauth/authorize"
+      }
+
+      uid { raw_info["uid"] }
+
+      info do
+        {
+          :username => raw_info["username"]
+          # and anything else you want to return to your API consumers
+        }
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get('/api/v1/me.json').parsed
+      end
+    end
+  end
+end

data/lib/openstax/connect/action_list.rb

@@ -0,0 +1,40 @@
+module OpenStax::Connect
+  class ActionList
+
+    def initialize(options={})
+      @options = options
+
+      raise IllegalArgument, "must supply data procs" if options[:data_procs].nil?
+
+      if options[:headings].present? && options[:data_procs].size != options[:headings].size
+        raise IllegalArgument, "if you supply headings, you must supply one for each column"
+      end
+
+      if options[:widths].present? && options[:data_procs].size != options[:widths].size
+        raise IllegalArgument, "if you supply widths, you must supply one for each column"
+      end
+
+    end
+
+    def num_columns
+      @options[:data_procs].size
+    end
+
+    def has_headings?
+      @options[:headings].present?
+    end
+
+    def get_heading(column)
+      @options[:headings].nil? ? nil : @options[:headings][column]
+    end
+
+    def get_width(column)
+      @options[:widths].nil? ? nil : @options[:widths][column]
+    end
+
+    def get_data(column, *args)
+      @options[:data_procs][column].call(*args)
+    end
+
+  end
+end

data/lib/openstax/connect/engine.rb

@@ -0,0 +1,34 @@
+ActiveSupport::Inflector.inflections do |inflect|
+  inflect.acronym 'OpenStax'
+end
+
+require 'omniauth'
+require 'squeel'
+
+module OpenStax
+  module Connect
+    class Engine < ::Rails::Engine
+      isolate_namespace OpenStax::Connect
+
+      config.autoload_paths << File.expand_path("../../../app/algorithms", __FILE__)
+      config.autoload_paths << File.expand_path("../../../app/handlers", __FILE__)
+
+      config.generators do |g|
+        g.test_framework :rspec, :view_specs => false
+      end
+
+      # Doesn't work to put this omniauth code in an engine initializer, instead:
+      # https://gist.github.com/pablomarti/5243118
+      middleware.use ::OmniAuth::Builder do
+        provider :openstax, 
+                 OpenStax::Connect.configuration.openstax_application_id,
+                 OpenStax::Connect.configuration.openstax_application_secret
+      end
+
+      config.after_initialize do
+        # The omniauth strategy requires values given during application init
+        require "omniauth/strategies/openstax"
+      end
+    end
+  end
+end

data/lib/openstax/connect/route_helper.rb

@@ -0,0 +1,34 @@
+require 'singleton'
+
+module OpenStax
+  module Connect
+    class RouteHelper
+      
+      include Singleton
+
+      # Registers a path against a canonical name.  An optional
+      # block can be provided to give the stubbed path
+      def self.register_path(canonical_name, path, &block)
+        instance.paths[canonical_name] = path
+        if block.present? && OpenStax::Connect.configuration.enable_stubbing?
+          instance.stubbed_paths[canonical_name] = block.call
+        end
+      end
+
+      def self.get_path(canonical_name)
+        OpenStax::Connect.configuration.enable_stubbing? ?
+          instance.stubbed_paths[canonical_name] :
+          instance.paths[canonical_name]
+      end
+
+      def initialize
+        self.paths = {}
+        self.stubbed_paths = {}
+      end
+
+      attr_accessor :paths
+      attr_accessor :stubbed_paths
+
+    end
+  end
+end

data/lib/openstax/connect/utilities.rb

@@ -0,0 +1,12 @@
+module OpenStax
+  module Connect
+
+    class SecurityTransgression < StandardError; end
+    class AbstractMethodCalled < StandardError; end
+    class NotYetImplemented < StandardError; end
+    class IllegalArgument < StandardError; end
+    class IllegalState < StandardError; end
+    class IllegalOperation < StandardError; end
+
+  end
+end

data/lib/openstax/connect/version.rb

@@ -0,0 +1,5 @@
+module OpenStax
+  module Connect
+    VERSION = "0.0.1"
+  end
+end

data/lib/openstax_connect.rb

@@ -0,0 +1,72 @@
+require "openstax/connect/engine"
+require "openstax/connect/version"
+require "openstax/connect/utilities"
+require "openstax/connect/route_helper"
+require "openstax/connect/action_list"
+
+module OpenStax
+  module Connect
+
+    class << self
+
+      ###########################################################################
+      #
+      # Configuration machinery.
+      #
+      # To configure OpenStax Utilities, put the following code in your applications 
+      # initialization logic (eg. in the config/initializers in a Rails app)
+      #
+      #   OpenStax::Connect.configure do |config|
+      #     config.<parameter name> = <parameter value>
+      #     ...
+      #   end
+      #
+      # Set enable_stubbing to true iff you want this engine to fake all 
+      #   interaction with the services site.
+      #
+      
+      def configure
+        yield configuration
+      end
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      class Configuration
+        attr_accessor :openstax_application_id
+        attr_accessor :openstax_application_secret
+        attr_accessor :enable_stubbing
+        attr_reader :openstax_services_url
+        attr_accessor :logout_via
+        attr_accessor :default_errors_partial
+        attr_accessor :default_errors_html_id
+        attr_accessor :default_errors_added_trigger
+
+        def openstax_services_url=(url)
+          url.gsub!(/https|http/,'https') if !(url =~ /localhost/)
+          url = url + "/" if url[url.size-1] != '/'
+          @openstax_services_url = url
+        end
+
+        def initialize      
+          @openstax_application_id = 'SET ME!'
+          @openstax_application_secret = 'SET ME!'
+          @openstax_services_url = 'https://services.openstax.org/'
+          @enable_stubbing = true
+          @logout_via = :get
+          @default_errors_partial = 'openstax/connect/shared/attention'
+          @default_errors_html_id = 'openstax-connect-attention'
+          @default_errors_added_trigger = 'openstax-connect-errors-added'
+          super
+        end
+
+        def enable_stubbing?
+          !Rails.env.production? && enable_stubbing
+        end
+      end
+
+    end
+
+  end
+end

data/lib/tasks/connect-rails_tasks.rake

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