uc3-dmp-api-core 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fdf225c15fdb31fde0c5b580c65fe11cc1f954ca5095c3ba65b97ec5a75706c
-  data.tar.gz: 312895d96acf566e198b8159ced5cdf99055330fcddf62b105cfc750fa2d124b
+  metadata.gz: cbc951e48875269d72952ec846fb48d262edc1de0646f922b989fcca081c3365
+  data.tar.gz: 29d964e6a26deef238cc42d67d24fb1d5fd33334160405d5a03e8da0a7c8a7cd
 SHA512:
-  metadata.gz: c70e9f61cd6d20b1936561a15257d89d13655eb6d163c28c9cd75f2e1c46927118128155312e6b2e6797d704de6fa5360ea4c2ae3019fd159b8a39d95dc4bc4b
-  data.tar.gz: 7dd073b4a5c47ac0fef2c750bb780282b8b0cdf23fc8243dcbcf64a27b02787ec3dc692d25dbc2c962803f2b5a99f480c2363b62950bfec7d99bb45287a858b5
+  metadata.gz: 0eecb4937d2f190f2e620ab5ba7598030a2bfd085c860e2a8714fbc25e3f1cd434f63f08cfe875ed46322f1d1fcde520d1a3bdcefe3967b5f375a566564f58cc
+  data.tar.gz: 82db9a348a62d816998170aa6c954859a3ce68843d3e2f393193b5066cdd31aa19741c8c6163933ad7daa51b81e6b2b5175f33e15585da8dad791ced188b869a

data/README.md

@@ -2,7 +2,8 @@
 
 Basic helper classes used by the DMPTool Lambda functions.
 
-- Logger: Helper for logging messages and errors to CloudWatch
+- LogWriter: Helper for logging messages and errors to CloudWatch
 - Notifier: Helper for sending emails via SNS and sending events to EventBridge
+- Paginator: Helper for paginating search results and building the pagination links for the response
 - Responder: Helper that formats API responses in a standardized way
 - SsmReader: Helper that fetches values from the SSM parameter store

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

@@ -34,6 +34,7 @@ module Uc3DmpApiCore
         # 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

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

@@ -8,7 +8,6 @@ module Uc3DmpApiCore
     class << self
       # Sends the Administrator an email notification
       # --------------------------------------------------------------------------------
-      # rubocop:disable Metrics/AbcSize
       def notify_administrator(source:, details:, event: {})
         Aws::SNS::Client.new.publish(
           topic_arn: ENV.fetch('SNS_FATAL_ERROR_TOPIC', nil),
@@ -22,13 +21,13 @@ module Uc3DmpApiCore
         puts " - DETAILS: #{details.to_json}" if details.is_a?(Hash) && details.keys.any?
         false
       end
-      # rubocop:enable Metrics/AbcSize
 
       private
 
       # Format the Admin email message
       def _build_admin_message(source:, details:, event: {})
-        payload = "DMPTool #{ENV.fetch('LAMBDA_ENV', 'dev')} has encountered a fatal error within a Lambda function.\n\n /
+        payload = "DMPTool #{ENV.fetch('LAMBDA_ENV',
+                                       'dev')} has encountered a fatal error within a Lambda function.\n\n /
           SOURCE: #{source}\n /
           TIME STAMP: #{Time.now.strftime('%Y-%m-%dT%H:%M:%S%L%Z')}\n /
           NOTES: Check the CloudWatch logs for additional details.\n\n"
@@ -36,6 +35,7 @@ module Uc3DmpApiCore
         payload += "DETAILS: #{details.to_json}\n\n" if details.is_a?(Hash) && details.keys.any?
         payload += "This is an automated email generated by the Uc3DmpCore.Notifier gem.\n /
                     Please do not reply to this message."
+        payload
       end
     end
   end

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

@@ -8,7 +8,8 @@ module Uc3DmpApiCore
     MAXIMUM_PER_PAGE = 250
 
     class << self
-      def paginate(params: {}, results:)
+      # rubocop:disable Metrics/AbcSize
+      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)
@@ -17,18 +18,16 @@ module Uc3DmpApiCore
 
         # Calculate the offset and extract those results
         offset = current[:page] == 1 ? 0 : (current[:page] - 1) * current[:per_page]
-        results[offset,current[:per_page]]
+        results[offset, current[:per_page]]
       end
+      # rubocop:enable Metrics/AbcSize
 
       # 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)
 
-        hash = {
-          page: prms[:page],
-          per_page: prms[:per_page],
-          total_items: item_count
-        }
+        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]
 
         prv = prms[:page] - 1
@@ -41,6 +40,7 @@ module Uc3DmpApiCore
         hash[:last] = _build_link(url: url, target_page: last, per_page: prms[:per_page]) if prms[:page] < last
         hash.compact
       end
+      # rubocop:enable Metrics/AbcSize
 
       private
 

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

@@ -24,8 +24,7 @@ module Uc3DmpApiCore
       #
       # Returns a hash that is a valid Lambda API response
       # --------------------------------------------------------------------------------
-      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      # rubocop:disable Metrics/AbcSize
       def respond(status: DEFAULT_STATUS_CODE, 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?
@@ -45,7 +44,7 @@ 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!
-        log_error(source: url, message: errors, details: body, event: args[:event]) if status.to_s[0] == '5'
+        Logger.log_error(source: url, message: errors, details: body, event: args[:event]) if status.to_s[0] == '5'
 
         { statusCode: status.to_i, body: body.compact.to_json, headers: headers }
       rescue StandardError => e
@@ -53,8 +52,7 @@ module Uc3DmpApiCore
         puts " - STACK: #{e.backtrace}"
         _standard_error(url: url)
       end
-      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
-      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      # rubocop:enable Metrics/AbcSize
 
       private
 
@@ -85,9 +83,9 @@ module Uc3DmpApiCore
         return {} if ENV['CORS_ORIGIN'].nil?
 
         {
-          'Access-Control-Allow-Headers': ENV['CORS_HEADERS'],
-          'Access-Control-Allow-Origin': ENV['CORS_ORIGIN'],
-          'Access-Control-Allow-Methods': ENV['CORS_METHODS']
+          'Access-Control-Allow-Headers': ENV.fetch('CORS_HEADERS', nil),
+          'Access-Control-Allow-Origin': ENV.fetch('CORS_ORIGIN', nil),
+          'Access-Control-Allow-Methods': ENV.fetch('CORS_METHODS', nil)
         }
       end
     end

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

@@ -21,10 +21,9 @@ module Uc3DmpApiCore
       # ----------------------------------------------------
       # rubocop:disable Metrics/AbcSize
       def get_ssm_value(key:, provenance_name: nil)
-        full_key = _ssm_keys[:"#{key.downcase.to_s}"] unless key.nil?
+        full_key = _ssm_keys[:"#{key.downcase}"] unless key.nil?
         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? ||
@@ -54,6 +53,7 @@ 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',
@@ -82,6 +82,7 @@ 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.6'
+  VERSION = '0.0.7'
 end

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

@@ -1,3 +1,4 @@
+# rubocop:disable Naming/FileName
 # frozen_string_literal: true
 
 require 'aws-sdk-sns'
@@ -16,3 +17,4 @@ module Uc3DmpApiCore
   MSG_INVALID_ARGS = 'Invalid arguments.' # For HTTP 400 (Bad request)
   MSG_SERVER_ERROR = 'Unable to process your request at this time.' # For HTTP 500 (Server error)
 end
+# rubocop:enable Naming/FileName

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uc3-dmp-api-core
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Brian Riley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-01 00:00:00.000000000 Z
+date: 2023-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -100,14 +100,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.88.0
+        version: 1.50.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.88.0
+        version: 1.50.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.20.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.20.0
 description: Helpers for SSM, EventBridge, standardizing responses/errors
 email:
 - brian.riley@ucop.edu
@@ -126,7 +140,8 @@ files:
 homepage: https://github.com/CDLUC3/dmp-hub-cfn/blob/main/src/sam/gems/uc3-dmp-api-core
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'false'
 post_install_message: 
 rdoc_options: []
 require_paths: