geo_redirect 0.2.3 → 0.2.4

data/README.md

@@ -89,6 +89,15 @@ If that doesn't suit you, you can customize these when adding `GeoRedirect` to y
 	  	: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.  
+This is useful when working on your configuration YAML.
+
+	Rails.application.middleware.use GeoRedirect::Middleware, :logfile => 'log/geo_redirect.log'
+
+`GeoRedirect`'s log messages will always be prefixed with `[GeoRedirect]`.
+
 ## Known Issues
 
 A couple issues I know about but haven't had the time to fix:

data/lib/geo_redirect.rb

@@ -12,6 +12,7 @@ module GeoRedirect
       # Some defaults
       options[:db]     ||= 'db/GeoIP.dat'
       options[:config] ||= 'config/geo_redirect.yml'
+      @logfile = options[:logfile] || nil
 
       @app = app
 
@@ -38,6 +39,8 @@ module GeoRedirect
         puts "GeoRedirect middlware."
         raise e
       end
+
+      self.log "Initialized middleware"
     end
 
     def call(env)
@@ -57,6 +60,7 @@ module GeoRedirect
     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
@@ -66,6 +70,7 @@ module GeoRedirect
 
     def handle_session
       host = @request.session['geo_redirect']
+      self.log "Handling session var: #{host}"
       redirect_request(host)
     end
 
@@ -77,6 +82,7 @@ module GeoRedirect
     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
@@ -84,15 +90,21 @@ module GeoRedirect
     def handle_geoip
       # Fetch country code
       begin
-        res     = @db.country(@request.env['HTTP_X_FORWARDED_FOR'] || @request.env['REMOTE_ADDR'])
+        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)
@@ -119,7 +131,10 @@ module GeoRedirect
         }.to_param
         url.query = nil if url.query.empty?
 
-        [301, {'Location' => url.to_s, 'Content-Type' => 'text/plain'}, ['Moved Permanently\n']]
+        self.log "Redirecting to #{url}"
+        [301,
+         {'Location' => url.to_s, 'Content-Type' => 'text/plain'},
+         ['Moved Permanently\n']]
       else
         @app.call(@request.env)
       end
@@ -136,11 +151,21 @@ module GeoRedirect
     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
   end
 end

data/lib/geo_redirect/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geo_redirect
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-04 00:00:00.000000000 Z
+date: 2012-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: geoip