ipdb 1.0.0

data/.gitignore

@@ -0,0 +1,11 @@
+doc
+pkg
+tmp/*
+.DS_Store
+.yardoc
+*.db
+*.log
+*.swp
+*~
+*.gemspec
+*.gem

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2009-11-25
+ 
+* Initial release.
+  * Query IP addressses and domains for geographical information.
+  * Convenience methods for google maps integration.
+

data/README.rdoc

@@ -0,0 +1,95 @@
+= ipdb
+
+* Source: http://www.github.com/mephux/ipdb
+* Documentation: http://yardoc.com/docs/mephux-ipdb
+* My Website: http://www.packetport.net
+
+== DESCRIPTION:
+
+IpDB is a simple ruby interface to the ipinfodb IP geographical locator api.
+
+== INSTALL:
+
+  $ sudo gem install ipdb
+
+== SYNOPSIS:
+
+Using IpDB is super simple. Here are a few example of how one may use this gem.
+
+Look up my current external address:
+
+ ip = Ipdb::Query.new.parse
+ 
+ puts ip.address #=> '127.0.0.1'
+ 
+Get geographical information for a given address:
+  
+  ip = Ipdb::Query.new('173.45.230.150').parse
+  
+  puts ip.latitude      #=> 38.6446
+  puts ip.longitude     #=> -90.2533
+  puts ip.country       #=> United States
+  puts ip.region        #=> Missouri
+  puts ip.city          #=> Saint Louis
+  
+Return the hostname & city for each address and/or domain in an array.
+
+ ips = ['127.0.0.1', 'snorby.org', '64.13.134.52']
+ 
+ Ipdb::Query.new(ips, :timeout => 1).each do |ip|
+  puts ip.hostname
+  puts ip.city
+ end
+ 
+Render a google map from an array of IP addresses:
+
+ map = Ipdb::Map.new(ip_array, :width => 600, :height => 350, :units => :px)
+ map.render
+ 
+Thats It! Below is a screenshot of its output:
+
+http://snorby.org/images/ipdb.png
+
+Nice! If you zoom out some you get this:
+
+http://snorby.org/images/ipdb2.png
+
+== FEATURES/PROBLEMS:
+
+* IP/Domain geographical location
+* Look up multiple addresses at once.
+* Convenience Methods for Google Maps
+* No API usage limit.
+* Timezone data is from Geonames. Please refer to Geonames.org for more info about timezones.
+
+* A max of 25 addresses can be parsed during a single query.
+* There is a one second pause when querying domain names.
+
+== REQUIREMENTS:
+
+* nokogiri http://nokogiri.rubyforge.org >= 1.4.0
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Dustin Willis Webber
+
+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,25 @@
+require 'rubygems'
+require 'rake'
+
+require './tasks/spec.rb'
+require './tasks/yard.rb'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ipdb"
+    gem.summary = "ipdb is a simple IP geographical locator."
+    gem.description = "ipdb is a ruby interface to the ipinfodb IP geographical locator api."
+    gem.email = "dustin.webber@gmail.com"
+    gem.homepage = "http://github.com/mephux/ipdb"
+    gem.authors = ["Dustin Willis Webber"]
+    gem.add_dependency "nokogiri", ">= 1.4.0"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">=0.2.3.5"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+# vim: syntax=ruby

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/init.rb

@@ -0,0 +1 @@
+require 'ipdb'

data/lib/ipdb.rb

@@ -0,0 +1 @@
+require 'ipdb/query'

data/lib/ipdb/location.rb

@@ -0,0 +1,191 @@
+require 'ipdb/map'
+require 'resolv'
+
+module Ipdb
+  class Location
+    # Location
+    attr_reader :location
+    
+    #
+    # Creates a new Location object.
+    #
+    # @param [Nokogiri::XML::Node] node
+    #   The XML node that contains the location information.
+    #
+    # @yield [location]
+    #   If a block is given, it will be passed the newly created Location
+    #   object.
+    #
+    # @param [String] timeout
+    #   The timeout for the location object.
+    #
+    def initialize(location, timeout=10)
+      @xml = location
+      @timeout = timeout
+    end
+
+    #
+    # Return the Location address.
+    #
+    # @return [String] address
+    #
+    def address
+      @address = @xml.at('Ip').inner_text
+    end
+
+    #
+    # Return the Location status.
+    #
+    # @return [String] status
+    #
+    def status
+      @status = @xml.at('Status').inner_text
+    end
+
+    #
+    # Return the Location hostname.
+    #
+    # @return [String] hostname
+    #
+    def hostname
+      Timeout::timeout(@timeout) do
+        @hostname = Resolv.getname(address)
+      end
+    rescue Timeout::Error
+    rescue
+    end
+
+    #
+    # Return the Location Country Coce.
+    #
+    # @return [String] country_code
+    #
+    def country_code
+      @country_code = @xml.at('CountryCode').inner_text
+    end
+
+    #
+    # Return the Location Country.
+    #
+    # @return [String] country
+    #
+    def country
+      @country_name = @xml.at('CountryName').inner_text
+    end
+
+    #
+    # Return the Location Region Code.
+    #
+    # @return [String] region_code
+    #
+    def region_code
+      @region_code = @xml.at('RegionCode').inner_text
+    end
+
+    #
+    # Return the Location Region.
+    #
+    # @return [String] region
+    #
+    def region
+      @region_name = @xml.at('RegionName').inner_text
+    end
+
+    #
+    # Return the Location City.
+    #
+    # @return [String] city
+    #
+    def city
+      @city = @xml.at('City').inner_text
+    end
+    
+    #
+    # Return the Location Zip Code.
+    #
+    # @return [Integer] zip_code
+    #
+    # @see Location#zipcode
+    #
+    def zip_code
+      @zip_code = @xml.at('ZipPostalCode').inner_text.to_i
+    end
+    alias zipcode zip_code
+
+    #
+    # Return the Location Latitude.
+    #
+    # @return [Float] latitude
+    #
+    def latitude
+      @latitude = @xml.at('Latitude').inner_text.to_f
+    end
+    
+    #
+    # Return the Location Longitude.
+    #
+    # @return [Float] longitude
+    #
+    def longitude
+      @longitude = @xml.at('Longitude').inner_text.to_f
+    end
+
+    #
+    # Return the Location Time Zone Offset.
+    #
+    # @return [Integer] time_zone
+    #
+    # @see http://www.geonames.org/
+    # @see Location#timezone
+    #
+    def time_zone
+      @timezone = @xml.at('Timezone').inner_text.to_i
+    end
+    alias timezone time_zone
+
+    #
+    # Return the Location GMT Offset. 
+    # The gmtOffset/dstOffset fields names are a little misleading => gmtOffset: offset to GMT at 1st January.
+    #
+    # @return [Integer] gmt_offset
+    #
+    # @see http://www.geonames.org/
+    #
+    def gmt_offset
+      @gmt_offset = @xml.at('Gmtoffset').inner_text.to_i
+    end
+
+    #
+    # Return the Location DST Offset. 
+    # The gmtOffset/dstOffset fields names are a little misleading => dstOffset: offset to GMT at 1st July.
+    #
+    # @return [Integer] dst_offset
+    #
+    # @see http://www.geonames.org/
+    #
+    def dst_offset
+      @dst_offset = @xml.at('Dstoffset').inner_text.to_i
+    end
+
+    #
+    # Return the Location Current Time.
+    #
+    # @return [DateTime] current_time
+    #
+    # @todo Make this method work correctly! =]
+    #
+    def current_time
+      (Time.now + timezone)
+    end
+    
+    #
+    # Return the Location as a string
+    #
+    # @return [String] location
+    #
+    def to_s
+      "#{address} #{hostname} #{country} #{region} #{city}"
+    end
+
+  end
+end

data/lib/ipdb/map.rb

@@ -0,0 +1,136 @@
+require 'ipdb/location'
+module Ipdb
+
+  class Map
+
+    #
+    # Creates a new Map object.
+    #
+    # @param [Array] addresses/domians
+    #   An array of addresses or domains.
+    #
+    # @param [Hash] options The options to create a Map with.
+    #
+    # @option options [Integer] :timeout ('10') The Timeout.
+    # @option options [Symbol] :units (':px') The units for width and height.
+    # @option options [Integer] :width ('600') The width of the Map.
+    # @option options [Integer] :height ('350') The height of the Map.
+    # @option options [Integer] :zoom ('10') The zoom of the Map.
+    # @option options [String] :div_id ('map_canvas') The div id of the Map container.
+    # @option options [String] :div_class ('ipdb') The div class of the Map container.
+    #
+    # @return [MAP] map The newly created Map Object.
+    #
+    # @example
+    #   Ipdb::Map.new(@ips, :zoom => 1, :width => 100, :height => 100, :units => :%)
+    def initialize(addr=nil, options={})
+      @timeout = options[:timeout] || 10
+      @units = (options[:units] || :px).to_sym
+      @width = options[:width] || 600
+      @height = options[:height] || 350
+      @zoom = options[:zoom] || 10
+      @div_id = options[:div_id] || 'map_canvas'
+      @div_class = options[:div_class] || 'ipdb'
+
+      ip = [addr].flatten
+      @url = "#{SCRIPT}?ip=#{URI.escape(ip.join(','))}"
+      @xml = Nokogiri::XML.parse(open(@url)).xpath('//Location')
+    end
+    
+    #
+    # Return a Google Map for a Query Object
+    #
+    # @return [String<HTML, JavaScript>] map The Google Map html and JavaScript.
+    #
+    def render
+      @map = ""; @id = 0
+      @xml.each do |x|
+        location = Location.new(x, @timeout)
+        id = "ip_#{@id += 1}_id"
+        @start = new_location(location.latitude, location.longitude) if @id == 1
+        @map += add_marker(id, location.address, location.latitude, location.longitude)
+        @map += add_window(id, location.address, location.city, location.country)
+        @map += add_listener(id)
+      end
+      build_map(@start, @map)
+    end
+    
+    private
+    
+    #
+    # Build the Google maps options hash.
+    #
+    # @private
+    #
+    def build_options(start)
+      "var myOptions = {zoom: #{@zoom},center: #{start},mapTypeId: google.maps.MapTypeId.ROADMAP};var map = new google.maps.Map(document.getElementById('#{@div_id}'), myOptions);"
+    end
+
+    #
+    # Build a new Google Map Location object.
+    #
+    # @param [Float] latitude The new location objects latitude.
+    # @param [Float] longitude The new location objects longitude.
+    #
+    # @private
+    #
+    def new_location(latitude,longitude)
+      "new google.maps.LatLng(#{latitude}, #{longitude})"
+    end
+
+    #
+    # Build a Google Map marker for the Location.
+    #
+    # @param [String] id The Location id.
+    # @param [String] address The Location address.
+    # @param [Float] latitude The new location objects latitude.
+    # @param [Float] longitude The new location objects longitude.
+    #
+    # @private
+    #
+    def add_marker(id,address,latitude,longitude)
+      "var marker_#{id} = new google.maps.Marker({position: new google.maps.LatLng(#{latitude}, #{longitude}), map: map, title: '#{address}'});"
+    end
+    
+    #
+    # Build a Google Map Window for the Location.
+    #
+    # @param [String] id The Location id.
+    # @param [String] address The Location address.
+    # @param [String] city The location city.
+    # @param [String] country The location country.
+    #
+    # @private
+    #
+    def add_window(id, address, city, country)
+      "var infowindow_#{id} = new google.maps.InfoWindow({content: 'IP Address: #{address}<br />#{city}, #{country}'});"
+    end
+
+    #
+    # Build a Google map Listener to watch for marker clicks.
+    #
+    # @param [String] id The Location id.
+    #
+    def add_listener(id)
+      "google.maps.event.addListener(marker_#{id}, 'click', function() {infowindow_#{id}.open(map,marker_#{id});});"
+    end
+
+    #
+    # Build The Google Map.
+    #
+    # @param [String] start A Google Map Location object to use as a starting point.
+    # @param [String] data The Google Map js built from the Location object.
+    #
+    # @private
+    #
+    def build_map(start, data)
+      return <<-EOF
+<script type="text/javascript" src="http://www.google.com/jsapi?autoload=%7Bmodules%3A%5B%7Bname%3A%22maps%22%2Cversion%3A3%2Cother_params%3A%22sensor%3Dfalse%22%7D%5D%7D"></script>
+<script type="text/javascript">function ipdb() {#{build_options(start)}#{data}};google.setOnLoadCallback(ipdb);</script>
+<div id="#{@div_id}" class="#{@div_class}" style="width: #{@width}#{@units}; height: #{@height}#{@units}"></div>
+      EOF
+    end
+
+  end
+  
+end

data/lib/ipdb/query.rb

@@ -0,0 +1,123 @@
+require 'ipdb/location'
+require 'nokogiri'
+require 'open-uri'
+require 'enumerator'
+require 'uri'
+
+module Ipdb
+  
+  #
+  # The IPinfoDB url
+  #
+  # @example http://ipinfodb.com/ip_query.php?ip=127.0.0.1&output=json
+  #
+  SCRIPT = 'http://ipinfodb.com/ip_query2.php'
+
+  class Query
+    include Enumerable
+
+    #
+    # Creates a new Query object.
+    #
+    # @param [Array] addresses/domians
+    #   An array of addresses or domains.
+    #
+    # @param [Hash<Options>]
+    #   Options for the new Query Object.
+    #
+    # @option opts [Integer] :timeout The Timeout. (Default: 10)
+    #
+    def initialize(addr=nil, options={})
+      @timeout = options[:timeout]
+
+      ip = [addr].flatten
+      @url = "#{SCRIPT}?ip=#{URI.escape(ip.join(','))}"
+      @xml = Nokogiri::XML.parse(open(@url))
+    end
+
+    #
+    # Process The Query Object And Return A Location Object
+    #
+    # @return [Location]
+    #   The Location object returned from the Query.
+    #
+    def parse
+      Location.new(@xml.xpath('//Location'), @timeout)
+    end
+
+    #
+    # Parses the Locations from the Query.
+    #
+    # @yield [Query]
+    #   Each query will be passed to a given block.
+    #
+    # @yieldparam [Location] location
+    #   A location from the query.
+    #
+    # @return [XML]
+    #   The XML object.
+    #
+    def each(&block)
+      @xml.xpath('//Location').each do |location|
+        block.call(Location.new(location, @timeout)) if block
+      end
+    end
+
+    #
+    # Return the url of the Query
+    #
+    # @return [String] url
+    #
+    def url
+      @url
+    end
+
+    #
+    # Return the Query object in json format.
+    #
+    # @return [Query] json
+    #
+    def to_json
+      json = "#{@url}&output=json"
+      @doc = Nokogiri::HTML(open(json))
+      return @doc.xpath('//body/.').inner_text
+    end
+
+    #
+    # Return the Query in XML format.
+    #
+    # @return [Query] xml
+    #
+    def to_s
+      @xml
+    end
+
+    alias to_xml to_s
+    alias all to_a
+    
+    #
+    # Return a map url of addresses from the Query
+    #
+    # @return [String] url
+    #
+    def simple_map_url
+      @country_codes = []
+      @data = []
+      Enumerator.new(self,:each).to_a.collect {|x| @country_codes << x.country_code }
+      @country_codes = @country_codes.uniq
+      1.upto(@country_codes.size) { |x| @data << '0' }
+      url = "http://chart.apis.google.com/chart?cht=t&chs=440x220&chd=t:#{@data.join(',')}&chco=FFFFFF,4A4A4A,EBEBEB&chld=#{@country_codes}&chtm=world&chf=bg,s,EAF7FE"
+      return url
+    end
+    
+    #
+    # Convenient Method to render the map url as an image in Rails.
+    #
+    # @return [String] image
+    #
+    def simple_map_image
+      "image_path(#{simple_map_url})"
+    end
+
+  end
+end

data/spec/ipdb_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+ 
+describe 'Ipdb' do
+  it "should have a SCRIPT constant" do
+    Ipdb.const_defined?('SCRIPT').should == true
+  end
+end

data/spec/location_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe "Location" do
+
+  before(:all) do
+    @ip = Ipdb::Query.new('64.13.134.52').parse
+  end
+
+  it "should return the Location hostname" do
+    @ip.hostname.should == 'scanme.nmap.org'
+  end
+  
+  it "should return the Location ip address" do
+    @ip.address.should == '64.13.134.52'
+  end
+  
+  it "should return the Location Country" do
+    @ip.country.should == 'United States'
+  end
+  
+  it "should return the Location Region" do
+    @ip.region.should == 'California'
+  end
+
+  it "should return the Location City" do
+    @ip.city.should == 'Sunnyvale'
+  end
+  
+  it "should return the Location Status" do
+    @ip.status.should == 'OK'
+  end
+
+end

data/spec/query_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe "Query" do
+
+  before(:all) do
+    @query = Ipdb::Query.new('64.13.134.52')
+  end
+
+  it "should return the Query url" do
+    @query.url.should == 'http://ipinfodb.com/ip_query2.php?ip=64.13.134.52'
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+gem 'rspec', '>=1.1.12'
+require 'spec'
+require 'spec/autorun'
+ 
+require "ipdb"

data/tasks/spec.rb

@@ -0,0 +1,10 @@
+require 'spec/rake/spectask'
+ 
+desc "Run all specifications"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.libs += ['lib', 'spec']
+  t.spec_opts = ['--colour', '--format', 'specdoc']
+end
+ 
+task :test => :spec
+task :default => :spec

data/tasks/yard.rb

@@ -0,0 +1,12 @@
+require 'yard'
+ 
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']
+  t.options = [
+    '--protected',
+    '--files', 'History.txt',
+    '--title', 'Ipdb'
+  ]
+end
+ 
+task :docs => :yard

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: ipdb
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Dustin Willis Webber
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-27 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.3.5
+    version: 
+description: ipdb is a ruby interface to the ipinfodb IP geographical locator api.
+email: dustin.webber@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- History.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- lib/ipdb.rb
+- lib/ipdb/location.rb
+- lib/ipdb/map.rb
+- lib/ipdb/query.rb
+- spec/ipdb_spec.rb
+- spec/location_spec.rb
+- spec/query_spec.rb
+- spec/spec_helper.rb
+- tasks/spec.rb
+- tasks/yard.rb
+has_rdoc: true
+homepage: http://github.com/mephux/ipdb
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: ipdb is a simple IP geographical locator.
+test_files: 
+- spec/ipdb_spec.rb
+- spec/location_spec.rb
+- spec/query_spec.rb
+- spec/spec_helper.rb