arclight 0.0.1 → 0.1.0

data/lib/generators/arclight/templates/config/downloads.yml

@@ -0,0 +1,13 @@
+#
+# downloads.yml - Use the EAD's <unitid> as the primary key and
+#                 provide the PDF and/or EAD (.xml) links. The
+#                 size value should be a String (shown as-is) or
+#                 the number of bytes in the download.
+#
+sample_unitid:
+  pdf:
+    href: 'http://example.com/sample.pdf'
+    size: '1.23MB'
+  ead:
+    href: 'http://example.com/sample.xml'
+    size: 123456

data/lib/generators/arclight/templates/config/repositories.yml

@@ -0,0 +1,42 @@
+nlm:
+  name: 'National Library of Medicine. History of Medicine Division'
+  description: 'NLM’s History of Medicine Division collects, preserves, makes available, and interprets for diverse audiences one of the world’s richest collections of historical material related to human health and disease.'
+  building: 'Building 38, Room 1E-21'
+  address1: '8600 Rockville Pike'
+  address2: ''
+  city: 'Bethesda'
+  state: 'MD'
+  zip: '20894'
+  country: 'USA'
+  phone: ''
+  contact_info: 'hmdref@nlm.nih.gov'
+  thumbnail_url: "https://collections.nlm.nih.gov/pageturnerserver/ajaxp?theurl=http://localhost:8080/fedora/get/nlm:nlmuid-101421040-img/THUMB"
+  google_request_url: 'https://docs.google.com/a/stanford.edu/forms/d/e/1FAIpQLSeOamhY_IcFw4sPnz0ddwWWkrPaHbM5wp7JVbOLOL_mIusEyw/viewform'
+  google_request_mappings: "document_url=entry.1980510262&collection_name=entry.619150170&collection_creator=entry.14428541&eadid=entry.996397105&containers=entry.1125277048&title=entry.862815208"
+sul-spec:
+  name: 'Stanford University Libraries. Special Collections and University Archives'
+  visit_note: 'Special Collections and University Archives materials are stored offsite and must be paged 36 hours in advance.'
+  description: 'The Special Collections and University Archives Department of Stanford University Libraries is committed to acquiring, preserving, and providing access to primary source materials that support the research needs of the Stanford community and beyond. There are three distinct divisions in our department: Manuscripts, Rare Books and University Archives. We welcome all students, scholars and members of the general public to the Field Reading Room. Learn more about using and accessing our collections.'
+  building: 'Green Library'
+  address1: '557 Escondido Mall'
+  address2: ''
+  city: 'Stanford'
+  state: 'CA'
+  zip: '94305'
+  country: 'USA'
+  phone: '(650) 725-1022'
+  contact_info: 'specialcollections@stanford.edu'
+  thumbnail_url: 'https://library.stanford.edu/sites/default/files/styles/150x150/public/collection/image/Collections-Super-Enlight.jpg'
+umich-bhl:
+  name: 'University of Michigan. Bentley Historical Library'
+  description: 'The Bentley Historical Library collects the materials for and promotes the study of the histories of two great, intertwined institutions, the State of Michigan and the University of Michigan. The Library is open without fee to the public, and we welcome researchers regardless of academic or professional affiliation.'
+  building: ''
+  address1: '1150 Beal Ave'
+  address2: ''
+  city: 'Ann Arbor'
+  state: 'MI'
+  zip: '48109-2113'
+  country: 'USA'
+  phone: ''
+  contact_info: 'bentley.ref@umich.edu'
+  thumbnail_url: 'https://upload.wikimedia.org/wikipedia/commons/thumb/9/93/Bhlexterior.jpg/150px-Bhlexterior.jpg'

data/lib/generators/arclight/update_generator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'generators/arclight/install_generator'
+
+module Arclight
+  ##
+  # Arclight Update generator. This subclasses the Install generator, so this is
+  # intended to override behavior in the install generator that can allow the
+  # downstream application to choose if they want to take our changes or not and
+  # can choose to see a diff of our changes to help them decide.
+  class Update < Arclight::Install
+    source_root File.expand_path('../templates', __FILE__)
+
+    def create_blacklight_catalog
+      copy_file 'catalog_controller.rb', 'app/controllers/catalog_controller.rb'
+    end
+
+    def solr_config
+      directory '../../../../solr', 'solr'
+    end
+  end
+end

data/lib/tasks/index.rake

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'arclight'
+require 'benchmark'
+
+##
+# Environment variables for indexing:
+#
+# REPOSITORY_ID for the repository id/slug to load repository data from
+# your configuration (default: none).
+#
+# REPOSITORY_FILE for the YAML file of your repository configuration
+# (default: config/repositories.yml).
+#
+# SOLR_URL for the location of your Solr instance
+# (default: http://127.0.0.1:8983/solr/blacklight-core)
+#
+namespace :arclight do
+  desc 'Index an EAD document, use FILE=<path/to/ead.xml> and REPOSITORY_ID=<myid>'
+  task :index do
+    raise 'Please specify your EAD document, ex. FILE=<path/to/ead.xml>' unless ENV['FILE']
+    indexer = load_indexer
+    print "Loading #{ENV['FILE']} into index...\n"
+    elapsed_time = Benchmark.realtime { indexer.update(ENV['FILE']) }
+    print "Indexed #{ENV['FILE']} (in #{elapsed_time.round(3)} secs).\n"
+  end
+
+  desc 'Index a directory of EADs, use DIR=<path/to/directory> and REPOSITORY_ID=<myid>'
+  task :index_dir do
+    raise 'Please specify your directory, ex. DIR=<path/to/directory>' unless ENV['DIR']
+    Dir.glob(File.join(ENV['DIR'], '*.xml')).each do |file|
+      system("rake arclight:index FILE=#{file}")
+    end
+  end
+
+  desc 'Index an EAD document, use URL=<http[s]://domain/path/to/ead.xml> and REPOSITORY_ID=<myid>'
+  task :index_url do
+    raise 'Please specify your EAD document, ex. URL=<http[s]://domain/path/to/ead.xml>' unless ENV['URL']
+    ead = Nokogiri::XML(open(ENV['URL']))
+    tmp = Tempfile.new(["#{Time.now.to_i}-", '.xml'], encoding: 'utf-8')
+    begin
+      tmp.write ead
+      puts "Downloaded EAD to #{tmp.path}"
+      ENV['FILE'] = tmp.path
+      Rake::Task['arclight:index'].invoke
+      Rake::Task['arclight:index'].reenable
+      tmp.close
+    ensure
+      tmp.delete
+    end
+  end
+
+  desc 'Index EADs from a file of URLs, use BATCH=<path/to/urls.txt> and REPOSITORY_ID=<myid>'
+  task :index_url_batch do
+    raise 'Please specify your URLs file, ex. BATCH=<path/to/urls.txt>' unless ENV['BATCH']
+    File.open(ENV['BATCH']).each_line do |l|
+      ENV['URL'] = l.chomp
+      next if ENV['URL'].empty?
+      unless ENV['URL'] =~ /\A#{URI.regexp(%w[http https])}\z/
+        puts "Skipping invalid looking url #{ENV['URL']}"
+        next
+      end
+      puts "Indexing #{ENV['URL']}"
+      Rake::Task['arclight:index_url'].invoke
+      Rake::Task['arclight:index_url'].reenable
+    end
+  end
+
+  desc 'Destroy all documents in the index'
+  task :destroy_index_docs do
+    puts 'Deleting all documents from index...'
+    indexer = load_indexer
+    indexer.delete_all
+  end
+end
+
+def load_indexer
+  # hardcoded since we don't have access to Blacklight.connection_config[:url] here
+  ENV['SOLR_URL'] ||= 'http://127.0.0.1:8983/solr/blacklight-core'
+
+  options = {
+    document: Arclight::CustomDocument,
+    component: Arclight::CustomComponent
+  }
+
+  Arclight::Indexer.new(options)
+end

data/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "arclight",
+  "description": "",
+  "main": "index.js",
+  "dependencies": {},
+  "devDependencies": {
+    "eslint": "^3.19.0",
+    "eslint-config-airbnb-base": "^11.1.3",
+    "eslint-plugin-import": "^2.2.0"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sul-dlss/arclight.git"
+  },
+  "author": "",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/sul-dlss/arclight/issues"
+  },
+  "homepage": "https://github.com/sul-dlss/arclight#readme"
+}

data/solr/conf/_rest_managed.json

@@ -0,0 +1,3 @@
+{
+  "initArgs":{},
+  "managedList":[]}

data/solr/conf/admin-extra.html

@@ -0,0 +1,31 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<!-- The content of this page will be statically included into the top
+of the admin page.  Uncomment this as an example to see there the content
+will show up.
+
+<hr>
+<i>This line will appear before the first table</i>
+<tr>
+<td colspan="2">
+This row will be appended to the end of the first table
+</td>
+</tr>
+<hr>
+
+-->

data/solr/conf/elevate.xml

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<!-- If this file is found in the config directory, it will only be
+     loaded once at startup.  If it is found in Solr's data
+     directory, it will be re-loaded every commit.
+-->
+
+<elevate>
+ <query text="foo bar">
+  <doc id="1" />
+  <doc id="2" />
+  <doc id="3" />
+ </query>
+ 
+ <query text="ipod">
+   <doc id="MA147LL/A" />  <!-- put the actual ipod at the top -->
+   <doc id="IW-02" exclude="true" /> <!-- exclude this cable -->
+ </query>
+ 
+</elevate>

data/solr/conf/mapping-ISOLatin1Accent.txt

@@ -0,0 +1,246 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Syntax:
+#   "source" => "target"
+#     "source".length() > 0 (source cannot be empty.)
+#     "target".length() >= 0 (target can be empty.)
+
+# example:
+#   "??" => "A"
+#   "\u00C0" => "A"
+#   "\u00C0" => "\u0041"
+#   "??" => "ss"
+#   "\t" => " "
+#   "\n" => ""
+
+# ?? => A
+"\u00C0" => "A"
+
+# ?? => A
+"\u00C1" => "A"
+
+# ?? => A
+"\u00C2" => "A"
+
+# ?? => A
+"\u00C3" => "A"
+
+# ?? => A
+"\u00C4" => "A"
+
+# ?? => A
+"\u00C5" => "A"
+
+# ?? => AE
+"\u00C6" => "AE"
+
+# ?? => C
+"\u00C7" => "C"
+
+# ?? => E
+"\u00C8" => "E"
+
+# ?? => E
+"\u00C9" => "E"
+
+# ?? => E
+"\u00CA" => "E"
+
+# ?? => E
+"\u00CB" => "E"
+
+# ?? => I
+"\u00CC" => "I"
+
+# ?? => I
+"\u00CD" => "I"
+
+# ?? => I
+"\u00CE" => "I"
+
+# ?? => I
+"\u00CF" => "I"
+
+# ?? => IJ
+"\u0132" => "IJ"
+
+# ?? => D
+"\u00D0" => "D"
+
+# ?? => N
+"\u00D1" => "N"
+
+# ?? => O
+"\u00D2" => "O"
+
+# ?? => O
+"\u00D3" => "O"
+
+# ?? => O
+"\u00D4" => "O"
+
+# ?? => O
+"\u00D5" => "O"
+
+# ?? => O
+"\u00D6" => "O"
+
+# ?? => O
+"\u00D8" => "O"
+
+# ?? => OE
+"\u0152" => "OE"
+
+# ??
+"\u00DE" => "TH"
+
+# ?? => U
+"\u00D9" => "U"
+
+# ?? => U
+"\u00DA" => "U"
+
+# ?? => U
+"\u00DB" => "U"
+
+# ?? => U
+"\u00DC" => "U"
+
+# ?? => Y
+"\u00DD" => "Y"
+
+# ?? => Y
+"\u0178" => "Y"
+
+# ?? => a
+"\u00E0" => "a"
+
+# ?? => a
+"\u00E1" => "a"
+
+# ?? => a
+"\u00E2" => "a"
+
+# ?? => a
+"\u00E3" => "a"
+
+# ?? => a
+"\u00E4" => "a"
+
+# ?? => a
+"\u00E5" => "a"
+
+# ?? => ae
+"\u00E6" => "ae"
+
+# ?? => c
+"\u00E7" => "c"
+
+# ?? => e
+"\u00E8" => "e"
+
+# ?? => e
+"\u00E9" => "e"
+
+# ?? => e
+"\u00EA" => "e"
+
+# ?? => e
+"\u00EB" => "e"
+
+# ?? => i
+"\u00EC" => "i"
+
+# ?? => i
+"\u00ED" => "i"
+
+# ?? => i
+"\u00EE" => "i"
+
+# ?? => i
+"\u00EF" => "i"
+
+# ?? => ij
+"\u0133" => "ij"
+
+# ?? => d
+"\u00F0" => "d"
+
+# ?? => n
+"\u00F1" => "n"
+
+# ?? => o
+"\u00F2" => "o"
+
+# ?? => o
+"\u00F3" => "o"
+
+# ?? => o
+"\u00F4" => "o"
+
+# ?? => o
+"\u00F5" => "o"
+
+# ?? => o
+"\u00F6" => "o"
+
+# ?? => o
+"\u00F8" => "o"
+
+# ?? => oe
+"\u0153" => "oe"
+
+# ?? => ss
+"\u00DF" => "ss"
+
+# ?? => th
+"\u00FE" => "th"
+
+# ?? => u
+"\u00F9" => "u"
+
+# ?? => u
+"\u00FA" => "u"
+
+# ?? => u
+"\u00FB" => "u"
+
+# ?? => u
+"\u00FC" => "u"
+
+# ?? => y
+"\u00FD" => "y"
+
+# ?? => y
+"\u00FF" => "y"
+
+# ??? => ff
+"\uFB00" => "ff"
+
+# ??? => fi
+"\uFB01" => "fi"
+
+# ??? => fl
+"\uFB02" => "fl"
+
+# ??? => ffi
+"\uFB03" => "ffi"
+
+# ??? => ffl
+"\uFB04" => "ffl"
+
+# ??? => ft
+"\uFB05" => "ft"
+
+# ??? => st
+"\uFB06" => "st"