lingodotdev 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14034dfe2c60a19185f6097951589bcf8e34791d10bb4ac8cc2ed120702d061b
-  data.tar.gz: 1405a8002ff6688494158e9da901bf58c7f1c60f144a1c5c287631a8cb4fc87e
+  metadata.gz: 28c83f0fada39ed4eec6b9d0b67917fac54a45fc6d8d11b50389f282f49a322c
+  data.tar.gz: bdca77419544b1253dd3aecc752f07a92c3acab361f8693d7069f3d74d247160
 SHA512:
-  metadata.gz: b4e21ba8cb795eaf703440583d42370ea6750b43a215a5dba2a4a908e19e4ef21b0afec9bc6b45b4ca382b32e13f0ab8dc1c33ab102dda6274f4fac95a5bab9d
-  data.tar.gz: 8b9efcb6a126f0c38f146c5b2125debd4fa14e2ab5a30baefec6703aefd7166330fdc1bc4f8b171b9a6b41697fad47c62e42bcb12e5d4b9e9734510080b30ad4
+  metadata.gz: 458753b774866b16fd4d960ba5e52bcff42b8c322ea3bab294943590ba0a04a09206182fbffcbf9c0fdd51269c542214a689da47893c9519efc7ee8961b2b730
+  data.tar.gz: e002510b545296b9b358713113e86d8f1a6aa08d233c2770b04e89730ad291fa6a77e85f2167cf32d3e3c574da048b6d48a3f08264287f1ce42657ed45a5c728

data/README.md

@@ -39,10 +39,10 @@ gem install lingodotdev
 require 'lingodotdev'
 
 # Create an engine instance
-engine = LingoDotDev::Engine.new(api_key: 'your-api-key')
+engine = LingoDotDev::Engine.new(api_key: 'your-api-key', engine_id: 'your-engine-id')
 
 # Localize text
-result = engine.localize_text('Hello world', target_locale: 'es')
+result = engine.localize_text('Hello world', target_locale: 'es', source_locale: 'en')
 puts result # => "Hola mundo"
 ```
 
@@ -53,29 +53,14 @@ puts result # => "Hola mundo"
 Localize a simple string to a target locale:
 
 ```ruby
-engine = LingoDotDev::Engine.new(api_key: 'your-api-key')
+engine = LingoDotDev::Engine.new(api_key: 'your-api-key', engine_id: 'your-engine-id')
 
 result = engine.localize_text(
   'Hello world',
-  target_locale: 'es'
-)
-# => "Hola mundo"
-
-# With source locale specified
-result = engine.localize_text(
-  'Hello world',
-  target_locale: 'fr',
+  target_locale: 'es',
   source_locale: 'en'
 )
-# => "Bonjour le monde"
-
-# Fast mode for quicker results
-result = engine.localize_text(
-  'Hello world',
-  target_locale: 'de',
-  fast: true
-)
-# => "Hallo Welt"
+# => "Hola mundo"
 ```
 
 ### Object localization
@@ -89,7 +74,7 @@ data = {
   message: 'Welcome to our app'
 }
 
-result = engine.localize_object(data, target_locale: 'es')
+result = engine.localize_object(data, target_locale: 'es', source_locale: 'en')
 # => {
 #   greeting: "Hola",
 #   farewell: "Adiós",
@@ -108,7 +93,7 @@ chat = [
   { name: 'user', text: 'I need some information.' }
 ]
 
-result = engine.localize_chat(chat, target_locale: 'ja')
+result = engine.localize_chat(chat, target_locale: 'ja', source_locale: 'en')
 # => [
 #   { name: 'user', text: 'こんにちは！' },
 #   { name: 'assistant', text: 'こんにちは！どのようにお手伝いできますか？' },
@@ -136,7 +121,7 @@ html = <<~HTML
   </html>
 HTML
 
-result = engine.localize_html(html, target_locale: 'es')
+result = engine.localize_html(html, target_locale: 'es', source_locale: 'en')
 # => HTML with localized text content and attributes, lang="es" attribute updated
 ```
 
@@ -156,7 +141,8 @@ Localize the same content to multiple target locales:
 # Batch localize text
 results = engine.batch_localize_text(
   'Hello world',
-  target_locales: ['es', 'fr', 'de']
+  target_locales: ['es', 'fr', 'de'],
+  source_locale: 'en'
 )
 # => ["Hola mundo", "Bonjour le monde", "Hallo Welt"]
 
@@ -164,6 +150,7 @@ results = engine.batch_localize_text(
 results = engine.batch_localize_text(
   'Hello world',
   target_locales: ['es', 'fr', 'de', 'ja'],
+  source_locale: 'en',
   concurrent: true
 )
 ```
@@ -182,6 +169,7 @@ objects = [
 results = engine.batch_localize_objects(
   objects,
   target_locale: 'es',
+  source_locale: 'en',
   concurrent: true
 )
 # => [
@@ -198,9 +186,6 @@ Automatically detect the locale of a given text:
 ```ruby
 locale = engine.recognize_locale('Bonjour le monde')
 # => "fr"
-
-locale = engine.recognize_locale('こんにちは世界')
-# => "ja"
 ```
 
 ### Progress tracking
@@ -209,7 +194,7 @@ Monitor localization progress with callbacks:
 
 ```ruby
 # Using a block
-result = engine.localize_text('Hello world', target_locale: 'es') do |progress|
+result = engine.localize_text('Hello world', target_locale: 'es', source_locale: 'en') do |progress|
   puts "Progress: #{progress}%"
 end
 
@@ -218,24 +203,25 @@ callback = proc { |progress| puts "Progress: #{progress}%" }
 result = engine.localize_text(
   'Hello world',
   target_locale: 'es',
+  source_locale: 'en',
   on_progress: callback
 )
 ```
 
 ### Reference context
 
-Provide additional context to improve translation accuracy:
+Provide existing translations as reference to improve translation accuracy. The `reference` hash maps locale codes to key-value content objects:
 
 ```ruby
 reference = {
-  context: 'greeting',
-  tone: 'formal',
-  domain: 'business'
+  'es' => { 'greeting' => 'Hola', 'farewell' => 'Adiós' },
+  'fr' => { 'greeting' => 'Bonjour', 'farewell' => 'Au revoir' }
 }
 
 result = engine.localize_text(
   'Hello',
   target_locale: 'ja',
+  source_locale: 'en',
   reference: reference
 )
 ```
@@ -249,21 +235,27 @@ For one-off translations without managing engine instances:
 result = LingoDotDev::Engine.quick_translate(
   'Hello world',
   api_key: 'your-api-key',
-  target_locale: 'es'
+  engine_id: 'your-engine-id',
+  target_locale: 'es',
+  source_locale: 'en'
 )
 
 # Quick translate a hash
 result = LingoDotDev::Engine.quick_translate(
   { greeting: 'Hello', farewell: 'Goodbye' },
   api_key: 'your-api-key',
-  target_locale: 'fr'
+  engine_id: 'your-engine-id',
+  target_locale: 'fr',
+  source_locale: 'en'
 )
 
 # Quick batch translate to multiple locales
 results = LingoDotDev::Engine.quick_batch_translate(
   'Hello',
   api_key: 'your-api-key',
-  target_locales: ['es', 'fr', 'de']
+  engine_id: 'your-engine-id',
+  target_locales: ['es', 'fr', 'de'],
+  source_locale: 'en'
 )
 ```
 
@@ -283,7 +275,8 @@ The SDK can be configured when creating an engine instance:
 ```ruby
 engine = LingoDotDev::Engine.new(
   api_key: 'your-api-key',          # Required: Your Lingo.dev API key
-  api_url: 'https://engine.lingo.dev', # Optional: API endpoint URL
+  engine_id: 'your-engine-id',      # Optional: Your engine ID
+  api_url: 'https://api.lingo.dev', # Optional: API endpoint URL
   batch_size: 25,                    # Optional: Max items per batch (1-250)
   ideal_batch_item_size: 250         # Optional: Target word count per batch (1-2500)
 )
@@ -292,7 +285,7 @@ engine = LingoDotDev::Engine.new(
 You can also configure using a block:
 
 ```ruby
-engine = LingoDotDev::Engine.new(api_key: 'your-api-key') do |config|
+engine = LingoDotDev::Engine.new(api_key: 'your-api-key', engine_id: 'your-engine-id') do |config|
   config.batch_size = 50
   config.ideal_batch_item_size = 500
 end
@@ -303,7 +296,8 @@ end
 | Option                  | Type    | Default                    | Description                               |
 | ----------------------- | ------- | -------------------------- | ----------------------------------------- |
 | `api_key`               | String  | Required                   | Your Lingo.dev API key                    |
-| `api_url`               | String  | `https://engine.lingo.dev` | API endpoint URL                          |
+| `engine_id`             | String  | `nil`                      | Your engine ID for localization processing|
+| `api_url`               | String  | `https://api.lingo.dev`    | API endpoint URL                          |
 | `batch_size`            | Integer | `25`                       | Maximum items per batch (1-250)           |
 | `ideal_batch_item_size` | Integer | `250`                      | Target word count per batch item (1-2500) |
 
@@ -311,51 +305,49 @@ end
 
 ### Instance methods
 
-#### `localize_text(text, target_locale:, source_locale: nil, fast: nil, reference: nil, on_progress: nil, concurrent: false, &block)`
+#### `localize_text(text, target_locale:, source_locale:, reference: nil, on_progress: nil, concurrent: false, &block)`
 
 Localizes a string to the target locale.
 
 - **Parameters:**
   - `text` (String): Text to localize
   - `target_locale` (String): Target locale code (e.g., 'es', 'fr', 'ja')
-  - `source_locale` (String, optional): Source locale code
-  - `fast` (Boolean, optional): Enable fast mode
-  - `reference` (Hash, optional): Additional context for translation
+  - `source_locale` (String): Source locale code (e.g., 'en')
+  - `reference` (Hash, optional): Existing translations keyed by locale code, e.g. `{ 'es' => { 'key' => 'valor' } }`
   - `on_progress` (Proc, optional): Progress callback
   - `concurrent` (Boolean): Enable concurrent processing
   - `&block`: Alternative progress callback
 - **Returns:** Localized string
 
-#### `localize_object(obj, target_locale:, source_locale: nil, fast: nil, reference: nil, on_progress: nil, concurrent: false, &block)`
+#### `localize_object(obj, target_locale:, source_locale:, reference: nil, on_progress: nil, concurrent: false, &block)`
 
 Localizes all string values in a Hash.
 
 - **Parameters:** Same as `localize_text`, with `obj` (Hash) instead of `text`
 - **Returns:** Localized Hash
 
-#### `localize_chat(chat, target_locale:, source_locale: nil, fast: nil, reference: nil, on_progress: nil, concurrent: false, &block)`
+#### `localize_chat(chat, target_locale:, source_locale:, reference: nil, on_progress: nil, concurrent: false, &block)`
 
 Localizes chat messages. Each message must have `:name` and `:text` keys.
 
 - **Parameters:** Same as `localize_text`, with `chat` (Array) instead of `text`
 - **Returns:** Array of localized chat messages
 
-#### `localize_html(html, target_locale:, source_locale: nil, fast: nil, reference: nil, on_progress: nil, concurrent: false, &block)`
+#### `localize_html(html, target_locale:, source_locale:, reference: nil, on_progress: nil, concurrent: false, &block)`
 
 Localizes an HTML document while preserving structure and formatting. Handles both text content and localizable attributes (alt, title, placeholder, meta content).
 
 - **Parameters:**
   - `html` (String): HTML document string to localize
   - `target_locale` (String): Target locale code (e.g., 'es', 'fr', 'ja')
-  - `source_locale` (String, optional): Source locale code
-  - `fast` (Boolean, optional): Enable fast mode
-  - `reference` (Hash, optional): Additional context for translation
+  - `source_locale` (String): Source locale code (e.g., 'en')
+  - `reference` (Hash, optional): Existing translations keyed by locale code, e.g. `{ 'es' => { 'key' => 'valor' } }`
   - `on_progress` (Proc, optional): Progress callback
   - `concurrent` (Boolean): Enable concurrent processing
   - `&block`: Alternative progress callback
 - **Returns:** Localized HTML document string with updated `lang` attribute
 
-#### `batch_localize_text(text, target_locales:, source_locale: nil, fast: nil, reference: nil, concurrent: false)`
+#### `batch_localize_text(text, target_locales:, source_locale:, reference: nil, concurrent: false)`
 
 Localizes text to multiple target locales.
 
@@ -365,7 +357,7 @@ Localizes text to multiple target locales.
   - Other parameters same as `localize_text`
 - **Returns:** Array of localized strings
 
-#### `batch_localize_objects(objects, target_locale:, source_locale: nil, fast: nil, reference: nil, concurrent: false)`
+#### `batch_localize_objects(objects, target_locale:, source_locale:, reference: nil, concurrent: false)`
 
 Localizes multiple objects to the same target locale.
 
@@ -391,7 +383,7 @@ Returns information about the authenticated user.
 
 ### Class methods
 
-#### `Engine.quick_translate(content, api_key:, target_locale:, source_locale: nil, fast: true, api_url: 'https://engine.lingo.dev')`
+#### `Engine.quick_translate(content, api_key:, engine_id: nil, target_locale:, source_locale:, api_url: 'https://api.lingo.dev')`
 
 One-off translation without managing engine lifecycle.
 
@@ -400,7 +392,7 @@ One-off translation without managing engine lifecycle.
   - Other parameters as in instance methods
 - **Returns:** Translated String or Hash
 
-#### `Engine.quick_batch_translate(content, api_key:, target_locales:, source_locale: nil, fast: true, api_url: 'https://engine.lingo.dev')`
+#### `Engine.quick_batch_translate(content, api_key:, engine_id: nil, target_locales:, source_locale:, api_url: 'https://api.lingo.dev')`
 
 One-off batch translation to multiple locales.
 
@@ -417,7 +409,7 @@ The SDK defines custom exception classes for different error scenarios:
 ```ruby
 begin
   engine = LingoDotDev::Engine.new(api_key: 'your-api-key')
-  result = engine.localize_text('Hello', target_locale: 'es')
+  result = engine.localize_text('Hello', target_locale: 'es', source_locale: 'en')
 rescue LingoDotDev::ValidationError => e
   # Invalid input or configuration
   puts "Validation error: #{e.message}"

data/lib/lingodotdev/version.rb

@@ -3,6 +3,6 @@
 # Ruby SDK for Lingo.dev localization and translation API.
 module LingoDotDev
   # Current version of the LingoDotDev SDK.
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end