wovnrb 3.7.2 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cc4b57cbbcb73d7c80599b43c3c5cc2cf942bd2488d6d53ed80cbc33810dc32
-  data.tar.gz: 075a4767449cfa394036400ab377be8659939f59c4229d9192b2042b9eabd65d
+  metadata.gz: a0283acd73cab4171aefb1bb183832a0536a2c88fd4c62ac3fef0befee06a2a2
+  data.tar.gz: b8eebae5190864b55c02f53c30e166ec955ce08c19fd7866185a7ec50df54c3c
 SHA512:
-  metadata.gz: d5952288b10b0d86e39ff6496bccc0a9c5d51ff876d0f41f07fb1b7b33cc9cab0792d2a1f7c97477849f4dedb20cfada495e6498255a987825c478f305e076f8
-  data.tar.gz: 323f2b3d50b221b67831c43b9a70e2d595bfd3d7a86f4325cbfbdb2fb700ce0cd48da7952f6a5950064d5766de34b743abd1d9f14dc3764677d61a6787a1e113
+  metadata.gz: c1b6e6f940f60e059d0b2527108660f43e17d82ca6b57ec7a4f2ec127062482494bc684e7c01bd86453d776dbe53159f19f2984a59a373e3b95920bfd1c78ee0
+  data.tar.gz: 9851f866c7df91b312f99790b165407432e6d77f6fa95774cee4016ef3ec35f7e7e0d291396dd20c48a420aaa6771d8196e53641eef53fc3abdd24cb96aa80f8

data/Gemfile

@@ -1,2 +1,30 @@
 source 'https://rubygems.org'
 gemspec
+
+# All gems below are development dependencies
+gem 'bundler', '>= 1.7'
+gem 'guard'
+gem 'guard-rspec'
+gem 'listen', '~> 3.0.6'
+gem 'minitest'
+gem 'mocha'
+gem 'pry'
+gem 'pry-nav'
+gem 'pry-remote'
+gem 'rake', '~> 10.0'
+gem 'rb-readline'
+gem 'shoulda-context'
+gem 'terminal-notifier'
+gem 'test-unit'
+gem 'test-unit-notify'
+
+gem 'rake-compiler'
+gem 'rubocop'
+gem 'rubocop-performance'
+gem 'timecop'
+
+# NOTE; it need to use webmock 2.3.2 for avoiding error when we use ruby 2.4.x.
+# https://github.com/bblimke/webmock/issues/683
+gem 'public_suffix', '~> 1.4.6'
+gem 'simplecov'
+gem 'webmock', '>= 2.3.2'

data/README.en.md

@@ -90,6 +90,7 @@ compress_api_requests          |          | true
 api_timeout_seconds            |          | 1.0
 api_timeout_search_engine_bots |          | 5.0
 translate_canonical_tag        |          | true
+custom_domain_langs            |          | {}
 
 ### 2.1. project_token
 
@@ -123,19 +124,20 @@ Japanese, then you should use the following setting:
 
 ### 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.
+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 4 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.
+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.
+'custom_domain' | Depends on `custom_domain_langs` | See [Section 2.15.](#215-custom_domain_langs).
 
 ※ 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
+### 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
@@ -169,7 +171,7 @@ 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
+### 2.9. ignore_paths
 
 This parameter tells WOVN.rb to not localize content withing given directories.
 
@@ -180,7 +182,7 @@ For instance, if you want to not localize the admin directory of your website, y
 'ignore_paths' => ['/admin/']
 ```
 
-### 2.10 install_middleware
+### 2.10. install_middleware
 
 When using WOVN.rb in a Rails environment, this parameter controls whether the WOVN.rb middleware will be automatically installed or not.
 
@@ -201,20 +203,47 @@ WOVN.rb needs to be added after any compression middleware.
   }
 ```
 
-### 2.11 compress_api_requests
+### 2.11. compress_api_requests
 
 By default, requests to the translation API will be sent with gzip compression. Set to false to disable compression.
 
-### 2.12 api_timeout_seconds
-Configures the amount of time in seconds wovnrb will wait for the translation API for a response before the 
+### 2.12. api_timeout_seconds
+Configures the amount of time in seconds wovnrb will wait for the translation API for a response before the
 request is considered timed-out. This setting defaults to `1.0`.
 
-### 2.13 api_timeout_search_engine_bots
+### 2.13. api_timeout_search_engine_bots
 Similar to `api_timeout_seconds`, this timeout setting is applied when handling requests made by search engine bots.
 Currently, bots from Google, Yahoo, Bing, Yandex, DuckDuckGo and Baidu are supported. This setting
 defaults to `5.0`.
 
-### 2.14 translate_canonical_tag
+### 2.14. translate_canonical_tag
 Configures if wovnrb should automatically translate existing canonical tag in the HTML. When set to `true`, wovnrb
 will translate the canonical URL with the current language code according to your `url_pattern` setting.
-This setting defaults to `true`.
+This setting defaults to `true`.
+
+### 2.15. custom_domain_langs
+This parameter is valid and required, when `url_pattern` is `custom_domain`.
+Set `custom_domain_langs` for all languages declared in `supported_langs`.
+
+```ruby
+config.wovnrb = {
+  # ...
+  :custom_domain_langs => {
+    'en' => { 'url' => 'wovn.io/en' },
+    'ja' => { 'url' => 'ja.wovn.io' },
+    'fr' => { 'url' => 'fr.wovn.co.jp' }
+  }
+}
+```
+
+For the example above, all request URLs that match `wovn.io/en/*` will be considered as requests in English language.
+All request URLs other than the above that match `ja.wovn.io/*` will be considered as requests in Japanese langauge.
+And, request URLs that match `fr.wovn.co.jp/*` will be considered as requests in French langauge.
+With the above example configuration, the page `http://ja.wovn.io/about.html` in Japanese language will have the URL `http://wovn.io/en/about.html` as English language.
+
+`custom_domain_langs` setting may only be used together with the `url_pattern = custom_domain` setting.
+
+If this setting is used, each language declared in `supported_langs` must be given a custom domain.
+
+The path declared for your original language must match the structure of the actual web server.
+In other words, you cannot use this setting to change the request path of your content in original language.

data/README.ja.md

@@ -2,7 +2,7 @@
 
 For English users: [English](README.en.md)
 
-WOVN.io Rubyライブラリは、翻訳を提供するためにWOVN.ioを利用したライブラリです。  
+WOVN.io Rubyライブラリは、翻訳を提供するためにWOVN.ioを利用したライブラリです。
 WOVN.io Ruby ライブラリは Rack Middleware としてパッケージ化されています。
 
 このドキュメントでは、WOVN.io Rubyをインストールするまでの手順や、セットアップ・設定の流れを説明しています。
@@ -11,7 +11,7 @@ WOVN.io Ruby ライブラリは Rack Middleware としてパッケージ化さ
 
 ### 1.1. WOVN.ioアカウントを作成
 
-WOVN.io Ruby Libraryを利用するには、WOVN.ioのアカウントが必要です。  
+WOVN.io Ruby Libraryを利用するには、WOVN.ioのアカウントが必要です。
 アカウントをお持ちでない方は、まずはWOVN.ioに登録してください。
 
 ### 1.2. ページ追加
@@ -20,7 +20,7 @@ WOVN.ioにログイン後、翻訳したいページを追加します。
 
 ### 1.3. Rubyアプリケーションの設定
 
-WOVN.io Ruby ライブラリを使用するには、以下の行を Ruby アプリケーションの Gemfile に挿入します。  
+WOVN.io Ruby ライブラリを使用するには、以下の行を Ruby アプリケーションの Gemfile に挿入します。
 WOVN.ioは現在、バージョン2.0.1以上をサポートしています。
 
 ```ruby
@@ -88,6 +88,7 @@ query              |          | []
 ignore_class       |          | []
 translate_fragment |          | true
 ignore_paths       |          | []
+custom_domain_langs|          | {}
 
 ### 2.1. project_token
 
@@ -97,7 +98,7 @@ WOVN.ioアカウントのプロジェクトトークンを設定します。こ
 
 これはRubyアプリケーションのデフォルト言語を設定します。デフォルト値は英語（'en'）です。
 
-リクエストされたページで、デフォルトの言語パラメータが URL に含まれている場合、リクエストは翻訳前にリダイレクトされます。  
+リクエストされたページで、デフォルトの言語パラメータが URL に含まれている場合、リクエストは翻訳前にリダイレクトされます。
 このために `default_lang` パラメータを使用します。
 
 `default_lang` が 'en' に設定されている時に、以下のURLへのリクエストを受信した場合。
@@ -110,7 +111,7 @@ WOVN.ioアカウントのプロジェクトトークンを設定します。こ
 
 ### 2.3. supported_langs
 
-これは、ウェブサイトで使用されている言語（翻訳元を含む）をライブラリに伝えます。  
+これは、ウェブサイトで使用されている言語（翻訳元を含む）をライブラリに伝えます。
 この設定では、SEO（検索エンジン最適化）に必要なメタデータを挿入することができます。
 
 ウェブサイトが英語で、WOVN.ioを使って日本語にローカライズしている場合は、以下の設定にしてください。
@@ -121,32 +122,33 @@ WOVN.ioアカウントのプロジェクトトークンを設定します。こ
 
 ### 2.4. url_pattern
 
-ライブラリはRubyアプリケーションの中で、翻訳されるURLを新たに追加することで動作します。  
-urlの種類は `url_pattern` パラメータで設定できます。設定できるタイプは3種類。
+ライブラリはRubyアプリケーションの中で、翻訳されるURLを新たに追加することで動作します。
+urlの種類は `url_pattern` パラメータで設定できます。設定できるタイプは4種類。
 
 
-パラメータ  | 翻訳されたページのURL           | 備考
------------ | ------------------------------- | -------
-'path'      | https://wovn.io/ja/contact      | デフォルト値、何も設定されていない場合、 `url_pattern` のデフォルト値はこの値になります
-'subdomain' | https://ja.wovn.io/contact      | DNSの設定が必要です
-'query'     | https://wovn.io/contact?wovn=ja | セットアップを完了するために必要なアプリケーションへの変更の最小量
+パラメータ        | 翻訳されたページのURL                | 備考
+--------------- | -------------------------------   | -------
+'path'          | https://wovn.io/ja/contact        | デフォルト値、何も設定されていない場合、 `url_pattern` のデフォルト値はこの値になります
+'subdomain'     | https://ja.wovn.io/contact        | DNSの設定が必要です
+'query'         | https://wovn.io/contact?wovn=ja   | セットアップを完了するために必要なアプリケーションへの変更の最小量
+'custom_domain' | `custom_domain_langs`に設定された値 | [2.10.項](#210-custom_domain_langs)を参照してください。
 
 ※ 上記は、以下のURLを使用してライブラリが翻訳したURLの例です。
 
 	https://wovn.io/contact
 
-### 2.5 lang_param_name
+### 2.5. lang_param_name
 
 このパラメータは `url_pattern` が `query` に設定されている場合のみ有効です。
 
 ページの言語を指定するためのクエリパラメータ名を設定することができます。
 
-この設定のデフォルト値は `wovn` であり、翻訳された英語のページのURLが `https://my-website.com/index.php?wovn=en` という形式になります。  
+この設定のデフォルト値は `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は翻訳されたページを検索する際にクエリパラメータを無視します。  
+WOVN.ioは翻訳されたページを検索する際にクエリパラメータを無視します。
 翻訳ページのURLにクエリパラメータを追加したい場合は、`query` パラメータを設定する必要があります。(WOVN.ioも設定する必要があります)
 
 	https://wovn.io/ja/contact?os=mac&keyboard=us
@@ -165,16 +167,45 @@ WOVN.ioは翻訳されたページを検索する際にクエリパラメータ
 
 ### 2.8. translate_fragment
 
-このオプションでは、部分的なHTMLコンテンツの翻訳を無効にすることができます。  
-デフォルトでは、部分的なHTMLコンテンツは翻訳されますが、ウィジェットのスニペットは追加されません。  
+このオプションでは、部分的なHTMLコンテンツの翻訳を無効にすることができます。
+デフォルトでは、部分的なHTMLコンテンツは翻訳されますが、ウィジェットのスニペットは追加されません。
 `translate_fragment` を `false` に設定すると、HTMLの一部が翻訳されないようになります。
 
-### 2.9 ignore_paths
+### 2.9. ignore_paths
 
-このパラメータは、WOVN.rbが指定されたディレクトリ内のコンテンツをローカライズしないように指示します。  
-指定されたディレクトリは、URLパスの先頭にのみマッチします。  
+このパラメータは、WOVN.rbが指定されたディレクトリ内のコンテンツをローカライズしないように指示します。
+指定されたディレクトリは、URLパスの先頭にのみマッチします。
 例えば、ウェブサイトの管理者ディレクトリをローカライズしたくない場合は、WOVN.rbの設定に次のように追加します。
 
 ```
 'ignore_paths' => ['/admin/']
 ```
+
+### 2.10. custom_domain_langs
+
+このパラメータは、カスタムドメイン言語パターンの場合（`url_pattern = custom_domain` が設定されている場合）のみ有効です。
+カスタムドメイン言語パターン使用時は必須パラメータです。
+`supported_langs` で設定した全ての言語と元言語に、必ず `custom_domain_langs` を設定してください。
+
+```ruby
+config.wovnrb = {
+  # ...
+  :custom_domain_langs => {
+    'en' => { 'url' => 'wovn.io/en' },
+    'ja' => { 'url' => 'ja.wovn.io' },
+    'fr' => { 'url' => 'fr.wovn.co.jp' }
+  }
+}
+```
+
+上記の例では、 `wovn.io/en/*` にマッチするリクエストは英語のリクエストとして扱われます。
+それ以外の `ja.wovn.io/*` にマッチするリクエストは日本語のリクエストとして扱われます。
+また、 `fr.wovn.co.jp/*` にマッチするリクエストはフランス語のリクエストとして扱われます。
+例えば、`http://ja.wovn.io/about.html` の日本語ページは、`http://wovn.io/en/about.html` という英語ページのURLを持つことになります。
+
+必ず `url_pattern = custom_domain`と`custom_domain_langs` は一緒に使用してください。
+
+`supported_langs` で宣言された各言語に `custom_domain_langs` を与えなければなりません。
+
+オリジナル言語のために宣言されたパスは、実際のウェブサーバーの構造と一致していなければなりません。
+この設定を使用して、オリジナル言語のリクエストパスを変更することはできません。

data/README.md

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