Module PrivatePub
In: lib/private_pub.rb
lib/generators/private_pub/install_generator.rb
lib/private_pub/engine.rb
lib/private_pub/faye_extension.rb
lib/private_pub/view_helpers.rb

Methods

faye_app   load_config   message   publish_message   publish_to   reset_config   signature_expired?   subscription  

Classes and Modules

Module PrivatePub::Generators
Module PrivatePub::ViewHelpers
Class PrivatePub::Engine
Class PrivatePub::Error
Class PrivatePub::FayeExtension

Attributes

config  [R] 

Public Class methods

faye_app(options = {})

Returns the Faye Rack application. Any options given are passed to the Faye::RackAdapter.

load_config(filename, environment)

Loads the configuration from a given YAML file and environment (such as production)

message(channel, data)

Returns a message hash for sending to Faye

publish_message(message)

Sends the given message hash to the Faye server using Net::HTTP.

publish_to(channel, data)

Publish the given data to a specific channel. This ends up sending a Net::HTTP POST request to the Faye server.

reset_config()

Resets the configuration to the default (empty hash)

signature_expired?(timestamp)

Determine if the signature has expired given a timestamp.

subscription(options = {})

Returns a subscription hash to pass to the PrivatePub.sign call in JavaScript. Any options passed are merged to the hash.

[Validate]