ipgeolocation 0.1.0

data/History.txt

@@ -0,0 +1,6 @@
+=== 0.1.0 / 2009-03-24
+
+* First release
+
+  * Supports 3 remote IP Geolocation services: blogama.org, netgeo, and iphost
+

data/Manifest.txt

@@ -0,0 +1,6 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/ipgeolocation.rb
+test/test_ipgeolocation.rb

data/README.txt

@@ -0,0 +1,62 @@
+= ipgeolocation
+
+* http://beforefilter.blogspot.com/
+
+== DESCRIPTION:
+
+Remote, IP-Based Geolocation for everyone!
+
+Seriously, this gem gives you 3 different IP-location services as
+1-liners. Example:
+
+    IPGeolocation.locate("12.345.678.90", :blogama)
+    
+That's all there is to it! And you get a bunch of information, especially
+from blogama's API.
+
+== FEATURES/PROBLEMS:
+
+* 3 supported IP-Location services
+* no local DB support - this will come in the future once licensing issues
+  are determined
+
+== SYNOPSIS:
+
+    IPGeolocation.locate("74.125.45.100", :blogama)
+  
+gives
+  
+    #<struct IPGeolocation::Location ip="74.125.45.100", country_code="US", country_name="United States", region_code="CA", region_name=nil, city="Mountain View", postal_code="94043", latitude="37.4192", longitude="-122.057">
+
+== REQUIREMENTS:
+
+* nothing!
+
+== INSTALL:
+
+* sudo gem install ipgeolocation
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Michael J. Edgar
+
+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/Rakefile

@@ -0,0 +1,76 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/ipgeolocation.rb'
+
+Hoe.new('ipgeolocation', IPGeolocation::VERSION) do |p|
+  # p.rubyforge_name = 'ipgeolocationx' # if different than lowercase project name
+  p.developer('Michael J. Edgar', 'edgar@triqweb.com')
+  p.remote_rdoc_dir = ''
+  
+  desc 'Post your blog announcement to blogger.'
+  task :post_blogger do
+    require 'net/http'
+    require 'net/https'
+    p.with_config do |config, path|
+      break unless config['blogs']
+      subject, title, body, urls = p.announcement
+      #body += "\n\n#{urls}"
+      
+      config['blogs'].each do |site|
+        next unless site['url'] =~ /www\.blogger\.com/
+        google_email = site['user']
+        google_passwd = site['password']
+        source = 'beforefilter.blogspot.com-rubypost'
+
+        http = Net::HTTP.new('www.google.com', 443)
+        http.use_ssl = true
+        login_url = '/accounts/ClientLogin'
+
+        # Setup HTTPS request post data to obtain authentication token.
+        data = 'Email=' + google_email +'&Passwd=' + google_passwd + '&source=' + source + '&service=blogger'
+        headers = {
+          'Content-Type' => 'application/x-www-form-urlencoded'
+        }
+
+        # Submit HTTPS post request
+        resp, data = http.post(login_url, data, headers)
+
+        unless resp.code.eql? '200' 
+          puts "Error during authentication, blog at #{site['url']}, ##{site['blog_id']}: #{resp.message}\n"
+        else 
+
+          # Parse for the authentication token.
+          authToken = data.split("\n").map {|l| l.split("=")}.assoc("Auth")[1]
+
+          headers = {
+            'Authorization' => 'GoogleLogin auth=' + authToken,
+            'Content-Type' => 'application/atom+xml'
+          }
+
+          data = <<-EOF
+          <entry xmlns='http://www.w3.org/2005/Atom'>
+            <title type='text'>#{title}</title>
+            <content type='xhtml'>
+              <div xmlns="http://www.w3.org/1999/xhtml">
+                #{body}
+              </div>
+            </content>
+            #{p.blog_categories.inject("") {|acc,cat| acc + "<category scheme=\"http://www.blogger.com/atom/ns#\" term=\"#{cat}\" />\n"}}
+          </entry>
+          EOF
+          
+          http = Net::HTTP.new('www.blogger.com')
+          path = '/feeds/' + site['blog_id'] + '/posts/default'
+
+          resp, data = http.post(path, data, headers)
+          puts "Error while posting, blog at #{site['url']}, ##{site['blog_id']}: #{resp.message}" unless resp.code == 200
+          # Expect resp.code == 200 and resp.message == 'OK' for a successful.
+        end
+      end
+    end
+  end
+end
+
+# vim: syntax=Ruby

data/lib/ipgeolocation.rb

@@ -0,0 +1,118 @@
+require 'rexml/document'
+require 'open-uri'
+require 'net/http'
+# = IPGeolocation
+#
+# This library enables IP-Location lookups via remote services.
+# Simply call:
+#    IPGeolocation.locate("12.345.678.90", :blogama) # OR
+#    IPGeolocation.locate("12.345.678.90", :netgeo) # OR
+#    IPGeolocation.locate("12.345.678.90", :hostip)
+#
+# and you will be given a struct with a bunch of nifty information!
+# to its credit, blogama seems to be very, very accurate.
+#
+module IPGeolocation
+  VERSION = '0.1.0'
+  
+  ACCEPTABLE_LOCATORS = [:blogama, :netgeo, :hostip]
+  
+  # Fields you can get from the different services
+  RESULT_FIELDS = [:ip, :country_code, :country_name, :region_code, :region_name,
+                   :city, :postal_code, :latitude, :longitude]
+  
+  # Main Location thread. You must choose from one of the available
+  # location services. In future versions this will support a local database.
+  #
+  # Available locators:
+  #    [:blogama] The Blogama IP database - highly accurate
+  #    [:netgeo] Netgeo, a legacy IP geolocation service. Doesn't offer zip-codes.
+  #    [:hostip] Hostip.info - this is a newer location service, but coverage is somewhat spotty.
+  #
+  # Usage:
+  #    IPgeolocation.locate("12.345.678.90", :blogama)
+  #
+  def locate(ip, locator)
+    raise ArgumentError.new("Invalid locator: #{locator}") unless ACCEPTABLE_LOCATORS.include?(locator)
+    klass = case locator
+            when :blogama
+              IPGeolocation::BlogamaLocator
+            when :netgeo
+              IPGeolocation::NetGeoLocator
+            when :hostip
+              IPGeolocation::HostIPLocator
+            end
+      
+    klass.locate(ip)
+  end
+  module_function :locate
+  
+  # Location interface for hostip.info. Doesn't need to be used directly.
+  class HostIPLocator
+    HOST_IP_QUERY_URL = "http://api.hostip.info/?"
+    
+    def self.locate ip
+      doc = REXML::Document.new(open(IPGeolocation::HostIPLocator::HOST_IP_QUERY_URL+"ip=#{ip}"))
+
+      result = IPGeolocation::Location.new
+      result.ip = ip
+      result.country_code = REXML::XPath.first( doc, "//countryAbbrev" ).text.strip
+      result.country_name = REXML::XPath.first( doc, "//countryName" ).text.strip
+      result.region_code = REXML::XPath.first( doc, "//gml:name" ).text.split(",").last.strip
+      result.city = REXML::XPath.first( doc, "//gml:name" ).text.split(",").first.strip
+      
+      coords = REXML::XPath.first( doc, "//gml:coordinates" )
+      if coords
+        result.latitude = coords.text.split(",").last.strip
+        result.longitude = coords.text.split(",").first.strip
+      end
+      result
+    end
+  end
+  
+  # Location interface for netgeo.caida.org. Doesn't need to be used directly.
+  class NetGeoLocator
+    
+    def self.locate ip
+      resp = Net::HTTP.new("netgeo.caida.org").get("/perl/netgeo.cgi?target=#{ip}")
+      result = IPGeolocation::Location.new
+      fakehash = resp.body.gsub(/<\/?[^>]*>/, "").split("\n").map {|a| a.split ":"}
+      
+      result.ip = fakehash.assoc("TARGET")[1].strip
+      result.city = fakehash.assoc("CITY")[1].strip
+      result.region_name = fakehash.assoc("STATE")[1].strip
+      result.country_code = fakehash.assoc("COUNTRY")[1].strip
+      result.latitude = fakehash.assoc("LAT")[1].strip
+      result.longitude = fakehash.assoc("LONG")[1].strip
+      result
+    end
+  end
+  
+  # Location interface for blogama.org. Doesn't need to be used directly.
+  class BlogamaLocator
+    BLOGAMA_QUERY_URL = "http://blogama.org/ip_query.php?"
+    
+    def self.locate ip
+      doc = REXML::Document.new(open(IPGeolocation::BlogamaLocator::BLOGAMA_QUERY_URL+"ip=#{ip}&output=xml"))
+
+      root = doc.root
+      puts root
+      result = IPGeolocation::Location.new
+      result.ip = root.elements["Ip"].text
+      result.country_code = root.elements["CountryCode"].text
+      result.country_name = root.elements["CountryName"].text
+      result.region_code = root.elements["RegionCode"].text
+      result.region_name = root.elements["RegionName"].text
+      result.city = root.elements["City"].text
+      result.postal_code = root.elements["ZipPostalCode"].text
+      result.latitude = root.elements["Latitude"].text
+      result.longitude = root.elements["Longitude"].text
+
+      result
+    end
+  end
+  
+  # Struct for holding all relevant info from GeoLocation services
+  class Location < Struct.new(*IPGeolocation::RESULT_FIELDS)
+  end
+end

data/test/test_ipgeolocation.rb

@@ -0,0 +1,8 @@
+require "test/unit"
+require "ipgeolocation"
+
+class TestIpgeolocation < Test::Unit::TestCase
+  def test_sanity
+    flunk "write tests or I will kneecap you"
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: ipgeolocation
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Michael J. Edgar
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-25 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.11.0
+    version: 
+description: "Remote, IP-Based Geolocation for everyone!  Seriously, this gem gives you 3 different IP-location services as 1-liners. Example:  IPGeolocation.locate(\"12.345.678.90\", :blogama)  That's all there is to it! And you get a bunch of information, especially from blogama's API."
+email: 
+- edgar@triqweb.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/ipgeolocation.rb
+- test/test_ipgeolocation.rb
+has_rdoc: true
+homepage: http://beforefilter.blogspot.com/
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: ipgeolocation
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Remote, IP-Based Geolocation for everyone!  Seriously, this gem gives you 3 different IP-location services as 1-liners
+test_files: 
+- test/test_ipgeolocation.rb