Resolves #104 by adding support for RabbitMQ messaging for the creati…

…on, updates, and deletion of Figgy resources

Increasing the test coverage for the FileSet Resource and the publishing of messages for deleted FileSets

Restructuring the #parents and #collections methods to be exposed by decorators

Gemfile

@@ -3,6 +3,7 @@ source "https://rubygems.org"
 
 gem "autoprefixer-rails"
 gem "blacklight"
+gem 'bunny'
 gem "devise-guests", git: "https://github.com/cbeer/devise-guests.git"
 gem "flutie"
 gem "honeybadger"

Gemfile.lock

@@ -144,6 +144,7 @@ GEM
       rails (>= 4.2, < 6)
     archive-zip (0.7.0)
       io-like (~> 0.3.0)
+    amq-protocol (2.2.0)
     arel (8.0.0)
     ast (2.3.0)
     autoprefixer-rails (7.1.2.3)
@@ -204,6 +205,8 @@ GEM
     bundler-audit (0.6.0)
       bundler (~> 1.2)
       thor (~> 0.18)
+    bunny (2.6.6)
+      amq-protocol (>= 2.1.0)
     byebug (9.0.6)
     cancancan (1.17.0)
     capistrano (3.7.2)
@@ -236,6 +239,7 @@ GEM
     chromedriver-helper (1.1.0)
       archive-zip (~> 0.7.0)
       nokogiri (~> 1.6)
+    cliver (0.3.2)
     coderay (1.1.1)
     coffee-rails (4.2.2)
       coffee-script (>= 2.2.0)
@@ -758,6 +762,7 @@ DEPENDENCIES
   browse-everything
   bullet
   bundler-audit (>= 0.5.0)
+  bunny
   capistrano (~> 3.7.1)
   capistrano-passenger
   capistrano-rails

app/change_set_persisters/plum_change_set_persister.rb

@@ -19,10 +19,15 @@ def save(change_set:)
   end
 
   def delete(change_set:)
+    deleted_resource = change_set.resource
+    if change_set.resource.is_a?(FileSet)
+      deleted_resource = change_set.resource.decorate.parents.first unless change_set.resource.decorate.parents.empty?
+    end
     before_delete(change_set: change_set)
     persister.delete(resource: change_set.resource).tap do
       after_commit unless transaction?
     end
+    messenger.record_deleted(deleted_resource)
   end
 
   def save_all(change_sets:)
@@ -55,6 +60,13 @@ def with(metadata_adapter:)
 
   private
 
+    ##
+    #
+    # Retrieve the messenger for RabbitMQ
+    def messenger
+      @messenger ||= ManifestEventGenerator.new(Figgy.messaging_client)
+    end
+
     def before_save(change_set:)
       apply_remote_metadata(change_set: change_set)
       create_files(change_set: change_set)
@@ -69,6 +81,12 @@ def before_save(change_set:)
 
     def after_save(change_set:, updated_resource:)
       append(append_id: change_set.append_id, updated_resource: updated_resource) if change_set.append_id.present?
+      # Update after having appended a FileSet to a Work, or updated a Work
+      if updated_resource.is_a? FileSet
+        messenger.record_updated(updated_resource.decorate.parents.first) unless updated_resource.decorate.parents.empty?
+      else
+        messenger.record_updated(updated_resource)
+      end
     end
 
     def before_delete(change_set:)

app/decorators/collection_decorator.rb

@@ -7,4 +7,10 @@ def title
   def manageable_files?
     false
   end
+
+  # Nested collections are not currently supported
+  def parents
+    []
+  end
+  alias collections parents
 end

app/decorators/file_set_decorator.rb

@@ -4,4 +4,12 @@ class FileSetDecorator < Valkyrie::ResourceDecorator
   def manageable_files?
     false
   end
+
+  def parents
+    Valkyrie::MetadataAdapter.find(:indexing_persister).query_service.find_parents(resource: self).to_a
+  end
+
+  def collections
+    []
+  end
 end

app/decorators/scanned_resource_decorator.rb

@@ -73,4 +73,9 @@ def iiif_manifest_attributes
 
     current_attributes
   end
+
+  def parents
+    Valkyrie::MetadataAdapter.find(:indexing_persister).query_service.find_references_by(resource: self, property: :member_of_collection_ids).to_a
+  end
+  alias collections parents
 end

app/services/manifest_event_generator.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+class ManifestEventGenerator
+  attr_reader :rabbit_exchange
+  def initialize(rabbit_exchange)
+    @rabbit_exchange = rabbit_exchange
+  end
+
+  def record_created(record)
+    publish_message(
+      message_with_collections("CREATED", record)
+    )
+  end
+
+  def record_deleted(record)
+    publish_message(
+      message("DELETED", record)
+    )
+  end
+
+  def record_updated(record)
+    publish_message(
+      message_with_collections("UPDATED", record)
+    )
+  end
+
+  private
+
+    def message(type, record)
+      {
+        "id" => record ? record.id.to_s : nil,
+        "event" => type,
+        "manifest_url" => helper.polymorphic_url([:manifest, record])
+      }
+    end
+
+    def message_with_collections(type, record)
+      output = message(type, record)
+      if record.decorate.respond_to? :collections
+        output["collection_slugs"] = record.decorate.collections.map { |collection| collection.try(:slug) }.compact
+      end
+      output
+    end
+
+    def publish_message(message)
+      rabbit_exchange.publish(message.to_json)
+    end
+
+    def helper
+      @helper ||= ManifestBuilder::ManifestHelper.new
+    end
+end

app/services/messaging_client.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+class MessagingClient
+  attr_reader :amqp_url
+  def initialize(amqp_url)
+    @amqp_url = amqp_url
+  end
+
+  def publish(message)
+    exchange.publish(message, persistent: true)
+  rescue
+    Rails.logger.warn "Unable to publish message to #{amqp_url}"
+  end
+
+  private
+
+    def bunny_client
+      @bunny_client ||= Bunny.new(amqp_url).tap(&:start)
+    end
+
+    def channel
+      @channel ||= bunny_client.create_channel
+    end
+
+    def exchange
+      @exchange ||= channel.fanout(Figgy.config['events']['exchange']['plum'], durable: true)
+    end
+end

config/config.yml

@@ -8,67 +8,72 @@ defaults: &defaults
   plum_derivative_path: "/mnt/libimages1/data/jp2s/plum_prod"
   jp2_recipes:
     default_color: >
-      -rate 2.4,1.48331273,.91673033,.56657224,.35016049,.21641118,.13374944,.08266171 
-      -jp2_space sRGB 
-      -double_buffering 10 
-      -num_threads 1 
-      -no_weights 
-      Clevels=6 
-      Clayers=8 
-      Cblk=\{64,64\} 
-      Cuse_sop=yes 
-      Cuse_eph=yes  
-      Corder=RPCL 
-      ORGgen_plt=yes 
-      ORGtparts=R 
+      -rate 2.4,1.48331273,.91673033,.56657224,.35016049,.21641118,.13374944,.08266171
+      -jp2_space sRGB
+      -double_buffering 10
+      -num_threads 1
+      -no_weights
+      Clevels=6
+      Clayers=8
+      Cblk=\{64,64\}
+      Cuse_sop=yes
+      Cuse_eph=yes
+      Corder=RPCL
+      ORGgen_plt=yes
+      ORGtparts=R
       Stiles=\{1024,1024\}
     default_gray: >
-      -rate 2.4,1.48331273,.91673033,.56657224,.35016049,.21641118,.13374944,.08266171 
-      -jp2_space sLUM 
-      -double_buffering 10 
+      -rate 2.4,1.48331273,.91673033,.56657224,.35016049,.21641118,.13374944,.08266171
+      -jp2_space sLUM
+      -double_buffering 10
       -num_threads 1
-      -no_weights 
-      Clevels=6 
-      Clayers=8 
-      Cblk=\{64,64\} 
-      Cuse_sop=yes 
-      Cuse_eph=yes  
-      Corder=RPCL 
-      ORGgen_plt=yes 
-      ORGtparts=R 
+      -no_weights
+      Clevels=6
+      Clayers=8
+      Cblk=\{64,64\}
+      Cuse_sop=yes
+      Cuse_eph=yes
+      Corder=RPCL
+      ORGgen_plt=yes
+      ORGtparts=R
       Stiles=\{1024,1024\}
     geo_color: >
       -no_palette
-      -rate 2.4,1.48331273,.91673033,.56657224,.35016049,.21641118,.13374944,.08266171 
-      -jp2_space sRGB 
-      -double_buffering 10 
-      -num_threads 1 
-      -no_weights 
-      Clevels=6 
-      Clayers=8 
-      Cblk=\{64,64\} 
-      Cuse_sop=yes 
-      Cuse_eph=yes  
-      Corder=RPCL 
-      ORGgen_plt=yes 
-      ORGtparts=R 
+      -rate 2.4,1.48331273,.91673033,.56657224,.35016049,.21641118,.13374944,.08266171
+      -jp2_space sRGB
+      -double_buffering 10
+      -num_threads 1
+      -no_weights
+      Clevels=6
+      Clayers=8
+      Cblk=\{64,64\}
+      Cuse_sop=yes
+      Cuse_eph=yes
+      Corder=RPCL
+      ORGgen_plt=yes
+      ORGtparts=R
       Stiles=\{1024,1024\}
     geo_gray: >
       -no_palette
-      -rate 2.4,1.48331273,.91673033,.56657224,.35016049,.21641118,.13374944,.08266171 
-      -jp2_space sLUM 
-      -double_buffering 10 
+      -rate 2.4,1.48331273,.91673033,.56657224,.35016049,.21641118,.13374944,.08266171
+      -jp2_space sLUM
+      -double_buffering 10
       -num_threads 1
-      -no_weights 
-      Clevels=6 
-      Clayers=8 
-      Cblk=\{64,64\} 
-      Cuse_sop=yes 
-      Cuse_eph=yes  
-      Corder=RPCL 
-      ORGgen_plt=yes 
-      ORGtparts=R 
+      -no_weights
+      Clevels=6
+      Clayers=8
+      Cblk=\{64,64\}
+      Cuse_sop=yes
+      Cuse_eph=yes
+      Corder=RPCL
+      ORGgen_plt=yes
+      ORGtparts=R
       Stiles=\{1024,1024\}
+  events:
+    server: 'amqp://localhost:5672'
+    exchange:
+      plum: "plum_events"
+      geoblacklight: "gbl_events"
 
 development:
   <<: *defaults

config/initializers/figgy.rb

@@ -4,7 +4,16 @@ def config
     @config ||= config_yaml.with_indifferent_access
   end
 
+  def messaging_client
+    @messaging_client ||= MessagingClient.new(Figgy.config['events']['server'])
+  end
+
+  def geoblacklight_messaging_client
+    @geoblacklight_messaging_client ||= GeoblacklightMessagingClient.new(Figgy.config['events']['server'])
+  end
+
   def default_url_options
+    # @default_url_options ||= Rails.application.config.action_mailer.default_url_options
     @default_url_options ||= ActionMailer::Base.default_url_options
   end
 
@@ -14,5 +23,5 @@ def config_yaml
       YAML.safe_load(ERB.new(File.read(Rails.root.join("config", "config.yml"))).result, [], [], true)[Rails.env]
     end
 
-    module_function :config, :config_yaml, :default_url_options
+    module_function :config, :config_yaml, :messaging_client, :geoblacklight_messaging_client, :default_url_options
 end

config/routes.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 Rails.application.routes.draw do
   resources :auth_tokens
+  default_url_options Rails.application.config.action_mailer.default_url_options
   concern :exportable, Blacklight::Routes::Exportable.new
 
   resources :solr_documents, only: [:show], path: '/catalog', controller: 'catalog' do