hyrax 3.2.0 → 3.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1dfd66c313400a16a149d5bdb7a2495164c18bce86b9bd8f079970b68e328cf
-  data.tar.gz: 66c678a483a9f2822712dea5f8448e55d9019dbdc47605b9a03177d0465ab775
+  metadata.gz: 865d623446e36dc64e73cf82ef855955e83d8d8f730a65f439b9b89664641c3f
+  data.tar.gz: 87aec067e009093bbd119d6d39639c5c6927b2b26173088ca7000b1241f71caa
 SHA512:
-  metadata.gz: 8309e7eb25d84767fd2395e04326df0c1f925bef0a2618818b0430327ac623f0f4078abbd45b5a966ccb6ccbc4c6bc233823e7d1b00d08b5e977771c97be4306
-  data.tar.gz: dd759280930d7cbc3448b3fafbfae5bbb631f9eb8fb93a9dca2e9ee73b3226f71d5b453ec29a40ac087dacf076059b752e8e72b2b9e35c5efab1b54743a1e958
+  metadata.gz: d75dbf03372ee072f394a88af8449ff947ff42b21de9b10a83428ac98af5d01783f21e7f123ee00e3c0dd7b6d3808d4e7d59f0238e1fda703da8358d2b567447
+  data.tar.gz: 6dae952fde3a2f2fdc329775d8efe14929e23c0f92284d1848abfa8a7a8a041e4b5a197a4fa0581d3934ddc9267d0e3ca64c455a5f65b81f5287bde8110fb19e

data/.circleci/config.yml

@@ -33,10 +33,9 @@ jobs:
             fi
             [[ -z "$(git branch --all --list master */master)" ]]
 
-      - samvera/bundle_for_gem:
+      - samvera/bundle:
           ruby_version: << parameters.ruby_version >>
           bundler_version: << parameters.bundler_version >>
-          project: hyrax
 
       # Run rubocop in parallel with caching
       # This should get added to the orb once proven here
@@ -89,10 +88,9 @@ jobs:
           at: ~/
       - samvera/engine_cart_generate:
           cache_key: v1-internal-test-app-{{ checksum "hyrax.gemspec" }}-{{ checksum ".regen" }}-{{ checksum ".circleci/config.yml" }}-<< parameters.rails_version >>-<< parameters.ruby_version >>
-      - samvera/bundle_for_gem:
+      - samvera/bundle:
           ruby_version: << parameters.ruby_version >>
           bundler_version: << parameters.bundler_version >>
-          project: hyrax
       - persist_to_workspace:
           root: ~/
           paths:
@@ -128,10 +126,9 @@ jobs:
           solr_config_path: .internal_test_app/solr/conf
           core_name: hyrax-valkyrie-test
       # Rerun bundler in case this is a different ruby version than bundle and build steps
-      - samvera/bundle_for_gem:
+      - samvera/bundle:
           ruby_version: << parameters.ruby_version >>
           bundler_version: << parameters.bundler_version >>
-          project: hyrax
       - run:
           command: bundle exec rake app:db:migrate
       - samvera/parallel_rspec

data/.dassie/.env

@@ -1,4 +1,4 @@
 MEMCACHED_HOST=memcached
-HYRAX_ANALYTICS=1
 REDIS_PROVIDER=SIDEKIQ_REDIS_URL
 SIDEKIQ_REDIS_URL=redis://redis:6379/0
+SEED_DASSIE=true

data/.dassie/Gemfile

@@ -52,11 +52,15 @@ gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
 
 gemspec name: 'hyrax', path: ENV.fetch('HYRAX_ENGINE_PATH', '..')
 
-gem 'rsolr', '>= 1.0', '< 3'
 gem 'bootstrap-sass', '~> 3.0'
-gem 'twitter-typeahead-rails', '0.11.1.pre.corejavascript'
-gem 'jquery-rails'
 gem 'devise'
 gem 'devise-guests', '~> 0.6'
+gem 'jquery-rails'
+gem 'pry-byebug'
+gem 'pry-doc'
+gem 'pry-rails'
+gem 'pry-rescue'
 gem 'riiif', '~> 2.1'
+gem 'rsolr', '>= 1.0', '< 3'
 gem 'sidekiq', '~> 6.0'
+gem 'twitter-typeahead-rails', '0.11.1.pre.corejavascript'

data/.dassie/app/models/user.rb

@@ -5,8 +5,6 @@ class User < ApplicationRecord
   include Hyrax::User
   include Hyrax::UserUsageStats
 
-
-
   if Blacklight::Utils.needs_attr_accessible?
     attr_accessible :email, :password, :password_confirmation
   end

data/.dassie/config/analytics.yml

@@ -1,6 +1,13 @@
 analytics:
-  app_name: My App Name
-  app_version: 0.0.1
-  privkey_path: /tmp/privkey.p12
-  privkey_secret: s00pers3kr1t
-  client_email: oauth@example.org
+  google:
+    analytics_id: <%= ENV['GOOGLE_ANALYTICS_ID'] %>
+    app_name: <%= ENV['GOOGLE_OAUTH_APP_NAME'] %>
+    app_version: <%= ENV['GOOGLE_OAUTH_APP_VERSION'] %>
+    privkey_path: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_PATH'] %>
+    privkey_secret: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_SECRET'] %>
+    client_email: <%= ENV['GOOGLE_OAUTH_CLIENT_EMAIL'] %>
+  matomo: 
+    base_url: <%= ENV['MATOMO_BASE_URL'] %>
+    site_id: <%= ENV['MATOMO_SITE_ID'] %>
+    auth_token: <%= ENV['MATOMO_AUTH_TOKEN'] %>
+    

data/.dassie/config/environments/development.rb

@@ -29,6 +29,8 @@ Rails.application.configure do
     config.cache_store = :null_store
   end
 
+  config.web_console.whitelisted_ips = ['172.18.0.0/16', '172.27.0.0/16', '0.0.0.0/0']
+
   # Store uploaded files on the local file system (see config/storage.yml for options)
   config.active_storage.service = :local
 

data/.dassie/config/initializers/hyrax.rb

@@ -5,6 +5,8 @@ Hyrax.config do |config|
   # Defaults to false.  See README for more info
   config.arkivo_api = true
 
+  config.analytics = ActiveModel::Type::Boolean.new.cast(ENV.fetch('HYRAX_ANALYTICS', 'false'))
+  config.analytics_provider = ENV.fetch('HYRAX_ANALYTICS_PROVIDER', 'google')
   # Injected via `rails g hyrax:work GenericWork`
   config.register_curation_concern :generic_work
   # Injected via `rails g hyrax:work NamespacedWorks::NestedWork`
@@ -13,6 +15,8 @@ Hyrax.config do |config|
   config.register_curation_concern :monograph
 
   config.iiif_image_server = true
+  config.work_requires_files = false
+  config.citations = true
 
   # Returns a URL that resolves to an image provided by a IIIF image server
   config.iiif_image_url_builder = lambda do |file_id, base_url, size, format|
@@ -36,14 +40,22 @@ Hyrax.config do |config|
     config.browse_everything = nil
   end
 
+  # config.geonames_username = ''
+
   ##
   # Set the system-wide virus scanner
   config.virus_scanner = Hyrax::VirusScanner
 
   ##
-  # To index to the Valkyrie core, uncomment the following two lines.
+  # To index to the Valkyrie core, uncomment the following lines.
   # config.query_index_from_valkyrie = true
   # config.index_adapter = :solr_index
+
+  ##
+  # NOTE: To Valkyrie works, use Monograph which is_a Hyrax::Work is_a Valkyrie::Resource
+  # To use Valkyrie models, uncomment the following lines.
+  # config.collection_model = 'Hyrax::PcdmCollection'
+  # config.admin_set_model = 'Hyrax::AdministrativeSet'
 end
 
 Date::DATE_FORMATS[:standard] = "%m/%d/%Y"

data/.dassie/db/migrate/20210921150120_enable_uuid_extension.valkyrie_engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+# This migration comes from valkyrie_engine (originally 20160111215816)
+class EnableUuidExtension < ActiveRecord::Migration[5.0]
+  def change
+    enable_extension 'uuid-ossp'
+  end
+end

data/.dassie/db/migrate/20210921150121_create_orm_resources.valkyrie_engine.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+# This migration comes from valkyrie_engine (originally 20161007101725)
+class CreateOrmResources < ActiveRecord::Migration[5.0]
+  def options
+    if ENV["VALKYRIE_ID_TYPE"] == "string"
+      { id: :text, default: -> { '(uuid_generate_v4())::text' } }
+    else
+      { id: :uuid }
+    end
+  end
+
+  def change
+    create_table :orm_resources, **options do |t|
+      t.jsonb :metadata, null: false, default: {}
+      t.timestamps
+    end
+    add_index :orm_resources, :metadata, using: :gin
+  end
+end

data/.dassie/db/migrate/20210921150122_add_model_type_to_orm_resources.valkyrie_engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+# This migration comes from valkyrie_engine (originally 20170124135846)
+class AddModelTypeToOrmResources < ActiveRecord::Migration[5.0]
+  def change
+    add_column :orm_resources, :resource_type, :string
+  end
+end

data/.dassie/db/migrate/20210921150123_change_model_type_to_internal_model.valkyrie_engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+# This migration comes from valkyrie_engine (originally 20170531004548)
+class ChangeModelTypeToInternalModel < ActiveRecord::Migration[5.1]
+  def change
+    rename_column :orm_resources, :resource_type, :internal_resource
+  end
+end

data/.dassie/db/migrate/20210921150124_create_path_gin_index.valkyrie_engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+# This migration comes from valkyrie_engine (originally 20171011224121)
+class CreatePathGinIndex < ActiveRecord::Migration[5.1]
+  def change
+    add_index :orm_resources, 'metadata jsonb_path_ops', using: :gin
+  end
+end

data/.dassie/db/migrate/20210921150125_create_internal_resource_index.valkyrie_engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+# This migration comes from valkyrie_engine (originally 20171204224121)
+class CreateInternalResourceIndex < ActiveRecord::Migration[5.1]
+  def change
+    add_index :orm_resources, :internal_resource
+  end
+end

data/.dassie/db/migrate/20210921150126_create_updated_at_index.valkyrie_engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+# This migration comes from valkyrie_engine (originally 20180212092225)
+class CreateUpdatedAtIndex < ActiveRecord::Migration[5.1]
+  def change
+    add_index :orm_resources, :updated_at
+  end
+end

data/.dassie/db/migrate/20210921150127_add_optimistic_locking_to_orm_resources.valkyrie_engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+# This migration comes from valkyrie_engine (originally 20180802220739)
+class AddOptimisticLockingToOrmResources < ActiveRecord::Migration[5.1]
+  def change
+    add_column :orm_resources, :lock_version, :integer
+  end
+end

data/.dassie/db/migrate/20211130181150_create_default_administrative_set.rb

@@ -0,0 +1,8 @@
+class CreateDefaultAdministrativeSet < ActiveRecord::Migration[5.2]
+  def change
+    create_table :hyrax_default_administrative_set do |t|
+      t.string :default_admin_set_id, null: false
+      t.timestamps null: false
+    end
+  end
+end

data/.dassie/db/schema.rb

@@ -10,10 +10,11 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 2020_08_21_212903) do
+ActiveRecord::Schema.define(version: 2021_11_30_181150) do
 
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
+  enable_extension "uuid-ossp"
 
   create_table "bookmarks", id: :serial, force: :cascade do |t|
     t.integer "user_id", null: false
@@ -139,6 +140,12 @@ ActiveRecord::Schema.define(version: 2020_08_21_212903) do
     t.index ["machine_id"], name: "index_hyrax_collection_types_on_machine_id", unique: true
   end
 
+  create_table "hyrax_default_administrative_set", force: :cascade do |t|
+    t.string "default_admin_set_id", null: false
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
   create_table "hyrax_features", force: :cascade do |t|
     t.string "key", null: false
     t.boolean "enabled", default: false, null: false
@@ -225,6 +232,18 @@ ActiveRecord::Schema.define(version: 2020_08_21_212903) do
     t.index ["namespace"], name: "index_minter_states_on_namespace", unique: true
   end
 
+  create_table "orm_resources", id: :uuid, default: -> { "uuid_generate_v4()" }, force: :cascade do |t|
+    t.jsonb "metadata", default: {}, null: false
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.string "internal_resource"
+    t.integer "lock_version"
+    t.index ["internal_resource"], name: "index_orm_resources_on_internal_resource"
+    t.index ["metadata"], name: "index_orm_resources_on_metadata", using: :gin
+    t.index ["metadata"], name: "index_orm_resources_on_metadata_jsonb_path_ops", opclass: :jsonb_path_ops, using: :gin
+    t.index ["updated_at"], name: "index_orm_resources_on_updated_at"
+  end
+
   create_table "permission_template_accesses", force: :cascade do |t|
     t.bigint "permission_template_id"
     t.string "agent_type"

data/.dassie/db/seeds.rb

@@ -1,22 +1,77 @@
-# This file should contain all the record creation needed to seed the database with its default values.
-# The data can then be loaded with the rails db:seed command (or created alongside the database with db:setup).
-#
-# Examples:
-#
-#   movies = Movie.create([{ name: 'Star Wars' }, { name: 'Lord of the Rings' }])
-#   Character.create(name: 'Luke', movie: movies.first)
+wipe_data = ActiveModel::Type::Boolean.new.cast(ENV.fetch('WIPE_DATA', false))
+seed_release_testing = ActiveModel::Type::Boolean.new.cast(ENV.fetch('SEED_RELEASE_TESTING', false))
+seed_dassie = ActiveModel::Type::Boolean.new.cast(ENV.fetch('SEED_DASSIE', false))
 
-Hyrax::Engine.load_seed unless ActiveModel::Type::Boolean.new.cast(ENV["SKIP_HYRAX_ENGINE_SEED"])
+unless wipe_data || seed_release_testing
+  puts 'NAME'
+  puts '     rails db:seed (Hyrax)'
+  puts
+  puts 'SYNOPSIS'
+  puts '     bundle exec rails db:seed [WIPE_DATA=true|false] [SEED_RELEASE_TESTING=true|false] [SEED_DASSIE=true|false]'
+  puts
+  puts 'DESCRIPTION'
+  puts '     Hyrax defined db:seed provides a means to clear repository metadata from the datastore (e.g. Fedora, Postgres) and from Solr.'
+  puts '     Seeds can be run to pre-populate metadata to help with release testing and local development testing.'
+  puts
+  puts '     NOTE: Options can be passed in with the command on the command line or set as ENV variables.'
+  puts
+  puts '     The options are as follows:'
+  puts
+  puts '     WIPE_DATA'
+  puts '             USE WITH CAUTION - Deleted data cannot be recovered.'
+  puts
+  puts '             When true, it will clear all repository metadata from the datastore (e.g. Fedora, Postgres) and from Solr.  It also'
+  puts '             clears data from the application database that are tightly coupled to repository metadata.  See Hyrax::DataMaintenance'
+  puts '             for more information on what data will be destroyed by this process.'
+  puts
+  puts '             The wipe_data process will also restore required repository metadata including collection types and the default admin'
+  puts '             set.  See Hyrax::RequiredDataSeeder for more information on what data will be created by this process.'
+  puts
+  puts '     SEED_RELEASE_TESTING'
+  puts '             When true, it will run the set of seeds for release testing creating a repository metadata and support data, including'
+  puts '             test users, collection types, collections, and works with and without files.  See Hyrax::TestDataSeeder for more information'
+  puts '             on what data will be created by this process.'
+  puts
+  puts '     SEED_DASSIE'
+  puts '             When true, it will run a minimal set of seeds for dassie test app, including required collection types, default admin set,'
+  puts '             and test users.'
+  puts
+  puts '     ALLOW_RELEASE_SEEDING_IN_PRODUCTION'
+  puts '             USE WITH EXTERME CAUTION WHEN USED IN PRODUCTION - Deleted data cannot be recovered.  Attempts are made to not overwrite'
+  puts '             existing data, but use in production is not recommended.'
+  puts
+  puts '             If this is NOT true, the process will abort when Rails environment is production.'
+  puts
+end
+
+allow_release_seeding_in_production = ActiveModel::Type::Boolean.new.cast(ENV.fetch('ALLOW_RELEASE_SEEDING_IN_PRODUCTION', false))
+
+if Rails.env == 'production' && !allow_release_seeding_in_production
+  puts "Seeding data for release testing is not for use in production!"
+  exit
+end
+
+if wipe_data
+  puts '####################################################################################'
+  puts
+  puts 'WARNING: You are about to clear all repository metadata from the datastore and solr.'
+  puts 'Are you sure? [YES|n]'
+  answer = STDIN.gets.chomp
+  unless answer == 'YES'
+    puts '   Aborting!'
+    puts '####################################################################################'
+    exit
+  end
 
-puts "\n== Loading users"
-User.where(email: 'admin@example.com').first_or_create do |f|
-  f.password = 'admin_password'
+  Hyrax::DataMaintenance.new.destroy_repository_metadata_and_related_data
+  Hyrax::RequiredDataSeeder.new.generate_seed_data
 end
 
-User.where(email: 'basic_user@example.com').first_or_create do |f|
-  f.password = 'password'
+if seed_dassie
+  Hyrax::RequiredDataSeeder.new.generate_seed_data
+  Hyrax::TestDataSeeders::UserSeeder.generate_seeds
 end
 
-User.where(email: 'another_user@example.com').first_or_create do |f|
-  f.password = 'password'
+if seed_release_testing
+  Hyrax::TestDataSeeder.new.generate_seed_data
 end

data/.env

@@ -1,14 +1,17 @@
+ANALYTICS_START_DATE=2021-08-21
 CHROME_HEADLESS_MODE=false
 DATABASE_CLEANER_ALLOW_REMOTE_DATABASE_URL=true
 DATABASE_TEST_URL=postgresql://hyrax_user:hyrax_password@postgres/hyrax_test?pool=5
 DATABASE_URL=postgresql://hyrax_user:hyrax_password@postgres/hyrax?pool=5
-DB_PORT=5432
 DB_HOST=postgres
-FCREPO_PORT=8080
+DB_PORT=5432
 FCREPO_HOST=fcrepo
+FCREPO_PORT=8080
 FCREPO_REST_PATH=rest
 FCREPO_TEST_BASE_PATH=/test
 HUB_URL=http://chrome:4444/wd/hub
+HYRAX_ANALYTICS=false
+HYRAX_ANALYTICS_PROVIDER=google
 HYRAX_DERIVATIVES_PATH=/app/samvera/hyrax-webapp/derivatives/
 HYRAX_ENGINE_PATH=/app/samvera/hyrax-engine
 HYRAX_UPLOAD_PATH=/app/samvera/hyrax-webapp/uploads/
@@ -17,9 +20,9 @@ RACK_ENV=development
 RAILS_ENV=development
 RAILS_ROOT=.dassie
 REDIS_HOST=redis
-SOLR_PORT=8983
 SOLR_HOST=solr
+SOLR_PORT=8983
 SOLR_TEST_URL=http://solr:8983/solr/hyrax_test
 SOLR_URL=http://solr:8983/solr/hyrax
-VALKYRIE_SOLR_PORT=8983
 VALKYRIE_SOLR_HOST=solr
+VALKYRIE_SOLR_PORT=8983

data/.github/release.yml

@@ -0,0 +1,26 @@
+changelog:
+  categories:
+    - title: Major Changes (Potentially breaking changes)
+      labels:
+        - notes-major
+    - title: New Features
+      labels:
+        - notes-minor
+    - title: Deprecations
+      labels:
+        - notes-deprecation
+    - title: Bug Fixes
+      labels:
+        - notes-bugfix
+    - title: Valkyrie Progress
+      labels:
+        - notes-valkyrie
+    - title: Documentation
+      labels:
+        - notes-docs
+    - title: Containerization
+      labels:
+        - notes-container
+    - title: Other
+      labels:
+        - "*"

data/.github/workflows/main.yml

@@ -0,0 +1,17 @@
+name: Trigger Nurax build
+on:
+  workflow_dispatch:
+  push:
+
+jobs:
+  trigger:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: peter-evans/repository-dispatch@v1
+      with:
+         token: ${{ secrets.NURAX_ACCESS_TOKEN }}
+         event-type: push
+         repository: curationexperts/nurax
+         client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'
+
+

data/.github/workflows/release.yml

@@ -0,0 +1,17 @@
+name: Trigger Nurax build
+on:
+  workflow_dispatch:
+  release:
+
+jobs:
+  trigger:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: peter-evans/repository-dispatch@v1
+      with:
+         token: ${{ secrets.NURAX_ACCESS_TOKEN }}
+         event-type: release
+         repository: curationexperts/nurax
+         client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'
+
+

data/.gitignore

@@ -49,6 +49,8 @@ coverage
 rdoc
 /.bundle
 tmp
+/.idea
+
 
 *.log
 *~
@@ -71,6 +73,7 @@ db/schema.rb
 
 .*_app
 .byebug_history
+.tool-versions
 
 ## Carried over from hyrax-models (RIP)
 *.gem
@@ -82,3 +85,4 @@ lib/bundler/man
 spec/reports
 /spec/examples.txt
 node_modules
+.env.*

data/.regen

@@ -1 +1 @@
-36
+41

data/.rubocop_fixme.yml

@@ -63,6 +63,7 @@ RSpec/ExampleLength:
     - 'spec/jobs/content_restored_version_event_job_spec.rb'
     - 'spec/jobs/content_new_version_event_job_spec.rb'
     - 'spec/jobs/content_depositor_change_event_job_spec.rb'
+    - 'spec/jobs/change_depositor_event_job_spec.rb'
     - 'spec/jobs/content_deposit_event_job_spec.rb'
     - 'spec/jobs/content_delete_event_job_spec.rb'
     - 'spec/jobs/ingest_file_job_spec.rb'
@@ -100,7 +101,6 @@ RSpec/SubjectStub:
     - 'spec/models/hyrax/operation_spec.rb'
     - 'spec/controllers/hyrax/accepts_batches_controller_spec.rb'
     - 'spec/indexers/hyrax/repository_reindexer_spec.rb'
-    - 'spec/jobs/content_depositor_change_event_job_spec.rb'
     - 'spec/lib/hyrax/analytics_spec.rb'
     - 'spec/models/job_io_wrapper_spec.rb'
     - 'spec/search_builders/hyrax/abstract_type_relation_spec.rb'
@@ -114,6 +114,8 @@ RSpec/AnyInstance:
     - 'spec/controllers/hyrax/batch_edits_controller_spec.rb'
     - 'spec/controllers/hyrax/stats_controller_spec.rb'
     - 'spec/controllers/hyrax/users_controller_spec.rb'
+    - 'spec/hyrax/transactions/steps/delete_access_control_spec.rb'
+    - 'spec/hyrax/transactions/steps/save_access_control_spec.rb'
     - 'spec/jobs/content_restored_version_event_job_spec.rb'
     - 'spec/jobs/file_set_attached_event_job_spec.rb'
     - 'spec/jobs/hyrax/grant_edit_to_members_job_spec.rb'

data/CONTAINERS.md

@@ -1,15 +1,12 @@
 Hyrax-in-a-Container
 ====================
 
-Our goal is to provide a practical, reusable "reference environment for applications.  The first step is providing
-on on-ramp for Hyrax engine development.  Then providing help with Hyrax-based application development.  Finally,
-providing better guidance around deployment.
-
-Where are we at?  It's complicated.  What we have below is experimental support, but one that we want to push
-towards.  We need your help to keep pushing in this direction.  So dig in and prepare to get your hands dirty.
+Our goal is to provide a practical, reusable reference environment for applications.  The first step is providing an on-ramp for Hyrax engine development. Then providing help with Hyrax-based application development. Finally, providing better guidance around deployment.
 
 The [Hyrax Engine Development](#hyrax-engine-development) is further along than the [Docker Image for Hyrax-based Applications](#docker-image-for-hyrax-based-applications) which is further along than [Deploying to Production](#deploying-to-production).
 
+See the [Troubleshooting](#troubleshooting) section if you encounter any issues.
+
 <!-- NOTE: This title is referenced in the top-level README.md. Keep that in mind if you change it. -->
 ## Hyrax Engine Development
 
@@ -42,8 +39,6 @@ To stop the containers for the Hyrax-based application, type <kbd>Ctrl</kbd>+<kb
 
 _**Note:** Starting and stopping Docker in this way will preserve your data between restarts._
 
-_**Note:** I (Jeremy) encountered a problem using `docker-compose build`. I ran `bundle update` in `./hyrax` as well as within `./hyrax/.dassie`. That appeared to clear up the problem of a failure to build a gem._
-
 ### Code Changes and Testing
 
 With `docker-compose up` running, any changes you make to your cloned Hyrax code-base should show up in `http://localhost:3000`; There may be cases where you need to restart your test application (e.g. stop the containers and start them up again).
@@ -99,7 +94,7 @@ In the two examples, note the difference in the `-w` switch. In the first case,
 
 ### Debugging
 
-I (Jeremy) find myself wanting to debug the application.  This requires a somewhat different approach than running Hyrax bare-metal.  You need to use `docker attach` to debug the running docker instance.
+If you are interested in running Hyrax in debug mode, this requires a somewhat different approach than running Hyrax bare-metal.  You need to use `docker attach` to debug the running docker instance.
 
 1. With `docker-compose up` running open a new Terminal session.
 2. In that new Terminal session, using `docker container ls` find the "CONTAINER ID" for the `hyrax-engine-dev`.
@@ -127,6 +122,14 @@ cp: cannot create directory '/var/solr/data/hyrax_test': Permission denied
 
 The solution that appears to work is to `docker-compose down --volumes`; This will tear down the docker instance, and remove the volumes.  You can then run `docker-compose up` to get back to work.  _**Note:** the `--volumes` switch will remove all custom data._
 
+#### Errors building the Docker image
+
+If you encounter errors running `docker-compose build`, try running `bundle update` in `./hyrax` as well as within `./hyrax/.dassie`. That can help clear up the problem of a failure to build a particular gem.
+
+#### Containers do not all start
+
+If any of the services fail to start on `docker-compose up`, try clearing out any `Gemfile.lock` files that might exist in `./hyrax` or `./hyrax/.dassie` and run `docker-compose build` again, then `docker-compose up` again.
+
 <!-- NOTE: This title is referenced in the top-level documentation/developing-your-hyrax-based-app.md. Keep that in mind if you change it. -->
 ## Docker Image for Hyrax-based Applications
 
@@ -177,4 +180,4 @@ helm dependency update chart/hyrax
 helm install -n hyrax --set image.tag=(git rev-parse HEAD) dassie chart/hyrax
 ```
 
-[dockerhub-samveralabs]: https://hub.docker.com/r/samveralabs
+[dockerhub-samveralabs]: https://hub.docker.com/r/samveralabs

data/Dockerfile

@@ -7,6 +7,7 @@ ARG EXTRA_APK_PACKAGES="git"
 RUN apk --no-cache upgrade && \
   apk --no-cache add build-base \
   curl \
+  gcompat \
   imagemagick \
   tzdata \
   nodejs \
@@ -57,7 +58,7 @@ USER app
 
 RUN mkdir -p /app/fits && \
     cd /app/fits && \
-    wget https://github.com/harvard-lts/fits/releases/download/1.5.0/fits-1.5.0.zip -O fits.zip && \
+    wget https://github.com/harvard-lts/fits/releases/download/1.5.1/fits-1.5.1.zip -O fits.zip && \
     unzip fits.zip && \
     rm fits.zip && \
     chmod a+x /app/fits/fits.sh

data/README.md

@@ -77,6 +77,43 @@ This is where you work on the code-base that will be used by yours and other Hyr
     <p>By moving to Docker, we are encoding the documentation steps for standing up a Hyrax-engine development environment.</p>
 </aside>
 
+### Installing Analytics
+
+Hyrax supports your choice of either Google Analytics or Matomo.  To enable analytics tracking and reporting features, follow the directions below.
+
+Enable Analytics Features
+
+Analytics can be enabled and configured using environment variables. Set HYRAX_ANALYTICS to true, set either 'google' or 'matomo' for  HYRAX_ANALYTICS_PROVIDER, and set the date you would like reporting to start (ANALYTICS_START_DATE).
+
+```
+HYRAX_ANALYTICS=true
+HYRAX_ANALYTICS_PROVIDER=google
+ANALYTICS_START_DATE=2021-08-21
+```
+
+If using google, you'll also need the following ENV variables:
+
+```
+GOOGLE_ANALYTICS_ID=UA-111111-1  # Universal ID (Currently Hyrax Analytics only works with Univeral (UA) accounts)
+GOOGLE_OAUTH_APP_NAME=
+GOOGLE_OAUTHAPP_VERSION=
+GOOGLE_OAUTH_PRIVATE_KEY_PATH= # store the .p12 file in the root of your application
+GOOGLE_OAUTH_PRIVATE_KEY_SECRET=
+GOOGLE_OAUTH_CLIENT_EMAIL=
+```
+
+Add these ENV variables if using Matomo:
+
+```
+MATOMO_SITE_ID=
+MATOMO_BASE_URL=
+MATOMO_AUTH_TOKEN=
+```
+
+#### Analytics Features
+
+Once analytics is enabled, Hyrax will automatically install the JS tracking code.  Page views and downloads of a file set are recorded and sent to the selected analytics provider.  Admin users will have access to an expanded dashboard with details about how many vistors viewed a page, and how many visitors downloaded a file.  Easily find the top works by views, and most popular file downloads!
+
 #### Contributing
 
 We'd love to accept your contributions.  Please see our guide to [contributing to Hyrax](./.github/CONTRIBUTING.md).