happenings 0.1.0 → 0.2.0

checksums.yaml

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

data/CHANGELOG

@@ -0,0 +1,6 @@
+== 0.2.0 2014-05-06
+
+ * Removed #app_name method that forced users to declare one.  You can always
+ add it back by subclassing the event_name.
+ * Retain the module nesting of event name
+

data/{LICENSE.txt → LICENSE}

@@ -1,7 +1,8 @@
-Copyright (c) 2014 Desmond Bowe
+Copyright (c) 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

data/README.md

@@ -21,7 +21,8 @@ Or install it yourself as:
 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.
+Happening Event is run and returns a generic success by default.  `#strategy` must return with
+`#success!` or `#failure!` or a `Happenings::OutcomeError` will be raised.
 
 ```
 class ResetPasswordEvent
@@ -58,8 +59,6 @@ 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 
@@ -81,9 +80,12 @@ Publishing happens automatically when `#run!` is called, regardless of the strat
 `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'.
+`routing_key`: The routable description of the event.  Defaults to `#{event_name}.#{outcome}`, where outcome is either 'success' or 'failure'.
+You can override this to use your own routing scheme, but you'll probably just want to augment it by
+calling `"#{super}.my.details.here"`.
 
-`event_name`: A machine-filterable version of the event.  Defaults to the underscored class name.
+`event_name`: A machine-filterable version of the event.  Defaults to the underscored class name.  Override
+this to use your own naming scheme.
 
 Here's an expanded version of our Reset Password example above that includes publishing features:
 
@@ -106,7 +108,6 @@ end
 
 Happenings.configure do |config|
   config.publisher = MyEventPublisher.new
-  config.app_name = 'my_app'
 end
 
 class ResetPasswordEvent
@@ -154,7 +155,7 @@ message.inspect # => { user: { id: 2 },
                        succeeded: true }
 
 properties.inspect # => { message_id: <SecureRandom.uuid>,
-                          routing_key: 'my_app.reset_password_event.success',
+                          routing_key: 'reset_password_event.success',
                           timestamp: <Time.now.to_i> }
 ```
 
@@ -168,7 +169,6 @@ 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
 ```

data/Rakefile

@@ -1 +1 @@
-require "bundler/gem_tasks"
+require 'ritual'

data/happenings.gemspec

@@ -22,5 +22,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.5'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'ritual', '~> 0.4.1'
   spec.add_development_dependency 'rspec'
 end

data/lib/happenings/config.rb

@@ -9,7 +9,6 @@ module Happenings
     def set_default_attributes
       self.logger = default_logger
       self.publisher = default_publisher
-      self.app_name = nil
     end
 
     def method_missing method, *args

data/lib/happenings/event.rb

@@ -41,7 +41,7 @@ module Happenings
     end
 
     def routing_key
-      [routing_key_prefixes, event_name, outcome].compact.join '.'
+      [event_name, outcome].compact.join '.'
     end
 
 
@@ -53,22 +53,11 @@ module Happenings
       @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
+      self.class.to_s.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
 

data/lib/happenings/version.rb

@@ -1,3 +1,11 @@
 module Happenings
-  VERSION = "0.1.0"
+  VERSION = [0, 2, 0]
+
+  class << VERSION
+    include Comparable
+
+    def to_s
+      join('.')
+    end
+  end
 end

metadata

@@ -1,83 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: happenings
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Desmond Bowe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-05 00:00:00.000000000 Z
+date: 2014-05-06 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: ritual
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
 - !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
@@ -88,10 +102,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
+- CHANGELOG
 - Gemfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - happenings.gemspec
@@ -115,17 +130,17 @@ 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
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Event-Driven Domain Scaffold
@@ -136,3 +151,4 @@ test_files:
 - spec/support/event.rb
 - spec/support/reset_password_event.rb
 - spec/support/user.rb
+has_rdoc: