quick_search-core 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 321f0450148c73d170124fa2c0ba56f5e2762a45
-  data.tar.gz: 0993b7ba6e88ba4f2f130be31fa081cfb5b04591
+  metadata.gz: 23539ea74f21394249a312b7eabb3931fb9db0ed
+  data.tar.gz: 2bd211e5230357b90c760babca649e4c4d7b138e
 SHA512:
-  metadata.gz: 36dad4fb86f7fd80d2e09962e0cf377b7dbfa4a11d6465a3a6879338a22cf75ddf02324cf7b5a4372a405e7c8e9c4287dfd7d32197e39b89a1332fbb1790f89e
-  data.tar.gz: 38a1a60600c059987b4db18f864cad3ef3d5f730ac7d653c8ff7d12d7796759f826b2be5b306fb7e554d5452bd7dd92690522a0a5a059bc3ac6d70b09f624546
+  metadata.gz: e71d9c5dbaf542ed012c57906721d8e6558083977b5b671d362711e57aa9268650f26c171ef754e33f30f0066c78e8401315ed35e2d021ffccd092b0dfba2129
+  data.tar.gz: e7228c8b1cd7d08a63fa0ca3f837bdcf92d986b2e00cd7bb689fd902ead185d939fc53783d98d6e495b11bfda82661981718ec8123f0d57e4be59b541b2f9119

data/README.md

@@ -4,6 +4,9 @@
 > looking for the original release of QuickSearch as a standalone Rails project, it can be found here:
 > https://github.com/NCSU-Libraries/quick_search/tree/pre-gem
 
+[![Build Status](https://travis-ci.org/NCSU-Libraries/quick_search.svg?branch=master)](https://travis-ci.org/NCSU-Libraries/quick_search)
+[![Gem Version](https://badge.fury.io/rb/quick_search-core.svg)](https://badge.fury.io/rb/quick_search-core)
+
 QuickSearch is a customized federated search tool designed to connect people to a variety of library resources, services, and tools. QuickSearch is designed to complement and increase use of existing dedicated library resource discovery tools, such as the catalog, electronic resource search, and subject guides/portals, by directing people to them via an intuitive search interface. The aim of QuickSearch is to provide people with a quick and easy way to find the information they need.
 
 For more information about NCSU Libraries' QuickSearch and the history of the project, see: http://www.lib.ncsu.edu/reports/quicksearch
@@ -27,52 +30,15 @@ production, but still should be considered an early release.
 
 ## Installation
 
-The aim of QuickSearch is to make it very easy to get up and running. There are several ways that you can go about installing it, depending on your situation.
-
-### Vagrant
-
-If you’re interested in trying out QuickSearch, or you’re a developer looking to get a development environment up and running, the easiest way is to use Vagrant to create a virtual environment which automatically installs QuickSearch and its dependencies in only a couple easy steps.
-
-This method uses Ansible playbooks to provision the virtual environment
-and install QuickSearch, so it is a good guide to see how you might
-configure a server for a QuickSearch production envrionment.
-
-#### Prerequisites
-
-- Vagrant 1.8+ (http://www.vagrantup.com)
-- VirtualBox (https://www.virtualbox.org/wiki/Downloads)
-
-#### Instructions
-
-##### Clone this repository
-
-    git clone git@github.com:ncsu-libraries/quick_search
-
-##### Change into the cloned directory
-
-    cd quick_search
-
-##### Run
+The aim of QuickSearch is to make it very easy to get up and running.
 
-    vagrant up
-
-> Note: sometimes the provisioning process will hang at the "dev-bundle |
-bundle install" step. If this happens, press Ctrl+C to kill the process,
-then run the following command to continue the provisioning process:
-
-    vagrant provision
-
-#####Once this completes, you'll have a running instance of QuickSearch available at http://localhost:8888/
-
-### Manual Installation
-
-Follow these instructions to manually install QuickSearch for
+Follow these instructions to install QuickSearch for
 development.
 
 #### Prerequisites
 
-- Rails 4.1
-- Ruby 2.1
+- Rails 5.0
+- Ruby 2.2.2+ or 2.3.x
 - MySQL development headers (mysql-devel package on CentOS)
 - qtwebkit development headers (qtwebkit-devel package on CentOS)
 
@@ -86,11 +52,11 @@ development.
 
     cd my_app
 
-##### Add quick_search_core gem to your Gemfile:
+##### Add quick_search-core gem to your Gemfile:
 
     gem 'quick_search-core'
 
-> For development, use: gem 'quick_search-core', :git => 'git://github.com/NCSU-Libraries/quick_search.git'
+> For development, use: gem 'quick_search-core', git: 'git://github.com/NCSU-Libraries/quick_search.git'
 
 ##### Run 'bundle install'
 
@@ -98,7 +64,9 @@ development.
 
     bundle exec rails generate quick_search:install
 
-##### Configure QuickSearch (see [Configuring QuickSearch](docs/configuration.md))
+The generator will install the generic QuickSearch theme, and some
+searchers that will work out of the box. For more information on further
+configuring QuickSearch, see: [Configuring QuickSearch](docs/configuration.md)
 
 ##### Start the server:
 
@@ -124,29 +92,48 @@ For more in-depth documentation about this, see:
 Here are a list of searchers that have been created for QuickSearch so
 far. Feel free to submit a pull request to add to this list.
 
-|Searcher                |Repository URL                                                        |
-|------------------------|----------------------------------------------------------------------|
-|arXiv                   |http://github.com/NCSU-Libraries/quick_search-arxiv_searcher          |
-|Wikipedia               |http://github.com/NCSU-Libraries/quick_search-wikipedia_searcher      |
-|OpenLibrary             |http://github.com/NCSU-Libraries/quick_search-open_library_searcher   |
-|Summon                  |Coming soon                                                           |
-|NCSU Libraries' Catalog |Coming soon                                                           |
+|Searcher                |Line to include in Gemfile to install          |Repository                         |
+|------------------------|-----------------------------------------------|-----------------------------------|
+|arxiv                   |gem 'quick_search-arxiv_searcher'              |[quick_search-arxiv_searcher](https://www.github.com/ncsu-libraries/quick_search-arxiv_searcher)               |
+|wikipedia               |gem 'quick_search-wikipedia_searcher'          |[quick_search-wikipedia_searcher](https://www.github.com/ncsu-libraries/quick_search-wikipedia_searcher)       |
+|OpenLibrary             |gem 'quick_search-open_library_searcher'       |[quick_search-open_library_searcher](https://www.github.com/ncsu-libraries/quick_search-open_library_searcher) |
+|Placeholder           |gem 'quick_search-placeholder_searcher'       |[quick_search-placeholder_searcher](https://www.github.com/ncsu-libraries/quick_search-placeholder_searcher) |
+|Summon                  |Coming soon                                    |                                   |
+|NCSU Libraries' Catalog |Coming soon                                    |                                   |
 
 
 
 ### Themes
 
-|Theme          |Repository URL                                                      |
-|---------------|--------------------------------------------------------------------|
-|Generic Theme  |http://github.com/NCSU-Libraries/quicksearch-generic_theme          |
+|Theme          |Line to include in Gemfile to install |Repository                         |
+|---------------|--------------------------------------|-----------------------------------|
+|Generic Theme  |gem 'quick_search-generic_theme'      |[quick_search-generic_theme](https://www.github.com/ncsu-libraries/quick_search-generic_theme)|
+
+
+## Running the Tests
+
+In order to run the tests, you'll need to have Xvfb installed. If you
+are on CentOS, you can run:
+
+    sudo yum install org-x11-server-Xvfb
+
+On Ubuntu/Debian:
+
+    sudo apt-get install xvfb
+
+To set up the testing database, run:
+
+    RAILS_ENV=test bundle exec rake db:schema:load
+
+Then, to run the tests:
 
+    bundle exec rake test
 
 ## TODO
 
 There are still some TODOs left in terms of extracting this code from
 our production codebase:
 
-- Fix tests
 - Improve documentation
 
 ## Bugs, Feature Requests, etc.
@@ -160,6 +147,7 @@ Here are the people who have contributed code to this implementation of
 QuickSearch (listed in alphabetical order)
 
 - Kevin Beswick
+- Nushrat Khan
 - Cory Lown
 - Jason Ronallo
 

data/Rakefile

@@ -1,6 +1,32 @@
-# Add your own tasks in files placed in lib/tasks ending in .rake,
-# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
 
-require File.expand_path('../config/application', __FILE__)
+require 'rdoc/task'
 
-QuickSearch::Application.load_tasks
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'QuickSearch'
+  rdoc.options << '--line-numbers'
+  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

data/app/assets/javascripts/quick_search/event_tracking.js.erb

@@ -197,15 +197,9 @@ var quickSearchEventTracking = (function () {
 
     function searchPage() {
         var pathname = window.location.pathname;
-        if (pathname == '/') {
-            var page = 'index';
-        } else if (pathname.indexOf('website') > -1) {
-            var page = 'search/website_search';
-        } else {
-            var page = pathname;
-        }
 
-        return page;
+        // Get the pathname relative to the application root
+        return pathname.replace("<%= ActionController::Base.relative_url_root || '' %>", "");
     }
 
     function logSearchToDatabase(searchValues) {

data/app/assets/stylesheets/quick_search/{quick_search.css.scss → quick_search.scss}

@@ -169,6 +169,7 @@
 
         .thumbnail {
             border: 1px solid #555555;
+			margin-top: 1.5em;
         }
 
         .citation {

data/app/controllers/concerns/quick_search/searcher_concern.rb

@@ -27,13 +27,20 @@ module QuickSearch::SearcherConcern
         end
       end
 
+      # Constantize all searchers before creating searcher threads
+      # Excluding this line causes threads to hang indefinitely as of Rails 5
+      QuickSearch::Engine::APP_CONFIG['searchers'].each do |searcher_name|
+        "QuickSearch::#{searcher_name.camelize}Searcher".constantize
+      end
+
       searchers.shuffle.each do |search_method|
         search_threads << Thread.new(search_method) do |sm|
           benchmark "%s server #{sm}" % CGI.escape(query.to_str) do
             begin
               klass = "QuickSearch::#{sm.camelize}Searcher".constantize
+
               http_client = HTTPClient.new
-              update_searcher_timeout(http_client, search_method)
+              update_searcher_timeout(http_client, sm)
               # FIXME: Probably want to set paging and offset somewhere else.
               # searcher = klass.new(http_client, params_q_scrubbed, QuickSearch::Engine::APP_CONFIG['per_page'], 0, 1, on_campus?(request.remote_ip))
               if sm == primary_searcher

data/app/controllers/concerns/quick_search/searcher_config.rb

@@ -8,8 +8,11 @@ module QuickSearch::SearcherConfig
     if searcher == 'best_bets'
       QuickSearch::Engine::APP_CONFIG['best_bets']
     else
-      #TODO: test for the existence of this?
-      "QuickSearch::Engine::#{searcher.upcase}_CONFIG".constantize
+      begin
+        "QuickSearch::Engine::#{searcher.upcase}_CONFIG".constantize
+      rescue NameError
+        nil
+      end
     end
   end
 

data/app/controllers/quick_search/appstats_controller.rb

@@ -19,7 +19,7 @@ module QuickSearch
     def top_searches
       @page_title = 'Top Searches'
       searches_count
-      searches = Search.where(page: 'index').where(date_range)
+      searches = Search.where(page: '/').where(date_range)
       queries = []
       searches.each do |search|
         queries << search["query"].downcase
@@ -83,7 +83,7 @@ module QuickSearch
     end
 
     def searches_count
-      @searches_count = Search.where(page: 'index').where(date_range).count
+      @searches_count = Search.where(page: '/').where(date_range).count
     end
 
     def search_click_ratio

data/app/controllers/quick_search/search_controller.rb

@@ -10,8 +10,8 @@ module QuickSearch
 
     require 'benchmark_logger'
 
-    before_filter :doi_trap, :log_query
-    after_filter :realtime_message, only: [:index]
+    before_action :doi_trap, :log_query
+    after_action :realtime_message, only: [:index]
     protect_from_forgery except: :log_event
 
     def index
@@ -117,9 +117,9 @@ module QuickSearch
     def log_search
       if params[:query].present? && params[:page].present?
         Search.create(query: params[:query], page: params[:page])
-        render :nothing => true, :status => 200, :content_type => 'text/html'
+        head :ok
       else
-        render :nothing => true, :status => 500, :content_type => 'text/html'
+        head :bad_request
       end
     end
 
@@ -127,12 +127,12 @@ module QuickSearch
       if params[:category].present? && params[:event_action].present? && params[:label].present?
         Event.create(category: params[:category], action: params[:event_action], label: params[:label][0..250])
         if params[:callback].present?
-          render :nothing => true, :status => 200, :content_type => 'text/javascript'
+          head :ok, content_type: 'text/javascript'
         else
-          render :nothing => true, :status => 200, :content_type => 'text/html'
+          head :ok
         end
       else
-        render :nothing => true, :status => 500, :content_type => 'text/html'
+        head :bad_request
       end
     end
 

data/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/app/models/event.rb

@@ -1,2 +1,2 @@
-class Event < ActiveRecord::Base
+class Event < ApplicationRecord
 end

data/app/models/search.rb

@@ -1,4 +1,4 @@
-class Search < ActiveRecord::Base
+class Search < ApplicationRecord
   
   def self.get_most_frequent_searches
     frequent_searches = []

data/app/searchers/quick_search/best_bets_searcher.rb

@@ -2,7 +2,13 @@ module QuickSearch
   class BestBetsSearcher < QuickSearch::Searcher
 
     def search
-      search_best_bets_index
+      unless QuickSearch::Engine::APP_CONFIG['best_bets']['solr_url'].empty?
+        search_best_bets_index
+      else
+        if defined? QuickSearch::Engine::BEST_BETS
+          search_local_best_bets
+        end
+      end
     end
 
     def results
@@ -43,6 +49,23 @@ module QuickSearch
       end
     end
 
+    def search_local_best_bets
+      if QuickSearch::Engine::BEST_BETS_INDEX.has_key? http_request_queries['not_escaped'].downcase
+        best_bet_name = QuickSearch::Engine::BEST_BETS_INDEX[http_request_queries['not_escaped'].downcase]
+        best_bet = QuickSearch::Engine::BEST_BETS[best_bet_name]
+        result = OpenStruct.new
+        result.title = title(best_bet)
+        result.link = link(best_bet)
+        result.id = ''
+        result.description = description(best_bet)
+        result.best_bets_type = 'best-bets-regular'
+
+        @response = result
+      else
+        nil
+      end
+    end
+
     def base_url
       QuickSearch::Engine::APP_CONFIG['best_bets']['solr_url']
     end
@@ -76,12 +99,7 @@ module QuickSearch
     end
 
     def link(value)
-      # TODO: should we make all URLS in the best_bets index absolute? currently some begin with a /
-      if value['url'].start_with?('/')
-        QuickSearch::Engine::APP_CONFIG['website']['website_base_url'] + value['url']
-      else
-        value['url']
-      end
+      value['url']
     end
 
     def id(value)

data/app/views/layouts/quick_search/_google_analytics.html.erb

@@ -1,14 +1,5 @@
 <% if Rails.env == 'production' or Rails.env == 'staging' %>
 <script>
-    //Univeral Analytics
-    // (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
-    // (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
-    // m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
-    // })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
-
-    // ga('create', "<%= APP_CONFIG['google_analytics_tracking_id'] %>", 'ncsu.edu'); //FIXME: Add id for quicksearch GA
-    // ga('send', 'pageview');
-
     // Classic Analytics
     var _gaq = _gaq || [];
     _gaq.push(['_setAccount', "<%= QuickSearch::Engine::APP_CONFIG['google_analytics_tracking_id'] %>"]);

data/lib/generators/quick_search/install_generator.rb

@@ -11,11 +11,105 @@ ROUTES
         insert_into_file "config/routes.rb", routes, :after => "Rails.application.routes.draw do\n"
       end
 
+
+      desc 'insert generic theme'
+      def insert_theme
+
+        theme_gem_entry = <<-THEME
+\n
+# -Inserted by QuickSearch-
+
+# QuickSearch theme
+#
+# Remove the following if you want to use a different theme
+
+gem 'quick_search-generic_theme'
+
+# END -Inserted by QuickSearch-
+
+THEME
+
+
+        say("\nYou'll need to include a theme which QuickSearch uses to render your results. We've built a generic
+theme which can be modified or extended to meet your needs. Alternatively you can build your own from
+scratch and include it.\n\n")
+
+        @theme_response = ask("Would you like to install the generic theme?", limited_to: ['y', 'n'])
+
+        if @theme_response == 'y'
+          insert_into_file "Gemfile", theme_gem_entry, :after => /gem [\"\']quick_search-core[\"\'].*$/
+        end
+
+      end
+
+
+      desc 'insert searchers'
+      def insert_searchers
+        searcher_gem_entry = <<-SEARCHERS
+\n
+# -Inserted by QuickSearch-
+
+# QuickSearch searchers
+#
+# If you want to use different searchers, remove/replace these and be sure to remove them from
+# your config/quick_search_config.yml file as well as references to them in your theme's search
+# results page template
+
+gem 'quick_search-wikipedia_searcher'
+gem 'quick_search-open_library_searcher'
+gem 'quick_search-arxiv_searcher'
+gem 'quick_search-placeholder_searcher'
+
+# -END Inserted by QuickSearch-
+
+        SEARCHERS
+
+        say("\nTo have a working application you'll need to install some searchers. Searchers are the
+code that integrates with third-party APIs, handles performing searches and creating results objects.
+By default quick_search-core provides no searchers. Some searchers are available and it is easy to
+write your own.\n\n")
+
+
+        @searcher_response = ask("Would you like to install some basic searchers that do not require API keys?", limited_to: ['y', 'n'])
+
+        if @searcher_response == 'y'
+          insert_into_file "Gemfile", searcher_gem_entry, :after => /gem [\"\']quick_search-core[\"\'].*$/
+        end
+
+      end
+
+
+      desc 'bundle install theme/searchers'
+      def bundle_install_theme_searchers
+        Bundler.with_clean_env do
+          run "bundle install"
+        end
+      end
+
       desc 'create application configuration file'
       def quick_search_config_yml
         copy_file 'quick_search_config.yml', 'config/quick_search_config.yml'
       end
 
+      desc 'update quick_search_config.yml'
+      def update_quick_search_config
+        if @theme_response == 'y'
+          theme_config = 'quick_search_generic_theme'
+          insert_into_file "config/quick_search_config.yml", theme_config, :after => /^  theme: '/
+        end
+        if @searcher_response == 'y'
+          included_searchers = ',arxiv,open_library,wikipedia,placeholder'
+          included_found_types = 'arxiv,open_library,wikipedia,placeholder,placeholder,placeholder,placeholder'
+          insert_into_file "config/quick_search_config.yml", included_searchers, :after => /^  searchers: \[best_bets/
+          insert_into_file "config/quick_search_config.yml", included_found_types, :after => /^  found_types: \[/
+        end
+      end
+
+      desc 'create best bets configuration file'
+      def best_bets_yml
+        copy_file 'best_bets.yml', 'config/best_bets.yml'
+      end
+
       desc 'create kaminari initializer'
       def kaminari_initializer
         copy_file 'kaminari.rb', 'config/initializers/kaminari.rb'
@@ -40,6 +134,13 @@ ROUTES
 
       desc 'display messages about what needs to be configured'
       def configuration_messages
+        say "QuickSearch installation complete.\n\n", :green
+        if @searcher_response == 'y'
+          say "We've installed a set of default searchers.\n", :green
+        end
+        if @theme_response == 'y'
+          say "We've installed the generic theme.\n", :green
+        end
         file = File.read(File.join( File.expand_path('../templates', __FILE__), 'post_install.txt'))
         say file, :green
       end