uc3-dmp-api-core 0.0.16 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed9b757e777dcc7b4f9f7376301bb9862a72225e656b64330f8f7339f6b9da25
-  data.tar.gz: 2f015eb315d4e025dc7083b650613bee20060ce97b5c4d0d9466d624333f6f6f
+  metadata.gz: ecd9ce7aa91e92f0bc0497c413d90dabceeb90e0038f3625d95da02551cdb6b3
+  data.tar.gz: 81a93bfd340caf3cc9b03765d822465eb7b82565f9e31e5c4b56414fa09c9060
 SHA512:
-  metadata.gz: 9f8dd989a5057d25ebc7f9cc662aa813927986814147440350eb6409278055c113cb8cb7ca9995917ed23ddc699cbbcaef25d541567c2f96fadc7e66ddc8a750
-  data.tar.gz: 64abd3e9580f36a92d2d917398caf2f6914c43a2618c10d0198b89ecb96e404bc2842d39df26cd68ecd61f4f349a157e7cfe7b0fc252488e2c27d5a2c3ea889e
+  metadata.gz: 1be8abaad5987e0bce3925cf55f1e3faf3770322d5539a5f48129b2cc0a93f22818224e0cb07828b17ff13e7129fe567c3b7b6f6e19f91967f0920778e1d792a
+  data.tar.gz: 0f89e11e6058b8315829d86adac3fd3d3d8956bb567fbea3ae75f930d5e72d1c50bfb842e18cca43ce13ca881c7a07271f0c80ad7f2e5e101b4e6d9675a48752

data/lib/uc3-dmp-api-core/responder.rb

@@ -25,7 +25,7 @@ module Uc3DmpApiCore
       # Returns a hash that is a valid Lambda API response
       # --------------------------------------------------------------------------------
       # rubocop:disable Metrics/AbcSize
-      def respond(status: DEFAULT_STATUS_CODE, items: [], errors: [], **args)
+      def respond(status: DEFAULT_STATUS_CODE, logger: nil, items: [], errors: [], **args)
         url = _url_from_event(event: args[:event]) || SsmReader.get_ssm_value(key: 'api_base_url')
         return _standard_error(url: url) if url.nil?
 
@@ -44,7 +44,10 @@ module Uc3DmpApiCore
         body = body.merge(Paginator.pagination_meta(url: url, item_count: item_count, params: args))
 
         # If this is a server error, then notify the administrator!
-        LogWriter.log_error(source: url, message: errors, details: body, event: args[:event]) if status.to_s[0] == '5'
+        if status.to_s[0] == '5' && !logger.nil?
+          logger.error(message: errors, details: body)
+          Notifier.notify_administrator(source: logger.source, details: body, event: logger.event)
+        end
 
         { statusCode: status.to_i, body: body.compact.to_json, headers: headers }
       rescue StandardError => e

data/lib/uc3-dmp-api-core/ssm_reader.rb

@@ -9,7 +9,7 @@ module Uc3DmpApiCore
   # Shared helper methods for accessing SSM parameters
   # ----------------------------------------------------
   class SsmReader
-    SOURCE = 'SsmReader gem'
+    SOURCE = 'Uc3DmpApiCore::SsmReader'
 
     class << self
       # Return all of the available keys
@@ -20,8 +20,9 @@ module Uc3DmpApiCore
       # Fetch the value for the specified :key
       # ----------------------------------------------------
       # rubocop:disable Metrics/AbcSize
-      def get_ssm_value(key:, provenance_name: nil)
+      def get_ssm_value(key:, provenance_name: nil, logger: nil)
         full_key = _ssm_keys[:"#{key.downcase}"] unless key.nil?
+        logger.debug(message: "Looking for SSM Key: #{full_key}")
         return nil if full_key.nil?
 
         key_vals = { env: ENV.fetch('LAMBDA_ENV', 'dev').to_s.downcase }
@@ -30,29 +31,19 @@ module Uc3DmpApiCore
                                                        !full_key.include?('%{provenance}')
         fetch_value(key: format(full_key, key_vals))
       rescue Aws::Errors::ServiceError => e
-        LogWriter.log_error(
-          source: "#{SOURCE} - looking for #{key}", message: e.message, details: e.backtrace
-        )
+        puts "Fatal error in #{SOURCE} - #{e.message}" if logger.nil?
+        logger.error(message: "Looking for SSM Key: #{key} - #{e.message}", details: e.backtrace) unless logger.nil?
         nil
       end
       # rubocop:enable Metrics/AbcSize
 
       # Call SSM to get the value for the specified key
-      def fetch_value(key:)
+      def fetch_value(key:, logger:)
         resp = Aws::SSM::Client.new.get_parameter(name: key, with_decryption: true)
+        logger.debug(message: "Searching for SSM Key: #{key}, Found: '#{resp&.parameter&.value}'")
         resp.nil? || resp.parameter.nil? ? nil : resp.parameter.value
       end
 
-      # Checks to see if debug mode has been enabled in SSM
-      # ----------------------------------------------------
-      def debug_mode?
-
-puts "Checking to see if we are in debug mode."
-puts "Key: #{_ssm_keys[:debug_mode]}, Val: #{get_ssm_value(key: _ssm_keys[:debug_mode])}, Downcased: #{get_ssm_value(key: _ssm_keys[:debug_mode])&.to_s&.downcase&.strip} "
-
-        get_ssm_value(key: _ssm_keys[:debug_mode])&.to_s&.downcase&.strip == 'true'
-      end
-
       private
 
       # DMPTool/DMPHub SSM keys. See the installation guide for information about how these values are used
@@ -63,7 +54,6 @@ puts "Key: #{_ssm_keys[:debug_mode]}, Val: #{get_ssm_value(key: _ssm_keys[:debug
           administrator_email: '/uc3/dmp/hub/%{env}/AdminEmail',
           api_base_url: '/uc3/dmp/hub/%{env}/ApiBaseUrl',
           base_url: '/uc3/dmp/hub/%{env}/BaseUrl',
-          debug_mode: '/uc3/dmp/hub/%{env}/Debug',
 
           dmp_id_api_url: '/uc3/dmp/hub/%{env}/EzidApiUrl',
           dmp_id_base_url: '/uc3/dmp/hub/%{env}/EzidBaseUrl',

data/lib/uc3-dmp-api-core/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Uc3DmpApiCore
-  VERSION = '0.0.16'
+  VERSION = '0.0.18'
 end

data/lib/uc3-dmp-api-core.rb

@@ -4,7 +4,6 @@
 require 'aws-sdk-sns'
 require 'aws-sdk-ssm'
 
-require 'uc3-dmp-api-core/log_writer'
 require 'uc3-dmp-api-core/notifier'
 require 'uc3-dmp-api-core/paginator'
 require 'uc3-dmp-api-core/responder'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uc3-dmp-api-core
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.18
 platform: ruby
 authors:
 - Brian Riley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-03 00:00:00.000000000 Z
+date: 2023-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -131,7 +131,6 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/uc3-dmp-api-core.rb
-- lib/uc3-dmp-api-core/log_writer.rb
 - lib/uc3-dmp-api-core/notifier.rb
 - lib/uc3-dmp-api-core/paginator.rb
 - lib/uc3-dmp-api-core/responder.rb

data/lib/uc3-dmp-api-core/log_writer.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module Uc3DmpApiCore
-  # Standardized ways for logging messages and errors to CloudWatch
-  #
-  # Methods expect the following inputs:
-  #   - source:       the name of the Lambda function or Layer file
-  #   - message:      the error message as a String or Array of Strings
-  #   - details:      any additional context as a Hash
-  #   - event:        the Lambda event if available
-  #
-  # --------------------------------------------------------------------------------
-  class LogWriter
-    class << self
-      # rubocop:disable Metrics/AbcSize
-      def log_error(source:, message:, details: {}, event: {})
-        return false if source.nil? || message.nil?
-
-        message = message.join(', ') if message.is_a?(Array)
-        # Is there a better way here than just 'print'? This ends up in the CloudWatch logs
-        puts "ERROR: #{source} - #{message}"
-        puts " - DETAILS: #{details.to_json}" if details.is_a?(Hash) && details.keys.any?
-        puts " - EVENT: #{event.to_json}" if event.is_a?(Hash) && event.keys.any?
-
-        Notifier.notify_administrator(source: source, details: details, event: event)
-      end
-      # rubocop:enable Metrics/AbcSize
-
-      def log_message(source:, message:, details: {}, event: {})
-        return false if source.nil? || message.nil?
-
-        message = message.join(', ') if message.is_a?(Array)
-
-        # Is there a better way here than just 'print'? This ends up in the CloudWatch logs
-        puts "INFO: #{source} - #{message}"
-        puts " - DETAILS: #{details.to_json}" if details.is_a?(Hash) && details.keys.any?
-        puts " - EVENT: #{event.to_json}" if event.is_a?(Hash) && event.keys.any?
-        true
-      end
-    end
-  end
-end