lib/private_pub.rb in private_pub-0.3.0 vs lib/private_pub.rb in private_pub-1.0.0

@@ -8,50 +8,59 @@
   class Error < StandardError; end
 
   class << self
     attr_reader :config
 
+    # Resets the configuration to the default (empty hash)
     def reset_config
-      @config = {
-        :server => "http://localhost:9292/faye",
-        :signature_expiration => 60 * 60, # one hour
-      }
+      @config = {}
     end
 
+    # Loads the  configuration from a given YAML file and environment (such as production)
     def load_config(filename, environment)
       yaml = YAML.load_file(filename)[environment.to_s]
       raise ArgumentError, "The #{environment} environment does not exist in #{filename}" if yaml.nil?
       yaml.each { |k, v| config[k.to_sym] = v }
     end
 
-    def subscription(options = {})
-      sub = {:timestamp => (Time.now.to_f * 1000).round}.merge(options)
-      sub[:signature] = Digest::SHA1.hexdigest([config[:secret_token], sub[:channel], sub[:timestamp]].join)
-      sub
-    end
-
+    # Publish the given data to a specific channel. This ends up sending
+    # a Net::HTTP POST request to the Faye server.
     def publish_to(channel, data)
       publish_message(message(channel, data))
     end
 
+    # Sends the given message hash to the Faye server using Net::HTTP.
+    def publish_message(message)
+      raise Error, "No server specified, ensure private_pub.yml was loaded properly." unless config[:server]
+      Net::HTTP.post_form(URI.parse(config[:server]), :message => message.to_json)
+    end
+
+    # Returns a message hash for sending to Faye
     def message(channel, data)
       message = {:channel => channel, :data => {:channel => channel}, :ext => {:private_pub_token => config[:secret_token]}}
       if data.kind_of? String
         message[:data][:eval] = data
       else
         message[:data][:data] = data
       end
       message
     end
 
-    def publish_message(message)
-      Net::HTTP.post_form(URI.parse(config[:server]), :message => message.to_json)
+    # Returns a subscription hash to pass to the PrivatePub.sign call in JavaScript.
+    # Any options passed are merged to the hash.
+    def subscription(options = {})
+      sub = {:server => config[:server], :timestamp => (Time.now.to_f * 1000).round}.merge(options)
+      sub[:signature] = Digest::SHA1.hexdigest([config[:secret_token], sub[:channel], sub[:timestamp]].join)
+      sub
     end
 
+    # Determine if the signature has expired given a timestamp.
     def signature_expired?(timestamp)
       timestamp < ((Time.now.to_f - config[:signature_expiration])*1000).round if config[:signature_expiration]
     end
 
+    # Returns the Faye Rack application.
+    # Any options given are passed to the Faye::RackAdapter.
     def faye_app(options = {})
       options = {:mount => "/faye", :timeout => 45, :extensions => [FayeExtension.new]}.merge(options)
       Faye::RackAdapter.new(options)
     end
   end