wovnrb 2.2.0 → 2.5.1

data/wovnrb.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport'
   spec.add_dependency 'addressable'
   spec.add_dependency 'lz4-ruby'
-  spec.add_dependency 'nokogiri', '~> 1.8.1'
+  spec.add_dependency 'nokogiri', '>= 1.8.1'
   spec.add_dependency 'nokogumbo', '>= 1.4.0', '< 2.0.0'
   spec.add_dependency 'rack'
 

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: wovnrb
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.5.1
 platform: ruby
 authors:
 - Jeff Sandford
 - Antoine David
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-11 00:00:00.000000000 Z
+date: 2021-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -57,14 +57,14 @@ dependencies:
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.1
 - !ruby/object:Gem::Dependency
@@ -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
@@ -462,7 +464,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Gem for WOVN.io
 test_files:

data/README.md

@@ -1,170 +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
-
-### 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.
-
-## 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