strongmind-platform-sdk 3.19.8 → 3.19.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a96d5aa7945fd70fc71dc5bca7a00756038727655e4e007a9bfad83a7251b54b
-  data.tar.gz: de985f9fa3bb6e62c1f2be87b4a9b265d267b03d8635e4010b37725cd9920dbc
+  metadata.gz: 3b4e9c7bfc3e7b93b4aabdfa138eaaa574725e36d087df67e15e239a4de595f4
+  data.tar.gz: 30acfbe7eb2487768dabe23ff6920b3b95f600e52039cde1f6ab5587cbdccc4e
 SHA512:
-  metadata.gz: '07877c3c9e11727ca2ae0712cb7ba783d7ceafe713e2ab916bc7b6c1dd25a8d3b8ba2a047c2007707454e9bacdb3a4df984df6221ee5d3459d132ee5bd25ff73'
-  data.tar.gz: 1aeefbe7d613d46efc392043ea769567a1da826e7f9aa3abe6dfb5e6d318e10cfe990be636bc87b259dc20737ad4399b5c2fc0bcbc0629b4fee6c2d93ecb826f
+  metadata.gz: 7539aa22ff674560101e36c8b668bd43a9d601ddec913865595cd9a8e81d19703b1482b2afd73dd1e44b25183ef1c80fd39701416e8460fd605817fc3676bb36
+  data.tar.gz: 1ca026d1104f79143f564c60c9b81473e2794b8501cb161e9df85c17e762ce8c5d5d339757deaecff9e4df623b3e228e2635da9f62779cbb27b7997c10487f0f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    strongmind-platform-sdk (3.19.8)
+    strongmind-platform-sdk (3.19.9)
       activesupport (~> 7.1)
       aws-sdk-secretsmanager (~> 1.66)
       faraday (~> 2.5, >= 2.5.2)

data/README.md

@@ -153,6 +153,25 @@ class MyModel < ApplicationRecord
 end
 ```
 
+You can override the following methods in the model to customize the noun data:
+
+```ruby
+class MyModel < ApplicationRecord
+  include PlatformSdk::ActiveRecord::DataPipelineable
+
+  def pipeline_excluded_attributes
+    [:column1, :column2]
+  end
+
+  def pipeline_additional_attributes
+    {
+      "foo": "important data",
+      "bar": "more important data"
+    }
+  end
+end
+```
+
 ### Configuration
 You will need the following ENV variables set in your application to send data to the Data Pipeline (found in bitwarden):
 * DATA_PIPELINE_HOST

data/lib/platform_sdk/active_record/data_pipelineable.rb

@@ -31,6 +31,10 @@ module PlatformSdk
         raise NotImplementedError, 'You must implement the pipeline_meta class method, an example value is { "source": "strongmind-central" }'
       end
 
+      def pipeline_excluded_attributes
+        []
+      end
+
       def pipeline_identifiers
         {
           "id": id
@@ -42,7 +46,7 @@ module PlatformSdk
 
         data_hash.merge!(pipeline_additional_attributes)
 
-        data_hash
+        data_hash.except(*pipeline_excluded_attributes)
       end
 
       def pipeline_additional_attributes

data/lib/platform_sdk/spec_support/shared_examples/data_pipelineable_examples.rb

@@ -1,21 +1,24 @@
 module PlatformSdk
   module SpecSupport
-    RSpec.shared_examples "DataPipelineable" do | data = nil|
+    RSpec.shared_examples "DataPipelineable" do
+      let(:data) do
+        { action: }
+          .merge(record.attributes.symbolize_keys)
+          .merge(record.pipeline_additional_attributes)
+          .except(*record.pipeline_excluded_attributes)
+      end
+
       let(:pipeline_payload) do
         {
           "noun": described_class.pipeline_noun,
           "identifiers": { "id": record.id },
           "meta": described_class.pipeline_meta,
-          "data": data || default_data,
+          "data": data,
           "envelope_version": '1.0.0',
           "message_timestamp": Time.current.utc.iso8601
         }
       end
-      let(:default_data) do
-        {
-          action:
-        }.merge!(record.attributes.symbolize_keys)
-      end
+
       let(:record) { build(described_class.to_s.underscore.to_sym) }
       let(:data_pipeline_client) { double(PlatformSdk::DataPipeline::Client)}
 

data/lib/platform_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PlatformSdk
-  VERSION = "3.19.8"
+  VERSION = "3.19.9"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: strongmind-platform-sdk
 version: !ruby/object:Gem::Version
-  version: 3.19.8
+  version: 3.19.9
 platform: ruby
 authors:
 - Platform Team