happenings 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ddc6f910e11bfdc46fc02009443d8d946930daa7
+  data.tar.gz: afdf5f4d4c91fee91648729afac51447a305e157
+SHA512:
+  metadata.gz: 6abb8f430a2b00daea4a13802c62207a42baf14f2835b9345be1b19f804f0d75723c63cf63eb83bf2b0302a2a630c14f656807d04f88a2a56b0cc8cc41d4cb5f
+  data.tar.gz: 99ecdb60c6c6d5a644149baf0465076ac15cdfc4d6138d2e00144b56da6547698f5d4c9ca616fc888a8cd02e47e0f68a55d32de02f162bac7aa73d8ab7abd56f

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.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 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Desmond Bowe
+
+MIT License
+
+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,186 @@
+# Happenings
+
+A light framework for building and publishing domain events.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'happenings'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install happenings
+
+## Basic Usage
+
+Start by creating a Plain Old Ruby Object for your domain event and including the `Happening::Event` module.
+You'll want to declare an initialize method that sets up any needed variables.  Then, implement
+a `#strategy` method and add your business logic there.  This method will be called when your
+Happening Event is run.
+
+```
+class ResetPasswordEvent
+  include Happenings::Event
+
+  def initialize user, new_password, new_password_confirmation
+    @user = user
+    @new_password = new_password
+    @new_password_confirmation = new_password_confirmation
+  end
+
+  def strategy
+    if @new_password == @new_password_confirmation
+      @user.reset_password! @new_password
+      success! message: 'Password reset successfully'
+    else
+      failure! message: 'Password must match confirmation'
+    end
+  end
+end
+```
+
+Run the event using the `#run` method as follows:
+
+```
+event = ResetPasswordEvent.new(user, 'secret_password', 'secret_password')
+if event.run!
+  # it worked, do something
+  flash[:notice] = event.message
+else
+  # event failed for some reason
+  flash[:error] = event.message
+end
+```
+
+`#run!` will return Boolean `true` or `false` depending on the outcome of your strategy.
+`#strategy` must return with `#success!` or `#failure!` or a `Happenings::OutcomeError` will
+be raised.
+
+## Success, Failure
+`#success!` and `#failure!` will set a `succeeded?` attribute and set optional keys for 
+`message` and `reason` attributes.  `message` is meant for human-readable messages, 
+such as "Password reset failed", whereas `reason` is designed for machine-sortable
+filtering, such as "confirmation\_mismatch".  A `duration` attribute is also recorded.
+
+
+## Publishing
+Happenings makes it easy to disseminate your business events to interested parties, such as
+your analytics system, cache counters, or background workers.  Happenings will swallow the
+events by default, but it's recommended that you set a publisher in the configuration (see below).
+This publisher must respond to a `publish` method that accepts two arguments: the 
+payload and a hash of additional info.  This arrangement is geared towards a message broker like
+RabbitMQ, but you can certainly write your own wrapper for another messaging bus like Redis.
+
+Publishing happens automatically when `#run!` is called, regardless of the strategy outcome.  The following methods are important:
+
+`payload`: The main package of the event.  defaults to `{}`, but should
+be overridden in your event to include useful info such as the user id, changed attributes, etc.
+
+`routing_key`: The routable description of the event.  Defaults to `#{app_name}.#{event_name}.#{outcome}`, where outcome is either 'success' or 'failure'.
+
+`event_name`: A machine-filterable version of the event.  Defaults to the underscored class name.
+
+Here's an expanded version of our Reset Password example above that includes publishing features:
+
+```
+class MyEventPublisher
+  require 'bunny'
+
+  def initialize
+    @rabbitmq = Bunny.new
+    @rabbitmq.start
+    @rabbitmq_channel = @rabbitmq.create_channel
+    @events_exchange = @rabbitmq_channel.topic 'events', durable: true
+  end
+
+  def publish message, properties
+    @events_exchange.publish JSON.dump(message), properties
+  end
+end
+
+
+Happenings.configure do |config|
+  config.publisher = MyEventPublisher.new
+  config.app_name = 'my_app'
+end
+
+class ResetPasswordEvent
+  include Happenings::Event
+
+  attr_reader :user, :new_password, :new_password_confirmation
+
+  def initialize user, new_password, new_password_confirmation
+    @user = user
+    @new_password = new_password
+    @new_password_confirmation = new_password_confirmation
+  end
+
+  def strategy
+    ensure_passwords_match and
+      reset_user_password
+  end
+
+  def payload
+    { user: { id: user.id } }
+  end
+
+
+  private
+
+  def reset_user_password
+    user.reset_password! new_password
+    success! message: 'Password reset successfully'
+  end
+
+  def ensure_passwords_match
+    new_password == new_password_confirmation or
+      failure! message: 'Password must match confirmation'
+  end
+end
+```
+
+If the event is successful, `MyEventPublisher#publish` will receive the following parameters:
+```
+message.inspect # => { user: { id: 2 },
+                       event: 'reset_password_event',
+                       reason: nil,
+                       message: 'Password reset successfully',
+                       duration: '0.0015',
+                       succeeded: true }
+
+properties.inspect # => { message_id: <SecureRandom.uuid>,
+                          routing_key: 'my_app.reset_password_event.success',
+                          timestamp: <Time.now.to_i> }
+```
+
+
+## Configuration
+You can change the Happenings configuration by passing a block to the `.configure` method.
+If you're using Happenings with Rails, a good place for this setup is in an
+initializer such as `config/initializers/happenings.rb`:
+
+```
+Happenings.configure do |config|
+  config.logger = your_logger
+  config.publisher = your_publisher
+  config.app_name = 'my awesome app'
+  config.socks = 'black socks'
+end
+```
+
+## Requirements
+
+* ActiveSupport (>= 2.3)
+
+## Contributing
+
+1. Fork it ( http://github.com/desmondmonster/happenings/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/happenings.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'happenings/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "happenings"
+  spec.version       = Happenings::VERSION
+  spec.authors       = ["Desmond Bowe"]
+  spec.email         = ["desmondbowe@gmail.com"]
+  spec.summary       = %q{Event-Driven Domain Scaffold}
+  spec.description   = %q{For use in applications where business domain events are first-class citizens}
+  spec.homepage      = "https://github.com/desmondmonster/happenings"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '>= 2.3'
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/lib/happenings/config.rb

@@ -0,0 +1,42 @@
+module Happenings
+  class Config
+    require 'logger'
+
+    def initialize
+      set_default_attributes
+    end
+
+    def set_default_attributes
+      self.logger = default_logger
+      self.publisher = default_publisher
+      self.app_name = nil
+    end
+
+    def method_missing method, *args
+      if method =~ /=$/
+        attribute = method.to_s.sub '=', ''
+        self.class.instance_eval { attr_accessor attribute }
+        self.send method, args.first
+      else
+        super
+      end
+    end
+
+
+    private
+
+    def default_logger
+      Logger.new $stdout
+    end
+
+    def default_publisher
+      NullPublisher
+    end
+
+    class NullPublisher
+      def self.publish payload, options
+        true
+      end
+    end
+  end
+end

data/lib/happenings/event.rb

@@ -0,0 +1,107 @@
+module Happenings
+
+  class OutcomeError < StandardError; end
+
+  module Event
+
+    require 'active_support/inflector'
+
+    attr_reader :duration, :message, :reason, :succeeded
+
+    def run!
+      time do
+        strategy
+      end
+
+      raise OutcomeError.new 'no outcome specified' if no_outcome_specified?
+
+      publish
+
+      succeeded?
+    end
+
+    def strategy
+      success!
+    end
+
+    def success! options = {}
+      result true, options
+    end
+
+    def failure! options = {}
+      result false, options
+    end
+
+    def succeeded?
+      succeeded
+    end
+
+    def payload
+      {}
+    end
+
+    def routing_key
+      [routing_key_prefixes, event_name, outcome].compact.join '.'
+    end
+
+
+    private
+
+    def result succeeded, options
+      @succeeded = succeeded
+      @message = options[:message]
+      @reason = options[:reason]
+    end
+
+    # overload in subclass.
+    def routing_key_prefixes
+
+    end
+
+    def app_name
+      warn "#app_name is deprecated"
+      Happenings.config.app_name && Happenings.config.app_name.gsub(' ', '').underscore
+    end
+
+    def event_name
+      self.class.to_s.split('::').last.underscore
+    end
+
+    def publish
+      # TODO: change to #reverse_merge because that puts the main payload first
+      Happenings.config.publisher.publish additional_info.merge(payload), properties
+    end
+
+    def properties
+      { message_id: SecureRandom.uuid,
+        routing_key: routing_key,
+        timestamp: Time.now.to_i }
+    end
+
+    def additional_info
+      { event: event_name,
+        reason: reason,
+        message: message,
+        succeeded: succeeded,
+        duration: formatted_duration }
+    end
+
+    def outcome
+      succeeded? ? 'success' : 'failure'
+    end
+
+    def no_outcome_specified?
+      succeeded.nil?
+    end
+
+    def formatted_duration
+      "%.6f" % @duration
+    end
+
+    def time
+      initial_time = Time.now.to_f
+      yield
+      @duration = Time.now.to_f - initial_time
+    end
+  end
+end

data/lib/happenings/version.rb

@@ -0,0 +1,3 @@
+module Happenings
+  VERSION = "0.1.0"
+end

data/lib/happenings.rb

@@ -0,0 +1,16 @@
+
+require 'happenings/version'
+require_relative 'happenings/config'
+require_relative 'happenings/event'
+
+
+module Happenings
+
+  def self.configure
+    yield config if block_given?
+  end
+
+  def self.config
+    @@config ||= Config.new
+  end
+end

data/spec/happenings/configuration_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe 'config' do
+
+  context 'with default settings' do
+    it 'uses the library defaults' do
+      expect(Happenings.config.logger).to be_a Logger
+    end
+  end
+
+  context 'when settings are specified' do
+    it 'uses the new settings' do
+      require 'logger'
+
+      class FooLogger < Logger; end
+
+      Happenings.configure do |config|
+        config.logger = FooLogger.new $stdout
+      end
+
+      expect(Happenings.config.logger).to be_a FooLogger
+    end
+  end
+
+  context 'when random settings are specified' do
+    it 'stores them in the config' do
+      Happenings.configure {|c| c.socks = 'pants'}
+      expect(Happenings.config.socks).to eq 'pants'
+    end
+  end
+end

data/spec/happenings/event_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+
+describe 'a happening event' do
+
+  let(:event) { Event.new }
+
+  describe '#run!' do
+    context 'when no result action is called' do
+      before { class Event; def strategy; end; end }
+
+      it 'raises an exception' do
+        expect {event.run!}.to raise_error Happenings::OutcomeError
+      end
+    end
+
+    context 'when the strategy is successful' do
+      before do
+        class Event
+          def strategy
+            success! message: 'it worked'
+          end
+        end
+      end
+
+      it 'returns true' do
+        expect(event.run!).to be
+        expect(event).to be_succeeded
+      end
+
+      it 'records the duration of the run' do
+        event.run!
+        expect(event.duration).to be > 0.0
+      end
+
+      it 'sets the message' do
+        event.run!
+        expect(event.message).to eq 'it worked'
+      end
+
+      it 'publishes the event' do
+        Happenings.config.publisher.should_receive :publish
+        event.run!
+      end
+    end
+
+    context 'when the strategy is unsuccessful' do
+      before do
+        class Event
+          def strategy
+            failure! message: 'it did not work'
+          end
+        end
+      end
+
+      it 'returns false' do
+        expect(event.run!).not_to be
+        expect(event).not_to be_succeeded
+      end
+
+      it 'records the duration of the run' do
+        event.run!
+        expect(event.duration).to be > 0.0
+      end
+
+      it 'sets the message' do
+        event.run!
+        expect(event.message).to eq 'it did not work'
+      end
+
+      it 'publishes the event' do
+        Happenings.config.publisher.should_receive :publish
+        event.run!
+      end
+    end
+  end
+
+  describe 'event publishing' do
+    let(:user) { User.new }
+    let(:password) { 'password' }
+    let(:payload) do
+      { user: { id: 2 },
+        event: 'reset_password_event',
+        reason: nil,
+        message: message,
+        succeeded: succeeded }
+    end
+    let(:properties) { { routing_key: "reset_password_event.#{outcome}" } }
+
+    context 'when the strategy is successful' do
+      let(:confirmation) { password }
+      let(:succeeded) { true }
+      let(:message) { 'Password reset successfully' }
+      let(:outcome) { 'success' }
+
+      it 'publishes the event' do
+        Happenings.config.publisher.should_receive(:publish)
+          .with(hash_including(:duration, payload), hash_including(:message_id, :timestamp, properties))
+
+        ResetPasswordEvent.new(user, password, confirmation).run!
+      end
+    end
+
+    context 'when the strategy is unsuccessful' do
+      let(:confirmation) { 'not the password' }
+      let(:succeeded) { false }
+      let(:message) { 'Password must match confirmation' }
+      let(:outcome) { 'failure' }
+
+      it 'publishes the event' do
+        Happenings.config.publisher.should_receive(:publish)
+          .with(hash_including(:duration, payload), hash_including(:message_id, :timestamp, properties))
+
+        ResetPasswordEvent.new(user, password, confirmation).run!
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+
+require 'bundler/setup'
+Bundler.require(:default, :development)
+
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+Dir["#{Dir.pwd}/spec/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/event.rb

@@ -0,0 +1,7 @@
+class Event
+  include Happenings::Event
+
+  def strategy
+  end
+
+end

data/spec/support/reset_password_event.rb

@@ -0,0 +1,35 @@
+class ResetPasswordEvent
+
+  include Happenings::Event
+
+  attr_reader :user, :new_password, :new_password_confirmation
+
+  def initialize user, new_password, new_password_confirmation
+    @user = user
+    @new_password = new_password
+    @new_password_confirmation = new_password_confirmation
+  end
+
+  def strategy
+    ensure_passwords_match and
+      reset_user_password
+  end
+
+  def payload
+    { user: { id: user.id } }
+  end
+
+
+  private
+
+  def reset_user_password
+    user.reset_password! new_password
+    success! message: 'Password reset successfully'
+  end
+
+  def ensure_passwords_match
+    new_password == new_password_confirmation or
+      failure! message: 'Password must match confirmation'
+  end
+end
+

data/spec/support/user.rb

@@ -0,0 +1,10 @@
+class User
+
+  def id
+    2
+  end
+
+  def reset_password! password
+    true
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: happenings
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Desmond Bowe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rake
+  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: 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'
+description: For use in applications where business domain events are first-class
+  citizens
+email:
+- desmondbowe@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- happenings.gemspec
+- lib/happenings.rb
+- lib/happenings/config.rb
+- lib/happenings/event.rb
+- lib/happenings/version.rb
+- spec/happenings/configuration_spec.rb
+- spec/happenings/event_spec.rb
+- spec/spec_helper.rb
+- spec/support/event.rb
+- spec/support/reset_password_event.rb
+- spec/support/user.rb
+homepage: https://github.com/desmondmonster/happenings
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Event-Driven Domain Scaffold
+test_files:
+- spec/happenings/configuration_spec.rb
+- spec/happenings/event_spec.rb
+- spec/spec_helper.rb
+- spec/support/event.rb
+- spec/support/reset_password_event.rb
+- spec/support/user.rb