event_bg_bus 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZWIwZTQxNTY3YjBiYWYxMWUyOGE3MWJmMmZhZTAzZGMyNTc5NmYwYw==
+    MzY1OWZiMGZiNGRkMjkyY2YzZTdiMTE4NjZhODcyNTZhNTM4ZmVmNQ==
   data.tar.gz: !binary |-
-    M2NjYzhiOTIwMzE2MDIxN2M1ZTRjZTYyM2I0YmYyZWMxMDllN2E2ZQ==
+    YjcwZGQwZGM4Y2Y4MzRmNzMwOTEzZTgwYjA5MjZjMDQ5YjExNDM2Mw==
 SHA512:
   metadata.gz: !binary |-
-    NmVmZDBhZjE3NTE2Y2JjMTJhOGM4YWMzMTQ3NzVhNmE0ZDJlMzcwYzQ1OWU2
-    YmQ1YWY0MTNkMzk5MjE4N2QxY2U1YTk4YzM0NWYzM2MyNWFjMTA4ZjdjOTVl
-    Y2IxMzBmMDlkMWU0MWQ3N2Q1NDEyMGI2NzE5YThkMTBhMTVlODk=
+    MDkzZTY1ZDNjNmQ4MmZkNWIxYmZhYzEwMmY4ZmFlYWI4N2FkYTVjMGQ1MTRi
+    OTMwYzZhNzM3MTA2NTcwYTNmMGE4YmQzYTViOTI4YmIxMDllZTczNTkwNmYz
+    YTkwMTJlY2I3MmI4MDU5ZGFiYmM1ZmQxMTBhOWI4YmMxMGE4OTg=
   data.tar.gz: !binary |-
-    ZTUxYzRiYWFhMjJiYzlmMWQ3NjVmMjZhODFiNWI3YjljNTNkYTUzODAxMDg0
-    MjdiZWI3OTY1YWQyY2ViZmE4OWZlMWQ3OWI0NTE0ODE0NmJjNTFjMzAxZDY2
-    YTlmODgxYjg0NTZmZGQzNzkwMmY0ZjRmOThmOTllZjA1ZmJhYTc=
+    NDk0Y2Q1OWE2NjJlYmIzZWE2YWNlMzFjMDg3MDA5YTY2NzY1ODEzNzBhYTkz
+    ODZmZjE2ZGEyY2VhMDdkNGE4MDg4NzdmNDFiOWFiYmQ1YzZiNGM1YmM0Njlm
+    NGMzMTM4MDg4NWM2YWVkMzNiMWVkNzUxMzU2MWUyOTcwMzM4ODA=

data/README.md

@@ -3,8 +3,11 @@
 A simple pubsub event bus for Ruby applications.
 
 [![Build Status](https://travis-ci.org/artmees/event_bus.svg?branch=master)](https://travis-ci.org/artmees/event_bus)
+[![Code Climate](https://codeclimate.com/github/artmees/event_bus.png)](https://codeclimate.com/github/artmees/event_bus)
 
-* Source code: <https://github.com/artmees/event_bus>
+* Gem: <https://rubygems.org/gems/event_bg_bus>
+* Docs: <http://rubydoc.info/github/artmees/event_bg_bus/master/frames>
+* Source code: <https://github.com/artmees/event_bg_bus>
 
 ## Features
 
@@ -18,10 +21,17 @@ A simple pubsub event bus for Ruby applications.
 
 ## Installation
 
+Install the gem
+```
+gem install 'event_bg_bus'
+```
+
 Add it to your Gemfile and run `bundle`.
 
 ``` ruby
 gem 'event_bus', github: 'artmees/event_bus'
+# or
+gem 'event_bg_bus'
 ```
 
 ## Usage
@@ -121,21 +131,20 @@ There are three ways to subscribe to events.
 
 #### Subscribe to background published events
 
-due to a limitation using [Sidekiq](https://github.com/mperham/sidekiq),
-you can not subscribe to events published using `bg_announce` using Symbols in either `event_name` or `payload`.
+due to some [Sidekiq](https://github.com/mperham/sidekiq) limitations with background jobs.
+you can not subscribe to events published by `EventBGBus` using Symbols in either `event_name` or `payload`.
 you can via Reqexp, Strings or listener objects.
 
+```ruby
+EventBus.subscribe('order_placed', StatsRecorder.new, :print_order)
+```
 
-    ```ruby
-    EventBus.subscribe('order_placed', StatsRecorder.new, :print_order)
-    ```
-
-    ```ruby
-    EventBus.subscribe('order_placed') do |payload|
-      order = payload['order']
-      //...
-    end
-    ```
+```ruby
+EventBus.subscribe('order_placed') do |payload|
+  order = payload['order']
+  //...
+end
+```
 
 See the specs for more detailed usage scenarios.
 

data/lib/event_bg_bus.rb

@@ -10,9 +10,13 @@ class EventBGBus
     # The +event_name+ is added to the +payload+ hash (with the key +"event_name"+)
     # before being passed on to listeners.
     #
+    # note that the +payload+ hash won't be accessed using the symbol syntax
+    # so instead of using +payload[:param]+ you can only use +payload['param']
+    # this is due to sidekiq limitation with background jobs
+    #
     # @param event_name [String, Symbol] the name of your event
     # @param payload [Hash] the information you want to pass to the listeners
-    # @return [EventBus] the EventBus, ready to be called again.
+    # @return [EventBGBus] the EventBGBus, ready to be called again.
     #
     def publish(event_name, payload = {})
       case event_name

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: event_bg_bus
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-01 00:00:00.000000000 Z
+date: 2014-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -89,7 +89,7 @@ files:
 - spec/lib/event_bg_bus_spec.rb
 - spec/lib/event_bus_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/artmees/event_bus
+homepage: http://github.com/artmees/event_bg_bus
 licenses: []
 metadata: {}
 post_install_message: