wovnrb 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21db13334fd0ceefeba7a6d0f23a13c035d8ca2e97796f2c5342659369b4a5d9
-  data.tar.gz: 6453345eb832513563decad6050d3b44d2f100c203c8e0f3f9cbbd8d6cc833b5
+  metadata.gz: b1d7702d09e87b697371b1c5609040910fa9383d55a05ebac5d1ae668b04013c
+  data.tar.gz: c18162741b2cbb82137687cd6b9a0176cc576cae8230c3720d4ebd19df065656
 SHA512:
-  metadata.gz: a43841cb1cd9a2fcda906663b8c8a5d46e751e37d202591f42d7eea17603df6523e8eca82538c49b7db20e9d3b1d8fd51d5e64e482ee71422384f109f699eef3
-  data.tar.gz: 6e87c0aa31e2b6853d295e600ba6fef63beb3cc5d0154a872e19a51cdc3a6d7828b1bc7ea21346dfee72c888576885256d11c84e1085608e2a5c55e693312359
+  metadata.gz: 3285cbeb773a4415e82fd8cc06b375d4e3e0adea37c2e026699f401cd2692a67972aef40513a209b1d39686fb52664bc3964d6d8be69088d716b960f9e8e1ef3
+  data.tar.gz: ea6c7b83a2a2b6c16c5d7d5310ec17e021a4e1b87524cc60de3794230890aeb8742205e7197ba9bbd74d492092523f59bcd48f576440729e6a014919d11f4313

data/README.md

@@ -82,6 +82,7 @@ lang_param_name    |          | 'wovn'
 query              |          | []
 ignore_class       |          | []
 translate_fragment |          | true
+ignore_paths       |          | []
 
 ### 2.1. project_token
 
@@ -161,6 +162,17 @@ 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.
 
+### 2.9 ignore_paths
+
+This parameter tells WOVN.rb to not localize content withing given directories.
+
+The directories given will only be matched against the beginning of the URL path.
+
+For instance, if you want to not localize the admin directory of your website, you should add the following to you WOVN.rb configuration.
+```
+'ignore_paths' => ['/admin/']
+```
+
 ## 3. Contributing
 
 1. Fork it ( https://github.com/WOVNio/wovnrb/fork )

data/lib/wovnrb.rb

@@ -32,14 +32,21 @@ module Wovnrb
 
       @env = env
       headers = Headers.new(env, @store.settings)
+      default_lang = @store.settings['default_lang']
       return @app.call(env) if @store.settings['test_mode'] && @store.settings['test_url'] != headers.url
 
       # 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'])
+      if headers.path_lang == default_lang
+        redirect_headers = headers.redirect(default_lang)
         return [307, redirect_headers, ['']]
       end
 
+      # if path containing language code is ignored, do nothing
+      if headers.lang_code != default_lang && ignore_path?(headers.unmasked_pathname_without_trailing_slash)
+        status, res_headers, body = @app.call(env)
+
+        return output(headers, status, res_headers, body)
+      end
       # pass to application
       status, res_headers, body = @app.call(headers.request_out)
 
@@ -51,7 +58,7 @@ module Wovnrb
       return output(headers, status, res_headers, body) if request.params['wovn_disable'] == true
 
       @store.settings.update_dynamic_settings!(request.params)
-      return output(headers, status, res_headers, body) if @store.settings['ignore_globs'].any? { |g| g.match?(headers.pathname) }
+      return output(headers, status, res_headers, body) if ignore_path?(headers.pathname)
 
       body = switch_lang(headers, body) unless status.to_s =~ /^1|302/
 
@@ -105,6 +112,10 @@ module Wovnrb
       !html_body.xpath('//html[@wovn-ignore]').empty?
     end
 
+    def ignore_path?(path)
+      @store.settings['ignore_globs'].ignore?(path)
+    end
+
     # Checks if a given HTML body is an Accelerated Mobile Page (AMP).
     # To do so, it looks at the required attributes for the HTML tag:
     # https://www.ampproject.org/docs/tutorials/create/basic_markup.

data/lib/wovnrb/headers.rb

@@ -39,7 +39,6 @@ module Wovnrb
               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, lang_code) : @pathname
@@ -66,6 +65,10 @@ module Wovnrb
       @redis_url = "#{@host}#{@pathname}#{@query}"
     end
 
+    def unmasked_pathname_without_trailing_slash
+      @unmasked_pathname.chomp('/')
+    end
+
     # Get the language code of the current request
     #
     # @return [String] The lang code of the current page
@@ -150,6 +153,7 @@ module Wovnrb
     end
 
     def request_out(_def_lang = @settings['default_lang'])
+      @env['wovnrb.target_lang'] = lang_code
       case @settings['url_pattern']
       when 'query'
         @env['REQUEST_URI'] = remove_lang(@env['REQUEST_URI']) if @env.key?('REQUEST_URI')
@@ -203,19 +207,21 @@ module Wovnrb
       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.key?('Location') && headers['Location'] =~ r
-        case @settings['url_pattern']
-        when 'query'
-          headers['Location'] += if headers['Location'] =~ /\?/
-                                   '&'
-                                 else
-                                   '?'
-                                 end
-          headers['Location'] += "#{@settings['lang_param_name']}=#{lang_code}"
-        when 'subdomain'
-          headers['Location'] = headers['Location'].sub(/\/\/([^.]+)/, '//' + lang_code + '.\1')
-        # when 'path'
-        else
-          headers['Location'] = headers['Location'].sub(/(\/\/[^\/]+)/, '\1/' + lang_code)
+        unless @settings['ignore_globs'].ignore?(headers['Location'])
+          case @settings['url_pattern']
+          when 'query'
+            headers['Location'] += if headers['Location'] =~ /\?/
+                                     '&'
+                                   else
+                                     '?'
+                                   end
+            headers['Location'] += "#{@settings['lang_param_name']}=#{lang_code}"
+          when 'subdomain'
+            headers['Location'] = headers['Location'].sub(/\/\/([^.]+)/, '//' + lang_code + '.\1')
+          # when 'path'
+          else
+            headers['Location'] = headers['Location'].sub(/(\/\/[^\/]+)/, '\1/' + lang_code)
+          end
         end
       end
       headers

data/lib/wovnrb/settings.rb

@@ -7,7 +7,7 @@ module Wovnrb
 
     def [](key)
       return @dynamic_settings[key] if @dynamic_settings.key?(key)
-      return ignore_globs if key == 'ignore_globs'
+      return IgnoreGlobsWrapper.new(ignore_globs) if key == 'ignore_globs'
 
       super(key)
     end
@@ -35,5 +35,13 @@ module Wovnrb
       'wovn_token' => 'project_token',
       'wovn_ignore_paths' => 'ignore_paths'
     }.freeze
+
+    class IgnoreGlobsWrapper < Array
+      def ignore?(uri)
+        path = Addressable::URI.parse(uri).path
+
+        any? { |glob| glob.match?(path) }
+      end
+    end
   end
 end

data/lib/wovnrb/version.rb

@@ -1,3 +1,3 @@
 module Wovnrb
-  VERSION = '2.2.0'.freeze
+  VERSION = '2.2.1'.freeze
 end

data/test/lib/headers_test.rb

@@ -279,6 +279,49 @@ module Wovnrb
       assert_equal('http://wovn.io/test', env['HTTP_REFERER'])
     end
 
+    def test_out_should_add_lang_code_to_redirection
+      sut = Wovnrb::Headers.new(
+        Wovnrb.get_env(
+          'SERVER_NAME' => 'wovn.io',
+          'REQUEST_URI' => '/ja/test',
+          'HTTP_REFERER' => 'http://wovn.io/ja/test'
+        ),
+        Wovnrb.get_settings(
+          'default_lang' => 'en',
+          'supported_langs' => %w[en ja],
+          'url_pattern' => 'path',
+          'url_pattern_reg' => '/(?<lang>[^/.?]+)'
+        )
+      )
+      headers = {
+        'Location' => 'http://wovn.io/'
+      }
+
+      assert_equal('http://wovn.io/ja/', sut.out(headers)['Location'])
+    end
+
+    def test_out_should_not_add_lang_code_to_ignored_redirection
+      sut = Wovnrb::Headers.new(
+        Wovnrb.get_env(
+          'SERVER_NAME' => 'wovn.io',
+          'REQUEST_URI' => '/ja/test',
+          'HTTP_REFERER' => 'http://wovn.io/ja/test'
+        ),
+        Wovnrb.get_settings(
+          'default_lang' => 'en',
+          'supported_langs' => %w[en ja],
+          'url_pattern' => 'path',
+          'url_pattern_reg' => '/(?<lang>[^/.?]+)',
+          'ignore_paths' => ['/static/']
+        )
+      )
+      headers = {
+        'Location' => 'http://wovn.io/static/'
+      }
+
+      assert_equal('http://wovn.io/static/', sut.out(headers)['Location'])
+    end
+
     def test_out_http_referer_subdomain_with_custom_lang_code
       Store.instance.update_settings('custom_lang_aliases' => { 'ja' => 'staging-ja' })
       h = Wovnrb::Headers.new(

data/test/lib/wovnrb_test.rb

@@ -108,8 +108,119 @@ HTML
     assert_switch_lang('en', 'ja', body, body, false)
   end
 
+  def test_call_without_path_ignored_should_change_environment
+    settings = {
+      'project_token' => '123456',
+      'url_pattern' => 'path',
+      'default_lang' => 'ja',
+      'supported_langs' => %w[ja en],
+      'ignore_paths' => ['/en/ignored']
+    }
+    env = {
+      'rack.input' => '',
+      'rack.request.query_string' => '',
+      'rack.request.query_hash' => {},
+      'HTTP_HOST' => 'test.com',
+      'REQUEST_URI' => '/en/not_ignored',
+      'PATH_INFO' => '/en/not_ignored'
+    }
+
+    assert_call_affects_env(settings, env, mock_api: true, affected: true)
+  end
+
+  def test_call_with_path_ignored_with_language_code_should_change_environment
+    settings = {
+      'project_token' => '123456',
+      'url_pattern' => 'path',
+      'default_lang' => 'ja',
+      'supported_langs' => %w[ja en],
+      'ignore_paths' => ['/en/ignored']
+    }
+    env = {
+      'rack.input' => '',
+      'rack.request.query_string' => '',
+      'rack.request.query_hash' => {},
+      'HTTP_HOST' => 'test.com',
+      'REQUEST_URI' => '/ignored',
+      'PATH_INFO' => '/ignored'
+    }
+
+    assert_call_affects_env(settings, env, mock_api: false, affected: true)
+  end
+
+  def test_call_with_path_ignored_without_language_code_should_change_environment
+    settings = {
+      'project_token' => '123456',
+      'url_pattern' => 'path',
+      'default_lang' => 'ja',
+      'supported_langs' => %w[ja en],
+      'ignore_paths' => ['/ignored']
+    }
+    env = {
+      'rack.input' => '',
+      'rack.request.query_string' => '',
+      'rack.request.query_hash' => {},
+      'HTTP_HOST' => 'test.com',
+      'REQUEST_URI' => '/en/ignored',
+      'PATH_INFO' => '/en/ignored'
+    }
+
+    assert_call_affects_env(settings, env, mock_api: false, affected: true)
+  end
+
+  def test_call_with_path_ignored_without_language_code_in_original_language_should_change_environment
+    settings = {
+      'project_token' => '123456',
+      'url_pattern' => 'path',
+      'default_lang' => 'ja',
+      'supported_langs' => %w[ja en],
+      'ignore_paths' => ['/ignored']
+    }
+    env = {
+      'rack.input' => '',
+      'rack.request.query_string' => '',
+      'rack.request.query_hash' => {},
+      'HTTP_HOST' => 'test.com',
+      'REQUEST_URI' => '/ignored',
+      'PATH_INFO' => '/ignored'
+    }
+
+    assert_call_affects_env(settings, env, mock_api: false, affected: true)
+  end
+
+  def test_call_with_path_ignored_should_not_change_environment
+    settings = {
+      'project_token' => '123456',
+      'url_pattern' => 'path',
+      'default_lang' => 'ja',
+      'supported_langs' => %w[ja en],
+      'ignore_paths' => ['/en/ignored']
+    }
+    env = {
+      'rack.input' => '',
+      'rack.request.query_string' => '',
+      'rack.request.query_hash' => {},
+      'HTTP_HOST' => 'test.com',
+      'REQUEST_URI' => '/en/ignored',
+      'PATH_INFO' => '/en/ignored'
+    }
+
+    assert_call_affects_env(settings, env, mock_api: false, affected: false)
+  end
+
   private
 
+  def assert_call_affects_env(settings, env, mock_api:, affected:)
+    app_mock = get_app
+    sut = Wovnrb::Interceptor.new(app_mock, settings)
+    unaffected_env = env
+
+    mock_translation_api_response('', '') if mock_api
+    sut.call(env.clone)
+
+    assert_equal(unaffected_env != app_mock.env, affected)
+  end
+
   def assert_switch_lang(original_lang, target_lang, body, expected_body, api_expected = true)
     subdomain = target_lang == original_lang ? '' : "#{target_lang}."
     interceptor = Wovnrb::Interceptor.new(get_app)
@@ -160,7 +271,7 @@ HTML
   end
 
   class RackMock
-    attr_accessor :params
+    attr_accessor :params, :env
 
     def initialize(opts = {})
       @params = {}

data/test/test_helper.rb

@@ -59,7 +59,8 @@ module Wovnrb
   end
 
   def get_settings(options = {})
-    settings = {}
+    settings = Wovnrb::Store.default_settings
+
     settings['project_token'] = 'OHYx9'
     settings['url_pattern'] = 'path'
     settings['url_pattern_reg'] = '/(?<lang>[^/.?]+)'
@@ -68,7 +69,8 @@ module Wovnrb
     settings['api_url'] = 'http://localhost/v0/values'
     settings['default_lang'] = 'en'
     settings['supported_langs'] = %w[en ja]
-    settings.merge(options)
+
+    Wovnrb::Settings.new.merge(settings.merge(options))
   end
 
   def get_env(options = {})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wovnrb
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Jeff Sandford
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-11 00:00:00.000000000 Z
+date: 2019-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport