Module: Defender::Spammable::ClassMethods

Defined in:
lib/defender/spammable.rb

Overview

Public: Methods that will be included as class methods when including Defender::Spammable into your model.

Instance Method Summary collapse

Instance Method Details

#_defensio_keys ⇒ Object

Internal: Returns the key-attribute mapping Hash used.

This will default to DEFENSIO_KEYS, but can be modified.

The Public API has access to this through configure_defender.



77
78
79
 
# File 'lib/defender/spammable.rb', line 77

def _defensio_keys
  @_defensio_keys ||= DEFENSIO_KEYS.dup
end

#configure_defender(options) ⇒ Object

Public: Configures various Defender options.

options - The hash options used to configure Defender:

:keys      - A Hash which maps field names in the database to
             Defensio field names (optional).
:api_key   - Your Defensio API key String (optional).
:test_mode - Set this to true to enable the test mode. See
             Defender.test_mode for more information.

Examples

configure_defender :keys => { 'content' => :comment_content },
  :api_key => 'Your API key.', :test_mode => true

Returns nothing



50
51
52
53
54
55
56
 
# File 'lib/defender/spammable.rb', line 50

def configure_defender(options)
  keys = options.delete(:keys)
  _defensio_keys.merge!(keys) unless keys.nil?
  api_key = options.delete(:api_key)
  Defender.api_key = api_key unless api_key.nil?
  Defender.test_mode = options.delete(:test_mode)
end

#test_mode ⇒ Object

Deprecated: Returns whether Defender is in “test mode”.

Use Defender.test_mode instead.



61
62
63
 
# File 'lib/defender/spammable.rb', line 61

def test_mode
  Defender.test_mode
end

#test_mode=(test_mode) ⇒ Object

Deprecated: Enables/disables Defender’s test mode.

Use Defender.test_mode= instead.



68
69
70
 
# File 'lib/defender/spammable.rb', line 68

def test_mode=(test_mode)
  Defender.test_mode = test_mode
end