daqing_rucaptcha 3.2.1

data/lib/rucaptcha/cache.rb

@@ -0,0 +1,12 @@
+require "fileutils"
+
+module RuCaptcha
+  class << self
+    def cache
+      return @cache if defined? @cache
+
+      @cache = ActiveSupport::Cache.lookup_store(RuCaptcha.config.cache_store)
+      @cache
+    end
+  end
+end

data/lib/rucaptcha/configuration.rb

@@ -0,0 +1,21 @@
+module RuCaptcha
+  class Configuration
+    # Store Captcha code where, this config more like Rails config.cache_store
+    # default: Rails application config.cache_store
+    attr_accessor :cache_store
+    # rucaptcha expire time, default 2 minutes
+    attr_accessor :expires_in
+    # Chars length: default 5, allows: [3..7]
+    attr_accessor :length
+    # Hard mode, default: 5, allows: [1..10]
+    attr_accessor :difficulty
+    # Enable or disable strikethrough lines on captcha image, default: true
+    attr_accessor :line
+    # Enable or disable noise on captcha image, default: false
+    attr_accessor :noise
+    # Image format allow: ['jpeg', 'png', 'webp'], default: 'png'
+    attr_accessor :format
+    # skip_cache_store_check, default: false
+    attr_accessor :skip_cache_store_check
+  end
+end

data/lib/rucaptcha/controller_helpers.rb

@@ -0,0 +1,90 @@
+module RuCaptcha
+  module ControllerHelpers
+    extend ActiveSupport::Concern
+
+    included do
+      helper_method :verify_rucaptcha?
+    end
+
+    def rucaptcha_session_id
+      cookies[:_rucaptcha_session_id]
+    end
+
+    # session key of rucaptcha
+    def rucaptcha_sesion_key_key
+      warning_when_session_invalid if rucaptcha_session_id.blank?
+
+      # With https://github.com/rack/rack/commit/7fecaee81f59926b6e1913511c90650e76673b38
+      # to protected session_id into secret
+      session_id_digest = Digest::SHA256.hexdigest(rucaptcha_session_id.inspect)
+      ["rucaptcha-session", session_id_digest].join(":")
+    end
+
+    # Generate a new Captcha
+    def generate_rucaptcha
+      generate_rucaptcha_session_id
+
+      res = RuCaptcha.generate
+      session_val = {
+        code: res[0],
+        time: Time.now.to_i
+      }
+      RuCaptcha.cache.write(rucaptcha_sesion_key_key, session_val, expires_in: RuCaptcha.config.expires_in)
+      res[1]
+    end
+
+    # Verify captcha code
+    #
+    # @param [String] code the captcha code to check against
+    # @param [Boolean] keep_session true to keep the session
+    # @return [Hash] { success: true, message: "validation_ok"} or { success: false, message: "error_reason" }
+    def verify_rucaptcha?(code, keep_session)
+      store_info = RuCaptcha.cache.read(rucaptcha_sesion_key_key)
+
+      # make sure move used key
+      RuCaptcha.cache.delete(rucaptcha_sesion_key_key) unless keep_session
+
+      # Make sure session exist
+      return { success: false, message: "store_info_is_blank" } if store_info.blank?
+
+      # Make sure not expire
+      return { success: false, message: "captcha_is_expired" } if (Time.now.to_i - store_info[:time]) > RuCaptcha.config.expires_in
+
+      # Make sure parama have captcha
+      captcha = code.downcase.strip
+      actual = store_info[:code]
+
+      return { success: false, message: "captcha_is_blank" } if captcha.blank?
+      return { success: false, message: "captcha_not_match_with_#{actual}" } if captcha != actual
+
+      { success: true, message: "validation_ok" }
+    end
+
+    private
+
+    def generate_rucaptcha_session_id
+      return if rucaptcha_session_id.present?
+
+      cookies[:_rucaptcha_session_id] = {
+        value: SecureRandom.hex(16),
+        expires: 1.day
+      }
+    end
+
+    # def add_rucaptcha_validation_error
+    #   if defined?(resource) && resource && resource.respond_to?(:errors)
+    #     resource.errors.add(:base, t("rucaptcha.invalid"))
+    #   end
+    #   false
+    # end
+
+    def warning_when_session_invalid
+      return unless Rails.env.development?
+
+      Rails.logger.warn "
+        WARNING! The session.id is blank, RuCaptcha can't work properly, please keep session available.
+        More details about this: https://github.com/huacnlee/rucaptcha/pull/66
+      "
+    end
+  end
+end

data/lib/rucaptcha/engine.rb

@@ -0,0 +1,15 @@
+module RuCaptcha
+  class Engine < ::Rails::Engine
+    isolate_namespace RuCaptcha
+
+    initializer "rucaptcha.init" do |app|
+      # https://github.com/rails/rails/blob/3-2-stable/actionpack/lib/action_dispatch/routing/route_set.rb#L268
+      # `app.routes.prepend` start from Rails 3.2 - 5.0
+      app.routes.prepend do
+        mount RuCaptcha::Engine => "/rucaptcha"
+      end
+
+      RuCaptcha.check_cache_store! unless RuCaptcha.config.skip_cache_store_check
+    end
+  end
+end

data/lib/rucaptcha/errors/configuration.rb

@@ -0,0 +1,5 @@
+module RuCaptcha
+  module Errors
+    class Configuration < StandardError; end
+  end
+end

data/lib/rucaptcha/version.rb

@@ -0,0 +1,3 @@
+module RuCaptcha
+  VERSION = "3.2.1"
+end

data/lib/rucaptcha/view_helpers.rb

@@ -0,0 +1,22 @@
+module RuCaptcha
+  module ViewHelpers
+    def rucaptcha_input_tag(opts = {})
+      opts[:name] = "_rucaptcha"
+      opts[:type] = "text"
+      opts[:autocorrect] = "off"
+      opts[:autocapitalize] = "off"
+      opts[:pattern] = "[a-zA-Z0-9]*"
+      opts[:autocomplete] = "off"
+      opts[:maxlength] = RuCaptcha.config.length
+      tag(:input, opts)
+    end
+
+    def rucaptcha_image_tag(opts = {})
+      @rucaptcha_image_tag__image_path_in_this_request ||= "#{ru_captcha.root_path}?t=#{Time.now.strftime('%s%L')}"
+      opts[:class] = opts[:class] || "rucaptcha-image"
+      opts[:src] = @rucaptcha_image_tag__image_path_in_this_request
+      opts[:onclick] = "this.src = '#{ru_captcha.root_path}?t=' + Date.now();"
+      tag(:img, opts)
+    end
+  end
+end

data/lib/rucaptcha.rb

@@ -0,0 +1,86 @@
+require "rails"
+require "action_controller"
+require "active_support/all"
+
+begin
+  # load the precompiled extension file
+  ruby_version = /(\d+\.\d+)/.match(::RUBY_VERSION)
+  require_relative "rucaptcha/#{ruby_version}/rucaptcha"
+rescue LoadError
+  require "rucaptcha/rucaptcha"
+end
+
+require "rucaptcha/version"
+require "rucaptcha/configuration"
+require "rucaptcha/controller_helpers"
+require "rucaptcha/view_helpers"
+require "rucaptcha/cache"
+require "rucaptcha/engine"
+require "rucaptcha/errors/configuration"
+
+module RuCaptcha
+  class << self
+    def config
+      return @config if defined?(@config)
+
+      @config = Configuration.new
+      @config.length = 5
+      @config.difficulty = 3
+      @config.expires_in = 2.minutes
+      @config.skip_cache_store_check = false
+      @config.line = true
+      @config.noise = true
+      @config.format = "png"
+
+      @config.cache_store = if Rails.application
+                              Rails.application.config.cache_store
+                            else
+                              :mem_cache_store
+                            end
+      @config.cache_store
+      @config
+    end
+
+    def configure(&block)
+      config.instance_exec(&block)
+    end
+
+    def generate
+      length = config.length
+
+      raise RuCaptcha::Errors::Configuration, "length config error, value must in 3..7" unless length.in?(3..7)
+
+      result = RuCaptchaCore.create(length, config.difficulty || 5, config.line, config.noise, config.format)
+      [result[0].downcase, result[1].pack("c*")]
+    end
+
+    def check_cache_store!
+      cache_store = RuCaptcha.config.cache_store
+      store_name = cache_store.is_a?(Array) ? cache_store.first : cache_store
+      if %i[memory_store null_store file_store].include?(store_name)
+        RuCaptcha.config.cache_store = [:file_store, Rails.root.join("tmp/cache/rucaptcha/session")]
+
+        puts "
+
+  RuCaptcha's cache_store requirements are stored across processes and machines,
+  such as :mem_cache_store, :redis_store, or other distributed storage.
+  But your current set is #{cache_store}, it has changed to :file_store for working.
+  NOTE: :file_store is still not a good way, it only works with single server case.
+
+  Please make config file `config/initializers/rucaptcha.rb` to setup `cache_store`.
+  More infomation please read GitHub RuCaptcha README file.
+  https://github.com/huacnlee/rucaptcha
+
+"
+      end
+    end
+  end
+end
+
+ActiveSupport.on_load(:action_controller) do
+  ActionController::Base.include RuCaptcha::ControllerHelpers
+end
+
+ActiveSupport.on_load(:action_view) do
+  include RuCaptcha::ViewHelpers
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: daqing_rucaptcha
+version: !ruby/object:Gem::Version
+  version: 3.2.1
+platform: ruby
+authors:
+- David Zhang
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rb_sys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.18
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.18
+description:
+email: daqing@v8os.com
+executables: []
+extensions:
+- ext/rucaptcha/extconf.rb
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/controllers/ru_captcha/captcha_controller.rb
+- config/locales/rucaptcha.de-DE.yml
+- config/locales/rucaptcha.en.yml
+- config/locales/rucaptcha.pt-BR.yml
+- config/locales/rucaptcha.zh-CN.yml
+- config/locales/rucaptcha.zh-TW.yml
+- config/routes.rb
+- ext/rucaptcha/Cargo.lock
+- ext/rucaptcha/Cargo.toml
+- ext/rucaptcha/extconf.rb
+- ext/rucaptcha/fonts/FuzzyBubbles-Regular.ttf
+- ext/rucaptcha/fonts/Handlee-Regular.ttf
+- ext/rucaptcha/src/captcha.rs
+- ext/rucaptcha/src/lib.rs
+- ext/rucaptcha/target/release/build/clang-sys-f87b799a4d35af4b/out/common.rs
+- ext/rucaptcha/target/release/build/clang-sys-f87b799a4d35af4b/out/dynamic.rs
+- ext/rucaptcha/target/release/build/clang-sys-f87b799a4d35af4b/out/macros.rs
+- ext/rucaptcha/target/release/build/num-bigint-34c75daf72c2b049/out/radix_bases.rs
+- ext/rucaptcha/target/release/build/rb-sys-6bdd5b2895b9570a/out/bindings-0.9.78-arm64-darwin22-3.2.2.rs
+- ext/rucaptcha/target/release/build/typenum-f3872660002fb991/out/consts.rs
+- ext/rucaptcha/target/release/build/typenum-f3872660002fb991/out/op.rs
+- ext/rucaptcha/target/release/build/typenum-f3872660002fb991/out/tests.rs
+- lib/rucaptcha.rb
+- lib/rucaptcha/cache.rb
+- lib/rucaptcha/configuration.rb
+- lib/rucaptcha/controller_helpers.rb
+- lib/rucaptcha/engine.rb
+- lib/rucaptcha/errors/configuration.rb
+- lib/rucaptcha/version.rb
+- lib/rucaptcha/view_helpers.rb
+homepage: https://github.com/daqing/rucaptcha
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Captcha Gem for Rails, which generates captcha image by Rust.
+test_files: []