db_blaster 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e7b7ce6209a45251fe19c47d6248e932e042bca2ef60e4507b7365dd517555b
-  data.tar.gz: 774d0e7784134bfc8b14759cb7eb832851245d24a1afbcb7f1bd300be49f6537
+  metadata.gz: 9313d3abe0bd4dcaa756dab6b07b1d65eb6438b435c914d18f9d38964f08a29d
+  data.tar.gz: c694940facb41fb3656d011baba720ffb5f66cf124472f945d7de45661ba90b5
 SHA512:
-  metadata.gz: 2ab4c82a9debbaeb34f40353d5e0fae79077920bd4509469ea3a4bf51788f504a813c20b57aced15c68025ae34de6dd3fb97e112d2240613adb33fddcd64f429
-  data.tar.gz: 600d83c0a603c961b68a5751dbfd5685c4aefd916484905abb00e4997977fed4f63c7f79adb18291a6b64d9dab3c89d48a89aa3b19b47218b5b5ab20fec3c8b0
+  metadata.gz: c045adce6f5a4fb70be59194f6f4630879761011be805dbed09c9be225a415a807ffe60a2b33ccf5361e49ce595b87250f8b0e67f370c29d867254928a36e41f
+  data.tar.gz: 4b509898ced3205b588248700a75a375ddc6c614611298f0af347ef1a45b35f4c3d1adc9ae0a70d357c56050f47a7225d454564c22a350a21cec45da0effe322

data/app/jobs/db_blaster/publish_all_job.rb

@@ -18,7 +18,7 @@ module DbBlaster
     end
 
     def batch_start_time
-      @batch_start_time ||= DateTime.now.utc.strftime('%Y-%m-%dT%H:%M:%S.%LZ')
+      @batch_start_time ||= DateTime.now.utc.strftime(DbBlaster::Configuration::DEFAULT_DATETIME_FORMAT)
     end
   end
 end

data/lib/db_blaster/configuration.rb

@@ -6,7 +6,8 @@ module DbBlaster
   class Configuration
     DEFAULT_BATCH_SIZE = 100
     DEFAULT_MAX_MESSAGE_SIZE_IN_KILOBYTES = 256 # max size allowed by AWS SNS
-    DEFAULT_S3_KEY = '<batch_timestamp>/db_blaster/<table_name>/<uuid>.json'
+    DEFAULT_S3_KEY = '<batch_date>/<batch_time>/db_blaster/<table_name>/<uuid>.json'
+    DEFAULT_DATETIME_FORMAT = '%Y-%m-%dT%H:%M:%S.%LZ'
 
     # The required configuration fields
     REQUIRED_FIELDS = %i[aws_access_key aws_access_secret aws_region].freeze
@@ -30,7 +31,7 @@ module DbBlaster
     # Optional
     # Applicable only when `s3_bucket' is set
     # The value set here will be included in every payload pushed to S3
-    # example: config.s3_meta = {'infra_id' => '061', 'src_app' => 'kcp-api'}}
+    # example: config.s3_meta = {'infra_id' => '061', 'source_app' => 'kcp-api'}}
     # The resulting JSON:
     # {"meta" : {"infra_id" : "061", "src_app" : "kcp-api", "src_table" : "the-table"}, "records" : [] }
     attr_accessor :s3_meta
@@ -45,6 +46,12 @@ module DbBlaster
     # '<batch_timestamp>/kcp-api/001/<table_name>/<uuid>.json'
     attr_accessor :s3_key
 
+    # Optional
+    # Applicable only when `s3_bucket` is set
+    # S3 Tags
+    # example: config.s3_tags = { infra_id: '001', source_app: 'kcp-api', source_table: 'meetings' }
+    attr_accessor :s3_tags
+
     # Global list of column names not to include in published SNS messages
     # example: config.ignored_column_names = ['email', 'phone_number']
     attr_accessor :ignored_column_names

data/lib/db_blaster/s3_key_builder.rb

@@ -23,7 +23,10 @@ module DbBlaster
     end
 
     def substitutions
-      { '<batch_timestamp>' => batch_start_time,
+      date, time = batch_start_time.split('T')
+      { '<batch_date_time>' => batch_start_time,
+        '<batch_date>' => date,
+        '<batch_time>' => time,
         '<uuid>' => SecureRandom.uuid,
         '<table_name>' => source_table_name }
     end

data/lib/db_blaster/s3_publisher.rb

@@ -9,6 +9,7 @@ module DbBlaster
       client.put_object(bucket: DbBlaster.configuration.s3_bucket,
                         key: S3KeyBuilder.build(source_table_name: source_table.name,
                                                 batch_start_time: batch_start_time),
+                        tagging: tagging,
                         body: content.to_json)
     end
 
@@ -17,8 +18,17 @@ module DbBlaster
         records: records }
     end
 
+    def tagging
+      URI.encode_www_form(tags_hash)
+    end
+
+    def tags_hash
+      @tags_hash ||= { source_table: source_table.name }
+                     .merge(DbBlaster.configuration.s3_tags.presence || {})
+    end
+
     def meta
-      (DbBlaster.configuration.s3_meta || {}).merge(source_table: source_table.name)
+      (DbBlaster.configuration.s3_meta.presence || {}).merge(source_table: source_table.name)
     end
 
     def client

data/lib/db_blaster/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DbBlaster
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

data/lib/generators/db_blaster/install/templates/db_blaster_config.rb

@@ -20,7 +20,9 @@ DbBlaster.configure do |config|
   # Optional
   # Applicable only when `s3_bucket` is set
   # The S3 key path. The following values will get substituted:
-  # <batch_timestamp> - a timestamp signifying the beginning of the batch processing
+  # <batch_date_time> - a timestamp signifying the beginning of the batch processing
+  # <batch_date> - a date signifying the beginning of the batch processing
+  # <batch_time> - a time signifying the beginning of the batch processing
   # <timestamp> - the current time
   # <table_name> - the name of the table associated with the S3 body
   # <uuid> - a universal identifier
@@ -31,7 +33,7 @@ DbBlaster.configure do |config|
   # Extra meta values sent along with each payload
   # example: config.s3_meta = {'infra_id' => '061'}
   # The resulting JSON:
-  # {"meta" : {"infra_id" : "061", "src_app" : "kcp-api", "src_table" : "the-table"}, "records" : [] }
+  # {"meta" : {"infra_id" : "061", "source_app" : "kcp-api", "src_table" : "the-table"}, "records" : [] }
   # config.s3_meta = {'infra_id' => '061'}
 
   # Optional

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: db_blaster
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Perry Hertler
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-01 00:00:00.000000000 Z
+date: 2021-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3