translator-text 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2a23c9076d2e91225a46124d809eb0acf0b3513b
-  data.tar.gz: ef82b1270172a0ef04f5b83b5e15317b5de61383
+SHA256:
+  metadata.gz: 8632db69acab569b667be95a710ddfb4063475a820160008248099d36d0b42fc
+  data.tar.gz: d0bc41f634efd36ed604f439036188e70f3a1952d79952f650449a448c0cb535
 SHA512:
-  metadata.gz: 4552b5d7a357a5f013a0a3a36aaf9ee9d63b54a42ce3f92451ddc312e6a8a52ed239250f4289c2070b346c11a1fe43e747fe5887c08e43113352e51ad7417d6a
-  data.tar.gz: 44ff8cb26e0d4ff5f99a9f52276847cc7fbd7e31c40cb1e6a604f996227e607d8b385c0f0bd2948d90c0be5455d72e8a24d13cf9d8478ca343d03a0139e160ae
+  metadata.gz: 2286a74057def86c7fae4ed2f6e8e9b4ebb15e3d23a38a6dbf74533ac6e079fc023764270cb8f3930e2803d8d17e4b9505a7396d3c02ac78c6a843f2241e759b
+  data.tar.gz: 5edd026d712c585b93e170644424f73da279c1dad6314250a99a153a4fcca9d1ea2c7216c02bed6f068d7c6864400c4ad164035586d46ad47d79efd4682259e0

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/.travis.yml

@@ -1,5 +1,5 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.4
-before_install: gem install bundler -v 1.16.2
+  - 3.1.4
+before_install: gem install bundler -v 2.3.26

data/CHANGELOG.md

@@ -4,7 +4,20 @@ 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.1.0 (2018-08-28)
+## [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
 ### Added
 - Initial release
 - Support of <translation> service

data/Gemfile

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

data/Gemfile.lock

@@ -1,109 +1,122 @@
 PATH
   remote: .
   specs:
-    translator-text (0.1.0)
-      dry-struct (~> 0.5.0)
-      httparty (~> 0.15)
+    translator-text (0.3.0)
+      dry-struct (~> 1)
+      httparty (~> 0.21)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
-    ast (2.4.0)
-    concurrent-ruby (1.0.5)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.3)
-    docile (1.3.1)
-    dotenv (2.5.0)
-    dry-configurable (0.7.0)
+    addressable (2.8.5)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    concurrent-ruby (1.2.2)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    dotenv (2.8.1)
+    dry-core (1.0.1)
       concurrent-ruby (~> 1.0)
-    dry-container (0.6.0)
+      zeitwerk (~> 2.6)
+    dry-inflector (1.0.0)
+    dry-logic (1.5.0)
       concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.4.7)
-      concurrent-ruby (~> 1.0)
-    dry-equalizer (0.2.1)
-    dry-inflector (0.1.2)
-    dry-logic (0.4.2)
-      dry-container (~> 0.2, >= 0.2.6)
-      dry-core (~> 0.2)
-      dry-equalizer (~> 0.2)
-    dry-struct (0.5.1)
-      dry-core (~> 0.4, >= 0.4.3)
-      dry-equalizer (~> 0.2)
-      dry-types (~> 0.13)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-struct (1.6.0)
+      dry-core (~> 1.0, < 2)
+      dry-types (>= 1.7, < 2)
       ice_nine (~> 0.11)
-    dry-types (0.13.2)
+      zeitwerk (~> 2.6)
+    dry-types (1.7.1)
       concurrent-ruby (~> 1.0)
-      dry-container (~> 0.3)
-      dry-core (~> 0.4, >= 0.4.4)
-      dry-equalizer (~> 0.2)
-      dry-inflector (~> 0.1, >= 0.1.2)
-      dry-logic (~> 0.4, >= 0.4.2)
-    hashdiff (0.3.7)
-    httparty (0.16.2)
+      dry-core (~> 1.0)
+      dry-inflector (~> 1.0)
+      dry-logic (~> 1.4)
+      zeitwerk (~> 2.6)
+    hashdiff (1.0.1)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
       multi_xml (>= 0.5.2)
     ice_nine (0.11.2)
-    jaro_winkler (1.5.1)
-    json (2.1.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    mini_mime (1.1.5)
     multi_xml (0.6.0)
-    parallel (1.12.1)
-    parser (2.5.1.2)
-      ast (~> 2.4.0)
-    powerpack (0.1.2)
-    public_suffix (3.0.3)
-    rainbow (3.0.0)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.1)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    public_suffix (5.0.3)
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (12.3.3)
+    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.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    rubocop (0.58.2)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.57.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      powerpack (~> 0.1)
+      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.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.10.0)
-    safe_yaml (1.0.4)
-    simplecov (0.16.1)
+      unicode-display_width (>= 2.4.0, < 3.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)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    unicode-display_width (1.4.0)
-    webmock (3.4.2)
-      addressable (>= 2.3.6)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    unicode-display_width (2.5.0)
+    webmock (3.19.1)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
-      hashdiff
-    yard (0.9.16)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    yard (0.9.34)
+    zeitwerk (2.6.12)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
   dotenv
-  rake (~> 10.0)
-  rspec (~> 3.0)
+  rake (~> 12)
+  rspec (~> 3)
   rubocop
+  rubocop-rspec
   simplecov
   translator-text!
   webmock
   yard
 
 BUNDLED WITH
-   1.16.2
+   2.3.26

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)
 
@@ -104,9 +114,10 @@ module TranslatorText
     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
@@ -9,8 +11,6 @@ module TranslatorText
       attribute :score, Types::Float
       attribute :isTranslationSupported, Types::Bool
       attribute :isTransliterationSupported, Types::Bool
-
-      attribute :alternatives, Types::Array.of(Alternative)
     end
   end
 end

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,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'dry-struct'
 
 module TranslatorText
   # Includes all the types for the exchanges with the API
   module Types
-    include Dry::Types.module
+    include Dry.Types
 
     Symbol = Types::Symbol.constructor do |str|
       str ? str.to_sym : str

data/lib/translator_text/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TranslatorText
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.3.0'
 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.add_dependency 'dry-struct', '~> 0.5.0'
-  spec.add_dependency 'httparty', '~> 0.15'
+  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.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Aymeric Brisse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-28 00:00:00.000000000 Z
+date: 2023-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.21'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.21'
 description: API Wrapper for the Microsoft Translator Text API (Cognitive Services)
 email:
 - aymeric.brisse@perfect-memory.com
@@ -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,15 +83,14 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: API Wrapper for the Microsoft Translator Text API