hostip 0.2.1 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e4401e8218709f87b556408950d6cd1128649866
+  data.tar.gz: 056c6d80a71cfc2fca77029adb1182b7578bd81f
+SHA512:
+  metadata.gz: 66c38885955adfdda6355a99665aabca561125fb446181011578be5836bf2b27f02948974fc2ed3f81a1db9b69b33b77bf77bde097e5629255ee1c1ffeefed50
+  data.tar.gz: ca1d9a61d195af272b29626c7cbc748e655149b4f3f41e59c707a1bfbac1cecb9fd29b2f95efbe03760c0128fe94abf068efe09d8b2b8024c65fc28c3237367e

data/{README.rdoc → README.md}

@@ -1,33 +1,52 @@
-== hostip
+![Status](https://travis-ci.org/sideshowcoder/hostip-gem.png)
+
+# hostip
 
 A simple Ruby Gem wrapper for hostip.info
+
 Includes a command line tool hostip to get all information from the command line as well
-== 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 
+
+## example
+
+```ruby
+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"
+```
+
+## command line
+```shell
+$ hostip --help
+hostip version 0.2.0
+Usage: hostip [options]
+    -v, --version                    display version
+    -h, --help                       display help
+    -V, --verbose                    be more verbose
+        --city                       get the city only i.e. Munich
+        --geo                        get longtitude and latitude, i.e. 12.45, 12.23
+        --country                    get the country i.e. Germany
+        --country-abbrev             get the country abbreviation i.e. US
+```
+
+## license
 
 (the BSD license)
 
-Copyright 2010 Philipp Fehre. All rights reserved.
+Copyright 2013 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:

data/bin/hostip

@@ -1,191 +1,124 @@
-#!/usr/bin/env ruby 
-
-# == Synopsis 
-#	Get info from hostip.info service about current IP and Geo Location  
-#
-# == Examples
-#	Get ip
-#		hostip 
-#	Get city
-#		hostip --city
-#	Get longtitude and latitude
-#		hostip --geo
-#
-#	Also works for any given IP
-#	hostip --city 123.456.789.1	
-#
-# == Usage 
-#	hostip [options] [ip]
-#
-#	For help use: hostip -h
-#
-# == Options
-#	-h, --help		Displays help message
-#	-v, --version		Display version
-#	-V, --verbose		Be more verbose
-#	--city			Get city (Munich)
-#	--geo			Get longtitude and latitude (12.4567,12.2345)
-#	--country		Get country (ie Germany)
-#	--country-abbrev	Get country abbreviation (ie US)
-#
-# == Author
-#	Philipp Fehre (philipp.fehre@googlemail.com)
-#
-# == Copyright
-#	(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.
-#	
-
-
-require 'optparse' 
-require 'rdoc/usage'
+#!/usr/bin/env ruby
+
+require 'optparse'
 require 'ostruct'
 require 'date'
-require 'hostip'
+require_relative '../lib/hostip'
 require 'ipaddr'
 
 class App
-	VERSION = '0.2.0'
-  
-	attr_reader :options
-
-	def initialize(arguments)
-	    @arguments = arguments
-    
-	    # Set defaults
-	    @options = OpenStruct.new
-	    @options.verbose = false
-	    @options.city = false  
-	    @options.geo = false
-	    @options.country = false
-	    @options.abbrev = false
-	    @options.ip = nil 
-	  end
-
-	  # Parse options, check arguments, then process the command
-	  def run
-        
-	    if parsed_options? && arguments_valid? 
-      
-	      puts "Start at #{DateTime.now}\n\n" if @options.verbose
-      
-	      process_command
-      
-	      puts "\nFinished at #{DateTime.now}" if @options.verbose
-      
-	    else
-	      output_usage
-	    end
-      
-	  end
-  
-	  protected
-  
-	    def parsed_options?
-      
-	      # Specify options
-	      opts = OptionParser.new 
-
-	      opts.on('-v', '--version')	{ output_version ; exit 0 }
-	      opts.on('-h', '--help')		{ output_help }
-	      opts.on('-V', '--verbose')	{ @options.verbose = true }  
-	      opts.on('--city')			{ @options.city = true }
-	      opts.on('--geo')			{ @options.geo = true }
-	      opts.on('--country')		{ @options.country = true }
-	      opts.on('--country-abbrev')	{ @options.abbrev = true }
-
-	      opts.parse!(@arguments) rescue return false
-      
-	      process_options
-      
-	      true      
-	    end
-
-	    # Performs post-parse processing on options
-	    def process_options
-    
-	    end
-    
-	    # True if required arguments were provided
-	    def arguments_valid?
-		# Check if IP is passed and IP is a valid IP
-		begin 
-			if @arguments[0] && IPAddr.new(@arguments[0])
-				@options.ip = @arguments[0]
-				return true
-			end
-		rescue Exception
-			return false     
-		end
-		# No IP passed, also good!
-		true
-	    end
-    
-	    def output_help
-		output_version
-		RDoc::usage() #exits app
-	    end
-    
-	    def output_usage
-		RDoc::usage('usage') # gets usage from comments above and exit
-	    end
-    
-	    def output_version
-		puts "#{File.basename(__FILE__)} version #{VERSION}"
-	    end
-    
-	    def process_command
-		hostip = Hostip.new
-	
-		unless @options.ip
-			@options.ip = hostip.ip
-			puts @options.ip
-		end
-		if @options.city
-			puts hostip.city(@options.ip)
-		end
-		if @options.geo
-			puts "#{hostip.geo_location(@options.ip)["lat"]} #{hostip.geo_location(@options.ip)["long"]}" 
-		end
-		if @options.country
-			puts hostip.country_name(@options.ip)
-		end
-		if @options.abbrev
-			puts hostip.country_abbrev(@options.ip)
-		end
-
-	    end
+  VERSION = '0.2.0'
 
-end
+  attr_reader :options
+
+  def initialize(arguments)
+    @arguments = arguments
+
+    # Set defaults
+    @options = OpenStruct.new
+    @options.verbose = false
+    @options.city = false
+    @options.geo = false
+    @options.country = false
+    @options.abbrev = false
+    @options.ip = nil
+
+    @opts = OptionParser.new
+  end
+
+  # Parse options, check arguments, then process the command
+  def run
+
+    if parsed_options? && arguments_valid?
+
+      puts "Start at #{DateTime.now}\n\n" if @options.verbose
+
+      process_command
+
+      puts "\nFinished at #{DateTime.now}" if @options.verbose
+
+    else
+      output_usage
+    end
+
+  end
+
+  protected
 
+  def parsed_options?
+    @opts.on('-v', '--version', 'display version')	{ output_version ; exit 0 }
+    @opts.on('-h', '--help', 'display help')		{ output_help }
+    @opts.on('-V', '--verbose', 'be more verbose')	{ @options.verbose = true }
+    @opts.on('--city', 'get the city only i.e. Munich')			{ @options.city = true }
+    @opts.on('--geo', 'get longtitude and latitude, i.e. 12.45, 12.23')			{ @options.geo = true }
+    @opts.on('--country', 'get the country i.e. Germany')		{ @options.country = true }
+    @opts.on('--country-abbrev', 'get the country abbreviation i.e. US')	{ @options.abbrev = true }
 
+    @opts.parse!(@arguments) rescue return false
+
+    process_options
+
+    true
+  end
+
+  # Performs post-parse processing on options
+  def process_options
+
+  end
+
+  # True if required arguments were provided
+  def arguments_valid?
+    # Check if IP is passed and IP is a valid IP
+    begin
+      if @arguments[0] && IPAddr.new(@arguments[0])
+        @options.ip = @arguments[0]
+        return true
+      end
+    rescue Exception
+      return false
+    end
+    # No IP passed, also good!
+    true
+  end
+
+  def output_help
+    output_version
+    output_usage
+  end
+
+  def output_usage
+    puts @opts.help
+    exit 1
+  end
+
+  def output_version
+    puts "#{File.basename(__FILE__)} version #{VERSION}"
+  end
+
+  def process_command
+    hostip = Hostip.new
+
+    unless @options.ip
+      @options.ip = hostip.ip
+      puts @options.ip
+    end
+    if @options.city
+      puts hostip.city(@options.ip)
+    end
+    if @options.geo
+      puts "#{hostip.geo_location(@options.ip)["lat"]} #{hostip.geo_location(@options.ip)["long"]}"
+    end
+    if @options.country
+      puts hostip.country_name(@options.ip)
+    end
+    if @options.abbrev
+      puts hostip.country_abbrev(@options.ip)
+    end
+
+  end
+
+end
 
-# Create and run the application
 app = App.new(ARGV)
 app.run
 

data/lib/hostip.rb

@@ -1,50 +1,47 @@
-#!/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  
+  # 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"]
+    self.class.request(ip)["name"]
   end
-  
+
   # get current ip
   def ip
     self.class.request["ip"]
   end
-  
-  # Returns a hash with 
+
+  # 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(',')
+      coordinates = self.class.request(ip, true)["ipLocation"]["pointProperty"]["Point"]["coordinates"].split(',')
       return { "long" => coordinates[0], "lat" => coordinates[1] }
-    rescue 
+    rescue
       raise "geo location unknown"
     end
   end
-  
+
   class << self
-    
+
     # Make a request and strip unwanted XML before returning result
-    # options: 
+    # options:
     # ip => xxx.xxx.xxx.xxx
     # postion => true (Documented but does nothing!)
     def request(ip=nil, position=false)
@@ -58,12 +55,12 @@ class Hostip
       end
       # sent request
       if params == {}
-        self.get('/get_xml.php')["HostipLookupResultSet"]["gml:featureMember"]["Hostip"]
+        self.get('/get_xml.php')["HostipLookupResultSet"]["featureMember"]["Hostip"]
       else
-        self.get('/get_xml.php', :query => params)["HostipLookupResultSet"]["gml:featureMember"]["Hostip"]
+        self.get('/get_xml.php', :query => params)["HostipLookupResultSet"]["featureMember"]["Hostip"]
       end
     end
-    
+
   end
-  
+
 end

data/lib/version.rb

@@ -0,0 +1 @@
+HOSTIP_VERSION = "0.3.0"

data/tests/hostip_bin_test.rb

@@ -0,0 +1,40 @@
+require_relative "./test_helper"
+
+class HostipiBinTest < Minitest::Test
+
+	def setup
+		@hostipbin = File.expand_path("../bin/hostip", File.dirname(__FILE__))
+	end
+
+	def test_get_ip
+	  assert IPAddr.new(%x[ruby #{@hostipbin}].chomp)
+	end
+
+	def test_city
+		city = %x[ruby #{@hostipbin} --city 74.125.77.147].chomp
+		assert_equal "Mountain View, CA", city
+	end
+
+  def test_multiple
+    mult = %x[ruby #{@hostipbin} --geo --city --country 66.102.13.103].chomp
+    exp_res = "Mountain View, CA\n37.402 -122.078\nUNITED STATES"
+    assert_equal exp_res, mult
+  end
+
+  def test_country
+    country = %x[ruby #{@hostipbin} --country 74.125.77.147].chomp
+    assert_equal "UNITED STATES", country
+  end
+
+  def test_country_abbrev
+    abbrev = %x[ruby #{@hostipbin} --country-abbrev 74.125.77.147].chomp
+    assert_equal "US", abbrev
+  end
+
+  def test_geo_location
+    geo = %x[ruby #{@hostipbin} --geo 74.125.77.147].chomp
+    assert_equal "37.402 -122.078", geo
+  end
+
+end
+

data/tests/hostip_test.rb

@@ -0,0 +1,30 @@
+require_relative "./test_helper"
+require "ipaddr"
+
+class HostipTest < Minitest::Test
+
+  def setup
+    @hip = Hostip.new
+  end
+
+  def test_ip
+    assert IPAddr.new(@hip.ip)
+  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

data/tests/test_helper.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
-$LOAD_PATH << File.expand_path( File.dirname(__FILE__) + '/../lib' )
-$LOAD_PATH << File.expand_path( File.dirname(__FILE__) + '/../bin' )
+require "minitest/autorun"
+require_relative "../lib/hostip"
+require "ipaddr"
 

metadata

@@ -1,30 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: hostip
 version: !ruby/object:Gem::Version
-  version: 0.2.1
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Philipp Fehre
-autorequire: hostip
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-09 00:00:00.000000000 Z
+date: 2013-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: A simple Ruby wrapper for hostip.info
@@ -33,43 +58,41 @@ executables:
 - hostip
 extensions: []
 extra_rdoc_files:
-- README.rdoc
+- README.md
 files:
-- README.rdoc
-- Rakefile
+- README.md
 - lib/hostip.rb
-- tests/tc_hostip.rb
-- tests/tc_hostipbin.rb
+- lib/version.rb
+- tests/hostip_bin_test.rb
+- tests/hostip_test.rb
 - tests/test_helper.rb
-- tests/ts_alltests.rb
 - bin/hostip
 homepage: https://github.com/sideshowcoder/hostip-gem
-licenses: []
+licenses:
+- BSD
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.23
+rubyforge_project: hostip
+rubygems_version: 2.0.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Get geolocation, ip, country and city information for current or any other
   ip from hostip.info
 test_files:
-- tests/tc_hostip.rb
-- tests/tc_hostipbin.rb
+- tests/hostip_bin_test.rb
+- tests/hostip_test.rb
 - tests/test_helper.rb
-- tests/ts_alltests.rb

data/Rakefile

@@ -1,37 +0,0 @@
-#!/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.2.1"
-  s.authors = ['Philipp Fehre']
-  s.email = "philipp.fehre@googlemail.com"
-  s.homepage = "https://github.com/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 from 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,bin}/*")
-  
-  s.bindir = 'bin'
-  s.executables = ['hostip']
-  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/tests/tc_hostip.rb

@@ -1,37 +0,0 @@
-#!/usr/bin/env ruby
-
-require "test_helper"
-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

data/tests/tc_hostipbin.rb

@@ -1,48 +0,0 @@
-#!/usr/bin/env ruby
-
-require "test_helper"
-require "test/unit"
-require "hostip"
-require "ipaddr"
-
-
-class HostipiBinTest < Test::Unit::TestCase
-
-	def setup 
-		@hostipbin = "../bin/hostip"		
-	end
-
-	def test_get_ip
-		assert_nothing_raised() do
-			 IPAddr.new(%x[ruby ../bin/hostip].chomp)	
-		end
-	end
-
-	def test_city
-		city = %x[ruby ../bin/hostip --city 74.125.77.147].chomp
-		assert_equal(city, "Buren")
-	end
-
-	def test_multiple
-		mult = %x[ruby ../bin/hostip --geo --city --country 74.125.77.147].chomp
-		exp_res = "Buren\n51.9167 5.3333\nNETHERLANDS"
-		assert_equal(mult, exp_res)		
-	end
-
-	def test_country
-		country = %x[ruby ../bin/hostip --country 74.125.77.147].chomp
-		assert_equal(country, "NETHERLANDS")
-	end
-
-	def test_country_abbrev
-		abbrev = %x[ruby ../bin/hostip --country-abbrev 74.125.77.147].chomp
-		assert_equal(abbrev, "NL")
-	end
-
-	def test_geo_location
-		geo = %x[ruby ../bin/hostip --geo 74.125.77.147].chomp
-		assert_equal(geo, "51.9167 5.3333")
-	end
-
-end
-

data/tests/ts_alltests.rb

@@ -1,4 +0,0 @@
-#!/usr/bin/env ruby
-require "test/unit"
-require "tc_hostip"
-require "tc_hostipbin"