quick_search-core 0.0.1.test

data/config/routes.rb

@@ -0,0 +1,81 @@
+QuickSearch::Engine.routes.draw do
+
+  root 'search#index'
+
+  get 'xhr_search' => 'search#xhr_search', :defaults => { :format => 'html' }
+  get 'log_event' => 'search#log_event'
+  get 'log_search' => 'search#log_search'
+
+  get 'searcher/:searcher_name' => 'search#single_searcher'
+  get 'searcher/:searcher_name/xhr_search' => 'search#xhr_search', :defaults => { :format => 'html' }
+  get 'searcher/:searcher_name/log_event' => 'search#log_event'
+  get 'searcher/:searcher_name/log_search' => 'search#log_search'
+
+
+  get 'opensearch' => 'opensearch#opensearch', :defaults => { :format => 'xml' }
+
+  get 'about' => 'pages#about'
+  get 'realtime' => 'pages#realtime'
+
+  match 'appstats', to: 'appstats#index', via: [:get, :post]
+  match 'appstats/clicks_overview', to: 'appstats#clicks_overview', as: 'clicks_overview', via: [:get, :post]
+  match 'appstats/top_searches', to: 'appstats#top_searches', as: 'top_searches', via: [:get, :post]
+  match 'appstats/top_spot', to: 'appstats#top_spot', as: 'top_spot', via: [:get, :post]
+  match 'appstats/detail/:ga_scope', to: 'appstats#detail', via: [:get, :post]
+  get 'appstats/realtime' => 'appstats#realtime'
+
+  # The priority is based upon order of creation: first created -> highest priority.
+  # See how all your routes lay out with "rake routes".
+
+  # You can have the root of your site routed with "root"
+  # root 'welcome#index'
+
+  # Example of regular route:
+  #   get 'products/:id' => 'catalog#view'
+
+  # Example of named route that can be invoked with purchase_url(id: product.id)
+  #   get 'products/:id/purchase' => 'catalog#purchase', as: :purchase
+
+  # Example resource route (maps HTTP verbs to controller actions automatically):
+  #   resources :products
+
+  # Example resource route with options:
+  #   resources :products do
+  #     member do
+  #       get 'short'
+  #       post 'toggle'
+  #     end
+  #
+  #     collection do
+  #       get 'sold'
+  #     end
+  #   end
+
+  # Example resource route with sub-resources:
+  #   resources :products do
+  #     resources :comments, :sales
+  #     resource :seller
+  #   end
+
+  # Example resource route with more complex sub-resources:
+  #   resources :products do
+  #     resources :comments
+  #     resources :sales do
+  #       get 'recent', on: :collection
+  #     end
+  #   end
+
+  # Example resource route with concerns:
+  #   concern :toggleable do
+  #     post 'toggle'
+  #   end
+  #   resources :posts, concerns: :toggleable
+  #   resources :photos, concerns: :toggleable
+
+  # Example resource route within a namespace:
+  #   namespace :admin do
+  #     # Directs /admin/products/* to Admin::ProductsController
+  #     # (app/controllers/admin/products_controller.rb)
+  #     resources :products
+  #   end
+end

data/db/migrate/20140130202859_create_events.rb

@@ -0,0 +1,11 @@
+class CreateEvents < ActiveRecord::Migration
+  def change
+    create_table :events do |t|
+      t.string :category
+      t.string :action
+      t.string :label
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20140130202944_create_searches.rb

@@ -0,0 +1,9 @@
+class CreateSearches < ActiveRecord::Migration
+  def change
+    create_table :searches do |t|
+      t.string :query
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20140225145441_add_page_to_searches.rb

@@ -0,0 +1,5 @@
+class AddPageToSearches < ActiveRecord::Migration
+  def change
+    add_column :searches, :page, :string
+  end
+end

data/db/schema.rb

@@ -0,0 +1,31 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# 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 that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 20140225145441) do
+
+  create_table "events", force: true do |t|
+    t.string   "category"
+    t.string   "action"
+    t.string   "label"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "searches", force: true do |t|
+    t.string   "query"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+    t.string   "page"
+  end
+
+end

data/db/seeds.rb

@@ -0,0 +1,7 @@
+# This file should contain all the record creation needed to seed the database with its default values.
+# The data can then be loaded with the rake db:seed (or created alongside the db with db:setup).
+#
+# Examples:
+#
+#   cities = City.create([{ name: 'Chicago' }, { name: 'Copenhagen' }])
+#   Mayor.create(name: 'Emanuel', city: cities.first)

data/lib/benchmark_logger.rb

@@ -0,0 +1,2 @@
+BenchmarkLogger = ActiveSupport::Logger.new(Rails.root.join('log/benchmark.log'))
+BenchmarkLogger.formatter = Logger::Formatter.new

data/lib/capistrano/tasks/access_check.cap

@@ -0,0 +1,10 @@
+desc "Check that we can access everything"
+task :check_write_permissions do
+  on roles(:all) do |host|
+    if test("[ -w #{fetch(:deploy_to)} ]")
+      info "#{fetch(:deploy_to)} is writable on #{host}"
+    else
+      error "#{fetch(:deploy_to)} is not writable on #{host}"
+    end
+  end
+end

data/lib/generators/quick_search/install_generator.rb

@@ -0,0 +1,49 @@
+module QuickSearch
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      desc 'insert routes'
+      def insert_routes
+        routes = <<-ROUTES
+  mount QuickSearch::Engine => "/"
+ROUTES
+        insert_into_file "config/routes.rb", routes, :after => "Rails.application.routes.draw do\n"
+      end
+
+      desc 'create application configuration file'
+      def quick_search_config_yml
+        copy_file 'quick_search_config.yml', 'config/quick_search_config.yml'
+      end
+
+      desc 'create kaminari initializer'
+      def kaminari_initializer
+        copy_file 'kaminari.rb', 'config/initializers/kaminari.rb'
+      end
+
+      desc 'add styles'
+      def add_styles
+        remove_file 'app/assets/stylesheets/application.css'
+        create_file 'app/assets/stylesheets/application.css.scss', %Q|@import "quick_search";\n|
+      end
+
+      desc 'add javascript'
+      def add_javascript
+        gsub_file('app/assets/javascripts/application.js', '//= require_tree .', '//= require quick_search')
+      end
+
+      desc 'install migrations'
+      def install_migrations
+        rake "quick_search:install:migrations"
+        rake "db:migrate"
+      end
+
+      desc 'display messages about what needs to be configured'
+      def configuration_messages
+        file = File.read(File.join( File.expand_path('../templates', __FILE__), 'post_install.txt'))
+        say file, :green
+      end
+
+    end
+  end
+end

data/lib/generators/quick_search/templates/kaminari.rb

@@ -0,0 +1,5 @@
+Kaminari.configure do |config|
+  # FIXME: This should be set per searcher in the main quicksearch config
+  config.default_per_page = 20
+  config.window = 3
+end

data/lib/generators/quick_search/templates/post_install.txt

@@ -0,0 +1,8 @@
+QuickSearch installation complete. To add searchers:
+
+1. Add searcher gems (see README for list of gems) to your project's Gemfile
+2. Add a theme gem to Gemfile (see README)
+3. Add the searchers/theme to quick_search_config.yml
+4. Add render_module calls to search results view for each searcher
+
+For more information, see README and other documentation at http://github.com/ncsu-libraries/quick_search/

data/lib/generators/quick_search/templates/quick_search_config.yml

@@ -0,0 +1,58 @@
+defaults: &defaults
+  theme: 'quick_search_generic_theme'
+  searchers: [best_bets,arxiv,open_library,wikipedia,placeholder]
+  found_types: [arxiv,open_library,wikipedia,placeholder,placeholder,placeholder,placeholder]
+  per_page: 3
+  max_per_page: 50
+  http_timeout: 1.5
+  xhr_http_timeout: 15
+# google_analytics_tracking_id: ""
+  user: "stats"
+  password: "stats"
+
+  on_campus:
+    - !ruby/regexp '/^192\.(1|168)\.\d*\.\d*$/'
+
+
+  common_searches: ["web of science", "google scholar", "refworks", "harvard business review", "pubmed", "ieee"]
+
+  common_website_searches: ["dissertations", "exhibits", "textbooks", "visit the libraries", "government information", "literature review", "printing"]
+
+  loaded_searches:
+    - name: "Google Scholar"
+      landing_page: "http://scholar.google.com/"
+      query: "https://scholar.google.com/scholar?hl=en&q="
+    - name: "WorldCat"
+      landing_page: "https://www.worldcat.org"
+      query: "https://www.worldcat.org/search?qt=worldcat_org_all&q="
+    - name: "Google"
+      landing_page: "https://www.google.com/"
+      query: "https://www.google.com/#q="
+
+  loaded_website_searches:
+    - name: "Books, Articles, Journals & More"
+      landing_page: "http://search.lib.ncsu.edu"
+      query: "http://search.lib.ncsu.edu/?q="
+
+  doi_loaded_link: "http://doi.org/"
+
+  best_bets:
+    solr_url: "http://localhost:8983/solr/bestbets/select?"
+
+development:
+  <<: *defaults
+#  realtime_url: http://path_to_websockets_server
+
+test:
+  <<: *defaults
+
+staging:
+  <<: *defaults
+#  realtime_url: http://path_to_websockets_server
+#  google_analytics_tracking_id: ""
+
+
+production:
+  <<: *defaults
+#  realtime_url: http://path_to_websockets_server
+  # Add or override config options here

data/lib/quick_search/engine.rb

@@ -0,0 +1,16 @@
+module QuickSearch
+  class Engine < ::Rails::Engine
+    isolate_namespace QuickSearch
+
+    initializer :quick_search, :after => :add_view_paths do
+      config_file = File.join(Rails.root, "/config/quick_search_config.yml")
+      if File.exist?(config_file)
+        APP_CONFIG = YAML.load_file(config_file)[Rails.env]
+        ActiveSupport.on_load(:action_controller) do
+          theme_engine_class = "#{QuickSearch::Engine::APP_CONFIG['theme'].classify}::Engine".constantize
+          prepend_view_path theme_engine_class.root.join('app', 'views', QuickSearch::Engine::APP_CONFIG['theme'])
+        end
+      end
+    end
+  end
+end

data/lib/quick_search/version.rb

@@ -0,0 +1,3 @@
+module QuickSearch
+  VERSION = "0.0.1.test"
+end

data/lib/quick_search.rb

@@ -0,0 +1,12 @@
+require "quick_search/engine"
+
+require "httpclient"
+require "kaminari"
+require "nokogiri"
+require "mysql2"
+require "rsolr"
+require "exception_notification"
+require "newrelic_rpm" #required?
+
+module QuickSearch
+end

data/lib/tasks/best_bets.rake

@@ -0,0 +1,29 @@
+namespace :best_bets do
+  desc 'Update the BestBets SOLR index from best_bets.yml'
+  task :update_index => :environment do
+    best_bets_yaml = File.join Rails.root, "/config/best_bets.yml"
+    best_bets = YAML.load_file(best_bets_yaml)['best_bets']
+
+    solr = RSolr.connect :url => QuickSearch::Engine::APP_CONFIG['best_bets']['solr_url']
+
+    solr.delete_by_query('*:*') 
+
+    records = []
+
+    best_bets.each do |id, value|
+        record = {
+            :id => id,
+            :title => value['title'],
+            :url => value['url'],
+            :description => value['description'],
+            :keywords => value['keywords']
+        }
+        records << record
+    end
+
+    solr.add(records)
+    solr.commit
+
+  end
+
+end

data/test/controllers/appstats_controller_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class AppstatsControllerTest < ActionController::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end

data/test/controllers/concerns/doi_trap_test.rb

@@ -0,0 +1,19 @@
+require 'test_helper'
+
+class DoiTrapTest < ActionController::TestCase
+
+  include DoiTrap
+
+  test "should be a doi" do
+    doi = '10.1016/0046-8177(95)90302-X'
+    is_a_doi = is_a_doi?(doi)
+    assert is_a_doi
+  end
+
+  test "should not be a doi" do
+    doi = '0046-8177(95)90302-X'
+    is_a_doi = is_a_doi?(doi)
+    assert_not is_a_doi  
+  end
+
+end

data/test/controllers/concerns/on_campus_test.rb

@@ -0,0 +1,19 @@
+require 'test_helper'
+
+class OnCampusTest < ActionController::TestCase
+
+  include OnCampus
+
+  test "should be on campus" do
+    ip = '152.14.1.1'
+    on_campus = on_campus?(ip)
+    assert on_campus
+  end
+
+  test "should not be on campus" do
+    ip = '152.2.1.1'
+    on_campus = on_campus?(ip)
+    assert_not on_campus  
+  end
+
+end

data/test/controllers/concerns/query_parser_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+
+class QueryParserTest < ActionController::TestCase
+
+  include QueryParser
+
+  test "should extract basic prefixed scoped query" do
+    full_query = 'scope:scrc libraries'
+    
+    query = extracted_query(full_query)
+    assert_equal('libraries', query)
+
+    scope = extracted_scope(full_query)
+    assert_equal('scrc', scope)
+  end
+
+  test "should extract basic suffixed scoped query" do
+    full_query = 'libraries scope:scrc'
+    
+    query = extracted_query(full_query)
+    assert_equal('libraries', query)
+
+    scope = extracted_scope(full_query)
+    assert_equal('scrc', scope)
+  end
+
+  test "should extract compound prefixed scoped query" do
+    full_query = 'scope:(scrc OR jobs) libraries'
+    
+    query = extracted_query(full_query)
+    assert_equal('libraries', query)
+
+    scope = extracted_scope(full_query)
+    assert_equal('scrc OR jobs', scope)
+  end
+
+  test "should extract compound suffixed scoped query" do
+    full_query = 'libraries scope:(scrc OR jobs)'
+    
+    query = extracted_query(full_query)
+    assert_equal('libraries', query)
+
+    scope = extracted_scope(full_query)
+    assert_equal('scrc OR jobs', scope)
+  end
+
+end

data/test/controllers/opensearch_controller_test.rb

@@ -0,0 +1,13 @@
+require 'test_helper'
+
+class OpensearchControllerTest < ActionController::TestCase
+
+  test "should return xml" do
+    @request.env['HTTP_ACCEPT'] = 'application/xml'
+    get :opensearch
+
+    assert_response :success
+    assert_select 'OpenSearchDescription'
+  end
+
+end

data/test/controllers/pages_controller_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class PagesControllerTest < ActionController::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end

data/test/controllers/search_controller_test.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+
+class SearchControllerTest < ActionController::TestCase
+
+  vcr_test "should return a summon searcher" do
+    get :index, q: 'printing'
+    assert assigns(:summon)
+  end
+
+  test "should redirect to link resolver" do
+    get :index, q: 'doi:10.1002/0470841559.ch1'
+    assert_redirected_to 'http://js8lb8ft5y.search.serialssolutions.com/criteriarefiner/?SS_doi=10.1002/0470841559.ch1'
+  end
+
+end

data/test/fixtures/events.yml

@@ -0,0 +1,11 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+
+one:
+  category: MyString
+  action: MyString
+  label: MyString
+
+two:
+  category: MyString
+  action: MyString
+  label: MyString

data/test/fixtures/searches.yml

@@ -0,0 +1,7 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+
+one:
+  query: MyString
+
+two:
+  query: MyString

data/test/helpers/appstats_helper_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+class AppstatsHelperTest < ActionView::TestCase
+end

data/test/helpers/opensearch_helper_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+class OpensearchHelperTest < ActionView::TestCase
+end

data/test/helpers/pages_helper_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+class PagesHelperTest < ActionView::TestCase
+end

data/test/helpers/search_helper_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+class SearchHelperTest < ActionView::TestCase
+end

data/test/integration/catalog_search_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class CatalogSearchTest < ActionDispatch::IntegrationTest
+  vcr_test "should show catalog results", 'searches', cassette: 'printing' do
+    visit root_path(q: 'printing')
+    assert page.has_content?('book results')
+  end
+end

data/test/integration/google_analytics_test.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+class GoogleAnalyticsTest < ActionDispatch::IntegrationTest
+  
+  # FIXME maybe should use puffing-billy gem for this?
+  setup do
+    WebMock.disable!
+    Capybara.current_driver = Capybara.javascript_driver
+    visit root_path(q: 'printing')
+  end
+
+  test "should capture google analytics data for all links in module" do
+    within("#catalog") do
+      click_link('Books & Media')
+    end
+    assert page.has_content?('heading')
+
+    click_link('book results')
+    assert page.has_content?('see-all-results')
+
+  end
+
+end

data/test/integration/landing_page_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class LandingPageTest < ActionDispatch::IntegrationTest
+  test "should have a search box" do
+    visit root_path
+    assert page.has_selector?('#main-search-form')
+  end
+end

data/test/integration/searching_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+
+class SearchingTest < ActionDispatch::IntegrationTest
+
+  vcr_test "search box should give search results", "searches", cassette: 'printing' do
+    visit root_path
+    within('#quicksearch') do
+      fill_in :q, with: 'printing'
+      click_on('Search')
+      assert page.has_content?('Articles')
+    end
+  end
+
+  vcr_test "should have article results", "searches", cassette: 'printing' do
+    visit root_path
+    within('#quicksearch') do
+      fill_in :q, with: 'printing'
+      click_on('Search')
+      assert page.has_content?('Beginning Os X Lion Apps ')
+    end
+  end
+
+  vcr_test "should present a spelling suggestion", "searches", cassette: 'speling' do
+    visit root_path
+    within('#quicksearch') do
+      fill_in :q, with: 'speling'
+      click_on('Search')
+      assert page.has_content?('Did you mean')
+    end
+  end
+
+  vcr_test "should have FAQ results", "searches", cassette: 'printing' do
+    visit root_path
+    within('#quicksearch') do
+      fill_in :q, with: 'printing'
+      click_on('Search')
+      assert page.has_content?('Where is the Makerspace in Hunt Library')
+    end
+  end
+end

data/test/integration/smart_subjects_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class SmartSubjectsSearchTest < ActionDispatch::IntegrationTest
+  vcr_test "should show smart subjects results", 'searches', cassette: 'printing' do
+    visit root_path(q: 'printing')
+    assert page.has_content?('Textile Chemistry')
+  end
+end

data/test/integration/website_search_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class WebsiteSearchTest < ActionDispatch::IntegrationTest
+  vcr_test "should show website results", 'searches', cassette: 'printing' do
+    visit root_path(q: 'printing')
+    assert page.has_content?('Our Website')
+  end
+end

data/test/models/event_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class EventTest < ActiveSupport::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end

data/test/models/search_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class SearchTest < ActiveSupport::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end