geo_redirect 0.3 → 0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cc53d6e770a29fb9a25ad601803bc220e9de5595
+  data.tar.gz: ce7e9473fb1a032807256e361c72811ef06856c8
+SHA512:
+  metadata.gz: 4b82b53e72d1ac2f59562433e6f4f30033115692484049253991507aa3871c4030751f382020976fda8b945425c9df93d7957a58534fa1f065b5e7f13b9b998e
+  data.tar.gz: 467773cacba033e14b1f0ee811fc420095e9f650d7239db8caf10a6bc0ebf4948fb967a5fde8e6096b8d8223624d08d4c732047e2194efa5198ab85dbf8c5326

data/.rubocop.yml

@@ -0,0 +1,16 @@
+require: rubocop-rspec
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/ClassLength:
+  Max: 154
+
+Style/RescueModifier:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false

data/README.md

@@ -12,9 +12,15 @@ to redirect users to:
 * [biz.waze.com](http://biz.waze.com) for US and Canada incoming traffic.
 * [biz-world.waze.com](http://biz-world.waze.com/) for any other sources.
 
-The server stores a session variable with the server it decided on, for future traffic from the same client.
+The server stores a session variable with the server it decided on, for future
+traffic from the same client.
 
-In addition, you can override these redirects by adding `?redirect=1` to any URL, and by that forcing the server to host from the current domain (and saving that domain to the user's session variable).
+In addition, you can override these redirects by adding `?redirect=1` to any
+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).
 
 ## Installation
 
@@ -45,36 +51,44 @@ This should be a YML file representing your redirection rules.
 
 Here's a template that we use for the setup described above:
 
-```
-:us:
-  :host: 'biz.waze.com'
-  :countries: ['US', 'CA']
+    :us:
+      :host: 'biz.waze.com'
+      :countries: ['US', 'CA']
 
-:il:
-  :host: 'biz.waze.co.il'
-  :countries: ['IL']
+    :il:
+      :host: 'biz.waze.co.il'
+      :countries: ['IL']
 
-:world: &default
-  :host: 'biz-world.waze.com'
+    :world: &default
+      :host: 'biz-world.waze.com'
 
-:default: *default
-```
+    :default: *default
 
 Note that:
 
 1. Every main item is a location, and must have a `host` configured.
-2. A location can have a `countries` array. This will cause a redirect to this location for users from that country code. For available country codes, see [ISO 3166 Country Codes list](http://www.maxmind.com/en/iso3166) from MaxMind (the Geo IP provider `GeoRedirect` uses).
-3. There must be a `default` location that would be used in case the client can't be geo-located.
+2. A location can have a `countries` array. This will cause a redirect to this
+   location for users from that country code. For available country codes, see
+   [ISO 3166 Country Codes list](http://www.maxmind.com/en/iso3166) from MaxMind
+   (the Geo IP provider `GeoRedirect` uses).
+3. There must be a `default` location that would be used in case the client
+   can't be geo-located.
 
 ### 2. GeoIP Countries database
 
-`GeoRedirect` uses the [`geoip`](http://geoip.rubyforge.org/) gem for its geo-location functionality. In particular, it requires the `GeoLite country` free database from [MaxMind](http://www.maxmind.com/).
+`GeoRedirect` uses the [`geoip`](http://geoip.rubyforge.org/) gem for its
+geo-location functionality. In particular, it requires the `GeoLite country`
+free database from [MaxMind](http://www.maxmind.com/).
 
-You can download the database file [directly from MaxMind](http://geolite.maxmind.com/download/geoip/database/GeoLiteCountry/GeoIP.dat.gz) and unzip it into `db/` in your project, **or** you could use the following `rake` task designed just for that:
+You can download the database file [directly from
+MaxMind](http://geolite.maxmind.com/download/geoip/database/GeoLiteCountry/GeoIP.dat.gz)
+and unzip it into `db/` in your project, **or** you could use the following
+`rake` task designed just for that:
 
 	$ rake geo_redirect:fetch_db
 
-It'd be a good idea to use this task on your (Capistrano or whatever) deployment scripts.
+It'd be a good idea to use this task on your (Capistrano or whatever) deployment
+scripts.
 
 ### Custom paths
 
@@ -83,33 +97,41 @@ The default paths for these files are:
 1. `config/georedirect.yml`
 2. `db/GeoIP.dat`
 
-If that doesn't suit you, you can customize these when adding `GeoRedirect` to your project:
+If that doesn't suit you, you can customize these when adding `GeoRedirect` to
+your project:
 
 	  Rails.application.middleware.use GeoRedirect::Middleware, {
-	  	:db => 'db/geo_database.dat',
-	  	:config => 'geo_cfg.yml'
+	  	db: 'db/geo_database.dat',
+	  	config: 'geo_cfg.yml'
 	  }
 
 ### Debugging
 
-You can add a `logfile` path string when adding the middleware if you want it to log some of its decision process into the file.  
+You can add a `logfile` path string when adding the middleware if you want it to
+log some of its decision process into the file.  
 This is useful when working on your configuration YAML.
 
-	Rails.application.middleware.use GeoRedirect::Middleware, :logfile => 'log/geo_redirect.log'
+	Rails.application.middleware.use GeoRedirect::Middleware, logfile: 'log/geo_redirect.log'
 
 `GeoRedirect`'s log messages will always be prefixed with `[GeoRedirect]`.
 
 ### Accessing discovered country
 
-The country code discovered for the current user is available for your convenience, under `session['geo_redirect.country']`.  
+The country code discovered for the current user is available for your
+convenience, under `session['geo_redirect.country']`.  
 You can use it to make content decisions, or whatever.
 
 ## Known Issues
 
 A couple issues I know about but haven't had the time to fix:
 
-1. Cross-domain session var is required. In particular, if your stubborn user goes to more than 1 server with `?redirect=1`, all of these servers will never redirect them again (until the session is expired).
-2. When a client accesses your site from an unknown hostname (one that was not configured in the `yml` file) with `?redirect=1`, they will stay in that hostname for the current session, but in the future would be redirected to the configured default hostname (because it was saved on their session var).
+1. Cross-domain session var is required. In particular, if your stubborn user
+   goes to more than 1 server with `?redirect=1`, all of these servers will
+   never redirect them again (until the session is expired).
+2. When a client accesses your site from an unknown hostname (one that was not
+   configured in the `yml` file) with `?redirect=1`, they will stay in that
+   hostname for the current session, but in the future would be redirected to
+   the configured default hostname (because it was saved on their session var).
 
 
 ## Contributing

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => [:spec]
+task default: [:spec]

data/geo_redirect.gemspec

@@ -4,25 +4,24 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'geo_redirect/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "geo_redirect"
+  gem.name          = 'geo_redirect'
   gem.version       = GeoRedirect::VERSION
-  gem.authors       = ["Sagie Maoz"]
-  gem.email         = ["sagie@waze.com"]
-  gem.description   = %q{Geo-location based redirector}
-  gem.summary       = %q{Rack middleware to redirect clients to hostnames based on geo-location}
-  gem.homepage      = ""
+  gem.authors       = ['Sagie Maoz']
+  gem.email         = ['sagie@waze.com']
+  gem.description   = 'Geo-location based redirector'
+  gem.summary       = 'Rack middleware to redirect clients to hostnames based on geo-location'
+  gem.homepage      = ''
 
-  gem.add_dependency "rake"
-  gem.add_dependency "geoip"
+  gem.add_dependency 'rake'
+  gem.add_dependency 'geoip'
 
-  gem.add_development_dependency "rspec",     "~> 2.13.0"
-  gem.add_development_dependency "rack",      "~> 1.5.2"
-  gem.add_development_dependency "rack-test", "~> 0.6.2"
-  gem.add_development_dependency "debugger",  "~> 1.5.0"
-  gem.add_development_dependency "simplecov", "~> 0.7.1"
+  gem.add_development_dependency 'rspec',     '~> 3.1.0'
+  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.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+  gem.require_paths = ['lib']
 end

data/lib/geo_redirect.rb

@@ -6,8 +6,5 @@ module GeoRedirect
   DEFAULT_CONFIG_PATH = 'config/geo_redirect.yml'
 
   # Load rake tasks
-  if defined? Rails
-    require 'geo_redirect/railtie'
-  end
-
+  require 'geo_redirect/railtie' if defined? Rails
 end

data/lib/geo_redirect/middleware.rb

@@ -16,13 +16,16 @@ module GeoRedirect
       @db     = init_db(options[:db])
       @config = init_config(options[:config])
 
-      self.log "Initialized middleware"
+      log 'Initialized middleware'
     end
 
     def call(env)
       @request = Rack::Request.new(env)
 
-      if force_redirect?
+      if skip_redirect?
+        @app.call(env)
+
+      elsif force_redirect?
         handle_force
 
       elsif session_exists?
@@ -36,7 +39,7 @@ module GeoRedirect
     def session_exists?
       host = @request.session['geo_redirect']
       if host && @config[host].nil? # Invalid var, remove it
-        self.log "Invalid session var, forgetting"
+        log 'Invalid session var, forgetting'
         forget_host(host)
         host = nil
       end
@@ -46,7 +49,7 @@ module GeoRedirect
 
     def handle_session
       host = @request.session['geo_redirect']
-      self.log "Handling session var: #{host}"
+      log "Handling session var: #{host}"
       redirect_request(host)
     end
 
@@ -55,10 +58,15 @@ module GeoRedirect
       Rack::Utils.parse_query(url.query).key? 'redirect'
     end
 
+    def skip_redirect?
+      url = URI.parse(@request.url)
+      Rack::Utils.parse_query(url.query).key? 'skip_geo'
+    end
+
     def handle_force
       url = URI.parse(@request.url)
       host = host_by_hostname(url.host)
-      self.log "Handling force flag: #{host}"
+      log "Handling force flag: #{host}"
       remember_host(host)
       redirect_request(url.host, true)
     end
@@ -66,28 +74,28 @@ module GeoRedirect
     def handle_geoip
       country = country_from_request rescue nil
       @request.session['geo_redirect.country'] = country
-      self.log "GeoIP match: country code #{country}"
+      log "GeoIP match: country code #{country}"
 
-      unless country.nil?
+      if country.nil?
+        @app.call(@request.env)
+      else
         host = host_by_country(country) # desired host
-        self.log "GeoIP host match: #{host}"
+        log "GeoIP host match: #{host}"
         remember_host(host)
 
         redirect_request(host)
-      else
-        @app.call(@request.env)
       end
     end
 
-    def redirect_request(host=nil, same_host=false)
+    def redirect_request(host = nil, same_host = false)
       hostname = hostname_by_host(host)
 
       if should_redirect?(hostname, same_host)
         url = redirect_url(hostname)
 
-        self.log "Redirecting to #{url}"
+        log "Redirecting to #{url}"
         [301,
-         {'Location' => url.to_s, 'Content-Type' => 'text/plain'},
+         { 'Location' => url.to_s, 'Content-Type' => 'text/plain' },
          ['Moved Permanently\n']]
       else
         @app.call(@request.env)
@@ -95,12 +103,12 @@ module GeoRedirect
     end
 
     def host_by_country(country)
-      hosts = @config.select { |k, v| Array(v[:countries]).include?(country) }
+      hosts = @config.select { |_k, v| Array(v[:countries]).include?(country) }
       hosts.keys.first || :default
     end
 
     def host_by_hostname(hostname)
-      hosts = @config.select { |k, v| v[:host] == hostname }
+      hosts = @config.select { |_k, v| v[:host] == hostname }
       hosts.keys.first || :default
     end
 
@@ -109,17 +117,18 @@ module GeoRedirect
     end
 
     def remember_host(host)
-      self.log "Remembering: #{host}"
+      log "Remembering: #{host}"
       @request.session['geo_redirect'] = host
     end
 
     def forget_host(host)
-      self.log "Forgetting: #{host}"
+      log "Forgetting: #{host}"
       remember_host(nil)
     end
 
     protected
-    def log(message, level=:debug)
+
+    def log(message, level = :debug)
       @logger.send(level, "[GeoRedirect] #{message}") unless @logger.nil?
     end
 
@@ -134,35 +143,38 @@ module GeoRedirect
     rescue Errno::EINVAL, Errno::ENOENT
       message = <<-ERROR
         Could not load GeoIP database file.
-        Please make sure you have a valid one and add its name to the GeoRedirect middleware.
-        Alternatively, use `rake georedirect:fetch_db` to fetch it to the default location (under db/).
+        Please make sure you have a valid one and add its name to
+        the GeoRedirect middleware.
+        Alternatively, use `rake georedirect:fetch_db` to fetch it
+        to the default location (under db/).
       ERROR
-      self.log(message, :error)
+      log(message, :error)
     end
 
     def init_config(path)
-      YAML.load_file(path) || raise(Errno::EINVAL)
+      YAML.load_file(path) || fail(Errno::EINVAL)
     rescue Errno::EINVAL, Errno::ENOENT, Psych::SyntaxError, SyntaxError
       message = <<-ERROR
         Could not load GeoRedirect config YML file.
-        Please make sure you have a valid YML file and pass its name when adding the GeoRedirect middlware.
+        Please make sure you have a valid YML file and pass its name
+        when adding the GeoRedirect middlware.
       ERROR
-      self.log(message, :error)
+      log(message, :error)
     end
 
     def request_ip
-      ip_address = @request.env['HTTP_X_FORWARDED_FOR'] || @request.env['REMOTE_ADDR']
+      ip_address =
+        @request.env['HTTP_X_FORWARDED_FOR'] || @request.env['REMOTE_ADDR']
       # take only the first given ip
       ip_address.split(',').first.strip
     end
 
-
     def country_from_request
       ip = request_ip
-      self.log "Handling GeoIP lookup: IP #{ip}"
+      log "Handling GeoIP lookup: IP #{ip}"
 
-      res     = @db.country(ip)
-      code    = res[:country_code]
+      res  = @db.country(ip)
+      code = res[:country_code]
 
       res[:country_code2] unless code.nil? || code.zero?
     end
@@ -173,9 +185,9 @@ module GeoRedirect
       url.host = hostname if hostname
 
       # Remove force flag from GET arguments
-      query_hash = Rack::Utils.parse_query(url.query).tap{ |u|
+      query_hash = Rack::Utils.parse_query(url.query).tap do |u|
         u.delete('redirect')
-      }
+      end
 
       # Copy query
       url.query = URI.encode_www_form(query_hash)
@@ -185,13 +197,10 @@ module GeoRedirect
     end
 
     def should_redirect?(hostname, same_host)
-      unless hostname.nil? || same_host
-        hostname_ends_with = %r{#{hostname.gsub(".", "\.")}$}
-        (@request.host =~ hostname_ends_with).nil?
-      else
-        true
-      end
-    end
+      return true if hostname.nil? || same_host
 
+      hostname_ends_with = %r{#{hostname.gsub(".", "\.")}$}
+      (@request.host =~ hostname_ends_with).nil?
+    end
   end
 end

data/lib/geo_redirect/version.rb

@@ -1,3 +1,3 @@
 module GeoRedirect
-  VERSION = "0.3"
+  VERSION = '0.4'
 end

data/lib/tasks/geo_redirect.rake

@@ -5,9 +5,9 @@ require 'zlib'
 namespace :geo_redirect do
   DB_URI = 'http://geolite.maxmind.com/download/geoip/database/GeoLiteCountry/GeoIP.dat.gz'
 
-  desc "Fetches an updated copy of the GeoIP countries DB from MaxMind"
-  task :fetch_db, :db_path do |t, args|
-    args.with_defaults(:db_path => GeoRedirect::DEFAULT_DB_PATH)
+  desc 'Fetches an updated copy of the GeoIP countries DB from MaxMind'
+  task :fetch_db, :db_path do |_t, args|
+    args.with_defaults(db_path: GeoRedirect::DEFAULT_DB_PATH)
 
     # Fetches DB copy and gunzips it
     # Thx http://stackoverflow.com/a/2014317/107085

data/spec/geo_redirect_spec.rb

@@ -1,141 +1,130 @@
-require "spec_helper"
-require "tempfile"
-require "logger"
+require 'spec_helper'
+require 'tempfile'
+require 'logger'
 
-describe "geo_redirect" do
+describe 'geo_redirect' do
   include GeoRedirect::Support
   include Rack::Test::Methods
 
   def session
-    last_request.env['rack.session']
+    last_request.env['rack.session'] || {}
   end
 
   def url_scheme
     last_request.env['rack.url_scheme']
   end
 
-  before :each do
-    @config = YAML.load_file(fixture_path("config.yml"))
-  end
+  let(:config) { YAML.load_file(fixture_path('config.yml')) }
 
-  describe "#load_config" do
-    it "reads a config file" do
+  describe '#load_config' do
+    it 'reads a config file' do
       mock_app
-
-      @app.config.should_not be_nil
-      @app.config.should eq(@config)
+      expect(@app.config).to eq(config)
     end
 
-    it "errors on not-found config file" do
-      mock_app :config => nonexisting_file_path
-      log_should_include("ERROR")
-      log_should_include("Could not load GeoRedirect config YML file")
+    it 'errors on not-found config file' do
+      mock_app config: nonexisting_file_path
+      log_should_include('ERROR')
+      log_should_include('Could not load GeoRedirect config YML file')
     end
 
-    it "errors on a mal-formatted config file" do
-      mock_app :config => fixture_path("config.bad.yml")
-      log_should_include("ERROR")
-      log_should_include("Could not load GeoRedirect config YML file")
+    it 'errors on a mal-formatted config file' do
+      mock_app config: fixture_path('config.bad.yml')
+      log_should_include('ERROR')
+      log_should_include('Could not load GeoRedirect config YML file')
     end
   end
 
-  describe "#load_db" do
-    it "reads a db file" do
+  describe '#load_db' do
+    it 'reads a db file' do
       mock_app
-
-      @app.db.should_not be_nil
-      @app.db.should be_a_kind_of GeoIP
+      expect(@app.db).to be_a(GeoIP)
     end
 
-    it "errors on not-found db file" do
-      mock_app :db => nonexisting_file_path
-      log_should_include("ERROR")
-      log_should_include("Could not load GeoIP database file.")
+    it 'errors on not-found db file' do
+      mock_app db: nonexisting_file_path
+      log_should_include('ERROR')
+      log_should_include('Could not load GeoIP database file.')
     end
 
     # this example is disabled, as it seems that
     # GeoIP does not let me know if a db file is proper.
-=begin
-    it "errors on mal-formatted db file" do
-      pending "GeoIP does not raise on bad files"
-      mock_app :db => fixture_path("config.yml")
-      log_should_include("ERROR")
-      log_should_include("Could not load GeoIP database file.")
-    end
-=end
+    #     it "errors on mal-formatted db file" do
+    #       pending "GeoIP does not raise on bad files"
+    #       mock_app :db => fixture_path("config.yml")
+    #       log_should_include("ERROR")
+    #       log_should_include("Could not load GeoIP database file.")
+    #     end
   end
 
-  describe "#log" do
-    describe "with valid logfile path" do
-      before :each do
-        mock_app
-      end
+  describe '#log' do
+    describe 'with valid logfile path' do
+      before { mock_app }
 
-      it "initiates a log file" do
+      it 'initiates a log file' do
         @app.instance_variable_get(:"@logger").should be_kind_of Logger
       end
 
-      it "prints to log file" do
-        message = "Testing GeoRedirect logger"
+      it 'prints to log file' do
+        message = 'Testing GeoRedirect logger'
         @app.send(:log, [message])
         log_should_include(message)
       end
     end
 
-    it "ignores invalid logfile path" do
-      mock_app :logfile => '/no_such_file'
-      @app.instance_variable_get(:"@logger").should be_nil
+    it 'ignores invalid logfile path' do
+      mock_app logfile: '/no_such_file'
+      expect(@app.instance_variable_get(:"@logger")).to be_nil
     end
   end
 
-  describe "#host_by_country" do
-    before :each do
-      mock_app
-    end
+  describe '#host_by_country' do
+    before { mock_app }
+    subject { @app.host_by_country(country) }
 
-    it "fetches host by country" do
-      @app.host_by_country("US").should eq(:us)
-      @app.host_by_country("IL").should eq(:il)
+    context 'when country is valid' do
+      let(:country) { 'US' }
+      it { is_expected.to eq(:us) }
     end
 
-    it "falls back to default" do
-      @app.host_by_country(:foo).should eq(:default)
+    context 'when country is invalid' do
+      let(:country) { 'WHATEVER' }
+      it { is_expected.to eq(:default) }
     end
   end
 
-  describe "host_by_hostname" do
-    before :each do
-      mock_app
-    end
+  describe 'host_by_hostname' do
+    before { mock_app }
+    subject { @app.host_by_hostname(hostname) }
 
-    it "fetches host by hostname" do
-      @app.host_by_hostname("biz.waze.com").should eq(:us)
-      @app.host_by_hostname("biz.waze.co.il").should eq(:il)
-      @app.host_by_hostname("biz.world.waze.com").should eq(:world)
+    context 'when hostname is valid' do
+      let(:hostname) { 'biz.waze.co.il' }
+      it { is_expected.to eq(:il) }
     end
 
-    it "falls back to default" do
-      @app.host_by_hostname("foo").should eq(:default)
+    context 'when hostname is invalid' do
+      let(:hostname) { 'something.else.org' }
+      it { is_expected.to eq(:default) }
     end
   end
 
-  describe "redirect logic" do
+  describe 'redirect logic' do
     before :each do
       mock_app
     end
 
-    def mock_request_from(code, options={})
-      ip = "5.5.5.5"
+    def mock_request_from(code, options = {})
+      ip = '5.5.5.5'
 
       if code.nil?
         country = nil
       else
-        country = GeoIP::Country.stub({ :country_code2 => code,
-                                        :country_code => 5 })
+        country = GeoIP::Country.stub(country_code2: code,
+                                      country_code: 5)
       end
       @app.db.stub(:country).with(ip).and_return(country)
 
-      env = { "REMOTE_ADDR" => ip, "HTTP_HOST" => "biz.waze.co.il" }
+      env = { 'REMOTE_ADDR' => ip, 'HTTP_HOST' => 'biz.waze.co.il' }
 
       if options[:session]
         env['rack.session'] ||= {}
@@ -144,23 +133,22 @@ describe "geo_redirect" do
       end
 
       args = {}
-      if options[:force]
-        args[:redirect] = 1
-      end
+      args[:redirect] = 1 if options[:force]
+      args[:skip_geo] = true if options[:skip]
 
-      get "/", args, env
+      get '/', args, env
     end
 
     def should_redirect_to(host)
-      last_response.body.should include("Moved Permanently")
+      last_response.body.should include('Moved Permanently')
       last_response.status.should eq(301)
-      last_response.headers.should have_key("Location")
-      url = "#{url_scheme}://#{@config[host][:host]}"
-      last_response.headers["Location"].should start_with(url)
+      last_response.headers.should have_key('Location')
+      url = "#{url_scheme}://#{config[host][:host]}"
+      last_response.headers['Location'].should start_with(url)
     end
 
     def should_not_redirect
-      last_response.body.should include("Hello world!")
+      last_response.body.should include('Hello world!')
       last_response.should be_ok
     end
 
@@ -172,149 +160,82 @@ describe "geo_redirect" do
       session['geo_redirect.country'].should eq(country)
     end
 
-    describe "without session memory" do
-      describe "for a foreign source" do
-        before :each do
-          mock_request_from "US"
-        end
-
-        it "redirects to destination" do
-          should_redirect_to :us
-        end
-
-        it "stores decision in session" do
-          should_remember :us
-        end
-
-        it "stores discovered country in session" do
-          should_remember_country "US"
-        end
+    describe 'without session memory' do
+      describe 'for a foreign source' do
+        before { mock_request_from 'US' }
+        it { should_redirect_to :us }
+        it { should_remember :us }
+        it { should_remember_country 'US' }
       end
 
-      describe "for a local source" do
-        before :each do
-          mock_request_from "IL"
-        end
-
-        it "does not redirect" do
-          should_not_redirect
-        end
-
-        it "stores decision in session" do
-          should_remember :il
-        end
-
-        it "stores discovered country in session" do
-          should_remember_country "IL"
-        end
+      describe 'for a local source' do
+        before { mock_request_from 'IL' }
+        it { should_not_redirect }
+        it { should_remember :il }
+        it { should_remember_country 'IL' }
       end
 
-      describe "for an unknown source" do
-        before :each do
-          mock_request_from "SOMEWHERE OVER THE RAINBOW"
-        end
-
-        it "redirects to default" do
-          should_redirect_to :default
-        end
-
-        it "stores decision in session" do
-          should_remember :default
-        end
-
-        it "stores discovered country in session" do
-          should_remember_country "SOMEWHERE OVER THE RAINBOW"
-        end
+      describe 'for an unknown source' do
+        before { mock_request_from 'SOMEWHERE OVER THE RAINBOW' }
+        it { should_redirect_to :default }
+        it { should_remember :default }
+        it { should_remember_country 'SOMEWHERE OVER THE RAINBOW' }
       end
     end
 
-    describe "with valid session memory" do
-      before :each do
-        mock_request_from "US", :session => :default
-      end
-
-      it "redirects to remembered destination" do
-        should_redirect_to :default
-      end
-
-      it "leaves session as is" do
-        should_remember :default
-      end
-
-      it "remembers discovered country" do
-        should_remember_country "US"
-      end
+    describe 'with valid session memory' do
+      before { mock_request_from 'US', session: :default }
+      it { should_redirect_to :default }
+      it { should_remember :default }
+      it { should_remember_country 'US' }
     end
 
-    describe "with invalid session memory" do
-      before :each do
-        mock_request_from "US", :session => "foo"
-      end
-
-      it "removes invalid session data" do
-        session['geo_redirect'].should_not eq("foo")
-      end
-
-      it "redirects to destination" do
-        should_redirect_to :us
-      end
+    describe 'with invalid session memory' do
+      before { mock_request_from 'US', session: 'foo' }
 
-      it "stores decision in session" do
-        should_remember :us
+      it 'removes invalid session data' do
+        expect(session['geo_redirect']).not_to eq('foo')
       end
 
-      it "stores discovered country in session" do
-        should_remember_country "US"
-      end
+      it { should_redirect_to :us }
+      it { should_remember :us }
+      it { should_remember_country 'US' }
     end
 
-    describe "with forced redirect flag" do
-      before :each do
-        mock_request_from "US", :force => true
-      end
+    describe 'with forced redirect flag' do
+      before { mock_request_from 'US', force: true }
 
-      it "rewrites the flag out" do
-        should_redirect_to :il
-        last_response.headers["Location"].should_not include("redirect=1")
+      it { should_redirect_to :il }
+      it 'rewrites the flag out' do
+        expect(last_response.headers['Location']).not_to include('redirect=1')
       end
 
-      it "stores decision in session" do
-        should_remember :il
-      end
-
-      it "does not store discovered country in session" do
-        should_remember_country nil
-      end
+      it { should_remember :il }
+      it { should_remember_country nil }
     end
 
-    describe "with no recognizable IP" do
-      before :each do
-        mock_request_from nil
-      end
-
-      it "does not redirect" do
-        should_not_redirect
-      end
-
-      it "does not store session" do
-        should_remember nil
-      end
-
-      it "does not store discovered country in session" do
-        should_remember_country nil
-      end
+    describe 'with skip flag' do
+      before { mock_request_from 'US', skip: true }
+      it { should_not_redirect }
+      it { should_remember nil }
+      it { should_remember_country nil }
     end
 
+    describe 'with no recognizable IP' do
+      before { mock_request_from nil }
+      it { should_not_redirect }
+      it { should_remember nil }
+      it { should_remember_country nil }
+    end
   end
 end
 
-describe "geo_redirect:fetch_db" do
-  include_context "rake"
+describe 'geo_redirect:fetch_db' do
+  include_context 'rake'
 
-  it "downloads a GeoIP db to a location" do
-    @dbfile = Tempfile.new("db")
-    subject.invoke(@dbfile.path)
-    @dbfile.size.should_not be_nil
-    @dbfile.size.should be > 0
+  it 'downloads a GeoIP db to a location' do
+    dbfile = Tempfile.new('db')
+    subject.invoke(dbfile.path)
+    expect(dbfile.size).to be > 0
   end
 end

data/spec/spec_helper.rb

@@ -1,16 +1,16 @@
-require "simplecov"
+require 'simplecov'
 SimpleCov.start
 
-require "rspec"
-require "rack"
-require "rack/test"
+require 'rspec'
+require 'rack'
+require 'rack/test'
 
 current_dir = File.dirname(__FILE__)
 $LOAD_PATH.unshift(File.join(current_dir, '..', 'lib'))
 $LOAD_PATH.unshift(current_dir)
-require "geo_redirect"
+require 'geo_redirect'
 
-Dir[File.join(current_dir, "support/**/*.rb")].each { |f| require f }
+Dir[File.join(current_dir, 'support/**/*.rb')].each { |f| require f }
 
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
@@ -18,5 +18,5 @@ RSpec.configure do |config|
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
 
-  config.order = "random"
+  config.order = 'random'
 end

data/spec/support/geo_redirect.rb

@@ -5,7 +5,7 @@ module GeoRedirect
     end
 
     def nonexisting_file_path
-      "/no_such_file"
+      '/no_such_file'
     end
 
     def app
@@ -14,16 +14,16 @@ module GeoRedirect
 
     def mock_app(options = {})
       # Simple HTTP server that always returns 'Hello world!'
-      main_app = lambda { |env|
+      main_app = lambda do |env|
         Rack::Request.new(env)
-        headers = {"Content-Type" => "text/html"}
-        [200, headers, ["Hello world!"]]
-      }
+        headers = { 'Content-Type' => 'text/html' }
+        [200, headers, ['Hello world!']]
+      end
 
-      @logfile = Tempfile.new("log")
-      options = { :config => fixture_path("config.yml"),
-                  :db => fixture_path("GeoIP.dat"),
-                  :logfile => @logfile.path
+      @logfile = Tempfile.new('log')
+      options = { config: fixture_path('config.yml'),
+                  db: fixture_path('GeoIP.dat'),
+                  logfile: @logfile.path
                 }.merge(options)
 
       builder = Rack::Builder.new
@@ -38,4 +38,3 @@ module GeoRedirect
     end
   end
 end
-

data/spec/support/rake.rb

@@ -1,17 +1,17 @@
 # thanks http://robots.thoughtbot.com/post/11957424161/test-rake-tasks-like-a-boss
 
-require "rake"
+require 'rake'
 
-shared_context "rake" do
+shared_context 'rake' do
   let(:rake)      { Rake::Application.new }
   let(:task_name) { self.class.top_level_description }
-  let(:task_path) { "lib/tasks/#{task_name.split(":").first}" }
+  let(:task_path) { "lib/tasks/#{task_name.split(':').first}" }
   subject         { rake[task_name] }
 
   before do
     Rake.application = rake
-    Rake.application.rake_require(task_path,
-      [File.join(File.dirname(__FILE__), "..", "..")])
+    Rake.application
+      .rake_require(task_path, [File.join(File.dirname(__FILE__), '..', '..')])
 
     Rake::Task.define_task(:environment)
   end

metadata

@@ -1,128 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: geo_redirect
 version: !ruby/object:Gem::Version
-  version: '0.3'
-  prerelease: 
+  version: '0.4'
 platform: ruby
 authors:
 - Sagie Maoz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-18 00:00:00.000000000 Z
+date: 2015-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: geoip
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: 1.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 0.6.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.6.2
-- !ruby/object:Gem::Dependency
-  name: debugger
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.5.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 0.6.3
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.9.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.9.1
 description: Geo-location based redirector
 email:
 - sagie@waze.com
@@ -132,6 +103,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .rubocop.yml
 - .travis.yml
 - Gemfile
 - LICENSE.txt
@@ -152,33 +124,26 @@ files:
 - spec/support/rake.rb
 homepage: ''
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3031125964627560618
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3031125964627560618
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.4.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Rack middleware to redirect clients to hostnames based on geo-location
 test_files:
 - spec/fixtures/GeoIP.dat