geo_redirect 0.2.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in geo_redirect.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 TODO: Write your name
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+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.

data/README.md

@@ -0,0 +1,104 @@
+# Waze GeoRedirect
+
+`GeoRedirect` is a Rack middleware that can be configured to
+redirect incoming clients to different hosts based on their
+geo-location data.
+
+For instance, we use it for [our advertisers site](http://biz.waze.com/)
+to redirect users to:
+
+* [biz.waze.co.il](http://biz.waze.co.il) for Israel-incoming traffic.
+* [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.
+
+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).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'geo_redirect'
+
+And then execute:
+
+    $ bundle
+
+
+## Usage
+
+These usage instructions were written for Rails products, although I'm pretty sure you could use the gem with any other Rack-based solution.
+
+You'll need to add this to your `production.rb`:
+
+	  Rails.application.middleware.use GeoRedirect::Middleware
+
+This will make sure `GeoRedirect` runs before your application gets rolling.
+
+The middleware requires two additional files to be present:
+
+### 1. Configuration YML
+
+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']
+
+:il:
+  :host: 'biz.waze.co.il'
+  :countries: ['IL']
+
+:world: &default
+  :host: 'biz-world.waze.com'
+
+: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. 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/).
+
+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
+
+### Custom paths
+
+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:
+
+	  Rails.application.middleware.use GeoRedirect::Middleware {
+	  	:db => 'db/geo_database.dat',
+	  	:config => 'geo_cfg.yml'
+	  }
+
+## 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).
+
+
+## Contributing
+
+1. Fork it!
+2. Create your feature branch! (`git checkout -b my-new-feature`)
+3. Commit your changes! (`git commit -am 'Add some feature'`)
+4. Push to the branch! (`git push origin my-new-feature`)
+5. Create new Pull Request!

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/geo_redirect.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'geo_redirect/version'
+
+Gem::Specification.new do |gem|
+  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.add_dependency "geoip"
+
+  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)/})
+  gem.require_paths = ["lib"]
+end

data/lib/geo_redirect.rb

@@ -0,0 +1,146 @@
+require 'yaml'
+require 'geoip'
+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'
+
+      @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
+    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
+        forget_host
+        host = nil
+      end
+
+      host.present?
+    end
+
+    def handle_session
+      host = @request.session['geo_redirect']
+      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)
+      remember_host(host)
+      redirect_request(url.host, true)
+    end
+
+    def handle_geoip
+      # Fetch country code
+      begin
+        res     = @db.country(@request.env['REMOTE_ADDR'])
+        code    = res.try(:country_code)
+        country = res.try(:country_code2) unless code.nil? || code.zero?
+      rescue
+        country = nil
+      end
+
+      unless country.nil?
+        host = host_by_country(country) # desired 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?
+
+        [301, {'Location' => url.to_s}, ['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)
+      @request.session['geo_redirect'] = host
+    end
+
+    def forget_host
+      remember_host(nil)
+    end
+  end
+end

data/lib/geo_redirect/railtie.rb

@@ -0,0 +1,10 @@
+require 'geo_redirect'
+require 'rails'
+
+module GeoRedirect
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      require 'tasks/geo_redirect.rb'
+    end
+  end
+end

data/lib/geo_redirect/version.rb

@@ -0,0 +1,3 @@
+module GeoRedirect
+  VERSION = "0.2.1"
+end

data/lib/tasks/geo_redirect.rb

@@ -0,0 +1,19 @@
+require 'zlib'
+require 'open-uri'
+
+namespace :georedirect 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
+    # Fetches DB copy and gunzips it
+    # Thx http://stackoverflow.com/a/2014317/107085
+    source = open(DB_URI)
+    gz = Zlib::GzipReader.new(source)
+    result = gz.read
+
+    # Write to file
+    filename = Rails.root.join('db', 'GeoIP.dat')
+    File.open(filename, 'w') { |f| f.write(result) }
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: geo_redirect
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+  prerelease: 
+platform: ruby
+authors:
+- Sagie Maoz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-28 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: Geo-location based redirector
+email:
+- sagie@waze.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- geo_redirect.gemspec
+- lib/geo_redirect.rb
+- lib/geo_redirect/railtie.rb
+- lib/geo_redirect/version.rb
+- lib/tasks/geo_redirect.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+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: []