aliyun_intelligent_captcha 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 62f0463a50dc9c3494408cb48a92a72bc52ca8d4a4b85377170f705cd0163b6f
+  data.tar.gz: d6be4f996f9a11b5458003aec5a42f5a8c52e5469790623ac571d6285a407c93
+SHA512:
+  metadata.gz: b552f81e4d2c44024e43c6b1567e077ca743ae1fc6d2bb9c664c02a2046e259ad37e52a8b430532a66e834b86b0c6b8c143e91c6e75a12fbbb1613177656b5f4
+  data.tar.gz: b887aa0e96dac79476f505d40327c6c220fd70fed4b729ff0c54828a599f152d7e6b36fa5bae7ac944e84e51d5f874a90a42ade38179aca321288798aa64967e

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ming
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,123 @@
+# Aliyun Intelligent Captcha
+
+Ruby gem for verifying Alibaba Cloud intelligent captcha tokens with the `VerifyIntelligentCaptcha` OpenAPI.
+
+It has no runtime dependency on the Alibaba Cloud SDK. The client signs requests with Alibaba Cloud ACS3-HMAC-SHA256 and uses Ruby's standard `Net::HTTP`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "aliyun_intelligent_captcha"
+```
+
+Then run:
+
+```sh
+bundle install
+```
+
+## Rails Configuration
+
+Create `config/initializers/aliyun_intelligent_captcha.rb`:
+
+```ruby
+AliyunIntelligentCaptcha.configure do |config|
+  config.access_key_id = ENV.fetch("ALIYUN_ACCESS_KEY_ID")
+  config.access_key_secret = ENV.fetch("ALIYUN_ACCESS_KEY_SECRET")
+  config.scene_id = ENV["ALIYUN_CAPTCHA_SCENE_ID"]
+
+  # Defaults:
+  # config.endpoint = "captcha.cn-shanghai.aliyuncs.com"
+  # config.api_version = "2023-03-05"
+  # config.open_timeout = 2
+  # config.read_timeout = 5
+end
+```
+
+You can also use Rails config:
+
+```ruby
+# config/application.rb
+config.aliyun_intelligent_captcha.access_key_id = ENV["ALIYUN_ACCESS_KEY_ID"]
+config.aliyun_intelligent_captcha.access_key_secret = ENV["ALIYUN_ACCESS_KEY_SECRET"]
+```
+
+## Usage
+
+```ruby
+result = AliyunIntelligentCaptcha.verify(
+  captcha_verify_param: params[:captcha_verify_param],
+  remote_ip: request.remote_ip
+)
+
+if result.passed?
+  # continue
+else
+  # reject request
+end
+```
+
+For Rails controllers:
+
+```ruby
+class ApplicationController < ActionController::Base
+  include AliyunIntelligentCaptcha::Rails::ControllerHelpers
+end
+
+class SessionsController < ApplicationController
+  def create
+    unless verify_aliyun_intelligent_captcha(params[:captcha_verify_param])
+      render status: :unprocessable_entity, json: { error: "captcha_failed" }
+      return
+    end
+
+    # sign in
+  end
+end
+```
+
+## Custom Fields
+
+Alibaba Cloud may add or rename request fields. Pass additional OpenAPI fields as keyword arguments:
+
+```ruby
+AliyunIntelligentCaptcha.verify(
+  captcha_verify_param: params[:captcha_verify_param],
+  scene_id: "your_scene_id",
+  user_id: current_user.id,
+  remote_ip: request.remote_ip
+)
+```
+
+Ruby snake_case keys are converted to Alibaba Cloud CamelCase keys:
+
+```ruby
+captcha_verify_param # => CaptchaVerifyParam
+remote_ip            # => RemoteIp
+```
+
+## Direct Client
+
+```ruby
+client = AliyunIntelligentCaptcha::Client.new(
+  access_key_id: "...",
+  access_key_secret: "...",
+  scene_id: "..."
+)
+
+client.verify(captcha_verify_param: "...")
+```
+
+## Error Handling
+
+Network errors and non-2xx responses raise `AliyunIntelligentCaptcha::Error` subclasses:
+
+```ruby
+begin
+  result = AliyunIntelligentCaptcha.verify(captcha_verify_param: token)
+rescue AliyunIntelligentCaptcha::ConfigurationError, AliyunIntelligentCaptcha::RequestError => error
+  Rails.logger.warn("captcha verify failed: #{error.message}")
+end
+```

data/lib/aliyun_intelligent_captcha/client.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+
+require "json"
+require "net/http"
+require "openssl"
+require "securerandom"
+require "time"
+require "uri"
+
+require_relative "configuration"
+require_relative "error"
+require_relative "result"
+
+module AliyunIntelligentCaptcha
+  class Client
+    ACTION = "VerifyIntelligentCaptcha"
+    CONTENT_TYPE = "application/json; charset=utf-8"
+    SIGNATURE_ALGORITHM = "ACS3-HMAC-SHA256"
+
+    def initialize(access_key_id:,
+                   access_key_secret:,
+                   endpoint: Configuration::DEFAULT_ENDPOINT,
+                   api_version: Configuration::DEFAULT_API_VERSION,
+                   scene_id: nil,
+                   open_timeout: Configuration::DEFAULT_OPEN_TIMEOUT,
+                   read_timeout: Configuration::DEFAULT_READ_TIMEOUT,
+                   logger: nil,
+                   http_client: nil)
+      @access_key_id = access_key_id
+      @access_key_secret = access_key_secret
+      @endpoint = endpoint
+      @api_version = api_version
+      @scene_id = scene_id
+      @open_timeout = open_timeout
+      @read_timeout = read_timeout
+      @logger = logger
+      @http_client = http_client
+    end
+
+    def verify(captcha_verify_param:, scene_id: @scene_id, **extra)
+      ensure_configured!
+
+      payload = normalize_payload(
+        extra.merge(captcha_verify_param: captcha_verify_param, scene_id: scene_id).compact
+      )
+      response = perform_request(payload)
+      Result.new(body: parse_response(response.body), status: response.code)
+    end
+
+    private
+
+    def ensure_configured!
+      raise ConfigurationError, "access_key_id is required" if blank?(@access_key_id)
+      raise ConfigurationError, "access_key_secret is required" if blank?(@access_key_secret)
+    end
+
+    def perform_request(payload)
+      uri = URI::HTTPS.build(host: @endpoint, path: "/")
+      body = JSON.generate(payload)
+      request = Net::HTTP::Post.new(uri)
+      request.body = body
+      signed_headers(body).each { |key, value| request[key] = value }
+
+      response = @http_client ? @http_client.call(request, uri) : net_http_request(uri, request)
+      validate_response!(response)
+      response
+    rescue Timeout::Error, SocketError, SystemCallError, OpenSSL::SSL::SSLError => error
+      @logger&.warn("[aliyun_intelligent_captcha] request failed: #{error.class}: #{error.message}")
+      raise RequestError, error.message
+    end
+
+    def net_http_request(uri, request)
+      Net::HTTP.start(uri.host, uri.port, use_ssl: true, open_timeout: @open_timeout, read_timeout: @read_timeout) do |http|
+        http.request(request)
+      end
+    end
+
+    def signed_headers(body)
+      content_sha256 = sha256_hex(body)
+      headers = {
+        "host" => @endpoint,
+        "content-type" => CONTENT_TYPE,
+        "x-acs-action" => ACTION,
+        "x-acs-version" => @api_version,
+        "x-acs-date" => Time.now.utc.iso8601,
+        "x-acs-signature-nonce" => SecureRandom.uuid,
+        "x-acs-content-sha256" => content_sha256
+      }
+
+      headers.merge("Authorization" => authorization(headers, content_sha256))
+    end
+
+    def authorization(headers, content_sha256)
+      signed_header_names = headers.keys.map(&:downcase).sort
+      canonical_headers = signed_header_names.map { |name| "#{name}:#{headers.fetch(name)}\n" }.join
+      signed_headers = signed_header_names.join(";")
+      canonical_request = [
+        "POST",
+        "/",
+        "",
+        canonical_headers,
+        signed_headers,
+        content_sha256
+      ].join("\n")
+      string_to_sign = "#{SIGNATURE_ALGORITHM}\n#{sha256_hex(canonical_request)}"
+      signature = OpenSSL::HMAC.hexdigest("SHA256", @access_key_secret, string_to_sign)
+
+      "#{SIGNATURE_ALGORITHM} Credential=#{@access_key_id},SignedHeaders=#{signed_headers},Signature=#{signature}"
+    end
+
+    def validate_response!(response)
+      return if response.code.to_i.between?(200, 299)
+
+      raise ResponseError, "Aliyun captcha API returned HTTP #{response.code}: #{response.body}"
+    end
+
+    def parse_response(body)
+      JSON.parse(body)
+    rescue JSON::ParserError => error
+      raise ResponseError, "invalid JSON response: #{error.message}"
+    end
+
+    def normalize_payload(payload)
+      payload.each_with_object({}) do |(key, value), normalized|
+        normalized[camelize(key.to_s)] = value
+      end
+    end
+
+    def camelize(value)
+      value.split("_").map(&:capitalize).join
+    end
+
+    def sha256_hex(value)
+      OpenSSL::Digest::SHA256.hexdigest(value)
+    end
+
+    def blank?(value)
+      value.nil? || value.to_s.strip.empty?
+    end
+  end
+end

data/lib/aliyun_intelligent_captcha/configuration.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module AliyunIntelligentCaptcha
+  class Configuration
+    DEFAULT_ENDPOINT = "captcha.cn-shanghai.aliyuncs.com"
+    DEFAULT_API_VERSION = "2023-03-05"
+    DEFAULT_OPEN_TIMEOUT = 2
+    DEFAULT_READ_TIMEOUT = 5
+
+    attr_accessor :access_key_id,
+                  :access_key_secret,
+                  :endpoint,
+                  :api_version,
+                  :scene_id,
+                  :open_timeout,
+                  :read_timeout,
+                  :logger
+
+    def initialize
+      @endpoint = DEFAULT_ENDPOINT
+      @api_version = DEFAULT_API_VERSION
+      @open_timeout = DEFAULT_OPEN_TIMEOUT
+      @read_timeout = DEFAULT_READ_TIMEOUT
+    end
+
+    def to_h
+      {
+        access_key_id: access_key_id,
+        access_key_secret: access_key_secret,
+        endpoint: endpoint,
+        api_version: api_version,
+        scene_id: scene_id,
+        open_timeout: open_timeout,
+        read_timeout: read_timeout,
+        logger: logger
+      }
+    end
+  end
+end

data/lib/aliyun_intelligent_captcha/error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module AliyunIntelligentCaptcha
+  class Error < StandardError; end
+  class ConfigurationError < Error; end
+  class RequestError < Error; end
+  class ResponseError < Error; end
+end

data/lib/aliyun_intelligent_captcha/rails/controller_helpers.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module AliyunIntelligentCaptcha
+  module Rails
+    module ControllerHelpers
+      def verify_aliyun_intelligent_captcha(captcha_verify_param, **extra)
+        AliyunIntelligentCaptcha.verify(
+          captcha_verify_param: captcha_verify_param,
+          remote_ip: request.remote_ip,
+          **extra
+        ).passed?
+      end
+    end
+  end
+end

data/lib/aliyun_intelligent_captcha/railtie.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "rails/railtie"
+
+require_relative "configuration"
+require_relative "rails/controller_helpers"
+
+module AliyunIntelligentCaptcha
+  class Railtie < Rails::Railtie
+    config.aliyun_intelligent_captcha = Configuration.new
+
+    initializer "aliyun_intelligent_captcha.configure" do |app|
+      AliyunIntelligentCaptcha.configure do |config|
+        app.config.aliyun_intelligent_captcha.to_h.each do |key, value|
+          config.public_send("#{key}=", value)
+        end
+      end
+      AliyunIntelligentCaptcha.reset_client!
+    end
+  end
+end

data/lib/aliyun_intelligent_captcha/result.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module AliyunIntelligentCaptcha
+  class Result
+    attr_reader :body, :status
+
+    def initialize(body:, status:)
+      @body = body
+      @status = status.to_i
+    end
+
+    def passed?
+      truthy?(fetch_value("VerifyResult")) ||
+        truthy?(fetch_value("Passed")) ||
+        truthy?(fetch_value("Result")) ||
+        success_code?
+    end
+
+    def request_id
+      fetch_value("RequestId")
+    end
+
+    def code
+      fetch_value("Code")
+    end
+
+    def message
+      fetch_value("Message")
+    end
+
+    private
+
+    def fetch_value(key)
+      body[key] || body[underscore(key)]
+    end
+
+    def underscore(value)
+      value.gsub(/([a-z\d])([A-Z])/, "\\1_\\2").downcase
+    end
+
+    def success_code?
+      code.to_s.casecmp("OK").zero? || code.to_s == "200"
+    end
+
+    def truthy?(value)
+      value == true || value.to_s.casecmp("true").zero? || value.to_s == "1"
+    end
+  end
+end

data/lib/aliyun_intelligent_captcha/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AliyunIntelligentCaptcha
+  VERSION = "0.1.0"
+end

data/lib/aliyun_intelligent_captcha.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "aliyun_intelligent_captcha/client"
+require_relative "aliyun_intelligent_captcha/configuration"
+require_relative "aliyun_intelligent_captcha/error"
+require_relative "aliyun_intelligent_captcha/result"
+require_relative "aliyun_intelligent_captcha/version"
+
+require_relative "aliyun_intelligent_captcha/railtie" if defined?(Rails::Railtie)
+
+module AliyunIntelligentCaptcha
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def client
+      @client ||= Client.new(**configuration.to_h)
+    end
+
+    def reset_client!
+      @client = nil
+    end
+
+    def verify(...)
+      client.verify(...)
+    end
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: aliyun_intelligent_captcha
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ming
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: A small Ruby/Rails friendly gem for verifying Alibaba Cloud intelligent
+  captcha tokens through the VerifyIntelligentCaptcha OpenAPI.
+email:
+- ming@example.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/aliyun_intelligent_captcha.rb
+- lib/aliyun_intelligent_captcha/client.rb
+- lib/aliyun_intelligent_captcha/configuration.rb
+- lib/aliyun_intelligent_captcha/error.rb
+- lib/aliyun_intelligent_captcha/rails/controller_helpers.rb
+- lib/aliyun_intelligent_captcha/railtie.rb
+- lib/aliyun_intelligent_captcha/result.rb
+- lib/aliyun_intelligent_captcha/version.rb
+homepage: https://github.com/diningcity-group/Aliyun-intelligent-captcha
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.10
+specification_version: 4
+summary: Ruby client for Alibaba Cloud VerifyIntelligentCaptcha.
+test_files: []