quick_search-core 0.0.1 → 0.1.0

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

@@ -0,0 +1,86 @@
+---
+best_bets:
+  academicsearchpremier:
+    title: Academic Search Complete
+    url: http://search.ebscohost.com/login.aspx?authtype=ip,uid&profile=ehost&defaultdb=a9h
+    description: Search for full-text articles from a wide range of scholarly journals.
+      Formerly named Academic Search Premier.
+    keywords:
+    - academic search complete
+    - academic search complet
+    - academic search compleat
+    - academic search compleet
+    - academic search elite
+    - academic elite
+    - search elite
+    - academic search fulltext elite
+    - academic search premier
+    - academic premier
+    - academic premiere
+    - academic search premiere
+    - academic search premeir
+    - acedemic search premier
+    - academic search premire
+    - academic search primer
+  acm:
+    title: ACM Digital Library
+    url: http://www.acm.org/dl/
+    description: Provides access to ACM journals, magazines, and conference proceedings
+    keywords:
+    - acm
+    - acm digital library
+    - acm portal
+    - acm database
+    - acm digital
+  eric:
+    title: ERIC (Educational Resource Information Center)
+    url: http://search.ebscohost.com/login.aspx?authtype=ip,uid&profile=ehost&defaultdb=eric
+    description: Use ERIC to find journal articles in the field of education
+    keywords:
+    - eric database
+    - eric
+    - education
+    - educational resources information center
+  googlescholar:
+    title: Google Scholar
+    url: http://scholar.google.com
+    description: Use Google Scholar and get access to articles via our library
+    keywords:
+    - google scholar
+    - google search
+    - google com
+    - www google com
+    - googlescholar
+    - googlescholar
+    - google
+  lexisnexis:
+    title: LexisNexis Academic
+    url: http://www.lexisnexis.com/
+    description: Search for news, business, legal, medical, and congressional information
+    keywords:
+    - lexis
+    - nexis
+    - lexis nexis
+    - lexis nexus
+    - lexus nexis
+    - lexis-nexis
+    - lexisnexis
+    - lexus
+    - nexus
+    - lexus nexus
+    - lexus-nexus
+    - lexusnexus
+    - lexxis nexxis
+    - lexxus nexus
+    - lexxus nexxus
+    - academic universe
+    - lexis nexis academic
+    - lexisnexis academic
+  pubmed:
+    title: PubMed
+    url: http://www.ncbi.nlm.nih.gov/
+    description: Search citations from MEDLINE and other medical and life science
+      journals
+    keywords:
+    - pubmed
+    - pub med

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

@@ -1,4 +1,5 @@
-QuickSearch installation complete. To add searchers:
+
+To add/remove/replace 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)
@@ -6,3 +7,4 @@ QuickSearch installation complete. To add searchers:
 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

@@ -1,7 +1,29 @@
 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]
+
+  # QuickSearch theme name
+  #
+  # To use a different theme, you must first add a new theme gem to the Gemfile,
+  # run 'bundle install', then update this with the new theme name.
+  #
+  # See docs for more details: https://github.com/NCSU-Libraries/quick_search/blob/master/docs/configuration.md
+
+  theme: ''
+
+  # Searchers that QuickSearch will automatically search
+  #
+  # To use different searchers, you must first add the new searcher gem to the Gemfile,
+  # run 'bundle install', then add the searcher name to this list. You must also
+  # add a 'render_module()' helper call to your search results page tempate to expose the
+  # results for that searcher.
+  #
+  # See docs for more details: https://github.com/NCSU-Libraries/quick_search/blob/master/docs/configuration.md
+
+  searchers: [best_bets]
+
+  # Searchers listed in the "result type guide" bar that lists result types that were found for a given search
+
+  found_types: []
+
   per_page: 3
   max_per_page: 50
   http_timeout: 1.5

data/lib/quick_search.rb

@@ -4,8 +4,6 @@ require "httpclient"
 require "kaminari"
 require "nokogiri"
 require "mysql2"
-require "rsolr"
-require "exception_notification"
 
 module QuickSearch
 end

data/lib/quick_search/engine.rb

@@ -5,12 +5,27 @@ module 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]
+        QuickSearch::Engine::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
+
+    initializer :best_bets, :after => :quick_search do
+      if defined? QuickSearch::Engine::APP_CONFIG and QuickSearch::Engine::APP_CONFIG['best_bets']['solr_url'].empty?
+        best_bets_file = File.join(Rails.root, "/config/best_bets.yml")
+        if File.exist?(best_bets_file)
+          QuickSearch::Engine::BEST_BETS = YAML.load_file(best_bets_file)['best_bets']
+          QuickSearch::Engine::BEST_BETS_INDEX = {}
+          QuickSearch::Engine::BEST_BETS.each do |best_bet_name, best_bet|
+            best_bet['keywords'].each do |keyword|
+              QuickSearch::Engine::BEST_BETS_INDEX[keyword.downcase] = best_bet_name
+            end
+          end
+        end
+      end
+    end
   end
 end

data/lib/quick_search/version.rb

@@ -1,3 +1,3 @@
 module QuickSearch
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/tasks/best_bets.rake

@@ -1,6 +1,8 @@
 namespace :best_bets do
   desc 'Update the BestBets SOLR index from best_bets.yml'
   task :update_index => :environment do
+    require 'rsolr'
+
     best_bets_yaml = File.join Rails.root, "/config/best_bets.yml"
     best_bets = YAML.load_file(best_bets_yaml)['best_bets']
 

data/test/controllers/concerns/doi_trap_test.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 
 class DoiTrapTest < ActionController::TestCase
 
-  include DoiTrap
+  include QuickSearch::DoiTrap
 
   test "should be a doi" do
     doi = '10.1016/0046-8177(95)90302-X'
@@ -13,7 +13,7 @@ class DoiTrapTest < ActionController::TestCase
   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  
+    assert_not is_a_doi
   end
 
-end
+end

data/test/controllers/concerns/on_campus_test.rb

@@ -2,10 +2,10 @@ require 'test_helper'
 
 class OnCampusTest < ActionController::TestCase
 
-  include OnCampus
+  include QuickSearch::OnCampus
 
   test "should be on campus" do
-    ip = '152.14.1.1'
+    ip = '192.168.1.100'
     on_campus = on_campus?(ip)
     assert on_campus
   end
@@ -13,7 +13,7 @@ class OnCampusTest < ActionController::TestCase
   test "should not be on campus" do
     ip = '152.2.1.1'
     on_campus = on_campus?(ip)
-    assert_not on_campus  
+    assert_not on_campus
   end
 
-end
+end

data/test/controllers/concerns/query_parser_test.rb

@@ -2,11 +2,11 @@ require 'test_helper'
 
 class QueryParserTest < ActionController::TestCase
 
-  include QueryParser
+  include QuickSearch::QueryParser
 
   test "should extract basic prefixed scoped query" do
     full_query = 'scope:scrc libraries'
-    
+
     query = extracted_query(full_query)
     assert_equal('libraries', query)
 
@@ -16,7 +16,7 @@ class QueryParserTest < ActionController::TestCase
 
   test "should extract basic suffixed scoped query" do
     full_query = 'libraries scope:scrc'
-    
+
     query = extracted_query(full_query)
     assert_equal('libraries', query)
 
@@ -26,7 +26,7 @@ class QueryParserTest < ActionController::TestCase
 
   test "should extract compound prefixed scoped query" do
     full_query = 'scope:(scrc OR jobs) libraries'
-    
+
     query = extracted_query(full_query)
     assert_equal('libraries', query)
 
@@ -36,7 +36,7 @@ class QueryParserTest < ActionController::TestCase
 
   test "should extract compound suffixed scoped query" do
     full_query = 'libraries scope:(scrc OR jobs)'
-    
+
     query = extracted_query(full_query)
     assert_equal('libraries', query)
 
@@ -44,4 +44,4 @@ class QueryParserTest < ActionController::TestCase
     assert_equal('scrc OR jobs', scope)
   end
 
-end
+end

data/test/controllers/{appstats_controller_test.rb → quick_search/appstats_controller_test.rb}

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

data/test/controllers/{opensearch_controller_test.rb → quick_search/opensearch_controller_test.rb}

@@ -1,6 +1,11 @@
 require 'test_helper'
 
-class OpensearchControllerTest < ActionController::TestCase
+class QuickSearch::OpensearchControllerTest < ActionController::TestCase
+  include QuickSearch::Engine.routes.url_helpers
+
+  setup do
+    @routes = QuickSearch::Engine.routes
+  end
 
   test "should return xml" do
     @request.env['HTTP_ACCEPT'] = 'application/xml'

data/test/controllers/{pages_controller_test.rb → quick_search/pages_controller_test.rb}

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

data/test/controllers/quick_search/search_controller_test.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+
+class QuickSearch::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, params: { q: 'doi:10.1002/0470841559.ch1' }
+    assert_redirected_to 'http://doi.org/10.1002%2F0470841559.ch1'
+  end
+
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# 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.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// 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
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * 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 bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application