geo_redirect 0.6 → 0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb2df8b52f6869e6ed852973fa5774550c54f76c
-  data.tar.gz: b7e9c851cc2a67003efec2d8705eafc227176633
+  metadata.gz: 9f21f596f04cc22f8af21cd140c5e618c226a0f4
+  data.tar.gz: 210880d4a407c0e7263c282d5c421a1a3661affb
 SHA512:
-  metadata.gz: 2a654e3b640ef5c8eae208f5908e4c638816f933f42c31137b1c0c4c4a0108100282b72506d16c5f413354898c2323520cf2e5d2f54d25c8347b6bd540045e9b
-  data.tar.gz: 4ded31b14b6aa4c474a26f632af865bc7ec61ee75030aad98b6c0b39ef89d6321e8718e962bbdf61b88d2abaa9ec07c3b3a51c0a027c582608ab9c98301e4972
+  metadata.gz: aaacd15e27321f27961ff90d82a6b9f7d637774d4f427aa67efe95b46a681c70ef28ae0ff06109d963e84b5335df9f551b4d89cd54954efb02bd006999d73b60
+  data.tar.gz: bb5742370da7819f41579dcec891d52890dc9bbe0e7fdac7ab85c8e26d4153a9a76fa59258067a502c5f8357b72c509d9aa84da6298e3e656fbbd35eff13ec8d

data/.rubocop.yml

@@ -7,7 +7,7 @@ Metrics/MethodLength:
   Max: 15
 
 Metrics/ClassLength:
-  Max: 170
+  Max: 180
 
 Style/RescueModifier:
   Enabled: false

data/README.md

@@ -20,7 +20,7 @@ URL, and by that forcing the server to host from the current domain (and saving
 that domain to the user's session variable).
 
 To skip geo-redirection completely, pass a `?skip_geo=true` argument (this would
-avoid saving any session value and/or HTTP redirects).
+avoid saving any session value and/or HTTP redirects.
 
 ## Installation
 
@@ -127,6 +127,25 @@ your project:
 	  	config: 'geo_cfg.yml'
 	  }
 
+### Custom logic to skip the redirection
+
+You can pass a block to the `:skip_if` option to provide custom logic to skip the redirection.
+
+    Rails.application.middleware.use GeoRedirect::Middleware, skip_if: ->(req) { req.bot? }
+
+will ignore requests from bots (the code inside the block is just pseudo-code).
+
+### Skipping
+
+As mentioned, skipping Geo-redirection is done either by:
+
+* `redirect=1` to force a new domain and remember it in the user's session variable.
+* `skip_geo=true` for a one-time force (with no memory).
+
+If the `:remember_when_skipping` option flag is set to true, the server will
+always remember the current domain, even after skipping.
+
+
 ### Debugging
 
 You can add a `logfile` path string when adding the middleware if you want it to

data/geo_redirect.gemspec

@@ -20,8 +20,8 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rack',            '~> 1.6.0'
   gem.add_development_dependency 'rack-test',       '~> 0.6.3'
   gem.add_development_dependency 'simplecov',       '~> 0.9.1'
-  gem.add_development_dependency 'rubocop',         '~> 0.33.0'
-  gem.add_development_dependency 'rubocop-rspec',   '~> 1.3.0'
+  gem.add_development_dependency 'rubocop',         '~> 0.37'
+  gem.add_development_dependency 'rubocop-rspec',   '~> 1.4.0'
 
   gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }

data/lib/geo_redirect/middleware.rb

@@ -7,6 +7,7 @@ module GeoRedirect
 
     def initialize(app, options = {})
       @app = app
+      @options = options
 
       @logger = init_logger(options[:logfile])
       @db     = init_db(options[:db] || DEFAULT_DB_PATH)
@@ -22,6 +23,7 @@ module GeoRedirect
       @request = Rack::Request.new(env)
 
       if skip_redirect?
+        remember_host(request_host) if @options[:remember_when_skipping]
         @app.call(env)
 
       elsif force_redirect?
@@ -55,15 +57,14 @@ module GeoRedirect
     end
 
     def force_redirect?
-      url = URI.parse(@request.url)
-      Rack::Utils.parse_query(url.query).key? 'redirect'
+      Rack::Utils.parse_query(request_url.query).key? 'redirect'
     end
 
     def skip_redirect?
-      url = URI.parse(@request.url)
-      query_includes_skip_geo?(url) ||
-        path_not_whitelisted?(url) ||
-        path_blacklisted?(url)
+      query_includes_skip_geo?(request_url) ||
+        path_not_whitelisted?(request_url) ||
+        path_blacklisted?(request_url) ||
+        skipped_by_block?
     end
 
     def query_includes_skip_geo?(url)
@@ -71,7 +72,7 @@ module GeoRedirect
     end
 
     def path_not_whitelisted?(url)
-      @include_paths.length > 0 &&
+      !@include_paths.empty? &&
         !@include_paths.any? { |exclude| url.path == exclude }
     end
 
@@ -79,12 +80,14 @@ module GeoRedirect
       @exclude_paths.any? { |exclude| url.path == exclude }
     end
 
+    def skipped_by_block?
+      @options[:skip_if] && @options[:skip_if].call(@request)
+    end
+
     def handle_force
-      url = URI.parse(@request.url)
-      host = host_by_hostname(url.host)
-      log "Handling force flag: #{host}"
-      remember_host(host)
-      redirect_request(url.host, true)
+      log 'Handling force flag'
+      remember_host(request_host)
+      redirect_request(request_url.host, true)
     end
 
     def handle_geoip
@@ -168,7 +171,7 @@ module GeoRedirect
     end
 
     def init_config(path)
-      YAML.load_file(path) || fail(Errno::EINVAL)
+      YAML.load_file(path) || raise(Errno::EINVAL)
     rescue Errno::EINVAL, Errno::ENOENT, Psych::SyntaxError, SyntaxError
       message = <<-ERROR
         Could not load GeoRedirect config YML file.
@@ -185,6 +188,14 @@ module GeoRedirect
       ip_address.split(',').first.strip
     end
 
+    def request_url
+      @request_url ||= URI.parse(@request.url)
+    end
+
+    def request_host
+      host_by_hostname(request_url.host)
+    end
+
     def country_from_request
       ip = request_ip
       log "Handling GeoIP lookup: IP #{ip}"
@@ -196,7 +207,7 @@ module GeoRedirect
     end
 
     def redirect_url(hostname)
-      url = URI.parse(@request.url)
+      url = request_url.clone
       url.port = nil
       url.host = hostname if hostname
 

data/lib/geo_redirect/version.rb

@@ -1,3 +1,3 @@
 module GeoRedirect
-  VERSION = '0.6'
+  VERSION = '0.7'.freeze
 end

data/lib/geo_redirect.rb

@@ -2,8 +2,8 @@ require 'geo_redirect/middleware'
 require 'geo_redirect/version'
 
 module GeoRedirect
-  DEFAULT_DB_PATH     = 'db/GeoIP.dat'
-  DEFAULT_CONFIG_PATH = 'config/geo_redirect.yml'
+  DEFAULT_DB_PATH     = 'db/GeoIP.dat'.freeze
+  DEFAULT_CONFIG_PATH = 'config/geo_redirect.yml'.freeze
 
   # Load rake tasks
   require 'geo_redirect/railtie' if defined? Rails

data/lib/tasks/geo_redirect.rake

@@ -3,7 +3,7 @@ require 'open-uri'
 require 'zlib'
 
 namespace :geo_redirect do
-  DB_URI = 'http://geolite.maxmind.com/download/geoip/database/GeoLiteCountry/GeoIP.dat.gz'
+  DB_URI = 'http://geolite.maxmind.com/download/geoip/database/GeoLiteCountry/GeoIP.dat.gz'.freeze
 
   desc 'Fetches an updated copy of the GeoIP countries DB from MaxMind'
   task :fetch_db, :db_path do |_t, args|

data/spec/lib/geo_redirect/middleware_spec.rb

@@ -225,6 +225,24 @@ describe GeoRedirect::Middleware do
       it { is_expected.to not_redirect }
       it { is_expected.to remember nil }
       it { is_expected.to remember_country nil }
+
+      context 'with remember_when_skipping option set to true' do
+        let(:app_options) { { remember_when_skipping: true } }
+        let(:country_code) { 'IL' }
+        let(:request_args) { { skip_geo: true } }
+        it { is_expected.to not_redirect }
+        it { is_expected.to remember :il }
+        it { is_expected.to remember_country nil }
+      end
+
+      context 'with remember_when_skipping option set to false' do
+        let(:app_options) { { remember_when_skipping: false } }
+        let(:country_code) { 'IL' }
+        let(:request_args) { { skip_geo: true } }
+        it { is_expected.to not_redirect }
+        it { is_expected.to remember nil }
+        it { is_expected.to remember_country nil }
+      end
     end
 
     context 'with no recognizable IP' do
@@ -234,6 +252,24 @@ describe GeoRedirect::Middleware do
       it { is_expected.to remember_country nil }
     end
 
+    context 'with skip_if block' do
+      let(:country_code) { 'US' }
+
+      context 'when returns true' do
+        let(:app_options) { { skip_if: ->(_req) { true } } }
+        it { is_expected.to not_redirect }
+        it { is_expected.to remember nil }
+        it { is_expected.to remember_country nil }
+      end
+
+      context 'when returns false' do
+        let(:app_options) { { skip_if: ->(_req) { false } } }
+        it { is_expected.to redirect_to :us }
+        it { is_expected.to remember :us }
+        it { is_expected.to remember_country 'US' }
+      end
+    end
+
     describe 'include/exclude logic' do
       let(:country_code) { 'US' }
 

data/spec/support/rake.rb

@@ -11,7 +11,8 @@ shared_context 'rake' do
   before do
     Rake.application = rake
     Rake.application
-      .rake_require(task_path, [File.join(File.dirname(__FILE__), '..', '..')])
+        .rake_require(task_path,
+                      [File.join(File.dirname(__FILE__), '..', '..')])
 
     Rake::Task.define_task(:environment)
   end

metadata

@@ -1,127 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: geo_redirect
 version: !ruby/object:Gem::Version
-  version: '0.6'
+  version: '0.7'
 platform: ruby
 authors:
 - Sagie Maoz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-01 00:00:00.000000000 Z
+date: 2016-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: geoip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.6.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.6.3
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.1
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.33.0
+        version: '0.37'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.33.0
+        version: '0.37'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.4.0
 description: Geo-location based redirector
 email:
 - sagie@waze.com
@@ -129,10 +129,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .rubocop.yml
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -160,17 +160,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Rack middleware to redirect clients to hostnames based on geo-location
@@ -183,3 +183,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/geo_redirect.rb
 - spec/support/rake.rb
+has_rdoc: