fanout 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cbfb4c711d96d6478f61c7f7959cd7030d401113
-  data.tar.gz: 5d89979d357847615ecfc0b3e2c53d2e7d84ef2d
+  metadata.gz: c00a6654cc9a1afe647949d47e308e7e26a9cd3c
+  data.tar.gz: 779264dc8a6f2b90ee91ee53b4bcf91a12f15c49
 SHA512:
-  metadata.gz: cdda332116539888712e14450ff9d4a9d2b9a62714478c61d6205254722527fe8d7612266ffc2c692f33ae8db16415251ec08a8e4c9e45231b7637bb4386f444
-  data.tar.gz: 9389e44c87b24490d18ce2994c174a7bbaf36fde5762e0fbfeeda3588b861d4a625e1e64630ba54cea93223a6eb5868598bee7924f05f2f6de647889fd250407
+  metadata.gz: 6dc3caeb96825aa789e7493abe3a06c5d56412703aeb09b7c3a443d5bb53c4416c3e4f39ca9e2da10f6732b2e8047a13cf74e5d10c3720b1834908e54aeb36b6
+  data.tar.gz: 2f030df94aa915a6c5f2a55e52d6929e72a45206163c00a2cb38b941bfc0d7ed6c14c3daf7faf8654590bd162788ec7d03630a032e0422b30090ce49c525fe51

data/lib/fanout.rb

@@ -10,7 +10,19 @@ require 'thread'
 require 'pubcontrol'
 require_relative 'jsonobjectformat.rb'
 
+# The Fanout class is used for publishing messages to Fanout.io and is
+# configured with a Fanout.io realm and associated key. SSL can either
+# be enabled or disabled. As a convenience, the realm and key
+# can also be configured by setting the 'FANOUT_REALM' and 'FANOUT_KEY'
+# environmental variables. Note that unlike the PubControl class
+# there is no need to call the finish method manually, as it will
+# automatically be called when the calling program exits.
 class Fanout
+
+  # Initialize with a specified realm, key, and a boolean indicating wther
+  # SSL should be enabled or disabled. Note that if the realm and key 
+  # are omitted then the initialize method will use the 'FANOUT_REALM'
+  # and 'FANOUT_KEY' environmental variables.
   def initialize(realm=nil, key=nil, ssl=true)
     if realm.nil?
       realm = ENV['FANOUT_REALM']
@@ -21,14 +33,21 @@ class Fanout
     @realm = realm
     @key = key
     @ssl = ssl
-    at_exit { finish }
   end
 
+  # Synchronously publish the specified data to the specified channel for
+  # the configured Fanout.io realm. Optionally provide an ID and previous
+  # ID to send along with the message.
   def publish(channel, data, id=nil, prev_id=nil)
     pub = get_pubcontrol
     pub.publish(channel, Item.new(JsonObjectFormat.new(data), id, prev_id))
   end
 
+  # Asynchronously publish the specified data to the specified channel for
+  # the configured Fanout.io realm. Optionally provide an ID and previous ID
+  # to send along with the message, as well a callback method that will be
+  # called after publishing is complete and passed the result and error message
+  # if an error was encountered.
   def publish_async(channel, data, id=nil, prev_id=nil, callback=nil)
     pub = get_pubcontrol
     pub.publish_async(channel, Item.new(JsonObjectFormat.new(data), id,
@@ -37,11 +56,9 @@ class Fanout
 
   private
 
-  def finish
-    pub = get_pubcontrol
-    pub.finish
-  end
-
+  # An internal method used for retrieving the PubControl instance. The
+  # PubControl instance is saved as a thread variable and if an instance
+  # is not available when this method is called then one will be created.
   def get_pubcontrol
     if Thread.current['pubcontrol'].nil?
       if @ssl
@@ -52,6 +69,7 @@ class Fanout
       pub = PubControlClient.new(
           '%s://api.fanout.io/realm/%s' % [scheme, @realm])
       pub.set_auth_jwt({'iss' => @realm}, Base64.decode64(@key))
+      at_exit { pub.finish }
       Thread.current['pubcontrol'] = pub
     end
     return Thread.current['pubcontrol']

data/lib/jsonobjectformat.rb

@@ -7,15 +7,20 @@
 
 require 'pubcontrol'
 
+# The JSON object format used for publishing messages to Fanout.io.
 class JsonObjectFormat < Format
+
+  # Initialize with a value representing the message to be sent.
   def initialize(value)
     @value = value
   end
 
+  # The name of the format.
   def name
     return 'json-object'
   end
 
+  # The method used to export the format data.
   def export
     return @value
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fanout
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Konstantin Bokarius
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-11 00:00:00.000000000 Z
+date: 2015-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pubcontrol