pushmi_pullyu 2.0.6 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 128bfb644445954d7b9c5eb3700dd1f3e4d3c92ea1e8448ab98054d750b2d53d
-  data.tar.gz: 2fc44c64692367c9c4b254ec32b8241c7ecdc8fb1a33384561cbfcd34096a085
+  metadata.gz: da4560ad8303a06ea455d4da2915bd9be6a98edb70a8ee91bc12cb25d977f3b5
+  data.tar.gz: db98dc991f3149b0d217f6ae61f9c07c34ecc8ab7c878d4e60ecdbc08aed95bd
 SHA512:
-  metadata.gz: daaaf67bda17bdea14310b41a87a1c51190f41337d8f0d467887dea5ed9cc700b2b05822bddd6038a4c7746927439d2576fd8a7c3fb2a878d7f59a8ac84e45be
-  data.tar.gz: 33197ef8eb83869cea35ea5af258d83c16c56e77cbb0716fc61a6fa344b3d5cdf75e25a0fd72d6e2ab71148ddae9648351d29c5f2b53c9569af9f04869538ba0
+  metadata.gz: 5d565b6ecf4fcd0cab2690f04aaf619dc70d83848a8fc48960de393fac94b83ff18f9751528dbbb184c4f411d270113ec90c807146c8c14e35010c8a40434734
+  data.tar.gz: 478f4047534baaf2931733f0f48d199dd51088262e0076f5b52ad1f63f74fb5fee6dc5265ec8c8b5064f8b87d1ecaebf94513a5d9ecf299c3455df4526fbc9cb

data/.rubocop.yml

@@ -20,7 +20,6 @@ Layout/EmptyLinesAroundClassBody:
   EnforcedStyle: empty_lines_except_namespace
 
 Layout/IndentationConsistency:
-  Enabled: true
   EnforcedStyle: normal
 
 # A calculated magnitude based on number of assignments,
@@ -61,15 +60,6 @@ Style/ClassAndModuleChildren:
 Style/Documentation:
   Enabled: false
 
-Style/HashEachMethods:
-  Enabled: true
-
-Style/HashTransformKeys:
-  Enabled: true
-
-Style/HashTransformValues:
-  Enabled: true
-
 Naming/FileName:
   Exclude:
     - Dangerfile

data/CHANGELOG.md

@@ -6,8 +6,17 @@ PushmiPullyu is a Ruby application, whose primary job is to manage the flow of c
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and releases in PushmiPullyu adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [2.1.0]
+ - Add more logging information [#433](https://github.com/ualbertalib/pushmi_pullyu/issues/433)
+ - Add V3 authentication [#349](https://github.com/ualbertalib/pushmi_pullyu/issues/349)
 
+- Add logic to perform authentication against the V3 Auth protocol
+
+## [2.0.7] - 2023-09-13
+
+- Fix nil exception [#314](https://github.com/ualbertalib/pushmi_pullyu/issues/314)
+- Bump rubocop from 1.28.1 to 1.54.1 [PR#348](https://github.com/ualbertalib/pushmi_pullyu/pull/348)
+- Add missing logging for standard exception [#314](https://github.com/ualbertalib/pushmi_pullyu/issues/314)
 ## [2.0.6] - 2023-03-17
 
 - Fix URI concatenation for jupiter's base url. [#309](https://github.com/ualbertalib/pushmi_pullyu/issues/309)
@@ -51,5 +60,4 @@ and releases in PushmiPullyu adheres to [Semantic Versioning](https://semver.org
 ### Removed
 - Data output for original_file information
 
-- 
 ## [1.0.6] - 2018-11-29

data/Gemfile

@@ -2,3 +2,17 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in pushmi_pullyu.gemspec
 gemspec
+
+group :development, :test do
+  gem 'bundler', '~> 2.0'
+  gem 'danger', '~> 9.3'
+  gem 'pry', '~> 0.10', '>= 0.10.4'
+  gem 'pry-byebug', '~> 3.6'
+  gem 'rake', '~> 13.0'
+  gem 'rspec', '~> 3.13'
+  gem 'rubocop', '~> 1.64'
+  gem 'rubocop-rspec', '~> 2.24'
+  gem 'timecop', '~> 0.9'
+  gem 'vcr', '~> 5.0'
+  gem 'webmock', '~> 3.19'
+end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pushmi_pullyu (2.0.6)
+    pushmi_pullyu (2.1.0)
       activesupport (>= 5, < 8)
       bagit (~> 0.4)
       connection_pool (~> 2.2)
@@ -10,7 +10,7 @@ PATH
       openstack (~> 3.3, >= 3.3.10)
       rdf (>= 1.99, < 4.0)
       rdf-n3 (>= 1.99, < 4.0)
-      redis (>= 3.3, < 5.0)
+      redis (>= 3.3, < 6.0)
       rest-client (>= 1.8, < 3.0)
       rollbar (>= 2.18, < 4.0)
       uuid (~> 2.3.9)
@@ -18,80 +18,73 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4.2)
+    activesupport (7.1.1)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
-    addressable (2.8.1)
+    addressable (2.8.5)
       public_suffix (>= 2.0.2, < 6.0)
-    amazing_print (1.4.0)
     ast (2.4.2)
-    bagit (0.4.5)
+    bagit (0.4.6)
       docopt (~> 0.5.0)
       validatable (~> 1.6)
+    base64 (0.2.0)
+    bigdecimal (3.1.4)
     builder (3.2.4)
     byebug (11.1.3)
-    claide (1.0.3)
+    claide (1.1.0)
     claide-plugins (0.9.2)
       cork
       nap
       open4 (~> 1.3)
     coderay (1.1.3)
     colored2 (3.1.2)
-    concurrent-ruby (1.2.0)
-    connection_pool (2.3.0)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
     cork (0.3.0)
       colored2 (~> 3.1)
     crack (0.4.5)
       rexml
     daemons (1.4.1)
-    danger (8.4.2)
+    danger (9.3.2)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
       cork (~> 0.1)
-      faraday (>= 0.9.0, < 2.0)
+      faraday (>= 0.9.0, < 3.0)
       faraday-http-cache (~> 2.0)
-      git (~> 1.7)
+      git (~> 1.13)
       kramdown (~> 2.3)
       kramdown-parser-gfm (~> 1.0)
       no_proxy_fix
-      octokit (~> 4.7)
+      octokit (~> 6.0)
       terminal-table (>= 1, < 4)
-    diff-lcs (1.5.0)
+    diff-lcs (1.5.1)
     docopt (0.5.0)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    ebnf (2.3.1)
-      amazing_print (~> 1.4)
+    drb (2.1.1)
+      ruby2_keywords
+    ebnf (2.3.5)
       htmlentities (~> 4.3)
       rdf (~> 3.2)
       scanf (~> 1.0)
       sxp (~> 1.2)
-      unicode-types (~> 1.7)
-    faraday (1.8.0)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0.1)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.1)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      multipart-post (>= 1.2, < 3)
+      unicode-types (~> 1.8)
+    faraday (2.7.11)
+      base64
+      faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
-    faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
-    faraday-excon (1.1.0)
-    faraday-http-cache (2.2.0)
+    faraday-http-cache (2.5.0)
       faraday (>= 0.8)
-    faraday-httpclient (1.0.1)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.2.0)
-    faraday-patron (1.0.0)
-    faraday-rack (1.0.0)
-    git (1.13.0)
+    faraday-net_http (3.0.2)
+    git (1.18.0)
       addressable (~> 2.8)
       rchardet (~> 1.8)
     hashdiff (1.0.1)
@@ -99,50 +92,53 @@ GEM
     http-accept (1.7.0)
     http-cookie (1.0.5)
       domain_name (~> 0.5)
-    i18n (1.12.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    json (2.6.3)
-    kramdown (2.3.1)
+    json (2.7.2)
+    kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
+    language_server-protocol (3.17.0.3)
     link_header (0.0.8)
     logger (1.5.3)
     macaddr (1.7.2)
       systemu (~> 2.6.5)
     matrix (0.4.2)
     method_source (1.0.0)
-    mime-types (3.4.1)
+    mime-types (3.5.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2022.0105)
+    mime-types-data (3.2023.1003)
     minitar (0.9)
-    minitest (5.17.0)
-    multipart-post (2.1.1)
+    minitest (5.20.0)
+    mutex_m (0.1.2)
     nap (1.1.0)
-    net-http-persistent (4.0.1)
+    net-http-persistent (4.0.2)
       connection_pool (~> 2.2)
     netrc (0.11.0)
     no_proxy_fix (0.1.2)
-    octokit (4.21.0)
-      faraday (>= 0.9)
-      sawyer (~> 0.8.0, >= 0.5.3)
+    octokit (6.1.1)
+      faraday (>= 1, < 3)
+      sawyer (~> 0.9)
     open4 (1.3.4)
     openstack (3.3.21)
       json
-    parallel (1.22.1)
-    parser (3.1.2.1)
+    parallel (1.24.0)
+    parser (3.3.1.0)
       ast (~> 2.4.1)
-    pry (0.14.1)
+      racc
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
     pry-byebug (3.10.1)
       byebug (~> 11.0)
       pry (>= 0.13, < 0.15)
-    public_suffix (5.0.0)
+    public_suffix (5.0.3)
+    racc (1.8.0)
     rainbow (3.1.1)
     rake (13.0.6)
     rchardet (1.8.0)
-    rdf (3.2.9)
+    rdf (3.2.11)
       link_header (~> 0.0, >= 0.0.8)
     rdf-aggregate-repo (3.2.1)
       rdf (~> 3.2)
@@ -154,78 +150,91 @@ GEM
     rdf-xsd (3.2.1)
       rdf (~> 3.2)
       rexml (~> 3.2)
-    redis (4.8.1)
-    regexp_parser (2.6.0)
+    redis (5.0.8)
+      redis-client (>= 0.17.0)
+    redis-client (0.17.1)
+      connection_pool
+    regexp_parser (2.9.2)
     rest-client (2.1.0)
       http-accept (>= 1.7.0, < 2.0)
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)
-    rexml (3.2.5)
-    rollbar (3.4.0)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.0)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.0)
+    rexml (3.2.8)
+      strscan (>= 3.0.9)
+    rollbar (3.4.1)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.28.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.0)
+    rubocop (1.64.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.17.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.23.0)
-      parser (>= 3.1.1.0)
-    rubocop-rspec (2.11.1)
-      rubocop (~> 1.19)
-    ruby-progressbar (1.11.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-capybara (2.19.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.24.0)
+      rubocop (~> 1.33)
+    rubocop-rspec (2.24.1)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
-    sawyer (0.8.2)
+    sawyer (0.9.2)
       addressable (>= 2.3.5)
-      faraday (> 0.8, < 2.0)
+      faraday (>= 0.17.3, < 3)
     scanf (1.0.0)
-    sparql (3.2.5)
-      builder (~> 3.2)
-      ebnf (~> 2.2, >= 2.3.1)
+    sparql (3.2.6)
+      builder (~> 3.2, >= 3.2.4)
+      ebnf (~> 2.3, >= 2.3.5)
       logger (~> 1.5)
-      rdf (~> 3.2, >= 3.2.8)
-      rdf-aggregate-repo (~> 3.2)
+      rdf (~> 3.2, >= 3.2.11)
+      rdf-aggregate-repo (~> 3.2, >= 3.2.1)
       rdf-xsd (~> 3.2)
-      sparql-client (~> 3.2, >= 3.2.1)
-      sxp (~> 1.2, >= 1.2.2)
-    sparql-client (3.2.1)
-      net-http-persistent (~> 4.0, >= 4.0.1)
-      rdf (~> 3.2, >= 3.2.6)
-    sxp (1.2.3)
+      sparql-client (~> 3.2, >= 3.2.2)
+      sxp (~> 1.2, >= 1.2.4)
+    sparql-client (3.2.2)
+      net-http-persistent (~> 4.0, >= 4.0.2)
+      rdf (~> 3.2, >= 3.2.11)
+    strscan (3.1.0)
+    sxp (1.2.4)
       matrix (~> 0.4)
       rdf (~> 3.2)
     systemu (2.6.5)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
-    timecop (0.9.6)
+    timecop (0.9.8)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.8.2)
-    unicode-display_width (2.3.0)
-    unicode-types (1.8.0)
+    unicode-display_width (2.5.0)
+    unicode-types (1.9.0)
     uuid (2.3.9)
       macaddr (~> 1.0)
     validatable (1.6.7)
     vcr (5.1.0)
-    webmock (3.18.1)
+    webmock (3.19.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -235,17 +244,17 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 2.0)
-  danger (~> 8.0)
+  danger (~> 9.3)
   pry (~> 0.10, >= 0.10.4)
   pry-byebug (~> 3.6)
   pushmi_pullyu!
   rake (~> 13.0)
-  rspec (~> 3.0)
-  rubocop (~> 1.23)
-  rubocop-rspec (~> 2.6)
-  timecop (~> 0.8)
+  rspec (~> 3.13)
+  rubocop (~> 1.64)
+  rubocop-rspec (~> 2.24)
+  timecop (~> 0.9)
   vcr (~> 5.0)
-  webmock (~> 3.3)
+  webmock (~> 3.19)
 
 BUNDLED WITH
    2.3.12

data/examples/pushmi_pullyu.yml

@@ -32,7 +32,10 @@ swift:
   auth_url: http://localhost:8080/auth/v1.0
   project_name: demo
   project_domain_name: default
-  container: ERA
+  container: era
+  # These 2 extra parameters are now required for keystone v3 authentication
+  auth_version: v3
+  user_domain: default
 
 rollbar:
   token: 'abc123xyz'

data/lib/pushmi_pullyu/cli.rb

@@ -199,6 +199,8 @@ class PushmiPullyu::CLI
   def run_preservation_cycle
     begin
       entity = queue.wait_next_item
+      PushmiPullyu::Logging.log_preservation_attempt(entity,
+                                                     queue.get_entity_ingestion_attempt(entity))
       return unless entity && entity[:type].present? && entity[:uuid].present?
     rescue StandardError => e
       log_exception(e)
@@ -212,27 +214,29 @@ class PushmiPullyu::CLI
         # Push tarred AIP to swift API
         deposited_file = swift.deposit_file(aip_filename, options[:swift][:container])
         # Log successful preservation event to the log files
-        PushmiPullyu::Logging.log_preservation_event(deposited_file, aip_directory)
+        PushmiPullyu::Logging.log_preservation_success(deposited_file, aip_directory)
       end
     # An EntityInvalid expection means there is a problem with the entity information format so there is no point in
     # readding it to the queue as it will always fail
     rescue PushmiPullyu::AIP::EntityInvalid => e
     rescue StandardError => e
+      log_exception(e)
       begin
         queue.add_entity_in_timeframe(entity)
+        PushmiPullyu::Logging.log_preservation_fail_and_retry(entity, queue.get_entity_ingestion_attempt(entity), e)
       rescue PushmiPullyu::PreservationQueue::MaxDepositAttemptsReached => e
+        PushmiPullyu::Logging.log_preservation_failure(entity, queue.get_entity_ingestion_attempt(entity), e)
         log_exception(e)
       end
 
-    # rubocop:disable Lint/RescueException
     # Something other than a StandardError exception means something happened which we were not expecting!
     # Make sure we log the problem
+    # rubocop:disable Lint/RescueException
     rescue Exception => e
-      raise e
-    # rubocop:enable Lint/RescueException
-    ensure
       log_exception(e)
+      raise e
     end
+    # rubocop:enable Lint/RescueException
   end
 
   def run_tick_loop
@@ -244,7 +248,11 @@ class PushmiPullyu::CLI
 
   def setup_log
     if options[:daemonize]
-      PushmiPullyu::Logging.initialize_logger(PushmiPullyu.application_log_file)
+      PushmiPullyu::Logging.initialize_loggers(
+        log_target: PushmiPullyu.application_log_file,
+        events_target: "#{PushmiPullyu.options[:logdir]}/preservation_events.log",
+        json_target: "#{PushmiPullyu.options[:logdir]}/preservation_events.json"
+      )
     else
       logger.formatter = PushmiPullyu::Logging::SimpleFormatter.new
     end
@@ -266,10 +274,12 @@ class PushmiPullyu::CLI
   def swift
     @swift ||= PushmiPullyu::SwiftDepositer.new(username: options[:swift][:username],
                                                 password: options[:swift][:password],
-                                                tenant: options[:swift][:tenant],
                                                 project_name: options[:swift][:project_name],
+                                                tenant: options[:swift][:tenant],
                                                 project_domain_name: options[:swift][:project_domain_name],
-                                                auth_url: options[:swift][:auth_url])
+                                                user_domain: options[:swift][:user_domain],
+                                                auth_url: options[:swift][:auth_url],
+                                                auth_version: options[:swift][:auth_version])
   end
 
   # On first call of shutdown, this will gracefully close the main run loop

data/lib/pushmi_pullyu/logging.rb

@@ -21,14 +21,17 @@ module PushmiPullyu::Logging
 
     attr_writer :logger
 
-    def initialize_logger(log_target = $stdout)
+    def initialize_loggers(log_target: $stdout, events_target: $stdout, json_target: $stdout)
+      @preservation_logger = Logger.new(events_target)
+      @preservation_json_logger = Logger.new(json_target)
+
       @logger = Logger.new(log_target)
       @logger.level = Logger::INFO
       @logger
     end
 
     def logger
-      @logger ||= initialize_logger
+      @logger ||= initialize_loggers
     end
 
     def log_aip_activity(aip_directory, message)
@@ -43,10 +46,13 @@ module PushmiPullyu::Logging
       aip_logger.close
     end
 
-    def log_preservation_event(deposited_file, aip_directory)
-      preservation_logger = Logger.new("#{PushmiPullyu.options[:logdir]}/preservation_events.log")
-      preservation_json_logger = Logger.new("#{PushmiPullyu.options[:logdir]}/preservation_events.json")
+    def log_preservation_event(message, message_json)
+      logger.info(message)
+      @preservation_logger.info(message)
+      @preservation_json_logger.info("#{message_json},")
+    end
 
+    def log_preservation_success(deposited_file, aip_directory)
       message = "#{deposited_file.name} was successfully deposited into Swift Storage!\n" \
                 "Here are the details of this preservation event:\n" \
                 "\tUUID: '#{deposited_file.name}'\n" \
@@ -68,15 +74,62 @@ module PushmiPullyu::Logging
         end
       end
 
-      # Log to both the application log, and the preservation log file
-      logger.info(message)
-      preservation_logger.info(message)
+      log_preservation_event(message, preservation_success_to_json(deposited_file, aip_directory))
+    end
 
-      preservation_logger.close
+    def log_preservation_fail_and_retry(entity, retry_attempt, exception)
+      message = "#{entity[:type]} failed to be deposited and will try again.\n" \
+                "Here are the details of this preservation event:\n" \
+                "\t#{entity[:type]} uuid: #{entity[:uuid]}" \
+                "\tReadding to preservation queue with retry attempt: #{retry_attempt}\n" \
+                "\tError of type: #{exception.class.name}\n" \
+                "\tError message: #{exception.message}\n"
+
+      message_information = {
+        event_type: :fail_and_retry,
+        event_time: Time.now.to_s,
+        entity_type: entity[:type],
+        entity_uuid: entity[:uuid],
+        retry_attempt: retry_attempt,
+        error_message: exception.message
+      }
+
+      log_preservation_event(message, message_information.to_json)
+    end
 
-      message_json_str = preservation_event_to_json(deposited_file, aip_directory)
-      preservation_json_logger.info("#{message_json_str},")
-      preservation_json_logger.close
+    def log_preservation_failure(entity, retry_attempt, exception)
+      message = "#{entity[:type]} failed to be deposited.\n" \
+                "Here are the details of this preservation event:\n" \
+                "\t#{entity[:type]} uuid: #{entity[:uuid]}" \
+                "\tRetry attempt: #{retry_attempt}\n"
+
+      message_information = {
+        event_type: :fail_and_retry,
+        event_time: Time.now.to_s,
+        entity_type: entity[:type],
+        entity_uuid: entity[:uuid],
+        retry_attempt: retry_attempt,
+        error_message: exception.message
+      }
+
+      log_preservation_event(message, message_information.to_json)
+    end
+
+    def log_preservation_attempt(entity, retry_attempt)
+      message = "#{entity[:type]} will attempt to be deposited.\n" \
+                "Here are the details of this preservation event:\n" \
+                "\t#{entity[:type]} uuid: #{entity[:uuid]}" \
+                "\tRetry attempt: #{retry_attempt}\n"
+
+      message_information = {
+        event_type: :attempt,
+        event_time: Time.now.to_s,
+        entity_type: entity[:type],
+        entity_uuid: entity[:uuid],
+        retry_attempt: retry_attempt
+      }
+
+      log_preservation_event(message, message_information.to_json)
     end
 
     ###
@@ -107,14 +160,14 @@ module PushmiPullyu::Logging
     # note:
     #   to parse, the prefix "I, ... INFO --:" in each line needs to be
     #   stripped using a bash command such as "sed"
-    def preservation_event_to_json(deposited_file, aip_directory)
+    def preservation_success_to_json(deposited_file, aip_directory)
       message = {}
 
       message['do_uuid'] = deposited_file.name.to_s
       message['aip_deposited_at'] = deposited_file.last_modified.to_s
       message['aip_md5sum'] = deposited_file.etag.to_s
       message['aip_sha256'] = ''
-      message['aip_metadata'] = deposited_file.metadata.to_json.to_s
+      message['aip_metadata'] = deposited_file.metadata
 
       file_details = file_log_details(aip_directory)
 
@@ -138,7 +191,7 @@ module PushmiPullyu::Logging
       if @logger
         @logger.reopen
       else
-        @logger = initialize_logger
+        @logger = initialize_loggers
       end
     end
 

data/lib/pushmi_pullyu/preservation_queue.rb

@@ -70,6 +70,13 @@ class PushmiPullyu::PreservationQueue
     end
   end
 
+  def get_entity_ingestion_attempt(entity)
+    entity_attempts_key = "#{PushmiPullyu.options[:ingestion_prefix]}#{entity[:uuid]}"
+    @redis.with do |connection|
+      return connection.get entity_attempts_key
+    end
+  end
+
   def add_entity_in_timeframe(entity)
     entity_attempts_key = "#{PushmiPullyu.options[:ingestion_prefix]}#{entity[:uuid]}"
 

data/lib/pushmi_pullyu/swift_depositer.rb

@@ -6,16 +6,24 @@ class PushmiPullyu::SwiftDepositer
   attr_reader :swift_connection
 
   def initialize(connection)
-    @swift_connection = OpenStack::Connection.create(
+    # Generic authentication parameters
+    swift_connection_parameters = {
       username: connection[:username],
       api_key: connection[:password],
-      auth_method: 'password',
       auth_url: connection[:auth_url],
       project_name: connection[:project_name],
-      project_domain_name: connection[:project_domain_name],
-      authtenant_name: connection[:tenant],
+      auth_method: 'password',
       service_type: 'object-store'
-    )
+    }
+
+    if connection[:auth_version] == 'v3'
+      swift_connection_parameters[:user_domain] = connection[:user_domain]
+    elsif connection[:auth_version] == 'v1'
+      swift_connection_parameters[:project_domain_name] = connection[:project_domain_name]
+      swift_connection_parameters[:authtenant_name] = connection[:tenant]
+    end
+
+    @swift_connection = OpenStack::Connection.create(swift_connection_parameters)
   end
 
   def deposit_file(file_name, swift_container)

data/lib/pushmi_pullyu/version.rb

@@ -1,3 +1,3 @@
 module PushmiPullyu
-  VERSION = '2.0.6'.freeze
+  VERSION = '2.1.0'.freeze
 end

data/lib/pushmi_pullyu.rb

@@ -39,10 +39,11 @@ module PushmiPullyu
       auth_url: 'http://localhost:8080/auth/v1.0',
       project_name: 'demo',
       project_domain_name: 'default',
-      container: 'ERA'
-    },
-    rollbar: {
+      container: 'era',
+      auth_version: 'v3',
+      user_domain: 'default'
     },
+    rollbar: {},
     # rubocop disable: Style/FetchEnvVar
     jupiter: {
       user: ENV.fetch('JUPITER_USER', nil),

data/pushmi_pullyu.gemspec

@@ -29,22 +29,11 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'openstack', '~> 3.3', '>= 3.3.10'
   spec.add_runtime_dependency 'rdf', '>= 1.99', '< 4.0'
   spec.add_runtime_dependency 'rdf-n3', '>= 1.99', '< 4.0'
-  spec.add_runtime_dependency 'redis', '>= 3.3', '< 5.0'
+  spec.add_runtime_dependency 'redis', '>= 3.3', '< 6.0'
   spec.add_runtime_dependency 'rest-client', '>= 1.8', '< 3.0'
   spec.add_runtime_dependency 'rollbar', '>= 2.18', '< 4.0'
   spec.add_runtime_dependency 'uuid', '~> 2.3.9'
 
-  spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'danger', '~> 8.0'
-  spec.add_development_dependency 'pry', '~> 0.10', '>= 0.10.4'
-  spec.add_development_dependency 'pry-byebug', '~> 3.6'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 1.23'
-  spec.add_development_dependency 'rubocop-rspec', '~> 2.6'
-  spec.add_development_dependency 'timecop', '~> 0.8'
-  spec.add_development_dependency 'vcr', '~> 5.0'
-  spec.add_development_dependency 'webmock', '~> 3.3'
   spec.metadata = {
     'rubygems_mfa_required' => 'true'
   }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pushmi_pullyu
 version: !ruby/object:Gem::Version
-  version: 2.0.6
+  version: 2.1.0
 platform: ruby
 authors:
 - Shane Murnaghan
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-17 00:00:00.000000000 Z
+date: 2024-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -162,7 +162,7 @@ dependencies:
         version: '3.3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -172,7 +172,7 @@ dependencies:
         version: '3.3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -227,166 +227,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.3.9
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: danger
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '8.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '8.0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.10.4
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.10.4
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.23'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.23'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.6'
-- !ruby/object:Gem::Dependency
-  name: timecop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-- !ruby/object:Gem::Dependency
-  name: vcr
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.3'
 description: 
 email:
 - murnagha@ualberta.ca
@@ -454,7 +294,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Ruby application to manage flow of content from Jupiter into Swift for preservation