uc3-dmp-rds 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8d491135d6067f7ef206b6674634897e80e305fbf8d886a3f4b1b3d32762813b
+  data.tar.gz: 965e807f2ecabebbcaca3a5e251bf8844e17be5dad1731dc5c6d3d4d8cfc4bd2
+SHA512:
+  metadata.gz: 8bf401ad2b04e0865f304ee1bdc1d0a50bfc179dea37892bbc8207ce641e930d6e228dd38c5b472294cc31ab26f6b20a1c49735bed9611dcc76549f22ba1d712
+  data.tar.gz: f2bc501cc49ad107c7b61ddfcd9564ca95cded57e2b578c79945026eb76a8975606c3cad77fa35fddb6f6a82e1a03f63edb51157eb4fe43d2e4f20dcafd1dcdf

data/README.md

@@ -0,0 +1,7 @@
+# Uc3DmpRds gem
+
+Helper class for accessing the DMPTool database
+
+This gem uses the uc3-dmp-api-core gem to access the AWS to fetch your DB credentials
+
+It also uses mysql2 which means that when using this gem with a Lambda function, that function will need to reside within a Docker container that has installed mysql developer tools!

data/lib/uc3-dmp-rds/adapter.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'active_record'
+require 'active_record_simple_execute'
+require 'aws-sdk-sns'
+require 'aws-sdk-ssm'
+require 'mysql2'
+
+require 'uc3-dmp-api-core'
+
+module Uc3DmpRds
+  # 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 from the AWS SSM parameter store:
+  #     RDS_USERNAME:   The RDS username
+  #     RDS_PASSWORD:   The RDS password
+  #
+  class Adapter
+    MSG_NO_CONNECTION = 'No current database connection. Call Uc3DmpRds.connect first.'
+    MSG_KEYWORDS_INVALID = 'The parameters specified do not match those in the SQL query.'
+
+    class << self
+      # Connect to the RDS instance
+      def connect
+        creds = _credentials
+        ActiveRecord::Base.establish_connection(
+          adapter: 'mysql2',
+          host: ENV.fetch('DATABASE_HOST', nil),
+          port: ENV.fetch('DATABASE_PORT', nil),
+          database: ENV.fetch('DATABASE_NAME', nil),
+          username: creds[:username],
+          password: creds[:password],
+          encoding: 'utf8mb4'
+        )
+        ActiveRecord::Base.connected?
+      end
+
+      # Execute the specified query using ActiveRecord's helpers to sanitize the input
+      def execute_query(sql:, **params)
+        raise StandardError, MSG_NO_CONNECTION unless ActiveRecord::Base.connected?
+        return [] unless sql.is_a?(String) && !sql.strip.empty? && (params.nil? || params.is_a?(Hash))
+        # Verify that all of the kewords are accounted for and that values were supplied
+        raise StandardError, MSG_KEYWORDS_INVALID unless _verify_params(sql: sql, params: params)
+
+        ActiveRecord::Base.simple_execute(sql, params)
+      end
+
+      private
+
+      # Fetch the DB credentials from SSM parameter store
+      def _credentials
+        {
+          username: Uc3DmpApiCore::SsmReader.get_ssm_value(key: :rds_username),
+          password: Uc3DmpApiCore::SsmReader.get_ssm_value(key: :rds_password)
+        }
+      end
+
+      # Verify that all params defined in the SQL exist in the params hash and vice versa
+      # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      def _verify_params(sql:, params:)
+        # If the :sql doesn't have any parms and there are no :params then return true
+        return true if !sql.to_s.include?(':') && !params.is_a?(Hash)
+        # If the :sql has params but there are no :params return false
+        return false if sql.to_s.include?(':') && !params.is_a?(Hash)
+        # If the :sql has no params but there are :params return false
+        return false if params.is_a?(Hash) && !sql.include?(':')
+
+        resolvable = true
+        keywords = sql.scan(/:[a-zA-Z_]+/)
+
+        params&.keys&.each { |key| resolvable = false unless sql.include?(":#{key}") }
+        keywords.each { |key| resolvable = false unless params.keys.map(&:to_s).include?(key.sub(':', '')) }
+        resolvable
+      end
+      # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    end
+  end
+end

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

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

data/lib/uc3-dmp-rds.rb

@@ -0,0 +1,14 @@
+# rubocop:disable Naming/FileName
+# frozen_string_literal: true
+
+require 'aws-sdk-sns'
+require 'aws-sdk-ssm'
+
+require 'uc3-dmp-api-core'
+
+require 'uc3-dmp-rds/adapter'
+
+# RDS Database adapter
+module Uc3DmpRds
+end
+# rubocop:enable Naming/FileName

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: uc3-dmp-rds
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brian Riley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_record_simple_execute
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-sns
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.60'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.60'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-ssm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.150'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.150'
+- !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: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.5
+- !ruby/object:Gem::Dependency
+  name: uc3-dmp-api-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+- !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 MySQL connections and querying
+email:
+- brian.riley@ucop.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/uc3-dmp-rds.rb
+- lib/uc3-dmp-rds/adapter.rb
+- lib/uc3-dmp-rds/version.rb
+homepage: https://github.com/CDLUC3/dmp-hub-cfn/blob/main/src/sam/gems/uc3-dmp-rds
+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 MySQL DB hosted on
+  AWS RDS
+test_files: []