translator-text 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: beb931c696d3d7ccbcafa3ff1fdfbfad976be0f2c31b54d87f71d61e980ddaa4
-  data.tar.gz: 8cd04286399ee904a25a81af6ebc941c8b187c894848cef65b9ec489678db68c
+  metadata.gz: 402064d43803ff2cdf50582b924de32b0a2252fa537a9bde2a9d9aff1eafc206
+  data.tar.gz: f297a6cf08cbeddd475a971c94e2564e03bddb7b5d2d53a338b1853ecb46014f
 SHA512:
-  metadata.gz: 9f8573a6969215b1bfb8fe325d4cd818f99a84d8e4d85fc84bfbef6d8f88f5350ae8097b0d3ff9c6c0727f76cf6ef129b426f808cd7a92e7778defda69b01638
-  data.tar.gz: d91a8916221f79605592e75dbf6e72cce5e0f9e0122e4038e6daf79be144eb0001a9d5b9fa0a065e411915083b68fa7dbe570817ab065a80557c208362770764
+  metadata.gz: 2133346bf4f959758e2ace99cfb2ef4c78aa057c248115ea82725d4b5e885019c4e36b380af3514e3e32467179261b28b5fe8f4829900e09318c462f2a5a7a7d
+  data.tar.gz: a315e3b0e877ddfe1ad399761e3ba5cec4b1d329ef5fd1554306733aa42c27bf5b1cd03e47b8cb68e5d09945b6a966e30b8df7505aad656e67dc6b9d9ba44d9a

data/.rubocop.yml

@@ -1,3 +1,7 @@
+---
+require:
+  - rubocop-rspec
+
 LineLength:
   Max: 130
 
@@ -8,7 +12,8 @@ Metrics/ParameterLists:
   CountKeywordArgs: false
 
 AllCops:
-  TargetRubyVersion: 2.2
+  TargetRubyVersion: 3.1
+  NewCops: enable
 
 EndAlignment:
   EnforcedStyleAlignWith: variable

data/.ruby-version

@@ -0,0 +1 @@
+3.1

data/CHANGELOG.md

@@ -4,12 +4,24 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## 0.2.0 (2023-04-19)
+## [0.3.1] - 2024-03-05
+### Fixes
+- Better support of errors
+
+## [0.3.0] - 2023-11-15
+### Changed
+- Add support of the COGNITIVE_SUBSCRIPTION_REGION
+- Target ruby 3.1+
+
+### Fixed
+- Upgrade Client array queries normalization
+
+## [0.2.0] - 2023-04-19
 ### Changed
 - Use dry-struct 1+
 - Switch to ruby 3.1 as default ruby version
 
-## 0.1.0 (2018-08-28)
+## [0.1.0] - 2018-08-28
 ### Added
 - Initial release
 - Support of <translation> service

data/Gemfile

@@ -1,12 +1,15 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # git_source(:github) {|repo_name| 'https://github.com/#{repo_name}' }
 
-group :test do
+group :test, :development do
   gem 'dotenv'
   gem 'rake', '~> 12'
   gem 'rspec', '~> 3'
   gem 'rubocop'
+  gem 'rubocop-rspec'
   gem 'simplecov', require: false
   gem 'webmock'
   gem 'yard'

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    translator-text (0.2.0)
+    translator-text (0.3.1)
       dry-struct (~> 1)
       httparty (~> 0.21)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.4)
+    addressable (2.8.5)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     concurrent-ruby (1.2.2)
@@ -17,7 +17,7 @@ GEM
     diff-lcs (1.5.0)
     docile (1.4.0)
     dotenv (2.8.1)
-    dry-core (1.0.0)
+    dry-core (1.0.1)
       concurrent-ruby (~> 1.0)
       zeitwerk (~> 2.6)
     dry-inflector (1.0.0)
@@ -42,41 +42,53 @@ GEM
       multi_xml (>= 0.5.2)
     ice_nine (0.11.2)
     json (2.6.3)
-    mini_mime (1.1.2)
+    language_server-protocol (3.17.0.3)
+    mini_mime (1.1.5)
     multi_xml (0.6.0)
     parallel (1.23.0)
-    parser (3.2.2.0)
+    parser (3.2.2.4)
       ast (~> 2.4.1)
-    public_suffix (5.0.1)
+      racc
+    public_suffix (5.0.3)
+    racc (1.7.3)
     rainbow (3.1.1)
     rake (12.3.3)
-    regexp_parser (2.8.0)
-    rexml (3.2.5)
+    regexp_parser (2.8.2)
+    rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
       rspec-mocks (~> 3.12.0)
     rspec-core (3.12.2)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.50.2)
+    rspec-support (3.12.1)
+    rubocop (1.57.2)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      parser (>= 3.2.2.4)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.0, < 2.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.0)
+    rubocop-ast (1.30.0)
       parser (>= 3.2.1.0)
+    rubocop-capybara (2.19.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.24.0)
+      rubocop (~> 1.33)
+    rubocop-rspec (2.25.0)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
     ruby-progressbar (1.13.0)
     simplecov (0.22.0)
       docile (~> 1.1)
@@ -84,13 +96,13 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    unicode-display_width (2.4.2)
-    webmock (3.18.1)
+    unicode-display_width (2.5.0)
+    webmock (3.19.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
     yard (0.9.34)
-    zeitwerk (2.6.7)
+    zeitwerk (2.6.12)
 
 PLATFORMS
   ruby
@@ -100,6 +112,7 @@ DEPENDENCIES
   rake (~> 12)
   rspec (~> 3)
   rubocop
+  rubocop-rspec
   simplecov
   translator-text!
   webmock

data/README.md

@@ -29,15 +29,34 @@ Or install it yourself as:
 
 ## Usage
 
-### Translation
+### Client
+
+You can instanciate your own client by passing the [Azure authentication](https://learn.microsoft.com/en-us/azure/ai-services/translator/reference/v3-0-reference#authentication) parameters.
 
 ```ruby
 require 'translator-text'
 
-api_key = ENV.fetch('COGNITIVE_SUBSCRIPTION_KEY')
-client = TranslatorText::Client.new(api_key)
+client = TranslatorText::Client.new(api_key, api_region)
+```
+
+Or use the built-in that uses the following environment variables:
+
+* `COGNITIVE_SUBSCRIPTION_KEY`: The value is the Azure secret key for your subscription to Translator.
+* `COGNITIVE_SUBSCRIPTION_REGION`: The value is the region of the multi-service or regional translator resource. This value is optional when using a global translator resource.
 
-results = client.translate(
+```ruby
+require 'translator-text'
+
+client = TranslatorText.client
+```
+
+
+### Translation
+
+```ruby
+require 'translator-text'
+
+results = TranslatorText.client.translate(
 	['something to translate', 'another something to translate'],
 	to: [:fr, :es]
 )
@@ -58,10 +77,7 @@ results = client.translate(
 ```ruby
 require 'translator-text'
 
-api_key = ENV.fetch('COGNITIVE_SUBSCRIPTION_KEY')
-client = TranslatorText::Client.new(api_key)
-
-results = client.detect(['some unknown language', 'quelque chose à détecter'])
+results = TranslatorText.client.detect(['some unknown language', 'quelque chose à détecter'])
 
 # Returns
 # [

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'yard'

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'translator-text'

data/lib/translator-text.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'translator_text/version'
 require_relative 'translator_text/exceptions'
 require_relative 'translator_text/client'
@@ -14,7 +16,10 @@ module TranslatorText
     private
 
     def build_client
-      TranslatorText::Client.new(ENV.fetch('COGNITIVE_SUBSCRIPTION_KEY'))
+      TranslatorText::Client.new(
+        ENV.fetch('COGNITIVE_SUBSCRIPTION_KEY'),
+        ENV.fetch('COGNITIVE_SUBSCRIPTION_REGION', nil)
+      )
     end
   end
 end

data/lib/translator_text/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'securerandom'
 require 'httparty'
@@ -7,15 +9,23 @@ module TranslatorText
     include HTTParty
     format :json
 
-    base_uri 'https://api.cognitive.microsofttranslator.com'.freeze
-    API_VERSION = '3.0'.freeze
+    base_uri 'https://api.cognitive.microsofttranslator.com'
+    API_VERSION = '3.0'
+
+    query_string_normalizer proc { |query|
+      query.map do |key, value|
+        Array(value).map { |v| "#{key}=#{v}" }
+      end.join('&')
+    }
 
     # Initialize the client
     # @since 1.0.0
     #
     # @param api_key [String] the Cognitive Services API Key
-    def initialize(api_key)
+    # @param api_region [String] the Cognitive Services API Region
+    def initialize(api_key, api_region = nil)
       @api_key = api_key
+      @api_region = api_region
     end
 
     # Translate a group of sentences.
@@ -33,7 +43,7 @@ module TranslatorText
       results = post(
         '/translate',
         body: build_sentences(sentences).to_json,
-        query: Hash[to: to, **options]
+        query: { to:, **options }
       )
 
       results.map { |r| Types::TranslationResult.new(r) }
@@ -68,7 +78,7 @@ module TranslatorText
 
     def post(path, params)
       options = {
-        headers: headers,
+        headers:,
         query: {}
       }.merge(params)
 
@@ -83,30 +93,28 @@ module TranslatorText
     # If success, return the response body
     # If failure, raise an error
     def handle_response(response)
-      case response.code
-      when 200..299
-        response
-      else
-        if response.request.format == :json
-          raise ServiceError.new(
-            code: response['error']['code'],
-            message: response['error']['message']
-          )
-        else
-          raise NetError.new(
-            code: response.code,
-            message: response.response.message
-          )
-        end
+      return response if response.code.between?(200, 299)
+
+      if response.request.format == :json && response['error']
+        raise ServiceError.new(
+          code: response['error']['code'],
+          message: response['error']['message']
+        )
       end
+
+      raise NetError.new(
+        code: response.code,
+        message: response.response.message
+      )
     end
 
     def headers
       {
         'Ocp-Apim-Subscription-Key' => @api_key,
+        'Ocp-Apim-Subscription-Region' => @api_region,
         'X-ClientTraceId' => SecureRandom.uuid,
         'Content-type' => 'application/json'
-      }
+      }.compact
     end
   end
 end

data/lib/translator_text/exceptions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TranslatorText
   class Error < StandardError
     attr_reader :code, :message, :errors

data/lib/translator_text/types/alternative.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TranslatorText
   module Types
     class Alternative < Dry::Struct

data/lib/translator_text/types/detection_result.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TranslatorText
   module Types
     class DetectionResult < Dry::Struct

data/lib/translator_text/types/sentence.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TranslatorText
   module Types
     class Sentence < Dry::Struct

data/lib/translator_text/types/translation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TranslatorText
   module Types
     class Translation < Dry::Struct

data/lib/translator_text/types/translation_result.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TranslatorText
   module Types
     class TranslationResult < Dry::Struct
@@ -12,9 +14,9 @@ module TranslatorText
       #
       # @return [Symbol] the language
       def detected_language
-        if h = detectedLanguage['language']
-          h.to_sym
-        end
+        return unless (h = detectedLanguage['language'])
+
+        h.to_sym
       end
     end
   end

data/lib/translator_text/types.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dry-struct'
 
 module TranslatorText

data/lib/translator_text/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TranslatorText
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.1'
 end

data/translator-text.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'translator_text/version'
@@ -21,6 +23,8 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 3.1'
   spec.add_dependency 'dry-struct', '~> 1'
   spec.add_dependency 'httparty', '~> 0.21'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: translator-text
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Aymeric Brisse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-19 00:00:00.000000000 Z
+date: 2024-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -48,6 +48,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -72,7 +73,8 @@ files:
 homepage: https://github.com/PerfectMemory/translator-text
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -81,7 +83,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="