simple_captcha2 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c89e2fec1c40f57893d53697a221bf6ba4a9c3e6
-  data.tar.gz: 0d55c4ba052d020f19877571feac77daaf8c9231
+SHA256:
+  metadata.gz: 9109eee9cbbef0caa51b63ef969186a2efe0fb479597dc97ffbc118994fc443e
+  data.tar.gz: 6c2ed7db47e7f9b5c1ec924e17af38ed44103b6aaeb39ed3a2d0bb0630c88577
 SHA512:
-  metadata.gz: 7b6168a217a5d62ede49d7ee0f9e9a5d6b43ad3e6be5cac54024ac760164a6a04f2667cee33f29d2e3a459143b344760c7f95e3e5d077af4b25e662371f807ad
-  data.tar.gz: a82a14b079d107788853cdc8caabfa94f218f1d84ba2c7daa88280eccb905af70365750f152924690f3f6bf0fd5368a3683d28ac187f8c9b04facda3e361f867
+  metadata.gz: 01b783bb207580730aea77ab63ceaa142a77361609a31c14ea728405886f71f766dd4c26f61632eb8e482d993e55ab631fa74e29311db3a8be73421066b149b5
+  data.tar.gz: 953cb66bf597f7291ec0c898d85d358f72d7a0c5970db3c5c4d019effbf5d8fc00018bb67314a361a60a36cb5c1b4e1c10d3e6b17f9089905e566d97bdd5ce7d

data/README.md

@@ -1,4 +1,4 @@
-#SimpleCaptcha2
+# SimpleCaptcha2
 
 [![Build Status](https://travis-ci.org/pludoni/simple-captcha.png?branch=master)](https://travis-ci.org/pludoni/simple-captcha)
 [![Gem Version](https://badge.fury.io/rb/simple_captcha2.svg)](https://badge.fury.io/rb/simple_captcha2)
@@ -7,7 +7,7 @@ SimpleCaptcha(2) is the simplest and a robust captcha plugin. Its implementation
 SimpleCaptcha2 is available to be used with Rails 3 + 4.
 This is a fork of the popular Rubygem ``simple_captcha`` which got abandoned.
 
-##Features
+## Features
 
 * Zero FileSystem usage (secret code moved to db-store and image storage removed).
 * Provides various image styles.
@@ -17,20 +17,28 @@ This is a fork of the popular Rubygem ``simple_captcha`` which got abandoned.
 * Flexible DOM and CSS handling(There is a separate view partial for rendering SimpleCaptcha DOM elements).
 * Automated removal of 1 hour old unmatched simple_captcha data.
 
-##Requirements
+## Requirements
 
 * Ruby >= 1.9.3
 * Rails >= 3.2
 * ImageMagick should be installed on your machine to use this plugin.
   visit http://www.imagemagick.org/script/index.php for more details.
 
-You might need to install Ghostscript on a Mac-System:
+
+
+## Installation
+
+You might need to install Ghostscript on a Mac-System or a Debian-System:
 
 ```
 brew install ghostscript
 ```
 
-##Installation
+```
+apt-get install ghostscript
+```
+
+The default font, that imagemagick uses is Arial. Make sure that font is available (``apt install ttf-mscorefonts-installer``) or change the font in the SimpleCaptcha config.
 
 Put this into your Gemfile
 
@@ -114,7 +122,7 @@ Must add them:
 :captcha, :captcha_key
 ```
 
-####Form-Builder helper
+#### Form-Builder helper
 
 ```erb
 <%= form_for @user do |form| -%>
@@ -124,7 +132,7 @@ Must add them:
 <% end -%>
 ```
 
-####Validating with captcha
+#### Validating with captcha
 
 NOTE: @user.valid? will still work as it should, it will not validate the captcha code.
 
@@ -132,7 +140,7 @@ NOTE: @user.valid? will still work as it should, it will not validate the captch
 @user.valid_with_captcha?
 ```
 
-####Saving with captcha
+#### Saving with captcha
 
 NOTE: @user.save will still work as it should, it will not validate the captcha code.
 
@@ -140,7 +148,7 @@ NOTE: @user.save will still work as it should, it will not validate the captcha
 @user.save_with_captcha
 ```
 
-###Formtastic integration
+### Formtastic integration
 
 SimpleCaptcha detects if you are using Formtastic:
 
@@ -164,16 +172,27 @@ assert_equal 1, SimpleCaptcha::SimpleCaptchaData.count
 fill_in 'captcha', with: SimpleCaptcha::SimpleCaptchaData.first.value
 ```
 
-##Options & Examples
+## ORM support
+
+simple-captcha2 supports 3 type of ORM: ActiveRecord, Sequel and Mongoid.
+
+Selection of ORM is base on loaded classes. If `ActiveRecord` is loaded then it will be used for the simple captcha data model.
+If `ActiveRecord` is undefined, `Sequel` presence is tested. If `Sequel` is defined it will used for the simple captcha data model.
+If not, `Mongoid` is used.
+
+For instance if your application is using Sequel as an ORM just make sure you require `sequel-rails` gem before `simple-captcha2`
+ in your Gemfile and respective model will be selected automatically.
+
+## Options & Examples
 
-###View Options
+### View Options
 
 * ``:label`` - provides the custom text b/w the image and the text field, the default is "type the code from the image"
 * ``:object`` - the name of the object of the model class, to implement the model based captcha.
 * ``:code_type`` - return numeric only if set to 'numeric'
 * ``:multiple`` - allow to use the same captcha in multiple forms in one page. True for the first appaerance and false for the rest.
 
-###Global options
+### Global options
 
 * ``:image_style`` - provides the specific image style for the captcha image.
 There are eight different styles available with the plugin as...
@@ -270,8 +289,8 @@ You can change the CSS of the SimpleCaptcha DOM elements as per your need in thi
 
 ``app/views/simple_captcha/_simple_captcha.erb``
 
-###View's Examples
-####Controller Based Example
+### View's Examples
+#### Controller Based Example
 
 ```erb
 <%= show_simple_captcha %>
@@ -279,19 +298,19 @@ You can change the CSS of the SimpleCaptcha DOM elements as per your need in thi
 <%= show_simple_captcha(:label => "human authentication") %>
 ```
 
-####Model Based Example
+#### Model Based Example
 
 ```erb
 <%= show_simple_captcha(:object => 'user', :label => "human authentication") %>
 ```
 
-####Model Options
+#### Model Options
 
 * ``:message`` - provides the custom message on failure of captcha authentication the default is "Secret Code did not match with the Image"
 
 * ``:add_to_base`` - if set to true, appends the error message to the base.
 
-#####Model's Example
+##### Model's Example
 
 ```ruby
 class User < ActiveRecord::Base
@@ -304,7 +323,7 @@ end
 ```
 
 
-##I18n
+## I18n
 
 ```yaml
 en:
@@ -317,7 +336,7 @@ en:
       user: "The secret Image and code were different"
 ```
 
-##Contributing
+## Contributing
 
 For testing, generate a temporary Rails dummy app inside test:
 
@@ -333,7 +352,7 @@ Please add test cases when adding new functionality. I started with some basic e
 
 The tests will be run on [Travis-CI](https://travis-ci.org/pludoni/simple-captcha).
 
-##Who's who?
+## Who's who?
 
 Enjoy the simplest captcha implementation.
 

data/Rakefile

@@ -24,8 +24,14 @@ namespace :dummy do
   task :setup do
     require 'rails'
     require 'simple_captcha'
-    require File.expand_path('../test/lib/generators/simple_captcha/dummy/dummy_generator', __FILE__)
-    SimpleCaptcha::DummyGenerator.start %w(--quiet)
+    if ENV["SEQUEL"].nil?
+      require File.expand_path('../test/lib/generators/simple_captcha/dummy/dummy_generator', __FILE__)
+      generator_class = SimpleCaptcha::DummyGenerator
+    else
+      require File.expand_path('../test/lib/generators/simple_captcha/dummy/dummy_generator_sequel', __FILE__)
+      generator_class = SimpleCaptcha::DummyGeneratorSequel
+    end
+    generator_class.start %w(--quiet)
   end
 
   desc 'destroy dummy Rails app under test/dummy'

data/lib/generators/simple_captcha_generator.rb

@@ -17,6 +17,13 @@ class SimpleCaptchaGenerator < Rails::Generators::Base
   end
 
   def create_captcha_migration
-    migration_template "migration.rb", File.join('db/migrate', "create_simple_captcha_data.rb")
+    migration_template migration_file, File.join('db/migrate', "create_simple_captcha_data.rb")
+  end
+
+  private
+
+  def migration_file
+    return "migration_sequel.rb" if defined?(Sequel)
+    Rails::VERSION::MAJOR > 4 ? "migration5.rb" : "migration.rb"
   end
 end

data/lib/generators/templates/migration5.rb

@@ -0,0 +1,15 @@
+class CreateSimpleCaptchaData < ActiveRecord::Migration[4.2]
+  def self.up
+    create_table :simple_captcha_data do |t|
+      t.string :key, :limit => 40
+      t.string :value, :limit => 6
+      t.timestamps
+    end
+
+    add_index :simple_captcha_data, :key, :name => "idx_key"
+  end
+
+  def self.down
+    drop_table :simple_captcha_data
+  end
+end

data/lib/generators/templates/migration_sequel.rb

@@ -0,0 +1,17 @@
+Sequel.migration do
+  up do
+    create_table :simple_captcha_data do
+      primary_key :id
+      String :key, size: 40
+      String :value, size: 6
+      DateTime :created_at
+      DateTime :updated_at
+
+      index :key, name: "idx_key"
+    end
+  end
+
+  down do
+    drop_table :simple_captcha_data
+  end
+end

data/lib/simple_captcha.rb

@@ -18,6 +18,8 @@ module SimpleCaptcha
 
   if defined?(ActiveRecord)
     autoload :SimpleCaptchaData, 'simple_captcha/simple_captcha_data'
+  elsif defined?(Sequel)
+    autoload :SimpleCaptchaData, 'simple_captcha/simple_captcha_data_sequel'
   else
     autoload :SimpleCaptchaData,      'simple_captcha/simple_captcha_data_mongoid.rb'
   end

data/lib/simple_captcha/image.rb

@@ -74,10 +74,10 @@ module SimpleCaptcha #:nodoc
         params << "-gravity Center"
         params << "-pointsize 22"
         params << "-implode #{ImageHelpers.implode}"
-        params << "label:#{text}"
         unless SimpleCaptcha.font.empty?
           params << "-font #{SimpleCaptcha.font}"
         end
+        params << "label:#{text}"
         if SimpleCaptcha.noise and SimpleCaptcha.noise > 0
           params << "-evaluate Uniform-noise #{SimpleCaptcha.noise}"
         end

data/lib/simple_captcha/simple_captcha_data.rb

@@ -26,6 +26,8 @@ module SimpleCaptcha
       def clear_old_data(time = 1.hour.ago)
         return unless Time === time
         where(["#{connection.quote_column_name(:updated_at)} < ?", time]).delete_all
+      rescue ActiveRecord::Deadlocked => err
+        Rails.logger.error "#{err.class} #{err.message}"
       end
     end
   end

data/lib/simple_captcha/simple_captcha_data_sequel.rb

@@ -0,0 +1,22 @@
+module SimpleCaptcha
+  class SimpleCaptchaData < Sequel::Model
+    plugin :update_or_create
+    plugin :timestamps, update_on_create: true
+
+    class << self
+      def get_data(key)
+        find_or_new(key: key)
+      end
+
+      def remove_data(key)
+        where(key: key).delete
+        clear_old_data(1.hour.ago)
+      end
+
+      def clear_old_data(time = 1.hour.ago)
+        return unless Time === time
+        where {updated_at < time}.delete
+      end
+    end
+  end
+end

data/lib/simple_captcha/version.rb

@@ -1,3 +1,3 @@
 module SimpleCaptcha
-  VERSION = "0.4.3".freeze
+  VERSION = "0.5.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_captcha2
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Pavlo Galeta
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-20 00:00:00.000000000 Z
+date: 2019-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -96,6 +96,8 @@ files:
 - lib/generators/USAGE
 - lib/generators/simple_captcha_generator.rb
 - lib/generators/templates/migration.rb
+- lib/generators/templates/migration5.rb
+- lib/generators/templates/migration_sequel.rb
 - lib/generators/templates/partial.erb
 - lib/generators/templates/partial.haml
 - lib/simple_captcha.rb
@@ -108,6 +110,7 @@ files:
 - lib/simple_captcha/model_helpers.rb
 - lib/simple_captcha/simple_captcha_data.rb
 - lib/simple_captcha/simple_captcha_data_mongoid.rb
+- lib/simple_captcha/simple_captcha_data_sequel.rb
 - lib/simple_captcha/utils.rb
 - lib/simple_captcha/version.rb
 - lib/simple_captcha/view.rb
@@ -130,8 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: SimpleCaptcha is the simplest and a robust captcha plugin.