wovnrb 3.2.0 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b81d287414c2bec2a702a64f26f3bb7d17af912b558e420f5483b1adea3319e7
-  data.tar.gz: 638c81c1d8935753526b11a0a5d36b4d661fbb9cc7739054b121e66f6000c142
+  metadata.gz: e5c458ea4be1b5bc1325a0c54a9672f7fd744b864975699ae48e70acde6d5265
+  data.tar.gz: 318102aa29ae9bbb03d5cf0b1ccffa3f39ada7a8fc963daad856b058f46e46ec
 SHA512:
-  metadata.gz: f801b9ea2a61e7b1a0192d521ffcaac701262b277e732ab618aadc5fcfb41a2d812493a7e42c326726884a5b811d61763dbb5db9bc9c7bf6f7d6e47bcbfd52c1
-  data.tar.gz: f5ae170d54ac362dd74710ef05660e00f914f1cca8b1b13aeb0177478bd5d89fe472b4735df26cfd95ff854c88198f6e698c1ea33772734c52f3403af3ecbe75
+  metadata.gz: fd81bc766461ce8212a32afafc0a673790985213304c55765322e42591e34107a649d70e1133a597b88c6cda3ee0813cd1b4efbac1ff45d2d794f52d78c80814
+  data.tar.gz: fd4304143e2226ab1b9a887d45e2326da8b8b452e0a60bcbb94f3b680fc4280459e47fb3b025d6660c2d338a1d3150617fc279b279e68693b0566a41050bd3de

data/README.en.md

@@ -39,8 +39,8 @@ Insert the following into either config/application.rb or config/environments/.
 
 config.wovnrb = {
   :project_token => 'EnS!t3',
-  :default_lang => 'en',
-  :supported_langs => ['en'],
+  :default_lang => 'ja',
+  :supported_langs => ['ja', en'],
   :url_pattern => 'path'
 }
 
@@ -60,8 +60,8 @@ require 'wovnrb'
 
 use Wovnrb::Interceptor, {
   :project_token => 'EnS!t3',
-  :default_lang => 'en',
-  :supported_langs => ['en'],
+  :default_lang => 'ja',
+  :supported_langs => ['ja', 'en'],
   :url_pattern => 'path'
 }
 
@@ -74,18 +74,19 @@ After completing setup, start the Ruby Application, and make sure the WOVN.io li
 
 The following is a list of the WOVN.io Ruby Library's valid parameters.
 
-Parameter Name     | Required | Default Setting
------------------- | -------- | ----------------
-project_token      | yes      | ''
-default_lang       | yes      | 'en'
-supported_langs    | yes      | ['en']
-url_pattern        | yes      | 'path'
-lang_param_name    |          | 'wovn'
-query              |          | []
-ignore_class       |          | []
-translate_fragment |          | true
-ignore_paths       |          | []
-install_middleware |          | true
+Parameter Name        | Required | Default Setting
+----------------------| -------- | ----------------
+project_token         | yes      | ''
+default_lang          | yes      | 'ja'
+supported_langs       | yes      | ['ja', 'en']
+url_pattern           | yes      | 'path'
+lang_param_name       |          | 'wovn'
+query                 |          | []
+ignore_class          |          | []
+translate_fragment    |          | true
+ignore_paths          |          | []
+install_middleware    |          | true
+compress_api_requests |          | true
 
 ### 2.1. project_token
 
@@ -196,3 +197,7 @@ WOVN.rb needs to be added after any compression middleware.
     :install_middleware => false
   }
 ```
+
+### 2.11 compress_api_requests
+
+By default, requests to the translation API will be sent with gzip compression. Set to false to disable compression.

data/README.ja.md

@@ -44,8 +44,8 @@ bundle install
 
 config.wovnrb = {
   :project_token => 'EnS!t3',
-  :default_lang => 'en',
-  :supported_langs => ['en'],
+  :default_lang => 'ja',
+  :supported_langs => ['ja', en'],
   :url_pattern => 'path'
 }
 
@@ -63,8 +63,8 @@ require 'wovnrb'
 
 use Wovnrb::Interceptor, {
   :project_token => 'EnS!t3',
-  :default_lang => 'en',
-  :supported_langs => ['en'],
+  :default_lang => 'ja',
+  :supported_langs => ['ja', 'en'],
   :url_pattern => 'path'
 }
 
@@ -80,8 +80,8 @@ use Wovnrb::Interceptor, {
 パラメータ名       | 必須     | デフォルト設定
 ------------------ | -------- | ----------------
 project_token      | yes      | ''
-default_lang       | yes      | 'en'
-supported_langs    | yes      | ['en']
+default_lang       | yes      | 'ja'
+supported_langs    | yes      | ['ja', 'en']
 url_pattern        | yes      | 'path'
 lang_param_name    |          | 'wovn'
 query              |          | []

data/lib/wovnrb/api_translator.rb

@@ -52,25 +52,45 @@ module Wovnrb
     end
 
     def prepare_request(body)
-      data = compress_request_data(generate_request_data(body))
-      headers = {
-        'Accept-Encoding' => 'gzip',
-        'Content-Type' => 'application/octet-stream',
-        'Content-Length' => data.bytesize.to_s,
-        'X-Request-Id' => @uuid
-      }
-      request = Net::HTTP::Post.new(generate_request_path(body), headers)
+      if @store.compress_api_requests?
+        gzip_request(body)
+      else
+        json_request(body)
+      end
+    end
+
+    def gzip_request(html_body)
+      api_params = build_api_params(html_body)
+      compressed_body = compress_request_data(api_params)
+      request = Net::HTTP::Post.new(request_path(html_body), {
+                                      'Accept-Encoding' => 'gzip',
+                                      'Content-Type' => 'application/octet-stream',
+                                      'Content-Encoding' => 'gzip',
+                                      'Content-Length' => compressed_body.bytesize.to_s,
+                                      'X-Request-Id' => @uuid
+                                    })
+      request.body = compressed_body
+
+      request
+    end
 
-      request.body = data
+    def json_request(html_body)
+      api_params = build_api_params(html_body)
+      request = Net::HTTP::Post.new(request_path(html_body), {
+                                      'Accept-Encoding' => 'gzip',
+                                      'Content-Type' => 'application/json',
+                                      'X-Request-Id' => @uuid
+                                    })
+      request.body = api_params.to_json
 
       request
     end
 
-    def generate_request_path(body)
-      "#{api_uri.path.sub(/\/$/, '')}/translation?cache_key=#{generate_cache_key(body)}"
+    def request_path(body)
+      "#{api_uri.path}/translation?cache_key=#{cache_key(body)}"
     end
 
-    def generate_cache_key(body)
+    def cache_key(body)
       cache_key_components = {
         'token' => token,
         'settings_hash' => settings_hash,
@@ -83,8 +103,8 @@ module Wovnrb
       CGI.escape("(#{cache_key_components})")
     end
 
-    def generate_request_data(body)
-      data = {
+    def build_api_params(body)
+      result = {
         'url' => page_url,
         'token' => token,
         'lang_code' => lang_code,
@@ -95,9 +115,9 @@ module Wovnrb
         'body' => body
       }
 
-      data['custom_lang_aliases'] = JSON.dump(custom_lang_aliases) unless custom_lang_aliases.empty?
+      result['custom_lang_aliases'] = JSON.dump(custom_lang_aliases) unless custom_lang_aliases.empty?
 
-      data
+      result
     end
 
     def compress_request_data(data_hash)
@@ -111,7 +131,7 @@ module Wovnrb
     end
 
     def api_uri
-      Addressable::URI.parse("#{@store.settings['api_url']}/v0/")
+      Addressable::URI.parse("#{@store.settings['api_url']}/v0")
     end
 
     def api_timeout

data/lib/wovnrb/store.rb

@@ -25,8 +25,8 @@ module Wovnrb
         'ignore_class' => [],
         'api_url' => 'https://wovn.global.ssl.fastly.net',
         'api_timeout_seconds' => 1.0,
-        'default_lang' => 'en',
-        'supported_langs' => ['en'],
+        'default_lang' => 'ja',
+        'supported_langs' => %w[en ja],
         'test_mode' => false,
         'test_url' => '',
         'cache_megabytes' => nil,
@@ -35,7 +35,8 @@ module Wovnrb
         'custom_lang_aliases' => {},
         'translate_fragment' => true,
         'widget_url' => 'https://j.wovn.io/1',
-        'wovn_dev_mode' => false
+        'wovn_dev_mode' => false,
+        'compress_api_requests' => true
       )
     end
 
@@ -181,6 +182,10 @@ module Wovnrb
       @settings['supported_langs'] || []
     end
 
+    def compress_api_requests?
+      @settings['compress_api_requests']
+    end
+
     def widget_url
       @settings['widget_url'] || 'https://j.wovn.io/1'
     end

data/lib/wovnrb/version.rb

@@ -1,3 +1,3 @@
 module Wovnrb
-  VERSION = '3.2.0'.freeze
+  VERSION = '3.3.1'.freeze
 end

data/test/lib/api_translator_test.rb

@@ -1,6 +1,8 @@
 require 'test_helper'
 
 module Wovnrb
+  REQUEST_UUID = 'ABCD'.freeze
+
   class ApiTranslatorTest < WovnMiniTest
     def test_translate
       assert_translation('test.html', 'test_translated.html', true)
@@ -24,6 +26,38 @@ module Wovnrb
       assert_translation('test.html', 'test_translated.html', true, encoding: 'text/json')
     end
 
+    def test_translate_without_api_compression_sends_json
+      Wovnrb::Store.instance.update_settings('compress_api_requests' => false)
+      sut, _store, _headers = create_sut
+      html_body = 'foo'
+
+      stub_request(:post, %r{http://wovn\.global\.ssl\.fastly\.net/v0/translation\?cache_key=.*})
+        .to_return(status: 200, body: { 'body' => 'translated_body' }.to_json)
+
+      sut.translate(html_body)
+
+      assert_requested :post, %r{http://wovn\.global\.ssl\.fastly\.net/v0/translation\?cache_key=.*},
+                       headers: {
+                         'Accept' => '*/*',
+                         'Accept-Encoding' => 'gzip',
+                         'Content-Type' => 'application/json',
+                         'User-Agent' => 'Ruby',
+                         'X-Request-Id' => REQUEST_UUID
+                       },
+                       body: {
+                         'url' => 'http://wovn.io/test',
+                         'token' => '123456',
+                         'lang_code' => 'fr',
+                         'url_pattern' => 'subdomain',
+                         'lang_param_name' => 'lang',
+                         'product' => 'WOVN.rb',
+                         'version' => VERSION,
+                         'body' => 'foo',
+                         'custom_lang_aliases' => { 'ja' => 'Japanese' }.to_json
+                       }.to_json,
+                       times: 1
+    end
+
     private
 
     def assert_translation(original_html_fixture, translated_html_fixture, success_expected, response = { encoding: 'gzip', status_code: 200 })
@@ -39,6 +73,15 @@ module Wovnrb
     end
 
     def translate(original_html, translated_html, response)
+      api_translator, store, headers = create_sut
+      translation_request_stub = stub_translation_api_request(store, headers, original_html, translated_html, response)
+
+      actual_translated_html = api_translator.translate(original_html)
+      assert_requested(translation_request_stub, times: 1) if translation_request_stub
+      actual_translated_html
+    end
+
+    def create_sut
       settings = {
         'project_token' => '123456',
         'custom_lang_aliases' => { 'ja' => 'Japanese' },
@@ -53,12 +96,9 @@ module Wovnrb
         Wovnrb.get_env('url' => 'http://fr.wovn.io/test'),
         Wovnrb.get_settings(settings)
       )
-      api_translator = ApiTranslator.new(store, headers, 'ABCD')
-      translation_request_stub = stub_translation_api_request(store, headers, original_html, translated_html, response)
+      api_translator = ApiTranslator.new(store, headers, REQUEST_UUID)
 
-      actual_translated_html = api_translator.translate(original_html)
-      assert_requested(translation_request_stub, times: 1) if translation_request_stub
-      actual_translated_html
+      [api_translator, store, headers]
     end
 
     def stub_translation_api_request(store, headers, original_html, translated_html, response)

data/test/lib/headers_test.rb

@@ -170,7 +170,7 @@ module Wovnrb
         Wovnrb.get_env('url' => 'http://wovn.io/contact', 'HTTP_X_FORWARDED_HOST' => 'wovn.io'),
         Store.instance.settings
       )
-      assert_equal('http://wovn.io/contact?wovn=ja', sut.redirect_location('ja'))
+      assert_equal('http://wovn.io/contact?wovn=en', sut.redirect_location('en'))
     end
 
     def test_redirect_location_with_lang_param_name
@@ -179,7 +179,7 @@ module Wovnrb
         Wovnrb.get_env('url' => 'http://wovn.io/contact', 'HTTP_X_FORWARDED_HOST' => 'wovn.io'),
         Store.instance.settings
       )
-      assert_equal('http://wovn.io/contact?lang=ja', sut.redirect_location('ja'))
+      assert_equal('http://wovn.io/contact?lang=en', sut.redirect_location('en'))
     end
 
     #########################

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wovnrb
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.1
 platform: ruby
 authors:
 - Wovn Technologies, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-04 00:00:00.000000000 Z
+date: 2021-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport