private_captcha 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70c3d94ed5a3020b3f71df8c50558c2e1a09c5e245374844209d2734bc4d51a8
-  data.tar.gz: 6a3a267b62466abc243069c922af1440f77d6feaeac24c96238d1841aa9d4437
+  metadata.gz: 8cfbe57b68cd76d99caf830425f5c0b266807cd9f0b1290e7f973f10b3d6ff58
+  data.tar.gz: 9dc9b9cb80b0ed3efeaa15992233688836a07d0a2e26f8640f1801f023db0958
 SHA512:
-  metadata.gz: 88e3e2caef19070d9aba49ceaf62b9a9eb0fb0c80bf56e6c9c90a86d513137248c9a8435b5fb751604c1bd1814f5d771ba9bf021a3278aa6ac964f13e0021716
-  data.tar.gz: 7bb7b45b726e696b3ea57d38c2ad6fbb1a9a7e37ac2ece858f50e43741512c39469f68732894ac0696b70c98c977459f18ebecb2cba12c4e8f294b628d76f4de
+  metadata.gz: 9cfab92357a7f4a13d2b6f9aa63a2f523f29de75bcd0c2d79b252e49f65ca02cda3881ecadb7a2d5785eb9f85fa7e48df1561c4dad217718e532834ced62d8fc
+  data.tar.gz: 3cac0cac74a8e081a3a67e405481306d2ddfe01a8d9790de575fb45ee1ab40fa3bb08d4bcb86f2110bccc5b248c054434323cc371f0d814016352452113047f4

data/README.md

@@ -5,151 +5,36 @@
 
 Ruby client for server-side verification of Private Captcha solutions.
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'private_captcha'
-```
-
-And then execute:
-
-```bash
-bundle install
-```
-
-Or install it yourself as:
-
-```bash
-gem install private_captcha
-```
+<mark>Please check the [official documentation](https://docs.privatecaptcha.com/docs/integrations/ruby/) for the in-depth and up-to-date information.</mark>
 
 ## Quick Start
 
-```ruby
-require 'private_captcha'
-
-# Initialize the client with your API key
-client = PrivateCaptcha::Client.new do |config|
-  config.api_key = 'your-api-key-here'
-end
-
-# Verify a captcha solution
-begin
-  result = client.verify('user-solution-from-frontend')
-  if result.ok?
-    puts 'Captcha verified successfully!'
-  else
-    puts "Verification failed: #{result.error_message}"
+- Install gem `private_captcha`
+  ```bash
+  gem install private_captcha
+  ```
+- Instantiate the client and call `verify()` method to check the captcha solution
+  ```ruby
+  require 'private_captcha'
+  
+  # Initialize the client with your API key
+  client = PrivateCaptcha::Client.new do |config|
+    config.api_key = 'your-api-key-here'
   end
-rescue PrivateCaptcha::Error => e
-  puts "Error: #{e.message}"
-end
-```
-
-## Usage
-
-### Web Framework Integration
-
-#### Sinatra Example
-
-```ruby
-require 'sinatra'
-require 'private_captcha'
-
-client = PrivateCaptcha::Client.new do |config|
-  config.api_key = 'your-api-key'
-end
-
-post '/submit' do
+  
+  # Verify a captcha solution
   begin
-    # Verify captcha from form data
-    client.verify_request(request)
-
-    # Process your form data here
-    'Form submitted successfully!'
-  rescue PrivateCaptcha::Error
-    status 400
-    'Captcha verification failed'
-  end
-end
-```
-
-#### Rails Example
-
-```ruby
-class FormsController < ApplicationController
-  def submit
-    client = PrivateCaptcha::Client.new do |config|
-      config.api_key = 'your-api-key'
-    end
-
-    begin
-      client.verify_request(request)
-      # Process form data
-      render plain: 'Success!'
-    rescue PrivateCaptcha::Error
-      render plain: 'Captcha failed', status: :bad_request
+    result = client.verify('user-solution-from-frontend')
+    if result.ok?
+      puts 'Captcha verified successfully!'
+    else
+      puts "Verification failed: #{result.error_message}"
     end
+  rescue PrivateCaptcha::Error => e
+    puts "Error: #{e.message}"
   end
-end
-```
-
-#### Rack Middleware
-
-```ruby
-require 'private_captcha'
-
-use PrivateCaptcha::Middleware,
-  api_key: 'your-api-key',
-  failed_status_code: 403
-```
-
-## Configuration
-
-### Client Options
-
-```ruby
-require 'private_captcha'
-
-client = PrivateCaptcha::Client.new do |config|
-  config.api_key = 'your-api-key'
-  config.domain = PrivateCaptcha::Configuration::EU_DOMAIN  # replace domain for self-hosting or EU isolation
-  config.form_field = 'private-captcha-solution'            # custom form field name
-  config.max_backoff_seconds = 20                           # maximum wait between retries
-  config.attempts = 5                                       # number of retry attempts
-  config.logger = Logger.new(STDOUT)                        # optional logger
-end
-```
-
-### Non-standard backend domains
-
-```ruby
-require 'private_captcha'
-
-# Use EU domain
-eu_client = PrivateCaptcha::Client.new do |config|
-  config.api_key = 'your-api-key'
-  config.domain = PrivateCaptcha::Configuration::EU_DOMAIN  # api.eu.privatecaptcha.com
-end
-
-# Or specify custom domain in case of self-hosting
-custom_client = PrivateCaptcha::Client.new do |config|
-  config.api_key = 'your-api-key'
-  config.domain = 'your-custom-domain.com'
-end
-```
-
-### Retry Configuration
-
-```ruby
-result = client.verify(
-  'solution',
-  max_backoff_seconds: 15,  # maximum wait between retries
-  attempts: 3               # number of retry attempts
-)
-```
+  ```
+- Integrate using Rack middleware or use with Sinatra or Rails with `client.verify_request()` helper
 
 ## Requirements
 

data/lib/private_captcha/verify_output.rb

@@ -15,7 +15,8 @@ module PrivateCaptcha
     MAINTENANCE_MODE_ERROR = 9
     TEST_PROPERTY_ERROR = 10
     INTEGRITY_ERROR = 11
-    VERIFY_CODES_COUNT = 12
+    ORG_SCOPE_ERROR = 12
+    VERIFY_CODES_COUNT = 13
 
     ERROR_MESSAGES = {
       VERIFY_NO_ERROR => '',
@@ -29,7 +30,8 @@ module PrivateCaptcha
       VERIFIED_BEFORE_ERROR => 'solution-verified-before',
       MAINTENANCE_MODE_ERROR => 'maintenance-mode',
       TEST_PROPERTY_ERROR => 'property-test',
-      INTEGRITY_ERROR => 'integrity-error'
+      INTEGRITY_ERROR => 'integrity-error',
+      ORG_SCOPE_ERROR => 'org-scope-error'
     }.freeze
 
     attr_accessor :success, :code, :origin, :timestamp

data/lib/private_captcha/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: private_captcha
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Taras Kushnir
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-12-03 00:00:00.000000000 Z
+date: 2025-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack