apiverve_spellchecker 1.2.3 → 1.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 074a54c947760ca1cb9bc167a28bcd811951a663859dd73e64e73251a41bb52f
-  data.tar.gz: 3cd50895857a3ab2bc2987a820556e784ab175bfbe4b073553c9d311aaea17a2
+  metadata.gz: 295e400c7aba5b051fe10e9e9e9aaae5dcd1d4ba8131d50cb1e2d3d5bf8a7939
+  data.tar.gz: dd25228e1a1d39e9751bf82c9f2876422e961707670d6aac60c0908d3fffa4da
 SHA512:
-  metadata.gz: 28c365ffe1454f21c379a75887977e4cc2a8a8a5c8d757768302ac959f5b6eae1134dd800e21bee71d0f96c1c917aa2dfc0566fa637a3da783936619934725a5
-  data.tar.gz: be594cd5272f6eb42045b39d11778fd3356d057ba02576ed2866b104feb8c2de47b02afefbe54a9c9247d441650d59e2c40f486d74dd28263550a85ce4737feb
+  metadata.gz: a9f34d6ad2006e76e8bfd74797557264914a5925f52394046c54aadbf8d3128de1c72b888be4f9eaefe4378eb2f54c33aa1e26765b090f003fa2ee3100729c9d
+  data.tar.gz: dfa1d88d630f82f81e98efd28473746c3df268344b47c6b1677aca125240eb6da7aaaef71feb70fb5f8074056ea20d1ee628ecd19a051281672ad0b8c0fe86f6

data/README.md

@@ -1,6 +1,6 @@
 # Spell Checker API - Ruby Gem
 
-Spell Checker flags misspelled words in submitted English text and generates correction suggestions. It counts total spelling errors and lists possible replacements for each mistaken word.
+Spell Checker flags misspelled words in submitted English text and generates correction suggestions. It counts total spelling errors, lists possible replacements for each mistaken word, and can return the text with the top suggestions applied, plus on paid plans the character offsets of every misspelling.
 
 ## Installation
 
@@ -35,7 +35,11 @@ require 'apiverve_spellchecker'
 client = APIVerve::Spellchecker::Client.new(api_key: "YOUR_API_KEY")
 
 # Make a request
-response = client.execute({ text: "I neeed to call my friend on telephine today!" })
+response = client.execute({
+  text: "I neeed to call my friend on telephine today!",
+  autocorrect: true,
+  offsets: true
+})
 
 # Print the response
 puts response
@@ -46,7 +50,7 @@ puts response
 
 ```ruby
 begin
-  response = client.execute({ text: "I neeed to call my friend on telephine today!" })
+  response = client.execute({ text: "I neeed to call my friend on telephine today!", autocorrect: true, offsets: true })
   puts response["data"]
 rescue APIVerve::Spellchecker::ValidationError => e
   puts "Validation error: #{e.errors.join(', ')}"
@@ -75,6 +79,7 @@ client = APIVerve::Spellchecker::Client.new(
   "data": {
     "spellPass": false,
     "mispellingsFound": 2,
+    "totalOccurrences": 2,
     "corrections": [
       {
         "word": "neeed",
@@ -84,6 +89,13 @@ client = APIVerve::Spellchecker::Client.new(
           "needy",
           "Neel",
           "needs"
+        ],
+        "occurrences": 1,
+        "offsets": [
+          {
+            "start": 2,
+            "end": 7
+          }
         ]
       },
       {
@@ -94,9 +106,17 @@ client = APIVerve::Spellchecker::Client.new(
           "telephoner",
           "telephones",
           "telephony"
+        ],
+        "occurrences": 1,
+        "offsets": [
+          {
+            "start": 29,
+            "end": 38
+          }
         ]
       }
-    ]
+    ],
+    "correctedText": "I needed to call my friend on telephone today!"
   }
 }
 ```

data/lib/apiverve_spellchecker/client.rb

@@ -10,7 +10,7 @@ module APIVerve
     #
     # @example Basic usage
     #   client = APIVerve::Spellchecker::Client.new(api_key: "your_api_key")
-    #   response = client.execute({ text: "I neeed to call my friend on telephine today!" })
+    #   response = client.execute({ text: "I neeed to call my friend on telephine today!", autocorrect: true, offsets: true })
     #   puts response
     #
     # @see https://apiverve.com/marketplace/spellchecker?utm_source=ruby&utm_medium=referral&utm_content=readme
@@ -19,7 +19,7 @@ module APIVerve
       DEFAULT_TIMEOUT = 30
 
       # Validation rules for parameters
-      VALIDATION_RULES = { 'text' => { type: 'string', required: true, max_length: 50000 } }
+      VALIDATION_RULES = { 'text' => { type: 'string', required: true, max_length: 50000 }, 'autocorrect' => { type: 'boolean', required: false }, 'offsets' => { type: 'boolean', required: false } }
 
       # Format validation patterns
       FORMAT_PATTERNS = {

data/lib/apiverve_spellchecker.rb

@@ -4,6 +4,6 @@ require_relative "apiverve_spellchecker/client"
 
 module APIVerve
   module Spellchecker
-    VERSION = "1.2.3"
+    VERSION = "1.2.5"
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: apiverve_spellchecker
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.5
 platform: ruby
 authors:
 - APIVerve
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2026-10-26 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -59,8 +58,9 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 description: Spell Checker flags misspelled words in submitted English text and generates
-  correction suggestions. It counts total spelling errors and lists possible replacements
-  for each mistaken word.
+  correction suggestions. It counts total spelling errors, lists possible replacements
+  for each mistaken word, and can return the text with the top suggestions applied,
+  plus on paid plans the character offsets of every misspelling.
 email:
 - hello@apiverve.com
 executables: []
@@ -79,7 +79,6 @@ metadata:
   source_code_uri: https://github.com/apiverve/spellchecker-API/tree/main/ruby
   changelog_uri: https://apiverve.com/changelog
   documentation_uri: https://docs.apiverve.com/ref/spellchecker
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -94,8 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 4.0.23
 specification_version: 4
 summary: Spell Checker API - Ruby Client
 test_files: []