uc3-dmp-dynamo 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b80170988e25aef1241fd264b2e3e6640420851e8c16209946a53067eda0d16a
-  data.tar.gz: 0e88dba2cae7cb9bc5427f474eb3230ff627f806e433ea43ce1d7a3ff2de9ec0
+  metadata.gz: c011576d2723217aae4d7342bf91a859257e4216bd5206e044adf24bb29f7690
+  data.tar.gz: da6fa2f726afbfb00c0d55b331b014b29eb52369982ee6298b51c8b9d80ca979
 SHA512:
-  metadata.gz: 1384e8054db8fb6121631b3c7f32dc5180a6136115a84672613882af1edc07310cb069ab93d9c35e9126fdc993fd21e609c6a6d05b92f4b846da631c666a3658
-  data.tar.gz: 98a6e2672a64efe161ca4d1893bed31a4da2252d2e22f3ec93b8cf4c638b32c5c6187b1b277b4d19c96068bc394166c5d03f11687d6a69390bbbeea7264833c8
+  metadata.gz: b267194e66c9970735c40bcd0146f0124d5692ea083954656826dd18a17d043a5b440c76d9d6c1444a6dcd473f7207b685603942bc32e0fa83042d14125080f1
+  data.tar.gz: 7ae5ef0d23a3d409075f885657898a3f720eaf0e4aef102af9b0fa881c40e48aa41b98adc971b1c40519884e4934028d3f3390f26d11f060b9d4b67ddbf3db52

data/lib/uc3-dmp-dynamo/client.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
-
 # TODO: Be sure to update the API functions so that they call cleanse_dmp_json before
 #       calling Uc3DmpApiCore::Responder.respond !!!!!!!!!!
 
-
 module Uc3DmpDynamo
-  class Uc3DmpDynamoError < StandardError; end
+  class ClientError < StandardError; end
 
   # Helper functions for working with Dynamo JSON
   class Client
@@ -16,35 +14,37 @@ module Uc3DmpDynamo
     MSG_MISSING_TABLE = 'No Dynamo Table defined! Looking for `ENV[\'DYNAMO_TABLE\']`'
     MSG_DYNAMO_ERROR = 'Dynamo DB Table Error - %{msg} - %{trace}'
 
-    attr_accessor: :connection, :table
+    attr_accessor :connection, :table
 
-    def initialize(**args)
-      @table = ENV['DYNAMO_TABLE']
-      raise Uc3DmpDynamoError, MSG_MISSING_TABLE if @table.nil?
+    def initialize(**_args)
+      @table = ENV.fetch('DYNAMO_TABLE', nil)
+      raise ClientError, MSG_MISSING_TABLE if @table.nil?
 
       @connection = Aws::DynamoDB::Client.new(region: ENV.fetch('AWS_REGION', 'us-west-2'))
     end
 
     # Fetch a single item
+    # rubocop:disable Metrics/AbcSize
     def get_item(key:, debug: false)
-      raise Uc3DmpDynamoError, MSG_INVALID_KEY unless key.is_a?(Hash)
+      raise ClientError, MSG_INVALID_KEY unless key.is_a?(Hash) && !key[:PK].nil?
 
       resp = @connection.get_item(
         { table_name: @table,
           key: key,
           consistent_read: false,
-          return_consumed_capacity: debug ? 'TOTAL' : 'NONE'
-        }
+          return_consumed_capacity: debug ? 'TOTAL' : 'NONE' }
       )
+
       # If debug is enabled then write the response to the LogWriter
       if debug
         puts "#{SOURCE} => get_item - #{key}"
         puts resp[:item].first.inspect
       end
-      resp[:item].first
+      resp[:item].is_a?(Array) ? resp[:item].first : resp[:item]
     rescue Aws::Errors::ServiceError => e
-      raise Uc3DmpDynamoError, MSG_DYNAMO_ERROR % { msg: e.message, trace: e.backtrace }
+      raise ClientError, format(MSG_DYNAMO_ERROR, msg: e.message, trace: e.backtrace)
     end
+    # rubocop:enable Metrics/AbcSize
 
     # Perform a table scan if a filter was specified.
     # For example:
@@ -52,9 +52,9 @@ module Uc3DmpDynamo
     #    projection_expression: 'title, dmp_id, modified'
     #
     # See the DynamoDB docs for examples of key_conditions and projection_expressions
-    def query(debug: false, **args)
-      raise Uc3DmpDynamoError, MSG_INVALID_KEY unless args[:key_conditions].is_a?(Hash) &&
-                                                      !args[:key_conditions].keys.empty?
+    # rubocop:disable Metrics/AbcSize
+    def query(args:, debug: false)
+      raise ClientError, MSG_INVALID_KEY unless args.is_a?(Hash) && args.fetch(:key_conditions, {}).any?
 
       hash = {
         table_name: @table,
@@ -63,7 +63,7 @@ module Uc3DmpDynamo
         return_consumed_capacity: debug ? 'TOTAL' : 'NONE'
       }
       # Look for and add any other filtering or projection args
-      %i[filter_expression, expression_attribute_values, projection_expression, scan_index_forward].each do |key|
+      %i[filter_expression expression_attribute_values projection_expression scan_index_forward].each do |key|
         next if args[key.to_sym].nil?
 
         hash[key.to_sym] = args[key.to_sym]
@@ -72,13 +72,13 @@ module Uc3DmpDynamo
       resp = @connection.query(hash)
       # If debug is enabled then write the response to the LogWriter
       if debug
-        msg = "query - args: #{args}"
-        puts "#{SOURCE} => query - args: #{args.inspect}"
+        puts "#{SOURCE} => query - args: #{hash.inspect}"
         puts resp.items.inspect
       end
-      resp.items
+      resp.items.any? ? resp.items.map(&:item) : []
     rescue Aws::Errors::ServiceError => e
-      raise Uc3DmpDynamoError, MSG_DYNAMO_ERROR % { msg: e.message, trace: e.backtrace }
+      raise ClientError, format(MSG_DYNAMO_ERROR, msg: e.message, trace: e.backtrace)
     end
+    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/uc3-dmp-dynamo/version.rb

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

data/lib/uc3-dmp-dynamo.rb

@@ -5,7 +5,7 @@ require 'aws-sdk-dynamodb'
 
 require 'uc3-dmp-dynamo/client'
 
+# DynamoDB Table helpers for DMPTool
 module Uc3DmpDynamo
-
 end
 # rubocop:enable Naming/FileName

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uc3-dmp-dynamo
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Brian Riley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-09 00:00:00.000000000 Z
+date: 2023-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json