wovnrb 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c90040c4f9e8e77ba0a9cf1f7cde4abc204233dd94ed7c8d70baf9a27de4c11c
-  data.tar.gz: 5f25419537d1477fa55b654d3fcaa7325036828b454ad5ffb24994556f68868a
+  metadata.gz: 21db13334fd0ceefeba7a6d0f23a13c035d8ca2e97796f2c5342659369b4a5d9
+  data.tar.gz: 6453345eb832513563decad6050d3b44d2f100c203c8e0f3f9cbbd8d6cc833b5
 SHA512:
-  metadata.gz: 7d913ff2f9f2e9e1142ce64b95b88ddcf19296486d22cdbbd6ad8f24977a4da293fba7238ae092ceae7731598de37955b91056263d724dc917916272d004757c
-  data.tar.gz: 005fa22c1b8874c1dd55e6aca6e9d4af20ced80cc17ba538460e5aabc0646f37ef2a21e8230b77572f60e8c83a0af83c418730a4cdabbeb90547b753a2eeab56
+  metadata.gz: a43841cb1cd9a2fcda906663b8c8a5d46e751e37d202591f42d7eea17603df6523e8eca82538c49b7db20e9d3b1d8fd51d5e64e482ee71422384f109f699eef3
+  data.tar.gz: 6e87c0aa31e2b6853d295e600ba6fef63beb3cc5d0154a872e19a51cdc3a6d7828b1bc7ea21346dfee72c888576885256d11c84e1085608e2a5c55e693312359

data/.rubocop_todo.yml

@@ -101,6 +101,8 @@ Metrics/BlockNesting:
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
   Max: 4997
+  Exclude:
+    - 'test/lib/headers_test.rb'
 
 # Offense count: 14
 Metrics/CyclomaticComplexity:

data/README.md

@@ -78,6 +78,7 @@ 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
@@ -126,7 +127,17 @@ parameters  | Translated page's URL           | Notes
 
 	https://wovn.io/contact
 
-### 2.5. query
+### 2.5 lang_param_name
+This parameter is only valid for when `url_pattern_name` is set to `'query'`.
+
+It allows you to set the query parameter name for declaring the language of the
+page. The default value for this setting is `'wovn'`, such that a page URL in
+translated language English has the form
+`https://my-website.com/index.php?wovn=en`. If you instead set the value to
+`'lang'`, then the later URL example would have the form
+`https://my-website.com/index.php?lang=en`.
+
+### 2.6. query
 
 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)
 
@@ -140,11 +151,11 @@ If the `default_lang` is 'en', and the query is set to 'os', the above URL will
 
 	https://wovn.io/contact?os=mac
 
-### 2.6. ignore_class
+### 2.7. ignore_class
 
 This sets "Ignore class" which prevents WOVN from translating HTML elements that have a class contained in this array.
 
-### 2.7. translate_fragment
+### 2.8. 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

data/lib/wovnrb/api_translator.rb

@@ -87,6 +87,7 @@ module Wovnrb
         'token' => token,
         'lang_code' => lang_code,
         'url_pattern' => url_pattern,
+        'lang_param_name' => lang_param_name,
         'product' => 'WOVN.rb',
         'version' => VERSION,
         'body' => body
@@ -131,6 +132,10 @@ module Wovnrb
       @store.settings['url_pattern']
     end
 
+    def lang_param_name
+      @store.settings['lang_param_name']
+    end
+
     def custom_lang_aliases
       @store.settings['custom_lang_aliases']
     end

data/lib/wovnrb/headers.rb

@@ -133,10 +133,11 @@ module Wovnrb
         location = url
         case @settings['url_pattern']
         when 'query'
+          lang_param_name = @settings['lang_param_name']
           if location !~ /\?/
-            location = "#{location}?wovn=#{lang_code}"
-          else @env['REQUEST_URI'] !~ /(\?|&)wovn=/
-               location = "#{location}&wovn=#{lang_code}"
+            location = "#{location}?#{lang_param_name}=#{lang_code}"
+          else @env['REQUEST_URI'] !~ /(\?|&)#{lang_param_name}=/
+               location = "#{location}&#{lang_param_name}=#{lang_code}"
           end
         when 'subdomain'
           location = "#{lang_code.downcase}.#{location}"
@@ -187,7 +188,8 @@ module Wovnrb
 
       case @settings['url_pattern']
       when 'query'
-        return uri.sub(/(^|\?|&)wovn=#{lang_code}(&|$)/, '\1').gsub(/(\?|&)$/, '')
+        lang_param_name = @settings['lang_param_name']
+        return uri.sub(/(^|\?|&)#{lang_param_name}=#{lang_code}(&|$)/, '\1').gsub(/(\?|&)$/, '')
       when 'subdomain'
         rp = Regexp.new('(^|(//))' + lang_code + '\.', 'i')
         return uri.sub(rp, '\1')
@@ -208,7 +210,7 @@ module Wovnrb
                                  else
                                    '?'
                                  end
-          headers['Location'] += "wovn=#{lang_code}"
+          headers['Location'] += "#{@settings['lang_param_name']}=#{lang_code}"
         when 'subdomain'
           headers['Location'] = headers['Location'].sub(/\/\/([^.]+)/, '//' + lang_code + '.\1')
         # when 'path'

data/lib/wovnrb/lang.rb

@@ -91,7 +91,9 @@ module Wovnrb
     def add_lang_code(href, pattern, headers)
       return href if href =~ /^(#.*)?$/
 
-      code_to_add = Store.instance.settings['custom_lang_aliases'][@lang_code] || @lang_code
+      settings = Store.instance.settings
+      code_to_add = settings['custom_lang_aliases'][@lang_code] || @lang_code
+      lang_param_name = settings['lang_param_name']
       # absolute links
       new_href = href
       if href && href =~ /^(https?:)?\/\//i
@@ -115,7 +117,7 @@ module Wovnrb
                          href.sub(/(\/\/)([^\.]*)/, '\1' + code_to_add.downcase + '.' + '\2')
                        end
           when 'query'
-            new_href = add_query_lang_code(href, code_to_add)
+            new_href = add_query_lang_code(href, code_to_add, lang_param_name)
           else # path
             new_href = href.sub(/([^\.]*\.[^\/]*)(\/|$)/, '\1/' + code_to_add + '/')
           end
@@ -139,7 +141,7 @@ module Wovnrb
                        lang_url + current_dir + '/' + href
                      end
         when 'query'
-          new_href = add_query_lang_code(href, code_to_add)
+          new_href = add_query_lang_code(href, code_to_add, lang_param_name)
         else # path
           if href =~ /^\//
             new_href = '/' + code_to_add + href
@@ -209,10 +211,10 @@ module Wovnrb
       langs
     end
 
-    def add_query_lang_code(href, lang_code)
+    def add_query_lang_code(href, lang_code, lang_param_name)
       query_separator = href =~ /\?/ ? '&' : '?'
 
-      href.sub(/(#|$)/, "#{query_separator}wovn=#{lang_code}\\1")
+      href.sub(/(#|$)/, "#{query_separator}#{lang_param_name}=#{lang_code}\\1")
     end
   end
 end

data/lib/wovnrb/railtie.rb

@@ -1,7 +1,7 @@
 module Wovnrb
-  def self.middleware_inserted?(app)
+  def self.middleware_inserted?(app, middleware)
     app.middleware.send(:operations).each do |_, middlewares, _|
-      return true if middlewares.include?(Wovnrb::Interceptor)
+      return true if middlewares.include?(middleware)
     end
 
     false
@@ -9,7 +9,13 @@ module Wovnrb
 
   class Railtie < Rails::Railtie
     initializer 'wovnrb.configure_rails_initialization' do |app|
-      app.middleware.insert_before(0, Wovnrb::Interceptor) unless Wovnrb.middleware_inserted?(app)
+      unless Wovnrb.middleware_inserted?(app, Wovnrb::Interceptor)
+        if defined?(Rack::Deflater) && Wovnrb.middleware_inserted?(app, Rack::Deflater)
+          app.middleware.insert_after(Rack::Deflater, Wovnrb::Interceptor)
+        else
+          app.middleware.insert_before(0, Wovnrb::Interceptor)
+        end
+      end
     end
   end
 end

data/lib/wovnrb/services/html_converter.rb

@@ -176,6 +176,7 @@ module Wovnrb
       default_lang = @store.settings['default_lang']
       url_pattern = @store.settings['url_pattern']
       lang_code_aliases_json = JSON.generate(@store.settings['custom_lang_aliases'])
+      lang_param_name = @store.settings['lang_param_name']
 
       [
         "key=#{token}",
@@ -184,6 +185,7 @@ module Wovnrb
         "defaultLang=#{default_lang}",
         "urlPattern=#{url_pattern}",
         "langCodeAliases=#{lang_code_aliases_json}",
+        "langParamName=#{lang_param_name}",
         "version=WOVN.rb_#{VERSION}"
       ].join('&')
     end

data/lib/wovnrb/store.rb

@@ -20,6 +20,7 @@ module Wovnrb
         'ignore_globs' => [],
         'url_pattern' => 'path',
         'url_pattern_reg' => "/(?<lang>[^/.?]+)",
+        'lang_param_name' => 'wovn',
         'query' => [],
         'ignore_class' => [],
         'api_url' => 'https://wovn.global.ssl.fastly.net/v0/',
@@ -143,7 +144,7 @@ module Wovnrb
       if @settings['url_pattern'] == 'path'
         @settings['url_pattern_reg'] = "/(?<lang>[^/.?]+)"
       elsif @settings['url_pattern'] == 'query'
-        @settings['url_pattern_reg'] = "((\\?.*&)|\\?)wovn=(?<lang>[^&]+)(&|$)"
+        @settings['url_pattern_reg'] = "((\\?.*&)|\\?)#{@settings['lang_param_name']}=(?<lang>[^&]+)(&|$)"
       elsif @settings['url_pattern'] == 'subdomain'
         @settings['url_pattern_reg'] = "^(?<lang>[^.]+)\."
       end

data/lib/wovnrb/version.rb

@@ -1,3 +1,3 @@
 module Wovnrb
-  VERSION = '2.1.0'.freeze
+  VERSION = '2.2.0'.freeze
 end

data/test/lib/api_translator_test.rb

@@ -44,7 +44,8 @@ module Wovnrb
         'custom_lang_aliases' => { 'ja' => 'Japanese' },
         'default_lang' => 'en',
         'url_pattern' => 'subdomain',
-        'url_pattern_reg' => '^(?<lang>[^.]+).'
+        'url_pattern_reg' => '^(?<lang>[^.]+).',
+        'lang_param_name' => 'lang'
       }
       store = Wovnrb::Store.instance
       store.update_settings(settings)
@@ -106,6 +107,7 @@ module Wovnrb
         'token' => '123456',
         'lang_code' => 'fr',
         'url_pattern' => 'subdomain',
+        'lang_param_name' => 'lang',
         'product' => 'WOVN.rb',
         'version' => VERSION,
         'body' => original_html,

data/test/lib/headers_test.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 
 module Wovnrb
-  class LangTest < WovnMiniTest
+  class HeadersTest < WovnMiniTest
     #########################
     # INITIALIZE
     #########################
@@ -151,7 +151,7 @@ module Wovnrb
       assert_equal('http://ja.wovn.io/contact', h.redirect_location('ja'))
     end
 
-    def test_redirect_location_without_custom_lang_code
+    def test_redirect_location_with_custom_lang_code
       Store.instance.update_settings('custom_lang_aliases' => { 'ja' => 'staging-ja' })
       h = Wovnrb::Headers.new(
         Wovnrb.get_env('url' => 'http://wovn.io/contact', 'HTTP_X_FORWARDED_HOST' => 'wovn.io'),
@@ -160,6 +160,24 @@ module Wovnrb
       assert_equal('http://staging-ja.wovn.io/contact', h.redirect_location('ja'))
     end
 
+    def test_redirect_location_without_lang_param_name
+      Store.instance.update_settings('url_pattern' => 'query')
+      sut = Wovnrb::Headers.new(
+        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'))
+    end
+
+    def test_redirect_location_with_lang_param_name
+      Store.instance.update_settings('url_pattern' => 'query', 'lang_param_name' => 'lang')
+      sut = Wovnrb::Headers.new(
+        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'))
+    end
+
     #########################
     # REQUEST_OUT
     #########################
@@ -371,6 +389,17 @@ module Wovnrb
       assert_equal('ja', headers['wovnrb.target_lang'])
     end
 
+    def test_out_with_wovn_target_lang_header_using_query_with_lang_param_name
+      Store.instance.update_settings('url_pattern' => 'query', 'lang_param_name' => 'lang')
+      sut = Wovnrb::Headers.new(
+        Wovnrb.get_env('REQUEST_URI' => 'test?lang=ja', 'HTTP_REFERER' => 'http://wovn.io/test'),
+        Store.instance.settings
+      )
+      headers = sut.out(sut.request_out('ja'))
+
+      assert_equal('ja', headers['wovnrb.target_lang'])
+    end
+
     #########################
     # GET SETTINGS
     #########################
@@ -6186,6 +6215,25 @@ module Wovnrb
       end
     end
 
+    def test_remove_lang_query_with_lang_param_name
+      sut = Wovnrb::Headers.new(Wovnrb.get_env, Wovnrb.get_settings('url_pattern' => 'query', 'lang_param_name' => 'lang'))
+
+      keys = Wovnrb::Lang::LANG.keys
+      assert_equal(39, keys.size)
+
+      for key in keys
+        uri_without_custom_lang_param = "wovn.io/?wovn=#{key}"
+        unchanged_uri = sut.remove_lang(uri_without_custom_lang_param, key)
+        assert_equal(uri_without_custom_lang_param, unchanged_uri)
+
+        uri_without_scheme = sut.remove_lang("wovn.io/?lang=#{key}", key)
+        assert_equal('wovn.io/', uri_without_scheme)
+
+        uri_with_scheme = sut.remove_lang("https://wovn.io?lang=#{key}", key)
+        assert_equal('https://wovn.io', uri_with_scheme)
+      end
+    end
+
     def test_remove_lang_query_with_nil_lang
       h = Wovnrb::Headers.new(Wovnrb.get_env, Wovnrb.get_settings('url_pattern' => 'query'))
       keys = Wovnrb::Lang::LANG.keys

data/test/lib/lang_test.rb

@@ -233,6 +233,18 @@ module Wovnrb
       assert_equal('http://fr.home.google.com', lang.add_lang_code('http://home.google.com', 'subdomain', headers))
     end
 
+    def test_add_lang_code_with_query_and_lang_param_name
+      Store.instance.update_settings('url_pattern_name' => 'query', 'lang_param_name' => 'lang')
+
+      sut = Lang.new('fr')
+      headers = Wovnrb::Headers.new(
+        Wovnrb.get_env('url' => 'http://google.com'),
+        Store.instance.settings
+      )
+
+      assert_equal('http://google.com?hey=yo&lang=fr', sut.add_lang_code('http://google.com?hey=yo', 'query', headers))
+    end
+
     def test_add_lang_code_absolute_query_no_query
       lang = Lang.new('fr')
       headers = Wovnrb::Headers.new(Wovnrb.get_env('url' => 'http://google.com'), Wovnrb.get_settings)

data/test/lib/services/html_converter_test.rb

@@ -6,7 +6,20 @@ module Wovnrb
       converter = prepare_html_converter('<html><body><a class="test">hello</a></body></html>', supported_langs: %w[en vi])
       converted_html, = converter.build_api_compatible_html
 
-      expected_html = "<html><head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"><script src=\"//j.wovn.io/1\" async=\"true\" data-wovnio=\"key=123456&amp;backend=true&amp;currentLang=en&amp;defaultLang=en&amp;urlPattern=query&amp;langCodeAliases={}&amp;version=WOVN.rb_#{VERSION}\" data-wovnio-type=\"fallback_snippet\"></script><link rel=\"alternate\" hreflang=\"en\" href=\"http://my-site.com/\"><link rel=\"alternate\" hreflang=\"vi\" href=\"http://my-site.com/?wovn=vi\"></head><body><a class=\"test\">hello</a></body></html>"
+      expected_html = "<html><head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"><script src=\"//j.wovn.io/1\" async=\"true\" data-wovnio=\"key=123456&amp;backend=true&amp;currentLang=en&amp;defaultLang=en&amp;urlPattern=query&amp;langCodeAliases={}&amp;langParamName=wovn&amp;version=WOVN.rb_#{VERSION}\" data-wovnio-type=\"fallback_snippet\"></script><link rel=\"alternate\" hreflang=\"en\" href=\"http://my-site.com/\"><link rel=\"alternate\" hreflang=\"vi\" href=\"http://my-site.com/?wovn=vi\"></head><body><a class=\"test\">hello</a></body></html>"
+      assert_equal(expected_html, converted_html)
+    end
+
+    def test_build_api_compatible_html_with_custom_lang_param_name
+      settings = {
+        supported_langs: %w[en vi],
+        url_lang_pattern: 'query',
+        lang_param_name: 'lang'
+      }
+      converter = prepare_html_converter('<html><body><a class="test">hello</a></body></html>', settings)
+      converted_html, = converter.build_api_compatible_html
+
+      expected_html = "<html><head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"><script src=\"//j.wovn.io/1\" async=\"true\" data-wovnio=\"key=123456&amp;backend=true&amp;currentLang=en&amp;defaultLang=en&amp;urlPattern=query&amp;langCodeAliases={}&amp;langParamName=lang&amp;version=WOVN.rb_#{VERSION}\" data-wovnio-type=\"fallback_snippet\"></script><link rel=\"alternate\" hreflang=\"en\" href=\"http://my-site.com/\"><link rel=\"alternate\" hreflang=\"vi\" href=\"http://my-site.com/?lang=vi\"></head><body><a class=\"test\">hello</a></body></html>"
       assert_equal(expected_html, converted_html)
     end
 
@@ -15,7 +28,7 @@ module Wovnrb
       converter = prepare_html_converter('<html><body><p>' + long_string + '</p></body></html>', supported_langs: %w[en vi])
       converted_html, = converter.build_api_compatible_html
 
-      expected_html = "<html><head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"><script src=\"//j.wovn.io/1\" async=\"true\" data-wovnio=\"key=123456&amp;backend=true&amp;currentLang=en&amp;defaultLang=en&amp;urlPattern=query&amp;langCodeAliases={}&amp;version=WOVN.rb_#{VERSION}\" data-wovnio-type=\"fallback_snippet\"></script><link rel=\"alternate\" hreflang=\"en\" href=\"http://my-site.com/\"><link rel=\"alternate\" hreflang=\"vi\" href=\"http://my-site.com/?wovn=vi\"></head><body><p>" + long_string + '</p></body></html>'
+      expected_html = "<html><head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"><script src=\"//j.wovn.io/1\" async=\"true\" data-wovnio=\"key=123456&amp;backend=true&amp;currentLang=en&amp;defaultLang=en&amp;urlPattern=query&amp;langCodeAliases={}&amp;langParamName=wovn&amp;version=WOVN.rb_#{VERSION}\" data-wovnio-type=\"fallback_snippet\"></script><link rel=\"alternate\" hreflang=\"en\" href=\"http://my-site.com/\"><link rel=\"alternate\" hreflang=\"vi\" href=\"http://my-site.com/?wovn=vi\"></head><body><p>" + long_string + '</p></body></html>'
       assert_equal(expected_html, converted_html)
     end
 
@@ -31,7 +44,7 @@ module Wovnrb
       converter = prepare_html_converter(html, ignore_class: ['ignore-me'])
       converted_html, = converter.build_api_compatible_html
 
-      expected_convert_html = "<html><head><script src=\"//j.wovn.io/1\" async=\"true\" data-wovnio=\"key=123456&amp;backend=true&amp;currentLang=en&amp;defaultLang=en&amp;urlPattern=query&amp;langCodeAliases={}&amp;version=WOVN.rb_#{VERSION}\" data-wovnio-type=\"fallback_snippet\"></script><meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"><link rel=\"alternate\" hreflang=\"en\" href=\"http://my-site.com/\"><link rel=\"alternate\" hreflang=\"fr\" href=\"http://my-site.com/?wovn=fr\"><link rel=\"alternate\" hreflang=\"ja\" href=\"http://my-site.com/?wovn=ja\"><link rel=\"alternate\" hreflang=\"vi\" href=\"http://my-site.com/?wovn=vi\"></head><body><p>Hello <span wovn-ignore=\"\"><!-- __wovn-backend-ignored-key-0 --></span></p><p></p><div><span class=\"ignore-me\"><!-- __wovn-backend-ignored-key-1 --></span></div><span>Have a nice day!</span></body></html>"
+      expected_convert_html = "<html><head><script src=\"//j.wovn.io/1\" async=\"true\" data-wovnio=\"key=123456&amp;backend=true&amp;currentLang=en&amp;defaultLang=en&amp;urlPattern=query&amp;langCodeAliases={}&amp;langParamName=wovn&amp;version=WOVN.rb_#{VERSION}\" data-wovnio-type=\"fallback_snippet\"></script><meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"><link rel=\"alternate\" hreflang=\"en\" href=\"http://my-site.com/\"><link rel=\"alternate\" hreflang=\"fr\" href=\"http://my-site.com/?wovn=fr\"><link rel=\"alternate\" hreflang=\"ja\" href=\"http://my-site.com/?wovn=ja\"><link rel=\"alternate\" hreflang=\"vi\" href=\"http://my-site.com/?wovn=vi\"></head><body><p>Hello <span wovn-ignore=\"\"><!-- __wovn-backend-ignored-key-0 --></span></p><p></p><div><span class=\"ignore-me\"><!-- __wovn-backend-ignored-key-1 --></span></div><span>Have a nice day!</span></body></html>"
       assert_equal(expected_convert_html, converted_html)
     end
 
@@ -48,7 +61,7 @@ module Wovnrb
       converter = prepare_html_converter(html, ignore_class: [])
       converted_html, = converter.build_api_compatible_html
 
-      expected_convert_html = "<html><head><script src=\"//j.wovn.io/1\" async=\"true\" data-wovnio=\"key=123456&amp;backend=true&amp;currentLang=en&amp;defaultLang=en&amp;urlPattern=query&amp;langCodeAliases={}&amp;version=WOVN.rb_#{VERSION}\" data-wovnio-type=\"fallback_snippet\"></script><meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"><link rel=\"alternate\" hreflang=\"en\" href=\"http://my-site.com/\"><link rel=\"alternate\" hreflang=\"fr\" href=\"http://my-site.com/?wovn=fr\"><link rel=\"alternate\" hreflang=\"ja\" href=\"http://my-site.com/?wovn=ja\"><link rel=\"alternate\" hreflang=\"vi\" href=\"http://my-site.com/?wovn=vi\"></head><body><form action=\"/test\" method=\"POST\"><!-- __wovn-backend-ignored-key-0 --></form></body></html>"
+      expected_convert_html = "<html><head><script src=\"//j.wovn.io/1\" async=\"true\" data-wovnio=\"key=123456&amp;backend=true&amp;currentLang=en&amp;defaultLang=en&amp;urlPattern=query&amp;langCodeAliases={}&amp;langParamName=wovn&amp;version=WOVN.rb_#{VERSION}\" data-wovnio-type=\"fallback_snippet\"></script><meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"><link rel=\"alternate\" hreflang=\"en\" href=\"http://my-site.com/\"><link rel=\"alternate\" hreflang=\"fr\" href=\"http://my-site.com/?wovn=fr\"><link rel=\"alternate\" hreflang=\"ja\" href=\"http://my-site.com/?wovn=ja\"><link rel=\"alternate\" hreflang=\"vi\" href=\"http://my-site.com/?wovn=vi\"></head><body><form action=\"/test\" method=\"POST\"><!-- __wovn-backend-ignored-key-0 --></form></body></html>"
       assert_equal(expected_convert_html, converted_html)
     end
 
@@ -63,7 +76,7 @@ module Wovnrb
       converter = prepare_html_converter(html, ignore_class: [])
       converted_html, = converter.build_api_compatible_html
 
-      expected_convert_html = "<html><head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"><script src=\"//j.wovn.io/1\" async=\"true\" data-wovnio=\"key=123456&amp;backend=true&amp;currentLang=en&amp;defaultLang=en&amp;urlPattern=query&amp;langCodeAliases={}&amp;version=WOVN.rb_#{VERSION}\" data-wovnio-type=\"fallback_snippet\"></script><link rel=\"alternate\" hreflang=\"en\" href=\"http://my-site.com/\"><link rel=\"alternate\" hreflang=\"fr\" href=\"http://my-site.com/?wovn=fr\"><link rel=\"alternate\" hreflang=\"ja\" href=\"http://my-site.com/?wovn=ja\"><link rel=\"alternate\" hreflang=\"vi\" href=\"http://my-site.com/?wovn=vi\"></head><body><input id=\"user-id\" type=\"hidden\" value=\"<!-- __wovn-backend-ignored-key-0 -->\"><input id=\"name\" type=\"text\" value=\"wovn.io\"></body></html>"
+      expected_convert_html = "<html><head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"><script src=\"//j.wovn.io/1\" async=\"true\" data-wovnio=\"key=123456&amp;backend=true&amp;currentLang=en&amp;defaultLang=en&amp;urlPattern=query&amp;langCodeAliases={}&amp;langParamName=wovn&amp;version=WOVN.rb_#{VERSION}\" data-wovnio-type=\"fallback_snippet\"></script><link rel=\"alternate\" hreflang=\"en\" href=\"http://my-site.com/\"><link rel=\"alternate\" hreflang=\"fr\" href=\"http://my-site.com/?wovn=fr\"><link rel=\"alternate\" hreflang=\"ja\" href=\"http://my-site.com/?wovn=ja\"><link rel=\"alternate\" hreflang=\"vi\" href=\"http://my-site.com/?wovn=vi\"></head><body><input id=\"user-id\" type=\"hidden\" value=\"<!-- __wovn-backend-ignored-key-0 -->\"><input id=\"name\" type=\"text\" value=\"wovn.io\"></body></html>"
       assert_equal(expected_convert_html, converted_html)
     end
 
@@ -71,7 +84,7 @@ module Wovnrb
       converter = prepare_html_converter('<html><body><a>hello</a></body></html>', supported_langs: %w[en vi])
       translated_html = converter.build
 
-      expected_html = "<html><head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"><script src=\"//j.wovn.io/1\" async=\"true\" data-wovnio=\"key=123456&amp;backend=true&amp;currentLang=en&amp;defaultLang=en&amp;urlPattern=query&amp;langCodeAliases={}&amp;version=WOVN.rb_#{VERSION}\" data-wovnio-type=\"fallback_snippet\"></script><link rel=\"alternate\" hreflang=\"en\" href=\"http://my-site.com/\"><link rel=\"alternate\" hreflang=\"vi\" href=\"http://my-site.com/?wovn=vi\"></head><body><a>hello</a></body></html>"
+      expected_html = "<html><head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"><script src=\"//j.wovn.io/1\" async=\"true\" data-wovnio=\"key=123456&amp;backend=true&amp;currentLang=en&amp;defaultLang=en&amp;urlPattern=query&amp;langCodeAliases={}&amp;langParamName=wovn&amp;version=WOVN.rb_#{VERSION}\" data-wovnio-type=\"fallback_snippet\"></script><link rel=\"alternate\" hreflang=\"en\" href=\"http://my-site.com/\"><link rel=\"alternate\" hreflang=\"vi\" href=\"http://my-site.com/?wovn=vi\"></head><body><a>hello</a></body></html>"
       assert_equal(expected_html, translated_html)
     end
 
@@ -79,7 +92,7 @@ module Wovnrb
       converter = prepare_html_converter('<html><body><a>hello</a></body></html>', supported_langs: [])
       translated_html = converter.build
 
-      expected_html = "<html><head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"><script src=\"//j.wovn.io/1\" async=\"true\" data-wovnio=\"key=123456&amp;backend=true&amp;currentLang=en&amp;defaultLang=en&amp;urlPattern=query&amp;langCodeAliases={}&amp;version=WOVN.rb_#{VERSION}\" data-wovnio-type=\"fallback_snippet\"></script></head><body><a>hello</a></body></html>"
+      expected_html = "<html><head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"><script src=\"//j.wovn.io/1\" async=\"true\" data-wovnio=\"key=123456&amp;backend=true&amp;currentLang=en&amp;defaultLang=en&amp;urlPattern=query&amp;langCodeAliases={}&amp;langParamName=wovn&amp;version=WOVN.rb_#{VERSION}\" data-wovnio-type=\"fallback_snippet\"></script></head><body><a>hello</a></body></html>"
       assert_equal(expected_html, translated_html)
     end
 
@@ -87,7 +100,7 @@ module Wovnrb
       converter = prepare_html_converter('<html><head><title>TITLE</title></head><body><a>hello</a></body></html>', supported_langs: %w[en vi])
       translated_html = converter.build
 
-      expected_html = "<html><head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"><script src=\"//j.wovn.io/1\" async=\"true\" data-wovnio=\"key=123456&amp;backend=true&amp;currentLang=en&amp;defaultLang=en&amp;urlPattern=query&amp;langCodeAliases={}&amp;version=WOVN.rb_#{VERSION}\" data-wovnio-type=\"fallback_snippet\"></script><title>TITLE</title><link rel=\"alternate\" hreflang=\"en\" href=\"http://my-site.com/\"><link rel=\"alternate\" hreflang=\"vi\" href=\"http://my-site.com/?wovn=vi\"></head><body><a>hello</a></body></html>"
+      expected_html = "<html><head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"><script src=\"//j.wovn.io/1\" async=\"true\" data-wovnio=\"key=123456&amp;backend=true&amp;currentLang=en&amp;defaultLang=en&amp;urlPattern=query&amp;langCodeAliases={}&amp;langParamName=wovn&amp;version=WOVN.rb_#{VERSION}\" data-wovnio-type=\"fallback_snippet\"></script><title>TITLE</title><link rel=\"alternate\" hreflang=\"en\" href=\"http://my-site.com/\"><link rel=\"alternate\" hreflang=\"vi\" href=\"http://my-site.com/?wovn=vi\"></head><body><a>hello</a></body></html>"
       assert_equal(expected_html, translated_html)
     end
 
@@ -95,7 +108,7 @@ module Wovnrb
       converter = prepare_html_converter('<html>hello<a>world</a></html>', supported_langs: [])
       translated_html = converter.build
 
-      expected_html = "<html><head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"><script src=\"//j.wovn.io/1\" async=\"true\" data-wovnio=\"key=123456&amp;backend=true&amp;currentLang=en&amp;defaultLang=en&amp;urlPattern=query&amp;langCodeAliases={}&amp;version=WOVN.rb_#{VERSION}\" data-wovnio-type=\"fallback_snippet\"></script></head><body>hello<a>world</a></body></html>"
+      expected_html = "<html><head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"><script src=\"//j.wovn.io/1\" async=\"true\" data-wovnio=\"key=123456&amp;backend=true&amp;currentLang=en&amp;defaultLang=en&amp;urlPattern=query&amp;langCodeAliases={}&amp;langParamName=wovn&amp;version=WOVN.rb_#{VERSION}\" data-wovnio-type=\"fallback_snippet\"></script></head><body>hello<a>world</a></body></html>"
       assert_equal(expected_html, translated_html)
     end
 
@@ -110,7 +123,7 @@ module Wovnrb
       converter = HtmlConverter.new(dom, store, headers)
       translated_html = converter.build
 
-      expected_html = "<html><head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"><script src=\"//j.wovn.io/1\" async=\"true\" data-wovnio=\"key=123456&amp;backend=true&amp;currentLang=en&amp;defaultLang=en&amp;urlPattern=query&amp;langCodeAliases={}&amp;version=WOVN.rb_#{VERSION}\" data-wovnio-type=\"fallback_snippet\"></script><link rel=\"alternate\" hreflang=\"en\" href=\"http://my-site.com/\"><link rel=\"alternate\" hreflang=\"ja\" href=\"http://my-site.com/?wovn=ja\"><link rel=\"alternate\" hreflang=\"vi\" href=\"http://my-site.com/?wovn=vi\"></head><body>hello<a>world</a></body></html>"
+      expected_html = "<html><head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"><script src=\"//j.wovn.io/1\" async=\"true\" data-wovnio=\"key=123456&amp;backend=true&amp;currentLang=en&amp;defaultLang=en&amp;urlPattern=query&amp;langCodeAliases={}&amp;langParamName=wovn&amp;version=WOVN.rb_#{VERSION}\" data-wovnio-type=\"fallback_snippet\"></script><link rel=\"alternate\" hreflang=\"en\" href=\"http://my-site.com/\"><link rel=\"alternate\" hreflang=\"ja\" href=\"http://my-site.com/?wovn=ja\"><link rel=\"alternate\" hreflang=\"vi\" href=\"http://my-site.com/?wovn=vi\"></head><body>hello<a>world</a></body></html>"
       assert_equal(expected_html, translated_html)
     end
 
@@ -125,7 +138,7 @@ module Wovnrb
       converter = HtmlConverter.new(dom, store, headers)
       translated_html = converter.build
 
-      expected_html = "<html><head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"><script src=\"//j.wovn.io/1\" async=\"true\" data-wovnio=\"key=123456&amp;backend=true&amp;currentLang=en&amp;defaultLang=en&amp;urlPattern=path&amp;langCodeAliases={}&amp;version=WOVN.rb_#{VERSION}\" data-wovnio-type=\"fallback_snippet\"></script><link rel=\"alternate\" hreflang=\"en\" href=\"http://my-site.com/\"><link rel=\"alternate\" hreflang=\"ja\" href=\"http://my-site.com/ja/\"><link rel=\"alternate\" hreflang=\"vi\" href=\"http://my-site.com/vi/\"></head><body>hello<a>world</a></body></html>"
+      expected_html = "<html><head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"><script src=\"//j.wovn.io/1\" async=\"true\" data-wovnio=\"key=123456&amp;backend=true&amp;currentLang=en&amp;defaultLang=en&amp;urlPattern=path&amp;langCodeAliases={}&amp;langParamName=wovn&amp;version=WOVN.rb_#{VERSION}\" data-wovnio-type=\"fallback_snippet\"></script><link rel=\"alternate\" hreflang=\"en\" href=\"http://my-site.com/\"><link rel=\"alternate\" hreflang=\"ja\" href=\"http://my-site.com/ja/\"><link rel=\"alternate\" hreflang=\"vi\" href=\"http://my-site.com/vi/\"></head><body>hello<a>world</a></body></html>"
       assert_equal(expected_html, translated_html)
     end
 
@@ -133,7 +146,7 @@ module Wovnrb
       converter = prepare_html_converter('<html><head><script src="/a"></script><script src="//j.wovn.io/1" async="true"</head></html>')
       converter.send(:replace_snippet)
 
-      expected_html = "<html><head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"><script src=\"//j.wovn.io/1\" async=\"true\" data-wovnio=\"key=123456&amp;backend=true&amp;currentLang=en&amp;defaultLang=en&amp;urlPattern=query&amp;langCodeAliases={}&amp;version=WOVN.rb_#{VERSION}\" data-wovnio-type=\"fallback_snippet\"></script><script src=\"/a\"></script></head><body></body></html>"
+      expected_html = "<html><head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"><script src=\"//j.wovn.io/1\" async=\"true\" data-wovnio=\"key=123456&amp;backend=true&amp;currentLang=en&amp;defaultLang=en&amp;urlPattern=query&amp;langCodeAliases={}&amp;langParamName=wovn&amp;version=WOVN.rb_#{VERSION}\" data-wovnio-type=\"fallback_snippet\"></script><script src=\"/a\"></script></head><body></body></html>"
       assert_equal(expected_html, converter.send(:html))
     end
 
@@ -174,7 +187,7 @@ module Wovnrb
 
       headers = Wovnrb::Headers.new(
         Wovnrb.get_env('url' => 'http://my-site.com'),
-        Wovnrb.get_settings(settings)
+        store.settings
       )
 
       [store, headers]

data/test/lib/store_test.rb

@@ -55,6 +55,28 @@ module Wovnrb
       assert_equal('query', s.settings['url_pattern'])
     end
 
+    def test_settings_url_pattern_query_with_lang_param_name
+      sut = Wovnrb::Store.instance
+
+      sut.update_settings('url_pattern' => 'query', 'lang_param_name' => 'lang')
+
+      assert_equal('((\\?.*&)|\\?)lang=(?<lang>[^&]+)(&|$)', sut.settings['url_pattern_reg'])
+      assert_equal('query', sut.settings['url_pattern'])
+    end
+
+    def test_lang_param_name_wovn_by_default
+      sut = Wovnrb::Store.instance
+
+      assert_equal('wovn', sut.settings['lang_param_name'])
+    end
+
+    def test_lang_param_name_update
+      sut = Wovnrb::Store.instance
+
+      sut.update_settings('lang_param_name' => 'lang')
+      assert_equal('lang', sut.settings['lang_param_name'])
+    end
+
     def test_invalid_settings
       mock = LogMock.mock_log
       store = Wovnrb::Store.instance

data/test/test_helper.rb

@@ -63,6 +63,7 @@ module Wovnrb
     settings['project_token'] = 'OHYx9'
     settings['url_pattern'] = 'path'
     settings['url_pattern_reg'] = '/(?<lang>[^/.?]+)'
+    settings['lang_param_name'] = 'wovn'
     settings['query'] = []
     settings['api_url'] = 'http://localhost/v0/values'
     settings['default_lang'] = 'en'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wovnrb
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Jeff Sandford
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-21 00:00:00.000000000 Z
+date: 2019-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport