uc3-dmp-api-core 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7033c9283948ba0b3b9a2cea45d17ba843f42b2d78f8a32f003d88cce9532c9e
-  data.tar.gz: 7fbfe97abe42ee3005c37b246eac7eece4358cceb42a9c7d8fe4e1ae13f5c8ac
+  metadata.gz: e43205e6d19650a78cf8845c988c4272cd2c50deabdfe2cd36f90d767392b19a
+  data.tar.gz: 20095892d247fa52efd093c37f38daf6a90c410e198e191ea0829de862469a4b
 SHA512:
-  metadata.gz: d253494718f77f3cbf5e72d65f331eebe00a5fc327551c6478c1c144c29028b6bbab79395a76a15883049ff89482011015bb8387116407cb1d27edc64c8e24ae
-  data.tar.gz: fc0776170a8a1237f4b66564b83b12ff991548d6f98f4e8f43cce35414c3ba6a70e5e86f62155f710d09d230626510c46dcd64ad144d740dd7f5814e73abcf2b
+  metadata.gz: 948f688a92a84ae3998283d936cc6e605c28a266df2ee7d3b4dae31e2220b59365ef76e5627afa9e7d66daf3c8636d8a3f2b7d247e40da905500acb204b6feeb
+  data.tar.gz: 8c35c26fe2206c24457fed0e003dba47fe79885351a1b5cdad1d111d82fad41d9491ea89ce02a4290efc5a27fb6743db6b4475e6dceac799daf2fa07e140c139

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

@@ -2,6 +2,8 @@
 
 require_relative './notifier'
 
+require 'notifier'
+
 module Uc3DmpApiCore
   # Standardized ways for logging messages and errors to CloudWatch
   #

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

@@ -11,27 +11,35 @@ module Uc3DmpApiCore
       def paginate(params: {}, results:)
         return results unless results.is_a?(Array) && results.any? && params.is_a?(Hash)
 
-        current = _current_page(item_count: item_count, params: params)
+        current = _current_page(item_count: results.length, params: params)
         # Just return as is if there is only one page
         return results if current[:total_pages] == 1 || current[:per_page] >= results.length
 
         # Calculate the offset and extract those results
         offset = current[:page] == 1 ? 0 : (current[:page] - 1) * current[:per_page]
-        results[offset,(current[:per_page] - 1)]
+        results[offset,current[:per_page]]
       end
 
       # Construct the pagination meta information that will be included in the response
       def pagination_meta(url:, item_count: 0, params: {})
-        current = _current_page(item_count: item_count, params: params)
-        {
-          page: current[:page],
-          per_page: current[:per_page],
-          total_items: item_count,
-          first: _pagination_link(url: url, target_page: 1, per_page: per_page),
-          prev: _pagination_link(url: url, target_page: page - 1, per_page: per_page),
-          next: _pagination_link(url: url, target_page: page + 1, per_page: per_page),
-          last: _pagination_link(url: url, target_page: total_pages, per_page: per_page)
-        }.compact
+        prms = _current_page(item_count: item_count, params: 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]
+
+        prv = prms[:page] - 1
+        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.compact
       end
 
       private
@@ -41,7 +49,7 @@ module Uc3DmpApiCore
         page = params.fetch('page', DEFAULT_PAGE)
         page = DEFAULT_PAGE if page <= 1
         per_page = params.fetch('per_page', DEFAULT_PER_PAGE)
-        per_page = DEFAULT_PER_PAGE if per_page >= MAXIMUM_PER_PAGE || per_page <= 1
+        per_page = DEFAULT_PER_PAGE if per_page >= MAXIMUM_PER_PAGE || per_page < 1
 
         total_pages = _page_count(total: item_count, per_page: per_page)
         page = total_pages if page > total_pages
@@ -51,7 +59,7 @@ module Uc3DmpApiCore
 
       # Generate a pagination link
       # --------------------------------------------------------------------------------
-      def _pagination_link(url:, target_page:, per_page: DEFAULT_PER_PAGE)
+      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)

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'paginator'
+
 module Uc3DmpApiCore
   # Use Rails' ActiveResource to communicate with the DMPHub REST API
   class Responder
@@ -28,46 +30,48 @@ module Uc3DmpApiCore
       # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       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 { statusCode: DEFAULT_STATUS_CODE, body: { errors: ["#{MSG_INVALID_ARGS} - resp"] } } if url.nil?
+        return _standard_error(url: url) if url.nil?
 
+        args = JSON.parse(args.to_json)
         errors = [errors] unless errors.nil? || errors.is_a?(Array)
         item_count = items.is_a?(Array) ? items.length : 0
-        page = args[:page] || DEFAULT_PAGE
-        per_page = args[:per_page] || DEFAULT_PER_PAGE
-
-        unless ENV['CORS_ORIGIN'].nil?
-          cors_headers = {
-            'Access-Control-Allow-Headers': ENV['CORS_HEADERS'],
-            'Access-Control-Allow-Origin': ENV['CORS_ORIGIN'],
-            'Access-Control-Allow-Methods': ENV['CORS_METHODS']
-          }
-        end
 
         body = {
           status: status.to_i,
           requested: url,
           requested_at: Time.now.strftime(TIMESTAMP_FORMAT),
           total_items: item_count,
-          items: items.is_a?(Array) ? items.compact : []
+          items: items.is_a?(Array) ? Paginator.paginate(params: args, results: items) : [],
+          errors: errors
         }
-
-        body[:errors] = errors if errors.is_a?(Array) && errors.any?
-        body = _paginate(url: url, item_count: item_count, body: body, page: page, per_page: per_page)
+        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 == 500
+        log_error(source: url, message: errors, details: body, event: args[:event]) if status.to_s[0] == '5'
 
-        { statusCode: status.to_i, body: body.to_json, headers: cors_headers.nil? ? {} : cors_headers }
+        { statusCode: status.to_i, body: body.compact.to_json, headers: headers }
       rescue StandardError => e
-        puts "LambdaLayer: Responder.respond - #{e.message}"
+        puts "Uc3DmpApiCore.Responder.respond - #{e.message}"
         puts " - STACK: #{e.backtrace}"
-        { statusCode: DEFAULT_STATUS_CODE, body: { errors: ["#{MSG_INVALID_ARGS} - resp err"] } }
+        _standard_error(url: url)
       end
       # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
       # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
       private
 
+      # Format an error response for any issues within this Responder!
+      def _standard_error(url:, status: DEFAULT_STATUS_CODE, message: Uc3DmpApiCore::MSG_SERVER_ERROR)
+        body = {
+          status: status.to_i,
+          requested: url,
+          requested_at: Time.now.strftime(TIMESTAMP_FORMAT),
+          total_items: 0,
+          errors: [message]
+        }
+        { statusCode: DEFAULT_STATUS_CODE, body: body.compact.to_json, headers: headers }
+      end
+
       # Figure out the requested URL from the Lambda event hash
       # --------------------------------------------------------------------------------
       def _url_from_event(event:)
@@ -78,6 +82,16 @@ module Uc3DmpApiCore
 
         "#{url}?#{event['queryStringParameters'].map { |k, v| "#{k}=#{v}" }.join('&')}"
       end
+
+      def headers
+        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']
+        }
+      end
     end
   end
 end

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

@@ -2,6 +2,8 @@
 
 require 'aws-sdk-ssm'
 
+require 'logger'
+
 module Uc3DmpApiCore
   # ----------------------------------------------------
   # SSM Parameter Store Helper

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

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

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

@@ -3,6 +3,7 @@
 require 'aws-sdk-sns'
 require 'aws-sdk-ssm'
 
+require 'uc3-dmp-api-core/logger'
 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.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Brian Riley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-28 00:00:00.000000000 Z
+date: 2023-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json