rucaptcha 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 696d907bf4da18cbb818072c2c9ec9bd404e4389
-  data.tar.gz: 0e1e1629e95bf36d0689b1fff423a67773c1e0db
+  metadata.gz: 726ad396a3d2d992dd37ee322ee9624c2245a33f
+  data.tar.gz: ddcffb0566969992ab238a32eb6cd571d641b46f
 SHA512:
-  metadata.gz: 87a1455083f1eb353db3dfe94f9c94e7ae648346848d15237aaa241b01ba8e0dd496b6178375957657155ed98a3b7930c41528bcffd9d56806c79051d4e5c1f6
-  data.tar.gz: ea055d9b0de33f891d17523bcc920d245e815b731aaaeb054f7310c459bbdffa357880cdf21847d691a3eb0ce73e90766dd4345f4be2d8649d763c8fcd7e82f6
+  metadata.gz: 87dddae022cb9c3794abe475554315ae29c6f100539fc9964a023acfdbd7b601c620482f186cd484ee7cd397f2af57dd5f18b564ab54faf162b210683c3166f7
+  data.tar.gz: 2ee2e5fd0acac9b5e3d546eb6f9e16ac76dad9fac6a3cd2560b2ec51a1ef594b88c13483efbc45c7c02ee6587cd3a6d3a59046931a707bc3aef88bdbd0f404a6

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+0.2.0
+-----
+
+- Added file cache, can setup how many images you want generate by `config.cache_limit`,
+  RuCaptcha will use cache for next requests.
+  When you restart Rails processes it will generate new again and clean the old caches.
+
 0.1.4
 -----
 

data/README.md

@@ -1,6 +1,7 @@
 # RuCaptcha
 
 [![Gem Version](https://badge.fury.io/rb/rucaptcha.svg)](https://badge.fury.io/rb/rucaptcha)
+[![Build Status](https://travis-ci.org/huacnlee/rucaptcha.svg)](https://travis-ci.org/huacnlee/rucaptcha)
 
 This is a Captcha gem for Rails Applications. It runs an ImageMagick command to draw Captcha image - so it has NO performance issues or memory leak issues.
 
@@ -10,17 +11,37 @@ Idea by: https://ruby-china.org/topics/20558#reply4
 
 [中文介绍和使用说明](https://ruby-china.org/topics/27832)
 
-### Requirements
+
+## Feature
+
+- Only need `ImageMagick`, No `RMagick`, No `mini_magick`;
+- For Rails Application;
+- Simple, Easy to use;
+- File Caching for performance.
+
+## Requirements
 
 - ImageMagick
 
-### Example
+#### Ubuntu
+
+```
+sudo apt-get install imagemagick
+```
+
+#### Mac OS X
+
+```bash
+brew install imagemagick ghostscript
+```
+
+## Example
 
 ![rucaptcha1](https://cloud.githubusercontent.com/assets/5518/10726119/a844dfce-7c0b-11e5-99c3-a818f3ef3dd2.png) ![rucaptcha2](https://cloud.githubusercontent.com/assets/5518/10747608/2f2f5f10-7c92-11e5-860b-914db5695a57.png) ![rucaptcha3](https://cloud.githubusercontent.com/assets/5518/10747609/2f5bbac4-7c92-11e5-8192-4aa5dfb025b7.png) ![rucaptcha4](https://cloud.githubusercontent.com/assets/5518/10747611/2f7c6a12-7c92-11e5-8730-de7295b36dd6.png) ![rucaptcha5](https://cloud.githubusercontent.com/assets/5518/10747610/2f7a9d86-7c92-11e5-911a-44596c9aeef5.png)
 
 
 
-### Usage
+## Usage
 
 Put rucaptcha in your `Gemfile`:
 
@@ -38,6 +59,9 @@ RuCaptcha.configure do
   self.width = 180
   # Image height, default: 48
   self.height = 48
+  # Cache generated images in file store, this is config files limit, default: 100
+  # set 0 to disable file cache.
+  self.cache_limit = 100
 end
 ```
 
@@ -79,7 +103,7 @@ View `app/views/account/new.html.erb`
 </form>
 ```
 
-## Test skip captcha validation
+### Write your test skip captcha validation
 
 ```rb
 describe 'sign up and login', type: :feature do
@@ -91,7 +115,5 @@ describe 'sign up and login', type: :feature do
 end
 ```
 
-## TODO
 
-- Use [rtesseract](https://github.com/dannnylo/rtesseract) to test OCR.
 

data/lib/rucaptcha.rb

@@ -5,6 +5,7 @@ require_relative 'rucaptcha/version'
 require_relative 'rucaptcha/configuration'
 require_relative 'rucaptcha/controller_helpers'
 require_relative 'rucaptcha/view_helpers'
+require_relative 'rucaptcha/cache'
 require_relative 'rucaptcha/captcha'
 require_relative 'rucaptcha/engine'
 
@@ -13,19 +14,24 @@ module RuCaptcha
     def config
       return @config if defined?(@config)
       @config = Configuration.new
-      @config.len = 4
-      @config.width = 150
-      @config.height = 48
-      @config.implode = 0.4
+      @config.len         = 4
+      @config.width       = 150
+      @config.height      = 48
+      @config.implode     = 0.4
+      @config.cache_limit = 100
       @config
     end
 
     def configure(&block)
       config.instance_exec(&block)
+
+      # enable cache if cache_limit less than 1
+      if config.cache_limit >= 1
+        RuCaptcha::Captcha.send(:include, RuCaptcha::Cache)
+      end
     end
   end
 end
 
-
-ActionController::Base.send :include, RuCaptcha::ControllerHelpers
-ActionView::Base.send :include, RuCaptcha::ViewHelpers
+ActionController::Base.send(:include, RuCaptcha::ControllerHelpers)
+ActionView::Base.send(:include, RuCaptcha::ViewHelpers)

data/lib/rucaptcha/cache.rb

@@ -0,0 +1,44 @@
+module RuCaptcha
+  # File Cache
+  module Cache
+    extend ActiveSupport::Concern
+
+    included do
+      class << self
+        alias_method_chain :create, :cache
+        alias_method_chain :random_chars, :cache
+      end
+    end
+
+    module ClassMethods
+      def create_with_cache(code)
+        cache.fetch(code) do
+          create_without_cache(code)
+        end
+      end
+
+      def random_chars_with_cache
+        if cached_codes.length >= RuCaptcha.config.cache_limit
+          return cached_codes.sample
+        else
+          code = random_chars_without_cache
+          cached_codes << code
+          return code
+        end
+      end
+
+      def cache
+        return @cache if defined?(@cache)
+
+        cache_path = Rails.root.join('tmp', 'cache', 'rucaptcha')
+        @cache = ActiveSupport::Cache::FileStore.new(cache_path)
+        @cache.clear
+        @cache
+      end
+
+      def cached_codes
+        @cached_codes ||= []
+      end
+    end
+  end
+end

data/lib/rucaptcha/captcha.rb

@@ -2,44 +2,53 @@ require 'posix-spawn'
 
 module RuCaptcha
   class Captcha
-    def self.rand_color
-      r = rand(129).to_s(8).to_i
-      rgb = [rand(100).to_s(8), rand(100).to_s(8), rand(100).to_s(8)]
+    class << self
+      def rand_color
+        rgb = [rand(100).to_s(8), rand(100).to_s(8), rand(100).to_s(8)]
 
-      "rgba(#{rgb.join(',')},1)"
-    end
-
-    def self.create(code)
-      size = "#{RuCaptcha.config.width}x#{RuCaptcha.config.height}"
-      font_size = (RuCaptcha.config.height * 0.8).to_i
-      half_width = RuCaptcha.config.width / 2
-      half_height = RuCaptcha.config.height / 2
-      line_color = rand_color
+        "rgba(#{rgb.join(',')},1)"
+      end
 
-      chars = code.split('')
-      text_opts = []
-      text_top = (RuCaptcha.config.height - font_size) / 2
-      text_padding = 5
-      text_width = (RuCaptcha.config.width / chars.size) - text_padding * 2
-      text_left = 5
-      chars.each_with_index do |char, i|
-        text_opts << %(-fill '#{rand_color}' -draw 'text #{(text_left + text_width)  * i + text_left},#{text_top} "#{char}"')
+      def random_chars
+        chars = SecureRandom.hex(RuCaptcha.config.len / 2).downcase
+        chars.gsub!(/[0ol1]/i, (rand(8) + 2).to_s)
+        chars
       end
 
-      command = <<-CODE
-        convert -size #{size} #{text_opts.join(' ')}  \
-        -draw 'stroke #{line_color} line #{rand(10)},#{rand(20)} #{half_width + rand(half_width)},#{rand(half_height)}' \
-        -draw 'stroke #{line_color} line #{rand(10)},#{rand(25)} #{half_width + rand(half_width)},#{half_height + rand(half_height)}' \
-        -draw 'stroke #{line_color} line #{rand(10)},#{rand(30)} #{half_width + rand(half_width)},#{half_height + rand(half_height)}' \
-        -wave #{rand(2) + 2}x#{rand(2) + 1} \
-        -gravity NorthWest -sketch 1x10+#{rand(1)} -pointsize #{font_size} -weight 700 \
-        -implode #{RuCaptcha.config.implode} label:- png:-
-      CODE
-      command.strip!
-      # puts command
-      pid, stdin, stdout, stderr = POSIX::Spawn.popen4(command)
-      Process.waitpid(pid)
-      stdout.read
+      # Create Captcha image by code
+      def create(code)
+        size         = "#{RuCaptcha.config.width}x#{RuCaptcha.config.height}"
+        font_size    = (RuCaptcha.config.height * 0.8).to_i
+        half_width   = RuCaptcha.config.width / 2
+        half_height  = RuCaptcha.config.height / 2
+        line_color   = rand_color
+        chars        = code.split('')
+        text_opts    = []
+        text_top     = (RuCaptcha.config.height - font_size) / 2
+        text_padding = 5
+        text_width   = (RuCaptcha.config.width / chars.size) - text_padding * 2
+        text_left    = 5
+
+        chars.each_with_index do |char, i|
+          text_opts << %(-fill '#{rand_color}' -draw 'text #{(text_left + text_width) * i + text_left},#{text_top} "#{char}"')
+        end
+
+        command = <<-CODE
+          convert -size #{size} #{text_opts.join(' ')}  \
+          -draw 'stroke #{line_color} line #{rand(10)},#{rand(20)} #{half_width + rand(half_width)},#{rand(half_height)}' \
+          -draw 'stroke #{line_color} line #{rand(10)},#{rand(25)} #{half_width + rand(half_width)},#{half_height + rand(half_height)}' \
+          -draw 'stroke #{line_color} line #{rand(10)},#{rand(30)} #{half_width + rand(half_width)},#{half_height + rand(half_height)}' \
+          -wave #{rand(2) + 2}x#{rand(2) + 1} \
+          -gravity NorthWest -sketch 1x10+#{rand(1)} -pointsize #{font_size} -weight 700 \
+          -implode #{RuCaptcha.config.implode} label:- png:-
+        CODE
+
+        command.strip!
+        # puts command
+        pid, stdin, stdout, stderr = POSIX::Spawn.popen4(command)
+        Process.waitpid(pid)
+        stdout.read
+      end
     end
   end
 end

data/lib/rucaptcha/configuration.rb

@@ -1,5 +1,15 @@
 module RuCaptcha
   class Configuration
-    attr_accessor :width, :height, :font_size, :len, :implode
+    # Image width, default 150
+    attr_accessor :width
+    # Image height, default 48
+    attr_accessor :height
+    # Number of chars, default 4
+    attr_accessor :len
+    # implode, default 0.4
+    attr_accessor :implode
+    # Number of Captcha codes limit
+    # set 0 to disable limit and file cache, default: 100
+    attr_accessor :cache_limit
   end
 end

data/lib/rucaptcha/controller_helpers.rb

@@ -7,14 +7,8 @@ module RuCaptcha
     end
 
     def generate_rucaptcha
-      session[:_rucaptcha] = random_rucaptcha_chars
-      return RuCaptcha::Captcha.create(session[:_rucaptcha])
-    end
-
-    def random_rucaptcha_chars
-      chars = SecureRandom.hex(RuCaptcha.config.len / 2).downcase
-      chars.gsub!(/[0ol1]/i, (rand(8) + 2).to_s)
-      chars
+      session[:_rucaptcha] = RuCaptcha::Captcha.random_chars
+      RuCaptcha::Captcha.create(session[:_rucaptcha])
     end
 
     def verify_rucaptcha?(resource = nil)

data/lib/rucaptcha/version.rb

@@ -1,3 +1,3 @@
 module RuCaptcha
-  VERSION = '0.1.4'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rucaptcha
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Jason Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-28 00:00:00.000000000 Z
+date: 2015-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: posix-spawn
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,7 @@ files:
 - config/locales/rucaptcha.zh-TW.yml
 - config/routes.rb
 - lib/rucaptcha.rb
+- lib/rucaptcha/cache.rb
 - lib/rucaptcha/captcha.rb
 - lib/rucaptcha/configuration.rb
 - lib/rucaptcha/controller_helpers.rb