Module: Livefyre

Defined in:
lib/livefyre.rb,
lib/livefyre/user.rb,
lib/livefyre/site.rb,
lib/livefyre/engine.rb,
lib/livefyre/client.rb,
lib/livefyre/domain.rb,
lib/livefyre/version.rb,
lib/livefyre/helpers.rb,
lib/livefyre/comment.rb,
lib/livefyre/activity.rb,
lib/livefyre/conversation.rb,
lib/livefyre/model_extensions.rb,
lib/livefyre/controller_extensions.rb

Overview

Toplevel Livefyre namespace

Defined Under Namespace

Modules: Controller, Helpers, Model, Rails Classes: APIException, Activity, Client, Comment, Conversation, Domain, InvalidSignatureException, Site, User

Constant Summary

VERSION =
"0.1.0"

Class Method Summary (collapse)

Class Method Details

+ (Livefyre::Client) client

Retreive a singleton instance of the Livefyre client

Returns:

  • (Livefyre::Client)

    Returns Livefyre::Client instance configured with the default settings

Raises:

  • Exception if #config is nil



34
35
36
37
# File 'lib/livefyre.rb', line 34

def self.client
  raise "Invalid configuration" if @@config.nil?
  @@client ||= Livefyre::Client.new(@@config)
end

+ (Hash) config

Get the configuration object for default clients

Returns:

  • (Hash)

    Returns Hash configuration hash



26
27
28
# File 'lib/livefyre.rb', line 26

def self.config
  @@config
end

+ (nil) config=(config)

Set the default configuration object for Livefyre clients

Returns:

  • (nil)

    Returns



15
16
17
18
19
20
21
# File 'lib/livefyre.rb', line 15

def self.config=(config)
  config.keys.each do |key|
    config[(key.to_sym rescue key) || key] = config.delete(key)
  end if config.is_a? Hash
  @@config = config
  @@client = nil
end