hey-pubsub 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 590724616c1051ab959c4ac95e4a645118456819
-  data.tar.gz: b72160d7af916bad08377c2838928210bbc54d4f
+  metadata.gz: e7e86cccd486ebf7f99dcb3b3fd054ee87dc643e
+  data.tar.gz: a93db839d76dd98c5178ad72b4b865ba06e86902
 SHA512:
-  metadata.gz: 4bb1fdfd774c144b7f9a84db60e3d406244efd9fa105333a195b6f7534511b4f0169193e3cfcf73e308856c173d4ca46f54e5c1a74fa18f38903ba53c91ee589
-  data.tar.gz: a04bff268858dee84d39c54400ccd1b833108b97589ded246e17c78d342c18374818b85467c04e5f338b835e92c99e1bd295d324f5c239f14b69c5aad04ec6eb
+  metadata.gz: a97edb277e81c3761a444be82f8507a80c59dd4c259da5dd860ebe32cc855749f202c9a281484c7b5c5b601ddc94d2e58827ba4458a4aa491596ca48a0172562
+  data.tar.gz: fda8810ce7f36deed31c4c1bd96eb91d8c8dfbfc48f8fe426013d97523164c2ac3e0e24c0c7349fb5d46e433e9f7c8779ac7ff47fa3ebac8b02135cc3ecc6231

data/README.md

@@ -51,7 +51,29 @@ chain of events to be associated later in a Kibana dashboard, for example.
 This UUID could be used across disparate systems subscribing to the same message bus, so long as the convention is
 adhered to.
 
-### Sanitizing payloads
+### Contexts
+
+Use contexts if you want to attach meta-data to all events that happen on a thread from a certain point forward.
+
+```ruby
+Hey.context(ip_address: "127.0.0.1") do
+  Hey.publish!("registration.succeeded", { email: "john@ecommerce.com" })
+end
+```
+
+The payloads of all events wrapped in a context will include this extra data.
+
+You may also nest contexts:
+
+```ruby
+Hey.context(ip_address: "127.0.0.1") do
+  Hey.context(current_actor: "Jack Ship") do
+    Hey.publish!("registration.succeeded", { email: "john@ecommerce.com" })
+  end
+end
+```
+
+#### Sanitizing payloads
 
 There are times you'd like sensitive information to be stripped from event payloads. For example, if you are logging API
 requests and responses you should redact credentials before writing to a database or logfile.
@@ -60,21 +82,52 @@ It's easier to handle this sanitization during publication, since subscribers of
 values to strip. Hey provides a utility to record these sensitive values and every event published during the life of
 the current thread will redact them from their payloads.
 
+You can sanitize data by using the key `sanitize` in your contexts:
+
+```ruby
+Hey.context(sanitize: ["227-76-1234"]) do
+  Hey.publish!("registration.succeeded", { email: "john@ecommerce.com" })
+end
+```
+
+#### Namespacing events
+
+You can automatically namespace your event names using contexts and a top-level namespace.
+
+A top-level namespace can be configured like this:
+
 ```ruby
-Hey.sanitize!("ABC123", "4222222222222222", "245-65-12763")
+Hey.configure do |config|
+  config.global_namespace = “my-app”
+end
 ```
 
-### Setting arbitrary data
+As can a delimiter for chaining an event name together, the default of which is “:” :
+
+```ruby
+Hey.configure do |config|
+  config.delimiter = “/”
+end
+```
 
-If you need to set arbitrary values to be included on every event payload for the life of a thread, you can:
+With this configuration, an event’s name would look like this:
 
 ```ruby
-Hey.set(:ip_address, "127.0.0.1")
+Hey.publish!("registered", { email: "john@ecommerce.com" })
+=> "my-app/registered"
 ```
 
-### Writing customer setters
+You can also set a namespace on contexts and they will automatically be chained together in the order they are nested:
 
-TODO
+```ruby
+Hey.context(namespace: “foo”) do
+  Hey.context(namespace: “bar”) do
+    Hey.publish!(“hooray”)
+  end
+end
+
+=> "foo:bar:hooray"
+```
 
 ## Event publishing and subscribing
 
@@ -127,6 +180,19 @@ Hey.subscribe!("registration.succeeded") do |payload|
 end
 ```
 
+## Middleware
+
+A faraday middleware adapter is provided to automatically broadcast all requests and responses.
+
+```ruby
+faraday_connection = ::Faraday.new(url: base_url) do |faraday|
+  faraday.use Hey::Pubsub::Middleware::Faraday
+  faraday.adapter ::Faraday.default_adapter
+end
+```
+
+It will broadcast the event names "request" and "response", so be sure to use contexts and namespacing to make the event names more meaningful.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/hey/configuration.rb

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

data/lib/hey/event_name.rb

@@ -0,0 +1,19 @@
+class Hey::EventName
+  def initialize(name)
+    @name = name
+  end
+
+  def to_s
+    [Hey.global_namespace, namespaces, name].flatten.compact.join(Hey.configuration.delimiter)
+  end
+
+  private
+
+  attr_reader :name
+
+  def namespaces
+    @namespaces ||= Hey::ThreadCargo.contexts.map do |context|
+      Array[context[:namespace]]
+    end.flatten.compact
+  end
+end

data/lib/hey/pubsub/event.rb

@@ -3,7 +3,7 @@ class Hey::Pubsub::Event
   attr_accessor :name
 
   def initialize(name:, started_at: nil, ended_at: nil, metadata: {})
-    @name = name
+    @name = Hey::EventName.new(name).to_s
     @started_at = started_at
     @ended_at = ended_at
     @metadata = metadata

data/lib/hey/pubsub/middleware/faraday.rb

@@ -0,0 +1,19 @@
+module Hey::Pubsub::Middleware
+  class Faraday
+    def call(env)
+      Hey.publish("request", request: env)
+
+      @app.call(env).on_complete do |env|
+        Hey.publish("response", response: env)
+      end
+    end
+  end
+end
+
+
+
+
+
+
+
+

data/lib/hey/version.rb

@@ -1,3 +1,3 @@
 module Hey
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/hey.rb

@@ -17,9 +17,12 @@ module Hey
     configuration.pubsub_adapter
   end
 
+  def self.global_namespace
+    configuration.global_namespace
+  end
+
   module Behavior
     def publish!(event_name, payload = {}, &block)
-      event_name = "#{Hey.configuration.namespace}.#{event_name}" unless Hey.configuration.namespace.nil?
       event = Hey::Pubsub::Event.new(name: event_name, metadata: payload)
       pubsub_adapter.publish!(event, &block)
     end
@@ -43,6 +46,7 @@ end
 
 require "hey/configuration"
 require "hey/context"
+require "hey/event_name"
 require "hey/thread_cargo"
 require "hey/sanitized_hash"
 require "hey/pubsub"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hey-pubsub
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - ShippingEasy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-07 00:00:00.000000000 Z
+date: 2015-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,9 +86,11 @@ files:
 - lib/hey.rb
 - lib/hey/configuration.rb
 - lib/hey/context.rb
+- lib/hey/event_name.rb
 - lib/hey/pubsub.rb
 - lib/hey/pubsub/adapters/asn_adapter.rb
 - lib/hey/pubsub/event.rb
+- lib/hey/pubsub/middleware/faraday.rb
 - lib/hey/sanitized_hash.rb
 - lib/hey/thread_cargo.rb
 - lib/hey/version.rb
@@ -112,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Pubsub wrapper with utilities to chain events, sanitize payloads and record