Module: PrivatePub
- Defined in:
- lib/private_pub.rb,
lib/private_pub/engine.rb,
lib/private_pub/view_helpers.rb,
lib/private_pub/faye_extension.rb,
lib/generators/private_pub/install_generator.rb
Defined Under Namespace
Modules: Generators, ViewHelpers Classes: Engine, Error, FayeExtension
Class Attribute Summary collapse
-
.config ⇒ Object
readonly
Returns the value of attribute config.
Class Method Summary collapse
-
.faye_app(options = {}) ⇒ Object
Returns the Faye Rack application.
-
.load_config(filename, environment) ⇒ Object
Loads the configuration from a given YAML file and environment (such as production).
-
.message(channel, data) ⇒ Object
Returns a message hash for sending to Faye.
-
.publish_message(message) ⇒ Object
Sends the given message hash to the Faye server using Net::HTTP.
-
.publish_to(channel, data) ⇒ Object
Publish the given data to a specific channel.
-
.reset_config ⇒ Object
Resets the configuration to the default (empty hash).
-
.signature_expired?(timestamp) ⇒ Boolean
Determine if the signature has expired given a timestamp.
-
.subscription(options = {}) ⇒ Object
Returns a subscription hash to pass to the PrivatePub.sign call in JavaScript.
Class Attribute Details
.config ⇒ Object (readonly)
Returns the value of attribute config.
12 13 14 |
# File 'lib/private_pub.rb', line 12 def config @config end |
Class Method Details
.faye_app(options = {}) ⇒ Object
Returns the Faye Rack application. Any options given are passed to the Faye::RackAdapter.
71 72 73 74 |
# File 'lib/private_pub.rb', line 71 def faye_app( = {}) = {:mount => "/faye", :timeout => 45, :extensions => [FayeExtension.new]}.merge() Faye::RackAdapter.new() end |
.load_config(filename, environment) ⇒ Object
Loads the configuration from a given YAML file and environment (such as production)
20 21 22 23 24 |
# File 'lib/private_pub.rb', line 20 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 |
.message(channel, data) ⇒ Object
Returns a message hash for sending to Faye
46 47 48 49 50 51 52 53 54 |
# File 'lib/private_pub.rb', line 46 def (channel, data) = {:channel => channel, :data => {:channel => channel}, :ext => {:private_pub_token => config[:secret_token]}} if data.kind_of? String [:data][:eval] = data else [:data][:data] = data end end |
.publish_message(message) ⇒ Object
Sends the given message hash to the Faye server using Net::HTTP.
33 34 35 36 37 38 39 40 41 42 43 |
# File 'lib/private_pub.rb', line 33 def () raise Error, "No server specified, ensure private_pub.yml was loaded properly." unless config[:server] url = URI.parse(config[:server]) form = Net::HTTP::Post.new(url.path.empty? ? '/' : url.path) form.set_form_data(:message => .to_json) http = Net::HTTP.new(url.host, url.port) http.use_ssl = url.scheme == "https" http.start {|h| h.request(form)} end |
.publish_to(channel, data) ⇒ Object
Publish the given data to a specific channel. This ends up sending a Net::HTTP POST request to the Faye server.
28 29 30 |
# File 'lib/private_pub.rb', line 28 def publish_to(channel, data) ((channel, data)) end |
.reset_config ⇒ Object
Resets the configuration to the default (empty hash)
15 16 17 |
# File 'lib/private_pub.rb', line 15 def reset_config @config = {} end |
.signature_expired?(timestamp) ⇒ Boolean
Determine if the signature has expired given a timestamp.
65 66 67 |
# File 'lib/private_pub.rb', line 65 def signature_expired?() < ((Time.now.to_f - config[:signature_expiration])*1000).round if config[:signature_expiration] end |
.subscription(options = {}) ⇒ Object
Returns a subscription hash to pass to the PrivatePub.sign call in JavaScript. Any options passed are merged to the hash.
58 59 60 61 62 |
# File 'lib/private_pub.rb', line 58 def subscription( = {}) sub = {:server => config[:server], :timestamp => (Time.now.to_f * 1000).round}.merge() sub[:signature] = Digest::SHA1.hexdigest([config[:secret_token], sub[:channel], sub[:timestamp]].join) sub end |