uc3-dmp-s3 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 012b85ca0ad4be2d1cc1ee135f15198316202b5ff52f8192831838fd62f576a4
+  data.tar.gz: ca34a6e7221a1290f8a50224b60c5e2b33255b5a348460c5cb43d7fc52f596cd
+SHA512:
+  metadata.gz: ad81d5cc37ffccafdcebb9e8d7c695055e2b929ae401f807f207d9599b93101114dc5f514fb732ece2b4743556c8bf8ef726c3364d31598b7b8981852701302c
+  data.tar.gz: 35d294452bbd39c6f183cdd9f57d3698f12a799c085bd11d4a585b2aad4fb4fdf33e1cf1f42cf15abac4f163ca6548209532f52bd71759b5f4241f35fabad9c5

data/README.md

@@ -0,0 +1,3 @@
+# Uc3DmpS3 gem
+
+Helper class for accessing the DMPTool S3 bucket to manage PDF narratives and UI assets

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

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'aws-sdk-s3'
+require 'base64'
+require 'cgi'
+
+module Uc3DmpS3
+  # Error from the Rds Adapter
+  class ClientError < StandardError; end
+
+  # A module to interact with the RDS DB. Expects the following ENV variables to be set:
+  #     DATABASE_HOST:  The host URL
+  #     DATABASE_PORT:  The port to use
+  #     DATABASE_NAME:  The name of the database
+  #
+  # and the following should be passed into the :connect method:
+  #     RDS_USERNAME:   The RDS username
+  #     RDS_PASSWORD:   The RDS password
+  #
+  class Client
+    NARRATIVE_KEY_PREFIX = 'narratives/'
+
+    MSG_S3_FAILURE = 'Unable to save the PDF file at this time'
+
+    class << self
+      # Put the narrative file into the S3 bucket
+      # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+      def put_narrative(document:, dmp_id: nil, base64: false)
+        return nil if !document.is_a?(String) || document.strip.empty? || ENV['S3_BUCKET'].nil?
+
+        key = "#{NARRATIVE_KEY_PREFIX}#{SecureRandom.hex(8)}.pdf"
+        tg = dmp_id.nil? ? "PRE-DMP_ID=#{Time.now.strftime('%Y-%m-%d')}" : "DMP_ID=#{CGI.escape(dmp_id)}"
+        body = base64 ? Base64.decode64(document) : document
+
+        _put_object(key: key, tags: tg, payload: body)
+      rescue Aws::Errors::ServiceError => e
+        msg = "Unable to write PDF narrative to S3 bucket (dmp_id: #{dmp_id.nil? ? 'PRE-DMP_ID' : dmp_id})"
+        raise ClientError, "#{msg} - #{e.message}"
+      end
+      # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
+
+      # Fetch the narrative file from the S3 bucket
+      def get_narrative(key:)
+        return nil unless key.is_a?(String) && !key.strip.empty? && !ENV['S3_BUCKET'].nil?
+
+        _get_object(key: key.start_with?(NARRATIVE_KEY_PREFIX) ? key : "#{NARRATIVE_KEY_PREFIX}#{key}")
+      rescue Aws::Errors::ServiceError => e
+        raise ClientError, "Unable to fetch PDF narrative from S3 bucket (key: #{key}) - #{e.message}"
+      end
+
+      private
+
+      # Put the object into the S3 bucket
+      def _put_object(key:, payload:, tags: '')
+        return nil unless key.is_a?(String) && !key.strip.empty? && !payload.nil? && !ENV['S3_BUCKET'].nil?
+
+        client = Aws::S3::Client.new(region: ENV.fetch('AWS_REGION', nil))
+        bucket = ENV['S3_BUCKET'].gsub('arn:aws:s3:::', '')
+        resp = client.put_object({ body: payload, bucket: bucket, key: key, tagging: tags })
+        resp.successful? ? key : nil
+      end
+
+      # Fetch the object from the S3 bucket
+      # rubocop:disable Metrics/AbcSize
+      def _get_object(key:)
+        return nil unless key.is_a?(String) && !key.strip.empty? && !ENV['S3_BUCKET'].nil?
+
+        client = Aws::S3::Client.new(region: ENV.fetch('AWS_REGION', 'us-west-2'))
+        bucket = ENV['S3_BUCKET'].gsub('arn:aws:s3:::', '')
+        resp = client.get_object({ bucket: bucket, key: key })
+        return nil if resp.nil? || !resp.content_length.positive?
+
+        resp.body.is_a?(String) ? resp.body : resp.body.read
+      end
+      # rubocop:enable Metrics/AbcSize
+    end
+  end
+end

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

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

data/lib/uc3-dmp-s3.rb

@@ -0,0 +1,9 @@
+# rubocop:disable Naming/FileName
+# frozen_string_literal: true
+
+require 'uc3-dmp-s3/client'
+
+# RDS Database adapter
+module Uc3DmpS3
+end
+# rubocop:enable Naming/FileName

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: uc3-dmp-s3
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brian Riley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.119'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.119'
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: cgi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !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-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.17.1
+- !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 read/write to S3
+email:
+- brian.riley@ucop.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/uc3-dmp-s3.rb
+- lib/uc3-dmp-s3/client.rb
+- lib/uc3-dmp-s3/version.rb
+homepage: https://github.com/CDLUC3/dmp-hub-cfn/blob/main/src/sam/gems/uc3-dmp-s3
+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 general support for accessing the DMPTool S3 Bucket
+test_files: []