wovnrb 2.2.4 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cda8576fa90acfe5742dfdb5b96b7a6a7e5cb5905a208faa41fcf97d4ca32a6
-  data.tar.gz: 5468906a83cfe9b2cb7b08025e644264e02f51c7727296aa88f1fe766774de1a
+  metadata.gz: a1667b83e9b8a2a2a79d1c152c71fac66ecc1acfe98b53f062e6929dda1d267c
+  data.tar.gz: 6fe79d1445f3e87ebd65e9d5beca3c173da6e3ae25e92de97c9b85bed95c8547
 SHA512:
-  metadata.gz: 87e18f2650e806066452abdd5397ac02b4443e4c6550a61d07835dd9b9eda1682f465b35618eabb22d6eba4f12fa4cf95ecaad394a66a971616b4a8de05a2ff5
-  data.tar.gz: 3700452cb17292a0ff7f6bd8989c192d6b7901dee3e5643c98d702f6b9127698059efc1fef463734eed3e54b804d63abf462d806a27033c4a073d3de2c9dd29f
+  metadata.gz: 560317e910fdf2966f10919126b8e7ec255ce07a9325bcd24c610eda52bb2686347e76e7123e9ffe0c22d7373220aab5e270b3d63a324dda1acec6c5a1c0d9cb
+  data.tar.gz: dbcb9693c55eb8a5b7e77d1b98e53d1bd8ae15989d498e585505a2b04137bf068ab20f4efedf4205c1c412d2882e33774875ffa14294635e2e0f1772efbda08a

data/README.en.md

@@ -0,0 +1,174 @@
+# WOVN.io Ruby Library
+
+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 process of installing WOVN.io Ruby, as well as set up and configuration process.
+
+## 1. Install
+
+### 1.1. Creating a WOVN.io account.
+
+In order to use the WOVN.io Ruby Library, you need a WOVN.io account. If you do not have an account, please first sign up for one at WOVN.io.
+
+### 1.2. Adding a Page
+
+After logging into WOVN.io, add a page that you would like translated.
+
+### 1.3. Ruby Application Settings
+
+To use the WOVN.io Ruby Library, insert the following line into your Ruby Application's Gemfile. WOVN.io currently supports version 2.0.1 and up.
+
+```ruby
+gem 'wovnrb', '>= 2.0.1'
+```
+
+After setting the above, execute the following command to install the WOVN.io Ruby Library.
+
+```bash
+bundle install
+```
+
+After installing the library, insert the following into your Ruby Application's settings file.
+
+* If you're using Ruby on Rails
+
+Insert the following into either config/application.rb or config/environments/.
+
+```ruby
+...
+
+config.wovnrb = {
+  :project_token => 'EnS!t3',
+  :default_lang => 'en',
+  :supported_langs => ['en'],
+  :url_pattern => 'path'
+}
+
+...
+```
+
+* If you're using Sinatra
+
+Insert the following into either the Application File or config.ru.
+
+```ruby
+...
+
+require 'wovnrb'
+
+use Wovnrb::Interceptor, {
+  :project_token => 'EnS!t3',
+  :default_lang => 'en',
+  :supported_langs => ['en'],
+  :url_pattern => 'path'
+}
+
+...
+```
+
+After completing setup, start the Ruby Application, and make sure the WOVN.io library is working correctly.
+
+## 2. Parameter Setting
+
+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       |          | []
+
+### 2.1. project_token
+
+Set your WOVN.io Account's Project token. This parameter is required.
+
+### 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.
+
+### 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
+----------- | ------------------------------- | -------
+'path'      | https://wovn.io/ja/contact      | Default Value. If no settings have been set, url_pattern defaults to this value.
+'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 URLs.
+
+	https://wovn.io/contact
+
+### 2.5 lang_param_name
+This parameter is only valid for when `url_pattern` 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)
+
+	https://wovn.io/ja/contact?os=mac&keyboard=us
+
+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.
+
+	https://wovn.io/contact?os=mac
+
+### 2.7. ignore_class
+
+This sets "Ignore class" which prevents WOVN from translating HTML elements that have a class contained in this array.
+
+### 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
+`translate_fragment` to `false` to prevent translating partial HTML content.
+
+### 2.9 ignore_paths
+
+This parameter tells WOVN.rb to not localize content withing given directories.
+
+The directories given will only be matched against the beginning of the URL path.
+
+For instance, if you want to not localize the admin directory of your website, you should add the following to you WOVN.rb configuration.
+```
+'ignore_paths' => ['/admin/']
+```

data/README.ja.md

@@ -0,0 +1,180 @@
+# WOVN.io Ruby Library
+
+For English users: [English](README.en.md)
+
+WOVN.io Rubyライブラリは、翻訳を提供するためにWOVN.ioを利用したライブラリです。  
+WOVN.io Ruby ライブラリは Rack Middleware としてパッケージ化されています。
+
+このドキュメントでは、WOVN.io Rubyをインストールするまでの手順や、セットアップ・設定の流れを説明しています。
+
+## 1. インストール
+
+### 1.1. WOVN.ioアカウントを作成
+
+WOVN.io Ruby Libraryを利用するには、WOVN.ioのアカウントが必要です。  
+アカウントをお持ちでない方は、まずはWOVN.ioに登録してください。
+
+### 1.2. ページ追加
+
+WOVN.ioにログイン後、翻訳したいページを追加します。
+
+### 1.3. Rubyアプリケーションの設定
+
+WOVN.io Ruby ライブラリを使用するには、以下の行を Ruby アプリケーションの Gemfile に挿入します。  
+WOVN.ioは現在、バージョン2.0.1以上をサポートしています。
+
+```ruby
+gem 'wovnrb', '>= 2.0.1'
+```
+
+以上の設定を行った後、以下のコマンドを実行して、WOVN.io Rubyライブラリをインストールします。
+
+```bash
+bundle install
+```
+
+ライブラリをインストールしたら、Rubyアプリケーションの設定ファイルに以下を挿入します。
+
+* Ruby on Rails を使っている場合
+
+`config/application.rb` または `config/environments/` に以下を挿入します。
+
+```ruby
+...
+
+config.wovnrb = {
+  :project_token => 'EnS!t3',
+  :default_lang => 'en',
+  :supported_langs => ['en'],
+  :url_pattern => 'path'
+}
+
+...
+```
+
+* Sinatra を使っている場合
+
+アプリケーション・ファイルまたは `config.ru` のいずれかに以下を挿入します。
+
+```ruby
+...
+
+require 'wovnrb'
+
+use Wovnrb::Interceptor, {
+  :project_token => 'EnS!t3',
+  :default_lang => 'en',
+  :supported_langs => ['en'],
+  :url_pattern => 'path'
+}
+
+...
+```
+
+セットアップが完了したら、Rubyアプリケーションを起動し、WOVN.ioライブラリが正常に動作していることを確認します。
+
+## 2. パラメータ設定
+
+以下に、WOVN.io Ruby ライブラリの有効なパラメータの一覧を示します。
+
+パラメータ名       | 必須     | デフォルト設定
+------------------ | -------- | ----------------
+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       |          | []
+
+### 2.1. project_token
+
+WOVN.ioアカウントのプロジェクトトークンを設定します。このパラメータは必須です。
+
+### 2.2. default_lang
+
+これはRubyアプリケーションのデフォルト言語を設定します。デフォルト値は英語（'en'）です。
+
+リクエストされたページで、デフォルトの言語パラメータが URL に含まれている場合、リクエストは翻訳前にリダイレクトされます。  
+このために `default_lang` パラメータを使用します。
+
+`default_lang` が 'en' に設定されている時に、以下のURLへのリクエストを受信した場合。
+
+	https://wovn.io/en/contact
+
+ライブラリは以下のURLにリダイレクトされます。
+
+	https://wovn.io/contact
+
+### 2.3. supported_langs
+
+これは、ウェブサイトで使用されている言語（翻訳元を含む）をライブラリに伝えます。  
+この設定では、SEO（検索エンジン最適化）に必要なメタデータを挿入することができます。
+
+ウェブサイトが英語で、WOVN.ioを使って日本語にローカライズしている場合は、以下の設定にしてください。
+```
+:supported_langs => ['en', 'ja']
+```
+**注意:** 配列の言語の順番は関係ありません。
+
+### 2.4. url_pattern
+
+ライブラリはRubyアプリケーションの中で、翻訳されるURLを新たに追加することで動作します。  
+urlの種類は `url_pattern` パラメータで設定できます。設定できるタイプは3種類。
+
+
+パラメータ  | 翻訳されたページのURL           | 備考
+----------- | ------------------------------- | -------
+'path'      | https://wovn.io/ja/contact      | デフォルト値、何も設定されていない場合、 `url_pattern` のデフォルト値はこの値になります
+'subdomain' | https://ja.wovn.io/contact      | DNSの設定が必要です
+'query'     | https://wovn.io/contact?wovn=ja | セットアップを完了するために必要なアプリケーションへの変更の最小量
+
+※ 上記は、以下のURLを使用してライブラリが翻訳したURLの例です。
+
+	https://wovn.io/contact
+
+### 2.5 lang_param_name
+
+このパラメータは `url_pattern` が `query` に設定されている場合のみ有効です。
+
+ページの言語を指定するためのクエリパラメータ名を設定することができます。
+
+この設定のデフォルト値は `wovn` であり、翻訳された英語のページのURLが `https://my-website.com/index.php?wovn=en` という形式になります。  
+代わりに `lang` に値を設定すると、URLの例は `https://my-website.com/index.php?lang=en` という形式になります。
+
+### 2.6. query
+
+WOVN.ioは翻訳されたページを検索する際にクエリパラメータを無視します。  
+翻訳ページのURLにクエリパラメータを追加したい場合は、`query` パラメータを設定する必要があります。(WOVN.ioも設定する必要があります)
+
+	https://wovn.io/ja/contact?os=mac&keyboard=us
+
+`default_lang` が `en` でクエリが空に設定されている場合、上記のURLは以下のURLに変更され、ページの翻訳を検索するようになります。
+
+	https://wovn.io/contact
+
+`default_lang` が `en` でクエリが `os` に設定されている場合、上記のURLは以下のURLに変更され、ページの翻訳を検索するようになります。
+
+	https://wovn.io/contact?os=mac
+
+### 2.7. ignore_class
+
+これは「無視するクラス」を設定し、WOVNがこの配列に含まれるクラスを持つHTML要素を変換できないようにします。
+
+### 2.8. translate_fragment
+
+このオプションでは、部分的なHTMLコンテンツの翻訳を無効にすることができます。  
+デフォルトでは、部分的なHTMLコンテンツは翻訳されますが、ウィジェットのスニペットは追加されません。  
+`translate_fragment` を `false` に設定すると、HTMLの一部が翻訳されないようになります。
+
+### 2.9 ignore_paths
+
+このパラメータは、WOVN.rbが指定されたディレクトリ内のコンテンツをローカライズしないように指示します。  
+指定されたディレクトリは、URLパスの先頭にのみマッチします。  
+例えば、ウェブサイトの管理者ディレクトリをローカライズしたくない場合は、WOVN.rbの設定に次のように追加します。
+
+```
+'ignore_paths' => ['/admin/']
+```

data/README.md

@@ -0,0 +1 @@
+./README.ja.md

data/lib/wovnrb.rb

@@ -109,7 +109,7 @@ module Wovnrb
     end
 
     def wovn_ignored?(html_body)
-      !html_body.xpath('//html[@wovn-ignore]').empty?
+      !html_body.xpath('//html[@wovn-ignore or @data-wovn-ignore]').empty?
     end
 
     def ignore_path?(path)

data/lib/wovnrb/headers.rb

@@ -8,7 +8,6 @@ module Wovnrb
     attr_reader :unmasked_pathname
     attr_reader :pathname
     attr_reader :pathname_with_trailing_slash_if_present
-    attr_reader :redis_url
 
     # Generates new instance of Wovnrb::Headers.
     # Its parameters are set by parsing env variable.
@@ -62,7 +61,6 @@ module Wovnrb
       @query = remove_lang(@query, lang_code)
       @pathname_with_trailing_slash_if_present = @pathname
       @pathname = @pathname.gsub(/\/$/, '')
-      @redis_url = "#{@host}#{@pathname}#{@query}"
     end
 
     def unmasked_pathname_without_trailing_slash

data/lib/wovnrb/lang.rb

@@ -76,7 +76,10 @@ module Wovnrb
       'tr' => { name: 'Türkçe',                   code: 'tr',         en: 'Turkish' },
       'uk' => { name: 'Українська',               code: 'uk',         en: 'Ukrainian' },
       'ur' => { name: 'اردو',                      code: 'ur',         en: 'Urdu' },
-      'vi' => { name: 'Tiếng Việt',               code: 'vi',         en: 'Vietnamese' }
+      'vi' => { name: 'Tiếng Việt',               code: 'vi',         en: 'Vietnamese' },
+      'km' => { name: 'ភាសាខ្មែរ',               code: 'km',         en: 'Khmer' },
+      'ta' => { name: 'தமிழ்',               code: 'ta',         en: 'Tamil' },
+      'si' => { name: 'සිංහල',               code: 'si',         en: 'Sinhala' }
     }.freeze
 
     # Provides the ISO639-1 code for a given lang code.

data/lib/wovnrb/railtie.rb

@@ -1,7 +1,7 @@
 module Wovnrb
   def self.middleware_inserted?(app, middleware)
     app.middleware.send(:operations).each do |_, middlewares, _|
-      return true if middlewares.include?(middleware)
+      return true if middlewares&.include?(middleware)
     end
 
     false

data/lib/wovnrb/services/html_converter.rb

@@ -43,6 +43,7 @@ module Wovnrb
 
       insert_snippet(true)
       insert_hreflang_tags
+      inject_lang_html_tag
 
       html
     end
@@ -84,7 +85,7 @@ module Wovnrb
     end
 
     def strip_wovn_ignore(node, marker)
-      put_replace_marker(node, marker) if node && node.get_attribute('wovn-ignore')
+      put_replace_marker(node, marker) if node && (node.get_attribute('wovn-ignore') || node.get_attribute('data-wovn-ignore'))
     end
 
     def put_replace_marker(node, marker)
@@ -108,15 +109,9 @@ module Wovnrb
     def inject_lang_html_tag
       root = @dom.at_css('html')
       return unless root
+      return if root['lang']
 
-      current_lang = @headers.lang_code
-      default_lang = @store.default_lang
-
-      if current_lang != default_lang
-        root['lang'] = current_lang
-      else
-        root.delete('lang')
-      end
+      root['lang'] = @store.default_lang
     end
 
     def replace_hreflangs

data/lib/wovnrb/store.rb

@@ -185,7 +185,7 @@ module Wovnrb
 
     def wovn_host
       if @settings['wovn_dev_mode']
-        'dev-wovn.io:3000'
+        'dev-wovn.io'
       else
         'wovn.io'
       end

data/lib/wovnrb/version.rb

@@ -1,3 +1,3 @@
 module Wovnrb
-  VERSION = '2.2.4'.freeze
+  VERSION = '2.5.1'.freeze
 end

data/test/lib/headers_test.rb

@@ -74,24 +74,6 @@ module Wovnrb
       assert_equal('localhost', env['SERVER_NAME'])
     end
 
-    def test_initialize_without_query
-      env = Wovnrb.get_env
-      h = Wovnrb::Headers.new(env, Wovnrb.get_settings)
-      assert_equal('wovn.io/dashboard', h.redis_url)
-    end
-
-    def test_initialize_with_query
-      env = Wovnrb.get_env
-      h = Wovnrb::Headers.new(env, Wovnrb.get_settings('query' => ['param']))
-      assert_equal('wovn.io/dashboard?param=val', h.redis_url)
-    end
-
-    def test_initialize_with_not_matching_query
-      env = Wovnrb.get_env
-      h = Wovnrb::Headers.new(env, Wovnrb.get_settings('query' => ['aaa']))
-      assert_equal('wovn.io/dashboard', h.redis_url)
-    end
-
     def test_initialize_with_proto_header
       env = Wovnrb.get_env('url' => 'http://page.com', 'HTTP_X_FORWARDED_PROTO' => 'https')
       h = Wovnrb::Headers.new(env, Wovnrb.get_settings('query' => ['aaa']))
@@ -6232,7 +6214,7 @@ module Wovnrb
       h = Wovnrb::Headers.new(Wovnrb.get_env, Wovnrb.get_settings)
 
       keys = Wovnrb::Lang::LANG.keys
-      assert_equal(74, keys.size)
+      assert_equal(77, keys.size)
 
       for key in keys
         uri_without_scheme = h.remove_lang("wovn.io/#{key}", key)
@@ -6246,7 +6228,7 @@ module Wovnrb
     def test_remove_lang_path_with_nil_lang
       h = Wovnrb::Headers.new(Wovnrb.get_env, Wovnrb.get_settings)
       keys = Wovnrb::Lang::LANG.keys
-      assert_equal(74, keys.size)
+      assert_equal(77, keys.size)
 
       uri_without_scheme = h.remove_lang('wovn.io', nil)
       assert_equal('wovn.io', uri_without_scheme)
@@ -6269,7 +6251,7 @@ module Wovnrb
       h = Wovnrb::Headers.new(Wovnrb.get_env, Wovnrb.get_settings('url_pattern' => 'query'))
 
       keys = Wovnrb::Lang::LANG.keys
-      assert_equal(74, keys.size)
+      assert_equal(77, keys.size)
 
       for key in keys
         uri_without_scheme = h.remove_lang("wovn.io/?wovn=#{key}", key)
@@ -6284,7 +6266,7 @@ module Wovnrb
       sut = Wovnrb::Headers.new(Wovnrb.get_env, Wovnrb.get_settings('url_pattern' => 'query', 'lang_param_name' => 'lang'))
 
       keys = Wovnrb::Lang::LANG.keys
-      assert_equal(74, keys.size)
+      assert_equal(77, keys.size)
 
       for key in keys
         uri_without_custom_lang_param = "wovn.io/?wovn=#{key}"
@@ -6302,7 +6284,7 @@ module Wovnrb
     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
-      assert_equal(74, keys.size)
+      assert_equal(77, keys.size)
 
       uri_without_scheme = h.remove_lang('wovn.io', nil)
       assert_equal('wovn.io', uri_without_scheme)
@@ -6325,7 +6307,7 @@ module Wovnrb
       h = Wovnrb::Headers.new(Wovnrb.get_env, Wovnrb.get_settings('url_pattern' => 'subdomain'))
 
       keys = Wovnrb::Lang::LANG.keys
-      assert_equal(74, keys.size)
+      assert_equal(77, keys.size)
 
       for key in keys
         uri_without_scheme = h.remove_lang("#{key.downcase}.wovn.io/", key)
@@ -6339,7 +6321,7 @@ module Wovnrb
     def test_remove_lang_subdomain_with_nil_lang
       h = Wovnrb::Headers.new(Wovnrb.get_env, Wovnrb.get_settings('url_pattern' => 'subdomain'))
       keys = Wovnrb::Lang::LANG.keys
-      assert_equal(74, keys.size)
+      assert_equal(77, keys.size)
 
       uri_without_scheme = h.remove_lang('wovn.io', nil)
       assert_equal('wovn.io', uri_without_scheme)

data/test/lib/lang_test.rb

@@ -7,7 +7,7 @@ module Wovnrb
     end
 
     def test_langs_length
-      assert_equal(74, Wovnrb::Lang::LANG.length)
+      assert_equal(77, Wovnrb::Lang::LANG.length)
     end
 
     def test_keys_exist

data/test/lib/services/html_converter_test.rb

@@ -6,7 +6,7 @@ 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;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>"
+      expected_html = "<html lang=\"en\"><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
 
@@ -19,7 +19,7 @@ module Wovnrb
       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>"
+      expected_html = "<html lang=\"en\"><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
 
@@ -28,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;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>'
+      expected_html = "<html lang=\"en\"><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
 
@@ -36,6 +36,7 @@ module Wovnrb
       html = [
         '<html><body>',
         '<p>Hello <span wovn-ignore>WOVN</span><p>',
+        '<p>Hello <span data-wovn-ignore>WOVN</span><p>',
         '<div><span class="ignore-me">should be ignored</span></div>',
         '<span>Have a nice day!</span>',
         '</body></html>'
@@ -44,7 +45,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;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>"
+      expected_convert_html = "<html lang=\"en\"><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><p>Hello <span data-wovn-ignore=\"\"><!-- __wovn-backend-ignored-key-1 --></span></p><p></p><div><span class=\"ignore-me\"><!-- __wovn-backend-ignored-key-2 --></span></div><span>Have a nice day!</span></body></html>"
       assert_equal(expected_convert_html, converted_html)
     end
 
@@ -61,7 +62,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;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>"
+      expected_convert_html = "<html lang=\"en\"><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
 
@@ -79,7 +80,7 @@ module Wovnrb
       converted_html, = converter.build_api_compatible_html
 
       expected_convert_html = [
-        '<html><head>',
+        '<html lang="en"><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="password" type="hidden" value="__wovn-backend-ignored-key-1">',
@@ -94,7 +95,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;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>"
+      expected_html = "<html lang=\"en\"><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
 
@@ -102,7 +103,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;langParamName=wovn&amp;version=WOVN.rb_#{VERSION}\" data-wovnio-type=\"fallback_snippet\"></script></head><body><a>hello</a></body></html>"
+      expected_html = "<html lang=\"en\"><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
 
@@ -110,7 +111,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;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>"
+      expected_html = "<html lang=\"en\"><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
 
@@ -118,7 +119,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;langParamName=wovn&amp;version=WOVN.rb_#{VERSION}\" data-wovnio-type=\"fallback_snippet\"></script></head><body>hello<a>world</a></body></html>"
+      expected_html = "<html lang=\"en\"><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
 
@@ -133,7 +134,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;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>"
+      expected_html = "<html lang=\"en\"><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
 
@@ -148,7 +149,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;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>"
+      expected_html = "<html lang=\"en\"><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
 
@@ -168,18 +169,33 @@ module Wovnrb
       assert_equal(expected_html, converter.send(:html))
     end
 
-    def test_inject_lang_html_tag
+    def test_inject_lang_html_tag_with_no_lang_in_html_tag
       settings = default_store_settings
       store = Wovnrb::Store.instance
       store.update_settings(settings)
 
       headers = Wovnrb::Headers.new(
-        Wovnrb.get_env('url' => 'http://my-site.com/?wovn=ja'),
+        Wovnrb.get_env('url' => 'http://my-site.com/'),
         Wovnrb.get_settings(settings)
       )
       converter = HtmlConverter.new(get_dom('<html><body>hello</body></html>'), store, headers)
       converter.send(:inject_lang_html_tag)
-      expected_html = '<html lang="ja"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"></head><body>hello</body></html>'
+      expected_html = '<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"></head><body>hello</body></html>'
+      assert_equal(expected_html, converter.send(:html))
+    end
+
+    def test_inject_lang_html_tag_with_lang_in_html_tag
+      settings = default_store_settings
+      store = Wovnrb::Store.instance
+      store.update_settings(settings)
+
+      headers = Wovnrb::Headers.new(
+        Wovnrb.get_env('url' => 'http://my-site.com/'),
+        Wovnrb.get_settings(settings)
+      )
+      converter = HtmlConverter.new(get_dom('<html lang="th"><body>hello</body></html>'), store, headers)
+      converter.send(:inject_lang_html_tag)
+      expected_html = '<html lang="th"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"></head><body>hello</body></html>'
       assert_equal(expected_html, converter.send(:html))
     end
 

data/test/lib/store_test.rb

@@ -132,6 +132,7 @@ module Wovnrb
       store.update_settings('wovn_dev_mode' => true)
 
       assert(store.dev_mode?)
+      assert_equal('dev-wovn.io', store.wovn_host)
       assert_equal('http://dev-wovn.io:3001/v0/', store.settings['api_url'])
       assert_equal(3, store.settings['api_timeout_seconds'])
     end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: wovnrb
 version: !ruby/object:Gem::Version
-  version: 2.2.4
+  version: 2.5.1
 platform: ruby
 authors:
 - Jeff Sandford
 - Antoine David
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-28 00:00:00.000000000 Z
+date: 2021-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -410,6 +410,8 @@ files:
 - Gemfile
 - LICENSE.txt
 - PULL_REQUEST_TEMPLATE
+- README.en.md
+- README.ja.md
 - README.md
 - Rakefile
 - lib/wovnrb.rb
@@ -446,7 +448,7 @@ homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -461,9 +463,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Gem for WOVN.io
 test_files:

data/README.md

@@ -1,182 +0,0 @@
-# WOVN.io Ruby Library
-
-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 process of installing WOVN.io Ruby, as well as set up and configuration process.
-
-## 1. Install
-
-### 1.1. Creating a WOVN.io account.
-
-In order to use the WOVN.io Ruby Library, you need a WOVN.io account. If you do not have an account, please first sign up for one at WOVN.io.
-
-### 1.2. Adding a Page
-
-After logging into WOVN.io, add a page that you would like translated.
-
-### 1.3. Ruby Application Settings
-
-To use the WOVN.io Ruby Library, insert the following line into your Ruby Application's Gemfile. WOVN.io currently supports version 2.0.1 and up.
-
-```ruby
-gem 'wovnrb', '>= 2.0.1'
-```
-
-After setting the above, execute the following command to install the WOVN.io Ruby Library.
-
-```bash
-bundle install
-```
-
-After installing the library, insert the following into your Ruby Application's settings file.
-
-* If you're using Ruby on Rails
-
-Insert the following into either config/application.rb or config/environments/.
-
-```ruby
-...
-
-config.wovnrb = {
-  :project_token => 'EnS!t3',
-  :default_lang => 'en',
-  :supported_langs => ['en'],
-  :url_pattern => 'path'
-}
-
-...
-```
-
-* If you're using Sinatra
-
-Insert the following into either the Application File or config.ru.
-
-```ruby
-...
-
-require 'wovnrb'
-
-use Wovnrb::Interceptor, {
-  :project_token => 'EnS!t3',
-  :default_lang => 'en',
-  :supported_langs => ['en'],
-  :url_pattern => 'path'
-}
-
-...
-```
-
-After completing setup, start the Ruby Application, and make sure the WOVN.io library is working correctly.
-
-## 2. Parameter Setting
-
-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       |          | []
-
-### 2.1. project_token
-
-Set your WOVN.io Account's Project token. This parameter is required.
-
-### 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.
-
-### 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
------------ | ------------------------------- | -------
-'path'      | https://wovn.io/ja/contact      | Default Value. If no settings have been set, url_pattern defaults to this value.
-'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 URLs.
-
-	https://wovn.io/contact
-
-### 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)
-
-	https://wovn.io/ja/contact?os=mac&keyboard=us
-
-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.
-
-	https://wovn.io/contact?os=mac
-
-### 2.7. ignore_class
-
-This sets "Ignore class" which prevents WOVN from translating HTML elements that have a class contained in this array.
-
-### 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
-`translate_fragment` to `false` to prevent translating partial HTML content.
-
-### 2.9 ignore_paths
-
-This parameter tells WOVN.rb to not localize content withing given directories.
-
-The directories given will only be matched against the beginning of the URL path.
-
-For instance, if you want to not localize the admin directory of your website, you should add the following to you WOVN.rb configuration.
-```
-'ignore_paths' => ['/admin/']
-```
-
-## 3. Contributing
-
-1. Fork it ( https://github.com/WOVNio/wovnrb/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request