uc3-dmp-event-bridge 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 05e37209c45c2d372a5ef9259d16ec0c4e20f9c2a968d0311e34433b260952dc
+  data.tar.gz: c1499396710532b8a70ae7ad45bf64a5e63c50106c30637a6d69c373196b0e5e
+SHA512:
+  metadata.gz: 5da1a4dfe6f43853d028f71111332eca6887bb43d0d7051deca8398cfc3e407648b4cc7c06bd2b1922380def8d78ef0a040f5bf2e1a1e8ee8b81414b1b133545
+  data.tar.gz: d675d6c4881c2188dd38b810af50e36c400362a585f6fdab4de2709cb9446527b8876e80815e3fac0094960df578174faf4a053cc9cf029f2dce4fd089afb46c

data/lib/uc3-dmp-event-bridge/publisher.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Uc3DmpEventBridge
+  class PublisherError < StandardError; end
+
+  # CLass to manage publication of messages on an EventBridge's EventBus
+  class Publisher
+    SOURCE = 'Uc3DmpEventBridge::Publisher'
+
+    DEFAULT_EVENT_TYPE = 'DMP change'
+
+    MSG_BUS_ERROR = 'EventBus Error - %{msg} - %{trace}'
+    MSG_INVALID_KEY = 'Invalid message specified. Expecting Hash containing at least a `PK` and `SK`'
+    MSG_MISSING_BUS = 'No EventBus defined! Looking for `ENV[\'EVENT_BUS_NAME\']`'
+    MSG_MISSING_DOMAIN = 'No domain name defined! Looking for `ENV[\'DOMAIN\']`'
+
+    attr_accessor :client, :bus, :domain
+
+    def initialize(**_args)
+      @bus = ENV.fetch('EVENT_BUS_NAME', nil)
+      @domain = ENV.fetch('DOMAIN', nil)
+      raise PublisherError, MSG_MISSING_BUS if @bus.nil?
+      raise PublisherError, MSG_MISSING_DOMAIN if @domain.nil?
+
+      @client = Aws::EventBridge::Client.new(region: ENV.fetch('AWS_REGION', 'us-west-2'))
+    end
+
+    # Publish an event to the EventBus so that other Lambdas can do their thing
+    # rubocop:disable Metrics/AbcSize
+    def publish(source:, dmp:, event_type: DEFAULT_EVENT_TYPE, debug: false)
+      source = "#{source} -> #{SOURCE}.publish"
+
+      message = {
+        entries: [{
+          time: Time.now,
+          source: "#{ENV.fetch('DOMAIN', nil)}:lambda:event_publisher",
+          detail_type: event_type.to_s,
+          detail: _generate_detail(dmp: dmp).to_json,
+          event_bus_name: ENV.fetch('EVENT_BUS_NAME', nil)
+        }]
+      }
+      puts "#{SOURCE}.publish - Publishing event -> details: #{message}") if debug
+      resp = client.put_events(message)
+      return true unless resp.failed_entry_count.nil? || resp.failed_entry_count.positive?
+
+      # The EventBridge returned errors, so log the error
+      raise PublisherError, _generate_failure(source: source, response: resp, payload: payload)
+    rescue Aws::Errors::ServiceError => e
+      puts "#{SOURCE} - #{MSG_BUS_ERROR % { msg: e.message, trace: e.backtrace }}"
+      raise PublisherError, MSG_BUS_ERROR % { msg: e.message }
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    private
+
+    # Only post the bits of the DMP that are required for the message to cut down on size
+    def _generate_detail(dmp:)
+      {
+        PK: dmp['PK'],
+        SK: dmp['SK'],
+        dmphub_provenance_id: dmp.fetch('dmphub_provenance_id', nil),
+        dmproadmap_links: dmp.fetch('dmproadmap_links', {}),
+        dmphub_updater_is_provenance: dmp.fetch('dmphub_updater_is_provenance', false)
+      }
+    end
+
+    # If the EventBus returns an error log everything
+    def _generate_failure(source:, response:, payload:)
+      {
+        source: source,
+        message: 'Failed to post message to EventBridge!',
+        details: {
+          event_bus_name: ENV.fetch('EVENT_BUS_NAME', nil),
+          event_id: response.data.entries[0].event_id,
+          error_code: response.data.entries[0].error_code,
+          error_message: response.data.entries[0].error_message,
+          detail: payload
+        }
+      }
+    end
+  end
+end

data/lib/uc3-dmp-event-bridge/version.rb

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

data/lib/uc3-dmp-event-bridge.rb

@@ -0,0 +1,11 @@
+# rubocop:disable Naming/FileName
+# frozen_string_literal: true
+
+require 'aws-sdk-eventbridge'
+
+require 'uc3-dmp-event-bridge/publisher'
+
+# DynamoDB Table helpers for DMPTool
+module Uc3DmpEventBridge
+end
+# rubocop:enable Naming/FileName

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: uc3-dmp-event-bridge
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brian Riley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-06-08 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-eventbridge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.44'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.44'
+- !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 Event Bridge messaging
+email:
+- brian.riley@ucop.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/uc3-dmp-event-bridge.rb
+- lib/uc3-dmp-event-bridge/publisher.rb
+- lib/uc3-dmp-event-bridge/version.rb
+homepage: https://github.com/CDLUC3/dmp-hub-cfn/blob/main/src/sam/gems/uc3-dmp-event-bridge
+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 Event Bridge
+test_files: []