glebtv-simple_captcha 0.2.0 → 0.2.1

data/README.rdoc

@@ -17,18 +17,15 @@ backward compatibility with previous versions of Rails.
 
 ==Requirements
 
-* {Ruby}[http://ruby-lang.org/] >= 1.8.7
+* {Ruby}[http://ruby-lang.org/] >= 1.9
 * {Rails}[http://github.com/rails/rails] >= 3
 * ImageMagick should be installed on your machine to use this plugin.
   visit http://www.imagemagick.org/script/index.php for more details.
+* AR or mongoid
 
 ==Installation
 
-  gem "galetahub-simple_captcha", :require => "simple_captcha"
-
-or
-
-  gem 'galetahub-simple_captcha', :require => 'simple_captcha', :git => 'git://github.com/galetahub/simple-captcha.git'
+  gem "glebtv-simple_captcha", "~> 0.2.0", require: "simple_captcha"
 
 ==Setup
 

data/lib/simple_captcha.rb

@@ -6,14 +6,16 @@ module SimpleCaptcha
   autoload :ImageHelpers,      'simple_captcha/image'
   autoload :ViewHelper,        'simple_captcha/view'
   autoload :ControllerHelpers, 'simple_captcha/controller'
-  autoload :ModelHelpers,      'simple_captcha/active_record'
 
   autoload :FormBuilder,       'simple_captcha/form_builder'
   autoload :CustomFormBuilder, 'simple_captcha/formtastic'
   
   if defined?(Mongoid)
+    require 'simple_captcha/mongoid'
+    autoload :ModelHelpers,      'simple_captcha/mongoid'
     autoload :SimpleCaptchaData, 'simple_captcha/simple_captcha_data_mongoid'
   else
+    autoload :ModelHelpers,      'simple_captcha/active_record'
     autoload :SimpleCaptchaData, 'simple_captcha/simple_captcha_data_ar'
   end
   autoload :Middleware,        'simple_captcha/middleware'

data/lib/simple_captcha/engine.rb

@@ -5,8 +5,10 @@ require 'simple_captcha'
 module SimpleCaptcha
   class Engine < ::Rails::Engine
     config.before_initialize do
-      ActiveSupport.on_load :active_record do
-        ActiveRecord::Base.send(:include, SimpleCaptcha::ModelHelpers)
+      unless defined?(Mongoid)
+        ActiveSupport.on_load :active_record do
+          ActiveRecord::Base.send(:include, SimpleCaptcha::ModelHelpers)
+        end
       end
     end
 

data/lib/simple_captcha/mongoid.rb

@@ -0,0 +1,75 @@
+module SimpleCaptcha #:nodoc
+  module ModelHelpers #:nodoc
+    def self.included(base)
+      base.extend(SingletonMethods)
+    end
+
+    # To implement model based simple captcha use this method in the model as...
+    #
+    #  class User
+    #    include Mongoid::Document
+    #    include Mongoid::SimpleCaptcha
+    #    apply_simple_captcha :message => "my customized message"
+    #
+    #  end
+    #
+    # Customize the error message by using :message, the default message is "Captcha did not match".
+    # As in the applications captcha is needed with a very few cases like signing up the new user, but
+    # not every time you need to authenticate the captcha with @user.save. So as to maintain simplicity
+    # here we have the explicit method to save the instace with captcha validation as...
+    #
+    # * to validate the instance
+    #
+    #  @user.valid_with_captcha?  # whene captcha validation is required.
+    #
+    #  @user.valid?               # when captcha validation is not required.
+    #
+    # * to save the instance
+    #
+    #  @user.save_with_captcha   # whene captcha validation is required.
+    #
+    #  @user.save                # when captcha validation is not required.
+    module SingletonMethods
+      def apply_simple_captcha(options = {})
+        options = { :add_to_base => false }.merge(options)
+
+        class_attribute :simple_captcha_options
+        self.simple_captcha_options = options
+
+        unless self.is_a?(ClassMethods)
+          include InstanceMethods
+          extend ClassMethods
+
+          attr_accessor :captcha, :captcha_key
+        end
+      end
+    end
+
+    module ClassMethods
+    end
+
+    module InstanceMethods
+
+      def valid_with_captcha?
+        [valid?, is_captcha_valid?].all?
+      end
+
+      def is_captcha_valid?
+        return true if Rails.env.test?
+
+        if captcha && captcha.upcase.delete(" ") == SimpleCaptcha::Utils::simple_captcha_value(captcha_key)
+          SimpleCaptcha::Utils::simple_captcha_passed!(captcha_key)
+          return true
+        else
+          message = simple_captcha_options[:message] || I18n.t(self.class.model_name.downcase, :scope => [:simple_captcha, :message], :default => :default)
+          simple_captcha_options[:add_to_base] ? errors.add(:base, message) : errors.add(:captcha, message)
+          return false
+        end
+      end
+
+      def save_with_captcha
+        valid_with_captcha? && save(:validate => false)
+      end
+    end
+  end
+end

data/lib/simple_captcha/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module SimpleCaptcha
-  VERSION = "0.2.0".freeze
+  VERSION = "0.2.1".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glebtv-simple_captcha
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -30,6 +30,7 @@ files:
 - lib/simple_captcha/utils.rb
 - lib/simple_captcha/controller.rb
 - lib/simple_captcha/formtastic.rb
+- lib/simple_captcha/mongoid.rb
 - lib/simple_captcha/simple_captcha_data_ar.rb
 - lib/simple_captcha/engine.rb
 - lib/simple_captcha/form_builder.rb