staged_event 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 626ddab89e43654e2f9f7444efbbb778e40a02882142e5bab971a253d0586278
-  data.tar.gz: 77bf67900459f69099d58913d8ae49140c934d49239f1ebf043e0924d127632e
+  metadata.gz: e9857444ea3c1fe90c3384ebb2c0885b1238c318ee004ea15bbc8416e2956ee2
+  data.tar.gz: 130bb8f5daea2d867ab302878c90b9b1051666728ac61df082c39f4fb8337be1
 SHA512:
-  metadata.gz: 19f8edb5ba417a59bae2d5e62f68437d34a1563b3996fe2d848c6515292136970f071ef7ed75bbc6e9bdac7404a317b5330ba8d1cd3a4bfca40ca0160ea7ba1b
-  data.tar.gz: 7dc404d84752a7aeeda6897cbb47dda3168d86219e3fdc809e21b5dac230a829d2b266fb361f51ac21d0acf0b5ab3bd566a5121181b4853644b4b272a1f55f4e
+  metadata.gz: 67da3f9926591dc20af3a5b4afd6023715246109fc6e2956831503308f6b325c1ccdf36da903917e994676ee584762e2f2068701937a5daa45296f016521504b
+  data.tar.gz: c87ec0b8de498e1e4d355ebef73bef1b5855dc3d435bb79ff187230d729484f6eb6406ed511ed821207cdc12f8a4fd5461acf575e30b939b09e0f885ee9fdec6

data/README.md

@@ -36,6 +36,24 @@ rails db:migrate
 
 ### Publishing Events
 
+A typical usage of StagedEvent would look something like this:
+
+```ruby
+ActiveRecord::Base.transaction do
+  user = User.create!(params)
+
+  StagedEvent.save_proto!(MyEvents::UserCreatedEvent.new(name: user.name, email: user.email))
+end
+```
+This guarantees that a) creating a new User, and b) publishing the associated event, both happen atomically even though b) will result in sending data to an external system.
+
+An alternate syntax if you need access to the ActiveRecord model for the event is:
+```ruby
+  event = StagedEvent.from_proto(MyEvents::UserCreatedEvent.new(name: user.name, email: user.email))
+  event.is_a?(ActiveRecord::Base) # true
+  event.save!
+```
+
 In order for events to actually be published, StagedEvent provides a rake task that should be kept running alongside your application server(s):
 
 ```bash
@@ -44,13 +62,13 @@ rake staged_event:publisher
 
 ### Receiving Events
 
-In order to receive events from publishers, StagedEvent provides a rake task that should be kept running alongside your application server(s):
+To receive events from publishers, StagedEvent provides a rake task that should be kept running alongside your application server(s):
 
 ```bash
 rake staged_event:subscriber
 ```
 
-In order to process incoming events, you define a callback in the staged_event initializer file.
+To specify what is done with incoming events, you define a callback in the StagedEvent initializer file.
 
 ### Regenerating Ruby from protobufs
 

data/lib/generators/staged_event/templates/initializer.rb.erb

@@ -15,6 +15,8 @@ StagedEvent::Configuration.configure do |config|
       default: "topic_id_1",
     }
 
+    # The list of subscription ids to which the staged_event subscriber process will
+    # subscribe.
     google_pubsub.subscription_ids = [ "subscription_id_1" ]
   end
 

data/lib/staged_event/publisher_process.rb

@@ -18,6 +18,8 @@ module StagedEvent
       error :publish_failed, exception: exception.message
       backoff_timer.increment
       retry
+    rescue SignalException => exception
+      error :signal_exception, message: exception.message
     end
 
     private

data/lib/staged_event/subscriber_process.rb

@@ -13,6 +13,8 @@ module StagedEvent
     rescue StandardError => exception
       error :subscriber_main_loop_failed, exception: exception.message
       retry
+    rescue SignalException => exception
+      error :signal_exception, message: exception.message
     end
 
     private

data/lib/staged_event/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StagedEvent
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/staged_event.rb

@@ -49,6 +49,12 @@ module StagedEvent
       Model.new(id: uuid, data: data, topic: topic)
     end
 
+    # Shortcut method to construct and persist an event with a single call.
+    # Params are the same as from_proto.
+    def save_proto!(proto, **kwargs)
+      StagedEvent.from_proto(proto, **kwargs).save!
+    end
+
     # Converts serialized event data received from a publisher into an object with
     # the event (and its metadata) in accessible form
     #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: staged_event
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Andrew Cross
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-12 00:00:00.000000000 Z
+date: 2022-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -202,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: StagedEvent