Class: Recaptcha::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/recaptcha/configuration.rb

Overview

This class enables detailed configuration of the recaptcha services.

By calling

Recaptcha.configuration # => instance of Recaptcha::Configuration

or

Recaptcha.configure do |config|
  config # => instance of Recaptcha::Configuration
end

you are able to perform configuration updates.

Your are able to customize all attributes listed below. All values have sensitive default and will very likely not need to be changed.

Please note that the site and secret key for the reCAPTCHA API Access have no useful default value. The keys may be set via the Shell enviroment or using this configuration. Settings within this configuration always take precedence.

Setting the keys with this Configuration

Recaptcha.configure do |config|
  config.site_key  = '6Lc6BAAAAAAAAChqRbQZcn_yyyyyyyyyyyyyyyyy'
  config.secret_key = '6Lc6BAAAAAAAAKN3DRm6VA_xxxxxxxxxxxxxxxxx'
end

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeConfiguration

:nodoc:


36
37
38
39
40
41
42
43
44
# File 'lib/recaptcha/configuration.rb', line 36

def initialize #:nodoc:
  @skip_verify_env = %w[test cucumber]
  @handle_timeouts_gracefully = HANDLE_TIMEOUTS_GRACEFULLY

  @secret_key = ENV['RECAPTCHA_SECRET_KEY']
  @site_key = ENV['RECAPTCHA_SITE_KEY']
  @verify_url = nil
  @api_server_url = nil
end

Instance Attribute Details

#api_server_urlObject


54
55
56
# File 'lib/recaptcha/configuration.rb', line 54

def api_server_url
  @api_server_url || CONFIG.fetch('server_url')
end

#handle_timeouts_gracefullyObject

Returns the value of attribute handle_timeouts_gracefully


33
34
35
# File 'lib/recaptcha/configuration.rb', line 33

def handle_timeouts_gracefully
  @handle_timeouts_gracefully
end

#hostnameObject

Returns the value of attribute hostname


33
34
35
# File 'lib/recaptcha/configuration.rb', line 33

def hostname
  @hostname
end

#proxyObject

Returns the value of attribute proxy


33
34
35
# File 'lib/recaptcha/configuration.rb', line 33

def proxy
  @proxy
end

#secret_keyObject

Returns the value of attribute secret_key


33
34
35
# File 'lib/recaptcha/configuration.rb', line 33

def secret_key
  @secret_key
end

#site_keyObject

Returns the value of attribute site_key


33
34
35
# File 'lib/recaptcha/configuration.rb', line 33

def site_key
  @site_key
end

#skip_verify_envObject

Returns the value of attribute skip_verify_env


33
34
35
# File 'lib/recaptcha/configuration.rb', line 33

def skip_verify_env
  @skip_verify_env
end

#verify_urlObject


58
59
60
# File 'lib/recaptcha/configuration.rb', line 58

def verify_url
  @verify_url || CONFIG.fetch('verify_url')
end

Instance Method Details

#secret_key!Object


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

def secret_key!
  secret_key || raise(RecaptchaError, "No secret key specified.")
end

#site_key!Object


50
51
52
# File 'lib/recaptcha/configuration.rb', line 50

def site_key!
  site_key || raise(RecaptchaError, "No site key specified.")
end