Module: StreamRails

Extended by:
ActiveSupport::Autoload
Defined in:
lib/stream_rails/utils/view_helpers.rb,
lib/stream_rails.rb,
lib/stream_rails/config.rb,
lib/stream_rails/enrich.rb,
lib/stream_rails/logger.rb,
lib/stream_rails/railtie.rb,
lib/stream_rails/version.rb,
lib/stream_rails/activity.rb,
lib/stream_rails/renderable.rb,
lib/stream_rails/feed_manager.rb,
lib/stream_rails/sync_policies.rb

Overview

Provides a shortcut from views to the rendering method.

Defined Under Namespace

Modules: Activity, ClassMethods, Renderable, SyncPolicy, ViewHelpers Classes: ActivityResult, Config, Enrich, FeedManager, Railtie

Constant Summary collapse

VERSION = 
'2.6.0'.freeze

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.logger ⇒ Object

Returns the value of attribute logger.



5
6
7
 
# File 'lib/stream_rails/logger.rb', line 5

def logger
  @logger
end

Class Method Details

.client ⇒ Object 



16
17
18
19
20
21
22
23
24
25
 
# File 'lib/stream_rails.rb', line 16

def self.client
  Stream::Client.new(
    config.api_key,
    config.api_secret,
    config.api_site_id,
    location: config.location,
    default_timeout: config.timeout,
    api_hostname: config.api_hostname
  )
end

.config ⇒ Object

Returns StreamRails’s configuration object.



28
29
30
 
# File 'lib/stream_rails.rb', line 28

def self.config
  @config ||= StreamRails::Config.new
end

.configure {|config| ... } ⇒ Object

Lets you set global configuration options.

All available options and their defaults are in the example below:

Examples:

Initializer for Rails

StreamRails.configure do |config|
  config.api_key      = "key"
  config.api_secret   = "secret"
  config.api_site_id  = "42"
  config.location     = "us-east"
  config.api_hostname = "stream-io-api.com"
  config.enabled      = true
end

Yields:



62
63
64
 
# File 'lib/stream_rails.rb', line 62

def self.configure(&_block)
  yield(config) if block_given?
end

.create_reference(record) ⇒ Object 



6
7
8
9
10
11
12
 
# File 'lib/stream_rails/activity.rb', line 6

def create_reference(record)
  if record.is_a?(ActiveRecord::Base) || (Object.const_defined?('Sequel') && record.is_a?(Sequel::Model))
    "#{record.class.model_name}:#{record.id}"
  else
    record.to_s unless record.nil?
  end
end

.enabled=(value) ⇒ Object

Switches StreamRails on or off.

Parameters:

  • value (Boolean) 


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

def self.enabled=(value)
  StreamRails.config.enabled = value
end

.enabled? ⇒ Boolean

Returns ‘true` if StreamRails is on, `false` otherwise. Enabled by default.

Returns:

  • (Boolean) 


41
42
43
 
# File 'lib/stream_rails.rb', line 41

def self.enabled?
  StreamRails.config.enabled
end

.feed_manager ⇒ Object

Returns StreamRails’s configuration object.



46
47
48
 
# File 'lib/stream_rails.rb', line 46

def self.feed_manager
  @feed_manager ||= StreamRails::FeedManager.new(client, config.feed_configs)
end