re_captcha 0.1.2 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a1eba206968dce044b36e2eaafa4d9c8634b042a
-  data.tar.gz: de66b0441b7098cb3ccc63dcfa4c491b01356f0e
+SHA256:
+  metadata.gz: d8958b381d8da8041e8398e91834fd599156a20a94435e144296a949cdd48a44
+  data.tar.gz: 57704fc580ee3334a76448093e2933305a0506ec1ce53dbd07d3ad7dc4e8b4c5
 SHA512:
-  metadata.gz: 392cd5eb41b0490225884e757f866bba25117d00b9954a244b4f59371d76ac5fb5620710eb998b3139b3e706a9948a8fe872f64b420f3226dd7d8795e4c40d18
-  data.tar.gz: 0432cefb448559c917bbeacbcc901eb8878dd49e2816459b87d0d68df354206e14a045d30d535b383f1e2ece04964d55289f30536b681db84afae673ebec91d0
+  metadata.gz: 26034fd6e8d6e4a186d18603f7c7c6c83db4e8be5af94944475f711c16735fe326210b9f754a049456d9da5e1dea1de02cc774f27891cf4d6a5351b2450516c4
+  data.tar.gz: d24b6a69284dac1a173bf8a2bc9b1fe447d2d59d63cc6c9c9c12badc5bc7623d22a84298bc78f70163128e8ed8a4d418ad6a17d08e35c487f3c85ab12a8a005f

data/.travis.yml

@@ -1,5 +1,8 @@
 language: ruby
 rvm:
-  - "2.2"
-  - "2.1"
-  - "2.0"
+  - 2.4.4
+  - 2.5.3
+
+notifications:
+  flowdock:
+    secure: nK6d4SB5Ys3CBqoeavpDP60nc9m6pIcs8Bfxl07h9umYpUnY26irCY70g3kqXbR0tOj/KVaaXyuzwmYv9T+xAKNoNjaByM8xh4XLcvA/AE57q18wYrH4ttr9yRcw0pLSjvJCVD5+SiE39nplH/khOWTCsw2bO80/WZ1l9ixP6kbSTnAg7uxvSMaEPckNn76/0t7S1OLtHeTL8xUra0XUiC6rzuadg463uQa8TDxSbFfEQ4QRR+e/SyXHOXCaDjJqm9/FSGkN1A4VB3lCFshfZIP9prpQ145IpVDIfou3tkmajDGysKf3raBT6Xqa9LUzTfetvmufvyHUZDgBUwgAH5rRzquDo3yrnzY7fJ/LCorElg5odPstRbh7mKAJrel0WGys4gpCKv8WgekOKd+OLGxhClvd3Y28sol7AqKDZXIoHLOd8p5hzlzrquhLD3k0IrHivRHXmloqUSddrO28/HIVCgVYoUN/UNojPaFBgGqa6KrCmzSLda2m0j81QdcDhgH0NOWar5L460sdvoVgDC2hKKEnbJLkvdEzt3I0ZXIxeYMsF46LtkXuY7Xmg8/h+Oy4aJDBdakmwqrGejIaokf/3AybR1kP+brC0voSt0EwaDZ0AztONq0gYxu9gJrpSPwE/pOHQWe2iWnSXEiGVM297kbPSunEF6TCYWcdoOE=

data/CHANGELOG.md

@@ -1,3 +1,24 @@
-* 0.0.1
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## 0.2.2
+
+- Adding `rest-client` as a runtime dependency (#4)
+
+## 0.2.1
+
+_No changelog_
+
+## 0.1.2
+
+_No changelog_
+
+## 0.0.1
 
 - First release

data/Gemfile

@@ -4,6 +4,3 @@ gemspec
 
 gem 'rest-client'
 
-group :development do
-  gem 'rake'
-end

data/README.md

@@ -1,6 +1,11 @@
 # ReCaptcha
 
-Gem to easily use reCaptcha
+[![Build Status](https://travis-ci.org/textmaster/re_captcha.svg?branch=master)](https://travis-ci.org/textmaster/re_captcha)
+[![Code Climate](https://codeclimate.com/github/textmaster/re_captcha/badges/gpa.svg)](https://codeclimate.com/github/textmaster/re_captcha)
+
+Gem to easily use [Google reCaptcha](https://www.google.com/recaptcha/)
+
+The gem implements v2 of the reCaptcha API.
 
 Run tests with ``` rake ```
 
@@ -10,7 +15,7 @@ Run console with preloaded library with ``` rake console ```
 
 You may need to configure the gem with non default values:
 
-```
+```ruby
 ReCaptcha.configure do |config|
   config.private_key = "secret key"
   config.public_key  = "site key"
@@ -19,16 +24,16 @@ end
 ```
 
 The options are:
-- private_key (default: ENV['RECAPTCHA_PRIVATE_KEY'])
-- public_key (default: ENV['RECAPTCHA_PUBLIC_KEY'])
-- api_endpoint (default: https://www.google.com/recaptcha/)
-- skipped_env (default: ['test', 'cucumber'])
-- language_table: the table to map locale with language code
-- deny_on_error: if the Google reCaptcha API can't be accessed, deny the verification (default: false)
+- `private_key` (default: `ENV['RECAPTCHA_PRIVATE_KEY']`)
+- `public_key` (default: `ENV['RECAPTCHA_PUBLIC_KEY']`)
+- `api_endpoint` (default: https://www.google.com/recaptcha/)
+- `skipped_env` (default: `['test', 'cucumber']`)
+- `language_table`: the table to map locale with language code
+- `deny_on_error`: if the Google reCaptcha API can't be accessed, deny the verification (default: `false`)
 
 The default language table is the following:
 
-```
+```ruby
 {
   'en-US' => 'en',
   'fr-FR' => 'fr',
@@ -64,11 +69,95 @@ The options are the following (the default value is given):
 
 Check the reCaptcha doc for the available values (https://developers.google.com/recaptcha/docs/display).
 
+Here is an example that shows how to use the helpers in a view (haml)
+```ruby
+- content_for :scripts do
+  = recaptcha_script(language: I18n.locale)
+
+...
+
+= form_for @object, url: my_path, method: :post, html: { class: 'form' } do |form|
+  = form.text_area :message, placeholder: 'Message'
+  = recaptcha_tags
+  = form.submit 'Submit', class: 'submit btn blue-bg anim'
+```
+
 ## Verification
 
 Assuming that your application uses Rails, verify the reCaptcha response in your controller using the method ```recaptcha_valid?(model: nil, message: nil)```.
 
 model and message are optional and enables you to set an error message on the :base attribute of the provided model.
 
+Example
+```ruby
+def create
+  @user = User.new(user_params)
+
+  return error(t('invalid_recaptcha')) unless recaptcha_valid?
+
+  if @user.save
+    redirect_to root_path
+  else
+    error(t('user_error'))
+  end
+end
+
+private
+
+def error(message)
+  flash[:error] = message
+  render :new
+end
+```
 
 If you're not using Rails, this method can be called like this: ```ReCaptcha.client.recaptcha_valid?(response, remote_ip: nil)```.  No model nor message can be provided.
+
+## Integration with devise
+
+- Get your keys from [Google reCaptcha](https://www.google.com/recaptcha/).  The site key is the public key and the secret is the secret one.
+- Install this gem
+```ruby
+# Gemfile
+gem 're_captcha'
+```
+- Add the tags in your views.  ```recaptcha_script``` may be added in your layout view.
+```
+<%= recaptcha_script(...) %>
+
+...
+
+<%= recaptcha_tags(...) %>
+```
+- Create your own controllers that inherit from the Devise controllers.
+  - For unlocks
+  ```ruby
+  class UnlocksController < Devise::UnlocksController
+    def create
+      if recaptcha_valid?
+        super
+      else
+        self.resource = resource_class.find_or_initialize_with_errors(resource_class.unlock_keys, resource_params, :not_found)
+        flash[:error] = t("invalid_recaptcha")
+        render :new
+      end
+    end
+  end
+
+  ```
+  - For passwords
+  ```ruby
+  class PasswordsController < Devise::PasswordsController
+    def create
+      if recaptcha_valid?
+        super
+      else
+        self.resource = resource_class.find_or_initialize_with_errors(resource_class.unlock_keys, resource_params, :not_found)
+        flash[:error] = t("invalid_recaptcha")
+        render :new
+      end
+    end
+  end
+  ```
+  - etc
+
+Other examples are given on the [Devise Wiki](https://github.com/plataformatec/devise/wiki/How-To:-Use-Recaptcha-with-Devise) for [Recaptcha Gem](https://github.com/ambethia/recaptcha).  The use case is similar and examples can be easily adapted.

data/Rakefile

@@ -1,3 +1,4 @@
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 desc 'Open an irb session with ReCaptcha preloaded'

data/lib/re_captcha/application.rb

@@ -1,5 +1,4 @@
 require 're_captcha/api'
-require 're_captcha/secure_token_builder'
 
 module ReCaptcha
   module Application

data/lib/re_captcha/helpers.rb

@@ -3,7 +3,7 @@ module ReCaptcha
     def recaptcha_tags(options = {})
       html = ''
       html << %(<div class="g-recaptcha" data-sitekey="#{ReCaptcha.client.public_key}" )
-      html << %(data-stoken="#{secure_token}" #{tag_attributes(options)}></div>\n)
+      html << %(#{tag_attributes(options)}></div>\n)
       format_html(html)
     end
 
@@ -19,12 +19,6 @@ module ReCaptcha
       html.respond_to?(:html_safe) ? html.html_safe : html
     end
 
-    def secure_token
-      private_key = ReCaptcha.client.private_key
-      secure_token_builder = SecureTokenBuilder.new(private_key)
-      secure_token_builder.build
-    end
-
     def tag_attributes(theme: 'light', type: 'image', size: 'normal',
       tab_index: 0, callback: nil, expired_callback: nil)
       attributes = ''

data/lib/re_captcha/version.rb

@@ -1,3 +1,3 @@
 module ReCaptcha
-  VERSION = '0.1.2'.freeze
+  VERSION = '0.2.2'.freeze
 end

data/re_captcha.gemspec

@@ -1,10 +1,10 @@
 require File.expand_path('../lib/re_captcha/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.add_development_dependency 'rspec', '~> 3.0'
-  gem.add_development_dependency 'bundler', '~> 1.7'
-  gem.add_development_dependency 'rake', '~> 10.0'
-  gem.add_development_dependency 'webmock', '~> 1.21'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'bundler'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'webmock'
 
   gem.name = 're_captcha'
   gem.summary = 'reCaptcha helpers'
@@ -18,4 +18,6 @@ Gem::Specification.new do |gem|
 
   gem.files = `git ls-files`.split("\n")
   gem.test_files = `git ls-files -- spec/*`.split("\n")
+
+  gem.add_runtime_dependency 'rest-client', '>= 1.8.0'
 end

data/spec/re_captcha/client_spec.rb

@@ -127,7 +127,7 @@ describe ReCaptcha::Client do
       context 'with a correct response' do
 
         before(:all) do
-          body = { 'remoteip' => '', 'response' => 'correct response', 'secret' => 'bar' }
+          body = { 'remoteip' => nil, 'response' => 'correct response', 'secret' => 'bar' }
           stub_request(:post, 'https://www.google.com/recaptcha/api/siteverify')
             .with(body: body)
             .to_return(status: 200, body: { success: true }.to_json)
@@ -143,7 +143,7 @@ describe ReCaptcha::Client do
       context 'with an incorrect response' do
 
         before(:all) do
-          body = { 'remoteip' => '', 'response' => 'incorrect response', 'secret' => 'bar' }
+          body = { 'remoteip' => nil, 'response' => 'incorrect response', 'secret' => 'bar' }
           stub_request(:post, 'https://www.google.com/recaptcha/api/siteverify')
             .with(body: body)
             .to_return(status: 200, body: { success: false }.to_json)

metadata

@@ -1,71 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: re_captcha
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.2
 platform: ruby
 authors:
 - David Jeusette
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-08-19 00:00:00.000000000 Z
+date: 2024-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
 description: Google reCaptcha helpers and verifier
 email:
 - david@textmaster.com
@@ -91,20 +105,18 @@ files:
 - lib/re_captcha/exceptions.rb
 - lib/re_captcha/helpers.rb
 - lib/re_captcha/rails/helpers.rb
-- lib/re_captcha/secure_token_builder.rb
 - lib/re_captcha/version.rb
 - re_captcha.gemspec
 - spec/re_captcha/client_spec.rb
 - spec/re_captcha/configuration_spec.rb
 - spec/re_captcha/helpers_spec.rb
-- spec/re_captcha/secure_token_builder_spec.rb
 - spec/re_captcha_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/textmaster/re_captcha
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -119,15 +131,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: reCaptcha helpers
 test_files:
 - spec/re_captcha/client_spec.rb
 - spec/re_captcha/configuration_spec.rb
 - spec/re_captcha/helpers_spec.rb
-- spec/re_captcha/secure_token_builder_spec.rb
 - spec/re_captcha_spec.rb
 - spec/spec_helper.rb

data/lib/re_captcha/secure_token_builder.rb

@@ -1,45 +0,0 @@
-require 'json'
-require 'securerandom'
-require 'openssl'
-require 'base64'
-
-module ReCaptcha
-  class SecureTokenBuilder
-    def initialize(private_key)
-      @private_key = private_key
-    end
-
-    def build
-      json_token = generate_json_token
-      private_key_digest = digest_key @private_key
-      cipher = prepare_cipher private_key_digest
-      encode_token json_token, cipher
-    end
-
-    private
-
-    def encode_token(token, cipher)
-      encrypted_token = cipher.update(token) << cipher.final
-      strip_padding Base64.urlsafe_encode64(encrypted_token)
-    end
-
-    def digest_key(key)
-      Digest::SHA1.digest(key)[0...16]
-    end
-
-    def prepare_cipher(key)
-      cipher = OpenSSL::Cipher::AES128.new(:ECB)
-      cipher.encrypt
-      cipher.key = key
-      cipher
-    end
-
-    def generate_json_token
-      { session_id: SecureRandom.uuid, ts_ms: (Time.now.to_f * 1000).to_i }.to_json
-    end
-
-    def strip_padding(string)
-      string.gsub(/\=+\Z/, '')
-    end
-  end
-end

data/spec/re_captcha/secure_token_builder_spec.rb

@@ -1,25 +0,0 @@
-require 'spec_helper'
-
-describe ReCaptcha::SecureTokenBuilder do
-  let(:key) { 'my secret key' }
-  let(:instance) { described_class.new(key)}
-
-  describe 'instance' do
-    it { expect(instance).to respond_to(:build) }
-
-    describe '#build' do
-
-      it 'builds a secure token' do
-        expect(instance.build).to be_a(String)
-        expect(instance.build).not_to be_empty
-      end
-
-      it 'builds a token with a correct value' do
-        time = Time.parse("Feb 24 1981")
-        allow(Time).to receive(:now).and_return(time)
-        allow(SecureRandom).to receive(:uuid).and_return('8a180d31-c031-4258-a36f-bc4207f67bef')
-        expect(instance.build).to eq("95ZHArcXmvPlPBc6r95vSj_83vWuXuetY9KfVy4O6AszqvTE_ok6u85L74jMQYmYKtIEqjOJzUgiK9kSjEROQYHleYCsftaXldeLgxeQCFI")
-      end
-    end
-  end
-end