Module: Recaptcha

Defined in:
lib/recaptcha.rb,
lib/recaptcha/reply.rb,
lib/recaptcha/helpers.rb,
lib/recaptcha/railtie.rb,
lib/recaptcha/version.rb,
lib/recaptcha/configuration.rb,
lib/recaptcha/adapters/view_methods.rb,
lib/recaptcha/adapters/controller_methods.rb

Defined Under Namespace

Modules: Adapters, Helpers Classes: Configuration, Railtie, RecaptchaError, Reply, VerifyError

Constant Summary collapse

DEFAULT_TIMEOUT = 
3
VERSION = 
'5.20.1'

Class Method Summary collapse

Class Method Details

.api_verification_enterprise(query_params, body, project_id, timeout: nil) ⇒ Object 



127
128
129
130
131
132
133
134
135
 
# File 'lib/recaptcha.rb', line 127

def self.api_verification_enterprise(query_params, body, project_id, timeout: nil)
  query = URI.encode_www_form(query_params)
  uri = URI.parse("#{configuration.verify_url}/#{project_id}/assessments?#{query}")
  http_instance = http_client_for(uri: uri, timeout: timeout)
  request = Net::HTTP::Post.new(uri.request_uri)
  request['Content-Type'] = 'application/json; charset=utf-8'
  request.body = JSON.generate(body)
  JSON.parse(http_instance.request(request).body)
end

.api_verification_free(verify_hash, timeout: nil, json: false) ⇒ Object 



112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/recaptcha.rb', line 112

def self.api_verification_free(verify_hash, timeout: nil, json: false)
  if json
    uri = URI.parse(configuration.verify_url)
    request = Net::HTTP::Post.new(uri.request_uri)
    request['Content-Type'] = 'application/json; charset=utf-8'
    request.body = JSON.generate(verify_hash)
  else
    query = URI.encode_www_form(verify_hash)
    uri = URI.parse("#{configuration.verify_url}?#{query}")
    request = Net::HTTP::Get.new(uri.request_uri)
  end
  http_instance = http_client_for(uri: uri, timeout: timeout)
  JSON.parse(http_instance.request(request).body)
end

.configuration ⇒ Object

Gives access to the current Configuration.



26
27
28
 
# File 'lib/recaptcha.rb', line 26

def self.configuration
  @configuration ||= Configuration.new
end

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

Allows easy setting of multiple configuration options. See Configuration for all available options. – The temp assignment is only used to get a nicer rdoc. Feel free to remove this hack. ++

Yields:

  • (config) 


36
37
38
39
 
# File 'lib/recaptcha.rb', line 36

def self.configure
  config = configuration
  yield(config)
end

.http_client_for(uri:, timeout: nil) ⇒ Object 



97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/recaptcha.rb', line 97

def self.http_client_for(uri:, timeout: nil)
  timeout ||= DEFAULT_TIMEOUT
  http = if configuration.proxy
    proxy_server = URI.parse(configuration.proxy)
    Net::HTTP::Proxy(proxy_server.host, proxy_server.port, proxy_server.user, proxy_server.password)
  else
    Net::HTTP
  end
  instance = http.new(uri.host, uri.port)
  instance.read_timeout = instance.open_timeout = timeout
  instance.use_ssl = true if uri.port == 443

  instance
end

.invalid_response?(resp) ⇒ Boolean

Returns:

  • (Boolean) 


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

def self.invalid_response?(resp)
  resp.empty? || resp.length > configuration.response_limit || resp.length < configuration.response_minimum
end

.skip_env?(env) ⇒ Boolean

Returns:

  • (Boolean) 


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

def self.skip_env?(env)
  configuration.skip_verify_env.include?(env || configuration.default_env)
end

.verify_via_api_call(response, options) ⇒ Object 



62
63
64
65
66
67
68
 
# File 'lib/recaptcha.rb', line 62

def self.verify_via_api_call(response, options)
  if Recaptcha.configuration.enterprise
    verify_via_api_call_enterprise(response, options)
  else
    verify_via_api_call_free(response, options)
  end
end

.verify_via_api_call_enterprise(response, options) ⇒ Object 



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/recaptcha.rb', line 70

def self.verify_via_api_call_enterprise(response, options)
  site_key = options.fetch(:site_key) { configuration.site_key! }
  api_key = options.fetch(:enterprise_api_key) { configuration.enterprise_api_key! }
  project_id = options.fetch(:enterprise_project_id) { configuration.enterprise_project_id! }

  query_params = { 'key' => api_key }
  body = { 'event' => { 'token' => response, 'siteKey' => site_key } }
  body['event']['expectedAction'] = options[:action] if options.key?(:action)
  body['event']['userIpAddress'] = options[:remote_ip] if options.key?(:remote_ip)

  raw_reply = api_verification_enterprise(query_params, body, project_id, timeout: options[:timeout])
  reply = Reply.new(raw_reply, enterprise: true)
  result = reply.success?(options)
  options[:with_reply] == true ? [result, reply] : result
end

.verify_via_api_call_free(response, options) ⇒ Object 



86
87
88
89
90
91
92
93
94
95
 
# File 'lib/recaptcha.rb', line 86

def self.verify_via_api_call_free(response, options)
  secret_key = options.fetch(:secret_key) { configuration.secret_key! }
  verify_hash = { 'secret' => secret_key, 'response' => response }
  verify_hash['remoteip'] = options[:remote_ip] if options.key?(:remote_ip)

  raw_reply = api_verification_free(verify_hash, timeout: options[:timeout], json: options[:json])
  reply = Reply.new(raw_reply, enterprise: false)
  result = reply.success?(options)
  options[:with_reply] == true ? [result, reply] : result
end

.with_configuration(config) ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/recaptcha.rb', line 41

def self.with_configuration(config)
  original_config = {}

  config.each do |key, value|
    original_config[key] = configuration.send(key)
    configuration.send("#{key}=", value)
  end

  yield if block_given?
ensure
  original_config.each { |key, value| configuration.send("#{key}=", value) }
end