openstax_utilities 3.0.0 → 4.0.0

data/spec/dummy/config/initializers/mime_types.rb

@@ -2,4 +2,3 @@
 
 # Add new mime types for use in respond_to blocks:
 # Mime::Type.register "text/richtext", :rtf
-# Mime::Type.register_alias "text/html", :iphone

data/spec/dummy/config/initializers/session_store.rb

@@ -1,8 +1,3 @@
 # Be sure to restart your server when you modify this file.
 
-Dummy::Application.config.session_store :cookie_store, key: '_dummy_session'
-
-# Use the database for sessions instead of the cookie-based default,
-# which shouldn't be used to store highly confidential information
-# (create the session table with "rails generate session_migration")
-# Dummy::Application.config.session_store :active_record_store
+Rails.application.config.session_store :cookie_store, key: '_dummy_session'

data/spec/dummy/config/initializers/wrap_parameters.rb

@@ -1,14 +1,14 @@
 # Be sure to restart your server when you modify this file.
-#
+
 # This file contains settings for ActionController::ParamsWrapper which
 # is enabled by default.
 
 # Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
 ActiveSupport.on_load(:action_controller) do
-  wrap_parameters format: [:json]
+  wrap_parameters format: [:json] if respond_to?(:wrap_parameters)
 end
 
-# Disable root element in JSON by default.
-ActiveSupport.on_load(:active_record) do
-  self.include_root_in_json = false
-end
+# To enable root element in JSON for ActiveRecord objects.
+# ActiveSupport.on_load(:active_record) do
+#  self.include_root_in_json = true
+# end

data/spec/dummy/config/locales/en.yml

@@ -1,5 +1,23 @@
-# Sample localization file for English. Add more files in this directory for other locales.
-# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+# Files in the config/locales directory are used for internationalization
+# and are automatically loaded by Rails. If you want to use locales other
+# than English, add the necessary files in this directory.
+#
+# To use the locales, use `I18n.t`:
+#
+#     I18n.t 'hello'
+#
+# In views, this is aliased to just `t`:
+#
+#     <%= t('hello') %>
+#
+# To use a different locale, set it with `I18n.locale`:
+#
+#     I18n.locale = :es
+#
+# This would use the information in config/locales/es.yml.
+#
+# To learn more, please read the Rails Internationalization guide
+# available at http://guides.rubyonrails.org/i18n.html.
 
 en:
   hello: "Hello world"

data/spec/dummy/config/routes.rb

@@ -1,5 +1,2 @@
 Rails.application.routes.draw do
-  resources :users
-
-  mount OpenStax::Utilities::Engine => "/openstax_utilities"
 end

data/spec/dummy/config/secrets.yml

@@ -0,0 +1,22 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key is used for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+# You can use `rake secret` to generate a secure secret key.
+
+# Make sure the secrets in this file are kept private
+# if you're sharing your code publicly.
+
+development:
+  secret_key_base: 29e54ca73023838b463db707b1229ec66e43c4fb9a6302b136f4a09ba9f14fcfe39bf238f139a8475a6840e9a197abfbef5034ff1e227551cd914bac2000d958
+
+test:
+  secret_key_base: e96d972e503764aa27f184c2c9e1e14598be32d4471d93ffbeed148df0c8af572e7e9e60dfb32d21176118ace6a5de4075be4671d03937e6aa15527ea1800383
+
+# Do not keep production secrets in the repository,
+# instead read values from the environment.
+production:
+  secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>

data/spec/dummy/db/migrate/0_create_users.rb

@@ -1,10 +1,16 @@
 class CreateUsers < ActiveRecord::Migration
   def change
     create_table :users do |t|
-      t.string :username
-      t.string :password_hash
+      t.string :username, null: false
+      t.string :password_hash, null: false
+      t.string :name, null: false
+      t.string :email, null: false
 
       t.timestamps
     end
+
+    add_index :users, :username
+    add_index :users, :name
+    add_index :users, :email
   end
 end

data/spec/dummy/db/schema.rb

@@ -9,15 +9,21 @@
 # from scratch. The latter is a flawed and unsustainable approach (the more migrations
 # you'll amass, the slower it'll run and the greater likelihood for issues).
 #
-# It's strongly recommended to check this file into your version control system.
+# It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 0) do
+ActiveRecord::Schema.define(version: 0) do
 
-  create_table "users", :force => true do |t|
-    t.string   "username"
-    t.string   "password_hash"
-    t.datetime "created_at",    :null => false
-    t.datetime "updated_at",    :null => false
+  create_table "users", force: true do |t|
+    t.string   "username",      null: false
+    t.string   "password_hash", null: false
+    t.string   "name",          null: false
+    t.string   "email",         null: false
+    t.datetime "created_at"
+    t.datetime "updated_at"
   end
 
+  add_index "users", ["email"], name: "index_users_on_email"
+  add_index "users", ["name"], name: "index_users_on_name"
+  add_index "users", ["username"], name: "index_users_on_username"
+
 end

data/spec/dummy/public/404.html

@@ -2,25 +2,66 @@
 <html>
 <head>
   <title>The page you were looking for doesn't exist (404)</title>
-  <style type="text/css">
-    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
-    div.dialog {
-      width: 25em;
-      padding: 0 4em;
-      margin: 4em auto 0 auto;
-      border: 1px solid #ccc;
-      border-right-color: #999;
-      border-bottom-color: #999;
-    }
-    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+
+  div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
   </style>
 </head>
 
 <body>
   <!-- This file lives in public/404.html -->
   <div class="dialog">
-    <h1>The page you were looking for doesn't exist.</h1>
-    <p>You may have mistyped the address or the page may have moved.</p>
+    <div>
+      <h1>The page you were looking for doesn't exist.</h1>
+      <p>You may have mistyped the address or the page may have moved.</p>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
   </div>
 </body>
 </html>

data/spec/dummy/public/422.html

@@ -2,25 +2,66 @@
 <html>
 <head>
   <title>The change you wanted was rejected (422)</title>
-  <style type="text/css">
-    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
-    div.dialog {
-      width: 25em;
-      padding: 0 4em;
-      margin: 4em auto 0 auto;
-      border: 1px solid #ccc;
-      border-right-color: #999;
-      border-bottom-color: #999;
-    }
-    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+
+  div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
   </style>
 </head>
 
 <body>
   <!-- This file lives in public/422.html -->
   <div class="dialog">
-    <h1>The change you wanted was rejected.</h1>
-    <p>Maybe you tried to change something you didn't have access to.</p>
+    <div>
+      <h1>The change you wanted was rejected.</h1>
+      <p>Maybe you tried to change something you didn't have access to.</p>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
   </div>
 </body>
 </html>

data/spec/dummy/public/500.html

@@ -2,24 +2,65 @@
 <html>
 <head>
   <title>We're sorry, but something went wrong (500)</title>
-  <style type="text/css">
-    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
-    div.dialog {
-      width: 25em;
-      padding: 0 4em;
-      margin: 4em auto 0 auto;
-      border: 1px solid #ccc;
-      border-right-color: #999;
-      border-bottom-color: #999;
-    }
-    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+
+  div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
   </style>
 </head>
 
 <body>
   <!-- This file lives in public/500.html -->
   <div class="dialog">
-    <h1>We're sorry, but something went wrong.</h1>
+    <div>
+      <h1>We're sorry, but something went wrong.</h1>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
   </div>
 </body>
 </html>

data/spec/factories/user.rb

@@ -0,0 +1,8 @@
+FactoryGirl.define do
+  factory :user do
+    username { SecureRandom.hex.to_s }
+    password_hash { SecureRandom.hex.to_s }
+    name { Faker::Name.name }
+    email { Faker::Internet.email }
+  end
+end

data/spec/handlers/openstax/utilities/abstract_keyword_search_handler_spec.rb

@@ -0,0 +1,93 @@
+require 'rails_helper'
+
+module OpenStax
+  module Utilities
+    describe AbstractKeywordSearchHandler do
+
+      let!(:users_search) { UsersSearch.new }
+
+      let!(:john_doe) { FactoryGirl.create :user, name: "John Doe",
+                                           username: "doejohn",
+                                           email: "john@doe.com" }
+
+      let!(:jane_doe) { FactoryGirl.create :user, name: "Jane Doe",
+                                           username: "doejane",
+                                           email: "jane@doe.com" }
+
+      let!(:jack_doe) { FactoryGirl.create :user, name: "Jack Doe",
+                                           username: "doejack",
+                                           email: "jack@doe.com" }
+
+      before(:each) do
+        100.times do
+          FactoryGirl.create(:user)
+        end
+      end
+
+      it "passes its params to the search routine and sets the total_count output" do
+        outputs = users_search.call(params: {q: 'username:dOe'}).outputs
+        total_count = outputs[:total_count]
+        items = outputs[:items]
+        expect(total_count).to eq items.count
+        expect(items).to include(john_doe)
+        expect(items).to include(jane_doe)
+        expect(items).to include(jack_doe)
+        john_index = items.index(john_doe)
+        jane_index = items.index(jane_doe)
+        jack_index = items.index(jack_doe)
+        expect(jane_index).to be > john_index
+        expect(jack_index).to be > jane_index
+        items.each do |item|
+          expect(item.username).to match(/\Adoe[\w]*\z/i)
+        end
+
+        outputs = users_search.call(params: {order_by: 'cReAtEd_At DeSc, iD dEsC',
+                                             q: 'username:DoE'}).outputs
+        total_count = outputs[:total_count]
+        items = outputs[:items]
+        expect(total_count).to eq items.count
+        expect(items).to include(john_doe)
+        expect(items).to include(jane_doe)
+        expect(items).to include(jack_doe)
+        john_index = items.index(john_doe)
+        jane_index = items.index(jane_doe)
+        jack_index = items.index(jack_doe)
+        expect(jane_index).to be < john_index
+        expect(jack_index).to be < jane_index
+        items.each do |item|
+          expect(item.username).to match(/\Adoe[\w]*\z/i)
+        end
+      end
+
+      it "errors out if no query is provided" do
+        routine = users_search.call(params: {})
+        outputs = routine.outputs
+        errors = routine.errors
+        expect(outputs).to be_empty
+        expect(errors).not_to be_empty
+        expect(errors.first.code).to eq :no_query
+      end
+
+      it "errors out if the query is too short" do
+        routine = users_search.call(params: {q: 'a'})
+        outputs = routine.outputs
+        errors = routine.errors
+        expect(outputs).to be_empty
+        expect(errors).not_to be_empty
+        expect(errors.first.code).to eq :query_too_short
+      end
+
+      it "errors out if too many items match" do
+        routine = users_search.call(params: {q: 'username:a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w,x,y,z,0,1,2,3,4,5,6,7,8,9,-,_'})
+        outputs = routine.outputs
+        errors = routine.errors
+        expect(outputs).not_to be_empty
+        expect(outputs[:total_count]).to eq User.count
+        expect(outputs[:items]).to be_nil
+        expect(errors).not_to be_empty
+        expect(errors.first.code).to eq :too_many_matches
+      end
+
+    end
+  end
+end