hey-pubsub 0.0.5 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47678c0e57e35fa02d880ddb05d0905f5a1fdb35
-  data.tar.gz: 1675e2ed28ae1f7a7f9b7211d647f7e34cac8998
+  metadata.gz: db65819c7adc7ad9daaa79ce3a84a7f8a8d14d13
+  data.tar.gz: e8e130a00d678bc0bb8e3d432106b5682dcea1d6
 SHA512:
-  metadata.gz: 220af4af52b73ce75ceb3aa127002750d077b3283c2aebb69e42a72351a9ce2ea721cf8bb9bdbfd73af44a7d245675e68fc6d927b01c557ee748b01ca63cac5c
-  data.tar.gz: 33a541aefdef8390cbf7faf0783c451e7b7c5f5ba072e01f7319621164f20234a40b2b27cff44a9b46b3d5e4300e614e20bfe07964b04656fa17611995b26743
+  metadata.gz: b7bfdd6b8a72804d692e6bdf5501db7ca5fdfb5934a0221d2d250a6315ade1411851d735462f3c2391ceac57c8cb8cb2462d7a4ad56f98790c76eb0dd4da56bc
+  data.tar.gz: dcf7cf396f92c79b9e484523cc9ebcc3f60f7eea1ea345194a727a7b49b092d9f6ecb44515220493868177cd78598b515b5953a012093725a32bb82a0d47ee56

data/README.md

@@ -5,7 +5,6 @@ some convenience utilities to:
 
 * Track a chain of events
 * Sanitize sensitive data from event payloads
-* Record who originally kicked off the chain of events (the actor)
 * Set arbitrary data that will be included on every event published on the same thread
 
 ## Installation
@@ -42,19 +41,6 @@ your code.
 
 Hey provides utilities to share metadata across all events published on the same thread.
 
-### Setting the current actor
-
-It's often useful to know who kicked off a chain of events, whether it's a user, employee or the system itself via
-some automated process. We call this entity the "current actor".
-
-As soon as you know who the current actor is for a a business process, you should set it:
-
-```ruby
-Hey.set_current_actor!(id: 13234, type: "Employee", name: "Jack Ship")
-```
-
-Any events published for the life of the current thread with include `current_actor` in their payloads.
-
 ### Event chain UUID
 
 The first time an event is published via Hey a UUID will be assigned and stored on the current thread.
@@ -85,6 +71,11 @@ If you need to set arbitrary values to be included on every event payload for th
 ```ruby
 Hey.set(:ip_address, "127.0.0.1")
 ```
+
+### Writing customer setters
+
+TODO
+
 ## Event publishing and subscribing
 
 ### Adapters

data/hey-pubsub.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["ShippingEasy"]
   spec.email         = ["dev@shippingeasy.com"]
 
-  spec.summary       = %q{Pubsub wrapper with utilities to chain events, sanitize payloads and record the actor.}
+  spec.summary       = %q{Pubsub wrapper with utilities to chain events, sanitize payloads and record data on all events on the same thread.}
   spec.homepage      = "https://github.com/ShippingEasy/hey-pubsub"
   spec.license       = "MIT"
 

data/lib/hey/configuration.rb

@@ -1,7 +1,8 @@
 class Hey::Configuration
-  attr_accessor :pubsub_adapter
+  attr_accessor :pubsub_adapter, :namespace
 
   def initialize
     @pubsub_adapter = Hey::Pubsub::Adapters::AsnAdapter
+    @namespace = "pubsub"
   end
 end

data/lib/hey/pubsub/adapters/asn_adapter.rb

@@ -6,26 +6,23 @@ module Hey::Pubsub::Adapters
       if block_given?
         ActiveSupport::Notifications.subscribe(event_name) do |*args|
           asn_event = ActiveSupport::Notifications::Event.new(*args)
-
-          payload = asn_event.payload.dup
-          event = Hey::Pubsub::Event.new(uuid: payload.delete(:uuid),
-                                         name: asn_event.name,
+          event = Hey::Pubsub::Event.new(name: asn_event.name,
                                          started_at: asn_event.time,
                                          ended_at: asn_event.end,
-                                         metadata: payload)
+                                         metadata: asn_event.payload.dup)
 
-          yield(event.to_hash)
+          yield(event.to_h)
         end
       end
     end
 
-    def self.publish!(event_name, payload = {})
+    def self.publish!(event)
       if block_given?
-        ActiveSupport::Notifications.instrument(event_name, payload) do
+        ActiveSupport::Notifications.instrument(event.name, event.metadata) do
           yield
         end
       else
-        ActiveSupport::Notifications.instrument(event_name, payload)
+        ActiveSupport::Notifications.instrument(event.name, event.metadata)
       end
     end
   end

data/lib/hey/pubsub/event.rb

@@ -1,28 +1,45 @@
 class Hey::Pubsub::Event
-  def initialize(name:, uuid:, started_at:, ended_at:, metadata: {})
+  attr_writer :name, :metadata, :started_at, :ended_at
+
+  def initialize(name:, started_at: nil, ended_at: nil, metadata: {})
     @name = name
-    @uuid = uuid
     @started_at = started_at
     @ended_at = ended_at
     @metadata = metadata
   end
 
-  def to_hash
-    {
-      uuid: uuid,
-      name: name,
-      started_at: started_at,
-      ended_at: ended_at,
-      duration: duration,
-      metadata: metadata
-    }
+  def to_h
+    hash = { uuid: Hey::ThreadCargo.uuid, name: name, metadata: metadata }
+    hash[:started_at] = started_at unless started_at.nil?
+    hash[:ended_at] = ended_at unless ended_at.nil?
+    hash[:duration] = duration unless duration.nil?
+    hash
+  end
+
+  def started_at
+    return if @started_at.nil?
+    @started_at.strftime("%Y-%m-%dT%H:%M:%S.%L")
   end
 
-  private
+  def ended_at
+    return if @ended_at.nil?
+    @ended_at.strftime("%Y-%m-%dT%H:%M:%S.%L")
+  end
 
-  attr_reader :name, :uuid, :metadata, :started_at, :ended_at
+  def metadata
+    merged_data = Hey::ThreadCargo.to_h.merge(@metadata)
+    merged_data.delete(:uuid)
+    merged_data.delete(Hey::ThreadCargo::SANITIZABLE_VALUES_KEY)
+    Hey::SanitizedHash.new(merged_data).to_h
+  end
+
+  def name
+    return @name if Hey.configuration.namespace.nil?
+    "#{Hey.configuration.namespace}.#{@name}"
+  end
 
   def duration
-    @duration ||= 1000.0 * (ended_at - started_at)
+    return if @ended_at.nil? || @started_at.nil?
+    1000.0 * (@ended_at - @started_at)
   end
 end

data/lib/hey/thread_cargo.rb

@@ -14,21 +14,11 @@ class Hey::ThreadCargo
     Thread.current[:hey][name]
   end
 
-  # Returns the actor from the current thread
-  def self.current_actor
-    get(:current_actor)
-  end
-
   def self.uuid
     return set(:uuid, SecureRandom.uuid) if get(:uuid).nil?
     get(:uuid)
   end
 
-  # Sets the actor to the current thread
-  def self.set_current_actor(name:, type: nil, id: nil)
-    set(:current_actor, { name: name, type: type, id: id})
-  end
-
   # Adds the supplied values to the sanitized values array. It removes nils and duplicate values from the array.
   def self.sanitize!(*values)
     set(SANITIZABLE_VALUES_KEY, []) if get(SANITIZABLE_VALUES_KEY).nil?
@@ -45,10 +35,8 @@ class Hey::ThreadCargo
     Array(get(SANITIZABLE_VALUES_KEY))
   end
 
-  def self.to_hash
+  def self.to_h
     Thread.current[:hey] = {} if Thread.current[:hey].nil?
-    hash = Thread.current[:hey].clone
-    hash.delete(SANITIZABLE_VALUES_KEY)
-    hash
+    Thread.current[:hey].clone
   end
 end

data/lib/hey/version.rb

@@ -1,3 +1,3 @@
 module Hey
-  VERSION = "0.0.5"
+  VERSION = "0.0.7"
 end

data/lib/hey.rb

@@ -13,26 +13,26 @@ module Hey
     configuration.pubsub_adapter
   end
 
-  def self.publish!(event_name, payload = {}, &block)
-    payload = Hey::Pubsub::Payload.new(payload)
-    pubsub_adapter.publish!(event_name, payload.to_h, &block)
-  end
+  module Behavior
+    def publish!(event_name, payload = {}, &block)
+      event = Hey::Pubsub::Event.new(name: event_name, metadata: payload)
+      pubsub_adapter.publish!(event, &block)
+    end
 
-  def self.subscribe!(event_name, &block)
-    pubsub_adapter.subscribe!(event_name, &block)
-  end
+    def subscribe!(event_name, &block)
+      pubsub_adapter.subscribe!(event_name, &block)
+    end
 
-  def self.set(name, value)
-    Hey::ThreadCargo.set(name, value)
-  end
+    def set(name, value)
+      Hey::ThreadCargo.set(name, value)
+    end
 
-  def self.set_current_actor!(name:, id: nil, type: nil)
-    Hey::ThreadCargo.set_current_actor(name: name, id: id, type: type)
+    def sanitize!(*values)
+      Hey::ThreadCargo.sanitize!(values)
+    end
   end
 
-  def self.sanitize!(*values)
-    Hey::ThreadCargo.sanitize!(values)
-  end
+  extend Hey::Behavior
 end
 
 require "securerandom"
@@ -40,6 +40,5 @@ require "hey/configuration"
 require "hey/thread_cargo"
 require "hey/sanitized_hash"
 require "hey/pubsub"
-require "hey/pubsub/payload"
 require "hey/pubsub/event"
 require "hey/pubsub/adapters/asn_adapter"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hey-pubsub
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.7
 platform: ruby
 authors:
 - ShippingEasy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-20 00:00:00.000000000 Z
+date: 2015-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -88,7 +88,6 @@ files:
 - lib/hey/pubsub.rb
 - lib/hey/pubsub/adapters/asn_adapter.rb
 - lib/hey/pubsub/event.rb
-- lib/hey/pubsub/payload.rb
 - lib/hey/sanitized_hash.rb
 - lib/hey/thread_cargo.rb
 - lib/hey/version.rb
@@ -116,5 +115,5 @@ rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Pubsub wrapper with utilities to chain events, sanitize payloads and record
-  the actor.
+  data on all events on the same thread.
 test_files: []

data/lib/hey/pubsub/payload.rb

@@ -1,19 +0,0 @@
-class Hey::Pubsub::Payload
-  def initialize(values = {})
-    @values = values
-    merge_values!
-  end
-
-  def to_h
-    Hey::SanitizedHash.new(values).to_h
-  end
-
-  private
-
-  attr_accessor :values
-
-  def merge_values!
-    Hey::ThreadCargo.uuid # initialize if it has never been set
-    self.values = Hey::ThreadCargo.to_hash.merge(values)
-  end
-end