wovnrb 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce9217e8e741e4c5e658511a29459a675d203311
-  data.tar.gz: a7d6ee08c00f2e07179b7d70b0a9f21828c5b4bf
+  metadata.gz: 2914e87079803ec545cf0d8af1e225752cd1574b
+  data.tar.gz: 503907d34e84bd4bdf89c344ebb8f3716a9ae353
 SHA512:
-  metadata.gz: bf238b6e346db998dbedc89ed1a5cb0887aa291a2fa0027c636334282fc92becdfa45bc16eba2f4344a117c21c79cc1005f64eed8608f1fa0211a27d5d15da76
-  data.tar.gz: 1338a1cced911df557811a82b3086a1fd778475528e65640b2884717aae15664f88e3684d4a0a9d37699812d08ec58e323912b4741cb5012b211b562fac5f6cc
+  metadata.gz: 6752dea082bdd0f58fea2bd8c0f6ae4364b3217da3c351697f5f0a20ad19c3e667f1300d54db0bfb5efd4da657c9ae52933a1b829a64f1b060efa0707af16a53
+  data.tar.gz: 59e9a8316c3d53aface8c5d8614eff4f3fa0ce2c0e79dd92699b618c05ba2df3f4199bdd52692d322467899c16e81085fe5f053e9eabd9795be2b63dac3b1f91

data/README.md

@@ -2,7 +2,7 @@
 
 The WOVN.io Ruby library is a library that uses WOVN.io in order to provide translations. The WOVN.io Ruby Library is packaged as Rack Middleware.
 
-This document explains the the process of installing WOVN.io Ruby, as well as set up and configuration.
+This document explains the process of installing WOVN.io Ruby, as well as set up and configuration process.
 
 ## 1. Install
 
@@ -12,7 +12,7 @@ In order to use the WOVN.io Ruby Library, you need a WOVN.io account. If you do
 
 ### 1.2. Adding a Page
 
-After logging into WOVN.io, add a page you would like translated.
+After logging into WOVN.io, add a page that you would like translated.
 
 ### 1.3. Ruby Application Settings
 
@@ -38,7 +38,10 @@ Insert the following into either config/application.rb or config/environments/.
 ...
 
 config.wovnrb = {
-  :project_token => '2Wle3'
+  :project_token => 'EnS!t3',
+  :default_lang => 'en',
+  :supported_langs => ['en'],
+  :url_pattern => 'path'
 }
 
 ...
@@ -54,7 +57,10 @@ Insert the following into either the Application File or config.ru.
 require 'wovnrb'
 
 use Wovnrb::Interceptor, {
-  :project_token => '2Wle3'
+  :project_token => 'EnS!t3',
+  :default_lang => 'en',
+  :supported_langs => ['en'],
+  :url_pattern => 'path'
 }
 
 ...
@@ -64,14 +70,15 @@ After completing setup, start the Ruby Application, and make sure the WOVN.io li
 
 ## 2. Parameter Setting
 
-WOVN.io Ruby Library's valid parameters are as follows.
+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'
 query              |          | []
-default_lang       | yes      | 'en'
 ignore_class       |          | []
 translate_fragment |          | true
 
@@ -79,9 +86,35 @@ translate_fragment |          | true
 
 Set your WOVN.io Account's Project token. This parameter is required.
 
-### 2.2. url_pattern
+### 2.2. default_lang
+
+This sets the Ruby application's default language. The default value is English ('en').
+
+If, for a requested page, the default language parameter is included in the URL, the request is redirected before translating. The default_lang parameter is used for this purpose.
+
+If the default_lang is set to 'en', when receiving a request for the following URL,
+
+	https://wovn.io/en/contact
+
+Then the library will redirect to the following URL.
+
+	https://wovn.io/contact
+
+### 2.3. supported_langs
+This tells the library which languages are being used on the website (including
+the original language). This setting allows for inserting metadata necessary for
+SEO (Search Engine Optimization).
+
+If your website is in English and you are using WOVN.io to localize it in
+Japanese, then you should use the following setting:
+```
+:supported_langs => ['en', 'ja']
+```
+**Note:** The order of the languages in the list does not matter.
 
-The Library works in the Ruby Application by adding new URL's to be translated. You can set the type of url with the url_pattern parameter. There are 3 types that can be set.
+### 2.4. url_pattern
+
+The Library works in the Ruby Application by adding new URLs to be translated. You can set the type of url with the `url_pattern` parameter. There are 3 types that can be set.
 
 parameters  | Translated page's URL           | Notes
 ----------- | ------------------------------- | -------
@@ -89,47 +122,33 @@ parameters  | Translated page's URL           | Notes
 'subdomain' | https://ja.wovn.io/contact      | DNS settings must be set.
 'query'     | https://wovn.io/contact?wovn=ja | The least amount of changes to the application required to complete setup.
 
-※ The following is an example of a URL that has been translated by the library using the above URL's.
+※ The following is an example of a URL that has been translated by the library using the above URLs.
 
 	https://wovn.io/contact
 
-### 2.3. query
+### 2.5. query
 
-WOVN.io ignores query parameters when searching translated page. If you want to add query parameter to translated page's URL, you should configure "query" parameter. (You need to configure WOVN.io too)
+WOVN.io ignores query parameters when searching a translated page. If you want to add a query parameter to translated page's URL, you should configure the `query` parameter. (You need to configure WOVN.io too)
 
 	https://wovn.io/ja/contact?os=mac&keyboard=us
 
-If the defualt_lang is 'en', and the query is set to '', the above URL will be modified into the following URL to search for the page's translation.
+If the `default_lang` is 'en', and the query is set to '', the above URL will be modified into the following URL to search for the page's translation.
 
 	https://wovn.io/contact
 
-If the default_lang is 'en', and the query is set to 'os', the above URL will be modified into the following URL to search for the page's translation.
+If the `default_lang` is 'en', and the query is set to 'os', the above URL will be modified into the following URL to search for the page's translation.
 
 	https://wovn.io/contact?os=mac
 
-### 2.4. default_lang
-
-This sets the Ruby application's default language. The default value is English ('en').
-
-If a requested page, where the default language's parameter is included in the URL, the request is redirected before translating. The default_lang parameter is used for this purpose.
-
-If the default_lang is set to 'en', when receiving a request for the following URL,
-
-	https://wovn.io/en/contact
-
-The library will redirect to the following URL.
-
-	https://wovn.io/contact
-
-### 2.5 ignore_class
+### 2.6. ignore_class
 
-This sets "Ignore class" which prevent WOVN translating HTML elements that have one of the array.
+This sets "Ignore class" which prevents WOVN from translating HTML elements that have a class contained in this array.
 
-### 2.6 translate_fragment
+### 2.7. translate_fragment
 
 This option allows to disable translating partial HTML content. By default,
 partial HTML content is translated but no widget snippet is added. Set
-"translate_fragment" to 'false' to stop translating partial HTML content.
+`translate_fragment` to `false` to prevent translating partial HTML content.
 
 ## 3. Contributing
 

data/lib/wovnrb/api_translator.rb

@@ -27,6 +27,8 @@ module Wovnrb
           response_body = Zlib::GzipReader.new(StringIO.new(response.body)).read
 
           JSON.parse(response_body)['body'] || body
+        elsif @store.dev_mode?
+          JSON.parse(response.body)['body'] || body
         else
           WovnLogger.error("Received invalid content (\"#{response.header['Content-Encoding']}\") from WOVNio translation API.")
           body

data/lib/wovnrb/store.rb

@@ -153,6 +153,16 @@ module Wovnrb
                                else
                                  true
                                end
+
+      if @settings['wovn_dev_mode']
+        if @settings['api_url'] == self.class.default_settings['api_url']
+          @settings['api_url'] = 'http://dev-wovn.io:3001/v0/'
+        end
+
+        if @settings['api_timeout_seconds'] == self.class.default_settings['api_timeout_seconds']
+          @settings['api_timeout_seconds'] = 3
+        end
+      end
     end
 
     def custom_lang_aliases
@@ -180,6 +190,10 @@ module Wovnrb
       end
     end
 
+    def dev_mode?
+      @settings['wovn_dev_mode']
+    end
+
     private
 
     def stringify_keys!(hash)

data/lib/wovnrb/version.rb

@@ -1,3 +1,3 @@
 module Wovnrb
-  VERSION = '2.0.1'.freeze
+  VERSION = '2.0.2'.freeze
 end

data/test/lib/api_translator_test.rb

@@ -19,6 +19,11 @@ module Wovnrb
       assert_translation('test.html', 'test_translated.html', false, encoding: 'unknown')
     end
 
+    def test_translate_accepts_uncompressed_response_from_api_in_dev_mode
+      Wovnrb::Store.instance.update_settings('wovn_dev_mode' => true)
+      assert_translation('test.html', 'test_translated.html', true, encoding: 'text/json')
+    end
+
     private
 
     def assert_translation(original_html_fixture, translated_html_fixture, success_expected, response = { encoding: 'gzip', status_code: 200 })
@@ -58,7 +63,12 @@ module Wovnrb
     def stub_translation_api_request(store, headers, original_html, translated_html, response)
       if response
         cache_key = generate_cache_key(store, original_html)
-        api_url = "wovn.global.ssl.fastly.net/v0/translation?cache_key=#{cache_key}"
+        api_host = if store.dev_mode?
+                     'dev-wovn.io:3001'
+                   else
+                     'wovn.global.ssl.fastly.net'
+                   end
+        api_url = "http://#{api_host}/v0/translation?cache_key=#{cache_key}"
         compressed_data = compress(generate_data(original_html))
         headers = {
           'Accept' => '*/*',
@@ -67,11 +77,16 @@ module Wovnrb
           'Content-Type' => 'application/octet-stream',
           'User-Agent' => 'Ruby'
         }
-        compressed_response = compress("{\"body\":\"#{translated_html.gsub("\n", '\n')}\"}")
+        stub_response_json = "{\"body\":\"#{translated_html.gsub("\n", '\n')}\"}"
+        stub_response = if store.dev_mode?
+                          stub_response_json
+                        else
+                          compress(stub_response_json)
+                        end
         response_headers = { 'Content-Encoding' => response[:encoding] || 'gzip' }
         stub = stub_request(:post, api_url)
                .with(body: compressed_data, headers: headers)
-               .to_return(status: response[:status_code] || 200, body: compressed_response, headers: response_headers)
+               .to_return(status: response[:status_code] || 200, body: stub_response, headers: response_headers)
 
         stub
       end

data/test/lib/store_test.rb

@@ -104,6 +104,42 @@ module Wovnrb
       assert_equal([], s.settings['ignore_globs'])
     end
 
+    def test_default_dev_mode_settings
+      store = Wovnrb::Store.instance
+
+      store.update_settings('wovn_dev_mode' => true)
+
+      assert(store.dev_mode?)
+      assert_equal('http://dev-wovn.io:3001/v0/', store.settings['api_url'])
+      assert_equal(3, store.settings['api_timeout_seconds'])
+    end
+
+    def test_dev_mode_not_overriding_settings
+      store = Wovnrb::Store.instance
+
+      store.update_settings(
+        'wovn_dev_mode' => true,
+        'api_url' => 'http://my-test-api.wovn.io/v0/',
+        'api_timeout_seconds' => 42
+      )
+
+      assert(store.dev_mode?)
+      assert_equal('http://my-test-api.wovn.io/v0/', store.settings['api_url'])
+      assert_equal(42, store.settings['api_timeout_seconds'])
+    end
+
+    def test_dev_mode?
+      store = Wovnrb::Store.instance
+
+      assert_equal(false, store.settings['wovn_dev_mode'])
+      assert(!store.dev_mode?)
+
+      store.update_settings('wovn_dev_mode' => true)
+
+      assert_equal(true, store.settings['wovn_dev_mode'])
+      assert(store.dev_mode?)
+    end
+
     def test_valid_user_token
       mock = LogMock.mock_log
       store = Wovnrb::Store.instance

data/wovnrb.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'nokogumbo', '>= 1.4.0', '< 2.0.0'
   spec.add_dependency 'rack'
 
-  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'bundler', '>= 1.7'
   spec.add_development_dependency 'guard'
   spec.add_development_dependency 'guard-rspec'
   spec.add_development_dependency 'listen', '~> 3.0.6'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wovnrb
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Jeff Sandford
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-06 00:00:00.000000000 Z
+date: 2019-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -105,14 +105,14 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
@@ -448,7 +448,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.4
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Gem for WOVN.io