geo_location 0.1.3

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Chris Your
+
+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.rdoc

@@ -0,0 +1,41 @@
+= Geo Location
+
+Geo Locate your users using their IP address via hostip.info or maxmind.com.
+
+
+== Installation
+
+  gem install geo_location
+
+
+== Configuration
+
+config/initializers/geo_location_config.rb:
+
+  unless GeoLocation == nil
+	# Hostip (free)
+	GeoLocation::use = :hostip
+
+	# Max Mind (paid)
+	# For more information visit: http://www.maxmind.com/app/city
+	# GeoLocation::use = :maxmind
+	# GeoLocation::key = 'YOUR MaxMind.COM LICENSE KEY'
+	# GeoLocation::test = 'US,NY,Jamaica,40.676300,-73.775200' # Use this location while you test
+  end
+
+
+== Example
+
+  ip = GeoLocation.find('24.24.24.24') # => {:city=>"Jamaica", :region=>"NY", :country=>"US", :latitude=>"40.676300", :longitude=>"-73.775200"}
+  
+  puts ip[:city] # => Sugar Grove
+  puts ip[:region] # => IL
+  puts ip[:country] # => UNITED STATES
+  puts ip[:country_code] # => US
+  puts ip[:latitude] # => 40.676300
+  puts ip[:longitude] # => -73.775200
+
+
+== Copyright
+
+Copyright (c) 2010 Chris Your. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "geo_location"
+    gem.summary = %Q{Geo-locate your users using their IP address via hostip.info or maxmind.com.}
+    gem.description = %Q{Geo-locate your users using their IP address via hostip.info or maxmind.com.}
+    gem.email = "chris@ignitionindustries.com"
+    gem.homepage = "http://github.com/chrisyour/geo_location"
+    gem.authors = ["Chris Your"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "geo_location #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.3

data/geo_location.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{geo_location}
+  s.version = "0.1.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chris Your"]
+  s.date = %q{2010-08-24}
+  s.description = %q{Geo-locate your users using their IP address via hostip.info or maxmind.com.}
+  s.email = %q{chris@ignitionindustries.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "geo_location.gemspec",
+     "lib/geo_location.rb",
+     "lib/geo_location/geo_location.rb",
+     "lib/geo_location/variables.rb",
+     "lib/geo_location/version.rb",
+     "test/helper.rb",
+     "test/test_geo_location.rb"
+  ]
+  s.homepage = %q{http://github.com/chrisyour/geo_location}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Geo-locate your users using their IP address via hostip.info or maxmind.com.}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_geo_location.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/lib/geo_location.rb

@@ -0,0 +1,5 @@
+require 'active_support/inflector'
+
+require 'geo_location/variables'
+require 'geo_location/geo_location'
+require 'geo_location/version'

data/lib/geo_location/geo_location.rb

@@ -0,0 +1,102 @@
+require 'net/http'
+require 'rexml/document'
+include REXML
+
+module GeoLocation
+  
+  class << self
+    
+    def find(ip)
+      return nil unless valid_ip(ip)
+      return (GeoLocation::use == :maxmind) ? maxmind(ip) : hostip(ip)
+    end
+    
+    def valid_ip(ip)
+      ip =~ /(([2]([0-4][0-9]|[5][0-5])|[0-1]?[0-9]?[0-9])[.]){3}(([2]([0-4][0-9]|[5][0-5])|[0-1]?[0-9]?[0-9]))/i
+    end
+    
+    # == Sample text output from Max Mind
+    #   US,NY,Jamaica,40.676300,-73.775200
+    
+    def maxmind(ip)
+      unless GeoLocation::test.nil? || GeoLocation::test.empty?
+        puts "WARNING: GeoLocation is using the test location: #{GeoLocation::test}"
+        location = GeoLocation::test.split(',')
+      else
+        url = "http://geoip3.maxmind.com/b?l=#{GeoLocation::key}&i=#{ip}"
+        uri = URI.parse(url)
+        location = Net::HTTP.get_response(uri).body.split(',')
+      end
+      
+      data = {}
+      data[:country] = location[0]
+      data[:region] = location[1]
+      data[:city] = location[2]
+      data[:latitude] = location[3]
+      data[:longitude] = location[4]
+      
+      data
+    end
+    
+    # == Sample XML output from hostip.info (http://api.hostip.info/?ip=12.215.42.19)
+    #   <?xml version="1.0" encoding="ISO-8859-1" ?>
+    #   <HostipLookupResultSet version="1.0.1" xmlns:gml="http://www.opengis.net/gml" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.hostip.info/api/hostip-1.0.1.xsd">
+    #    <gml:description>This is the Hostip Lookup Service</gml:description>
+    #    <gml:name>hostip</gml:name>
+    #    <gml:boundedBy>
+    #     <gml:Null>inapplicable</gml:Null>
+    #    </gml:boundedBy>
+    #    <gml:featureMember>
+    #     <Hostip>
+    #      <ip>142.59.52.238</ip>
+    #      <gml:name>EDMONTON, AB</gml:name>
+    #      <countryName>CANADA</countryName>
+    #      <countryAbbrev>CA</countryAbbrev>
+    #      <!-- Co-ordinates are available as lng,lat -->
+    #      <ipLocation>
+    #       <gml:pointProperty>
+    #        <gml:Point srsName="http://www.opengis.net/gml/srs/epsg.xml#4326">
+    #         <gml:coordinates>-113.467,53.55</gml:coordinates>
+    #        </gml:Point>
+    #       </gml:pointProperty>
+    #      </ipLocation>
+    #     </Hostip>
+    #    </gml:featureMember>
+    #   </HostipLookupResultSet>
+    
+    def hostip(ip)
+      url = "http://api.hostip.info/?ip=#{ip}"
+      uri = URI.parse(url)
+      xml = Net::HTTP.get_response(uri).body
+      location = REXML::Document.new(xml)
+      
+      data = {}
+      
+      hostip = XPath.first( location, "//Hostip" )
+      return nil if hostip.nil?
+      
+      hostip.elements.each do |element|
+        case element.name
+          when 'name'
+            data[:city] = element.text.split(', ')[0].titleize
+            data[:region] = element.text.split(', ')[1]
+          when 'countryAbbrev'
+            data[:country] = element.text
+        end
+      end
+      
+      coords = XPath.first( location, "//gml:Point" )
+      coords.elements.each do |element|
+        case element.name
+          when 'coordinates'
+            coordinates = element.text.split(',')
+            data[:latitude] = coordinates[1]
+            data[:longitude] = coordinates[0]
+        end
+      end
+      
+      data
+    end
+    
+  end
+end

data/lib/geo_location/variables.rb

@@ -0,0 +1,21 @@
+module GeoLocation
+  @@use = :hostip
+  @@key = ''
+  @@test = ''
+
+  [:use, :key, :test].each do |sym|
+    class_eval <<-EOS, __FILE__, __LINE__
+      def self.#{sym}
+        if defined?(#{sym.to_s.upcase})
+          #{sym.to_s.upcase}
+        else
+          @@#{sym}
+        end
+      end
+
+      def self.#{sym}=(obj)
+        @@#{sym} = obj
+      end
+    EOS
+  end
+end

data/lib/geo_location/version.rb

@@ -0,0 +1,3 @@
+module GeoLocation
+  VERSION = "0.1.2"
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'geo_location'
+
+class Test::Unit::TestCase
+end

data/test/test_geo_location.rb

@@ -0,0 +1,21 @@
+require 'helper'
+
+class TestGeoLocation < Test::Unit::TestCase
+  should "find CA country using hostip" do
+    GeoLocation::use = :hostip
+    ip = GeoLocation.find('142.59.52.238')
+    assert_equal ip[:country], 'CA'
+  end
+  
+  should "find NY region using hostip" do
+    GeoLocation::use = :hostip
+    ip = GeoLocation.find('24.24.24.24')
+    assert_equal ip[:region], 'NY'
+  end
+  
+  should "find Edmonton city using hostip" do
+    GeoLocation::use = :hostip
+    ip = GeoLocation.find('142.59.52.238')
+    assert_equal ip[:city], 'Edmonton'
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: geo_location
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 3
+  version: 0.1.3
+platform: ruby
+authors: 
+- Chris Your
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-24 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Geo-locate your users using their IP address via hostip.info or maxmind.com.
+email: chris@ignitionindustries.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- geo_location.gemspec
+- lib/geo_location.rb
+- lib/geo_location/geo_location.rb
+- lib/geo_location/variables.rb
+- lib/geo_location/version.rb
+- test/helper.rb
+- test/test_geo_location.rb
+has_rdoc: true
+homepage: http://github.com/chrisyour/geo_location
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Geo-locate your users using their IP address via hostip.info or maxmind.com.
+test_files: 
+- test/helper.rb
+- test/test_geo_location.rb