private_captcha 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d114ffe4accff4d744e8a31c2a4db2e19a8415536f90edb03646c84a7d00c16
-  data.tar.gz: ac3306f495d28e9af4fde26cc041384ae6fe921755df621dbccca5691235fd17
+  metadata.gz: 633ba6ed9f1e744f7198bb02c280a219ee4cf88773b68507c6eec0a43e4b9ac7
+  data.tar.gz: 2fa1a08ffc72014ca32080b52fcd71bf2427c25c11ff1f0901c549350d28e1b9
 SHA512:
-  metadata.gz: 3c649faf68705a6eda2bb2e3a93337b2b30269cd91f48b629dd704f9e950b9f882f63b69ff57287e32c540be78b8c35d7714f3f763c7983e95675790106bc014
-  data.tar.gz: 4e8aa3fc7a92b88f83085f950438a3cae213c8d41c454b19f947b67531ba3e21f75cc3f3a1b8ea49a139e594272c60b0f7c943b774a2d4bb62765f77db204e69
+  metadata.gz: a25c0fb6454a60031b33d35e4550c6f6d7afe3ec8789cda95257926c28b3858c7f2864b753670f024aa0aa1b624ce0bd81482d6311323e9190b50001893765ab
+  data.tar.gz: 8bd7a36ace7a8e3d0ebfaf279e13661061e615ec6164413fcdc6fa2ad7e8681b4a632cf6e7ae258d1491d9f1faddbd50dcd664b1c5c6cc94da102d6f9bf2d15d

data/README.md

@@ -1,6 +1,7 @@
 # private-captcha-ruby
 
-![CI](https://github.com/PrivateCaptcha/private-captcha-ruby/actions/workflows/ci.yaml/badge.svg)
+[![Gem Version](https://badge.fury.io/rb/private_captcha.svg)](https://badge.fury.io/rb/private_captcha)
+ ![CI](https://github.com/PrivateCaptcha/private-captcha-ruby/actions/workflows/ci.yaml/badge.svg)
 
 Ruby client for server-side verification of Private Captcha solutions.
 

data/lib/private_captcha/client.rb

@@ -38,6 +38,7 @@ module PrivateCaptcha
       response = nil
       error = nil
       attempt = 0
+      trace_id = nil
 
       max_attempts.times do |i|
         attempt = i + 1
@@ -56,6 +57,7 @@ module PrivateCaptcha
           break
         rescue RetriableError => e
           error = e.original_error
+          trace_id = e.trace_id if e.trace_id
         end
       end
 
@@ -65,7 +67,8 @@ module PrivateCaptcha
 
       if error
         @logger.error("Failed to verify solution after #{attempt} attempts")
-        raise VerificationFailedError.new("Failed to verify solution after #{attempt} attempts", attempt)
+        raise VerificationFailedError.new("Failed to verify solution after #{attempt} attempts", attempt,
+                                          trace_id: trace_id)
       end
 
       response
@@ -78,7 +81,10 @@ module PrivateCaptcha
 
       output = verify(solution)
 
-      raise Error, "captcha verification failed: #{output.error_message}" unless output.success
+      unless output.success
+        raise Error.new("captcha verification failed: #{output.error_message}",
+                        trace_id: output.trace_id)
+      end
 
       output
     end
@@ -104,10 +110,12 @@ module PrivateCaptcha
       @logger.debug('Sending HTTP request') { "path=#{@endpoint.path} method=POST" }
 
       response = nil
+      trace_id = nil
       begin
         response = Net::HTTP.start(@endpoint.hostname, @endpoint.port, use_ssl: true) do |http|
           http.request(request)
         end
+        trace_id = response['X-Trace-ID']
       rescue SocketError, IOError, Timeout::Error, SystemCallError => e
         @logger.debug('Failed to send HTTP request') { "error=#{e.message}" }
         raise RetriableError, e
@@ -118,7 +126,6 @@ module PrivateCaptcha
       end
 
       status_code = response.code.to_i
-      request_id = response['X-Trace-ID']
 
       case status_code
       when 429
@@ -126,16 +133,16 @@ module PrivateCaptcha
         @logger.debug('Rate limited') do
           "retryAfter=#{retry_after} rateLimit=#{response['X-RateLimit-Limit']}"
         end
-        raise RetriableError, HTTPError.new(status_code, retry_after)
+        raise RetriableError, HTTPError.new(status_code, retry_after, trace_id: trace_id)
       when 500, 502, 503, 504, 408, 425
-        raise RetriableError, HTTPError.new(status_code)
+        raise RetriableError, HTTPError.new(status_code, trace_id: trace_id)
       when 300..599
-        raise HTTPError, status_code
+        raise HTTPError.new(status_code, trace_id: trace_id)
       end
 
       begin
         json_data = JSON.parse(response.body)
-        VerifyOutput.from_json(json_data, request_id: request_id)
+        VerifyOutput.from_json(json_data, trace_id: trace_id)
       rescue JSON::ParserError => e
         @logger.debug('Failed to parse response') { "error=#{e.message}" }
         raise RetriableError, e

data/lib/private_captcha/errors.rb

@@ -1,18 +1,26 @@
 # frozen_string_literal: true
 
 module PrivateCaptcha
-  class Error < StandardError; end
+  # Error is the base class for Private Captcha errors
+  class Error < StandardError
+    attr_reader :trace_id
+
+    def initialize(msg = nil, trace_id: nil)
+      @trace_id = trace_id
+      super(msg)
+    end
+  end
 
   # EmptyAPIKeyError is raised when the API key is not provided or is empty
   class EmptyAPIKeyError < Error
-    def initialize(msg = 'API key is empty')
+    def initialize(msg = 'API key is empty', trace_id: nil)
       super
     end
   end
 
   # EmptySolutionError is raised when the solution is not provided or is empty
   class EmptySolutionError < Error
-    def initialize(msg = 'solution is empty')
+    def initialize(msg = 'solution is empty', trace_id: nil)
       super
     end
   end
@@ -21,10 +29,10 @@ module PrivateCaptcha
   class HTTPError < Error
     attr_reader :status_code, :seconds
 
-    def initialize(status_code, seconds = nil)
+    def initialize(status_code, seconds = nil, trace_id: nil)
       @status_code = status_code
       @seconds = seconds
-      super("HTTP error #{status_code}")
+      super("HTTP error #{status_code}", trace_id: trace_id)
     end
   end
 
@@ -36,15 +44,19 @@ module PrivateCaptcha
       @original_error = error
       super(error.message)
     end
+
+    def trace_id
+      @original_error.respond_to?(:trace_id) ? @original_error.trace_id : nil
+    end
   end
 
   # VerificationFailedError is raised when verification fails after all retry attempts
   class VerificationFailedError < Error
     attr_reader :attempts
 
-    def initialize(message, attempts)
+    def initialize(message, attempts, trace_id: nil)
       @attempts = attempts
-      super(message)
+      super(message, trace_id: trace_id)
     end
   end
 end

data/lib/private_captcha/verify_output.rb

@@ -33,14 +33,14 @@ module PrivateCaptcha
     }.freeze
 
     attr_accessor :success, :code, :origin, :timestamp
-    attr_reader :request_id, :attempt
+    attr_reader :trace_id, :attempt
 
-    def initialize(success: false, code: VERIFY_NO_ERROR, origin: nil, timestamp: nil, request_id: nil, attempt: 0)
+    def initialize(success: false, code: VERIFY_NO_ERROR, origin: nil, timestamp: nil, trace_id: nil, attempt: 0)
       @success = success
       @code = code
       @origin = origin
       @timestamp = timestamp
-      @request_id = request_id
+      @trace_id = trace_id
       @attempt = attempt
     end
 
@@ -48,13 +48,13 @@ module PrivateCaptcha
       ERROR_MESSAGES.fetch(@code, 'error')
     end
 
-    def self.from_json(json_data, request_id: nil, attempt: 0)
+    def self.from_json(json_data, trace_id: nil, attempt: 0)
       new(
         success: json_data['success'],
         code: json_data['code'] || VERIFY_NO_ERROR,
         origin: json_data['origin'],
         timestamp: json_data['timestamp'],
-        request_id: request_id,
+        trace_id: trace_id,
         attempt: attempt
       )
     end

data/lib/private_captcha/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PrivateCaptcha
-  VERSION = '0.0.1'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: private_captcha
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Taras Kushnir
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-26 00:00:00.000000000 Z
+date: 2025-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -62,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Ruby client for server-side Private Captcha API