uc3-dmp-api-core 0.0.21 → 0.0.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 814a119b8bc2cae5b1019b447d206158f32af4322d7027c5d67692790662b620
-  data.tar.gz: 706c0127627df31924c712de0129f09e721d6659b8f04c0ce7ebdc4a819f1f14
+  metadata.gz: bc4c08b495c72961cf18ad8ecec8502b20a0154bde884fca9f55ec16fb944ea1
+  data.tar.gz: 5a5d3d363cb375c11f7548d1339d6b44bdc26fd92099b0a2c5021b3fa0bab5ee
 SHA512:
-  metadata.gz: 5aa2fb5aeea37687db35306f41c775ca5497f5184d5e04750830b8d2c9cd87a79d34e3c54c399f2531aa244d5bdf4f0e2c02684131f57d0892a06a0012fc9351
-  data.tar.gz: e0b90e46aac95b8d63f355e5e4198f0c99d3888a05abda1ac48e45ca5fcaef77ad38f479263e215e080ece7cf74d909604c221648dac86845a8957674bc59e44
+  metadata.gz: 6a3cba6f5e355f84d03a230201f19cd2e29a3d905da40ae99fe6b57d2329bdbc9581a220b47a0c7de669ae379c57bc82a2098ff30de7006515fe492f671be0c8
+  data.tar.gz: 719f0f56edff2b151a09570db7e50e390622802d9c2e309f70aa7f6f320700b6516f6b6934e31c87af6300cf2a58d0cebb7764713be5c89f182b19f2cbc31003

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

@@ -12,7 +12,7 @@ module Uc3DmpApiCore
         Aws::SNS::Client.new.publish(
           topic_arn: ENV.fetch('SNS_FATAL_ERROR_TOPIC', nil),
           subject: "DMPTool - fatal error in - #{source}",
-          message: _build_admin_message(source: source, details: details, event: event)
+          message: _build_admin_message(source:, details:, event:)
         )
         true
       rescue Aws::Errors::ServiceError => e

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

@@ -12,7 +12,7 @@ module Uc3DmpApiCore
       def paginate(results:, params: {})
         return results unless results.is_a?(Array) && results.any? && params.is_a?(Hash)
 
-        current = _current_page(item_count: results.length, params: params)
+        current = _current_page(item_count: results.length, params:)
         # Just return as is if there is only one page
         return results if current[:total_pages] == 1 || current[:per_page] >= results.length
 
@@ -25,7 +25,7 @@ module Uc3DmpApiCore
       # Construct the pagination meta information that will be included in the response
       # rubocop:disable Metrics/AbcSize
       def pagination_meta(url:, item_count: 0, params: {})
-        prms = _current_page(item_count: item_count, params: params)
+        prms = _current_page(item_count:, params:)
 
         hash = { page: prms[:page], per_page: prms[:per_page], total_items: item_count }
         return hash if prms[:total_pages] == 1 || item_count <= prms[:per_page]
@@ -34,10 +34,10 @@ module Uc3DmpApiCore
         nxt = prms[:page] + 1
         last = prms[:total_pages]
 
-        hash[:first] = _build_link(url: url, target_page: 1, per_page: prms[:per_page]) if prms[:page] > 1
-        hash[:prev] = _build_link(url: url, target_page: prv, per_page: prms[:per_page]) if prms[:page] > 1
-        hash[:next] = _build_link(url: url, target_page: nxt, per_page: prms[:per_page]) if prms[:page] < last
-        hash[:last] = _build_link(url: url, target_page: last, per_page: prms[:per_page]) if prms[:page] < last
+        hash[:first] = _build_link(url:, target_page: 1, per_page: prms[:per_page]) if prms[:page] > 1
+        hash[:prev] = _build_link(url:, target_page: prv, per_page: prms[:per_page]) if prms[:page] > 1
+        hash[:next] = _build_link(url:, target_page: nxt, per_page: prms[:per_page]) if prms[:page] < last
+        hash[:last] = _build_link(url:, target_page: last, per_page: prms[:per_page]) if prms[:page] < last
         hash.compact
       end
       # rubocop:enable Metrics/AbcSize
@@ -45,24 +45,26 @@ module Uc3DmpApiCore
       private
 
       # Fetch the current :page and :per_page from the params or use the defaults
+      # rubocop:disable Metrics/AbcSize
       def _current_page(item_count: 0, params: {})
         page = params.fetch('page', DEFAULT_PAGE).to_i
         page = DEFAULT_PAGE if page.nil? || page.to_i <= 1
         per_page = params.fetch('per_page', DEFAULT_PER_PAGE).to_i
         per_page = DEFAULT_PER_PAGE if per_page.nil? || per_page.to_i >= MAXIMUM_PER_PAGE || per_page.to_i < 1
 
-        total_pages = _page_count(total: item_count, per_page: per_page)
+        total_pages = _page_count(total: item_count, per_page:)
         page = total_pages if page > total_pages
 
         { page: page.to_i, per_page: per_page.to_i, total_pages: total_pages.to_i }
       end
+      # rubocop:enable Metrics/AbcSize
 
       # Generate a pagination link
       # --------------------------------------------------------------------------------
       def _build_link(url:, target_page:, per_page: DEFAULT_PER_PAGE)
         return nil if url.nil? || target_page.nil?
 
-        link = _url_without_pagination(url: url)
+        link = _url_without_pagination(url:)
         return nil if link.nil?
 
         link += '?' unless link.include?('?')

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

@@ -24,10 +24,11 @@ module Uc3DmpApiCore
       #
       # Returns a hash that is a valid Lambda API response
       # --------------------------------------------------------------------------------
-      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       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?
+        return _standard_error(url:) if url.nil?
 
         args = JSON.parse(args.to_json)
         errors = [errors] unless errors.nil? || errors.is_a?(Array)
@@ -39,9 +40,9 @@ module Uc3DmpApiCore
           requested_at: Time.now.strftime(TIMESTAMP_FORMAT),
           total_items: item_count,
           items: items.is_a?(Array) ? Paginator.paginate(params: args, results: items) : [],
-          errors: errors
+          errors:
         }
-        body = body.merge(Paginator.pagination_meta(url: url, item_count: item_count, params: args))
+        body = body.merge(Paginator.pagination_meta(url:, item_count:, params: args))
 
         # If this is a server error, then notify the administrator!
         if status.to_s[0] == '5' && !logger.nil?
@@ -49,12 +50,13 @@ module Uc3DmpApiCore
           Notifier.notify_administrator(source: logger.source, details: body, event: logger.event)
         end
 
-        { statusCode: status.to_i, body: body.compact.to_json, headers: headers }
+        { statusCode: status.to_i, body: body.compact.to_json, headers: }
       rescue StandardError => e
-        logger.error(message: e.message, details: e.backtrace) unless logger.nil?
-        _standard_error(url: url)
+        logger&.error(message: e.message, details: e.backtrace)
+        _standard_error(url:)
       end
-      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
       private
 
@@ -67,7 +69,7 @@ module Uc3DmpApiCore
           total_items: 0,
           errors: [message]
         }
-        { statusCode: DEFAULT_STATUS_CODE, body: body.compact.to_json, headers: headers }
+        { statusCode: DEFAULT_STATUS_CODE, body: body.compact.to_json, headers: }
       end
 
       # Figure out the requested URL from the Lambda event hash
@@ -84,7 +86,7 @@ module Uc3DmpApiCore
       def headers
         return {} if ENV['CORS_ORIGIN'].nil?
 
-        { 'access-control-allow-origin': ENV['CORS_ORIGIN'] }
+        { 'access-control-allow-origin': ENV.fetch('CORS_ORIGIN', nil) }
       end
     end
   end

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

@@ -22,16 +22,16 @@ module Uc3DmpApiCore
       # rubocop:disable Metrics/AbcSize
       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}") unless logger.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 }
         # Swap in the provenance name if applicable
         key_vals[:provenance] = provenance_name unless provenance_name.nil? ||
                                                        !full_key.include?('%{provenance}')
-        fetch_value(key: format(full_key, key_vals), logger: logger)
+        fetch_value(key: format(full_key, key_vals), logger:)
       rescue Aws::Errors::ServiceError => e
-        logger.error(message: "Looking for SSM Key: #{key} - #{e.message}", details: e.backtrace) unless logger.nil?
+        logger&.error(message: "Looking for SSM Key: #{key} - #{e.message}", details: e.backtrace)
         nil
       end
       # rubocop:enable Metrics/AbcSize
@@ -39,7 +39,7 @@ module Uc3DmpApiCore
       # Call SSM to get the value for the specified key
       def fetch_value(key:, logger: nil)
         resp = Aws::SSM::Client.new.get_parameter(name: key, with_decryption: true)
-        logger.debug(message: "Searching for SSM Key: #{key}, Found: '#{resp&.parameter&.value}'") unless logger.nil?
+        logger&.debug(message: "Searching for SSM Key: #{key}, Found: '#{resp&.parameter&.value}'")
         resp.nil? || resp.parameter.nil? ? nil : resp.parameter.value
       end
 
@@ -47,7 +47,6 @@ module Uc3DmpApiCore
 
       # DMPTool/DMPHub SSM keys. See the installation guide for information about how these values are used
       #    https://github.com/CDLUC3/dmp-hub-cfn/wiki/installation-and-setup#required-ssm-parameters
-      # rubocop:disable Metrics/MethodLength
       def _ssm_keys
         {
           administrator_email: '/uc3/dmp/hub/%{env}/AdminEmail',
@@ -75,7 +74,6 @@ module Uc3DmpApiCore
           dynamo_table_name: '/uc3/dmp/hub/%{env}/DynamoTableName'
         }
       end
-      # rubocop:enable Metrics/MethodLength
     end
   end
 end

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

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

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

@@ -9,6 +9,7 @@ require 'uc3-dmp-api-core/paginator'
 require 'uc3-dmp-api-core/responder'
 require 'uc3-dmp-api-core/ssm_reader'
 
+# Entrypoitn for the uc3-dmp-api-core gem
 module Uc3DmpApiCore
   # General HTTP Response Messages
   # ----------------------------------------

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uc3-dmp-api-core
 version: !ruby/object:Gem::Version
-  version: 0.0.21
+  version: 0.0.23
 platform: ruby
 authors:
 - Brian Riley
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-12 00:00:00.000000000 Z
+date: 2024-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -141,7 +141,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'false'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -149,15 +149,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.4.22
+signing_key:
 specification_version: 4
 summary: DMPTool gem that provides general support for Lambda functions
 test_files: []