wovnrb 0.2.01 → 0.2.02

data/lib/wovnrb/services/url.rb

@@ -1,78 +1,12 @@
 module Wovnrb
   class URL
-
     def self.resolve_absolute_url(curr_location, rel_location)
     end
 
-    # Set the path lang to 
+    # Set the path lang to
     def self.prepend_path(url, dir)
-
-     result = url.sub(/(.+\.[^\/]+)(\/|$)/, '\1/' + dir + '\2') 
+     result = url.sub(/(.+\.[^\/]+)(\/|$)/, '\1/' + dir + '\2')
      return result
-
-     end
-
-=begin
-
-     url_slash = url.count("/")
-
-      if url.include?("//") && url_slash >= 3 then
-
-        url_base = url.split("/", 4)
-
-        url_begin = url_base[0]
-        url_middle = url_base[2]
-        url_end = url_base[3]
-
-        result = url_begin + "//" + url_middle + "/" + dir + "/" + url_end
-
-        return result
-
-      elsif url.include?("//") then 
-
-        result = url + "/" + dir 
-
-        return result
-
-      elsif url.include?("/") #&& url_slash >= 2 then
-
-        url_base = url.split("/", 2)
-
-        url_begin = url_base[0]
-        url_end = url_base[1]
-
-       result = url_begin + "/" + dir + "/" + url_end
-
-        return result
-
-      else
-
-        result = url + "/" + dir
-
-        return result
-
      end
-    end
-
-=end
-
-    #def self.set_query_lang(url, lang, param_name='wovn')
-    #  url =
-    #  lang =
-    #  param_name = 'wovn'
-    #  return 
-    #end
-
-    #def self.set_subdomain_lang(url, lang)
-    #end
-
-    #def self.remove_subdomain(url)
-    #end
-
-          #def self.add_subdomain(url, subdomain)
-    #end
-    #def iself.set_query_param(url, param, value)
-    #end
-
   end
 end

data/lib/wovnrb/services/wovn_logger.rb

@@ -0,0 +1,45 @@
+require 'singleton'
+require 'logger' unless defined?(Logger)
+
+module Wovnrb
+  class WovnLogger
+    include Singleton
+
+    def initialize
+      path = Store.instance.settings['log_path']
+      if path
+        begin
+          @logger = Logger.new(path)
+        rescue
+          begin
+            @logger = Logger.new('wovn_error.log')
+            @logger.error("Wovn Error: log_path(#{path}) is invalid, please change log_path at config")
+          rescue
+            @logger = $stderr
+            $stderr.puts("Wovn Error: log_path(#{path}) is invalid, please change log_path at config")
+          end
+        end
+      else
+        @logger = $stderr
+      end
+    end
+
+    def set_logger(logger)
+      [:error].each do |method|
+        unless logger.respond_to? method
+          raise 'not suite for logger'
+        end
+      end
+
+      @logger = logger
+    end
+
+    def error(message)
+      if @logger == $stderr
+        @logger.puts "Wovnrb Error: #{message}"
+      else
+        @logger.error message
+      end
+    end
+  end
+end

data/lib/wovnrb/store.rb

@@ -1,29 +1,40 @@
 require 'net/http'
 require 'uri'
 require 'cgi'
-require 'logger' unless defined?(Logger)
+require 'singleton'
+require 'wovnrb/services/wovn_logger'
 
 module Wovnrb
-
   class Store
+    include Singleton
 
     def initialize
-      @settings = 
+      @settings = {}
+      @config_loaded = false
+      reset
+    end
+
+    # Reset @settings and @config_loaded variables to default.
+    #
+    # @return [nil]
+    def reset
+      @settings =
         {
           'user_token' => '',
           'secret_key' => '',
-          # 'url_pattern' => 'query'
-          # 'url_pattern_reg' => "?.*wovn=(?<lang>[^&]+)(&|$)",
+          'log_path' => 'log/wovn_error.log',
           'url_pattern' => 'path',
           'url_pattern_reg' => "/(?<lang>[^/.?]+)",
-          #'url_pattern' => 'subdomain',
-          #'url_pattern_reg' => "^(?<lang>[^.]+)\.",
           'query' => [],
           'api_url' => 'https://api.wovn.io/v0/values',
+          'api_timeout_seconds' => 0.5,
           'default_lang' => 'en',
           'supported_langs' => ['en'],
           'test_mode' => false,
           'test_url' => '',
+          'cache_megabytes' => nil,
+          'ttl_seconds' => nil,
+          'use_proxy' => false,  # use env['HTTP_X_FORWARDED_HOST'] instead of env['HTTP_HOST'] and env['SERVER_NAME'] when this setting is true.
         }
       # When Store is initialized, the Rails.configuration object is not yet initialized
       @config_loaded = false
@@ -65,9 +76,8 @@ module Wovnrb
       end
       # log errors
       if errors.length > 0
-        logger = Logger.new('log/error.log')
         errors.each do |e|
-          logger.error(e)
+          WovnLogger.instance.error(e)
         end
       end
       return valid
@@ -117,35 +127,6 @@ module Wovnrb
       end
       @settings
     end
-
-    # Get the values for the passed in url
-    #
-    # @param url [String] The url to get the values for
-    # @return [Hash] The values Hash for the passed in url
-    def get_values(url)
-      url = url.gsub(/\/$/, '')
-
-      begin
-        uri = URI.parse("#{settings['api_url']}?token=#{settings['user_token']}&url=#{url}")
-        http = Net::HTTP.new(uri.host, uri.port)
-        http.use_ssl = true if uri.scheme == 'https'
-        res = http.start {
-          http.get(uri.request_uri)
-        }
-        if res.code == "200"
-          vals = JSON.parse(res.body || '{}')
-        else
-          vals = {}
-        end
-      rescue
-        vals = {}
-        logger = Logger.new('../error.log')
-        logger.error("API server GET request failed with the following parameters:\napi_url: #{settings['api_url']}\ntoken: #{settings['user_token']}\nurl: #{url}")
-      end
-
-      vals
-    end
-
   end
 
 end

data/lib/wovnrb/text_caches/cache_base.rb

@@ -0,0 +1,52 @@
+require 'active_support/inflector'
+
+module Wovnrb
+  class CacheBase
+    @@strategy_map = {
+        memory: :memory_cache
+    }
+
+    @@default_base_config = {
+      strategy: :memory
+    }
+
+    @@singleton_cache = nil
+    def self.get_single
+      raise 'cache is not initialized' unless @@singleton_cache
+      @@singleton_cache
+    end
+
+    def self.set_single(config)
+      @@singleton_cache = self.build(config)
+    end
+
+    def self.reset_cache
+      @@singleton_cache = nil
+    end
+
+    def self.build(config)
+      @config = @@default_base_config.merge config
+
+      strategy = @@strategy_map[@config[:strategy]]
+      raise "Invalid strategy: #{strategy}" unless strategy
+
+      strategy_sym = strategy.to_sym
+      begin
+        require "wovnrb/text_caches/#{strategy_sym}"
+      rescue LoadError => e
+        raise "Could not find #{strategy_sym} (#{e})"
+      end
+
+      strategy_class = Wovnrb.const_get(ActiveSupport::Inflector.camelize(strategy_sym))
+      strategy_class.new(config)
+    end
+
+    def put(key, value)
+      raise NotImplementedError.new('put is not defined')
+    end
+
+    def get(key)
+      raise NotImplementedError.new('put is not defined')
+    end
+  end
+end

data/lib/wovnrb/text_caches/memory_cache.rb

@@ -0,0 +1,52 @@
+require 'active_support/cache'
+require 'active_support/cache/memory_store'
+require 'lz4-ruby'
+
+module Wovnrb
+  class MemoryCache < CacheBase
+    @@default_memory_cache_config = {
+      cache_megabytes: 200,
+      ttl_seconds: 300
+    }
+
+    def initialize(config)
+      @config = merge_setting(@@default_memory_cache_config, config)
+      cache_size = @config[:cache_megabytes].to_f
+      ttl = @config[:ttl_seconds].to_i
+      @cache_store = ActiveSupport::Cache::MemoryStore.new(expires_in: ttl.seconds, size: cache_size.megabytes)
+    end
+
+    def put(key, value)
+      @cache_store.write(key, compress(value))
+    end
+
+    def get(key)
+      stored_value =@cache_store.fetch(key)
+      decompress(stored_value) if stored_value
+    end
+
+    def options
+      @cache_store.options.clone
+    end
+
+    private
+    def merge_setting(original_config, merging_config)
+      config = original_config.clone
+      config.keys.each do |key|
+        key_string = key.to_s
+        if merging_config.has_key?(key_string) && merging_config[key_string].present?
+          config[key] = merging_config[key_string]
+        end
+      end
+      config
+    end
+
+    def compress(value)
+      LZ4::compress(value)
+    end
+
+    def decompress(value)
+      LZ4::decompress(value, value.bytesize, 'UTF-8')
+    end
+  end
+end

data/lib/wovnrb/version.rb

@@ -1,3 +1,3 @@
 module Wovnrb
-  VERSION = "0.2.01"
+  VERSION = "0.2.02"
 end

data/lib/wovnrb.rb

@@ -4,21 +4,29 @@ require 'wovnrb/lang'
 require 'nokogumbo'
 #require 'dom'
 require 'json'
-
+require 'wovnrb/api_data'
+require 'wovnrb/text_caches/cache_base'
+require 'wovnrb/html_replacers/replacer_base'
+require 'wovnrb/html_replacers/link_replacer'
+require 'wovnrb/html_replacers/text_replacer'
+require 'wovnrb/html_replacers/meta_replacer'
+require 'wovnrb/html_replacers/image_replacer'
+require 'wovnrb/html_replacers/script_replacer'
 require 'wovnrb/railtie' if defined?(Rails)
+require 'wovnrb/version'
 
 module Wovnrb
-
   class Interceptor
     def initialize(app, opts={})
       @app = app
-      @store = Store.new
+      @store = Store.instance
       opts = opts.each_with_object({}){|(k,v),memo| memo[k.to_s]=v}
       @store.settings(opts)
+      CacheBase.set_single(@store.settings)
     end
 
     def call(env)
-      unless @store.valid_settings?
+      unless Store.instance.valid_settings?
         return @app.call(env)
       end
       @env = env
@@ -26,7 +34,7 @@ module Wovnrb
       if @store.settings['test_mode'] && @store.settings['test_url'] != headers.url
         return @app.call(env)
       end
-       #redirect if the path is set to the default language (for SEO purposes)
+      #redirect if the path is set to the default language (for SEO purposes)
       if (headers.path_lang == @store.settings['default_lang'])
         redirect_headers = headers.redirect(@store.settings['default_lang'])
         return [307, redirect_headers, ['']]
@@ -37,7 +45,10 @@ module Wovnrb
       status, res_headers, body = @app.call(headers.request_out)
 
       if res_headers["Content-Type"] =~ /html/ # && !body[0].nil?
-        values = @store.get_values(headers.redis_url)
+        # ApiData creates request for external server, but cannot use async.
+        # Because some server not allow multi thread. (env['async.callback'] is not supported at all Server).
+        api_data = ApiData.new(headers.redis_url, @store)
+        values = api_data.get_data
         url = {
             :protocol => headers.protocol,
             :host => headers.host,
@@ -55,86 +66,9 @@ module Wovnrb
       #[status, res_headers, d.transform()]
     end
 
-    def add_lang_code(href, pattern, lang, headers)
-      return href if href =~ /^(#.*)?$/
-      # absolute links 
-      new_href = href
-      if href && href =~ /^(https?:)?\/\//i
-        # in the future, perhaps validate url rather than using begin rescue
-        # "#{url =~ /\// ? 'http:' : ''}#{url}" =~ URI::regexp
-        begin
-          uri = URI(href)
-        rescue
-          return new_href
-        end
-        # only add lang if it's an internal link 
-        # DNS names are case insensitive
-        if uri.host.downcase === headers.host.downcase
-          case pattern
-            when 'subdomain'
-              sub_d = href.match(/\/\/([^\.]*)\./)[1]
-              sub_code = Lang.get_code(sub_d)
-              if sub_code && sub_code.downcase == lang.downcase
-                new_href = href.sub(Regexp.new(lang, 'i'), lang.downcase)
-              else
-                new_href = href.sub(/(\/\/)([^\.]*)/, '\1' + lang.downcase + '.' + '\2')
-              end
-            when 'query'
-              new_href = href =~ /\?/ ? href + '&wovn=' + lang : href + '?wovn=' + lang
-            else # path
-              new_href = href.sub(/([^\.]*\.[^\/]*)(\/|$)/, '\1/' + lang + '/')
-          end
-        end
-      elsif href
-        case pattern
-          when 'subdomain'
-            lang_url = headers.protocol + '://' + lang.downcase + '.' + headers.host
-            current_dir = headers.pathname.sub(/[^\/]*\.[^\.]{2,6}$/, '')
-            if href =~ /^\.\..*$/
-              # ../path
-              new_href = lang_url + '/' + href.gsub(/^\.\.\//, '')
-            elsif href =~ /^\..*$/
-              # ./path
-              new_href = lang_url + current_dir + '/' + href.gsub(/^\.\//, '')
-            elsif href =~ /^\/.*$/
-              # /path
-              new_href = lang_url + href
-            else
-              # path
-              new_href = lang_url + current_dir + '/' + href
-            end
-          when 'query'
-            new_href = href =~ /\?/ ? href + '&wovn=' + lang : href + '?wovn=' + lang
-          else # path
-            if href =~ /^\//
-              new_href = '/' + lang + href
-            else
-              current_dir = headers.pathname.sub(/[^\/]*\.[^\.]{2,6}$/, '')
-              new_href = '/' + lang + current_dir + href
-            end
-        end
-      end
-      new_href
-    end
-
-    # returns true if a wovn_ignore is found in the tree from the node to the body tag
-    def check_wovn_ignore(node)
-      if !node.get_attribute('wovn-ignore').nil?
-        return true
-      elsif node.name === 'html'
-        return false
-      end
-      check_wovn_ignore(node.parent)
-    end
-
     def switch_lang(body, values, url, lang=@store.settings['default_lang'], headers)
-
-      lang = Lang.get_code(lang)
-      text_index = values['text_vals'] || {}
-      src_index = values['img_vals'] || {}
-      img_src_prefix = values['img_src_prefix'] || ''
+      lang = Lang.new(lang)
       ignore_all = false
-      string_index = {}
       new_body = []
       body.each do |b|
         d = Nokogiri::HTML5(b)
@@ -148,151 +82,12 @@ module Wovnrb
           next
         end
 
-        # add lang code to anchors href if not default lang 
-        if lang != @store.settings['default_lang']
-          pattern = @store.settings['url_pattern']
-
-          d.xpath('//a').each do |a|
-            next if check_wovn_ignore(a)
-            href = a.get_attribute('href')
-            new_href = add_lang_code(href, pattern, lang, headers)
-            a.set_attribute('href', new_href)
-          end
-
-          d.xpath('//form').each do |form|
-            next if check_wovn_ignore(form)
-            method = form.get_attribute('method')
-            if pattern == 'query' && (method.nil? || method.upcase == 'GET')
-              insert_node = Nokogiri::XML::Node.new('input', d)
-              insert_node['type'] = 'hidden'
-              insert_node['name'] = 'wovn'
-              insert_node['value'] = lang
-              if form.children.size > 0
-                form.children.first.add_previous_sibling(insert_node)
-              else
-                form.add_child(insert_node)
-              end
-            else
-              action = form.get_attribute('action')
-              new_action = add_lang_code(action, pattern, lang, headers)
-              form['action'] = new_action
-            end
-          end
-        end
-
-        # swap text
-        d.xpath('//text()').each do |node|
-          next if check_wovn_ignore(node)
-          node_text = node.content.strip
-# shouldn't need size check, but for now...
-          if text_index[node_text] && text_index[node_text][lang] && text_index[node_text][lang].size > 0
-            node.content = node.content.gsub(/^(\s*)[\S\s]*(\s*)$/, '\1' + text_index[node_text][lang][0]['data'] + '\2')
-          end
-        end
-        # swap meta tag values
-        d.xpath('//meta').select { |t|
-          next if check_wovn_ignore(t)
-          (t.get_attribute('name') || t.get_attribute('property') || '') =~ /^(description|title|og:title|og:description|twitter:title|twitter:description)$/
-        }.each do |node|
-          node_content = node.get_attribute('content').strip
-# shouldn't need size check, but for now...
-          if text_index[node_content] && text_index[node_content][lang] && text_index[node_content][lang].size > 0
-            node.set_attribute('content', node_content.gsub(/^(\s*)[\S\s]*(\s*)$/, '\1' + text_index[node_content][lang][0]['data'] + '\2'))
-          end
-        end
-        # swap img srcs
-        d.xpath('//img').each do |node|
-          next if check_wovn_ignore(node)
-          # use regular expressions to support case insensitivity (right?)
-          if node.to_html =~ /src=['"][^'"]*['"]/i
-            src = node.to_html.match(/src=['"]([^'"]*)['"]/i)[1]
-# THIS SRC CORRECTION DOES NOT HANDLE ONE IMPORTANT CASE
-# 1) "../path/with/ellipse"
-# if this is not an absolute src
-            if src !~ /:\/\//
-              # if this is a path with a leading slash
-              if src =~ /^\//
-                src = "#{url[:protocol]}://#{url[:host]}#{src}"
-              else
-                src = "#{url[:protocol]}://#{url[:host]}#{url[:path]}#{src}"
-              end
-            end
-
-# shouldn't need size check, but for now...
-            if src_index[src] && src_index[src][lang] && src_index[src][lang].size > 0
-              node.attribute('src').value = "#{img_src_prefix}#{src_index[src][lang][0]['data']}"
-            end
-          end
-          if node.get_attribute('alt')
-            alt = node.get_attribute('alt').strip
-            if text_index[alt] && text_index[alt][lang] && text_index[alt][lang].size > 0
-              node.attribute('alt').value = alt.gsub(/^(\s*)[\S\s]*(\s*)$/, '\1' + text_index[alt][lang][0]['data'] + '\2')
-            end
-          end
-        end
-
-        # REMOVE WIDGET
-        d.xpath('//script').each do |script_node|
-          if script_node['src'] && script_node['src'].include?('//j.(dev-)?wovn.io(:3000)?/')
-            #binding.pry
-            script_node.remove
-          end
-        end
-
-        # PARENT NODE FOR INSERTS
-        parent_node = d.at_css('head') || d.at_css('body') || d.at_css('html')
-
-        # INSERT BACKEND WIDGET
-        insert_node = Nokogiri::XML::Node.new('script', d)
-        # TODO: CHANGE THIS BACK; Should be '//j.wovn.io/0' in production
-        insert_node['src'] = '//j.wovn.io/1'
-        insert_node['async'] = true
-        #insert_node['src'] = '//j.dev-wovn.io:3000/0'
-        version = defined?(VERSION) ? VERSION : ''
-        insert_node['data-wovnio'] = "key=#{@store.settings['user_token']}&backend=true&currentLang=#{lang}&defaultLang=#{@store.settings['default_lang']}&urlPattern=#{@store.settings['url_pattern']}&version=#{version}"
-        # do this so that there will be a closing tag (better compatibility with browsers)
-        insert_node.content = ' '
-        if parent_node.children.size > 0
-          parent_node.children.first.add_previous_sibling(insert_node)
-        else
-          parent_node.add_child(insert_node)
-        end
-
-
-        # INSERT LANGUAGE METALINKS
-        published_langs = get_langs(values)
-        published_langs.each do |l|
-          insert_node = Nokogiri::XML::Node.new('link', d)
-          insert_node['rel'] = 'alternate'
-          insert_node['hreflang'] = l
-          insert_node['href'] = headers.redirect_location(l)
-          parent_node.add_child(insert_node)
-        end
-
-        # set lang property on HTML tag
-        if d.at_css('html') || d.at_css('HTML')
-          (d.at_css('html') || d.at_css('HTML')).set_attribute('lang', lang)
-        end
-
-        output = d.to_html.gsub(/href="([^"]*)"/) { |m| "href=\"#{URI.decode($1)}\"" }
+        output = lang.switch_dom_lang(d, @store, values, url, headers)
         new_body.push(output)
       end
       body.close if body.respond_to?(:close)
       new_body
-      #body
     end
-
-    # this clearly needs to be refactored. I'm thinking maybe a Value service? (@store.values.get_langs)
-    def get_langs(values)
-      langs = Set.new
-      (values['text_vals'] || {}).merge(values['img_vals'] || {}).each do |key, index|
-        index.each do |l, val|
-          langs.add(l)
-        end
-      end
-      langs
-    end
-
   end
 
 end

data/test/lib/api_data_test.rb

@@ -0,0 +1,62 @@
+require 'wovnrb/text_caches/cache_base'
+require 'wovnrb/text_caches/memory_cache'
+require 'wovnrb/api_data'
+require 'test_helper'
+require 'webmock/minitest'
+
+module Wovnrb
+  class MemoryCacheTest < WovnMiniTest
+    def setup
+      Wovnrb::CacheBase.set_single({})
+    end
+
+    def teardown
+      Wovnrb::CacheBase.reset_cache
+      WebMock.reset!
+    end
+
+    def test_initialize
+      Wovnrb::ApiData.new('http://wwww.example.com', Wovnrb::Store.instance)
+    end
+
+    def test_get_data
+      token = 'a'
+      url = 'url'
+      stub_request(:get, "https://api.wovn.io/v0/values?token=#{token}&url=#{url}").
+        to_return(:body => '{"test_body": "a"}')
+      store = Wovnrb::Store.instance
+      store.settings['user_token'] = token
+      api_data = Wovnrb::ApiData.new(url, store)
+
+      assert_equal({'test_body' => 'a'}, api_data.get_data)
+    end
+
+    def test_get_data_when_cache_exists
+      token = 'a'
+      url = 'url'
+      stub = stub_request(:get, "https://api.wovn.io/v0/values?token=#{token}&url=#{url}").
+        to_return(:body => '{"test_body": "a"}')
+      store = Wovnrb::Store.instance
+      store.settings['user_token'] = token
+      api_data = Wovnrb::ApiData.new(url, store)
+
+      assert_equal({'test_body' => 'a'}, api_data.get_data)
+      assert_equal({'test_body' => 'a'}, api_data.get_data)
+      assert_requested(stub, :times => 1)
+    end
+
+    def test_get_data_fail
+      token = 'a'
+      url = 'url'
+      stub_request(:get, "https://api.wovn.io/v0/values?token=#{token}&url=#{url}").
+        to_return(:status => [500, "Internal Server Error"])
+      store = Wovnrb::Store.instance
+      store.settings['user_token'] = token
+      api_data = Wovnrb::ApiData.new(url, store)
+      log_mock = Wovnrb::LogMock.mock_log
+
+      assert_equal({}, api_data.get_data)
+      assert(log_mock.errors[0].start_with?('API server GET request failed'))
+    end
+  end
+end