lingvanex-unofficial-rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 72b293cb5db2a5d48108b80e5b1ae121434d19185f9a7c4ab3bf2da08f87fafb
+  data.tar.gz: b05a3b136d71ff5cdf2f2f5e21c5f07ed14ec43dc701f82d7e38e6f7e03d7998
+SHA512:
+  metadata.gz: 499c4042f6c89d7a02045f38a3e172326d3d038b5980f6f420ff169cd387d419c94acbbe734731398502a5f4101c7c435bfc4f9c9e0437935c17caf2956f0155
+  data.tar.gz: 12ee1c0c8c39fb216492ab26c3736650be5bb8a38027e0f5ab2dc4dfd207b6f0333f99f9cc4b81b30b5b7736238738948d3f0028b5106ee4710b1b3cccec2cd1

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2025-11-04
+
+### Added
+- Initial release of lingvanex-unofficial-rb gem
+
+### Notes
+- This is an unofficial gem, not affiliated with Lingvanex
+- Module name remains `Lingvanex` for convenience

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025
+
+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,311 @@
+# Lingvanex (Unofficial Ruby Gem)
+
+An unofficial Ruby gem for the [Lingvanex Translation API](https://lingvanex.com/products/translationapi/). Translate text between 109+ languages with automatic language detection, HTML translation, and transliteration support.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lingvanex-unofficial-rb'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install lingvanex-unofficial-rb
+```
+
+## Getting Started
+
+### Obtaining an API Key
+
+1. Sign up for an account at [Lingvanex](https://lingvanex.com/)
+2. Navigate to the Cloud API tab
+3. Fill out the billing address data
+4. Complete the payment process to generate your API key
+
+### Configuration
+
+You can configure Lingvanex globally:
+
+```ruby
+require 'lingvanex'
+
+Lingvanex.configure do |config|
+  config.api_key = 'your_api_key_here'
+  config.timeout = 30  # optional, defaults to 30 seconds
+end
+```
+
+Or configure per-client:
+
+```ruby
+client = Lingvanex::Client.new(api_key: 'your_api_key_here')
+
+# Or with a block
+client = Lingvanex::Client.new do |config|
+  config.api_key = 'your_api_key_here'
+  config.timeout = 60
+end
+```
+
+## Usage
+
+### Translating Text
+
+Basic translation with automatic language detection:
+
+```ruby
+client = Lingvanex.client(api_key: 'your_api_key')
+
+result = client.translate('Hello, world!', to: 'es_ES')
+puts result['result']  # => "¡Hola, mundo!"
+```
+
+Specify source language:
+
+```ruby
+result = client.translate('Hello, world!', from: 'en_GB', to: 'fr_FR')
+puts result['result']  # => "Bonjour, le monde!"
+```
+
+Translate multiple texts at once:
+
+```ruby
+texts = ['Hello', 'Goodbye', 'Thank you']
+result = client.translate(texts, to: 'de_DE')
+# Returns translations for all texts
+```
+
+### HTML Translation
+
+Preserve HTML structure while translating:
+
+```ruby
+html = '<h1>Welcome</h1><p>This is a <strong>paragraph</strong>.</p>'
+result = client.translate(html, to: 'it_IT', translate_mode: 'html')
+# HTML tags remain intact, only text content is translated
+```
+
+### Transliteration
+
+Enable transliteration in the response:
+
+```ruby
+result = client.translate('Hello', to: 'uk_UA', enable_transliteration: true)
+# Response includes transliteration fields
+```
+
+### Getting Available Languages
+
+Fetch the list of supported languages:
+
+```ruby
+result = client.get_languages
+puts result['result']
+# => [
+#   {"full_code"=>"en_GB", "name"=>"English"},
+#   {"full_code"=>"es_ES", "name"=>"Spanish"},
+#   ...
+# ]
+```
+
+Get language names in a specific language:
+
+```ruby
+# Get language names in German
+result = client.get_languages(code: 'de_DE')
+```
+
+## Language Codes
+
+Language codes follow the format `language_COUNTRY`, for example:
+
+- `en_GB` - English (UK)
+- `en_US` - English (US)
+- `es_ES` - Spanish (Spain)
+- `fr_FR` - French (France)
+- `de_DE` - German (Germany)
+- `uk_UA` - Ukrainian (Ukraine)
+- `zh_CN` - Chinese (Simplified)
+- `ja_JP` - Japanese (Japan)
+
+See the [Lingvanex documentation](https://docs.lingvanex.com/) for the complete list of supported languages.
+
+## Error Handling
+
+The gem provides specific error classes for different scenarios:
+
+```ruby
+begin
+  client.translate('Hello', to: 'invalid_code')
+rescue Lingvanex::AuthenticationError => e
+  # Handle authentication errors (401)
+  puts "Authentication failed: #{e.message}"
+rescue Lingvanex::RateLimitError => e
+  # Handle rate limiting (429)
+  puts "Rate limit exceeded: #{e.message}"
+rescue Lingvanex::InvalidRequestError => e
+  # Handle invalid requests (400-499)
+  puts "Invalid request: #{e.message}"
+rescue Lingvanex::APIError => e
+  # Handle other API errors
+  puts "API error: #{e.message}"
+  puts "Status code: #{e.status_code}"
+  puts "Response body: #{e.response_body}"
+end
+```
+
+Error hierarchy:
+
+- `Lingvanex::Error` - Base error class
+  - `Lingvanex::ConfigurationError` - Configuration errors
+  - `Lingvanex::APIError` - API-related errors
+    - `Lingvanex::AuthenticationError` - Authentication failures (401)
+    - `Lingvanex::RateLimitError` - Rate limit exceeded (429)
+    - `Lingvanex::InvalidRequestError` - Invalid request parameters (400-499)
+
+## Advanced Configuration
+
+### Custom Base URL
+
+If you need to use a different API endpoint:
+
+```ruby
+Lingvanex.configure do |config|
+  config.api_key = 'your_api_key'
+  config.base_url = 'https://custom.api.endpoint'
+end
+```
+
+### Timeout Configuration
+
+Set custom timeout for API requests:
+
+```ruby
+client = Lingvanex::Client.new do |config|
+  config.api_key = 'your_api_key'
+  config.timeout = 60  # seconds
+end
+```
+
+### Platform Configuration
+
+The platform parameter is set to "api" by default, but can be customized:
+
+```ruby
+Lingvanex.configure do |config|
+  config.api_key = 'your_api_key'
+  config.platform = 'api'  # default value
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+### Running Tests
+
+```bash
+bundle exec rspec
+```
+
+### Running RuboCop
+
+```bash
+bundle exec rubocop
+```
+
+### Running All Checks
+
+```bash
+bundle exec rake  # runs both specs and rubocop
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mykbren/lingvanex-unofficial-rb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Resources
+
+- [Lingvanex API Documentation](https://docs.lingvanex.com/)
+- [Lingvanex Website](https://lingvanex.com/)
+
+## Examples
+
+### Simple Translation Script
+
+```ruby
+#!/usr/bin/env ruby
+require 'lingvanex'
+
+# Configure the gem
+Lingvanex.configure do |config|
+  config.api_key = ENV['LINGVANEX_API_KEY']
+end
+
+# Create a client
+client = Lingvanex.client
+
+# Translate some text
+puts "Translating 'Hello, world!' to Spanish..."
+result = client.translate('Hello, world!', to: 'es_ES')
+puts result['result']
+
+# Get available languages
+puts "\nFetching available languages..."
+languages = client.get_languages
+puts "Total languages available: #{languages['result'].length}"
+```
+
+### Rails Integration
+
+```ruby
+# config/initializers/lingvanex.rb
+Lingvanex.configure do |config|
+  config.api_key = Rails.application.credentials.lingvanex_api_key
+  config.timeout = 30
+end
+
+# app/services/translation_service.rb
+class TranslationService
+  def self.translate(text, target_language)
+    client = Lingvanex.client
+    result = client.translate(text, to: target_language)
+    result['result']
+  rescue Lingvanex::Error => e
+    Rails.logger.error("Translation failed: #{e.message}")
+    nil
+  end
+end
+```
+
+### Batch Translation
+
+```ruby
+require 'lingvanex'
+
+client = Lingvanex.client(api_key: 'your_api_key')
+
+# Translate multiple phrases
+phrases = [
+  'Good morning',
+  'Good afternoon',
+  'Good evening',
+  'Good night'
+]
+
+result = client.translate(phrases, to: 'ja_JP')
+puts result
+```

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+desc 'Run RSpec tests and RuboCop'
+task default: %i[spec rubocop]

data/lib/lingvanex/client.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+require 'uri'
+require 'openssl'
+
+module Lingvanex
+  class Client
+    attr_reader :configuration
+
+    def initialize(api_key: nil)
+      @configuration = Configuration.new
+      @configuration.api_key = api_key if api_key
+      yield(@configuration) if block_given?
+      @configuration.validate!
+    end
+
+    def translate(text, to:, from: nil, translate_mode: nil, enable_transliteration: false)
+      body = {
+        platform: configuration.platform,
+        to: to,
+        data: text
+      }
+      body[:from] = from if from
+      body[:translateMode] = translate_mode if translate_mode
+      body[:enableTransliteration] = enable_transliteration if enable_transliteration
+
+      post('/translate', body)
+    end
+
+    def get_languages(code: 'en_GB')
+      get('/getLanguages', platform: configuration.platform, code: code)
+    end
+
+    private
+
+    def get(path, **params)
+      uri = URI("#{configuration.base_url}#{path}")
+      uri.query = URI.encode_www_form(params) unless params.empty?
+
+      request = Net::HTTP::Get.new(uri)
+      request['Authorization'] = configuration.api_key
+      request['Content-Type'] = 'application/json'
+
+      execute_request(uri, request)
+    end
+
+    def post(path, body)
+      uri = URI("#{configuration.base_url}#{path}")
+
+      request = Net::HTTP::Post.new(uri)
+      request['Authorization'] = configuration.api_key
+      request['Content-Type'] = 'application/json'
+      request.body = body.to_json
+
+      execute_request(uri, request)
+    end
+
+    def execute_request(uri, request)
+      response = Net::HTTP.start(
+        uri.hostname,
+        uri.port,
+        use_ssl: true,
+        verify_mode: OpenSSL::SSL::VERIFY_PEER,
+        min_version: OpenSSL::SSL::TLS1_2_VERSION,
+        read_timeout: configuration.timeout
+      ) do |http|
+        http.request(request)
+      end
+
+      handle_response(response)
+    end
+
+    def handle_response(response)
+      status = response.code.to_i
+      return parse_success_response(response) if (200..299).cover?(status)
+
+      raise_error_for_status(status, response)
+    end
+
+    def parse_success_response(response)
+      JSON.parse(response.body)
+    rescue JSON::ParserError => e
+      raise_api_error("Invalid JSON response: #{e.message}", response)
+    end
+
+    def raise_error_for_status(status, response)
+      case status
+      when 401
+        raise_authentication_error(response)
+      when 429
+        raise_rate_limit_error(response)
+      when 400..499
+        raise_invalid_request_error(response)
+      else
+        raise_api_error("API error: #{response.body}", response)
+      end
+    end
+
+    def raise_authentication_error(response)
+      raise AuthenticationError.new('Authentication failed',
+                                    status_code: response.code.to_i,
+                                    response_body: response.body)
+    end
+
+    def raise_rate_limit_error(response)
+      raise RateLimitError.new('Rate limit exceeded',
+                               status_code: response.code.to_i,
+                               response_body: response.body)
+    end
+
+    def raise_invalid_request_error(response)
+      raise InvalidRequestError.new("Invalid request: #{response.body}",
+                                    status_code: response.code.to_i,
+                                    response_body: response.body)
+    end
+
+    def raise_api_error(message, response)
+      raise APIError.new(message,
+                         status_code: response.code.to_i,
+                         response_body: response.body)
+    end
+  end
+end

data/lib/lingvanex/configuration.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Lingvanex
+  class Configuration
+    attr_accessor :api_key, :base_url, :timeout, :platform
+
+    def initialize
+      @api_key = nil
+      @base_url = 'https://api-b2b.backenster.com/b1/api/v3' # Official Lingvanex API endpoint
+      @timeout = 30
+      @platform = 'api'
+    end
+
+    def validate!
+      raise ConfigurationError, 'API key is required' if api_key.nil? || api_key.empty?
+    end
+  end
+end

data/lib/lingvanex/errors.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Lingvanex
+  class Error < StandardError; end
+
+  class ConfigurationError < Error; end
+
+  class APIError < Error
+    attr_reader :status_code, :response_body
+
+    def initialize(message, status_code: nil, response_body: nil)
+      super(message)
+      @status_code = status_code
+      @response_body = response_body
+    end
+  end
+
+  class AuthenticationError < APIError; end
+
+  class RateLimitError < APIError; end
+
+  class InvalidRequestError < APIError; end
+end

data/lib/lingvanex/version.rb

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

data/lib/lingvanex.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lingvanex/version'
+require_relative 'lingvanex/errors'
+require_relative 'lingvanex/configuration'
+require_relative 'lingvanex/client'
+
+module Lingvanex
+  class << self
+    attr_writer :configuration
+
+    def configure
+      yield(configuration)
+      configuration.validate!
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+
+    def client(api_key: nil, &block)
+      if api_key || block_given?
+        Client.new(api_key: api_key, &block)
+      else
+        configuration.validate!
+        Client.new(api_key: configuration.api_key)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: lingvanex-unofficial-rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- mykbren
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-11-06 00:00:00.000000000 Z
+dependencies: []
+description: An unofficial, simple Ruby gem for interacting with the Lingvanex Translation
+  API. Supports text translation, language detection, and HTML translation with 109+
+  languages.
+email:
+- myk.bren@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/lingvanex.rb
+- lib/lingvanex/client.rb
+- lib/lingvanex/configuration.rb
+- lib/lingvanex/errors.rb
+- lib/lingvanex/version.rb
+homepage: https://github.com/mykbren/lingvanex-unofficial-rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/mykbren/lingvanex-unofficial-rb
+  source_code_uri: https://github.com/mykbren/lingvanex-unofficial-rb
+  changelog_uri: https://github.com/mykbren/lingvanex-unofficial-rb/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: Unofficial Ruby wrapper for the Lingvanex Translation API
+test_files: []