RubyGems - bento_search - Versions diffs - 0.0.1 - Mend

bento_search 0.0.1

Files changed (122) hide show

data/MIT-LICENSE +20 -0
data/README.md +299 -0
data/Rakefile +40 -0
data/app/assets/images/bento_search/large_loader.gif +0 -0
data/app/assets/javascripts/bento_search.js +3 -0
data/app/assets/javascripts/bento_search/ajax_load.js +22 -0
data/app/assets/stylesheets/bento_search/bento.css +4 -0
data/app/controllers/bento_search/bento_search_controller.rb +7 -0
data/app/controllers/bento_search/search_controller.rb +72 -0
data/app/helpers/bento_search_helper.rb +138 -0
data/app/item_decorators/bento_search/only_premade_openurl.rb +16 -0
data/app/item_decorators/bento_search/openurl_add_other_link.rb +35 -0
data/app/item_decorators/bento_search/openurl_main_link.rb +30 -0
data/app/models/bento_search/author.rb +25 -0
data/app/models/bento_search/link.rb +30 -0
data/app/models/bento_search/multi_searcher.rb +109 -0
data/app/models/bento_search/openurl_creator.rb +128 -0
data/app/models/bento_search/registrar.rb +70 -0
data/app/models/bento_search/result_item.rb +203 -0
data/app/models/bento_search/results.rb +54 -0
data/app/models/bento_search/results/pagination.rb +67 -0
data/app/models/bento_search/search_engine.rb +219 -0
data/app/models/bento_search/search_engine/capabilities.rb +65 -0
data/app/search_engines/bento_search/#Untitled-1# +11 -0
data/app/search_engines/bento_search/ebsco_host_engine.rb +356 -0
data/app/search_engines/bento_search/eds_engine.rb +557 -0
data/app/search_engines/bento_search/google_books_engine.rb +184 -0
data/app/search_engines/bento_search/primo_engine.rb +231 -0
data/app/search_engines/bento_search/scopus_engine.rb +295 -0
data/app/search_engines/bento_search/summon_engine.rb +398 -0
data/app/search_engines/bento_search/xerxes_engine.rb +168 -0
data/app/views/bento_search/_link.html.erb +4 -0
data/app/views/bento_search/_search_error.html.erb +22 -0
data/app/views/bento_search/_std_item.html.erb +39 -0
data/app/views/bento_search/search/search.html.erb +1 -0
data/config/locales/en.yml +25 -0
data/lib/bento_search.rb +29 -0
data/lib/bento_search/engine.rb +5 -0
data/lib/bento_search/routes.rb +45 -0
data/lib/bento_search/version.rb +3 -0
data/lib/generators/bento_search/pull_ebsco_dbs_generator.rb +24 -0
data/lib/generators/bento_search/templates/ebsco_global_var.erb +6 -0
data/lib/http_client_patch/include_client.rb +86 -0
data/lib/tasks/bento_search_tasks.rake +4 -0
data/test/dummy/README.rdoc +261 -0
data/test/dummy/Rakefile +7 -0
data/test/dummy/app/assets/javascripts/application.js +15 -0
data/test/dummy/app/assets/stylesheets/application.css +13 -0
data/test/dummy/app/controllers/application_controller.rb +3 -0
data/test/dummy/app/helpers/application_helper.rb +2 -0
data/test/dummy/app/views/layouts/application.html.erb +14 -0
data/test/dummy/config.ru +4 -0
data/test/dummy/config/application.rb +56 -0
data/test/dummy/config/boot.rb +10 -0
data/test/dummy/config/database.yml +25 -0
data/test/dummy/config/environment.rb +5 -0
data/test/dummy/config/environments/development.rb +37 -0
data/test/dummy/config/environments/production.rb +67 -0
data/test/dummy/config/environments/test.rb +37 -0
data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/test/dummy/config/initializers/inflections.rb +15 -0
data/test/dummy/config/initializers/mime_types.rb +5 -0
data/test/dummy/config/initializers/secret_token.rb +7 -0
data/test/dummy/config/initializers/session_store.rb +8 -0
data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
data/test/dummy/config/locales/en.yml +5 -0
data/test/dummy/config/routes.rb +6 -0
data/test/dummy/db/test.sqlite3 +0 -0
data/test/dummy/log/test.log +3100 -0
data/test/dummy/public/404.html +26 -0
data/test/dummy/public/422.html +26 -0
data/test/dummy/public/500.html +25 -0
data/test/dummy/public/favicon.ico +0 -0
data/test/dummy/script/rails +6 -0
data/test/functional/bento_search/search_controller_test.rb +81 -0
data/test/helper/bento_search_helper_test.rb +125 -0
data/test/integration/navigation_test.rb +10 -0
data/test/support/mock_engine.rb +23 -0
data/test/support/test_with_cassette.rb +38 -0
data/test/test_helper.rb +52 -0
data/test/unit/#vcr_test.rb# +68 -0
data/test/unit/ebsco_host_engine_test.rb +134 -0
data/test/unit/eds_engine_test.rb +105 -0
data/test/unit/google_books_engine_test.rb +93 -0
data/test/unit/item_decorators_test.rb +66 -0
data/test/unit/multi_searcher_test.rb +49 -0
data/test/unit/openurl_creator_test.rb +111 -0
data/test/unit/pagination_test.rb +59 -0
data/test/unit/primo_engine_test.rb +37 -0
data/test/unit/register_engine_test.rb +50 -0
data/test/unit/result_item_display_test.rb +39 -0
data/test/unit/result_item_test.rb +36 -0
data/test/unit/scopus_engine_test.rb +130 -0
data/test/unit/search_engine_base_test.rb +178 -0
data/test/unit/search_engine_test.rb +95 -0
data/test/unit/summon_engine_test.rb +161 -0
data/test/unit/xerxes_engine_test.rb +70 -0
data/test/vcr_cassettes/ebscohost/error_bad_db.yml +45 -0
data/test/vcr_cassettes/ebscohost/error_bad_password.yml +45 -0
data/test/vcr_cassettes/ebscohost/get_info.yml +3626 -0
data/test/vcr_cassettes/ebscohost/live_search.yml +45 -0
data/test/vcr_cassettes/ebscohost/live_search_smoke_test.yml +1311 -0
data/test/vcr_cassettes/eds/basic_search_smoke_test.yml +1811 -0
data/test/vcr_cassettes/eds/get_auth_token.yml +75 -0
data/test/vcr_cassettes/eds/get_auth_token_failure.yml +39 -0
data/test/vcr_cassettes/eds/get_with_auth.yml +243 -0
data/test/vcr_cassettes/eds/get_with_auth_recovers_from_bad_auth.yml +368 -0
data/test/vcr_cassettes/gbs/error_condition.yml +40 -0
data/test/vcr_cassettes/gbs/pagination.yml +702 -0
data/test/vcr_cassettes/gbs/search.yml +340 -0
data/test/vcr_cassettes/primo/search_smoke_test.yml +1112 -0
data/test/vcr_cassettes/scopus/bad_api_key_should_return_error_response.yml +60 -0
data/test/vcr_cassettes/scopus/escaped_chars.yml +187 -0
data/test/vcr_cassettes/scopus/fielded_search.yml +176 -0
data/test/vcr_cassettes/scopus/simple_search.yml +227 -0
data/test/vcr_cassettes/scopus/zero_results_search.yml +67 -0
data/test/vcr_cassettes/summon/bad_auth.yml +54 -0
data/test/vcr_cassettes/summon/proper_tags_for_snippets.yml +216 -0
data/test/vcr_cassettes/summon/search.yml +242 -0
data/test/vcr_cassettes/xerxes/live_search.yml +2580 -0
data/test/view/std_item_test.rb +98 -0
metadata +421 -0

data/test/dummy/public/404.html ADDED Viewed

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <h1>The page you were looking for doesn't exist.</h1>
+    <p>You may have mistyped the address or the page may have moved.</p>
+  </div>
+</body>
+</html>

data/test/dummy/public/422.html ADDED Viewed

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <h1>The change you wanted was rejected.</h1>
+    <p>Maybe you tried to change something you didn't have access to.</p>
+  </div>
+</body>
+</html>

data/test/dummy/public/500.html ADDED Viewed

@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <h1>We're sorry, but something went wrong.</h1>
+  </div>
+</body>
+</html>

data/test/dummy/public/favicon.ico ADDED Viewed

File without changes

data/test/dummy/script/rails ADDED Viewed

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/test/functional/bento_search/search_controller_test.rb ADDED Viewed

@@ -0,0 +1,81 @@
+require 'test_helper'
+module BentoSearch
+  class SearchControllerTest < ActionController::TestCase
+    def setup
+      BentoSearch.register_engine("mock") do |config|
+        config.engine = "MockEngine"
+        config.allow_routable_results = true
+      end
+      BentoSearch.register_engine("not_routable") do |config|
+        config.engine = "MockEngine"
+        # no allow_routable_results
+      end
+    end
+    def teardown
+      BentoSearch.reset_engine_registrations!
+    end
+    test "search" do
+      get :search, {:engine_id => "mock", :query => "my search"}
+      assert_response :success
+      assert_not_nil assigns(:results)
+      assert_template "bento_search/search"
+    end
+    test "non-routable engine" do
+      get :search, {:engine_id => "not_routable", :query => "my search"}
+      assert_response 403
+    end
+    test "non-existent engine" do
+      get :search, {:engine_id => "not_existing", :query => "my search"}
+      assert_response 404
+    end
+    test "custom before filter" do
+      # Okay, we're going to do a weird thing with a custom controller subclass
+      # we can add a custom before filter like a local app might.
+      #
+      # SUPER HACKY, but I dunno what else to do.
+      class CustomSearchController < BentoSearch::SearchController
+        before_filter :deny_everyone
+        def deny_everyone
+          raise BentoSearch::SearchController::AccessDenied
+        end
+      end
+      orig_controller = @controller
+      begin
+        Rails.application.routes.draw do
+          match "/custom_search" => "bento_search/search_controller_test/custom_search#search"
+        end
+        @controller = CustomSearchController.new
+        get :search, {:engine_id => "mock", :query => "my search"}
+        assert_response 403
+      ensure
+        @controller = orig_controller
+        Rails.application.reload_routes!
+      end
+    end
+  end
+end

data/test/helper/bento_search_helper_test.rb ADDED Viewed

@@ -0,0 +1,125 @@
+require 'test_helper'
+class BentoSearchHelperTest < ActionView::TestCase
+  include BentoSearchHelper
+  def teardown
+    BentoSearch.reset_engine_registrations!
+  end
+  def setup
+    # Make routing work
+    @routes = Rails.application.routes
+  end
+  def test_with_results_arg
+    results = MockEngine.new.search(:query => "foo")
+    bento_search(results)
+    assert_select("div.bento_item", 10)
+  end
+  def test_with_failed_search
+    results = BentoSearch::Results.new
+    results.error = {:error => true}
+    assert results.failed?
+    response = HTML::Document.new(bento_search(results))
+    assert (no_results_div = response.find(:attributes => {:class => "bento_search_error alert alert-error"})), "has search_error div"
+    assert no_results_div.match(Regexp.new I18n.translate("bento_search.search_error")), "has error message"
+    assert_nil response.find(:attributes => {:class => "bento_item"})
+  end
+  def test_with_empty_results
+    results = MockEngine.new(:num_results => 0).search(:query => "foo")
+    response = HTML::Document.new(bento_search(results))
+    assert (no_results_div = response.find(:attributes => {:class => "bento_search_no_results"})), "has no_results div"
+    assert no_results_div.match(Regexp.new(I18n.translate("bento_search.no_results")))
+    assert_nil response.find(:attributes => {:class => "bento_item"}), "has no results message"
+  end
+  def test_with_engine_arg
+    engine = MockEngine.new
+    bento_search(engine, :query => "QUERY")
+    assert_select("div.bento_item", 10).each_with_index do |node, i|
+      node.match /QUERY/
+      node.match /#{i +1 }/
+    end
+  end
+  def test_with_registered_id
+    BentoSearch.register_engine("test_engine") do |conf|
+      conf.engine = "MockEngine"
+    end
+    bento_search("test_engine", :query => "QUERY")
+    assert_select("div.bento_item", 10).each_with_index do |node, i|
+      node.match /QUERY/
+      node.match /#{i +1 }/
+    end
+  end
+  def test_ajax_load_without_registration
+    assert_raises(ArgumentError) { bento_search(MockEngine.new, :load => :ajax_auto) }
+  end
+  def test_ajax_load
+    BentoSearch.register_engine("test_engine") do |conf|
+      conf.engine = "MockEngine"
+    end
+    results = bento_search("test_engine", :query => "QUERY", :load => :ajax_auto)
+    results = HTML::Document.new(results)
+    div = results.find(:attributes => {:class => "bento_search_ajax_wait"})
+    assert div, "produces div.bento_search_ajax_wait"
+    assert_present div.attributes["data-bento-ajax-url"]
+    url = URI.parse(div.attributes["data-bento-ajax-url"])
+    assert_equal "/bento/test_engine", url.path
+    query = CGI.parse(url.query.gsub("&amp;", "&")) # gsub weirdness of HTML::Tag
+    assert_equal ["QUERY"], query["query"]
+    assert_empty query["load"]
+    assert div.find(:tag => "noscript"), "has <noscript> tag"
+    assert (img = div.find(:tag => "img")), "Has spinner gif"
+    assert_equal I18n.translate("bento_search.ajax_loading"), img.attributes["alt"]
+  end
+  def test_sort_hash_for
+    tested_keys = %w{title_asc date_desc relevance author_asc}
+    sort_definitions = {}
+    tested_keys.each {|k| sort_definitions[k] = {}}
+    engine = MockEngine.new(:sort_definitions => sort_definitions)
+    hash = bento_sort_hash_for(engine)
+    assert_present hash
+    tested_keys.each do |key|
+      assert_equal key, hash[ I18n.translate(key, :scope => "bento_search.sort_keys") ]
+    end
+  end
+end

data/test/integration/navigation_test.rb ADDED Viewed

@@ -0,0 +1,10 @@
+require 'test_helper'
+class NavigationTest < ActionDispatch::IntegrationTest
+  fixtures :all
+  # test "the truth" do
+  #   assert true
+  # end
+end

data/test/support/mock_engine.rb ADDED Viewed

@@ -0,0 +1,23 @@
+class MockEngine
+    include BentoSearch::SearchEngine
+    def search_implementation(args)
+      results = BentoSearch::Results.new
+      1.upto(configuration.num_results) do |i|
+        results << BentoSearch::ResultItem.new(:title => "Item #{i}: #{args[:query]}", :link => configuration.link)
+      end
+      results.total_items = configuration.total_items
+      return results
+    end
+    def self.default_configuration
+      { :num_results => 10,
+        :total_items => 1000,
+        :link => "http://example.org"}
+    end
+    def sort_definitions
+      configuration.sort_definitions || {}
+    end
+end

data/test/support/test_with_cassette.rb ADDED Viewed

@@ -0,0 +1,38 @@
+module TestWithCassette
+    def test_with_cassette(name, group = nil, vcr_options ={}, &block)
+      # cribbed from Rails and modified for VCR
+      # https://github.com/rails/rails/blob/b451de0d6de4df6bc66b274cec73b919f823d5ae/activesupport/lib/active_support/testing/declarative.rb#L25
+      test_name_safe = name.gsub(/\s+/,'_')
+      test_method_name = "test_#{test_name_safe}".to_sym
+      raise "#{test_method_name} is already defined in #{self}" if methods.include?(test_method_name)
+      cassette_name = vcr_options.delete(:cassette)
+      unless cassette_name
+        # calculate default cassette name from test name
+        cassette_name = test_name_safe
+        # put in group subdir if group
+        cassette_name = "#{group}/#{cassette_name}" if group
+      end
+      # default tag with groupname, can be over-ridden.
+      vcr_options = {:tag => group}.merge(vcr_options) if group
+      if block_given?
+        define_method(test_method_name) do
+          VCR.use_cassette(cassette_name , vcr_options) do
+            instance_eval &block
+          end
+        end
+      else
+        define_method(test_method_name) do
+          flunk "No implementation provided for #{name}"
+        end
+      end
+    end
+end

data/test/test_helper.rb ADDED Viewed

@@ -0,0 +1,52 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+# we insist on minitest, when only the best will do.
+# Rails will build on top of it if it's there.
+require 'minitest/unit'
+require "rails/test_help"
+Rails.backtrace_cleaner.remove_silencers!
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+# Load fixtures from the engine
+if ActiveSupport::TestCase.method_defined?(:fixture_path=)
+  ActiveSupport::TestCase.fixture_path = File.expand_path("../fixtures", __FILE__)
+end
+# VCR is used to 'record' HTTP interactions with
+# third party services used in tests, and play em
+# back. Useful for efficiency, also useful for
+# testing code against API's that not everyone
+# has access to -- the responses can be cached
+# and re-used.
+require 'vcr'
+require 'webmock'
+# To allow us to do real HTTP requests in a VCR.turned_off, we
+# have to tell webmock to let us.
+WebMock.allow_net_connect!
+VCR.configure do |c|
+  c.cassette_library_dir = 'test/vcr_cassettes'
+  # webmock needed for HTTPClient testing
+  c.hook_into :webmock
+end
+# Silly way to not have to rewrite all our tests if we
+# temporarily disable VCR, make VCR.use_cassette a no-op
+# instead of no-such-method.
+if ! defined? VCR
+  module VCR
+    def self.use_cassette(*args)
+      yield
+    end
+  end
+end

data/test/unit/#vcr_test.rb# ADDED Viewed

@@ -0,0 +1,68 @@
+require 'httpclient'
+require 'vcr'
+require 'webmock'
+require 'test/unit'
+# To allow us to do real HTTP requests in a VCR.turned_off, we
+# have to tell webmock to let us.
+WebMock.allow_net_connect!
+VCR.configure do |c|
+  c.cassette_library_dir = 'test/vcr_cassettes'
+  # webmock needed for HTTPClient testing
+  c.hook_into :webmock
+end
+class VcrTest < Test::Unit::TestCase
+      @@http_client = HTTPClient.new
+  def setup
+    @body = "{ \"UserId\":\"user\", \"Password\":\"password\" } "
+    # this was originally a real vendor URL, but test is reproducible
+    # even with this fake URL that isn't connectable.
+    # But reproduces with a real URL that
+    # accepts POSTs too.
+    @url = "http://example.org"
+  end
+  def test_get_one
+    VCR.use_cassette("test_one") do
+      response = @@http_client.post(@url, @body)
+    end
+  end
+  def test_get_two
+    VCR.use_cassette("test_two") do
+      response = @@http_client.post(@url, @body)
+    end
+  end
+  # If this VCR.turned_off is present, for some reason we get
+  # the "appears to be a bug in Webmock's" warning even when
+  # re-playing pre-recorded cassettes, otherwise only when
+  # recording.
+  def test_aaa_turned_off
+    VCR.turned_off do
+        response = @@http_client.post(@url, @body)
+    end
+  end
+end