journaled 3.1.0 → 4.2.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: journaled
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Jake Lipson
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-02 00:00:00.000000000 Z
+date: 2022-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -84,13 +84,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.2'
 - !ruby/object:Gem::Dependency
-  name: request_store
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -98,21 +98,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: appraisal
+  name: betterlint
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -126,7 +126,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -140,21 +140,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-betterment
+  name: spring
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: spring
+  name: spring-commands-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -168,7 +168,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: spring-commands-rspec
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -182,7 +182,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -196,7 +196,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: uncruft
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -245,7 +245,6 @@ files:
 - app/models/journaled/change.rb
 - app/models/journaled/change_definition.rb
 - app/models/journaled/change_writer.rb
-- app/models/journaled/delivery.rb
 - app/models/journaled/event.rb
 - app/models/journaled/json_schema_model/validator.rb
 - app/models/journaled/not_truly_exceptional_error.rb
@@ -254,7 +253,9 @@ files:
 - config/spring.rb
 - journaled_schemas/base_event.json
 - journaled_schemas/journaled/change.json
+- journaled_schemas/tagged_event.json
 - lib/journaled.rb
+- lib/journaled/current.rb
 - lib/journaled/engine.rb
 - lib/journaled/relation_change_protection.rb
 - lib/journaled/rspec.rb
@@ -293,7 +294,6 @@ files:
 - spec/models/database_change_protection_spec.rb
 - spec/models/journaled/actor_uri_provider_spec.rb
 - spec/models/journaled/change_writer_spec.rb
-- spec/models/journaled/delivery_spec.rb
 - spec/models/journaled/event_spec.rb
 - spec/models/journaled/json_schema_model/validator_spec.rb
 - spec/models/journaled/writer_spec.rb
@@ -303,7 +303,8 @@ files:
 homepage: http://github.com/Betterment/journaled
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -312,14 +313,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: Journaling for Betterment apps.
@@ -354,7 +355,6 @@ test_files:
 - spec/dummy/README.rdoc
 - spec/models/journaled/json_schema_model/validator_spec.rb
 - spec/models/journaled/actor_uri_provider_spec.rb
-- spec/models/journaled/delivery_spec.rb
 - spec/models/journaled/event_spec.rb
 - spec/models/journaled/change_writer_spec.rb
 - spec/models/journaled/writer_spec.rb

data/app/models/journaled/delivery.rb

@@ -1,88 +0,0 @@
-class Journaled::Delivery # rubocop:disable Betterment/ActiveJobPerformable
-  DEFAULT_REGION = 'us-east-1'.freeze
-
-  def initialize(serialized_event:, partition_key:, app_name:)
-    @serialized_event = serialized_event
-    @partition_key = partition_key
-    @app_name = app_name
-  end
-
-  def perform
-    kinesis_client.put_record record if Journaled.enabled?
-  rescue Aws::Kinesis::Errors::InternalFailure, Aws::Kinesis::Errors::ServiceUnavailable, Aws::Kinesis::Errors::Http503Error => e
-    Rails.logger.error "Kinesis Error - Server Error occurred - #{e.class}"
-    raise KinesisTemporaryFailure
-  rescue Seahorse::Client::NetworkingError => e
-    Rails.logger.error "Kinesis Error - Networking Error occurred - #{e.class}"
-    raise KinesisTemporaryFailure
-  end
-
-  def stream_name
-    env_var_name = [app_name&.upcase, 'JOURNALED_STREAM_NAME'].compact.join('_')
-    ENV.fetch(env_var_name)
-  end
-
-  def kinesis_client_config
-    {
-      region: ENV.fetch('AWS_DEFAULT_REGION', DEFAULT_REGION),
-      retry_limit: 0,
-      http_idle_timeout: Journaled.http_idle_timeout,
-      http_open_timeout: Journaled.http_open_timeout,
-      http_read_timeout: Journaled.http_read_timeout,
-    }.merge(credentials)
-  end
-
-  private
-
-  attr_reader :serialized_event, :partition_key, :app_name
-
-  def record
-    {
-      stream_name: stream_name,
-      data: serialized_event,
-      partition_key: partition_key,
-    }
-  end
-
-  def kinesis_client
-    Aws::Kinesis::Client.new(kinesis_client_config)
-  end
-
-  def credentials
-    if ENV.key?('JOURNALED_IAM_ROLE_ARN')
-      {
-        credentials: iam_assume_role_credentials,
-      }
-    else
-      legacy_credentials_hash_if_present
-    end
-  end
-
-  def legacy_credentials_hash_if_present
-    if ENV.key?('RUBY_AWS_ACCESS_KEY_ID')
-      {
-        access_key_id: ENV.fetch('RUBY_AWS_ACCESS_KEY_ID'),
-        secret_access_key: ENV.fetch('RUBY_AWS_SECRET_ACCESS_KEY'),
-      }
-    else
-      {}
-    end
-  end
-
-  def sts_client
-    Aws::STS::Client.new({
-      region: ENV.fetch('AWS_DEFAULT_REGION', DEFAULT_REGION),
-    }.merge(legacy_credentials_hash_if_present))
-  end
-
-  def iam_assume_role_credentials
-    @iam_assume_role_credentials ||= Aws::AssumeRoleCredentials.new(
-      client: sts_client,
-      role_arn: ENV.fetch('JOURNALED_IAM_ROLE_ARN'),
-      role_session_name: "JournaledAssumeRoleAccess",
-    )
-  end
-
-  class KinesisTemporaryFailure < ::Journaled::NotTrulyExceptionalError
-  end
-end

data/spec/models/journaled/delivery_spec.rb

@@ -1,222 +0,0 @@
-require 'rails_helper'
-
-RSpec.describe Journaled::Delivery do
-  let(:stream_name) { 'test_events' }
-  let(:partition_key) { 'fake_partition_key' }
-  let(:serialized_event) { '{"foo":"bar"}' }
-  let(:kinesis_client) { Aws::Kinesis::Client.new(stub_responses: true) }
-
-  around do |example|
-    with_env(JOURNALED_STREAM_NAME: stream_name) { example.run }
-  end
-
-  subject { described_class.new serialized_event: serialized_event, partition_key: partition_key, app_name: nil }
-
-  describe '#perform' do
-    let(:return_status_body) { { shard_id: '101', sequence_number: '101123' } }
-    let(:return_object) { instance_double Aws::Kinesis::Types::PutRecordOutput, return_status_body }
-
-    before do
-      allow(Aws::AssumeRoleCredentials).to receive(:new).and_call_original
-      allow(Aws::Kinesis::Client).to receive(:new).and_return kinesis_client
-      kinesis_client.stub_responses(:put_record, return_status_body)
-
-      allow(Journaled).to receive(:enabled?).and_return(true)
-    end
-
-    it 'makes requests to AWS to put the event on the Kinesis with the correct body' do
-      event = subject.perform
-
-      expect(event.shard_id).to eq '101'
-      expect(event.sequence_number).to eq '101123'
-    end
-
-    context 'when JOURNALED_IAM_ROLE_ARN is defined' do
-      let(:aws_sts_client) { Aws::STS::Client.new(stub_responses: true) }
-
-      around do |example|
-        with_env(JOURNALED_IAM_ROLE_ARN: 'iam-role-arn-for-assuming-kinesis-access') { example.run }
-      end
-
-      before do
-        allow(Aws::STS::Client).to receive(:new).and_return aws_sts_client
-        aws_sts_client.stub_responses(:assume_role, assume_role_response)
-      end
-
-      let(:assume_role_response) do
-        {
-          assumed_role_user: {
-            arn: 'iam-role-arn-for-assuming-kinesis-access',
-            assumed_role_id: "ARO123EXAMPLE123:Bob",
-          },
-          credentials: {
-            access_key_id: "AKIAIOSFODNN7EXAMPLE",
-            secret_access_key: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY",
-            session_token: "EXAMPLEtc764bNrC9SAPBSM22wDOk4x4HIZ8j4FZTwdQWLWsKWHGBuFqwAeMicRXmxfpSPfIeoIYRqTflfKD8YUuwthAx7mSEI",
-            expiration: Time.zone.parse("2011-07-15T23:28:33.359Z"),
-          },
-        }
-      end
-
-      it 'initializes a Kinesis client with assume role credentials' do
-        subject.perform
-
-        expect(Aws::AssumeRoleCredentials).to have_received(:new).with(
-          client: aws_sts_client,
-          role_arn: "iam-role-arn-for-assuming-kinesis-access",
-          role_session_name: "JournaledAssumeRoleAccess",
-        )
-      end
-    end
-
-    context 'when the stream name env var is NOT set' do
-      let(:stream_name) { nil }
-
-      it 'raises an KeyError error' do
-        expect { subject.perform }.to raise_error KeyError
-      end
-    end
-
-    context 'when Amazon responds with an InternalFailure' do
-      before do
-        kinesis_client.stub_responses(:put_record, 'InternalFailure')
-      end
-
-      it 'catches the error and re-raises a subclass of NotTrulyExceptionalError and logs about the failure' do
-        expect(Rails.logger).to receive(:error).with("Kinesis Error - Server Error occurred - Aws::Kinesis::Errors::InternalFailure").once
-        expect { subject.perform }.to raise_error described_class::KinesisTemporaryFailure
-      end
-    end
-
-    context 'when Amazon responds with a ServiceUnavailable' do
-      before do
-        kinesis_client.stub_responses(:put_record, 'ServiceUnavailable')
-      end
-
-      it 'catches the error and re-raises a subclass of NotTrulyExceptionalError and logs about the failure' do
-        allow(Rails.logger).to receive(:error)
-        expect { subject.perform }.to raise_error described_class::KinesisTemporaryFailure
-        expect(Rails.logger).to have_received(:error).with(/\AKinesis Error/).once
-      end
-    end
-
-    context 'when we receive a 504 Gateway timeout' do
-      before do
-        kinesis_client.stub_responses(:put_record, 'Aws::Kinesis::Errors::ServiceError')
-      end
-
-      it 'raises an error that subclasses Aws::Kinesis::Errors::ServiceError' do
-        expect { subject.perform }.to raise_error Aws::Kinesis::Errors::ServiceError
-      end
-    end
-
-    context 'when the IAM user does not have permission to put_record to the specified stream' do
-      before do
-        kinesis_client.stub_responses(:put_record, 'AccessDeniedException')
-      end
-
-      it 'raises an AccessDeniedException error' do
-        expect { subject.perform }.to raise_error Aws::Kinesis::Errors::AccessDeniedException
-      end
-    end
-
-    context 'when the request timesout' do
-      before do
-        kinesis_client.stub_responses(:put_record, Seahorse::Client::NetworkingError.new(Timeout::Error.new))
-      end
-
-      it 'catches the error and re-raises a subclass of NotTrulyExceptionalError and logs about the failure' do
-        expect(Rails.logger).to receive(:error).with(
-          "Kinesis Error - Networking Error occurred - Seahorse::Client::NetworkingError",
-        ).once
-        expect { subject.perform }.to raise_error described_class::KinesisTemporaryFailure
-      end
-    end
-  end
-
-  describe "#stream_name" do
-    context "when app_name is unspecified" do
-      subject { described_class.new serialized_event: serialized_event, partition_key: partition_key, app_name: nil }
-
-      it "is fetched from a prefixed ENV var if specified" do
-        allow(ENV).to receive(:fetch).and_return("expected_stream_name")
-        expect(subject.stream_name).to eq("expected_stream_name")
-        expect(ENV).to have_received(:fetch).with("JOURNALED_STREAM_NAME")
-      end
-    end
-
-    context "when app_name is specified" do
-      subject { described_class.new serialized_event: serialized_event, partition_key: partition_key, app_name: "my_funky_app_name" }
-
-      it "is fetched from a prefixed ENV var if specified" do
-        allow(ENV).to receive(:fetch).and_return("expected_stream_name")
-        expect(subject.stream_name).to eq("expected_stream_name")
-        expect(ENV).to have_received(:fetch).with("MY_FUNKY_APP_NAME_JOURNALED_STREAM_NAME")
-      end
-    end
-  end
-
-  describe "#kinesis_client_config" do
-    it "is in us-east-1 by default" do
-      with_env(AWS_DEFAULT_REGION: nil) do
-        expect(subject.kinesis_client_config).to include(region: 'us-east-1')
-      end
-    end
-
-    it "respects AWS_DEFAULT_REGION env var" do
-      with_env(AWS_DEFAULT_REGION: 'us-west-2') do
-        expect(subject.kinesis_client_config).to include(region: 'us-west-2')
-      end
-    end
-
-    it "doesn't limit retry" do
-      expect(subject.kinesis_client_config).to include(retry_limit: 0)
-    end
-
-    it "provides no AWS credentials by default" do
-      with_env(RUBY_AWS_ACCESS_KEY_ID: nil, RUBY_AWS_SECRET_ACCESS_KEY: nil) do
-        expect(subject.kinesis_client_config).not_to have_key(:access_key_id)
-        expect(subject.kinesis_client_config).not_to have_key(:secret_access_key)
-      end
-    end
-
-    it "will use legacy credentials if specified" do
-      with_env(RUBY_AWS_ACCESS_KEY_ID: 'key_id', RUBY_AWS_SECRET_ACCESS_KEY: 'secret') do
-        expect(subject.kinesis_client_config).to include(access_key_id: 'key_id', secret_access_key: 'secret')
-      end
-    end
-
-    it "will set http_idle_timeout by default" do
-      expect(subject.kinesis_client_config).to include(http_idle_timeout: 5)
-    end
-
-    it "will set http_open_timeout by default" do
-      expect(subject.kinesis_client_config).to include(http_open_timeout: 2)
-    end
-
-    it "will set http_read_timeout by default" do
-      expect(subject.kinesis_client_config).to include(http_read_timeout: 60)
-    end
-
-    context "when Journaled.http_idle_timeout is specified" do
-      it "will set http_idle_timeout by specified value" do
-        allow(Journaled).to receive(:http_idle_timeout).and_return(2)
-        expect(subject.kinesis_client_config).to include(http_idle_timeout: 2)
-      end
-    end
-
-    context "when Journaled.http_open_timeout is specified" do
-      it "will set http_open_timeout by specified value" do
-        allow(Journaled).to receive(:http_open_timeout).and_return(1)
-        expect(subject.kinesis_client_config).to include(http_open_timeout: 1)
-      end
-    end
-
-    context "when Journaled.http_read_timeout is specified" do
-      it "will set http_read_timeout by specified value" do
-        allow(Journaled).to receive(:http_read_timeout).and_return(2)
-        expect(subject.kinesis_client_config).to include(http_read_timeout: 2)
-      end
-    end
-  end
-end