openstax_connect 0.0.1

data/MIT-LICENSE

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

@@ -0,0 +1,70 @@
+connect-rails
+=============
+
+A rails engine for interfacing with OpenStax's common services server.
+
+Usage
+-----
+
+Add the engine to your Gemfile and then run `bundle install`.  
+
+Mount the engine your application's `routes.rb` file:
+
+    MyApplication::Application.routes.draw do
+      ...
+      mount OpenStax::Connect::Engine, at: "/connect"
+      ...
+     end
+
+You can use whatever path you want instead of `/connect`, just make sure to make the appropriate changes below.
+
+Create an `openstax_connect.rb` initializer in `config/initializers`, with the following contents:
+
+    OpenStax::Connect.configure do |config|
+      config.openstax_application_id = 'value_from_openstax_services_here'
+      config.openstax_application_secret = 'value_from_openstax_services_here'
+    end
+
+If you're running OpenStax Services in a dev instance on your machine, you can specify that instance's local URL with:
+
+    config.openstax_services_url = 'http://localhost:2999/'
+
+To have users login, direct them to `/connect/sessions/new`.  This is also available through the `openstax_connect.login` route helper, e.g. `<%= link_to 'Sign in!', openstax_connect.login_path %>`.
+
+There is also a logout path helper for `/connect/sessions/destroy`, given by `logout_path`.  By default this expects a `GET` request.  If you'd prefer a `DELETE` request, add this configuration:
+
+    config.logout_via = :delete
+
+Make sure to install the engine's migrations:
+
+    rake openstax_connect:install:migrations
+
+Example Application
+-------------------
+
+There is an example application included in the gem in the `example` folder.  Here are steps
+to follow:
+
+1. Download (clone) the OpenStax Services site from github.com/openstax/services.  
+1. In the site's `config` folder put a `secret_settings.yml` file that has values for the 
+following keys: `facebook_app_id`, `facebook_app_secret`, `twitter_consumer_key`, `twitter_consumer_secret`.  If you
+don't have access to these values, you can always make dummy apps on facebook and twitter.
+2. Do the normal steps to get this site online: 
+    1. Run `bundle install --without production`
+    2. Run `bundle exec rake db:migrate`
+    3. Run `bundle exec rails server`
+2. Open this services site in a web browser (defaults to http://localhost:2999)
+3. Navigate to http://localhost:2999/oauth/applications
+4. Click `New application`
+    5. Set the callback URL to `http://localhost:4000/connect/auth/openstax/callback`.  
+Port 4000 is where you'll be running the example application.
+    1. The name can be whatever.
+    2. Click the `Trusted?` checkbox.
+    3. Click `Submit`.
+    4. Keep this window open so you can copy the application ID and secret into the example app
+5. Leave the services app running
+6. Download (clone) the OpenStax Connect gem from github.com/openstax/connect-rails.  The
+example application is in the `example` folder.  In that folder's config folder, create a `secret_settings.yml` file 
+according to the instructions in `secret_settings.yml.example`.  Run the example server in the normal way (bundle install..., migrate db, rails server).
+7. Navigate to the home page, http://localhost:4000.  Click log in and play around.  You can also refresh the services site and see yourself logged in, log out, etc.
+8. For fun, change example/config/openstax_connect.rb to set `enable_stubbing` to `true`.  Now when you click login you'll be taken to a developer-only page where you can login as other users, generate new users, create new users, etc.

data/Rakefile

@@ -0,0 +1,49 @@
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'
+
+# 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    = 'OpenstaxConnect'
+#   rdoc.options << '--line-numbers'
+#   rdoc.rdoc_files.include('README.rdoc')
+#   rdoc.rdoc_files.include('lib/**/*.rb')
+# end
+
+# APP_RAKEFILE = File.expand_path("../test/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
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/app/algorithms/openstax/connect/search_users.rb

@@ -0,0 +1,47 @@
+module OpenStax::Connect
+
+  class SearchUsers
+    include Lev::Algorithm
+
+  protected
+
+    def exec(terms, type=:any)
+      # Return empty results if no search terms
+      return User.where{id == nil}.where{id != nil} if terms.blank?
+
+      # Note: % is the wildcard. This allows the user to search
+      # for stuff that "begins with" but not "ends with".
+      case type
+      when :name
+        users = User.scoped
+        terms.gsub(/[%,]/, '').split.each do |t|
+          next if t.blank?
+          query = t + '%'
+          users = users.where{(first_name =~ query) | (last_name =~ query)}
+        end
+      when :username
+        query = terms.gsub('%', '') + '%'
+        users = where{username =~ query}
+      when :any
+        users = User.scoped
+        terms.gsub(/[%,]/, '').split.each do |t|
+          next if t.blank?
+          query = t + '%'
+          users = users.where{(first_name =~ query) | 
+                      (last_name =~ query) |
+                      (username =~ query)}
+        end
+      else
+        raise IllegalArgument, "Unknown user search type: #{type.to_s}"
+      end
+
+      return users
+    end
+
+    def self.default_transaction_isolation
+      Lev::TransactionIsolation.serializable
+    end
+
+  end
+
+end

data/app/assets/javascripts/openstax/connect/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/javascripts/openstax/connect/sessions.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/openstax/connect/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/assets/stylesheets/openstax/connect/dev.css.scss

@@ -0,0 +1,31 @@
+@mixin section-block-base($heading_font_size) {
+  margin:  5px 0px;
+
+  .section-block-heading {
+
+    color:     black;
+    font-size: $heading_font_size;
+
+    a { 
+      font-size: $heading_font_size; 
+    }
+  }
+
+  .section-block-body {
+    margin:  $heading_font_size/2 0px 0px;
+    padding: 0px 0px 0px $heading_font_size;
+  }
+}
+
+.section-block-section {
+  @include section-block-base(22px);
+}
+
+
+.section-block-section.nesting-2 {
+  @include section-block-base(14px);
+
+  .section-block-heading {
+    font-style: italic;
+  }
+}

data/app/assets/stylesheets/openstax/connect/sessions.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

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

@@ -0,0 +1,9 @@
+# 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
+
+  include Lev::HandleWith
+
+end

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

@@ -0,0 +1,16 @@
+require_dependency "openstax/connect/application_controller"
+
+module OpenStax
+  module Connect
+    module Dev
+      class DevController < ApplicationController
+
+        before_filter Proc.new{ 
+          raise SecurityTransgression unless !Rails.env.production? || 
+                                             current_user.is_administrator? 
+        }
+        
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+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/controllers/openstax/connect/dev/users_controller.rb

@@ -0,0 +1,28 @@
+module OpenStax
+  module Connect
+    module Dev
+      class UsersController < DevController
+
+        def index; end
+        
+        def create
+          handle_with(Dev::UsersCreate,
+                      success: lambda { redirect_to dev_users_path, notice: 'Success!'},
+                      failure: lambda { render 'index', alert: 'Error' })
+        end
+
+        def generate
+          handle_with(Dev::UsersGenerate,
+                      success: lambda { redirect_to dev_users_path, notice: 'Success!'},
+                      failure: lambda { render 'index', alert: 'Error' })
+        end
+
+        def search
+          handle_with(Dev::UsersSearch,
+                      complete: lambda { render 'search' })
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+require_dependency "openstax/connect/application_controller"
+
+module OpenStax
+  module Connect
+    class SessionsController < ApplicationController
+
+      def new
+        session[:return_to] = request.referrer
+        redirect_to RouteHelper.get_path(:login)
+      end
+
+      def omniauth_authenticated
+        handle_with(SessionsOmniauthAuthenticated,
+                    complete: lambda { 
+                      sign_in(@results[:user_to_sign_in])
+                      redirect_to return_path(true)
+                    })
+      end
+
+      def destroy
+        sign_out!
+        redirect_to return_path, notice: "Signed out!"
+      end
+
+      def failure
+        redirect_to return_path, alert: "Authentication failed, please try again."
+      end
+
+      def become
+        raise SecurityTransgression unless !Rails.env.production? || current_user.is_administrator?
+        sign_in(User.find(params[:user_id]))
+        redirect_to return_path(true)
+      end
+
+    protected
+
+      def return_path(include_referrer=false)
+        referrer = include_referrer ? request.referrer : nil
+        params[:return_to] || session.delete(:return_to) || referrer || main_app.root_path
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+class OpenStax::Connect::Dev::UsersCreate
+  include Lev::Handler
+
+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
+    end
+  
+    transfer_errors_from(u, :register)
+
+    results[:user] = u
+  end
+
+  def available_openstax_uid
+    (User.order("openstax_uid DESC").first.try(:openstax_uid) || 0) + 1
+  end
+
+end 

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

@@ -0,0 +1,36 @@
+module OpenStax::Connect::Dev
+  class UsersGenerate
+    include Lev::Handler
+
+  protected
+
+    paramify :generate do
+      attribute :count, type: Integer
+      validates :count, numericality: { only_integer: true,
+                                        greater_than_or_equal_to: 0 }
+    end
+
+    def authorized?
+      !Rails.env.production?
+    end
+
+    def exec
+      generate_params.count.times do 
+        while !(User.where(:username => (username = SecureRandom.hex(4))).empty?) do; end
+
+        u = User.create do |user|
+          user.first_name = "Jane#{username}"
+          user.last_name = "Doe#{username}"
+          user.username = username
+          user.is_administrator = false
+          user.openstax_uid = available_openstax_uid
+        end
+      end
+    end
+
+    def available_openstax_uid
+      (User.order("openstax_uid DESC").first.try(:openstax_uid) || 0) + 1
+    end
+
+  end 
+end

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

@@ -0,0 +1,64 @@
+module OpenStax::Connect::Dev
+  class UsersSearch
+
+    include Lev::Handler
+
+    paramify :search do
+      attribute :search_type, type: String
+      validates :search_type, presence: true,
+                              inclusion: { in: %w(Name Username Any),
+                                           message: "is not valid" }
+
+      attribute :search_terms, type: String
+      validates :search_terms, presence: true                               
+    end
+
+    uses_routine OpenStax::Connect::SearchUsers, as: :search_users
+
+  protected
+
+    def authorized?
+      !Rails.env.production? || caller.is_administrator?
+    end
+
+    def exec
+      terms = search_params.search_terms
+      type = search_params.search_type
+
+      # results[:users] = run(OpenStax::Connect::SearchUsers, terms, type.downcase.to_sym)
+      # results[:users] = run(:openstax_connect_search_users, terms, type.downcase.to_sym)
+      results[:users] = run(:search_users, terms, type.downcase.to_sym)
+
+      # if terms.blank?
+      #   users = User.where{id == nil}.where{id != nil} # Empty
+      # else
+      #   # Note: % is the wildcard. This allows the user to search
+      #   # for stuff that "begins with" but not "ends with".
+      #   case type
+      #   when 'Name'
+      #     users = User.scoped
+      #     terms.gsub(/[%,]/, '').split.each do |t|
+      #       next if t.blank?
+      #       query = t + '%'
+      #       users = users.where{(first_name =~ query) | (last_name =~ query)}
+      #     end
+      #   when 'Username'
+      #     query = terms.gsub('%', '') + '%'
+      #     users = where{username =~ query}
+      #   else # Any
+      #     users = User.scoped
+      #     terms.gsub(/[%,]/, '').split.each do |t|
+      #       next if t.blank?
+      #       query = t + '%'
+      #       users = users.where{(first_name =~ query) | 
+      #                   (last_name =~ query) |
+      #                   (username =~ query)}
+      #     end
+      #   end
+      # end
+
+      # results[:users] = users
+    end
+
+  end
+end

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

@@ -0,0 +1,35 @@
+module OpenStax::Connect
+
+  class SessionsOmniauthAuthenticated
+    include Lev::Handler
+
+  protected
+
+    def setup
+      @auth_data = request.env['omniauth.auth']
+    end
+
+    def authorized?
+      @auth_data.provider == "openstax"
+    end
+
+    def exec
+      results[:user_to_sign_in] = user_to_sign_in
+    end
+
+    def user_to_sign_in
+      return caller if 
+        !caller.nil? && 
+        !caller.is_anonymous? &&
+        caller.openstax_uid == @auth_data.uid
+
+      existing_user = User.where(openstax_uid: @auth_data.uid).first
+      return existing_user if !existing_user.nil?
+
+      return User.create do |user|
+        user.openstax_uid = @auth_data.uid
+      end
+    end
+  end
+
+end

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

@@ -0,0 +1,20 @@
+module OpenStax
+  module Connect
+    module ApplicationHelper
+
+      def unless_errors(options={}, &block)
+        options[:errors] ||= @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
+
+        if options[:errors].any? || flash[:alert]
+          "$('##{options[:errors_html_id]}').html('#{ j(render options[:errors_partial], errors: options[:errors]) }').trigger('#{options[:trigger]}');".html_safe
+        else
+          ("$('##{options[:errors_html_id]}').html('');" + capture(&block)).html_safe
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,4 @@
+module OpenStax::Connect
+  module SessionsHelper
+  end
+end

data/app/models/anonymous_user.rb

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

@@ -0,0 +1,21 @@
+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/app/views/layouts/openstax/connect/application.html.erb

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