re_captcha 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11c1f2dd7960632efe95b32dd4f8f97011618221
-  data.tar.gz: aaffea5bf4341dbdf3066e28aa2291463d36d21b
+  metadata.gz: a1eba206968dce044b36e2eaafa4d9c8634b042a
+  data.tar.gz: de66b0441b7098cb3ccc63dcfa4c491b01356f0e
 SHA512:
-  metadata.gz: 9d8ec1ad825085efd0e1ee643896b597c048fde69dfc3753b49c81c7805901a506db0692a648abc6cd1e1b2296235720e6264fd8957ad3b9a5ef773d7f335346
-  data.tar.gz: e3a324b779f626d82963a990c35bc1bb2edfa024f2d6b0e5ee767f0c56cbf270d78ae64c997ecf3d83d7983b99bea8a48e21400333a4bbf5dd120d401823b7d6
+  metadata.gz: 392cd5eb41b0490225884e757f866bba25117d00b9954a244b4f59371d76ac5fb5620710eb998b3139b3e706a9948a8fe872f64b420f3226dd7d8795e4c40d18
+  data.tar.gz: 0432cefb448559c917bbeacbcc901eb8878dd49e2816459b87d0d68df354206e14a045d30d535b383f1e2ece04964d55289f30536b681db84afae673ebec91d0

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - "2.2"
+  - "2.1"
+  - "2.0"

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 David Jeusette
+Copyright (c) 2015 TextMaster SA
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -8,7 +8,7 @@ Run console with preloaded library with ``` rake console ```
 
 ## Getting started
 
-You first need to configure the gem.
+You may need to configure the gem with non default values:
 
 ```
 ReCaptcha.configure do |config|
@@ -18,7 +18,9 @@ end
 
 ```
 
-Other options are:
+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
@@ -44,27 +46,15 @@ The default language table is the following:
 
 ## Display
 
-To access the helpers in the views, make sure to include them in a Helper class
-such as ApplicationHelper (Rails)
+The view helpers are automatically included in a Rails app.  If you're not using Rails, include the helpers with ```include ReCaptcha::Helpers```.
 
-```
-module ApplicationHelper
-  include ReCaptcha::Helper
-end
-```
+The available helper methods are the following:
 
-Then include the script tag using this helper method in your view:
-```
-recaptcha_script(language: nil)
-```
-language is one of the locale defined in the language table.
+- ```recaptcha_script(language: nil)``` includes the script tag in the view.  Language is one of the locale defined in the language table.
 
-You can now add the reCaptcha box in your forms:
-```
-recaptcha_tags(options = {})
-```
+- ```recaptcha_tags(options = {})``` adds the reCaptcha box in the view.
 
-The options are the following:
+The options are the following (the default value is given):
 - theme: 'light'
 - type: 'image'
 - size: 'normal'
@@ -76,11 +66,9 @@ Check the reCaptcha doc for the available values (https://developers.google.com/
 
 ## Verification
 
-Assuming that your application uses Rails, verify the reCaptcha response using the method below:
-```
-recaptcha_valid?(response, remote_ip: nil, model: nil, message: nil)
-```
+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.
 
-This method can be called like this in a controller: ```ReCaptcha.client.recaptcha_valid?(...)```
 
-The response should be retrieved with ```params.fetch(:"g-recaptcha-response", "")```.  Optional args model and message allow to add an error with the given message on the :base attr of the provided model.
+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.

data/lib/re_captcha/rails/helpers.rb

@@ -14,7 +14,7 @@ module ReCaptcha
       private
 
       def add_error_on_model(model, message)
-        model.errors.add :base, message if model && message
+        model.errors.add(:base, message) if model && message
       end
     end
   end

data/lib/re_captcha/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: re_captcha
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - David Jeusette
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-17 00:00:00.000000000 Z
+date: 2015-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -75,6 +75,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE