emque-producing 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc3013b37568f755a5f258d0c18b3a8e346ac219
-  data.tar.gz: 28aad21a17a39be148e7d22611df8b4d992c85f6
+  metadata.gz: f07f1bcc511fa4aa8ccbe5a9c5342ff719541944
+  data.tar.gz: d7b89c744df15c439701549c1f756f35dd34c748
 SHA512:
-  metadata.gz: 997635efddaa40fe279c246a3862917666b4c4d154b6809c9c69e7fe6e3a4281ffac27e8a1638c8556467f764be2cdb62a9b8d67edaf90331541e2d581b733da
-  data.tar.gz: 5cebfd302c30b90c1863555cd5b7fce581d67d1278310a05d6ad13f4bf71e573bf9a50311204da6a74e7108de3d7f735654db85905639bf621b14f982e68dfda
+  metadata.gz: 06e9e100d3f6fa96200995b7f1affdf6ba6fcd843e69ea2b0cb83c4245fc8fc9fd6a97f252fabeea5cd79a2014a5b65aaa66b39c940d9b97e5d41d3c2bb02a61
+  data.tar.gz: 51c17c859632f0222c0ba16804e091b4e4664357e6b844bf37947eab6b56a7b20507cd1d753da94307f5441cb9558ecf72e75be2a6155bd2e1de4624b4f48645

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    emque-producing (0.0.2)
+    emque-producing (0.0.3)
       oj (~> 2.10.2)
       virtus (~> 1.0.3)
 

data/lib/emque/producing.rb

@@ -6,3 +6,4 @@ require "emque/producing/configuration"
 require "emque/producing/logging"
 require "emque/producing/publisher/base"
 require "emque/producing/message/message"
+require "emque/producing/message/message_with_changeset"

data/lib/emque/producing/message/message.rb

@@ -1,4 +1,5 @@
-require 'securerandom'
+require "securerandom"
+require "socket"
 
 module Emque
   module Producing

data/lib/emque/producing/message/message_with_changeset.rb

@@ -0,0 +1,59 @@
+module Emque
+  module Producing
+    module MessageWithChangeset
+      def self.included(base)
+        base.send(:include, Emque::Producing::Message)
+        base.send(:attribute, :partition_key, String, :default => nil, :required => false)
+        base.send(:attribute, :change_set, Hash, :default => :build_change_set, :required => true)
+        base.send(:private_attribute, :updated)
+        base.send(:private_attribute, :original)
+      end
+
+      def build_change_set
+        ChangesPayloadGenerator
+          .new({:original => original, :updated => updated})
+          .execute
+      end
+
+      def build_id
+        if updated
+          updated.fetch("id") { updated[:id] }
+        elsif original
+          original.fetch("id") { original[:id] }
+        else
+          raise Emque::Producing::Message::InvalidMessageError
+        end
+      end
+    end
+
+    class ChangesPayloadGenerator
+      def initialize(opts = {})
+        @original = opts.fetch(:original, {}) || {}
+        @updated = opts.fetch(:updated, {}) || {}
+      end
+
+      def execute
+        {:original => original, :updated => updated, :delta => delta}
+      end
+
+      private
+
+      attr_reader :original, :updated
+
+      def delta
+        if original.empty?
+          :_created
+        elsif updated.empty?
+          :_deleted
+        else
+          _delta = updated
+            .reject { |attr, val| original[attr] == val }
+            .map { |attr, val|
+            [attr, {:original => original[attr], :updated => val}]
+          }
+          Hash[_delta]
+        end
+      end
+    end
+  end
+end

data/lib/emque/producing/producing.rb

@@ -4,6 +4,20 @@ module Emque
       attr_accessor :publisher
       attr_writer :configuration
 
+      def message(opts = {})
+        with_changeset = opts.fetch(:with_changeset) { false }
+
+        Module.new do
+          define_singleton_method(:included) do |descendant|
+            if with_changeset
+              descendant.send(:include, ::Emque::Producing::MessageWithChangeset)
+            else
+              descendant.send(:include, ::Emque::Producing::Message)
+            end
+          end
+        end
+      end
+
       def configure
         yield(configuration)
       end

data/lib/emque/producing/version.rb

@@ -1,5 +1,5 @@
 module Emque
   module Producing
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/spec/producing/message/changes_payload_generator_spec.rb

@@ -0,0 +1,65 @@
+require "spec_helper"
+require "virtus"
+require "emque/producing/message/message_with_changeset"
+
+class FakeModel
+  include Virtus.model
+
+  attribute :foo, Integer
+  attribute :bar, Integer
+  attribute :baz, Integer
+end
+
+describe Emque::Producing::ChangesPayloadGenerator do
+  context "creating object" do
+    it "returns a correctly formatted payload" do
+      object = FakeModel.new(:foo => 1, :bar => 2, :baz => 3)
+      generator = Emque::Producing::ChangesPayloadGenerator.new(:updated => object.attributes)
+      payload = generator.execute
+
+      expect(payload).to eq(
+        {
+          :original => {},
+          :updated => {:foo => 1, :bar => 2, :baz => 3},
+          :delta => :_created
+        }
+      )
+    end
+  end
+
+  context "updating object" do
+    it "returns a correctly formatted payload" do
+      original = FakeModel.new(:foo => 1, :bar => 2, :baz => 3)
+      updated = original.dup
+      updated.attributes = {:foo => 4}
+      generator = Emque::Producing::ChangesPayloadGenerator.new(
+        :original => original.attributes, :updated => updated.attributes
+      )
+      payload = generator.execute
+
+      expect(payload).to eq(
+        {
+          :original => {:foo => 1, :bar => 2, :baz => 3},
+          :updated => {:foo => 4, :bar => 2, :baz => 3},
+          :delta => {:foo => {:original => 1, :updated => 4}}
+        }
+      )
+    end
+  end
+
+  context "deleting object" do
+    it "returns a correctly formatted payload" do
+      object = FakeModel.new(:foo => 1, :bar => 2, :baz => 3)
+      generator = Emque::Producing::ChangesPayloadGenerator.new(:original => object.attributes)
+      payload = generator.execute
+
+      expect(payload).to eq(
+        {
+          :original => {:foo => 1, :bar => 2, :baz => 3},
+          :updated => {},
+          :delta => :_deleted
+        }
+      )
+    end
+  end
+end

data/spec/producing/message/message_spec.rb

@@ -1,9 +1,40 @@
 require "spec_helper"
 require "virtus"
 require "emque/producing/message/message"
+require "emque/producing/message/message_with_changeset"
+
+class TestMessageWithChangeset
+  include Emque::Producing.message(:with_changeset => true)
+
+  topic "queue"
+  message_type "queue.new"
+
+  attribute :test_id, Integer, :required => true, :default => :build_id
+  private_attribute :extra, String, :default => "value"
+end
+
+class TestMessageWithChangesetCustomBuildId
+  include Emque::Producing.message(:with_changeset => true)
+
+  topic "queue"
+  message_type "queue.new"
+
+  attribute :test_uuid, Integer, :required => true, :default => :build_id
+  private_attribute :extra, String, :default => "value"
+
+  def build_id
+    if updated
+      updated.fetch("uuid") { updated[:uuid] }
+    elsif original
+      original.fetch("uuid") { original[:uuid] }
+    else
+      raise Emque::Producing::Message::InvalidMessageError
+    end
+  end
+end
 
 class TestMessage
-  include Emque::Producing::Message
+  include Emque::Producing.message
 
   topic "queue"
   message_type "queue.new"
@@ -13,19 +44,19 @@ class TestMessage
 end
 
 class MessageNoTopic
-  include Emque::Producing::Message
+  include Emque::Producing.message
   message_type "testing"
 end
 
 class MessageNoType
-  include Emque::Producing::Message
+  include Emque::Producing.message
   topic "testing"
 end
 
 describe Emque::Producing::Message do
   before do
     Emque::Producing.configure do |c|
-      c.app_name = "apiv3"
+      c.app_name = "my_app"
     end
   end
 
@@ -33,12 +64,12 @@ describe Emque::Producing::Message do
     it "creates the metadata" do
       message = TestMessage.new(:test_id => 1)
       metadata = message.add_metadata[:metadata]
-      expect(metadata[:app]).to eql("apiv3")
+      expect(metadata[:app]).to eql("my_app")
     end
 
     it "can be transformed to json" do
       message = Oj.load(TestMessage.new().to_json)
-      expect(message["metadata"]["app"]).to eql("apiv3")
+      expect(message["metadata"]["app"]).to eql("my_app")
     end
 
     it "includes valid attributes in json" do
@@ -85,4 +116,102 @@ describe Emque::Producing::Message do
     message = TestMessage.new()
     expect(message.add_metadata[:metadata][:type]).to eql("queue.new")
   end
+
+  context "message with changeset" do
+    describe "custom #build_id behavior" do
+      it "raises an InvalidMessageError when no updated or original object is passed in" do
+        expect{TestMessageWithChangesetCustomBuildId.new(:not_the_id => 1)}.to raise_error(
+          Emque::Producing::Message::InvalidMessageError
+        )
+      end
+
+      it "defaults to the id of the original object if not passed an updated object" do
+        produced_message = TestMessageWithChangesetCustomBuildId.new(
+          :original => {:uuid => 3, :attr => "old_value"}
+        )
+        json = produced_message.to_json
+        consumed_message = Oj.load(json)
+        expect(consumed_message["test_uuid"]).to eql(3)
+      end
+
+      it "defaults to the id of the updated object if passed an id" do
+        produced_message = TestMessageWithChangesetCustomBuildId.new(
+          :original => {:uuid => 1, :attr => "old_value"},
+          :updated => {:uuid => 2, :attr => "new_value"}
+        )
+        json = produced_message.to_json
+        consumed_message = Oj.load(json)
+        expect(consumed_message["test_uuid"]).to eql(2)
+      end
+    end
+
+    describe "default #build_id behavior" do
+      it "raises an InvalidMessageError when no updated or original object is passed in" do
+        expect{TestMessageWithChangeset.new(:not_the_id => 1)}.to raise_error(
+          Emque::Producing::Message::InvalidMessageError
+        )
+      end
+
+      it "defaults to the id of the original object if not passed an updated object" do
+        produced_message = TestMessageWithChangeset.new(
+          :original => {:id => 3, :attr => "old_value"}
+        )
+        json = produced_message.to_json
+        consumed_message = Oj.load(json)
+        expect(consumed_message["test_id"]).to eql(3)
+      end
+
+      it "defaults to the id of the updated object if passed an id" do
+        produced_message = TestMessageWithChangeset.new(
+          :original => {:id => 1, :attr => "old_value"},
+          :updated => {:id => 2, :attr => "new_value"}
+        )
+        json = produced_message.to_json
+        consumed_message = Oj.load(json)
+        expect(consumed_message["test_id"]).to eql(2)
+      end
+    end
+
+    it "defaults to a changeset of 'created' when no updated or original is passed in" do
+      produced_message = TestMessageWithChangeset.new(:test_id => 1)
+      json = produced_message.to_json
+      consumed_message = Oj.load(json)
+      expect(consumed_message["change_set"]).to eql(
+        {"original"=>{}, "updated"=>{}, "delta"=>"_created"}
+      )
+    end
+
+    it "indicates a deleted object when the update is not passed in" do
+      produced_message = TestMessageWithChangeset.new(
+        :test_id => 1,
+        :original => {:attr => "old_value"}
+      )
+      json = produced_message.to_json
+      consumed_message = Oj.load(json)
+      expect(consumed_message["change_set"]).to eql(
+        {"original"=>{"attr"=>"old_value"}, "updated"=>{}, "delta"=>"_deleted"}
+      )
+    end
+
+    it "returns a changeset when update and original values are passed in" do
+      produced_message = TestMessageWithChangeset.new(
+        :test_id => 1,
+        :updated => {:attr => "new_value"},
+        :original => {:attr => "old_value"}
+      )
+      json = produced_message.to_json
+      consumed_message = Oj.load(json)
+      expect(consumed_message["change_set"]).to eql(
+        {
+          "original"=>{"attr"=>"old_value"},
+          "updated"=>{"attr"=>"new_value"},
+          "delta"=>{
+            "attr"=>{
+              "original"=>"old_value", "updated"=>"new_value"
+            }
+          }
+        }
+      )
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: emque-producing
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Emily Dobervich
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-06 00:00:00.000000000 Z
+date: 2015-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -143,6 +143,7 @@ files:
 - lib/emque/producing/configuration.rb
 - lib/emque/producing/logging.rb
 - lib/emque/producing/message/message.rb
+- lib/emque/producing/message/message_with_changeset.rb
 - lib/emque/producing/producing.rb
 - lib/emque/producing/publisher/base.rb
 - lib/emque/producing/publisher/kafka.rb
@@ -151,6 +152,7 @@ files:
 - spec/bin/kafka-run-class.sh
 - spec/kafka_spec_helper.rb
 - spec/producing/configuration_spec.rb
+- spec/producing/message/changes_payload_generator_spec.rb
 - spec/producing/message/message_spec.rb
 - spec/producing/producing_spec.rb
 - spec/producing/publisher_spec.rb
@@ -184,6 +186,7 @@ test_files:
 - spec/bin/kafka-run-class.sh
 - spec/kafka_spec_helper.rb
 - spec/producing/configuration_spec.rb
+- spec/producing/message/changes_payload_generator_spec.rb
 - spec/producing/message/message_spec.rb
 - spec/producing/producing_spec.rb
 - spec/producing/publisher_spec.rb