umlaut 3.3.1 → 4.0.0.beta1

data/app/controllers/search_methods/sfx4_solr/README.md

@@ -1,57 +0,0 @@
-Sfx4Solr
----
-This searcher module leverages [Sunspot](http://sunspot.github.com/) to index SFX AZ Titles in Solr.
-
-In order to use this module, you first need to set up Sunspot in your applications by adding the sunspot_rails
-gem to you Gemfile
-
-    gem 'sunspot_rails'
-
-and requiring sunspot_rails in your config/application.rb under umlaut
-
-    require "umlaut"
-    require "sunspot_rails"
-    
-Then run
-
-    $ bundle install
-    $ rails generate sunspot_rails:install
-    
-This will create a file config/sunspot.yml.  You can configure the information about your Solr instance here.
-If you don't feel like running your own solr instance, [Websolr](http://websolr.com/) has built in Sunspot support.
-
-You'll also need to specify your SFX4 DBs in your databases.yml. The configuration names are different from the Sfx4
-SearchMethod in order to avoid (promote?) ambiguity and confusion.
-
-    sfx4_global:
-      adapter: mysql2
-      host: sfx.library.edu
-      port: 3310
-      database: sfxglb41
-      username: 
-      password: 
-      pool: 30
-      encoding: utf8
-
-    sfx_db:
-      adapter: mysql2
-      host: sfx.library.edu
-      port: 3310
-      database: sfxlcl41
-      username: 
-      password: 
-      pool: 30
-      encoding: utf8
-
-Once your Solr instance is configured and started, run
-
-    $ rake sunspot:reindex[,Sfx4::Local::AzTitle]
-    
-to index the AZ titles in Solr. This reindex should probably be run periodically and coincide with SFX KB updates.
-
-After the reindex is complete, add this to your UmlautController search config
-    
-     az_search_method  SearchMethods::Sfx4Solr::Local
-     
-and you should be up and running with SFX indexed in Solr.
-

data/app/controllers/search_methods/sfx4_solr/local.rb

@@ -1,40 +0,0 @@
-module SearchMethods
-  module Sfx4Solr
-    module Local
-      protected
-      # Class method for the module that gets called by the umlaut:load_sfx_urls task.
-      # Determines whether we should attempt to fetch SFX urls.
-      # Will probably be deprecated in the near future.
-      def self.fetch_urls?
-        sfx4_base.connection_configured?
-      end
-
-      # Class method for the module that gets called by the umlaut:load_sfx_urls task.
-      # Kind of hacky way of trying to extract target URLs from SFX4.
-      # Will probably be deprecated in the near future.
-      def self.fetch_urls
-        sfx4_base.fetch_urls
-      end
-
-      # Class method for the module.
-      # Returns the SFX4 base class in order to establish a connection.
-      def self.sfx4_base
-        # Need to do this convoluted Module.const_get so that we find the
-        # correct class. Otherwise the module looks locally and can't find it.
-        Module.const_get(:Sfx4).const_get(:Local).const_get(:Base)
-      end
-
-      # Instance method that returns the SFX4 AzTitle class for this search method.
-      # Can be overridden by search methods that want to include this one.
-      def az_title_klass
-        # Need to do this convoluted Module.const_get so that we find the
-        # correct class. Otherwise the module looks locally and can't find it.
-        Module.const_get(:Sfx4).const_get(:Local).const_get(:AzTitle)
-      end
-
-      # Include the core sfx4solr search methods.
-      # Search class is determined by az_title_klass
-      include SearchMethods::Sfx4Solr::Searcher
-    end
-  end
-end

data/app/controllers/search_methods/sfx4_solr/searcher.rb

@@ -1,118 +0,0 @@
-module SearchMethods
-  module Sfx4Solr
-    module Searcher
-      protected
-      def find_by_title
-        raise_sunspot_not_implemented_exception unless sunspot?
-        _find_by_title(title_query_param, search_type_param, context_object_from_params, page)
-      end
-      
-      def find_by_group
-        raise_sunspot_not_implemented_exception unless sunspot?
-        _find_by_group(_letter_group_param, context_object_from_params, page)
-      end
-      
-      private
-      # Is Umlaut configured to use Sunspot?
-      def sunspot?
-        begin
-          Sunspot and Sunspot.const_defined?(:Rails)
-        rescue
-          false
-        end
-      end
-
-      # Raise a NotImplementedError is Sunspot
-      def raise_sunspot_not_implemented_exception
-        raise NotImplementedError.new("Sunspot::Rails has not been implemented in this Umlaut instance.")
-      end
-
-      def _search_by_title(query, search_type, page=1)
-        # 20 per page
-        # TODO: Make this configurable
-        per_page = 20
-        # Upcase the query since SFX normalizes titles
-        # by doing the same.
-        query = query.upcase
-        # Remove "the", "a", and "an" from the query
-        # so that a search for "the economist" and a 
-        # search for "economist" return the same results.
-        # Seems to be remotely similar to how SFX works
-        # though I'm not sure if that's the best example
-        # to follow.
-        [/^THE /, /^AN? /].each do |article|
-          query.gsub! article, ""
-        end
-        # Sunspot DSL per search type
-        search = case search_type
-          when "contains"
-            az_title_klass.search {
-              keywords query, :fields => [:title]
-              # Order by relevance, since we can
-              order_by(:score, :desc)
-              # Order by title after relevance
-              order_by(:title_sort, :asc)
-              # Pagination
-              paginate(:page => page, :per_page => per_page)
-            }
-          when "begins"
-            az_title_klass.search {
-              with(:title_exact).starting_with(query)
-              # Order by relevance, since we can
-              order_by(:score, :desc)
-              # Order by title after relevance
-              order_by(:title_sort, :asc)
-              # Pagination
-              paginate(:page => page, :per_page => per_page)
-            }
-          else # exact
-            az_title_klass.search {
-              with(:title_exact, query)
-              # Order by relevance, since we can
-              order_by(:score, :desc)
-              # Order by title after relevance
-              order_by(:title_sort, :asc)
-              # Pagination
-              paginate(:page => page, :per_page => per_page)
-            }
-          end
-      end
-      
-      def _find_by_title(query, search_type, context_object, page=1)
-        search = _search_by_title(query, search_type, page)
-        return [search.hits.map{|hit| _to_context_object(hit, context_object)}, search.total]
-      end
-
-      def _find_by_group(letter_group, context_object, page=1)
-        search = az_title_klass.search {
-          with(:letter_group, letter_group)
-          order_by(:title_sort, :asc)
-          paginate(:page => page, :per_page => 20)
-        }
-        return [search.hits.map{|hit| _to_context_object(hit, context_object)}, search.total]
-      end
-      
-      def _to_context_object(hit, context_object)
-        ctx = OpenURL::ContextObject.new
-        # Start out wtih everything in search, to preserve date/vol/etc
-        ctx.import_context_object(context_object)
-        # Put SFX object id in rft.object_id, that's what SFX does.
-        ctx.referent.set_metadata('object_id', hit.stored(:object_id) )
-        ctx.referent.set_metadata("jtitle", hit.stored(:title_display) || "Unknown Title")
-        ctx.referent.set_metadata("issn", hit.stored(:issn)) unless hit.stored(:issn).nil? or hit.stored(:issn).blank?
-        ctx.referent.set_metadata("isbn", hit.stored(:isbn)) unless hit.stored(:isbn).nil? or hit.stored(:isbn).blank?
-        ctx.referent.add_identifier("info:lccn/#{hit.stored(:lccn)}") unless hit.stored(:lccn).nil? or hit.stored(:lccn).blank?
-        return ctx
-      end
-  
-      def _letter_group_param
-        case params[:id]
-        when /^Other/i
-          "Others"
-        else
-          "#{params[:id].upcase}"
-        end
-      end
-    end
-  end
-end

data/app/models/sfx4/global/base.rb

@@ -1,24 +0,0 @@
-module Sfx4
-  module Global
-    class Base < ActiveRecord::Base
-      attr_accessible
-
-      # Was a SFX Global DB connection set in database.yml to connect directly to sfx?
-      def self.connection_configured?
-        config = ActiveRecord::Base.configurations["sfx4_global"]
-        (not (config.nil? or config.blank? or config["adapter"].blank?))
-      end
-
-      self.establish_connection :sfx4_global if self.connection_configured?
-
-      # ActiveRecord likes it when we tell it this is an abstract
-      # class only. 
-      self.abstract_class = true
-
-      # All SFX things are read-only!
-      def readonly?() 
-        return true
-      end
-    end
-  end
-end

data/app/models/sfx4/global/kb_objects.rb

@@ -1,34 +0,0 @@
-# +--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+------+-----+------------------------+-----------------------------+
-# | Field                    | Type                                                                                                                                                      | Null | Key | Default                | Extra                       |
-# +--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+------+-----+------------------------+-----------------------------+
-# | OBJECT_ID                | bigint(20) unsigned                                                                                                                                       | NO   | PRI | NULL                   | auto_increment              |
-# | OBJECT_TYPE              | enum('JOURNAL','BOOK','DISSERTATION','PROCEEDING','CONFERENCE','REPORT','DOCUMENT','SERIES','NEWSPAPER','TRANSCRIPT','DATABASE','WIRE','CD','MANUSCRIPT') | YES  | MUL | NULL                   |                             |
-# | LANGUAGE                 | char(3)                                                                                                                                                   | NO   | MUL | eng                    |                             |
-# | PEER_REVIEWED            | enum('YES','NO')                                                                                                                                          | YES  |     | NO                     |                             |
-# | OWNER                    | varchar(100)                                                                                                                                              | NO   |     |                        |                             |
-# | AVAILABLE_FOR            | varchar(100)                                                                                                                                              | NO   |     |                        |                             |
-# | ATTR_XML                 | mediumtext                                                                                                                                                | YES  |     | NULL                   |                             |
-# | MMS_ID                   | bigint(20) unsigned                                                                                                                                       | NO   |     | NULL                   |                             |
-# | STATUS                   | enum('ACTIVE','WITHDRAWN')                                                                                                                                | YES  |     | ACTIVE                 |                             |
-# | STATUS_DATE              | timestamp                                                                                                                                                 | NO   |     | 0000-00-00 00:00:00    |                             |
-# | DISTRIBUTION_STATUS      | enum('READY FOR DISTRIBUTION','NOT FOR DISTRIBUTION')                                                                                                     | YES  |     | READY FOR DISTRIBUTION |                             |
-# | DISTRIBUTION_STATUS_DATE | timestamp                                                                                                                                                 | NO   |     | 0000-00-00 00:00:00    |                             |
-# | VERSION_NUMBER           | int(10)                                                                                                                                                   | NO   |     | 1                      |                             |
-# | RELEASE_NUMBER           | int(10)                                                                                                                                                   | NO   |     | 1                      |                             |
-# | CRUD_TYPE                | enum('CREATE','UPDATE','DELETE')                                                                                                                          | NO   |     | CREATE                 |                             |
-# | CREATION_DATE            | timestamp                                                                                                                                                 | NO   |     | 0000-00-00 00:00:00    |                             |
-# | CREATED_BY               | varchar(255)                                                                                                                                              | NO   |     |                        |                             |
-# | LAST_UPDATE_DATE         | timestamp                                                                                                                                                 | NO   |     | CURRENT_TIMESTAMP      | on update CURRENT_TIMESTAMP |
-# | LAST_UPDATED_BY          | varchar(255)                                                                                                                                              | NO   |     |                        |                             |
-# +--------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+------+-----+------------------------+-----------------------------+
-module Sfx4
-  module Global
-    class KbObject < Sfx4::Global::Base
-      self.table_name = 'KB_OBJECTS'
-      self.primary_key = 'OBJECT_ID'
-
-      has_many  :az_titles,
-                :foreign_key=>'OBJECT_ID'
-    end
-  end
-end

data/app/views/search/opensearch_description.rxml

@@ -1,10 +0,0 @@
-xml.OpenSearchDescription(:xmlns=>'http://a9.com/-/spec/opensearch/1.1/') do
-  xml.ShortName('FindIt')
-  xml.LongName("Find It! @ Georgia Tech")
-  xml.Tags("journals articles")
-  xml.Description("Georgia Tech's eJournal Finder")
-  ['rss','atom', 'xhtml'].each { | type |
-    xml.Url(:type=>'application/'+type+'+xml', :template=>'http://'+request.host()+url_for(:action=>'opensearch')+CGI.escapeHTML('?query={searchTerms}&page={startPage?}&type='+type))
-  }
-  xml.Query(:role=>'example', :searchTerms=>'nature')
-end

data/test/dummy/db/migrate/20120927163304_sfx4_global.rb

@@ -1,26 +0,0 @@
-# This is used for SFX search testing.
-# DO NOT USE THIS FOR ANYTHING LIKE A REAL SFX DATABASE.
-class Sfx4Global < ActiveRecord::Migration
-  def connection
-    if sfx4_mock_instance?
-      Sfx4::Global::Base.connection.initialize_schema_migrations_table
-      return Sfx4::Global::Base.connection
-    end
-  end
-
-  def change
-    if sfx4_mock_instance?
-      create_table "KB_OBJECTS", {:id => false} do |t|
-        t.integer "OBJECT_ID", :default => 0, :null => false, :limit => 8
-      end
-      execute "ALTER TABLE KB_OBJECTS ADD PRIMARY KEY (OBJECT_ID);"
-    else
-      puts "Skipping SFX Global migration since SFX global DB specified is not a mock instance."
-    end
-  end
-
-  def sfx4_mock_instance?
-    (ActiveRecord::Base.configurations["sfx4_global"] and
-      ActiveRecord::Base.configurations["sfx4_global"]["mock_instance"])
-  end
-end

data/test/fixtures/sfx4/global/KB_OBJECTS.yml

@@ -1,46 +0,0 @@
-kb_object1:
-  OBJECT_ID: 954921332001
-kb_object2: 
-  OBJECT_ID: 954921332002
-kb_object3: 
-  OBJECT_ID: 954921332003
-kb_object4: 
-  OBJECT_ID: 954921332004
-kb_object5: 
-  OBJECT_ID: 954921333005
-kb_object6: 
-  OBJECT_ID: 954921333006
-kb_object7: 
-  OBJECT_ID: 954921333007
-kb_object8: 
-  OBJECT_ID: 954921333008
-kb_object9: 
-  OBJECT_ID: 954921333009
-kb_object10:
-  OBJECT_ID: 954921333010
-kb_object11:
-  OBJECT_ID: 954921333011
-kb_object12:
-  OBJECT_ID: 954921333012
-kb_object13:
-  OBJECT_ID: 954921333013
-kb_object14:
-  OBJECT_ID: 954921333014
-kb_object15:
-  OBJECT_ID: 954921333015
-kb_object16:
-  OBJECT_ID: 954921333016
-kb_object17:
-  OBJECT_ID: 954921333017
-kb_object18:
-  OBJECT_ID: 954921333018
-kb_object19:
-  OBJECT_ID: 954921333019
-kb_object20:
-  OBJECT_ID: 954921333020
-kb_object21:
-  OBJECT_ID: 954921333021
-kb_object22:
-  OBJECT_ID: 954921334022
-kb_object23:
-  OBJECT_ID: 954921334023

data/test/integration/request_test.rb

@@ -1,25 +0,0 @@
-require 'test_helper'
-
-class RequestReuseTest < ActionDispatch::IntegrationTest
-
-    
-  test "simple request" do
-    sess = open_session
-    
-    request_params = { :issn => "012345678" }
-    
-    sess.get "/resolve", request_params
-            
-    
-    # TODO: We ought to be waiting for all bg services in other
-    # threads before ending test. Tricky to figure out
-    # how to do cleanly, we don't even know the request id at the
-    # integration level, unless we do an API request instead of
-    # an HTML request. We'll just wait, sorry. 
-    puts "sleeping"
-    sleep 4
-  end
-  
-  
-  
-end

data/test/performance/browsing_test.rb

@@ -1,9 +0,0 @@
-require 'test_helper'
-require 'rails/performance_test_help'
-
-# Profiling results for each test method are written to tmp/performance.
-class BrowsingTest < ActionDispatch::PerformanceTest
-  #def test_homepage
-  #  get '/'
-  #end
-end