class Hcaptcha::Configuration

This class enables detailed configuration of the hcaptcha services.

By calling

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

or

Hcaptcha.configure do |config|
  config # => instance of Hcaptcha::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 hCaptcha 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

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

Constants

DEFAULTS

Attributes

api_server_url[W]
default_env[RW]
handle_timeouts_gracefully[RW]
hostname[RW]
proxy[RW]
secret_key[RW]
site_key[RW]
skip_verify_env[RW]
verify_url[W]

Public Instance Methods

api_server_url() click to toggle source
# File lib/hcaptcha/configuration.rb, line 60
def api_server_url
  @api_server_url || DEFAULTS.fetch('server_url')
end
secret_key!() click to toggle source
# File lib/hcaptcha/configuration.rb, line 52
def secret_key!
  secret_key || raise(HcaptchaError, "No secret key specified.")
end
site_key!() click to toggle source
# File lib/hcaptcha/configuration.rb, line 56
def site_key!
  site_key || raise(HcaptchaError, "No site key specified.")
end
verify_url() click to toggle source
# File lib/hcaptcha/configuration.rb, line 64
def verify_url
  @verify_url || DEFAULTS.fetch('verify_url')
end