quick_search-summon_searcher 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 849cab8b1ba229f451ea92828c2dea7021637361
+  data.tar.gz: d4cdacfdfd9560fc58c66ab3dece06c890d21871
+SHA512:
+  metadata.gz: 8d346dfcca4f013605ae8f2cc9ff601fa963941490898c5b258fd8683faf848995b2fabad2ae2f26775ebf9a4a512c38ac407f9f8106150bd7dc8bec6a490094
+  data.tar.gz: 8cba9a0dbc28a8294a667e64371e7028294c3ff3b82aae5ea28d773fe71ee1c71a5310c0b379526c85d5e0e33503640e280abb72cd6706c9ab2f9d33ba42b836

data/README.md

@@ -0,0 +1,30 @@
+# QuickSearch Summon Searcher
+
+## Description
+
+This is a gem engine implementing a Summon searcher for QuickSearch.
+
+In addition to providing Summon results, the searcher can provide:
+
+* Spelling Suggestions
+* Related Topics
+* Topic Snippets
+
+These services can be enabled / disabled by adding / removing them from the "services" configuration option in summon_config.yml.
+
+> Note: This gem was extracted from NCSU Libraries' implementation of QuickSearch, and although some aspects have been made configurable, there may be still be some assumptions baked into the searcher. Issues or pull requests are welcome if you run into this situation.
+
+
+## Usage
+
+To use, add 'quick_search-summon_searcher' to your QuickSearch Gemfile, add the searcher to quick_search_config.yml, and add a render_module call into the app/views/search/index.html.erb results page.
+
+For more general information about setting up searcher plugins in QuickSearch, see https://github.com/NCSU-Libraries/quick_search
+
+## Configuration
+
+Configuration for the searcher is found in config/summon_config.yml. To override the default configuration, copy summon_config.yml to your QuickSearch application's config directory: <my_app>/config/searchers/summon_searcher.yml, then modify that version.
+
+You need to supply your API keys to summon_config.yml in order to allow the searcher to make requests to the Summon API. Additionally, you'll want to configure the commands and filters that are applied to the API response and link into the Summon search results page respectively. These are also set in summon_config.yml, and map to values for filters in the Summon API URL or search results page URL. You can see examples in the default summon_config.yml: https://www.github.com/ncsu-libraries/quick_search-summon_searcher/blob/master/config/summon_config.yml
+
+For more information about commands and filters, look at the Summon API documentation: https://api.summon.serialssolutions.com/help/api/search/commands

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'QuickSearchSummonSearcher'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.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/searchers/quick_search/summon_searcher.rb

@@ -0,0 +1,215 @@
+module QuickSearch
+  class SummonSearcher < QuickSearch::Searcher
+
+    attr_accessor :spelling_suggestion
+
+    def search
+      url = api_base_url + api_parameters.to_query
+      raw_response = @http.get(url, {}, headers)
+      @response = JSON.parse(raw_response.body)
+    end
+
+    def results
+      if results_list
+        results_list
+      else
+        pages = response['documents']
+        @results_list = []
+        pages.each do |value|
+          result = OpenStruct.new
+          result.title = title(value)
+          result.link = link(value)
+          result.format = format(value)
+          result.description = description(value)
+          result.citation = true
+          result.author = author(value)
+          result.date = date(value)
+          result.publisher = publisher(value)
+          result.volume = volume(value)
+          result.issue = issue(value)
+          result.pages = pages(value)
+          result.fulltext = fulltext(value)
+          result.thumbnail = thumbnail(value)
+          @results_list << result
+        end
+        @results_list
+      end
+    end
+
+    def loaded_link
+      loaded_link_base_url + loaded_link_parameters.to_query
+    end
+
+    def total
+      response['recordCount']
+    end
+
+    # This returns the spelling suggestion for the whole app!
+    def spelling_suggestion
+      unless response['didYouMeanSuggestions'].blank?
+        response['didYouMeanSuggestions'][0]['suggestedQuery']
+      else
+        ""
+      end
+    end
+
+    def related_topics
+      related_topics = []
+      unless response['topicRecommendations'].blank?
+        response['topicRecommendations'][0]['relatedTopics'].each do |topic|
+          related_topics << topic['title']
+        end
+      end
+      related_topics
+    end
+
+    def topic_snippet
+      topic_snippet = {}
+      unless response['topicRecommendations'].blank?
+        topic_snippet['title'] = response['topicRecommendations'][0]['title']
+        topic_snippet['snippet'] = response['topicRecommendations'][0]['snippet']
+        topic_snippet['source_name'] = response['topicRecommendations'][0]['sourceName']
+        topic_snippet['source_link'] = response['topicRecommendations'][0]['sourceLink']
+      end
+      topic_snippet
+    end
+
+  private
+
+    def api_base_url
+      QuickSearch::Engine::SUMMON_CONFIG['api_base']
+    end
+
+    def loaded_link_base_url
+      QuickSearch::Engine::SUMMON_CONFIG['loaded_link_base']
+    end
+
+    def commands
+      QuickSearch::Engine::SUMMON_CONFIG['commands']
+    end
+
+    def filters
+      QuickSearch::Engine::SUMMON_CONFIG['filters']
+    end
+
+    def api_parameters
+      api_parameters = {
+        's.cmd' => commands.join(' '),
+        's.light' => 'true',
+        's.pn' => '1',
+        's.ps' => @per_page,
+        's.q' => http_request_queries['not_escaped'],
+        's.rec.topic.max' => '1'
+      }
+
+      if @on_campus
+        api_parameters['s.role'] = 'authenticated'
+      end
+
+      api_parameters
+    end
+
+    def loaded_link_parameters
+      {
+        'fvf' => filters.join('|'),
+        'q' => http_request_queries['not_escaped'],
+        'l' => 'en',
+        'keep_r' => 'true'
+      }
+    end
+
+    def headers
+      Summon::Transport::Headers.new(
+        :url => api_base_url,
+        :access_id => QuickSearch::Engine::SUMMON_CONFIG['access_id'],
+        :client_key => QuickSearch::Engine::SUMMON_CONFIG['client_key'],
+        :secret_key => QuickSearch::Engine::SUMMON_CONFIG['secret_key'],
+        :accept => "json",
+        :params => api_parameters
+      )
+    end
+
+    def format(value)
+      value['ContentType'][0] if value['ContentType']
+    end
+
+    def title(value)
+      value['Title'][0] if value['Title']
+    end
+
+    def link(value)
+      value['link'] if value['link']
+    end
+
+    def description(value)
+      value['Abstract'][0] if value['Abstract']
+    end
+
+    def author(value)
+      authors = ''
+      if value['Author']
+        value['Author'].each do |author|
+          authors << author if value['Author']
+          authors << '; '
+        end
+      end
+      authors.chomp('; ')
+    end
+
+    def date(value)
+      value['PublicationDate_xml'][0]['year'] if value['PublicationDate_xml']
+    end
+
+    def publisher(value)
+      value['PublicationTitle'][0].titleize if value['PublicationTitle']
+    end
+
+    def volume(value)
+        value['Volume'][0] if value['Volume']
+    end
+
+    def issue(value)
+      value['Issue'][0] if value['Issue']
+    end
+
+    def fulltext(value)
+      value['hasFullText'] ? true : false
+    end
+
+    def page_start(value)
+      if value['StartPage']
+        Integer(value['StartPage'][0]) rescue nil
+      end
+    end
+
+    def page_end(value)
+      if value['EndPage']
+        Integer(value['EndPage'][0]) rescue nil
+      end
+    end
+
+    def pages(value)
+      page_start = page_start(value)
+      page_end = page_end(value)
+      if page_end && page_start && page_end > page_start
+        formatted_page = "#{page_start}&nbsp;-&nbsp;#{page_end}"
+      elsif page_start
+        formatted_page = "#{page_start}"
+      end
+    end
+
+    def thumbnail(value)
+      if value['thumbnail_s']
+        image_size = FastImage.size(value['thumbnail_s'][0], :timeout => 0.1)
+        unless image_size.nil?
+          if image_size.first > 1
+            thumbnail = value['thumbnail_s'][0].sub! "http://www.", "//"
+          end
+        end
+      end
+
+      thumbnail
+    end
+
+  end
+end

data/config/initializers/summon_searcher_config.rb

@@ -0,0 +1,8 @@
+# Try to load a local version of the config file if it exists - expected to be in quick_search_root/config/searchers/summon_config.yml
+if File.exists?(File.join(Rails.root, "/config/searchers/summon_config.yml"))
+  config_file = File.join Rails.root, "/config/searchers/summon_config.yml"
+else
+  # otherwise load the default config file
+  config_file = File.expand_path("../../summon_config.yml", __FILE__)
+end
+QuickSearch::Engine::SUMMON_CONFIG = YAML.load_file(config_file)[Rails.env]

data/config/locales/en.yml

@@ -0,0 +1,11 @@
+en:
+  summon_search:
+    display_name: "Articles"
+    short_display_name: "article"
+    search_form_placeholder: "Search for articles and book chapters"
+    module_callout: "Search Summon for articles and book chapters."
+    error_service_message: "searching Summon"
+    no_results_service_message: "a different search for articles"
+    loaded_link: "https://<institution>.summon.serialssolutions.com/#!/search?fvf=ContentType,Journal%20Article,f%7CContentType,Magazine%20Article,f%7CContentType,Book%20Chapter,f%7CContentType,Trade%20Publication%20Article,f%7CContentType,Journal%20%2F%20eJournal,f%7CLanguage,English,f&l=en&q="
+    no_results_link: "http://<institution>.summon.serialssolutions.com/"
+

data/config/routes.rb

@@ -0,0 +1,2 @@
+QuickSearchSummonSearcher::Engine.routes.draw do
+end

data/config/summon_config.yml

@@ -0,0 +1,35 @@
+defaults: &defaults
+  access_id: "summon"
+  secret_key: "your secret key here"
+  client_key: "your client key here"
+  api_base: "http://api.summon.serialssolutions.com/2.0.0/search?"
+  loaded_link_base: "http://<your_institution_here>.summon.serialssolutions.com/search?"
+  services: [spelling_suggestion, related_topics, topic_snippet]
+
+  filters:
+    - 'ContentType,Journal Article,f'
+    - 'ContentType,Magazine Article,f'
+    - 'ContentType,Book Chapter,f'
+    - 'ContentType,Trade Publication Article,f'
+    - 'ContentType,Journal / eJournal,f'
+    - 'Language,English,f'
+    - 'IsFullText,true,f'
+
+  commands:
+    - 'addFacetValueFilters(ContentType,Journal Article,Journal / eJournal,Book Chapter,Magazine Article,Trade Publication Article)'
+    - 'addFacetValueFilters(Language,English)'
+    - 'addFacetValueFilters(IsFullText,true)'
+    - 'setHoldingsOnly(true)'
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+staging:
+  <<: *defaults
+
+production:
+  <<: *defaults
+

data/lib/quick_search-summon_searcher.rb

@@ -0,0 +1,5 @@
+require "summon"
+require "quick_search_summon_searcher/engine"
+
+module QuickSearchSummonSearcher
+end

data/lib/quick_search_summon_searcher/engine.rb

@@ -0,0 +1,5 @@
+module QuickSearchSummonSearcher
+  class Engine < ::Rails::Engine
+    isolate_namespace QuickSearchSummonSearcher
+  end
+end

data/lib/quick_search_summon_searcher/version.rb

@@ -0,0 +1,3 @@
+module QuickSearchSummonSearcher
+  VERSION = "0.0.1"
+end

data/lib/tasks/quick_search_summon_searcher_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :quick_search_summon_searcher do
+#   # Task goes here
+# 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 any plugin's vendor/assets/javascripts directory 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 any plugin's vendor/assets/stylesheets directory 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
+ */