umlaut 3.0.0alpha1

data/test/dummy/config/database-jhu.yml

@@ -0,0 +1,44 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+# UMLAUT: mysql db with mysql2 adapter strongly recommended for Umlaut, in both 
+# production and development. sqlite3 has unclear semantics under threaded 
+# concurrency which umlaut uses, and in many cases simply does not work. 
+#
+# A high (connection) pool setting is also, sadly, generally
+# required at present. 
+#
+# development:
+#   adapter: mysql2
+#   host: 
+#   username:
+#   password:
+#   database:
+#   pool: 30
+
+development:
+  adapter: mysql2
+  database: umlaut3_dev
+  pool: 30 
+  timeout: 5000
+  username: umlaut_app
+  password: uu21
+  host: app01.mse.jhu.edu
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,34 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  #
+  # UMLAUT: Umlaut's use of threading is not compatible with class
+  # reloading, even in development. Umlaut requires true here.
+  # Rails 3.2 _might_ let you get away with false when it comes out.
+  config.cache_classes = true
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+
+  # Do not compress assets
+  config.assets.compress = false
+
+  # Expands the lines which load the assets
+  config.assets.debug = true
+end

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,60 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this)
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS
+  config.assets.compress = true
+
+  # Don't fallback to assets pipeline if a precompiled asset is missed
+  config.assets.compile = false
+
+  # Generate digests for assets URLs
+  config.assets.digest = true
+
+  # Defaults to Rails.root.join("public/assets")
+  # config.assets.manifest = YOUR_PATH
+
+  # Specifies the header that your server uses for sending files
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Use a different logger for distributed setups
+  # config.logger = SyslogLogger.new
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added)
+  # config.assets.precompile += %w( search.js )
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+end

data/test/dummy/config/environments/test.rb

@@ -0,0 +1,39 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite.  You never need to work with it otherwise.  Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs.  Don't rely on the data there!
+  config.cache_classes = true
+
+  # Configure static asset server for tests with Cache-Control for performance
+  config.serve_static_assets = true
+  config.static_cache_control = "public, max-age=3600"
+
+  # Log error messages when you accidentally call methods on nil
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Use SQL instead of Active Record's schema dumper when creating the test database.
+  # This is necessary if your schema can't be completely dumped by the schema dumper,
+  # like if you have constraints or database-specific column types
+  # config.active_record.schema_format = :sql
+
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+end

data/test/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/test/dummy/config/initializers/inflections.rb

@@ -0,0 +1,10 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format
+# (all these examples are active by default):
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end

data/test/dummy/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/test/dummy/config/initializers/secret_token.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+Dummy::Application.config.secret_token = 'c4943e40548e96896e3aa5d03bba3be644ddcf945569e8ef089578207dd8f55f57e83893158352dff0333e07231a64ce2ee4bf696e5e85334ec6f37d97d77253'

data/test/dummy/config/initializers/session_store.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+Dummy::Application.config.session_store :cookie_store, :key => '_dummy_session'
+
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rails generate session_migration")
+# Dummy::Application.config.session_store :active_record_store

data/test/dummy/config/initializers/wrap_parameters.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+#
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters :format => [:json]
+end
+
+# Disable root element in JSON by default.
+ActiveSupport.on_load(:active_record) do
+  self.include_root_in_json = false
+end

data/test/dummy/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"

data/test/dummy/config/routes.rb

@@ -0,0 +1,61 @@
+Dummy::Application.routes.draw do
+    
+  Umlaut::Routes.new(self).draw
+
+  # The priority is based upon order of creation:
+  # first created -> highest priority.
+
+  # Sample of regular route:
+  #   match 'products/:id' => 'catalog#view'
+  # Keep in mind you can assign values other than :controller and :action
+
+  # Sample of named route:
+  #   match 'products/:id/purchase' => 'catalog#purchase', :as => :purchase
+  # This route can be invoked with purchase_url(:id => product.id)
+
+  # Sample resource route (maps HTTP verbs to controller actions automatically):
+  #   resources :products
+
+  # Sample resource route with options:
+  #   resources :products do
+  #     member do
+  #       get 'short'
+  #       post 'toggle'
+  #     end
+  #
+  #     collection do
+  #       get 'sold'
+  #     end
+  #   end
+
+  # Sample resource route with sub-resources:
+  #   resources :products do
+  #     resources :comments, :sales
+  #     resource :seller
+  #   end
+
+  # Sample resource route with more complex sub-resources
+  #   resources :products do
+  #     resources :comments
+  #     resources :sales do
+  #       get 'recent', :on => :collection
+  #     end
+  #   end
+
+  # Sample resource route within a namespace:
+  #   namespace :admin do
+  #     # Directs /admin/products/* to Admin::ProductsController
+  #     # (app/controllers/admin/products_controller.rb)
+  #     resources :products
+  #   end
+
+  # You can have the root of your site routed with "root"
+  # just remember to delete public/index.html.
+  # root :to => 'welcome#index'
+
+  # See how all your routes lay out with "rake routes"
+
+  # This is a legacy wild controller route that's not recommended for RESTful applications.
+  # Note: This route will make all actions in every controller accessible via GET requests.
+  # match ':controller(/:action(/:id(.:format)))'
+end

data/test/dummy/config/umlaut_services.yml

@@ -0,0 +1,237 @@
+
+  # Configure what service plugins are used by Umlaut. This skeleton file
+  # has been generated into your app to help you get started. 
+  #
+  # If a service has "disabled:true", it's currently turned off. 
+  #
+  # Some services require local api key or connection details as config.
+  # Most services take other options for custom configuration too, not
+  # all options are neccesarily listed as examples here, see source
+  # or source-generated docs for more info.   
+
+default:
+    services:
+      
+      # SFX has pubmed lookup built in, so this service not generally
+      # needed with SFX, but included here as an example of it's availability
+      Pubmed:
+        disabled: true
+        priority: 0
+      
+      # Priority 3
+      
+      SFX:
+        type: Sfx
+        disabled: true
+        display_name: Find It       
+        base_url: YOUR_SFX_BASE_URL
+        priority: 3      
+      
+        
+      # First half of Amazon, run in foreground, get metadata and cover images.
+      Amazon:
+        disabled: true
+        display_name: Amazon.com
+        type: Amazon
+        url: http://webservices.amazon.com/onca/xml
+        api_key: "NEED_API_KEY"
+        secret_key: "NEED_SECRET_KEY"
+        associate_tag: "NEED_ASSOCIATE_ID"
+        priority: 3
+        service_types:
+          - abstract
+          - referent_enhance
+          - cover_image
+          
+      
+      # Priority c  : Background          
+      
+      # Second half of Amazon. It's Slow to lookup highlighted_link and search_inside
+      # availability, so we do it in a bg wave.  
+      Amazon_bg:
+        type: Amazon
+        disabled: true        
+        api_key: "NEED_API_KEY"
+        secret_key: "NEED_SECRET_KEY"
+        associate_tag: "NEED_ASSOCIATE_ID"
+        priority: c        
+        make_aws_call: false
+        service_types:
+          - highlighted_link
+          - search_inside
+          - excerpts
+          
+
+      
+      CoverThing:
+        type: CoverThing
+        disabled: true        
+        developer_key: YOUR_LT_KEY
+        priority: c
+        # Pre-empted by says if we already have a cover_image response
+        # from somewhere else that runs earlier, don't run this. 
+        preempted_by:
+          existing_type: cover_image
+          
+      ElsevierCover:
+        type: ElsevierCover
+        priority: c
+        
+      UlrichsCover:
+        type: UlrichsCover
+        priority: c      
+          
+      GoogleBookSearch:
+        type: GoogleBookSearch
+        disabled: true
+        priority: c        
+        api_key: 'YOUR_GBS_API_KEY'
+                
+      Ulrichs:
+        display_name: "Ulrich's Directory"
+        type: UlrichsLink
+        priority: c
+        
+      IsbnDb:
+        display_name: isbndb.com
+        disabled: true
+        type: IsbnDb
+        priority: c
+        access_key: YOUR_ISBNDB_ACCESS_KEY
+        
+      InternetArchive:
+        display_name: the Internet Archive
+        type: InternetArchive
+        priority: c
+        # disable audio results? uncomment:
+        #num_results_for_types:
+        #  audio: 0
+      
+      
+      # Priority d
+                
+      HathiTrust:
+        type: HathiTrust
+        priority: d
+        # Uncomment to link through this 'internal' URL instead
+        # of following permalinks. jrochkind does this to use
+        # a WAYFless shibboleth login with EZProxy. 
+        #direct_link_base: 'https://babel.hathitrust.org/shcgi/'
+        #
+        # This next says:
+        # Don't add HathiTrust fulltext if there's already a
+        # GoogleBookSearch fulltext. Still add other HT response
+        # types. 
+        preempted_by:
+          self_type: fulltext
+          existing_service: GoogleBookSearch
+          existing_type: fulltext
+          
+      EmailExport:
+        type: EmailExport
+        priority: d
+        
+      TxtHoldingExport:
+        type: TxtHoldingExport
+        priority: d
+      
+        
+      
+      ScopusCitations:
+        type: Scopus
+        disabled: true
+        priority: c
+        json_api_key: YOUR_SCOPUS_API_KEY
+        partner_id: YOUR_SCOPUS_PARTNER_ID
+        link_salt_key: "YOUR_SCOPUS_LINK_SALT_KEY"
+        
+      # Web of Knowledge API has no api key, but your
+      # IP needs to be registered with them. See source docs
+      # for how. 
+      IsiCitations:
+        type: Isi
+        disabled: true
+        priority: c
+        
+      # Thomson JCR LAMR api has no api key, but your
+      # IP needs to be registered with them. Same registraiton
+      # as for ISI WoK generally. 
+      Jcr:
+        type: Jcr
+        disabled: true
+        priority: c
+        
+      # Worldcat scraper can be quite slow, move it to wave 'd' to avoid
+      # holding up wave 'c'
+      Worldcat:
+        display_name: OCLC Worldcat.org
+        type: Worldcat
+        priority: d
+        # suppress_precheck says don't actually screen-scrape to
+        # see if the link is good, just link blindly. Mostly works
+        # for WorldCat, avoids the performance hit. 
+        suppress_precheck: true
+      
+      
+      WorldcatIdentities:
+        type: WorldcatIdentities
+        priority: d
+        # Turn off certain response types:
+        #note_types: false
+        #wikipedia_link: false
+        #openurl_widely_held: false
+        #require_identifier: true
+      
+      
+      # GPO is kind of experimental, it doesn't work great, but IF an 
+      # OpenURL includes a sudoc call number or other GPO identifiers,
+      # will try to link to full text via GPO catalog scrape. 
+      Gpo:
+        type: Gpo
+        disabled: true
+        priority: e
+        #preempted_by:
+        #  - existing_type: fulltext
+        #  - existing_type: fulltext_title_level
+
+
+      ####
+      # Link out filters: Effect what happens when a user clicks
+      # on an Umlaut link to a third party source. Link out filters
+      # can operate to change where link goes or execute side effects
+      # on click. 
+      ####
+
+      # Redirect outgoing links through EZProxy                
+      EZProxy:
+        type: Ezproxy
+        disabled: true
+        task: link_out_filter  
+        proxy_server:  HOSTNAME_OF_YOUR_EZPROXY
+        # By default, will pre-check with EZProxy api and
+        # only send links through EZProxy that are proxyable.
+        # requires proxy_password to be set. 
+        # optionally, set precheck_with_api false, and the EZProxy
+        # api won't be used, ALL links go through EZProxy. You may
+        # have EZProxy itself set to transparently redirect non-proxyable
+        # URLs back to non-proxied version.
+        #
+        #precheck_with_api: false
+        priority: 5
+        proxy_password: YOUR_EZPROXY_API_PWD
+        # Want to exclude certain hostnames from being directed through EZProxy?
+        # list them in array here:
+        #exclude: [ host.unversity.edu, otherhost.somewhere.com]
+        
+        
+      # Use of SFX api means that SFX can no longer keep statistics on
+      # clickthroughs. This link out filter will attempt to fake SFX into
+      # thinking a direct click happened when user clicks on an SFX link
+      # via Umlaut.  This is VERY fragile logic, required reverse engineering
+      # SFX and faking it out, still doesn't work all the time. But works
+      # much of the time. 
+      SFX_backchannel_record:
+        disabled: true
+        type: SfxBackchannelRecord
+        task: link_out_filter
+        priority: 6