simple_captcha_reloaded 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a0b34dbfa1c17906e1aaa726c06f77988b2a50c
-  data.tar.gz: 52b25d9225d5243a8fb64f38c16a431cb20869e5
+  metadata.gz: 0e5f1d37f89ed951fc718c423cd74d9e9b77cbd0
+  data.tar.gz: 6d04338634f0bcb29985dbd7b0fc6042402c33c4
 SHA512:
-  metadata.gz: b783a5cc40dec2af2d423600b632681a7df1436c71e6ee7beb882f907555a1b2eb5013966f677ea5e6ac7d32c2783d5a0c54d865651e30c3a782387f810ef829
-  data.tar.gz: c05b24ccb8fce886dc2a9f13a9578c064465c3423aeac1f8f4e029614188cd872c9fc92e0dd949ebd64410e2a3628ca3a85ddfca8949e277f1ce5fae4dd02492
+  metadata.gz: f6dc2a2eeea08c9faea959ec80c031af293fb3310cb11dc2d07115e5dc345dace2adfdeedb0f6a8e43fe8f7cb6a0c81a5da772b0ec0e6d3e1284aa3576f47180
+  data.tar.gz: d8b180bd8ae8cd9b24028de3af4f95ae2ef1a05fe1d39c46e70fc855c34f0cf97500bc4d8bb7300b59ed9d12fd854e84f69795cd8513dffbb75e0120a8e65c6a

data/README.md

@@ -3,19 +3,21 @@
 [![Build Status](https://travis-ci.org/zealot128/simple_captcha_reloaded.svg?branch=master)](https://travis-ci.org/zealot128/simple_captcha_reloaded)
 [![Gem Version](https://badge.fury.io/rb/simple_captcha_reloaded.svg)](http://badge.fury.io/rb/simple_captcha_reloaded)
 
-This is a rewrite of the popular Simple-Captcha Gem. Similarily to Simple-Captcha, it provides an easy way to integrate a Captcha into a Rails appliaction. In comparison to the older Gem(s), I decided to drop support for ancient versions of Rails + Formtastic + Mongoid, but also add specs and support for SimpleForm.
+This is a rewrite of the popular Simple-Captcha Gem(s). Similarly to Simple-Captcha, it provides an easy way to integrate a Captcha into a Rails application. In comparison to the older Gem(s), I decided to drop support for ancient versions of Rails + Formtastic + Mongoid, but instead add specs, code restructuring and support for SimpleForm, with the goal, to make it even easier to use.
 
 ## Features
 
-* Works with Rails 4.1+, Ruby 2.0+ (keyword arguments)
+* Works with Rails 4.1, 4.2, Ruby 2.0+ (keyword arguments)
 * Integrated into Model validation flow
-* Optional controller integration for custom flow
-* Uses a database table to track random captchas
-* Uses imagemagick to generate the captcha and stream it to the client, without file access
+* controller integration for custom flow
+* Optional SimpleForm integration (v.3.0 and 3.1)
+* Optional Formtastic integration (v.2.3 and 3.1)
+* Uses a database table to track random captchas (pg, myqsl, sqlite tested)
+* Uses Imagemagick to generate the Captcha and stream it to the client, without file access
 
 ## Prerequisites
 
-This needs Rails (4.1+), ActiveRecord with a database (all should be fine) and imagemagick.
+This needs Rails (4.1+), ActiveRecord with a database (all should be fine) and Imagemagick installed on the server.
 
 Mac:
 
@@ -57,7 +59,7 @@ class Message < ActiveRecord::Base
 end
 ```
 
-this adds 2 new methods: ``valid_with_captcha?`` and ``save_with_captcha`` to the model. Use it like this in controller:
+this adds 2 new methods: ``valid_with_captcha?`` and ``save_with_captcha`` to the model, as well as 2 virtual attributes captcha and captcha_key. Use it like this in controller:
 
 ```ruby
 class MessagesController < ApplicationController
@@ -76,9 +78,9 @@ class MessagesController < ApplicationController
 end
 ```
 
-Make sure to whiteliste the attributes ``captcha`` and ``captcha_key`` with Strong Parameters.
+Make sure to whitelist the attributes ``captcha`` and ``captcha_key`` with Strong Parameters.
 
-To show the captcha, you can use the SimpleForm helper:
+To show the captcha, you can use the SimpleForm or Formtastic helper or roll a total custom field:
 
 ### Simple Form
 
@@ -90,9 +92,22 @@ The Gem provides a custom input for SimpleForm:
   = f.submit
 ```
 
+To use it, just require it manually anywhere in your code (config/application.rb or a initializer file):
+
+```ruby
+require 'simple_captcha_reloaded/adapters/simple_form'
+```
+
+
 ### Formtastic
 
-PLANNED
+The Formtastic adapter works exactly like the simple form one.
+
+*You can't include both at the same time, as both have the same naming schema and will load each other's adapter*
+
+```ruby
+require 'simple_captcha_reloaded/adapters/formtastic'
+```
 
 ### Manual by using default Rails view helper
 
@@ -133,7 +148,7 @@ Adjust it to your needs:
 
 ### Manual Validation
 
-Now you can call a method in your controller to check if the captcha is valid:
+Now you can call a method in your controller to check if the Captcha is valid:
 
 ```ruby
 def submit
@@ -147,6 +162,8 @@ end
 
 ## Customizing
 
+Translations: Just have a look at config/locales/simple_captcha.en.yml with defaults for German and English. Just overwrite the keys in your own translation file.
+
 ### Captcha Options
 
 ```ruby
@@ -199,3 +216,11 @@ The Gem uses **Appraisal**, to create various configuration Gem sets. For each G
 
 If you need to add new controller methods to the dummy app, have a look at ``spec/template.rb``
 
+
+## Acknowledgment
+
+This rewrite was heavy inspired by the previous SimpleCaptcha Gems (licensed under MIT) by various authors:
+
+* Sur Max
+* Igor Galeta
+* Azdaroth

data/lib/simple_captcha_reloaded/adapters/formtastic.rb

@@ -0,0 +1,42 @@
+class SimpleCaptchaInput < Formtastic::Inputs::StringInput
+  def to_html
+    set_options!
+    captcha = SimpleCaptchaReloaded.generate_captcha(id: options[:captcha][:id], request: template.request)
+    input_wrapping do
+      label_html <<
+      image_tag(captcha) <<
+      captcha_key(captcha) <<
+      builder.text_field(method, input_html_options) <<
+      refresh_button(captcha)
+    end
+  end
+
+  def set_options!
+    default_options = {
+      refresh_button: true,
+      id: 'simple_captcha_wrapper'
+    }
+    options[:wrapper_html] ||= {}
+    options[:captcha] ||= {}
+    options[:captcha].reverse_merge!(default_options)
+    options[:wrapper_html][:id] ||= options[:captcha][:id]
+  end
+
+  def image_tag(captcha)
+    template.content_tag(:img, nil, src: captcha[:captcha_url], alt: 'Captcha', class: 'simple-captcha-image')
+  end
+
+  def captcha_key(captcha)
+    builder.hidden_field :captcha_key, value: captcha[:captcha_id]
+  end
+
+  def refresh_button(captcha)
+    template.content_tag :div, class: 'simple-captcha-reload' do
+      template.link_to captcha[:refresh_url], class: options[:captcha][:refresh_button_class], data: {remote: true} do
+        I18n.t('simple_captcha_reloaded.refresh_button_html')
+      end
+    end
+  end
+
+
+end

data/lib/simple_captcha_reloaded/adapters/simple_form.rb

@@ -4,7 +4,7 @@ superclass = SimpleForm::Inputs::StringInput
 if defined?(StringInput)
   superclass = StringInput
 end
-class SimpleCaptchaInput < superclass
+class SimpleForm::Inputs::SimpleCaptchaInput < superclass
   def input(wrapper_options=nil)
     set_options
     @captcha = SimpleCaptchaReloaded.generate_captcha(id: options[:captcha][:id], request: template.request)

data/lib/simple_captcha_reloaded/engine.rb

@@ -5,8 +5,10 @@ module SimpleCaptchaReloaded
     isolate_namespace SimpleCaptchaReloaded
     initializer "simple_captcha.load" do |app|
       ActiveSupport.on_load :action_controller do
-        helper SimpleCaptchaReloaded::ViewHelper
-        ActionController::Base.send(:include, SimpleCaptchaReloaded::ControllerHelper)
+        if defined?(helper)
+          helper SimpleCaptchaReloaded::ViewHelper
+          ActionController::Base.send(:include, SimpleCaptchaReloaded::ControllerHelper)
+        end
       end
       app.middleware.use SimpleCaptchaReloaded::Middleware
     end
@@ -14,7 +16,9 @@ module SimpleCaptchaReloaded
       if defined?(SimpleForm)
         require 'simple_captcha_reloaded/adapters/simple_form'
       end
+      if defined?(Formtastic)
+        require 'simple_captcha_reloaded/adapters/formtastic'
+      end
     end
-
   end
 end

data/lib/simple_captcha_reloaded/version.rb

@@ -1,3 +1,3 @@
 module SimpleCaptchaReloaded
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: simple_captcha_reloaded
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Stefan Wienert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-02 00:00:00.000000000 Z
+date: 2017-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.1'
 - !ruby/object:Gem::Dependency
@@ -199,6 +199,7 @@ files:
 - config/routes.rb
 - db/migrate/20141129170641_create_simple_captcha_reloaded_simple_captcha_reloaded_data.rb
 - lib/simple_captcha_reloaded.rb
+- lib/simple_captcha_reloaded/adapters/formtastic.rb
 - lib/simple_captcha_reloaded/adapters/simple_form.rb
 - lib/simple_captcha_reloaded/config.rb
 - lib/simple_captcha_reloaded/controller_helper.rb
@@ -230,9 +231,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Captcha library which uses imagemagick to create captchas
 test_files: []
-has_rdoc: