wovnrb 1.1.0 → 2.0.0

data/lib/wovnrb/api_translator.rb

@@ -0,0 +1,143 @@
+require 'addressable'
+require 'digest'
+require 'json'
+require 'zlib'
+
+module Wovnrb
+  class ApiTranslator
+    def initialize(store, headers)
+      @store = store
+      @headers = headers
+    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
+        if response.header['Content-Encoding'] == 'gzip'
+          response_body = Zlib::GzipReader.new(StringIO.new(response.body)).read
+
+          JSON.parse(response_body)['body'] || body
+        else
+          WovnLogger.error("Received invalid content (\"#{response.header['Content-Encoding']}\") from WOVNio translation API.")
+          body
+        end
+      else
+        WovnLogger.error("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)
+      data = compress_request_data(generate_request_data(body))
+      headers = {
+        'Accept-Encoding' => 'gzip',
+        'Content-Type' => 'application/octet-stream',
+        'Content-Length' => data.bytesize.to_s
+      }
+      request = Net::HTTP::Post.new(generate_request_path(body), headers)
+
+      request.body = data
+
+      request
+    end
+
+    def generate_request_path(body)
+      "#{api_uri.path.sub(/\/$/, '')}/translation?cache_key=#{generate_cache_key(body)}"
+    end
+
+    def generate_cache_key(body)
+      cache_key_components = {
+        'token' => token,
+        'settings_hash' => settings_hash,
+        'body_hash' => Digest::MD5.hexdigest(body),
+        'path' => page_pathname,
+        'lang' => lang_code
+      }.map { |k, v| "#{k}=#{v}" }.join('&')
+
+      CGI.escape("(#{cache_key_components})")
+    end
+
+    def generate_request_data(body)
+      data = {
+        'url' => page_url,
+        'token' => token,
+        'lang_code' => lang_code,
+        'url_pattern' => url_pattern,
+        'product' => 'WOVN.rb',
+        'version' => VERSION,
+        'body' => body
+      }
+
+      data['custom_lang_aliases'] = JSON.dump(custom_lang_aliases) unless custom_lang_aliases.empty?
+
+      data
+    end
+
+    def compress_request_data(data_hash)
+      encoded_data_components = data_hash.map do |key, value|
+        "#{key}=#{CGI.escape(value)}"
+      end
+
+      gzip = Zlib::GzipWriter.new(StringIO.new)
+      gzip << encoded_data_components.join('&')
+      gzip.close.string
+    end
+
+    def api_uri
+      Addressable::URI.parse(@store.settings['api_url'])
+    end
+
+    def api_timeout
+      @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 custom_lang_aliases
+      @store.settings['custom_lang_aliases']
+    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/headers.rb

@@ -1,5 +1,4 @@
 module Wovnrb
-
   class Headers
     attr_reader :unmasked_url
     attr_reader :url
@@ -8,7 +7,7 @@ module Wovnrb
     attr_reader :host
     attr_reader :unmasked_pathname
     attr_reader :pathname
-    attr_reader :dirname
+    attr_reader :pathname_with_trailing_slash_if_present
     attr_reader :redis_url
 
     # Generates new instance of Wovnrb::Headers.
@@ -20,52 +19,49 @@ module Wovnrb
       @env = env
       @settings = settings
       @protocol = request.scheme
-      if settings['use_proxy'] && @env.has_key?('HTTP_X_FORWARDED_HOST')
-        @unmasked_host = @env['HTTP_X_FORWARDED_HOST']
-      else
-        @unmasked_host = @env['HTTP_HOST']
-      end
-      unless @env.has_key?('REQUEST_URI')
+      @unmasked_host = if settings['use_proxy'] && @env.key?('HTTP_X_FORWARDED_HOST')
+                         @env['HTTP_X_FORWARDED_HOST']
+                       else
+                         @env['HTTP_HOST']
+                       end
+      unless @env.key?('REQUEST_URI')
         # Add '/' to PATH_INFO as a possible fix for pow server
-        @env['REQUEST_URI'] = (@env['PATH_INFO'] =~ /^[^\/]/ ? '/' : '') + @env['PATH_INFO'] + (@env['QUERY_STRING'].size == 0 ? '' : "?#{@env['QUERY_STRING']}")
+        @env['REQUEST_URI'] = (@env['PATH_INFO'] =~ /^[^\/]/ ? '/' : '') + @env['PATH_INFO'] + (@env['QUERY_STRING'].empty? ? '' : "?#{@env['QUERY_STRING']}")
       end
       # REQUEST_URI is expected to not contain the server name
       # heroku contains http://...
-      if @env['REQUEST_URI'] =~ /:\/\//
-        @env['REQUEST_URI'] = @env['REQUEST_URI'].sub(/^.*:\/\/[^\/]+/, '')
-      end
+      @env['REQUEST_URI'] = @env['REQUEST_URI'].sub(/^.*:\/\/[^\/]+/, '') if @env['REQUEST_URI'] =~ /:\/\//
       @unmasked_pathname = @env['REQUEST_URI'].split('?')[0]
       @unmasked_pathname += '/' unless @unmasked_pathname =~ /\/$/ || @unmasked_pathname =~ /\/[^\/.]+\.[^\/.]+$/
       @unmasked_url = "#{@protocol}://#{@unmasked_host}#{@unmasked_pathname}"
-      if settings['use_proxy'] && @env.has_key?('HTTP_X_FORWARDED_HOST')
-        @host = @env['HTTP_X_FORWARDED_HOST']
-      else
-        @host = @env['HTTP_HOST']
-      end
-      @env['wovnrb.target_lang'] = self.lang_code
-      @host = settings['url_pattern'] == 'subdomain' ? remove_lang(@host, self.lang_code) : @host
+      @host = if settings['use_proxy'] && @env.key?('HTTP_X_FORWARDED_HOST')
+                @env['HTTP_X_FORWARDED_HOST']
+              else
+                @env['HTTP_HOST']
+              end
+      @env['wovnrb.target_lang'] = lang_code
+      @host = settings['url_pattern'] == 'subdomain' ? remove_lang(@host, lang_code) : @host
       @pathname, @query = @env['REQUEST_URI'].split('?')
-      @pathname = settings['url_pattern'] == 'path' ? remove_lang(@pathname, self.lang_code) : @pathname
-      @query = @query || ''
-      @url = "#{@host}#{@pathname}#{(@query.length > 0 ? '?' : '') + remove_lang(@query, self.lang_code)}"
-      if settings['query'].length > 0
+      @pathname = settings['url_pattern'] == 'path' ? remove_lang(@pathname, lang_code) : @pathname
+      @query ||= ''
+      @url = "#{@host}#{@pathname}#{(!@query.empty? ? '?' : '') + remove_lang(@query, lang_code)}"
+      if !settings['query'].empty?
         query_vals = []
         settings['query'].each do |qv|
           rx = Regexp.new("(^|&)(?<query_val>#{qv}[^&]+)(&|$)")
           m = @query.match(rx)
-          if m && m[:query_val]
-            query_vals.push(m[:query_val])
-          end
-        end
-        if query_vals.length > 0
-          @query = "?#{query_vals.sort.join('&')}"
-        else
-          @query = ''
+          query_vals.push(m[:query_val]) if m && m[:query_val]
         end
+        @query = if !query_vals.empty?
+                   "?#{query_vals.sort.join('&')}"
+                 else
+                   ''
+                 end
       else
         @query = ''
       end
-      @query = remove_lang(@query, self.lang_code)
+      @query = remove_lang(@query, lang_code)
+      @pathname_with_trailing_slash_if_present = @pathname
       @pathname = @pathname.gsub(/\/$/, '')
       @redis_url = "#{@host}#{@pathname}#{@query}"
     end
@@ -74,7 +70,7 @@ module Wovnrb
     #
     # @return [String] The lang code of the current page
     def lang_code
-      (self.path_lang && self.path_lang.length > 0) ? self.path_lang : @settings['default_lang']
+      path_lang && !path_lang.empty? ? path_lang : @settings['default_lang']
     end
 
     # picks up language code from requested URL by using url_pattern_reg setting.
@@ -85,18 +81,18 @@ module Wovnrb
     def path_lang
       if @path_lang.nil?
         rp = Regexp.new(@settings['url_pattern_reg'])
-        if @settings['use_proxy'] && @env.has_key?('HTTP_X_FORWARDED_HOST')
-          match = "#{@env['HTTP_X_FORWARDED_HOST']}#{@env['REQUEST_URI']}".match(rp)
-        else
-          match = "#{@env['SERVER_NAME']}#{@env['REQUEST_URI']}".match(rp)
-        end
-        if match && match[:lang] && Lang.get_lang(match[:lang])
-          @path_lang = Lang.get_code(match[:lang])
-        else
-          @path_lang = ''
-        end
+        match = if @settings['use_proxy'] && @env.key?('HTTP_X_FORWARDED_HOST')
+                  "#{@env['HTTP_X_FORWARDED_HOST']}#{@env['REQUEST_URI']}".match(rp)
+                else
+                  "#{@env['SERVER_NAME']}#{@env['REQUEST_URI']}".match(rp)
+                end
+        @path_lang = if match && match[:lang] && Lang.get_lang(match[:lang])
+                       Lang.get_code(match[:lang])
+                     else
+                       ''
+                     end
       end
-      return @path_lang
+      @path_lang
     end
 
     def browser_lang
@@ -105,7 +101,7 @@ module Wovnrb
         if match && match[:lang] && Lang.get_lang(match[:lang])
           @browser_lang = match[:lang]
         else
-# IS THIS RIGHT?
+          # IS THIS RIGHT?
           @browser_lang = ''
           accept_langs = (@env['HTTP_ACCEPT_LANGUAGE'] || '').split(/[,;]/)
           accept_langs.each do |l|
@@ -116,87 +112,78 @@ module Wovnrb
           end
         end
       end
-      return @browser_lang
+      @browser_lang
     end
 
-    def redirect(lang=self.browser_lang)
+    def redirect(lang = browser_lang)
       redirect_headers = {}
-      redirect_headers['location'] = self.redirect_location(lang)
+      redirect_headers['location'] = redirect_location(lang)
       redirect_headers['content-length'] = '0'
-      return redirect_headers
+      redirect_headers
     end
 
     def redirect_location(lang)
       if lang == @settings['default_lang']
-# IS THIS RIGHT??
-        return "#{self.protocol}://#{self.url}"
-        #return remove_lang("#{@env['HTTP_HOST']}#{@env['REQUEST_URI']}", lang)
+        # IS THIS RIGHT??
+        "#{protocol}://#{url}"
+        # return remove_lang("#{@env['HTTP_HOST']}#{@env['REQUEST_URI']}", lang)
       else
         # TODO test
         lang_code = Store.instance.settings['custom_lang_aliases'][lang] || lang
-        location = self.url
+        location = url
         case @settings['url_pattern']
         when 'query'
           if location !~ /\?/
             location = "#{location}?wovn=#{lang_code}"
           else @env['REQUEST_URI'] !~ /(\?|&)wovn=/
-            location = "#{location}&wovn=#{lang_code}"
+               location = "#{location}&wovn=#{lang_code}"
           end
         when 'subdomain'
           location = "#{lang_code.downcase}.#{location}"
-       #when 'path'
+        # when 'path'
         else
-          location = location.sub(/(\/|$)/, "/#{lang_code}/");
+          location = location.sub(/(\/|$)/, "/#{lang_code}/")
         end
-        return "#{self.protocol}://#{location}"
+        "#{protocol}://#{location}"
       end
     end
 
-    def request_out(def_lang=@settings['default_lang'])
+    def request_out(_def_lang = @settings['default_lang'])
       case @settings['url_pattern']
       when 'query'
-        @env['REQUEST_URI'] = remove_lang(@env['REQUEST_URI']) if @env.has_key?('REQUEST_URI')
-        @env['QUERY_STRING'] = remove_lang(@env['QUERY_STRING']) if @env.has_key?('QUERY_STRING')
-        @env['ORIGINAL_FULLPATH'] = remove_lang(@env['ORIGINAL_FULLPATH']) if @env.has_key?('ORIGINAL_FULLPATH')
+        @env['REQUEST_URI'] = remove_lang(@env['REQUEST_URI']) if @env.key?('REQUEST_URI')
+        @env['QUERY_STRING'] = remove_lang(@env['QUERY_STRING']) if @env.key?('QUERY_STRING')
+        @env['ORIGINAL_FULLPATH'] = remove_lang(@env['ORIGINAL_FULLPATH']) if @env.key?('ORIGINAL_FULLPATH')
       when 'subdomain'
-        if @settings['use_proxy'] && @env.has_key?('HTTP_X_FORWARDED_HOST')
+        if @settings['use_proxy'] && @env.key?('HTTP_X_FORWARDED_HOST')
           @env['HTTP_X_FORWARDED_HOST'] = remove_lang(@env['HTTP_X_FORWARDED_HOST'])
         else
-          @env["HTTP_HOST"] = remove_lang(@env["HTTP_HOST"])
-          @env["SERVER_NAME"] = remove_lang(@env["SERVER_NAME"])
+          @env['HTTP_HOST'] = remove_lang(@env['HTTP_HOST'])
+          @env['SERVER_NAME'] = remove_lang(@env['SERVER_NAME'])
         end
-        if @env.has_key?('HTTP_REFERER')
-          @env["HTTP_REFERER"] = remove_lang(@env["HTTP_REFERER"])
-        end
-     #when 'path'
+        @env['HTTP_REFERER'] = remove_lang(@env['HTTP_REFERER']) if @env.key?('HTTP_REFERER')
+      # when 'path'
       else
         @env['REQUEST_URI'] = remove_lang(@env['REQUEST_URI'])
-        if @env.has_key?('REQUEST_PATH')
-          @env['REQUEST_PATH'] = remove_lang(@env['REQUEST_PATH'])
-        end
+        @env['REQUEST_PATH'] = remove_lang(@env['REQUEST_PATH']) if @env.key?('REQUEST_PATH')
         @env['PATH_INFO'] = remove_lang(@env['PATH_INFO'])
-        if @env.has_key?('ORIGINAL_FULLPATH')
-          @env['ORIGINAL_FULLPATH'] = remove_lang(@env['ORIGINAL_FULLPATH'])
-        end
-        if @env.has_key?('HTTP_REFERER')
-          @env["HTTP_REFERER"] = remove_lang(@env["HTTP_REFERER"])
-        end
+        @env['ORIGINAL_FULLPATH'] = remove_lang(@env['ORIGINAL_FULLPATH']) if @env.key?('ORIGINAL_FULLPATH')
+        @env['HTTP_REFERER'] = remove_lang(@env['HTTP_REFERER']) if @env.key?('HTTP_REFERER')
       end
       @env
     end
 
+    # TODO: this should be in Lang for reusability
     # Remove language code from the URI.
     #
     # @param uri  [String] original URI
     # @param lang_code [String] language code
     # @return     [String] removed URI
-    def remove_lang(uri, lang=self.path_lang)
+    def remove_lang(uri, lang = path_lang)
       lang_code = Store.instance.settings['custom_lang_aliases'][lang] || lang
 
       # Do nothing if lang is empty.
-      if lang_code.nil? || lang_code.empty?
-        return uri
-      end
+      return uri if lang_code.nil? || lang_code.empty?
 
       case @settings['url_pattern']
       when 'query'
@@ -204,27 +191,27 @@ module Wovnrb
       when 'subdomain'
         rp = Regexp.new('(^|(//))' + lang_code + '\.', 'i')
         return uri.sub(rp, '\1')
-     #when 'path'
+      # when 'path'
       else
         return uri.sub(/\/#{lang_code}(\/|$)/, '/')
       end
     end
 
     def out(headers)
-      r = Regexp.new("//" + @host)
+      r = Regexp.new('//' + @host)
       lang_code = Store.instance.settings['custom_lang_aliases'][self.lang_code] || self.lang_code
-      if lang_code != @settings['default_lang'] && headers.has_key?("Location") && headers["Location"] =~ r
+      if lang_code != @settings['default_lang'] && headers.key?('Location') && headers['Location'] =~ r
         case @settings['url_pattern']
         when 'query'
-          if headers['Location'] =~ /\?/
-            headers['Location'] += "&"
-          else
-            headers['Location'] += "?"
-          end
+          headers['Location'] += if headers['Location'] =~ /\?/
+                                   '&'
+                                 else
+                                   '?'
+                                 end
           headers['Location'] += "wovn=#{lang_code}"
         when 'subdomain'
-          headers['Location'] = headers["Location"].sub(/\/\/([^.]+)/, '//' + lang_code + '.\1')
-       #when 'path'
+          headers['Location'] = headers['Location'].sub(/\/\/([^.]+)/, '//' + lang_code + '.\1')
+        # when 'path'
         else
           headers['Location'] = headers['Location'].sub(/(\/\/[^\/]+)/, '\1/' + lang_code)
         end
@@ -240,5 +227,4 @@ module Wovnrb
       end
     end
   end
-
 end

data/lib/wovnrb/helpers/nokogumbo_helper.rb

@@ -10,7 +10,7 @@ module Wovnrb
                 parse_fragment(html_string, encoding)
               end
 
-        return dom
+        dom
       end
 
       # https://www.rubydoc.info/gems/nokogumbo/Nokogiri/HTML5#fragment-class_method