wovnrb 3.8.0 → 3.10.0

data/lib/wovnrb/api_translator.rb

@@ -1,173 +1,183 @@
-require 'addressable'
-require 'digest'
-require 'json'
-require 'zlib'
-
-module Wovnrb
-  class ApiTranslator
-    def initialize(store, headers, uuid)
-      @store = store
-      @headers = headers
-      @uuid = uuid
-    end
-
-    def translate(body)
-      connection = prepare_connection
-      request = prepare_request(body)
-
-      begin
-        response = connection.request(request)
-      rescue => e
-        WovnLogger.error("\"#{e.message}\" error occurred when contacting WOVNio translation API")
-        return body
-      end
-
-      case response
-      when Net::HTTPSuccess
-        begin
-          raw_response_body = @store.dev_mode? ? response.body : Zlib::GzipReader.new(StringIO.new(response.body)).read
-        rescue Zlib::GzipFile::Error
-          raw_response_body = response.body
-        end
-
-        begin
-          JSON.parse(raw_response_body)['body'] || body
-        rescue JSON::JSONError
-          body
-        end
-      else
-        WovnLogger.error("HTML-swapper call failed. Received \"#{response.message}\" from WOVNio translation API.")
-        body
-      end
-    end
-
-    private
-
-    def prepare_connection
-      connection = Net::HTTP.new(api_uri.host, api_uri.port)
-
-      connection.open_timeout = api_timeout
-      connection.read_timeout = api_timeout
-
-      connection
-    end
-
-    def prepare_request(body)
-      if @store.compress_api_requests?
-        gzip_request(body)
-      else
-        json_request(body)
-      end
-    end
-
-    def gzip_request(html_body)
-      api_params = build_api_params(html_body)
-      compressed_body = compress_request_data(api_params.to_json)
-      request = Net::HTTP::Post.new(request_path(html_body), {
-                                      'Accept-Encoding' => 'gzip',
-                                      'Content-Type' => 'application/json',
-                                      'Content-Encoding' => 'gzip',
-                                      'Content-Length' => compressed_body.bytesize.to_s,
-                                      'X-Request-Id' => @uuid
-                                    })
-      request.body = compressed_body
-
-      request
-    end
-
-    def json_request(html_body)
-      api_params = build_api_params(html_body)
-      request = Net::HTTP::Post.new(request_path(html_body), {
-                                      'Accept-Encoding' => 'gzip',
-                                      'Content-Type' => 'application/json',
-                                      'X-Request-Id' => @uuid
-                                    })
-      request.body = api_params.to_json
-
-      request
-    end
-
-    def request_path(body)
-      "#{api_uri.path}/translation?cache_key=#{cache_key(body)}"
-    end
-
-    def cache_key(body)
-      cache_key_components = {
-        'token' => token,
-        'settings_hash' => settings_hash,
-        'body_hash' => Digest::MD5.hexdigest(body),
-        'path' => page_pathname,
-        'lang' => lang_code,
-        'version' => "wovnrb_#{VERSION}"
-      }.map { |k, v| "#{k}=#{v}" }.join('&')
-
-      CGI.escape("(#{cache_key_components})")
-    end
-
-    def build_api_params(body)
-      result = {
-        'url' => page_url,
-        'token' => token,
-        'lang_code' => lang_code,
-        'url_pattern' => url_pattern,
-        'lang_param_name' => lang_param_name,
-        'translate_canonical_tag' => translate_canonical_tag,
-        'product' => 'WOVN.rb',
-        'version' => VERSION,
-        'body' => body
-      }
-
-      result['custom_lang_aliases'] = JSON.dump(custom_lang_aliases) unless custom_lang_aliases.empty?
-
-      result
-    end
-
-    def compress_request_data(data_hash)
-      ActiveSupport::Gzip.compress(data_hash)
-    end
-
-    def api_uri
-      Addressable::URI.parse("#{@store.settings['api_url']}/v0")
-    end
-
-    def api_timeout
-      @headers.search_engine_bot? ? @store.settings['api_timeout_search_engine_bots'] : @store.settings['api_timeout_seconds']
-    end
-
-    def settings_hash
-      Digest::MD5.hexdigest(JSON.dump(@store.settings))
-    end
-
-    def token
-      @store.settings['project_token']
-    end
-
-    def lang_code
-      @headers.lang_code
-    end
-
-    def url_pattern
-      @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
-
-    def translate_canonical_tag
-      @store.settings['translate_canonical_tag']
-    end
-
-    def page_url
-      "#{@headers.protocol}://#{@headers.url}"
-    end
-
-    def page_pathname
-      @headers.pathname_with_trailing_slash_if_present
-    end
-  end
-end
+require 'addressable'
+require 'digest'
+require 'json'
+require 'zlib'
+
+module Wovnrb
+  class ApiTranslator
+    def initialize(store, headers, uuid)
+      @store = store
+      @headers = headers
+      @uuid = uuid
+    end
+
+    def translate(body)
+      connection = prepare_connection
+      request = prepare_request(body)
+
+      begin
+        response = connection.request(request)
+      rescue => e
+        WovnLogger.error("\"#{e.message}\" error occurred when contacting WOVNio translation API")
+        return body
+      end
+
+      case response
+      when Net::HTTPSuccess
+        begin
+          raw_response_body = @store.dev_mode? ? response.body : Zlib::GzipReader.new(StringIO.new(response.body)).read
+        rescue Zlib::GzipFile::Error
+          raw_response_body = response.body
+        end
+
+        begin
+          JSON.parse(raw_response_body)['body'] || body
+        rescue JSON::JSONError
+          body
+        end
+      else
+        WovnLogger.error("HTML-swapper call failed. Received \"#{response.message}\" from WOVNio translation API.")
+        body
+      end
+    end
+
+    private
+
+    def prepare_connection
+      connection = Net::HTTP.new(api_uri.host, api_uri.port)
+
+      connection.open_timeout = api_timeout
+      connection.read_timeout = api_timeout
+
+      connection
+    end
+
+    def prepare_request(body)
+      if @store.compress_api_requests?
+        gzip_request(body)
+      else
+        json_request(body)
+      end
+    end
+
+    def gzip_request(html_body)
+      api_params = build_api_params(html_body)
+      compressed_body = compress_request_data(api_params.to_json)
+      request = Net::HTTP::Post.new(request_path(html_body), {
+                                      'Accept-Encoding' => 'gzip',
+                                      'Content-Type' => 'application/json',
+                                      'Content-Encoding' => 'gzip',
+                                      'Content-Length' => compressed_body.bytesize.to_s,
+                                      'X-Request-Id' => @uuid
+                                    })
+      request.body = compressed_body
+
+      request
+    end
+
+    def json_request(html_body)
+      api_params = build_api_params(html_body)
+      request = Net::HTTP::Post.new(request_path(html_body), {
+                                      'Accept-Encoding' => 'gzip',
+                                      'Content-Type' => 'application/json',
+                                      'X-Request-Id' => @uuid
+                                    })
+      request.body = api_params.to_json
+
+      request
+    end
+
+    def request_path(body)
+      "#{api_uri.path}/translation?cache_key=#{cache_key(body)}"
+    end
+
+    def cache_key(body)
+      cache_key_components = {
+        'token' => token,
+        'settings_hash' => settings_hash,
+        'body_hash' => Digest::MD5.hexdigest(body),
+        'path' => page_pathname,
+        'lang' => lang_code,
+        'version' => "wovnrb_#{VERSION}"
+      }.map { |k, v| "#{k}=#{v}" }.join('&')
+
+      CGI.escape("(#{cache_key_components})")
+    end
+
+    def build_api_params(body)
+      result = {
+        'url' => page_url,
+        'token' => token,
+        'lang_code' => lang_code,
+        'url_pattern' => url_pattern,
+        'lang_param_name' => lang_param_name,
+        'translate_canonical_tag' => translate_canonical_tag,
+        'insert_hreflangs' => insert_hreflangs,
+        'product' => 'WOVN.rb',
+        'version' => VERSION,
+        'body' => body
+      }
+
+      result['custom_lang_aliases'] = JSON.dump(custom_lang_aliases) unless custom_lang_aliases.empty?
+      result['custom_domain_langs'] = JSON.dump(custom_domain_langs) unless custom_domain_langs.empty?
+
+      result
+    end
+
+    def compress_request_data(data_hash)
+      ActiveSupport::Gzip.compress(data_hash)
+    end
+
+    def api_uri
+      Addressable::URI.parse("#{@store.settings['api_url']}/v0")
+    end
+
+    def api_timeout
+      @headers.search_engine_bot? ? @store.settings['api_timeout_search_engine_bots'] : @store.settings['api_timeout_seconds']
+    end
+
+    def settings_hash
+      Digest::MD5.hexdigest(JSON.dump(@store.settings))
+    end
+
+    def token
+      @store.settings['project_token']
+    end
+
+    def lang_code
+      @headers.lang_code
+    end
+
+    def url_pattern
+      @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
+
+    def translate_canonical_tag
+      @store.settings['translate_canonical_tag']
+    end
+
+    def insert_hreflangs
+      @store.settings['insert_hreflangs']
+    end
+
+    def custom_domain_langs
+      @store.custom_domain_langs.to_html_swapper_hash
+    end
+
+    def page_url
+      "#{@headers.protocol}://#{@headers.url}"
+    end
+
+    def page_pathname
+      @headers.pathname_with_trailing_slash_if_present
+    end
+  end
+end

data/lib/wovnrb/custom_domain/custom_domain_lang.rb

@@ -0,0 +1,31 @@
+module Wovnrb
+  # Represents a custom domain for a given language
+  class CustomDomainLang
+    attr_accessor :host, :path, :lang
+
+    def initialize(host, path, lang)
+      @host = host
+      @path = path.end_with?('/') ? path : "#{path}/"
+      @lang = lang
+    end
+
+    # @param uri [Addressable::URI]
+    def match?(parsed_uri)
+      @host.casecmp?(parsed_uri.host) && path_is_equal_or_subset_of?(@path, parsed_uri.path)
+    end
+
+    def host_and_path_without_trailing_slash
+      host_and_path = @host + @path
+      host_and_path.end_with?('/') ? host_and_path.delete_suffix('/') : host_and_path
+    end
+
+    private
+
+    def path_is_equal_or_subset_of?(path1, path2)
+      path1_segments = path1.split('/').reject(&:empty?)
+      path2_segments = path2.split('/').reject(&:empty?)
+
+      path1_segments == path2_segments.slice(0, path1_segments.length)
+    end
+  end
+end

data/lib/wovnrb/custom_domain/custom_domain_lang_url_handler.rb

@@ -0,0 +1,27 @@
+require 'wovnrb/custom_domain/custom_domain_lang'
+
+module Wovnrb
+  # Helper class for transforming actual domains to user-defined custom domains
+  class CustomDomainLangUrlHandler
+    class << self
+      def add_custom_domain_lang_to_absolute_url(absolute_url, target_lang, custom_domain_langs)
+        current_custom_domain = custom_domain_langs.custom_domain_lang_by_url(absolute_url)
+        new_lang_custom_domain = custom_domain_langs.custom_domain_lang_by_lang(target_lang)
+        change_to_new_custom_domain_lang(absolute_url, current_custom_domain, new_lang_custom_domain)
+      end
+
+      def change_to_new_custom_domain_lang(absolute_url, current_custom_domain, new_lang_custom_domain)
+        return absolute_url unless current_custom_domain.present? && new_lang_custom_domain.present?
+
+        current_host_and_path = current_custom_domain.host_and_path_without_trailing_slash
+        new_host_and_path = new_lang_custom_domain.host_and_path_without_trailing_slash
+
+        # ^(.*://|//)?               1: schema, e.g. https://
+        # (#{current_host_and_path}) 2: host and path, e.g. wovn.io/foo
+        # ((?:/|\?|#).*)?$           3: other / query params, e.g. ?hello=world
+        regex = %r{^(.*://|//)?(#{current_host_and_path})((?:/|\?|#).*)?$}
+        absolute_url.gsub(regex) { "#{Regexp.last_match(1)}#{new_host_and_path}#{Regexp.last_match(3)}" }
+      end
+    end
+  end
+end

data/lib/wovnrb/custom_domain/custom_domain_langs.rb

@@ -0,0 +1,40 @@
+require 'wovnrb/custom_domain/custom_domain_lang'
+
+module Wovnrb
+  # Represents a list of custom domains with corresponding languages
+  class CustomDomainLangs
+    def initialize(setting)
+      @custom_domain_langs = setting.map do |lang_code, config|
+        parsed_uri = Addressable::URI.parse(add_protocol_if_needed(config['url']))
+        CustomDomainLang.new(parsed_uri.host, parsed_uri.path, lang_code)
+      end
+    end
+
+    def custom_domain_lang_by_lang(lang_code)
+      @custom_domain_langs.find { |c| c.lang == lang_code }
+    end
+
+    def custom_domain_lang_by_url(uri)
+      parsed_uri = Addressable::URI.parse(add_protocol_if_needed(uri))
+
+      # "/" path will naturally match every URL, so by comparing longest paths first we will get the best match
+      @custom_domain_langs
+        .sort_by { |c| -c.path.length }
+        .find { |c| c.match?(parsed_uri) }
+    end
+
+    def to_html_swapper_hash
+      result = {}
+      @custom_domain_langs.each do |custom_domain_lang|
+        result[custom_domain_lang.host_and_path_without_trailing_slash] = custom_domain_lang.lang
+      end
+      result
+    end
+
+    private
+
+    def add_protocol_if_needed(url)
+      url.match?(%r{https?://}) ? url : "http://#{url}"
+    end
+  end
+end