quick_search-core 0.0.1.test

data/app/assets/stylesheets/quick_search/appstats.css.scss

@@ -0,0 +1,7 @@
+// Place all the styles related to the Appstats controller here.
+// They will automatically be included in application.css.
+// You can use Sass (SCSS) here: http://sass-lang.com/
+
+#appstats-date-filter {
+  display: none;
+}

data/app/assets/stylesheets/quick_search/opensearch.css.scss

@@ -0,0 +1,3 @@
+// Place all the styles related to the opensearch controller here.
+// They will automatically be included in application.css.
+// You can use Sass (SCSS) here: http://sass-lang.com/

data/app/assets/stylesheets/quick_search/pages.css.scss

@@ -0,0 +1,3 @@
+// Place all the styles related to the pages controller here.
+// They will automatically be included in application.css.
+// You can use Sass (SCSS) here: http://sass-lang.com/

data/app/assets/stylesheets/quick_search/quick_search.css.scss

@@ -0,0 +1,248 @@
+@mixin text-badge {
+    padding: 1px 5px 2px 5px;
+    border-radius: 2px;
+    color: #FFF;
+}
+
+//element overrides
+#content {
+  #main-content {
+    #quicksearch {
+
+        .twitter-typeahead {
+                    width: 100%;
+
+            img {
+                max-width: 79.578125px;
+            }
+            .space-container {
+                max-width: 438.3125px;
+            }
+
+            .bestbet-container {
+                padding: 0;
+            }
+
+        }
+
+        h3 {
+            padding-top: 0;
+            font-weight: normal;
+        }
+
+        ol, ul {
+            margin-left: 0;
+        }
+
+        li {
+            list-style-type: none;
+        }
+
+        em {
+            font-style: normal;
+            font-weight: bold;
+        }
+
+        #website {
+            margin-bottom: 2.5em;
+        }
+
+        // class overrides
+
+        .prefix.button {
+            height: 2.3rem
+        }
+
+        @media only screen and (max-width: 766px) {
+            .prefix.button {
+                height: 2.76rem
+            }
+        }
+
+        input[type="text"] {
+            -webkit-appearance: none;
+            border-radius: 0;
+            font-size: 1rem;
+        }
+
+        input[type="search"] {
+            margin: 0;
+        }
+
+        // custom classes
+
+        .about {
+            float: right;
+        }
+
+        .result-types {
+            margin: 10px 0 0 0;
+            li {
+                margin: 0 20px 0 0;
+            }
+        }
+
+        .trying_again {
+            padding-bottom: 20px;
+        }
+
+        .clear-search-box {
+            display: none;
+        }
+
+        .title {
+            font-size: 1.25em;
+            margin-bottom:0;
+            margin-top: 1em;
+        }
+
+        .result {
+            p {
+                margin-bottom: 0;
+            }
+        }
+
+        .see-all-results {
+            margin-bottom: 2.5em;
+            margin-top: 2em;
+            font-weight: bold;
+        }
+
+        .search-error-message {
+            margin-top: 1em
+        }
+
+        .with-thumbnail {
+            margin-bottom: 0.9em;
+        }
+
+        .no-thumbnail {
+            margin-bottom: 0.9em;
+        }
+
+        .link {
+            display: none;
+            word-break: break-word;
+        }
+
+        .query {
+            font-weight: bold;
+            word-break: break-word;
+        }
+
+        .display-link {
+            word-break: break-all;
+        }
+
+        .highlight {
+            @include text-badge;
+            background: #edb802;
+            @media only screen and (max-width: 640px) {
+                display: none;
+            }
+        }
+
+        .result-types-highlight {
+            @media only screen and (max-width: 640px) {
+                display: none;
+            }
+        }
+
+        .available {
+            color: #090;
+        }
+
+        .unavailable {
+            color: #C00;
+        }
+
+        .section-description {
+            text-transform: none;
+            margin-top: 1em;
+        }
+
+        .side-bar {
+            span.total {
+                display: none;
+            }
+        }
+
+        .thumbnail {
+            border: 1px solid #555555;
+        }
+
+        .citation {
+            .publisher {
+                font-style: italic;
+            }
+        }
+
+        .date {
+            font-weight: normal;
+        }
+
+        .search-error-rescue {
+            display: none;
+        }
+
+        .website {
+            .link {
+                display: block;
+                color: #006621;
+            }
+        }
+
+        .summon {
+            .description {
+                display: none;
+            }
+        }
+
+
+        .faq {
+            .total {
+                display: none;
+            }
+        }
+
+
+        .related-topics {
+            ul {
+                column-count: 2;
+                -moz-column-count: 2; /* Firefox */
+                -webkit-column-count: 2; /* Safari and Chrome */  
+            }
+        }
+
+        .journals-databases, .faq {
+            h3 {
+                font-size: 1.1em;
+            }
+            li {
+                margin-bottom: 0;
+            }
+        }
+
+        .appstats-show {
+            .total {
+                font-weight: bold;
+            }
+        }
+    }
+  }
+}
+
+
+// hide google analytics debug
+
+#quicksearch-ga-debug {
+    display: none;
+}
+
+// .hidden {
+//     display: none;
+// }
+
+.feedback-form {
+    display: none;
+}

data/app/assets/stylesheets/quick_search/search.css.scss

@@ -0,0 +1,3 @@
+// Place all the styles related to the search controller here.
+// They will automatically be included in application.css.
+// You can use Sass (SCSS) here: http://sass-lang.com/

data/app/assets/stylesheets/quick_search.css.scss.erb

@@ -0,0 +1,7 @@
+@import "<%= QuickSearch::Engine::APP_CONFIG['theme'] %>";
+@import "quick_search/quick_search";
+@import "quick_search/pages";
+@import "quick_search/search";
+@import "quick_search/appstats";
+// @import "typeahead";
+//

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

@@ -0,0 +1,22 @@
+require "digest/md5"
+
+module QuickSearch::Auth
+  extend ActiveSupport::Concern
+
+  SALT01 = SecureRandom.hex(512)
+  SALT02 = SecureRandom.hex(512)
+  REALM = "Please enter the username and password to access this page"
+  USERS = {"#{QuickSearch::Engine::APP_CONFIG['user']}" => Digest::MD5.hexdigest(["#{QuickSearch::Engine::APP_CONFIG['user']}",REALM,"#{QuickSearch::Engine::APP_CONFIG['password']}"].join(":"))}
+  SALTY = SALT01 + Digest::MD5.hexdigest(["#{QuickSearch::Engine::APP_CONFIG['user']}",REALM,"#{QuickSearch::Engine::APP_CONFIG['password']}"].join(":")) + SALT02
+
+  def auth
+    authenticate_or_request_with_http_digest(REALM) do |username|
+      unless SALT01.blank? or SALT02.blank? or USERS[username].blank?
+        if SALT01 + USERS[username] + SALT02 == SALTY
+          USERS[username]
+        end
+      end
+    end
+  end
+
+end

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

@@ -0,0 +1,43 @@
+module QuickSearch::DoiTrap
+  extend ActiveSupport::Concern
+
+  include QuickSearch::EncodeUtf8
+
+  private
+
+  def doi_trap
+    unless params_q_scrubbed.nil?
+      if is_a_doi?(doi_query)
+        Event.create(category: 'doi-trap', action: doi_query, label: '')
+        redirect_to doi_loaded_link
+        # Alternately insert a loaded link into the results interface
+        # @doi_loaded_link = loaded_link
+        # @doi_callout = "Searching for a DOI? Try this: "
+      end
+    end
+  end
+
+  def is_a_doi?(query)
+    if doi_regex.match(query)
+      true
+    else
+      false
+    end
+  end
+
+  def doi_regex
+    /^(?:(?:doi:?\s*|(?:http:\/\/)?(?:dx\.)?(?:doi\.org)?\/))?(10(?:\.\d+){1,2}\/\S+)$/i
+  end
+
+  def doi_loaded_link
+     QuickSearch::Engine::APP_CONFIG['doi_loaded_link'] + CGI.escape(doi_regex.match(doi_query)[1])
+  end
+
+  def doi_query
+    query = params_q_scrubbed
+    query.strip!
+    query.squish!
+    query
+  end
+
+end

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

@@ -0,0 +1,12 @@
+module QuickSearch::EncodeUtf8
+  extend ActiveSupport::Concern
+
+  private
+
+  def params_q_scrubbed
+    unless params[:q].nil?
+      params[:q].scrub
+    end
+  end
+
+end

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

@@ -0,0 +1,43 @@
+module QuickSearch::OnCampus
+  extend ActiveSupport::Concern
+
+  private
+
+  # Search for "Nucleation and growth mechanism of ferroelectric domain wall motion"
+  # To test this. Result should not show up in Summon results off campus.
+
+  ### WHY THIS IS HERE ###
+  # There is a subset of Summon results that cannot be shown unless a person is
+  # on campus or authenticated. So that we can show all results to people
+  # searching QuickSearch from on campus we're checking IP addresses. If the IP is a
+  # known campus IP we set the s.role=authenticated parameter in the Summon API request.
+
+  def ip
+    request.env['HTTP_X_FORWARDED_FOR'] || request.remote_ip
+  end
+
+  def on_campus?(ip)
+    ip = remote_ip(ip)
+    ip_range_check(ip)
+  end
+
+  # To spoof ON and OFF campus for development
+  def remote_ip(ip)
+    if ip == '127.0.0.1'
+      '204.84.244.1' #On Campus
+      #'127.0.0.1'  #Off Campus
+    else
+      ip
+    end
+  end
+
+  def ip_range_check(ip)
+    QuickSearch::Engine::APP_CONFIG['on_campus'].each do |on_campus_ip_regex|
+      if on_campus_ip_regex === ip
+        return true
+      end
+    end
+
+    return false
+  end
+end

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

@@ -0,0 +1,25 @@
+module QuickSearch::QueryFilter
+  extend ActiveSupport::Concern
+
+  include ActionView::Helpers::TextHelper
+
+  private
+
+  def filter_query(query)
+    if query.match(/ -$/)
+      query = query.sub(/ -$/,"")
+    end
+    query.gsub!('*', ' ')
+    query.gsub!('!', ' ')
+    query.gsub!('-', ' ') # Solr returns an error if multiple dashes appear at start of query string
+    query.gsub!('\\', '')
+    # query.gsub!('"', '')
+    query.strip!
+    query.squish!
+    query.downcase! # FIXME: Do we really want to downcase everything?
+    query = truncate(query, length: 100, separator: ' ', omission: '', escape: false)
+
+    query
+  end
+
+end

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

@@ -0,0 +1,54 @@
+module QuickSearch::QueryParser
+  extend ActiveSupport::Concern
+
+  private
+
+  def extracted_query(unfiltered_query)
+    @unfiltered_query = unfiltered_query
+    if extracted_query_and_scope
+      query = extracted_query_and_scope[:query]
+    else
+      query = unfiltered_query
+    end
+    query
+  end
+
+  def extracted_scope(unfiltered_query)
+    @unfiltered_query = unfiltered_query
+    if extracted_query_and_scope
+      scope = extracted_query_and_scope[:value]
+    else
+      scope = ''
+    end
+  end
+
+  def extracted_query_and_scope
+    if regex_matches = prefix_scope_multi_regex.match(@unfiltered_query)
+      regex_matches
+    elsif regex_matches = suffix_scope_multi_regex.match(@unfiltered_query)
+      regex_matches
+    elsif regex_matches = prefix_scope_regex.match(@unfiltered_query)
+      regex_matches
+    elsif regex_matches = suffix_scope_regex.match(@unfiltered_query)
+      regex_matches
+    end
+    regex_matches
+  end
+
+  def prefix_scope_regex
+    /^(?<option>scope):(?<value>\S+)\s?(?<query>.*)$/
+  end
+
+  def prefix_scope_multi_regex
+    /^(?<option>scope):\((?<value>.*?)\)\s?(?<query>.*)$/
+  end
+
+  def suffix_scope_regex
+    /(?<query>.*)\s(?<option>scope):(?<value>\S+)/
+  end
+
+  def suffix_scope_multi_regex
+    /^(?<query>.*)\s(?<option>scope):\((?<value>.*)\)$/
+  end
+
+end

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

@@ -0,0 +1,101 @@
+module QuickSearch::SearcherConcern
+  extend ActiveSupport::Concern
+
+  include QuickSearch::OnCampus
+  include QuickSearch::QueryParser
+  include QuickSearch::EncodeUtf8
+  include QuickSearch::SearcherConfig
+  require 'benchmark_logger'
+
+  private
+
+  def search_all_in_threads(primary_searcher = 'defaults')
+    benchmark "%s server ALL" % CGI.escape(query.to_str) do
+      search_threads = []
+      @found_types = [] # add the types that are found to a navigation bar
+
+      primary_searcher_config = ''
+
+      if primary_searcher == 'defaults'
+        searchers = QuickSearch::Engine::APP_CONFIG['searchers']
+      else
+        searcher_config = searcher_config(primary_searcher)
+        if searcher_config and searcher_config.has_key? 'with_paging'
+          searchers = searcher_config['with_paging']['searchers']
+        else
+          searchers = [primary_searcher]
+        end
+      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)
+              # 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
+                if primary_searcher_config.has_key? 'with_paging'
+                  per_page = primary_searcher_config['with_paging']['per_page']
+                else
+                  per_page = 10
+                end
+                searcher = klass.new(http_client, query, per_page, offset(page, per_page), page, on_campus?(ip), scope)
+              else
+                searcher = klass.new(http_client, query, QuickSearch::Engine::APP_CONFIG['per_page'], 0, 1, on_campus?(ip), scope)
+              end
+              searcher.search
+              unless searcher.is_a? StandardError or searcher.results.blank?
+                @found_types.push(sm)
+              end
+              instance_variable_set "@#{sm}", searcher
+            rescue StandardError => e
+              # logger.info e
+              logger.info "FAILED SEARCH: #{sm} | #{params_q_scrubbed}"
+              instance_variable_set :"@#{sm.to_s}", e
+            end
+          end
+        end
+      end
+      search_threads.each {|t| t.join}
+    end
+  end
+
+
+  def page
+    if page_in_params?
+      page = params[:page].to_i
+    else
+      page = 1
+    end
+    page
+  end
+
+  def offset(page, per_page)
+    (page * per_page) - per_page
+  end
+
+  def query
+    extracted_query(params_q_scrubbed)
+  end
+
+  def scope
+    extracted_scope(params_q_scrubbed)
+  end
+
+  def update_searcher_timeout(client, search_method, xhr=false)
+    timeout_type = xhr ? 'xhr_http_timeout' : 'http_timeout'
+    timeout = QuickSearch::Engine::APP_CONFIG[timeout_type]
+
+    if QuickSearch::Engine::APP_CONFIG.has_key? search_method and QuickSearch::Engine::APP_CONFIG[search_method].has_key? timeout_type
+        timeout = QuickSearch::Engine::APP_CONFIG[search_method][timeout_type]
+    end
+
+    client.receive_timeout = timeout
+    client.send_timeout = timeout
+    client.connect_timeout = timeout
+  end
+
+end

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

@@ -0,0 +1,16 @@
+module QuickSearch::SearcherConfig
+  extend ActiveSupport::Concern
+
+  private
+
+  def searcher_config(searcher)
+    # Best Bets searcher is available in QuickSearch core, use app_config
+    if searcher == 'best_bets'
+      QuickSearch::Engine::APP_CONFIG['best_bets']
+    else
+      #TODO: test for the existence of this?
+      "QuickSearch::Engine::#{searcher.upcase}_CONFIG".constantize
+    end
+  end
+
+end

data/app/controllers/quick_search/application_controller.rb

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