bing_translator 6.0.0.beta.1 → 6.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9106de975569bef3303a4940318a78b536beaf10
-  data.tar.gz: e40c556e6f474d185b74f6753635a448720600f6
+SHA256:
+  metadata.gz: 7135526b9017a66474ba77d994758c3f9bed0133527133f8d1abc5bf9461bad1
+  data.tar.gz: 4fce05ccdbb038f514dd80e7420951bad1e70e9d7b13be2d653fd7df71c5b347
 SHA512:
-  metadata.gz: 8b84d0f6c1b4a405ee631221a961f8e5462c7de1b0ca3eb26b0f0b2dc105e3b0e8ac19c085c8de320191a66895af313fc1b1f718f81b13505a6b31ab8a20108c
-  data.tar.gz: c22b944db83f5b437b9fa56e8df83da1bd69f7b81f9ef65dedb51a66d82c79714fba29701da46a6bd1b027e56ff69e54f3e5c21bddfccacddfadd3daa252e3a4
+  metadata.gz: 17393a3b1cf0e224f57cfefa1a0f9aac02cf235d415415b68c0a12c0740cb56051f4aa324c58cb822f892255ff086edd337a31c3c41efe1511fa9add84e5eb9f
+  data.tar.gz: 5368fa7751bebf485142e5b6a7e6821c25544c7a9a6e8524ef033f6cc65de7e71616935d51a8ed92a2a442634e6eff57be4bbdb6b53a3da0ed13879174766bc6

data/lib/bing_translator.rb

@@ -1,165 +1,177 @@
-#!/usr/bin/env ruby
-
-# (c) 2011-present. Ricky Elrod <ricky@elrod.me>
-# Released under the MIT license.
-require 'rubygems'
-require 'cgi'
-require 'uri'
-require 'net/http'
-require 'net/https'
-require 'json'
-
-class BingTranslator
-  class Exception < StandardError; end
-
-  class ApiClient
-    API_HOST = 'https://api.cognitive.microsofttranslator.com'.freeze
-    COGNITIVE_ACCESS_TOKEN_URI =
-      URI.parse('https://api.cognitive.microsoft.com/sts/v1.0/issueToken').freeze
-
-    def initialize(subscription_key, skip_ssl_verify)
-      @subscription_key = subscription_key
-      @skip_ssl_verify = skip_ssl_verify
-    end
-
-    def get(path, params: {}, headers: {}, authorization: false)
-      uri = request_uri(path, params)
-      request = Net::HTTP::Get.new(uri.request_uri, default_headers(authorization).merge(headers))
-
-      json_response(uri, request)
-    end
-
-    def post(path, params: {}, headers: {}, data: {}, authorization: true)
-      uri = request_uri(path, params)
-
-      request = Net::HTTP::Post.new(uri.request_uri, default_headers(authorization).merge(headers))
-      request.body = data
-
-      json_response(uri, request)
-    end
-
-    private
-
-    def default_headers(authorization = true)
-      headers = { 'Content-Type' => 'application/json' }
-      headers['Authorization'] = "Bearer #{access_token}" if authorization
-      headers
-    end
-
-    def json_response(uri, request)
-      http = http_client(uri)
-
-      response = http.request(request)
-
-      raise Exception.new("Unsuccessful API call: Code: #{response.code}") unless response.code == '200'
-      JSON.parse(response.body)
-    end
-
-    def http_client(uri)
-      http = Net::HTTP.new(uri.host, 443)
-      http.use_ssl = true
-      http.verify_mode = OpenSSL::SSL::VERIFY_NONE if @skip_ssl_verify
-      http
-    end
-
-    def request_uri(path, params)
-      encoded_params = URI.encode_www_form(params.merge('api-version' => '3.0'))
-      uri = URI.parse("#{API_HOST}#{path}")
-      uri.query = encoded_params
-      uri
-    end
-
-    def access_token
-      if @access_token.nil? || Time.now < @access_token_expiration_time
-        @access_token = request_new_access_token
-      end
-      @access_token
-    end
-
-    def request_new_access_token
-      headers = {
-        'Ocp-Apim-Subscription-Key' => @subscription_key
-      }
-
-      http = Net::HTTP.new(COGNITIVE_ACCESS_TOKEN_URI.host, COGNITIVE_ACCESS_TOKEN_URI.port)
-      http.use_ssl = true
-      http.verify_mode = OpenSSL::SSL::VERIFY_NONE if @skip_ssl_verify
-
-      response = http.post(COGNITIVE_ACCESS_TOKEN_URI.path, '', headers)
-      if response.code != '200'
-        raise Exception.new('Invalid credentials')
-      else
-        @access_token_expiration_time = Time.now + 480
-        response.body
-      end
-    end
-  end
-
-  def initialize(subscription_key, options = {})
-    skip_ssl_verify = options.fetch(:skip_ssl_verify, false)
-    @api_client = ApiClient.new(subscription_key, skip_ssl_verify)
-  end
-
-  def translate(text, params)
-    translate_array([text], params).first
-  end
-
-  def translate_array(texts, params = {})
-    translations = translation_request(texts, params)
-    translations.map do |translation|
-      translation['text'] if translation.is_a?(Hash)
-    end
-  end
-
-  def translate_array2(texts, params = {})
-    translations = translation_request(texts, params.merge('includeAlignment' => true))
-    translations.map do |translation|
-      [translation['text'], translation['alignment']['proj']] if translation.is_a?(Hash)
-    end
-  end
-
-  def detect(text)
-    data = [{ 'Text' => text }].to_json
-
-    response_json = api_client.post('/detect', data: data)
-    best_detection = response_json.sort_by { |detection| -detection['score'] }.first
-    best_detection['language'].to_sym
-  end
-
-  def speak(text, params = {})
-    raise Exception.new('Not supported since 3.0.0')
-  end
-
-  def supported_language_codes
-    response_json = api_client.get('/languages',
-                                   params: { scope: 'translation' },
-                                   authorization: false)
-    response_json['translation'].keys
-  end
-
-  def language_names(codes, locale = 'en')
-    response_json = api_client.get('/languages',
-                                   params: { scope: 'translation' },
-                                   headers: { 'Accept-Language' => locale },
-                                   authorization: false)
-    codes.map do |code|
-      response = response_json['translation'][code.to_s]
-      response['name'] unless response.nil?
-    end
-  end
-
-  private
-
-  attr_reader :api_client
-
-  def translation_request(texts, params)
-    raise Exception.new('Must provide :to.') if params[:to].nil?
-
-    data = texts.map { |text| { 'Text' => text } }.to_json
-    response_json = api_client.post('/translate', params: params, data: data)
-    response_json.map do |translation|
-      # There should be just one translation, but who knows...
-      translation['translations'].find { |result| result['to'] == params[:to].to_s }
-    end
-  end
-end
+#!/usr/bin/env ruby
+# Released under the MIT license, see LICENSE.
+require 'rubygems'
+require 'cgi'
+require 'uri'
+require 'net/http'
+require 'net/https'
+require 'json'
+
+class BingTranslator
+  class Exception < StandardError; end
+  class ApiException < BingTranslator::Exception; end
+  class UsageException < BingTranslator::Exception; end
+  class UnavailableException < BingTranslator::Exception; end
+  class AuthenticationException < BingTranslator::Exception; end
+
+  class ApiClient
+    API_HOST = 'https://api.cognitive.microsofttranslator.com'.freeze
+    COGNITIVE_ACCESS_TOKEN_URI =
+      URI.parse('https://api.cognitive.microsoft.com/sts/v1.0/issueToken').freeze
+
+    def initialize(subscription_key, skip_ssl_verify, read_timeout = 60, open_timeout = 60)
+      @subscription_key = subscription_key
+      @skip_ssl_verify = skip_ssl_verify
+      @read_timeout = read_timeout
+      @open_timeout = open_timeout
+    end
+
+    def get(path, params: {}, headers: {}, authorization: false)
+      uri = request_uri(path, params)
+      request = Net::HTTP::Get.new(uri.request_uri, default_headers(authorization).merge(headers))
+
+      json_response(uri, request)
+    end
+
+    def post(path, params: {}, headers: {}, data: {}, authorization: true)
+      uri = request_uri(path, params)
+
+      request = Net::HTTP::Post.new(uri.request_uri, default_headers(authorization).merge(headers))
+      request.body = data
+
+      json_response(uri, request)
+    end
+
+    private
+
+    def default_headers(authorization = true)
+      headers = { 'Content-Type' => 'application/json' }
+      headers['Authorization'] = "Bearer #{access_token}" if authorization
+      headers
+    end
+
+    def json_response(uri, request)
+      http = http_client(uri)
+
+      response = http.request(request)
+
+      raise ApiException.new("Unsuccessful API call: Code: #{response.code}") unless response.code == '200'
+      JSON.parse(response.body)
+    end
+
+    def http_client(uri)
+      http = Net::HTTP.new(uri.host, 443)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE if @skip_ssl_verify
+      http.read_timeout = @read_timeout
+      http.open_timeout = @open_timeout
+      http
+    end
+
+    def request_uri(path, params)
+      encoded_params = URI.encode_www_form(params.merge('api-version' => '3.0'))
+      uri = URI.parse("#{API_HOST}#{path}")
+      uri.query = encoded_params
+      uri
+    end
+
+    def access_token
+      if @access_token.nil? || Time.now >= @access_token_expiration_time
+        @access_token = request_new_access_token
+      end
+      @access_token
+    end
+
+    def request_new_access_token
+      headers = {
+        'Ocp-Apim-Subscription-Key' => @subscription_key
+      }
+
+      http = Net::HTTP.new(COGNITIVE_ACCESS_TOKEN_URI.host, COGNITIVE_ACCESS_TOKEN_URI.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE if @skip_ssl_verify
+
+      response = http.post(COGNITIVE_ACCESS_TOKEN_URI.path, '', headers)
+      case response
+      when Net::HTTPSuccess
+        @access_token_expiration_time = Time.now + 480
+        response.body
+      when Net::HTTPServerError
+        raise UnavailableException.new("#{response.code}: Credentials server unavailable")
+      else
+        raise AuthenticationException.new("Unsuccessful Access Token call: Code: #{response.code} (Invalid credentials?)")
+      end
+    end
+  end
+
+  def initialize(subscription_key, options = {})
+    skip_ssl_verify = options.fetch(:skip_ssl_verify, false)
+    read_timeout = options.fetch(:read_timeout, 60)
+    open_timeout = options.fetch(:open_timeout, 60)
+    @api_client = ApiClient.new(subscription_key, skip_ssl_verify, read_timeout, open_timeout)
+  end
+
+  def translate(text, params)
+    translate_array([text], params).first
+  end
+
+  def translate_array(texts, params = {})
+    translations = translation_request(texts, params)
+    translations.map do |translation|
+      translation['text'] if translation.is_a?(Hash)
+    end
+  end
+
+  def translate_array2(texts, params = {})
+    translations = translation_request(texts, params.merge('includeAlignment' => true))
+    translations.map do |translation|
+      [translation['text'], translation['alignment']['proj']] if translation.is_a?(Hash)
+    end
+  end
+
+  def detect(text)
+    data = [{ 'Text' => text }].to_json
+
+    response_json = api_client.post('/detect', data: data)
+    best_detection = response_json.sort_by { |detection| -detection['score'] }.first
+    best_detection['language'].to_sym
+  end
+
+  def speak(text, params = {})
+    raise UsageException.new('Not supported since 3.0.0')
+  end
+
+  def supported_language_codes
+    response_json = api_client.get('/languages',
+                                   params: { scope: 'translation' },
+                                   authorization: false)
+    response_json['translation'].keys
+  end
+
+  def language_names(codes, locale = 'en')
+    response_json = api_client.get('/languages',
+                                   params: { scope: 'translation' },
+                                   headers: { 'Accept-Language' => locale },
+                                   authorization: false)
+    codes.map do |code|
+      response = response_json['translation'][code.to_s]
+      response['name'] unless response.nil?
+    end
+  end
+
+  private
+
+  attr_reader :api_client
+
+  def translation_request(texts, params)
+    raise UsageException.new('Must provide :to.') if params[:to].nil?
+
+    data = texts.map { |text| { 'Text' => text } }.to_json
+    response_json = api_client.post('/translate', params: params, data: data)
+    to_lang = params[:to].to_s
+    response_json.map do |translation|
+      # There should be just one translation, but who knows...
+      translation['translations'].find { |result| result['to'].casecmp(to_lang).zero? }
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bing_translator
 version: !ruby/object:Gem::Version
-  version: 6.0.0.beta.1
+  version: 6.2.0
 platform: ruby
 authors:
 - Ricky Elrod
@@ -47,14 +47,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Translate using the Bing HTTP API
 test_files: []
-has_rdoc: