darlingtonia 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 145bf822e40f94c82cf2a0c61213e964a8f5e780209703e9506fa6ce35466612
-  data.tar.gz: ed804197a3ccad1047da9b8c8127603e38814c03d799325bb9c317938de71c88
+  metadata.gz: d7c349e432568a10f8f77a939d0464e511466f0bc7ae30f7d7f5ff134a1bb656
+  data.tar.gz: 5a89d7d2e778e35ab4213af0648c5c99857f264851f50a40dfbfa76f1440a79a
 SHA512:
-  metadata.gz: dbaec8b01d54cb94859e1630fec14b84082c981e25143646eb1aa58ab4dbb5e0bbebcb4954457799dccdac0d8cc20f78b315486f2f2d38bfa709bf209df70980
-  data.tar.gz: d5ce22c9e01ba293513d7398fa5af18bb5cfcfe1df67dc6313ebb70cce13c655dd8c1b0998042a1b823014337b2e2ae7980b288f5168a0d4d4caa5077d32701e
+  metadata.gz: 7ef901a03b12a77bf06ffb61622d4ff606c3369d872c1bc72f8bf8975c96faa9450b1826cda254c915afef0a03ebd1908db00e818ddc6d1087a1aeb83a823c9f
+  data.tar.gz: ac6bd1de71971065ec2432c27ad786e810f306f54271fd1d800117706479745b93b98b2e3115be806227becd01aaecbb570ae0a366370d231bc6d9a2b3ec6222

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+2.2.0 - Tue Feb 12, 2019
+
+* Improved default logging
+  * logs are more easily parsed, e.g., by splunk
+  * logs contain summary information
+  * option to pass in a batch_id to track successes and failures per batch
+
 2.1.0 - Tue Feb 12, 2019
 
 * Map a variety of values for 'visibility' to their Hyrax approved equivalents

data/lib/darlingtonia/hyrax_record_importer.rb

@@ -13,6 +13,18 @@ module Darlingtonia
     # @return [String] The fedora ID for a Collection.
     attr_accessor :collection_id
 
+    # @!attribute [rw] batch_id
+    # @return [String] an id number associated with the process that kicked off this import run
+    attr_accessor :batch_id
+
+    # @!attribute [rw] success_count
+    # @return [String] the number of records this importer has successfully created
+    attr_accessor :success_count
+
+    # @!attribute [rw] failure_count
+    # @return [String] the number of records this importer has failed to create
+    attr_accessor :failure_count
+
     # @param attributes [Hash] Attributes that come
     #        from the UI or importer rather than from
     #        the CSV/mapper.
@@ -23,8 +35,10 @@ module Darlingtonia
                    info_stream: Darlingtonia.config.default_info_stream,
                    attributes: {})
       self.collection_id = attributes[:collection_id]
+      self.batch_id = attributes[:batch_id]
       set_depositor(attributes[:depositor_id])
-
+      @success_count = 0
+      @failure_count = 0
       super(error_stream: error_stream, info_stream: info_stream)
     end
 
@@ -137,8 +151,8 @@ module Darlingtonia
       # Create an object using the Hyrax actor stack
       # We assume the object was created as expected if the actor stack returns true.
       def create_for(record:)
-        info_stream << 'Creating record: ' \
-                       "#{record.respond_to?(:title) ? record.title : record}."
+        info_stream << "event: record_import_started, batch_id: #{batch_id}, collection_id: #{collection_id}, record_title: #{record.respond_to?(:title) ? record.title : record}"
+
         additional_attrs = {
           uploaded_files: create_upload_files(record),
           depositor: @depositor.user_key
@@ -156,14 +170,14 @@ module Darlingtonia
                                                    attrs)
 
         if Hyrax::CurationConcern.actor.create(actor_env)
-          info_stream << "Record created at: #{created.id}"
+          info_stream << "event: record_created, batch_id: #{batch_id}, record_id: #{created.id}, collection_id: #{collection_id}, record_title: #{attrs[:title].first}"
+          @success_count += 1
         else
           created.errors.each do |attr, msg|
-            error_stream << "Validation failed: #{attr.capitalize}. #{msg}"
+            error_stream << "event: validation_failed, batch_id: #{batch_id}, collection_id: #{collection_id}, attribute: #{attr.capitalize}, message: #{msg}, record_title: #{attrs[:title].first}"
           end
+          @failure_count += 1
         end
-
-        info_stream << "Record created at: #{created.id}"
       end
   end
 end

data/lib/darlingtonia/importer.rb

@@ -34,6 +34,7 @@ module Darlingtonia
     def initialize(parser:, record_importer: RecordImporter.new)
       self.parser          = parser
       self.record_importer = record_importer
+      @info_stream = Darlingtonia.config.default_info_stream
     end
 
     ##
@@ -42,6 +43,7 @@ module Darlingtonia
     # @return [void]
     def import
       records.each { |record| record_importer.import(record: record) }
+      @info_stream << "event: finish_import, batch_id: #{record_importer.batch_id}, successful_record_count: #{record_importer.success_count}, failed_record_count: #{record_importer.failure_count}"
     end
   end
 end

data/lib/darlingtonia/record_importer.rb

@@ -7,7 +7,13 @@ module Darlingtonia
     #   @return [#<<]
     # @!attribute [rw] info_stream
     #   @return [#<<]
-    attr_accessor :error_stream, :info_stream
+    # @!attribute [rw] batch_id
+    #   @return [String] an optional batch id for this import run
+    # @!attribute [rw] success_count
+    #   @return [Integer] a count of the records that were successfully created
+    # @!attribute [rw] failure_count
+    #   @return [Integer] a count of the records that failed import
+    attr_accessor :error_stream, :info_stream, :batch_id, :success_count, :failure_count
 
     ##
     # @param error_stream [#<<]

data/lib/darlingtonia/validator.rb

@@ -53,7 +53,28 @@ module Darlingtonia
   #
   # @see Parser#validate
   class Validator
+    ##
+    # A representation of an error encountered in validation.
     Error = Struct.new(:validator, :name, :description, :lineno) do
+      ##
+      # @!attribute [rw] validator
+      #   @return [#to_s] the validator that generated this error
+      # @!attribute [rw] name
+      #   @return [#to_s] a short descriptive name for the given error
+      # @!attribute [rw] description
+      #   @return [#to_s] a long form description or message
+      # @!attribute [rw] lineno
+      #   @return [#to_s] the line number, or other indication of the location
+      #     where the error was encountered
+
+      ##
+      # @return [Boolean]
+      def validator_error?
+        true
+      end
+
+      ##
+      # @return [String]
       def to_s
         "#{name}: #{description} (#{validator})"
       end
@@ -79,16 +100,18 @@ module Darlingtonia
         errors.map { |error| error_stream << error }
       end
     end
-    # rubocop:enable Lint/UnusedMethodArgument
 
     private
 
+      # rubocop:disable Lint/UnusedMethodArgument
+
       ##
       # @return [Enumerator<Error>]
       #
-      # rubocop:disable Lint/UnusedMethodArgument
       def run_validation(parser:)
         [].to_enum
       end
+
+    # rubocop:enable Lint/UnusedMethodArgument
   end
 end

data/lib/darlingtonia/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Darlingtonia
-  VERSION = '2.1.0'
+  VERSION = '2.2.0'
 end

data/spec/darlingtonia/importer_spec.rb

@@ -12,6 +12,8 @@ describe Darlingtonia::Importer do
 
   let(:fake_record_importer) do
     Class.new do
+      attr_accessor :batch_id, :success_count, :failure_count
+
       def import(record:)
         records << record.attributes
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: darlingtonia
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Data Curation Experts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-12 00:00:00.000000000 Z
+date: 2019-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active-fedora