arclight 0.2.0 → 1.6.2

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

@@ -1,42 +1,53 @@
 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"
+  contact_html: |
+    <div class="al-repository-contact-info"><a href="mailto:hmdref@nlm.nih.gov">hmdref@nlm.nih.gov</a></div>
+  location_html: |
+    <div class="al-repository-street-address-building">Building 38, Room 1E-21</div>
+    <div class="al-repository-street-address-address1">8600 Rockville Pike</div>
+    <div class="al-repository-street-address-city_state_zip_country">Bethesda, MD 20894, USA</div>
+  thumbnail_url: "https://upload.wikimedia.org/wikipedia/commons/thumb/8/8b/United_States_National_Library_of_Medicine_1999.jpg/500px-United_States_National_Library_of_Medicine_1999.jpg"
+  request_types:
+    google_form:
+      request_url: 'https://docs.google.com/a/stanford.edu/forms/d/e/1FAIpQLSeOamhY_IcFw4sPnz0ddwWWkrPaHbM5wp7JVbOLOL_mIusEyw/viewform'
+      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'
+  contact_html: |
+    <div class="al-repository-contact-phone">(650) 725-1022</div>
+    <div class="al-repository-contact-info"><a href="mailto:specialcollections@stanford.edu">specialcollections@stanford.edu</a></div>
+  location_html: |
+    <div class="al-repository-street-address-building">Green Library</div>
+    <div class="al-repository-street-address-address1">557 Escondido Mall</div>
+    <div class="al-repository-street-address-city_state_zip_country">Stanford, CA 94305, USA</div>
+  thumbnail_url: 'https://upload.wikimedia.org/wikipedia/commons/thumb/2/2b/Stanford_University_Green_Library_Bing_Wing.jpg/500px-Stanford_University_Green_Library_Bing_Wing.jpg'
+  request_types:
+    aeon_web_ead:
+      request_url: 'https://sample.request.com'
+      request_mappings: 'Action=10&Form=31&Value=ead_url'
+
 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'
+  contact_html: |
+    <div class="al-repository-contact-info"><a href="mailto:bentley.ref@umich.edu">bentley.ref@umich.edu</a></div>
+  location_html: |
+    <div class="al-repository-street-address-address1">1150 Beal Ave</div>
+    <div class="al-repository-street-address-city_state_zip_country">Ann Arbor, MI 48109-2113, USA</div>
   thumbnail_url: 'https://upload.wikimedia.org/wikipedia/commons/thumb/9/93/Bhlexterior.jpg/150px-Bhlexterior.jpg'
+  request_types:
+    aeon_external_request_endpoint:
+      request_url: https://example.com/aeon/aeon.dll
+      request_mappings:
+        url_params:
+          Action: 11
+          Type: 200
+        static:
+          SystemId: ArcLight
+          ItemInfo1: manuscript
+        accessor:
+          ItemTitle: collection_name

data/lib/generators/arclight/update_generator.rb

@@ -9,7 +9,7 @@ module Arclight
   # 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__)
+    source_root File.expand_path('templates', __dir__)
 
     def create_blacklight_catalog
       copy_file 'catalog_controller.rb', 'app/controllers/catalog_controller.rb'

data/lib/tasks/index.rake

@@ -4,7 +4,7 @@ require 'arclight'
 require 'benchmark'
 
 ##
-# Environment variables for indexing:
+# Environment variables and information for indexing:
 #
 # REPOSITORY_ID for the repository id/slug to load repository data from
 # your configuration (default: none).
@@ -12,25 +12,29 @@ require 'benchmark'
 # REPOSITORY_FILE for the YAML file of your repository configuration
 # (default: config/repositories.yml).
 #
-# SOLR_URL for the location of your Solr instance
+# Blacklight default connection for the location of your Solr instance, SOLR_URL
+# as a backup
 # (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
+  # We need :environment to have access to the Blacklight confg
+  task index: :environment do
     raise 'Please specify your EAD document, ex. FILE=<path/to/ead.xml>' unless ENV['FILE']
-    print "Loading #{ENV['FILE']} into index...\n"
-    load_indexer # a leftover construct from solr_ead. Likely will need to be removed/modified when we remove that
-    elapsed_time = Benchmark.realtime { 
-      `bundle exec traject -u #{ENV['SOLR_URL']} -i xml -c #{Arclight::Engine.root}/lib/arclight/traject/ead2_config.rb #{ENV['FILE']}`
-    }
-    print "Indexed #{ENV['FILE']} (in #{elapsed_time.round(3)} secs).\n"
+
+    print "Loading #{ENV.fetch('FILE', nil)} into index...\n"
+    solr_url = ENV.fetch('SOLR_URL', Blacklight.default_index.connection.base_uri)
+    elapsed_time = Benchmark.realtime do
+      `bundle exec traject -u #{solr_url} -i xml -c #{Arclight::Engine.root}/lib/arclight/traject/ead2_config.rb #{ENV.fetch('FILE', nil)}`
+    end
+    print "Indexed #{ENV.fetch('FILE', nil)} (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|
+
+    Dir.glob(File.join(ENV.fetch('DIR', nil), '*.xml')).each do |file|
       system("rake arclight:index FILE=#{file}")
     end
   end
@@ -38,7 +42,8 @@ namespace :arclight do
   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']))
+
+    ead = Nokogiri::XML(open(ENV.fetch('URL', nil)))
     tmp = Tempfile.new(["#{Time.now.to_i}-", '.xml'], encoding: 'utf-8')
     begin
       tmp.write ead
@@ -55,35 +60,25 @@ namespace :arclight do
   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|
+
+    File.open(ENV.fetch('BATCH', nil)).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']}"
+
+      unless ENV.fetch('URL', nil) =~ /\A#{URI::DEFAULT_PARSER.make_regexp(%w[http https])}\z/
+        puts "Skipping invalid looking url #{ENV.fetch('URL', nil)}"
         next
       end
-      puts "Indexing #{ENV['URL']}"
+      puts "Indexing #{ENV.fetch('URL', nil)}"
       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
+  task destroy_index_docs: :environment do
     puts 'Deleting all documents from index...'
-    indexer = load_indexer
-    indexer.delete_all
+    Blacklight.default_index.connection.delete_by_query('*:*')
+    Blacklight.default_index.connection.commit
   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

@@ -1,24 +1,30 @@
 {
   "name": "arclight",
-  "description": "",
-  "main": "index.js",
-  "dependencies": {},
+  "version": "1.6.0",
+  "description": "The frontend for arclight",
+  "main": "app/assets/javascript/arclight/arclight.js",
+  "files": ["app/assets"],
   "devDependencies": {
-    "eslint": "^3.19.0",
-    "eslint-config-airbnb-base": "^11.1.3",
-    "eslint-plugin-import": "^2.2.0"
+    "eslint": "^8.26.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-plugin-import": "^2.2.0",
+    "sass": "^1.59.3",
+    "bootstrap": "^5.2.0"
   },
   "scripts": {
+    "build": "sass ./app/assets/stylesheets/arclight/build.scss:./app/assets/builds/arclight.css --no-source-map --load-path=node_modules",
+    "lint": "eslint './app/assets/javascripts/**/*.{js,es6}'",
+    "lint:fix": "eslint --fix './app/assets/javascripts/**/*.{js,es6}'",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/sul-dlss/arclight.git"
+    "url": "https://github.com/projectblacklight/arclight.git"
   },
   "author": "",
   "license": "Apache-2.0",
   "bugs": {
-    "url": "https://github.com/sul-dlss/arclight/issues"
+    "url": "https://github.com/projectblacklight/arclight/issues"
   },
-  "homepage": "https://github.com/sul-dlss/arclight#readme"
+  "homepage": "https://library.stanford.edu/projects/arclight"
 }