module Recaptcha::ClientHelper

Public Class Methods

recaptcha_components(options = {}) click to toggle source
# File lib/recaptcha/client_helper.rb, line 67
def self.recaptcha_components(options = {})
  html = ''.dup
  attributes = {}
  fallback_uri = ''.dup

  # Since leftover options get passed directly through as tag
  # attributes, we must unconditionally delete all our options
  options = options.dup
  env = options.delete(:env)
  class_attribute = options.delete(:class)
  site_key = options.delete(:site_key)
  hl = options.delete(:hl).to_s
  nonce = options.delete(:nonce)
  skip_script = (options.delete(:script) == false)
  data_attributes = {}
  [:badge, :theme, :type, :callback, :expired_callback, :error_callback, :size, :tabindex].each do |data_attribute|
    value = options.delete(data_attribute)
    data_attributes["data-#{data_attribute.to_s.tr('_', '-')}"] = value if value
  end

  unless Recaptcha::Verify.skip?(env)
    site_key ||= Recaptcha.configuration.site_key!
    script_url = Recaptcha.configuration.api_server_url
    script_url += "?hl=#{hl}" unless hl == ""
    nonce_attr = " nonce='#{nonce}'" if nonce
    html << %(<script src="#{script_url}" async defer#{nonce_attr}></script>\n) unless skip_script
    fallback_uri = %(#{script_url.chomp(".js")}/fallback?k=#{site_key})
    attributes["data-sitekey"] = site_key
    attributes.merge! data_attributes
  end

  # Append whatever that's left of options to be attributes on the tag.
  attributes["class"] = "g-recaptcha #{class_attribute}"
  tag_attributes = attributes.merge(options).map { |k, v| %(#{k}="#{v}") }.join(" ")

  [html, tag_attributes, fallback_uri]
end

Public Instance Methods

invisible_recaptcha_tags(options = {}) click to toggle source

Invisible reCAPTCHA implementation

# File lib/recaptcha/client_helper.rb, line 51
def invisible_recaptcha_tags(options = {})
  options = {callback: 'invisibleRecaptchaSubmit', ui: :button}.merge options
  text = options.delete(:text)
  html, tag_attributes = Recaptcha::ClientHelper.recaptcha_components(options)
  html << recaptcha_default_callback(options) if recaptcha_default_callback_required?(options)
  case options[:ui]
  when :button
    html << %(<button type="submit" #{tag_attributes}>#{text}</button>\n)
  when :invisible
    html << %(<div data-size="invisible" #{tag_attributes}></div>\n)
  else
    raise(RecaptchaError, "ReCAPTCHA ui `#{options[:ui]}` is not valid.")
  end
  html.respond_to?(:html_safe) ? html.html_safe : html
end
recaptcha_tags(options = {}) click to toggle source

Your public API can be specified in the options hash or preferably using the Configuration.

# File lib/recaptcha/client_helper.rb, line 7
    def recaptcha_tags(options = {})
      if options.key?(:stoken)
        raise(RecaptchaError, "Secure Token is deprecated. Please remove 'stoken' from your calls to recaptcha_tags.")
      end
      if options.key?(:ssl)
        raise(RecaptchaError, "SSL is now always true. Please remove 'ssl' from your calls to recaptcha_tags.")
      end

      noscript = options.delete(:noscript)

      html, tag_attributes, fallback_uri = Recaptcha::ClientHelper.recaptcha_components(options)
      html << %(<div #{tag_attributes}></div>\n)

      if noscript != false
        html << <<-HTML
          <noscript>
            <div>
              <div style="width: 302px; height: 422px; position: relative;">
                <div style="width: 302px; height: 422px; position: absolute;">
                  <iframe
                    src="#{fallback_uri}"
                    scrolling="no" name="ReCAPTCHA"
                    style="width: 302px; height: 422px; border-style: none; border: 0;">
                  </iframe>
                </div>
              </div>
              <div style="width: 300px; height: 60px; border-style: none;
                bottom: 12px; left: 25px; margin: 0px; padding: 0px; right: 25px;
                background: #f9f9f9; border: 1px solid #c1c1c1; border-radius: 3px;">
                <textarea id="g-recaptcha-response" name="g-recaptcha-response"
                  class="g-recaptcha-response"
                  style="width: 250px; height: 40px; border: 1px solid #c1c1c1;
                  margin: 10px 25px; padding: 0px; resize: none;">
                </textarea>
              </div>
            </div>
          </noscript>
        HTML
      end

      html.respond_to?(:html_safe) ? html.html_safe : html
    end

Private Instance Methods

recaptcha_default_callback(options = {}) click to toggle source
# File lib/recaptcha/client_helper.rb, line 107
    def recaptcha_default_callback(options = {})
      nonce = options[:nonce]
      nonce_attr = " nonce='#{nonce}'" if nonce

      <<-HTML
        <script#{nonce_attr}>
          var invisibleRecaptchaSubmit = function () {
            var closestForm = function (ele) {
              var curEle = ele.parentNode;
              while (curEle.nodeName !== 'FORM' && curEle.nodeName !== 'BODY'){
                curEle = curEle.parentNode;
              }
              return curEle.nodeName === 'FORM' ? curEle : null
            };

            var eles = document.getElementsByClassName('g-recaptcha');
            if (eles.length > 0) {
              var form = closestForm(eles[0]);
              if (form) {
                form.submit();
              }
            }
          };
        </script>
      HTML
    end
recaptcha_default_callback_required?(options) click to toggle source
# File lib/recaptcha/client_helper.rb, line 134
def recaptcha_default_callback_required?(options)
  options[:callback] == 'invisibleRecaptchaSubmit' &&
  !Recaptcha::Verify.skip?(options[:env]) &&
  options[:script] != false
end