wovnrb 3.5.0 → 3.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13d349b3045beb3370a29aca8ebe22f93fdcdeb143a7fefe0f4ecb031b8ffda9
-  data.tar.gz: da704d4f640423bc7a5c85151d3e531e95d564949812a032a925326b3a278219
+  metadata.gz: f8da9741562e23b433e622ef091da98042d6eab8dbe621cdfaa7d59bf29e58c6
+  data.tar.gz: 5a6e81693935de46ea0e7eaa3fac7d6eab40a3f1bb8e4fff594adc76699f5023
 SHA512:
-  metadata.gz: de57bbecbd55635636928d9de85a7e3e196098476684cdac3cc1f6f399434543dfd7cc7afa0cb947676cd9403c37d9122d82fa1c60dd20a304cf4cb3e5481ad4
-  data.tar.gz: aa54a84bb9b8a4d42126283ba7ca17c00214c6daf745132c1f7a4c4b50407772e8b6c8bd141f483e8d1b95b02ba3181e047a6ee51b0898daec75b688ed32881a
+  metadata.gz: 3ad1400b4c55e9989ab1c251330f5c3659ef0830a02a7e689f87e4ca248e23d9e40b65d9912a0745070151509c7243807981af7b2e985a7a973875e90ed68b71
+  data.tar.gz: c323c7912fc06eb004ab4b0ce3d130c6a7fa01b65d23472091dda391ab77f1fe4a37ac4a3edccf40462063fd4af1747530fc889306bfd0995564120a5f0b77f3

data/.rubocop.yml

@@ -4,3 +4,4 @@ inherit_from: .rubocop_todo.yml
 
 AllCops:
   SuggestExtensions: false
+  TargetRubyVersion: 2.5

data/README.en.md

@@ -74,19 +74,22 @@ After completing setup, start the Ruby Application, and make sure the WOVN.io li
 
 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      | 'ja'
-supported_langs       | yes      | ['ja', 'en']
-url_pattern           | yes      | 'path'
-lang_param_name       |          | 'wovn'
-query                 |          | []
-ignore_class          |          | []
-translate_fragment    |          | true
-ignore_paths          |          | []
-install_middleware    |          | true
-compress_api_requests |          | true
+Parameter Name                 | Required | Default Setting
+-------------------------------| -------- | ----------------
+project_token                  | yes      | ''
+default_lang                   | yes      | 'ja'
+supported_langs                | yes      | ['ja', 'en']
+url_pattern                    | yes      | 'path'
+lang_param_name                |          | 'wovn'
+query                          |          | []
+ignore_class                   |          | []
+translate_fragment             |          | true
+ignore_paths                   |          | []
+install_middleware             |          | true
+compress_api_requests          |          | true
+api_timeout_seconds            |          | 1.0
+api_timeout_search_engine_bots |          | 5.0
+translate_canonical_tag        |          | true
 
 ### 2.1. project_token
 
@@ -201,3 +204,17 @@ WOVN.rb needs to be added after any compression middleware.
 ### 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 
+request is considered timed-out. This setting defaults to `1.0`.
+
+### 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
+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`.

data/build.sh

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+set -eux
+
+TAG=$1
+cd $(dirname $0)
+docker build -t "${TAG}" -f docker/rails/Dockerfile.ECS .
+cd -

data/docker/nginx/Dockerfile

@@ -0,0 +1,18 @@
+FROM nginx:stable
+
+WORKDIR /var/tmp/nginx
+
+ADD wovnrb.conf .
+ADD scripts/startup.sh .
+ADD scripts/configure_sshd.sh .
+
+RUN apt-get update --allow-releaseinfo-change \
+    && apt install --no-install-recommends -y \
+      vim \
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/*
+
+# Setup sshd
+RUN ./configure_sshd.sh
+
+CMD ["/var/tmp/nginx/startup.sh"]

data/docker/nginx/README.md

@@ -0,0 +1,13 @@
+Update `nginx/{ENV_ID}/config`.
+And build new image.
+
+
+## How to Build
+
+*Notice*
+You need aws credentials `wovn-code-pipeline` for building image.
+If you need it, please contact to Infrastructure Team.
+
+```
+./build.sh
+```

data/docker/nginx/build.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+set -eux
+
+TAG="${1}"
+cd $(dirname $0)
+docker build -t ${TAG} .
+
+cd -

data/docker/nginx/scripts/configure_sshd.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+set -eu
+
+# Install openssh-server
+apt-get update --allow-releaseinfo-change \
+ && apt install --no-install-recommends -y \
+    openssh-server \
+ && apt-get clean \
+ && rm -rf /var/lib/apt/lists/*
+
+# Update sshd_config
+echo -e "Port 22\n" >> /etc/ssh/sshd_config
+echo -e "AllowUsers ec2-user\n" >> /etc/ssh/sshd_config
+echo -e "AuthorizedKeysFile .ssh/authorized_keys .ssh/authorized_keys2 /etc/authorized_keys/%u\n" >> /etc/ssh/sshd_config
+mkdir /etc/authorized_keys
+
+# Setup user and authorized_keys
+useradd -m -d /home/ec2-user -s /bin/bash ec2-user
+echo "ec2-user:$(cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 64 | head -n 1)" | chpasswd
+echo "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCp1wkFbEfS2CuUwSMJy5zx3SenZF6WOL0o60ngHYJ0bHWEe7e7KCdwkyKkgF8A57in2faI+nKO0ScnAYcuwEy5BJNh6789TEdNtC4mpKr7A5x0MEkAdWyjjQu/upsaDASSEmJO8dFV/xu/IEUticxA960Rz2ncOPRHFubnbFkCOUg2vy8dfZybx1d9bZWEdDrcnPFjhhxeti+Cq/OdwtTlteffUKhi7qcDKHZEGi3zHzrvXiSwKJHgyMdUNf/PzIV+9Z0G0XwrnZ/q6WQNESNaEra7Iwvl921hzlxP8RKDCaxsryAHR67BCJjqhok7qtnujQYWMNc40z1ewC0o+oat" > /etc/authorized_keys/ec2-user
+
+# Add ec2-user to wheel group
+groupadd -g 999 wheel
+sed -i -e 's/wheel:x:999:/wheel:x:999:root,ec2-user/g' /etc/group
+sed -i -e 's/^# auth       required   pam_wheel.so/auth sufficient pam_wheel.so trust/g' /etc/pam.d/su

data/docker/nginx/scripts/startup.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+set -e
+
+# Add port for sshd
+echo "Port 40022" >> /etc/ssh/sshd_config
+service ssh restart
+
+cp -a /var/tmp/nginx/wovnrb.conf /etc/nginx/conf.d/
+
+nginx -g 'daemon off;'

data/docker/nginx/wovnrb.conf

@@ -0,0 +1,19 @@
+map $http_user_agent $check_ua {
+  ~ELB-HealthChecker/ 0;
+  default 1;
+}
+
+server {
+  listen 80 default_server;
+  server_name wovn.io;
+
+  location / {
+    proxy_pass http://localhost:4000;
+    proxy_http_version 1.1;
+    proxy_set_header Upgrade $http_upgrade;
+    proxy_set_header Connection 'upgrade';
+    proxy_set_header Host $host;
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_cache_bypass $http_upgrade;
+  }
+}

data/docker/rails/Dockerfile

@@ -1,6 +1,15 @@
-FROM ruby:2.6.5
+FROM ruby:2.7.6
 
 WORKDIR /usr/src/app
 
 COPY ./TestSite/ .
-CMD ["/bin/bash", "start.sh"]
+
+RUN gem update --system
+RUN gem uninstall bundler && rm /usr/local/bin/bundle && rm /usr/local/bin/bundler
+RUN gem install bundler:2.1.4
+RUN apt update && apt install npm -y
+RUN npm install --global yarn
+RUN yarn install --check-files
+RUN bundle install
+
+CMD ["/bin/bash", "start.sh"]

data/docker/rails/Dockerfile.ECS

@@ -0,0 +1,17 @@
+FROM ruby:2.7.6
+
+WORKDIR /usr/src/app
+
+COPY docker/rails/TestSite .
+COPY lib ./wovnrb/lib
+COPY Gemfile ./wovnrb/
+COPY wovnrb.gemspec ./wovnrb/
+
+RUN gem update --system && gem uninstall bundler && \
+    rm /usr/local/bin/bundle && rm /usr/local/bin/bundler
+RUN gem install bundler:2.1.4 && bundle install
+RUN apt update -y && apt install npm -y && apt-get install openssh-server -y && apt-get install vim -y
+RUN npm install --global yarn
+RUN yarn install --check-files
+
+CMD ["/bin/bash", "start_rails.sh"]

data/docker/rails/TestSite/Gemfile

@@ -1,7 +1,7 @@
 source 'https://rubygems.org'
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-ruby '2.6.5'
+ruby '2.7.6'
 
 # Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
 gem 'rails', '~> 6.0.3', '>= 6.0.3.2'
@@ -52,5 +52,3 @@ end
 
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem
 gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
-
-gem 'wovnrb', path: './wovnrb'

data/docker/rails/TestSite/app/controllers/custom_response_controller.rb

@@ -1,5 +1,5 @@
 class CustomResponseController < ApplicationController
-  skip_before_action :verify_authenticity_token2
+  skip_before_action :verify_authenticity_token
 
   def make_response
     response_args_json = params[:response]

data/docker/rails/TestSite/config/environments/development.rb

@@ -59,4 +59,6 @@ Rails.application.configure do
   # Use an evented file watcher to asynchronously detect changes in source code,
   # routes, locales, etc. This feature depends on the listen gem.
   config.file_watcher = ActiveSupport::EventedFileUpdateChecker
+
+  config.hosts << "example.com"
 end

data/docker/rails/TestSite/config/environments/production.rb

@@ -109,4 +109,6 @@ Rails.application.configure do
   # config.active_record.database_selector = { delay: 2.seconds }
   # config.active_record.database_resolver = ActiveRecord::Middleware::DatabaseSelector::Resolver
   # config.active_record.database_resolver_context = ActiveRecord::Middleware::DatabaseSelector::Resolver::Session
+
+  config.hosts << "example.com"
 end

data/docker/rails/TestSite/config/environments/test.rb

@@ -46,4 +46,6 @@ Rails.application.configure do
 
   # Raises error for missing translations.
   # config.action_view.raise_on_missing_translations = true
+
+  config.hosts << "example.com"
 end

data/docker/rails/TestSite/package.json

@@ -3,9 +3,9 @@
   "private": true,
   "dependencies": {
     "@rails/actioncable": "^6.0.0",
-    "@rails/activestorage": "^6.0.0",
-    "@rails/ujs": "^6.0.0",
-    "@rails/webpacker": "4.3.0",
+    "@rails/activestorage": "^6.1.6",
+    "@rails/ujs": "^6.1.7",
+    "@rails/webpacker": "5.2.2",
     "turbolinks": "^5.2.0"
   },
   "version": "0.1.0",

data/docker/rails/TestSite/public/index.html

@@ -4,6 +4,6 @@
     <title>test</title>
 </head>
 <body>
-<h1>Hello WOVN.php world!</h1>
+<h1>Hello WOVN.rb world!</h1>
 </body>
 </html>

data/docker/rails/TestSite/start.sh

@@ -1,13 +1,4 @@
-cd /usr/src/app
-gem update --system
-gem uninstall bundler
-rm /usr/local/bin/bundle
-rm /usr/local/bin/bundler
-gem install bundler:2.1.4
-update --bundler
+# ./wovnrb should not be cached
+echo "gem 'wovnrb', path: './wovnrb'" >> Gemfile
 bundle install
-apt update
-apt install npm -y
-npm install --global yarn
-yarn install --check-files
 bin/rails server -b 0.0.0.0 -e development -p 4000

data/docker/rails/TestSite/start_rails.sh

@@ -0,0 +1,9 @@
+mkdir /root/.ssh
+touch /root/.ssh/authorized_keys
+echo "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCp1wkFbEfS2CuUwSMJy5zx3SenZF6WOL0o60ngHYJ0bHWEe7e7KCdwkyKkgF8A57in2faI+nKO0ScnAYcuwEy5BJNh6789TEdNtC4mpKr7A5x0MEkAdWyjjQu/upsaDASSEmJO8dFV/xu/IEUticxA960Rz2ncOPRHFubnbFkCOUg2vy8dfZybx1d9bZWEdDrcnPFjhhxeti+Cq/OdwtTlteffUKhi7qcDKHZEGi3zHzrvXiSwKJHgyMdUNf/PzIV+9Z0G0XwrnZ/q6WQNESNaEra7Iwvl921hzlxP8RKDCaxsryAHR67BCJjqhok7qtnujQYWMNc40z1ewC0o+oat" > /root/.ssh/authorized_keys
+echo "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIK8M0XAzp2KYW6pA4dmoRmC5jpfGqotxMTUXuUVTyCBc" >> /root/.ssh/authorized_keys
+echo "AuthorizedKeysFile .ssh/authorized_keys" >> /etc/ssh/sshd_config
+echo "PermitRootLogin yes" >> /etc/ssh/sshd_config
+echo "PubkeyAuthentication yes" >> /etc/ssh/sshd_config
+service ssh start
+bin/rails server -b 0.0.0.0 -e development -p 4000