quick_search-core 0.0.1.test

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5a4fe03574132a5fd52dd32e79b0e74d7cc06dc0
+  data.tar.gz: 92f12db0d6fa66a458b6b1cbd7cb18ce0066adc5
+SHA512:
+  metadata.gz: de01e59b12184ca86b394ed57fc19350e61c1ff1996135191bc2ae47cb71fef37738f971437b2465003f650763f2cce9795223a80fbaa485c1254216c8537639
+  data.tar.gz: c1aee7635f08ed91c973be3cf9cb5bab232890a7c5046cdbba05a37be91af04f514a219fed2e371bd1a9ded2e74ccb9b1ff6901bddc72a53edddeaf825b083bc

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 North Carolina State University
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,168 @@
+# QuickSearch
+
+> Note: This code has recently been converted to a Rails Gem Engine. It is encouraged that you use this version, but if you are
+> 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
+
+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
+
+For NCSU Libraries' implementation of QuickSearch, see:
+http://search.lib.ncsu.edu
+
+## Features
+
+- Single search with bento-box style results
+- Modular
+  - swap out searcher modules and themes easily
+  - choose from a variety of existing searchers or create your own
+- Best Bets
+- Search analytics
+
+## Disclaimer
+
+This code has been extracted from the code we have been running in
+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
+
+    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
+development.
+
+#### Prerequisites
+
+- Rails 4.1
+- Ruby 2.1
+- MySQL development headers (mysql-devel package on CentOS)
+- qtwebkit development headers (qtwebkit-devel package on CentOS)
+
+#### Instructions
+
+##### Create a new Rails app, cd into the directory:
+
+    rails new my_app
+
+    ...
+
+    cd my_app
+
+##### 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'
+
+##### Run 'bundle install'
+
+##### Run the QuickSearch installation generator:
+
+    bundle exec rails generate quick_search:install
+
+##### Configure QuickSearch (see [Configuring QuickSearch](docs/configuration.md))
+
+##### Start the server:
+
+    bundle exec rails s
+
+##### QuickSearch will be available at http://localhost:3000/
+
+## Documentation
+
+Find more in-depth documentation about QuickSearch in the [docs
+directory](docs/README.md)
+
+## Customizing QuickSearch
+
+QuickSearch is built in a modular way, and is easy to modify or extend.
+For more in-depth documentation about this, see:
+
+- [Customizing QuickSearch Searchers](docs/customizing_searchers.md)
+- [Customizing QuickSearch Themes](docs/customizing_themes.md)
+
+### Searchers
+
+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                                                           |
+
+
+
+### Themes
+
+|Theme          |Repository URL                                                      |
+|---------------|--------------------------------------------------------------------|
+|Generic Theme  |http://github.com/NCSU-Libraries/quicksearch-generic_theme          |
+
+
+## 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.
+
+To report bugs, or request features, please use GitHub issues. We also
+welcome pull requests!
+
+## Authors
+
+Here are the people who have contributed code to this implementation of
+QuickSearch (listed in alphabetical order)
+
+- Kevin Beswick
+- Cory Lown
+- Jason Ronallo
+
+## License
+
+See MIT-LICENSE

data/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__)
+
+QuickSearch::Application.load_tasks

data/app/assets/javascripts/quick_search/appstats.js

@@ -0,0 +1,8 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.
+
+$(function () {
+  $('#appstats-date-showhide').click(function () {
+    $('#appstats-date-filter').toggle();
+  });
+});

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

@@ -0,0 +1,257 @@
+
+var quickSearchEventTracking = (function () {
+
+    // Configs
+
+    var config = {
+        clickTrackingContainer: '.quicksearch-ga-click-tracking',
+        serveTrackingContainer: '.quicksearch-ga-serve-tracking',
+        testingContainer: '#quicksearch-ga-debug',
+        seeAllClass: 'see-all-results',
+        categoryDataAttribute: 'quicksearch-ga-category',
+        actionDataAttribute: 'quicksearch-ga-action',
+        labelDataAttribute: 'quicksearch-ga-label',
+        logQueryDataAttribute: 'quicksearch-ga-query'
+    }
+
+    // Public Methods
+
+    function listenForClicks () {
+        $(document).on('click', config.clickTrackingContainer + ' a', function(e) {
+            var eventValuesDefined = eventValues($(this));
+            var link = $(this)[0];
+
+            // This ensures that ctrl and cmd click to open
+            // link in a new window/tab continues to function.
+            // No need to preventDefault in this case
+            // because the original page remains.
+            if (e.metaKey || e.ctrlKey) {
+                sendEventData(eventValuesDefined, '');
+                return;
+            } else {
+                sendEventData(eventValuesDefined, link);
+                e.preventDefault();
+            }
+
+            // In case the hitCallback isn't triggered soon enough we ensure the link is followed
+            // after this timeout in any case.
+            setTimeout(function() {
+              document.location.href = link.href;
+            }, 200);
+        });
+    }
+
+    function listenForServesOnPageChange () {
+        $(document).ready(function() {
+            serveTrackingDivs = $(config.serveTrackingContainer).get();
+            $.map(serveTrackingDivs, function(val) {
+                checkForServes(val);
+            });
+        });
+    }
+
+    function checkForServes(val) {
+        var link = $(val).find('a');
+        var eventValuesDefined = eventValues(link);
+        eventValuesDefined.category = eventValuesDefined.category + '-serve';
+        sendEventData(eventValuesDefined, '');
+    }
+
+
+
+    // Private Methods
+
+    function eventValues (link) {
+        var link = link;
+        var ga_event = {};
+        ga_event.category = eventCategory(link);
+        ga_event.action = eventAction(link);
+        ga_event.label = eventLabel(link);
+        return ga_event;
+    }
+
+    function eventCategory (link) {
+        // FIXME: There may be a better way to get the action from the parent.
+        var category;
+        if (link.data(config.categoryDataAttribute)) {
+            category = link.data(config.categoryDataAttribute);
+        } else if (link[0].id.length > 0) {
+            category = link[0].id;
+        } else {
+            category = link.parents('[id]:first')[0].id;
+        }
+        return category;
+    }
+
+    function eventAction (link) {
+        var action;
+        if (link.data(config.actionDataAttribute)) {
+            action = link.data(config.actionDataAttribute);
+        } else if (link.hasClass(config.seeAllClass)) {
+            action = 'see-all-results';
+        } else if (link.parent('h1,h2').length > 0) {
+            action = 'heading';
+        } else {
+            index = link.parents('li').index()
+            result = index + 1
+            action = 'result-' + result;
+        }
+        return action
+    }
+
+    function eventLabel (link) {
+        var label;
+        if (link.data(config.labelDataAttribute)) {
+            label = link.data(config.labelDataAttribute);
+        } else if (link.parents('body').data(config.logQueryDataAttribute)){
+            label = link.parents('body').data(config.logQueryDataAttribute);
+        } else {
+            label = link[0].href;
+        } 
+        return label;
+    }
+
+    function sendEventData (eventValues, link) {
+        <% if Rails.env == 'development' %>
+            console.log('click_tracking', [eventValues.category, eventValues.action, eventValues.label]);
+            $.when(logEventToDatabase(eventValues)).then(function () {
+                if (link !== '') {
+                    //document.location.href = link;
+                }
+            });
+        <% elsif Rails.env == 'production' or Rails.env == 'staging' %>
+            $.when(logEventToDatabase(eventValues)).then(function () {
+                sendDataToGoogleAnalytics(eventValues, link)
+            });
+        <% else %>
+            appendTestingData(eventValues);
+        <% end %>
+    }
+
+    function appendTestingData (eventValues) {
+        var debugBlock = $(config.testingContainer);
+        var debugList = $(config.testingContainer + ' ol');
+        debugList.empty();
+        $.map (eventValues, function(val) {
+            debugList.append('<li>' + val + '</li>');
+        });
+        debugBlock.show();
+    }
+
+    function sendDataToGoogleAnalytics (eventValues, link) {
+        
+        // Universal Analytics
+
+        // ga('send', 'event', {
+        //     'hitType': 'event',
+        //     'eventCategory': eventValues.category,
+        //     'eventAction': eventValues.action,
+        //     'eventLabel': eventValues.label,
+        //     'hitCallback': function () {
+        //         if (link !== '') {
+        //             document.location = link;
+        //         }
+        //     }
+        // });
+        
+        // Classic Analytics
+        _gaq.push(['_set','hitCallback',function() {
+            if (link !== '') {
+                document.location = link;
+            }
+        }]);
+        _gaq.push(['_trackEvent', eventValues.category, eventValues.action, eventValues.label]);
+    }
+
+    function logEventToDatabase(eventValues) {
+
+        url = logging_url('log_event');
+
+        return $.ajax({
+            url: url,
+            data: {
+                category: eventValues.category,
+                event_action: eventValues.action,
+                label: eventValues.label
+            }
+        });
+    }
+
+    function checkForSearch() {
+        if ($('body').data(config.logQueryDataAttribute)) {
+            var query = $('body').data(config.logQueryDataAttribute);
+            if (query != '') {
+                searchValuesDefined = searchValues(query);
+                logSearchToDatabase(searchValuesDefined);
+            }
+        }
+    }
+
+    function searchValues (query) {
+        var link = link;
+        var ga_search = {};
+        ga_search.query = query;
+        ga_search.page = searchPage();
+        return ga_search;
+    }
+
+    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;
+    }
+
+    function logSearchToDatabase(searchValues) {
+        console.log(searchValues);
+        url = logging_url('log_search');
+
+        return $.ajax({
+            url: url,
+            data: {
+                query: searchValues.query,
+                page: searchValues.page
+            }
+        });
+    }
+
+    function logging_url(log_path) {
+        var pathname = window.location.pathname;
+        var url = pathname;
+        if (url.substr(-1) != '/'){
+            url += '/';
+        }
+        url += log_path;
+
+        return url;
+    }
+
+
+    return {
+
+        // Expose Public Methods
+        
+        listenForClicks: listenForClicks,
+        listenForServesOnPageChange: listenForServesOnPageChange,
+        checkForServes: checkForServes,
+        checkForSearch: checkForSearch
+
+    };
+ 
+})();
+
+$( document ).ready(function() {
+    quickSearchEventTracking.checkForSearch();
+    if ($("body").hasClass("search-index")) {
+        quickSearchEventTracking.listenForClicks();
+        quickSearchEventTracking.listenForServesOnPageChange();
+    }
+});
+
+

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

@@ -0,0 +1,8 @@
+<%# if Rails.env == 'production' %>
+// $(document).on('page:load', function() {
+//   // This way of determining the page comes from Google Universal Analytics documentation
+//   // var loc = window.location.protocol + '//' + window.location.hostname + window.location.pathname + window.location.search;
+//   var loc = window.location.pathname + window.location.search;
+//   ga('send', 'pageview', loc);
+// });
+<%# end %>

data/app/assets/javascripts/quick_search/opensearch.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/javascripts/quick_search/pages.js.coffee

@@ -0,0 +1,3 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+# You can use CoffeeScript in this file: http://coffeescript.org/

data/app/assets/javascripts/quick_search/quicksearch.js

@@ -0,0 +1,33 @@
+$(document).ready(function() {
+
+    // Fade out best bet highlight after 3 seconds
+    if (window.innerWidth > 640) {
+        $('.highlight').delay( 6000 ).fadeOut( 500 );
+    } else {
+        $('.highlight').remove();
+    }
+
+    // remove some generic library website template content from DOM
+    $('#utility-search').remove();
+    $('#search-toggle').remove();
+    
+});
+
+//  This handles the highlighting of modules when a result types quide link is clicked
+$(document).on('click', '.result-types a', function () {
+    
+    // Grab the hash value
+    var hash = this.hash.substr(1);
+
+    // Remove any active highlight
+    $('.result-types-highlight').remove();
+
+    // Add the highlight
+    $('#' + hash + ' h2').prepend('<span class="result-types-highlight"><i class="fa fa-angle-double-right highlight"></i>&nbsp;</span>');
+    
+    // Fade it away and then remove it.
+    $('#' + hash + ' .highlight').delay( 3000 ).animate({backgroundColor: 'transparent'}, 500 );
+    setTimeout(function() {
+        $('#' + hash + ' .result-types-highlight').remove();
+    }, 3550);
+});

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

@@ -0,0 +1,12 @@
+var realtime_host = "<%= QuickSearch::Engine::APP_CONFIG['realtime_url'] %>";
+
+var socket = io.connect(realtime_host);
+socket.emit('subscribe', {room: 'quicksearch-<%= Rails.env %>'});
+
+socket.on('update', function(data){
+  console.log(data);
+  if ('q' in data) {
+    var item = '<li>' + data.q + "</li>";
+    $('#realtime_searches ul').prepend(item);
+  }
+});

data/app/assets/javascripts/quick_search/search.js

@@ -0,0 +1,3 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+# You can use CoffeeScript in this file: http://coffeescript.org/

data/app/assets/javascripts/quick_search/xhr_search.js

@@ -0,0 +1,82 @@
+function remove_timedout_spinners(){
+  $('.fa-refresh').not('.icon-5x').remove();
+  $('#no-results-trying-again').remove();
+}
+
+function add_found_item_types(endpoint) {
+  var dasherized_endpoint = endpoint.replace("_", "-")
+  $('.result-types li.' + dasherized_endpoint + " .no-results-label")
+    .replaceWith('<a href="#' + dasherized_endpoint + '" data-quicksearch-ga-action="' + 
+      dasherized_endpoint + '">' + I18n["en"][endpoint + "_search"]["display_name"]);
+}
+
+var xhr_searches = function(){
+  // We want to remove the spinners once all of the ajax requests are done. To do this we create an array of all of the ajax
+  // requests, which are promises. We can then apply this array so that all the promises are wrapped up together. When
+  // they're all done then the 'then' function runs removing the spinners.
+  $.when.apply(this,
+    $('.search-error').map(function(index){
+      var that = $(this);
+      var endpoint = that.data('quicksearchSearchEndpoint');
+      var params_q = $('#params-q').val();
+      var params_page = that.data('quicksearch-page');
+      var params_template = that.data('quicksearch-template');
+      if (!that.hasClass('silent-search-error')) {
+        var parent = that.parent('.module-contents');
+        var parent_id = parent[0].id;
+      }
+      var pathname = window.location.pathname;
+      
+      var url = pathname;
+
+      if (url.substr(-1) != '/'){
+        url += '/';
+      }
+      url += 'xhr_search.html?q=' + encodeURIComponent(params_q) + '&endpoint=' + endpoint + '&page=' + params_page + '&template=' + params_template;
+      
+      if (!that.hasClass('silent-search-error')) {
+        parent.append('<div class="trying_again"><i class="fa fa-refresh fa-spin"></i> Just a few more seconds </div>');
+      }
+
+      return $.ajax({
+        url: url,
+        timeout: 15000,
+        success: function(response){
+          var response_object = jQuery.parseJSON(response);
+
+            if (!that.hasClass('silent-search-error')) {
+              parent.replaceWith(response_object[endpoint]);
+              if (response_object[endpoint].indexOf("search-error-message") <= -1) {
+                add_found_item_types(endpoint);
+              }
+              if (response_object.spelling_suggestion != ' ') {
+                  $('#spelling-suggestion').append(response_object.spelling_suggestion).removeClass('hidden');
+              }
+              if (response_object.related_topics != ' ') {
+                  $('#related-topics').append(response_object.related_topics).removeClass('hidden');
+              }
+            } else {
+              that.replaceWith(response_object[endpoint]);
+              if ($.trim(response_object[endpoint]) !== '') {
+                add_found_item_types(endpoint);
+              }
+            }
+        },
+        error: function(){
+          if (!that.hasClass('silent-search-error')) {
+            parent.find('.trying_again').remove();
+            parent.find('.search-error-rescue').show();
+          }
+        }
+      });
+    })
+  ).then(
+    // No matter what the result (success, failure) the spinners ought to be removed.
+    remove_timedout_spinners,
+    remove_timedout_spinners
+    );
+}
+
+$(document).ready(function() {
+  xhr_searches();
+});

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

@@ -0,0 +1,20 @@
+// 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/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require quick_search/google_analytics
+//= require quick_search/event_tracking
+//= require quick_search/xhr_search
+//= require quick_search/quicksearch
+//= require quick_search/appstats
+<%= require_asset(QuickSearch::Engine::APP_CONFIG['theme']) %>