Contents

##
# Main Defender module. Everything should be under this module.
module Defender
  autoload :VERSION, 'defender/version'
  autoload :Version, 'defender/version'
  autoload :Spammable, 'defender/spammable'
  autoload :DefenderError, 'defender/defender_error'
  
  ##
  # Set this to your Defensio API key. Get one at http://defensio.com.
  #
  # @see Defender::Spammable::ClassMethods.configure_defender
  #
  # @param [String] api_key The Defensio API key.
  def self.api_key=(api_key)
    @api_key = api_key.to_s
  end
  
  ##
  # Returns the Defensio API key set with {Defender.api_key=}.
  #
  # @see Defender.api_key=
  # @return [String] The API key if set.
  # @return [nil] If no API key has been set.
  def self.api_key
    @api_key
  end

  ##
  # You most probably don't need to set this.  It is used to replace the backend
  # when running the tests.  If you for any reason need to use another backend
  # than the defensio gem, set this.  The object needs to respond to the same
  # methods as the Defensio object does.
  #
  # @param [Defensio] defensio The Defensio backend
  def self.defensio=(defensio)
    @defensio = defensio
  end

  ##
  # The Defensio backend. If no backend has been set yet, this will create one
  # with the api key set with {Defender.api_key}.
  #
  # @return [Defensio] The Defensio backend
  def self.defensio
    return @defensio  if defined?(@defensio)
    require 'defensio'
    @defensio ||= Defensio.new(@api_key, "Defender | #{VERSION} | Henrik Hodne | [e-mail]")
  end

  ##
  # Calls a defensio method and wraps in error handling.
  #
  # Returns false if the method failed, otherwise returns whatever the method returns
  #
  # @param [Symbol] method Which method to call.
  # @return [false, Array(Fixnum, Hash)]
  def self.call(method, *args)
    code, data = defensio.send(method, *args)
    if code == 200 && data['status'] == 'success'
      [code, data]
    else
      false
    end
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
defender-2.0.2	lib/defender.rb
defender-2.0.1	lib/defender.rb
defender-2.0.0	lib/defender.rb
defender-2.0.0beta1	lib/defender.rb