uc3-dmp-dynamo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 58ed099abf0a13ea6a5e296d5b9cb1705e91323ecf0c11175aaa26548e601df4
+  data.tar.gz: e071931916566776591f79c380750834fc2474a2233ae15ddfb76dbd06dc594d
+SHA512:
+  metadata.gz: c74365c564c6762dc2429583611cfb69daec13fa6c3df7e1d624a1c8630df8e5440c31cac301a65f4182f9fdc168c165bf132ecff60f4381bbc906eb5d79aeb8
+  data.tar.gz: aa410b9a0fb4f84df58a4c6e5c8ef495359e290bbfeb5a50a45da8aa9544764d023d21d06282e7c350f729e3b7bca2a10a7cf05cc7f8e494113b5fd1d73c8a8c

data/README.md

@@ -0,0 +1,3 @@
+# Uc3DmpDynamo
+
+Helper methods for accessing the Dynamo DB

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

@@ -0,0 +1,83 @@
+# 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
+
+  # Helper functions for working with Dynamo JSON
+  class Client
+    SOURCE = 'Uc3DmpDynamo::Client'
+
+    MSG_INVALID_KEY = 'Invalid key specified. Expecting Hash containing `PK` and `SK`'
+    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, :log_writer
+
+    def initialize(**args)
+      @table = ENV['DYNAMO_TABLE']
+      raise Uc3DmpDynamoError, MSG_MISSING_TABLE if @table.nil?
+
+      @log_writer = args[:log_writer]
+      @connection = args.fetch(:client, Aws::DynamoDB::Client.new(region: ENV.fetch('AWS_REGION', 'us-west-2')))
+    end
+
+    # Fetch a single item
+    def get_item(key:, debug: false)
+      raise Uc3DmpDynamoError, MSG_INVALID_KEY unless key.is_a?(Hash)
+
+      resp = @client.get_item(
+        { table_name: @table,
+          key: key,
+          consistent_read: false,
+          return_consumed_capacity: debug ? 'TOTAL' : 'NONE'
+        }
+      )
+      # If debug is enabled then write the response to the LogWriter
+      if debug && @log_writer
+        @log_writer.log_message(source: SOURCE, message: "get_item - #{key}", details: resp[:item].first)
+      end
+      resp[:item].first
+    rescue Aws::Errors::ServiceError => e
+      raise Uc3DmpDynamoError, MSG_DYNAMO_ERROR % { msg: e.message, trace: e.backtrace }
+    end
+
+    # Perform a table scan if a filter was specified.
+    # For example:
+    #    key_conditions: { PK: { attribute_value_list: ['DMP#12345'] }, comparison_operator: 'EQ' }
+    #    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?
+
+      hash = {
+        table_name: @table,
+        key_conditions: args[:key_conditions],
+        consistent_read: false,
+        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|
+        next if args[key.to_sym].nil?
+
+        hash[key.to_sym] = args[key.to_sym]
+      end
+
+      resp = @client.query(hash)
+      # If debug is enabled then write the response to the LogWriter
+      if debug && @log_writer
+        msg = "query - key_conditions: #{key_conditions}, projection_expression: #{projection_expression}"
+        @log_writer.log_message(source: SOURCE, message: msg, details: resp.items)
+      end
+      resp.items
+    rescue Aws::Errors::ServiceError => e
+      raise Uc3DmpDynamoError, MSG_DYNAMO_ERROR % { msg: e.message, trace: e.backtrace }
+    end
+  end
+end

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

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

data/lib/uc3-dmp-dynamo.rb

@@ -0,0 +1,11 @@
+# rubocop:disable Naming/FileName
+# frozen_string_literal: true
+
+require 'aws-sdk-dynamodb'
+
+require 'uc3-dmp-dynamo/client'
+
+module Uc3DmpDynamo
+
+end
+# rubocop:enable Naming/FileName

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: uc3-dmp-dynamo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brian Riley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-dynamodb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.83'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.83'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.50.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        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 Dynamo DB Table access
+email:
+- brian.riley@ucop.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/uc3-dmp-dynamo.rb
+- lib/uc3-dmp-dynamo/client.rb
+- lib/uc3-dmp-dynamo/version.rb
+homepage: https://github.com/CDLUC3/dmp-hub-cfn/blob/main/src/sam/gems/uc3-dmp-dynamo
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'false'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: DMPTool gem that provides support for Dynamo DB
+test_files: []