hostip 0.1.0

data/README.rdoc

@@ -0,0 +1,54 @@
+== hostip
+
+A simple Ruby Gem wrapper for hostip.info
+    
+== example
+  
+	require 'rubygems'
+	require 'hostip'
+
+	hip = Hostip.new
+	
+	# get current ip
+	hip.ip
+	
+	# get current country
+	hip.country_name
+	# get country abbriviated
+	hip.country_abbrev
+	# get current geo location
+	hip.geo_location 
+	
+	# all this also works for a given ip like 74.125.77.104 (google.com)
+	hip.geo_location "74.125.77.104"
+	hip.country_name "74.125.77.104"
+
+== license 
+
+(the BSD license)
+
+Copyright 2010 Philipp Fehre. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are
+permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice, this list of
+      conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright notice, this list
+      of conditions and the following disclaimer in the documentation and/or other materials
+      provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY PHILIPP FEHRE ``AS IS'' AND ANY EXPRESS OR IMPLIED
+WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+The views and conclusions contained in the software and documentation are those of the
+authors and should not be interpreted as representing official policies, either expressed
+or implied, of Philipp Fehre.

data/Rakefile

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+require 'rubygems' unless ENV['NO_RUBYGEMS']
+require 'rake/gempackagetask'
+require 'rubygems/specification'
+
+ 
+spec = Gem::Specification.new do |s|
+  s.name = "hostip"
+  s.version = "0.1.0"
+  s.authors = ['Philipp Fehre']
+  s.email = "philipp.fehre@googlemail.com"
+  s.homepage = "http://bitbucket.org/sideshowcoder/hostip-gem/"
+  s.description = s.summary = "A simple Ruby wrapper for hostip.info"
+  s.summary = "Get geolocation, ip, country and city information for current or any other ip form hostip.info"
+  
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README.rdoc"]
+  
+  s.require_path = 'lib'
+  s.autorequire = 'hostip'
+  s.files = %w(README.rdoc Rakefile) + Dir.glob("{lib,tests}/*")
+  
+  s.test_files = Dir.glob('tests/*.rb')  
+  s.add_dependency('httparty')
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+    pkg.need_tar = true
+end
+
+task :default => "pkg/#{spec.name}-#{spec.version}.gem" do
+    puts "generated latest version"
+end

data/lib/hostip.rb

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+
+require "rubygems"
+require "httparty"
+
+class Hostip
+  include HTTParty
+  base_uri('api.hostip.info')
+  format :xml
+  
+  # get country name for ip, if no ip is passed use own ip
+  def country_name(ip=nil)
+      self.class.request(ip)["countryName"]
+  end
+
+  # get country abbreviation for ip, if no ip is passed use own ip  
+  def country_abbrev(ip=nil)
+    self.class.request(ip)["countryAbbrev"]
+  end
+  
+  # get city name for ip, if no ip is passed use own ip
+  def city(ip=nil)
+    self.class.request(ip)["gml:name"]
+  end
+  
+  # get current ip
+  def ip
+    self.class.request["ip"]
+  end
+  
+  # Returns a hash with 
+  # long => "xxxx" and lat => "xxx"
+  # or raise exception if location is unknown
+  def geo_location(ip=nil)
+    begin
+      # Get Comma seperated coordinates and return as hash
+      coordinates = self.class.request(ip, true)["ipLocation"]["gml:pointProperty"]["gml:Point"]["gml:coordinates"].split(',')
+      return { "long" => coordinates[0], "lat" => coordinates[1] }
+    rescue 
+      raise "geo location unknown"
+    end
+  end
+  
+  class << self
+    
+    # Make a request and strip unwanted XML before returning result
+    # options: 
+    # ip => xxx.xxx.xxx.xxx
+    # postion => true (Documented but does nothing!)
+    def request(ip=nil, position=false)
+      # construct params hash
+      params = {}
+      if ip != nil
+        params["ip"] = ip
+      end
+      if position
+        params["position"] = "true"
+      end
+      # sent request
+      if params == {}
+        self.get('/get_xml.php')["HostipLookupResultSet"]["gml:featureMember"]["Hostip"]
+      else
+        self.get('/get_xml.php', :query => params)["HostipLookupResultSet"]["gml:featureMember"]["Hostip"]
+      end
+    end
+    
+  end
+  
+end

data/tests/tc_hostip.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+require "test/unit"
+require "hostip"
+require "ipaddr"
+
+
+class HostipTest < Test::Unit::TestCase
+  
+  def setup
+    @hip = Hostip.new
+  end
+  
+  def test_ip
+    assert_nothing_raised() do
+      IPAddr.new(@hip.ip)
+    end
+  end
+  
+  def test_country_name
+    assert_equal(@hip.country_name("66.102.13.103"), "UNITED STATES")
+  end
+  
+  def test_country_abbrev
+    assert_equal(@hip.country_abbrev("66.102.13.103"), "US")
+  end
+  
+  def test_city
+    assert_equal(@hip.city("66.102.13.103"), "Mountain View, CA")
+  end
+  
+  def test_geo_location
+    assert_equal(@hip.geo_location("66.102.13.103"), {"lat"=>"37.402", "long"=>"-122.078"})
+  end
+  
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: hostip
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Philipp Fehre
+autorequire: hostip
+bindir: bin
+cert_chain: []
+
+date: 2010-03-16 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: A simple Ruby wrapper for hostip.info
+email: philipp.fehre@googlemail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- lib/hostip.rb
+- tests/tc_hostip.rb
+has_rdoc: true
+homepage: http://bitbucket.org/sideshowcoder/hostip-gem/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Get geolocation, ip, country and city information for current or any other ip form hostip.info
+test_files: 
+- tests/tc_hostip.rb