deimos-ruby 1.2.0.pre.beta1 → 1.3.0.pre.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d27374b4f6388c2eae44b4b9654b10461c8fd7d044f5a67a63d7b1866b8658f
-  data.tar.gz: 1b058d23b6e5bbab471b57f74d0f85c3cd3c78131c9b43a32494f1b95b3c9110
+  metadata.gz: e6496a3f7011b2d9cf92bc2841bd0cdaeea6173eb8a2fb4f388c640ecc619f0d
+  data.tar.gz: d98cd1b64bcc56397b4be95a54018beb57d294803ef3d2dec4f0ce649471f217
 SHA512:
-  metadata.gz: fb7e58230650beaec9d777a8ee8e33a9210b08ef05d59f64e6e3a9c5f8cfb095af72f15a443063998d3c6fd579263f1b25d0409b371200fbe9d95bee43ab0300
-  data.tar.gz: a6198b80dd040db5f2b633fc5e8c83da727f6d9e0d9915684df00f9f1e55f73fec99ed8ff482ac5f37378d1ebae18ebf7d9d24b6b89051625274b2f70b9cfbc4
+  metadata.gz: 393b37b8dc0799317ffb037552dd3c6f140c45dfa8ed33de93fa2dcfaead6a06d4065ed2082b3026acbae7ae023494bfe09a5d1a9cb4ad08cb7620c2d00b11a5
+  data.tar.gz: e3474dda911ee613f4048f82d76983cc6d361e5b878c87514543cd8b6105f3bf5c8ecb255a1349a59efb9944f637dabee147d7e32a9b767f1e06a90512bccc79

data/CHANGELOG.md

@@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## UNRELEASED
 
+# [1.3.0-beta1] - 2019-11-21
+- Added `fetch_record` and `assign_key` methods to ActiveRecordConsumer.
+
 # [1.2.0-beta1] - 2019-09-12
 - Added `fatal_error` to both global config and consumer classes.
 - Changed `pending_db_messages_max_wait` metric to send per topic.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    deimos-ruby (1.2.0.pre.beta1)
+    deimos-ruby (1.3.0.pre.beta1)
       avro-patches (~> 0.3)
       avro_turf (~> 0.8)
       phobos (~> 1.8.2.pre.beta2)
@@ -29,7 +29,7 @@ GEM
       multi_json
     avro-patches (0.4.1)
       avro (= 1.8.2)
-    avro_turf (0.9.0)
+    avro_turf (0.11.0)
       avro (>= 1.7.7, < 1.10)
       excon (~> 0.45)
     coderay (1.1.2)
@@ -41,8 +41,8 @@ GEM
     diff-lcs (1.3)
     digest-crc (0.4.1)
     dogstatsd-ruby (4.2.0)
-    excon (0.66.0)
-    exponential-backoff (0.0.2)
+    excon (0.68.0)
+    exponential-backoff (0.0.4)
     ffi (1.11.1)
     formatador (0.2.5)
     guard (2.14.2)
@@ -77,7 +77,7 @@ GEM
     method_source (0.9.0)
     minitest (5.11.3)
     msgpack (1.2.10)
-    multi_json (1.13.1)
+    multi_json (1.14.1)
     mysql2 (0.5.2)
     nenv (0.3.0)
     notiffany (0.1.1)
@@ -87,7 +87,7 @@ GEM
     parser (2.6.3.0)
       ast (~> 2.4.0)
     pg (1.1.3)
-    phobos (1.8.2.pre.beta2)
+    phobos (1.8.2)
       activesupport (>= 3.0.0)
       concurrent-ruby (>= 1.0.2)
       concurrent-ruby-ext (>= 1.0.2)

data/README.md

@@ -620,6 +620,18 @@ class MyConsumer < Deimos::ActiveRecordConsumer
   key_config field: 'my_field'
   record_class Widget
 
+  # Optional override of the way to fetch records based on payload and
+  # key. Default is to use the key to search the primary key of the table.
+  def fetch_record(klass, payload, key)
+    super
+  end
+
+  # Optional override on how to set primary key for new records. 
+  # Default is to set the class's primary key to the message's decoded key. 
+  def assign_key(record, payload, key)
+    super
+  end
+
   # Optional override of the default behavior, which is to call `destroy`
   # on the record - e.g. you can replace this with "archiving" the record
   # in some way. 

data/lib/deimos/active_record_consumer.rb

@@ -13,22 +13,43 @@ module Deimos
       end
     end
 
+    # Find the record specified by the given payload and key.
+    # Default is to use the primary key column and the value of the first
+    # field in the key.
+    # @param klass [Class < ActiveRecord::Base]
+    # @param _payload [Hash]
+    # @param key [Object]
+    # @return [ActiveRecord::Base]
+    def fetch_record(klass, _payload, key)
+      klass.unscoped.where(klass.primary_key => key).first
+    end
+
+    # Assign a key to a new record.
+    # @param record [ActiveRecord::Base]
+    # @param _payload [Hash]
+    # @param key [Object]
+    def assign_key(record, _payload, key)
+      record[record.class.primary_key] = key
+    end
+
     # :nodoc:
     def consume(payload, metadata)
       key = metadata.with_indifferent_access[:key]
       klass = self.class.config[:record_class]
-      record = klass.unscoped.where(klass.primary_key => key).first
+      record = fetch_record(klass, (payload || {}).with_indifferent_access, key)
       if payload.nil?
         destroy_record(record)
         return
       end
-      record ||= klass.new
+      if record.blank?
+        record = klass.new
+        assign_key(record, payload, key)
+      end
       attrs = record_attributes(payload.with_indifferent_access)
       # don't use attributes= - bypass Rails < 5 attr_protected
       attrs.each do |k, v|
         record.send("#{k}=", v)
       end
-      record[klass.primary_key] = key
       record.created_at ||= Time.zone.now if record.respond_to?(:created_at)
       record.updated_at ||= Time.zone.now if record.respond_to?(:updated_at)
       record.save!

data/lib/deimos/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Deimos
-  VERSION = '1.2.0-beta1'
+  VERSION = '1.3.0-beta1'
 end

data/spec/active_record_consumer_spec.rb

@@ -36,6 +36,24 @@ module ActiveRecordProducerTest
       end
       stub_const('MyConsumer', consumer_class)
 
+      consumer_class = Class.new(Deimos::ActiveRecordConsumer) do
+        schema 'MySchema'
+        namespace 'com.my-namespace'
+        key_config none: true
+        record_class Widget
+
+        # :nodoc:
+        def assign_key(_record, _payload, _key)
+          # do nothing since we're not using primary keys
+        end
+
+        # :nodoc:
+        def fetch_record(klass, payload, _key)
+          klass.unscoped.where('test_id' => payload[:test_id]).first
+        end
+      end
+      stub_const('MyCustomFetchConsumer', consumer_class)
+
       Time.zone = 'Eastern Time (US & Canada)'
     end
 
@@ -83,5 +101,23 @@ module ActiveRecordProducerTest
 
     end
 
+    it 'should find widgets by custom logic' do
+      widget1 = Widget.create!(test_id: 'id1')
+      expect(widget1.some_int).to be_nil
+      test_consume_message(MyCustomFetchConsumer, {
+                             test_id: 'id1',
+                             some_int: 3
+                           }, { call_original: true })
+      expect(widget1.reload.some_int).to eq(3)
+      expect(Widget.count).to eq(1)
+      test_consume_message(MyCustomFetchConsumer, {
+                             test_id: 'id2',
+                             some_int: 4
+                           }, { call_original: true })
+      expect(Widget.count).to eq(2)
+      expect(Widget.find_by_test_id('id1').some_int).to eq(3)
+      expect(Widget.find_by_test_id('id2').some_int).to eq(4)
+    end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deimos-ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.0.pre.beta1
+  version: 1.3.0.pre.beta1
 platform: ruby
 authors:
 - Daniel Orner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-12 00:00:00.000000000 Z
+date: 2019-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro-patches