geo_redirect 0.2.4 → 0.3

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012 TODO: Write your name
+Copyright (c) 2012 Sagie Maoz
 
 MIT License
 
@@ -19,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,4 +1,5 @@
 # Waze GeoRedirect
+[![Build Status](https://secure.travis-ci.org/wazeHQ/geo_redirect.png)](http://travis-ci.org/wazeHQ/geo_redirect) [![Code Climate](https://codeclimate.com/github/wazeHQ/geo_redirect.png)](https://codeclimate.com/github/wazeHQ/geo_redirect) [![Gem Version](https://badge.fury.io/rb/geo_redirect.png)](http://badge.fury.io/rb/geo_redirect)
 
 `GeoRedirect` is a Rack middleware that can be configured to
 redirect incoming clients to different hosts based on their
@@ -71,7 +72,7 @@ Note 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 georedirect:fetch_db
+	$ rake geo_redirect:fetch_db
 
 It'd be a good idea to use this task on your (Capistrano or whatever) deployment scripts.
 
@@ -98,6 +99,11 @@ This is useful when working on your configuration YAML.
 
 `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']`.  
+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:

data/Rakefile

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

data/geo_redirect.gemspec

@@ -12,8 +12,15 @@ Gem::Specification.new do |gem|
   gem.summary       = %q{Rack middleware to redirect clients to hostnames based on geo-location}
   gem.homepage      = ""
 
+  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.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})

data/lib/geo_redirect/middleware.rb

@@ -0,0 +1,197 @@
+require 'yaml'
+require 'geoip'
+
+module GeoRedirect
+  class Middleware
+    attr_accessor :db, :config
+
+    def initialize(app, options = {})
+      # Some defaults
+      options[:db]     ||= DEFAULT_DB_PATH
+      options[:config] ||= DEFAULT_CONFIG_PATH
+
+      @app = app
+
+      @logger = init_logger(options[:logfile]) if options[:logfile]
+      @db     = init_db(options[:db])
+      @config = init_config(options[:config])
+
+      self.log "Initialized middleware"
+    end
+
+    def call(env)
+      @request = Rack::Request.new(env)
+
+      if force_redirect?
+        handle_force
+
+      elsif session_exists?
+        handle_session
+
+      else
+        handle_geoip
+      end
+    end
+
+    def session_exists?
+      host = @request.session['geo_redirect']
+      if host && @config[host].nil? # Invalid var, remove it
+        self.log "Invalid session var, forgetting"
+        forget_host(host)
+        host = nil
+      end
+
+      !host.nil?
+    end
+
+    def handle_session
+      host = @request.session['geo_redirect']
+      self.log "Handling session var: #{host}"
+      redirect_request(host)
+    end
+
+    def force_redirect?
+      url = URI.parse(@request.url)
+      Rack::Utils.parse_query(url.query).key? 'redirect'
+    end
+
+    def handle_force
+      url = URI.parse(@request.url)
+      host = host_by_hostname(url.host)
+      self.log "Handling force flag: #{host}"
+      remember_host(host)
+      redirect_request(url.host, true)
+    end
+
+    def handle_geoip
+      country = country_from_request rescue nil
+      @request.session['geo_redirect.country'] = country
+      self.log "GeoIP match: country code #{country}"
+
+      unless country.nil?
+        host = host_by_country(country) # desired host
+        self.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)
+      hostname = hostname_by_host(host)
+
+      if should_redirect?(hostname, same_host)
+        url = redirect_url(hostname)
+
+        self.log "Redirecting to #{url}"
+        [301,
+         {'Location' => url.to_s, 'Content-Type' => 'text/plain'},
+         ['Moved Permanently\n']]
+      else
+        @app.call(@request.env)
+      end
+    end
+
+    def host_by_country(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.keys.first || :default
+    end
+
+    def hostname_by_host(host)
+      host.is_a?(Symbol) ? @config[host][:host] : host
+    end
+
+    def remember_host(host)
+      self.log "Remembering: #{host}"
+      @request.session['geo_redirect'] = host
+    end
+
+    def forget_host(host)
+      self.log "Forgetting: #{host}"
+      remember_host(nil)
+    end
+
+    protected
+    def log(message, level=:debug)
+      @logger.send(level, "[GeoRedirect] #{message}") unless @logger.nil?
+    end
+
+    def init_logger(path)
+      Logger.new(path)
+    rescue Errno::EINVAL, Errno::EACCES
+      nil
+    end
+
+    def init_db(path)
+      GeoIP.new(path)
+    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/).
+      ERROR
+      self.log(message, :error)
+    end
+
+    def init_config(path)
+      YAML.load_file(path) || raise(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.
+      ERROR
+      self.log(message, :error)
+    end
+
+    def request_ip
+      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}"
+
+      res     = @db.country(ip)
+      code    = res[:country_code]
+
+      res[:country_code2] unless code.nil? || code.zero?
+    end
+
+    def redirect_url(hostname)
+      url = URI.parse(@request.url)
+      url.port = nil
+      url.host = hostname if hostname
+
+      # Remove force flag from GET arguments
+      query_hash = Rack::Utils.parse_query(url.query).tap{ |u|
+        u.delete('redirect')
+      }
+
+      # Copy query
+      url.query = URI.encode_www_form(query_hash)
+      url.query = nil if url.query.empty?
+
+      url
+    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
+
+  end
+end

data/lib/geo_redirect/railtie.rb

@@ -4,7 +4,7 @@ require 'rails'
 module GeoRedirect
   class Railtie < Rails::Railtie
     rake_tasks do
-      require 'tasks/geo_redirect.rb'
+      load 'tasks/geo_redirect.rake'
     end
   end
 end

data/lib/geo_redirect/version.rb

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

data/lib/geo_redirect.rb

@@ -1,171 +1,13 @@
-require 'yaml'
-require 'geoip'
+require 'geo_redirect/middleware'
 require 'geo_redirect/version'
 
 module GeoRedirect
-  # Load rake tasks
-  require 'geo_redirect/railtie' if defined?(Rails)
-
-  # Rack middleware
-  class Middleware
-    def initialize(app, options = {})
-      # Some defaults
-      options[:db]     ||= 'db/GeoIP.dat'
-      options[:config] ||= 'config/geo_redirect.yml'
-      @logfile = options[:logfile] || nil
-
-      @app = app
-
-      # Load GeoIP database
-      begin
-        @db = GeoIP.new(options[:db])
-      rescue Errno::EINVAL, Errno::ENOENT => e
-        puts "Could not load GeoIP database file."
-        puts "Please make sure you have a valid one and"
-        puts "add its name to the GeoRedirect middleware."
-        puts "Alternatively, use `rake georedirect:fetch_db`"
-        puts "to fetch it to the default location (under db/)."
-        raise e
-      end
-
-      # Load config object
-      begin
-        @config = YAML.load_file('config/geo_redirect.yml')
-        raise Errno::EINVAL unless @config
-      rescue Errno::EINVAL, Errno::ENOENT => e
-        puts "Could not load GeoRedirect config YML file."
-        puts "Please make sure you have a valid YML file"
-        puts "and pass its name when adding the"
-        puts "GeoRedirect middlware."
-        raise e
-      end
-
-      self.log "Initialized middleware"
-    end
-
-    def call(env)
-      @request = Rack::Request.new(env)
-
-      if force_redirect?
-        handle_force
-
-      elsif session_exists?
-        handle_session
-
-      else
-        handle_geoip
-      end
-    end
-
-    def session_exists?
-      host = @request.session['geo_redirect']
-      if host.present? && @config[host].nil? # Invalid var, remove it
-        self.log "Invalid session var, forgetting"
-        forget_host
-        host = nil
-      end
-
-      host.present?
-    end
-
-    def handle_session
-      host = @request.session['geo_redirect']
-      self.log "Handling session var: #{host}"
-      redirect_request(host)
-    end
-
-    def force_redirect?
-      url = URI.parse(@request.url)
-      Rack::Utils.parse_query(url.query).key? 'redirect'
-    end
+  DEFAULT_DB_PATH     = 'db/GeoIP.dat'
+  DEFAULT_CONFIG_PATH = 'config/geo_redirect.yml'
 
-    def handle_force
-      url = URI.parse(@request.url)
-      host = host_by_hostname(url.host)
-      self.log "Handling force flag: #{host}"
-      remember_host(host)
-      redirect_request(url.host, true)
-    end
-
-    def handle_geoip
-      # Fetch country code
-      begin
-        ip_address = @request.env['HTTP_X_FORWARDED_FOR'] || @request.env['REMOTE_ADDR']
-        ip_address = ip_address.split(',').first.chop # take only the first given ip
-        self.log "Handling GeoIP lookup: IP #{ip_address}"
-        res     = @db.country(ip_address)
-        code    = res.try(:country_code)
-        country = res.try(:country_code2) unless code.nil? || code.zero?
-      rescue
-        country = nil
-      end
-
-      self.log "GeoIP match: country code #{country}"
-
-      unless country.nil?
-        host = host_by_country(country) # desired host
-        self.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)
-      redirect = true
-      unless host.nil?
-        hostname = host.is_a?(Symbol) ? @config[host][:host] : host
-        redirect = hostname.present?
-        redirect &&= !@request.host.ends_with?(hostname) unless same_host
-      end
-
-      if redirect
-        url = URI.parse(@request.url)
-        url.port = nil
-        url.host = hostname if host
-        # Remove 'redirect' GET arg
-        url.query = Rack::Utils.parse_query(url.query).tap{ |u|
-          u.delete('redirect')
-        }.to_param
-        url.query = nil if url.query.empty?
-
-        self.log "Redirecting to #{url}"
-        [301,
-         {'Location' => url.to_s, 'Content-Type' => 'text/plain'},
-         ['Moved Permanently\n']]
-      else
-        @app.call(@request.env)
-      end
-    end
-
-    def host_by_country(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.keys.first || :default
-    end
-
-    def remember_host(host)
-      self.log "Remembering: #{host}"
-      @request.session['geo_redirect'] = host
-    end
-
-    def forget_host
-      self.log "Forgetting: #{host}"
-      remember_host(nil)
-    end
-
-    protected
-    def log(message)
-      unless @logfile.nil?
-        @logger ||= Logger.new(@logfile)
-        @logger.debug("[GeoRedirect] #{message}")
-      end
-    end
+  # Load rake tasks
+  if defined? Rails
+    require 'geo_redirect/railtie'
   end
+
 end

data/lib/tasks/{geo_redirect.rb → geo_redirect.rake}

@@ -1,11 +1,14 @@
-require 'zlib'
+require 'geo_redirect'
 require 'open-uri'
+require 'zlib'
 
-namespace :georedirect do
+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 do
+  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
     source = open(DB_URI)
@@ -13,7 +16,6 @@ namespace :georedirect do
     result = gz.read
 
     # Write to file
-    filename = Rails.root.join('db', 'GeoIP.dat')
-    File.open(filename, 'w') { |f| f.write(result) }
+    File.open(args[:db_path], 'w') { |f| f.write(result) }
   end
 end

data/spec/fixtures/config.bad.yml

@@ -0,0 +1,7 @@
+:::T:HIS
+     is:
+   not :
+        really      : @$#%& &
+: a 
+  :   v  a  l  i  d
+    YAML file!!!

data/spec/fixtures/config.yml

@@ -0,0 +1,12 @@
+:us:
+  :host: 'biz.waze.com'
+  :countries: ['US', 'CA']
+
+:il:
+  :host: 'biz.waze.co.il'
+  :countries: ['IL']
+
+:world: &default
+  :host: 'biz.world.waze.com'
+
+:default: *default

data/spec/geo_redirect_spec.rb

@@ -0,0 +1,320 @@
+require "spec_helper"
+require "tempfile"
+require "logger"
+
+describe "geo_redirect" do
+  include GeoRedirect::Support
+  include Rack::Test::Methods
+
+  def 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
+
+  describe "#load_config" do
+    it "reads a config file" do
+      mock_app
+
+      @app.config.should_not be_nil
+      @app.config.should 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")
+    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")
+    end
+  end
+
+  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
+    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.")
+    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
+  end
+
+  describe "#log" do
+    describe "with valid logfile path" do
+      before :each do
+        mock_app
+      end
+
+      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"
+        @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
+    end
+  end
+
+  describe "#host_by_country" do
+    before :each do
+      mock_app
+    end
+
+    it "fetches host by country" do
+      @app.host_by_country("US").should eq(:us)
+      @app.host_by_country("IL").should eq(:il)
+    end
+
+    it "falls back to default" do
+      @app.host_by_country(:foo).should eq(:default)
+    end
+  end
+
+  describe "host_by_hostname" do
+    before :each do
+      mock_app
+    end
+
+    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)
+    end
+
+    it "falls back to default" do
+      @app.host_by_hostname("foo").should eq(:default)
+    end
+  end
+
+  describe "redirect logic" do
+    before :each do
+      mock_app
+    end
+
+    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 })
+      end
+      @app.db.stub(:country).with(ip).and_return(country)
+
+      env = { "REMOTE_ADDR" => ip, "HTTP_HOST" => "biz.waze.co.il" }
+
+      if options[:session]
+        env['rack.session'] ||= {}
+        env['rack.session']['geo_redirect'] = options[:session]
+        env['rack.session']['geo_redirect.country'] = code
+      end
+
+      args = {}
+      if options[:force]
+        args[:redirect] = 1
+      end
+
+      get "/", args, env
+    end
+
+    def should_redirect_to(host)
+      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)
+    end
+
+    def should_not_redirect
+      last_response.body.should include("Hello world!")
+      last_response.should be_ok
+    end
+
+    def should_remember(host)
+      session['geo_redirect'].should eq(host)
+    end
+
+    def should_remember_country(country)
+      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
+      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
+      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
+      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
+    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
+
+      it "stores decision in session" do
+        should_remember :us
+      end
+
+      it "stores discovered country in session" do
+        should_remember_country "US"
+      end
+    end
+
+    describe "with forced redirect flag" do
+      before :each do
+        mock_request_from "US", :force => true
+      end
+
+      it "rewrites the flag out" do
+        should_redirect_to :il
+        last_response.headers["Location"].should_not 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
+    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
+    end
+
+  end
+end
+
+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
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require "simplecov"
+SimpleCov.start
+
+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"
+
+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|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.order = "random"
+end

data/spec/support/geo_redirect.rb

@@ -0,0 +1,41 @@
+module GeoRedirect
+  module Support
+    def fixture_path(file)
+      "spec/fixtures/#{file}"
+    end
+
+    def nonexisting_file_path
+      "/no_such_file"
+    end
+
+    def app
+      Rack::Lint.new(@app)
+    end
+
+    def mock_app(options = {})
+      # Simple HTTP server that always returns 'Hello world!'
+      main_app = lambda { |env|
+        Rack::Request.new(env)
+        headers = {"Content-Type" => "text/html"}
+        [200, headers, ["Hello world!"]]
+      }
+
+      @logfile = Tempfile.new("log")
+      options = { :config => fixture_path("config.yml"),
+                  :db => fixture_path("GeoIP.dat"),
+                  :logfile => @logfile.path
+                }.merge(options)
+
+      builder = Rack::Builder.new
+      builder.use GeoRedirect::Middleware, options
+      builder.run main_app
+      @app = builder.to_app
+    end
+
+    def log_should_include(message)
+      @logfile.rewind
+      @logfile.read.should include(message)
+    end
+  end
+end
+

data/spec/support/rake.rb

@@ -0,0 +1,18 @@
+# thanks http://robots.thoughtbot.com/post/11957424161/test-rake-tasks-like-a-boss
+
+require "rake"
+
+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}" }
+  subject         { rake[task_name] }
+
+  before do
+    Rake.application = rake
+    Rake.application.rake_require(task_path,
+      [File.join(File.dirname(__FILE__), "..", "..")])
+
+    Rake::Task.define_task(:environment)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geo_redirect
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: '0.3'
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-07 00:00:00.000000000 Z
+date: 2013-07-18 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
@@ -27,6 +43,86 @@ dependencies:
     - - ! '>='
       - !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
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  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
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
 description: Geo-location based redirector
 email:
 - sagie@waze.com
@@ -35,15 +131,25 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - geo_redirect.gemspec
 - lib/geo_redirect.rb
+- lib/geo_redirect/middleware.rb
 - lib/geo_redirect/railtie.rb
 - lib/geo_redirect/version.rb
-- lib/tasks/geo_redirect.rb
+- lib/tasks/geo_redirect.rake
+- spec/fixtures/GeoIP.dat
+- spec/fixtures/config.bad.yml
+- spec/fixtures/config.yml
+- spec/geo_redirect_spec.rb
+- spec/spec_helper.rb
+- spec/support/geo_redirect.rb
+- spec/support/rake.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -56,16 +162,29 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !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
 signing_key: 
 specification_version: 3
 summary: Rack middleware to redirect clients to hostnames based on geo-location
-test_files: []
+test_files:
+- spec/fixtures/GeoIP.dat
+- spec/fixtures/config.bad.yml
+- spec/fixtures/config.yml
+- spec/geo_redirect_spec.rb
+- spec/spec_helper.rb
+- spec/support/geo_redirect.rb
+- spec/support/rake.rb