hey-pubsub 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 777cd434081c96081256b6c8f4005f0d3eb56337
+  data.tar.gz: cddd2ed4927bdd139eeb25cf147095be362b40b6
+SHA512:
+  metadata.gz: f002172c5f5a9052907e29e5842a7f2db05fa0adbf1046935d1c88b65db4b2eae022601c23dffc35c7c2b42ccbe9cd8238fcd7827dd155591db94d9bc53a9071
+  data.tar.gz: 9a205acdd2080483330edf069572a605c998f1176e9293b2fae4442c5596da0bc2f64f12b8d56a8f0811c44a6132c331659930ed96cc6e9dbb2a9caad6a210c4

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+.idea
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hey-pubsub.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Theo Mills
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,152 @@
+# Hey!
+
+Hey is a lightweight pubsub wrapper that makes it easy to change underlying messaging implementations and also includes
+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
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hey-pubsub'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hey-pubsub
+
+## Why use Hey?
+
+We often treat logging, exception notification and event broadcasting as separate operations within our code. Hey
+encourages you to treat everything as a published event that is meaningful to the current operation being performed.
+
+Any number of subscribers may react to the event once it's published. For example a published registration failure event
+could have a logstash subscriber logging the failure details into Kibana and a HoneyBadger subscriber recording the exception
+and notifying the dev team. A successful registration event, on the other hand, could trigger a welcome email delivery.
+
+The utilities Hey provides, such as data sanitization, makes it more appealing to combine these logging and pubsub use cases.
+Additionally the ability to switch out messaging implementations means you start with a simple approach (ActiveSupport
+Notifications) and ease into using a more distributed, asynchronous approach as your application grows without changing
+your code.
+
+## Shared Metadata
+
+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.
+
+Any events published for the life of the current thread with include this `uuid` in their payloads. This allows a
+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
+
+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.
+
+It's easier to handle this sanitization during publication, since subscribers of the events will likely not know what
+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.
+
+```ruby
+Hey.sanitize!("ABC123", "4222222222222222", "245-65-12763")
+```
+
+### Setting arbitrary data
+
+If you need to set arbitrary values to be included on every event payload for the life of a thread, you can:
+
+```ruby
+Hey.set(:ip_address, "127.0.0.1")
+```
+## Event publishing and subscribing
+
+### Adapters
+
+Hey uses an ActiveSupport Notifications adapter by default, which is essentially a synchronous event bus. However it is
+easy to configure a different adapter if needed:
+
+```ruby
+Hey.configure do |config|
+  config.pubsub_adapter = FooBar::RabbitMqAdapter
+end
+```
+
+__Note: Currently the only adapter is the aforementioned `Hey::Pubsub::Adapters::AsnAdapter`__
+
+### Publishing
+
+To gain all of the `Hey` goodness, you have to of course use the Hey `publish!` method:
+
+```ruby
+Hey.publish!("registration.succeeded", { email: "john@ecommerce.com" })
+```
+
+The resulting payload would look something like this:
+
+```
+{
+  uuid: "0a5d3f22-2cff-4126-a791-c4ac31a2a5bb",
+  current_actor: {
+    id: "123343",
+    type: "Employee",
+    name: "Jack Ship"
+  },
+  email: "john@ecommerce.com"
+}
+```
+
+__Note: Though ASN supports passing objects in payloads since it's all in the same thread, do not do it. If you ever
+switch to an asyncronous adapter it will fail. Only pass JSON compatible values.__
+
+### Subscribing
+
+To subscribe to a published event, do this:
+
+```ruby
+Hey.subscribe!("registration.succeeded") do |payload|
+  email = payload["email"]
+  RegistrationMailer.new_customer(email).deliver
+end
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ShippingEasy/hey-pubsub.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hey/pubsub"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/hey-pubsub.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hey/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hey-pubsub"
+  spec.version       = Hey::VERSION
+  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.homepage      = "https://github.com/ShippingEasy/hey-pubsub"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_dependency "activesupport"
+end

data/lib/hey/configuration.rb

@@ -0,0 +1,7 @@
+class Hey::Configuration
+  attr_accessor :pubsub_adapter
+
+  def initialize
+    @pubsub_adapter = Hey::Pubsub::Adapters::AsnAdapter
+  end
+end

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

@@ -0,0 +1,24 @@
+require "active_support/all"
+
+module Hey::Pubsub::Adapters
+  module AsnAdapter
+    def self.subscribe!(event_name)
+      if block_given?
+        ActiveSupport::Notifications.subscribe(event_name) do |*args|
+          event = ActiveSupport::Notifications::Event.new(*args)
+          yield(event.payload)
+        end
+      end
+    end
+
+    def self.publish!(event_name, payload = {})
+      if block_given?
+        ActiveSupport::Notifications.instrument(event_name, payload) do
+          yield
+        end
+      else
+        ActiveSupport::Notifications.instrument(event_name, payload)
+      end
+    end
+  end
+end

data/lib/hey/pubsub/payload.rb

@@ -0,0 +1,42 @@
+class Hey::Pubsub::Payload
+  def initialize(values = {})
+    @values = values
+    merge_values!
+    sanitize_values!
+  end
+
+  def to_hash
+    values
+  end
+
+  alias_method :to_h, :to_hash
+
+  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
+
+  def sanitize_values!
+    traverse_hash(values) { |k, v| [k, sanitize_value!(v)] }
+  end
+
+  def sanitize_value!(value)
+    Hey::ThreadCargo.sanitizable_values.each do |sanitizable_value|
+      value.gsub!(sanitizable_value, "")
+    end
+  end
+
+  def traverse_hash(h, &block)
+    h.each_pair do |k, v|
+      if v.is_a?(Hash)
+        traverse_hash(v, &block)
+      else
+        yield(k, v)
+      end
+    end
+  end
+end

data/lib/hey/pubsub.rb

@@ -0,0 +1 @@
+module Hey::Pubsub; end

data/lib/hey/thread_cargo.rb

@@ -0,0 +1,54 @@
+class Hey::ThreadCargo
+  SANITIZABLE_VALUES_KEY = :sanitizable_values
+
+  # Sets a namespaced value on the current thread
+  def self.set(name, value)
+    Thread.current[:hey] = {} if Thread.current[:hey].nil?
+    Thread.current[:hey][name] = value
+    value
+  end
+
+  # Returns a namespaced value from the current thread
+  def self.get(name)
+    return nil if Thread.current[:hey].nil?
+    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?
+    values = Array(values)
+    set(SANITIZABLE_VALUES_KEY, get(SANITIZABLE_VALUES_KEY).concat(values).flatten.compact.uniq)
+  end
+
+  # Removes all namespaced values from the current thread.
+  def self.purge!
+    Thread.current[:hey] = nil
+  end
+
+  def self.sanitizable_values
+    Array(get(SANITIZABLE_VALUES_KEY))
+  end
+
+  def self.to_hash
+    Thread.current[:hey] = {} if Thread.current[:hey].nil?
+    hash = Thread.current[:hey].clone
+    hash.delete(SANITIZABLE_VALUES_KEY)
+    hash
+  end
+end

data/lib/hey/version.rb

@@ -0,0 +1,3 @@
+module Hey
+  VERSION = "0.0.1"
+end

data/lib/hey.rb

@@ -0,0 +1,43 @@
+require "hey/version"
+
+module Hey
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.configuration
+    @configuration ||= Hey::Configuration.new
+  end
+
+  def self.pubsub_adapter
+    configuration.pubsub_adapter
+  end
+
+  def self.publish!(event_name, payload = {})
+    payload = Hey::Pubsub::Payload.new(payload)
+    pubsub_adapter.publish!(event_name, payload.to_h)
+  end
+
+  def self.subscribe!(event_name)
+    pubsub_adapter.subscribe!(event_name)
+  end
+
+  def self.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)
+  end
+
+  def self.sanitize!(*values)
+    Hey::ThreadCargo.sanitize!(values)
+  end
+end
+
+require "securerandom"
+require "hey/configuration"
+require "hey/thread_cargo"
+require "hey/pubsub"
+require "hey/pubsub/payload"
+require "hey/pubsub/adapters/asn_adapter"

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: hey-pubsub
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- ShippingEasy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- dev@shippingeasy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hey-pubsub.gemspec
+- lib/hey.rb
+- lib/hey/configuration.rb
+- lib/hey/pubsub.rb
+- lib/hey/pubsub/adapters/asn_adapter.rb
+- lib/hey/pubsub/payload.rb
+- lib/hey/thread_cargo.rb
+- lib/hey/version.rb
+homepage: https://github.com/ShippingEasy/hey-pubsub
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Pubsub wrapper with utilities to chain events, sanitize payloads and record
+  the actor.
+test_files: []