hostip 0.1.0 → 0.2.0

data/README.rdoc

@@ -1,7 +1,7 @@
 == 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'
@@ -51,4 +51,4 @@ 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.
+or implied, of Philipp Fehre.

data/Rakefile

@@ -7,12 +7,12 @@ require 'rubygems/specification'
  
 spec = Gem::Specification.new do |s|
   s.name = "hostip"
-  s.version = "0.1.0"
+  s.version = "0.2.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.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
@@ -20,8 +20,10 @@ spec = Gem::Specification.new do |s|
   
   s.require_path = 'lib'
   s.autorequire = 'hostip'
-  s.files = %w(README.rdoc Rakefile) + Dir.glob("{lib,tests}/*")
+  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

data/bin/hostip

@@ -0,0 +1,191 @@
+#!/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'
+require 'ostruct'
+require 'date'
+require '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
+
+end
+
+
+
+# Create and run the application
+app = App.new(ARGV)
+app.run
+

data/lib/hostip.rb

@@ -66,4 +66,4 @@ class Hostip
     
   end
   
-end
+end

data/tests/tc_hostip.rb

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 
+require "test_helper"
 require "test/unit"
 require "hostip"
 require "ipaddr"
@@ -32,5 +33,5 @@ class HostipTest < Test::Unit::TestCase
   def test_geo_location
     assert_equal(@hip.geo_location("66.102.13.103"), {"lat"=>"37.402", "long"=>"-122.078"})
   end
-  
-end
+
+end

data/tests/tc_hostipbin.rb

@@ -0,0 +1,48 @@
+#!/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/test_helper.rb

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+$LOAD_PATH << File.expand_path( File.dirname(__FILE__) + '/../lib' )
+$LOAD_PATH << File.expand_path( File.dirname(__FILE__) + '/../bin' )
+

data/tests/ts_alltests.rb

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

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Philipp Fehre
@@ -14,7 +14,7 @@ autorequire: hostip
 bindir: bin
 cert_chain: []
 
-date: 2010-03-16 00:00:00 +01:00
+date: 2010-04-01 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -31,8 +31,8 @@ dependencies:
   version_requirements: *id001
 description: A simple Ruby wrapper for hostip.info
 email: philipp.fehre@googlemail.com
-executables: []
-
+executables: 
+- hostip
 extensions: []
 
 extra_rdoc_files: 
@@ -42,6 +42,10 @@ files:
 - Rakefile
 - lib/hostip.rb
 - tests/tc_hostip.rb
+- tests/tc_hostipbin.rb
+- tests/test_helper.rb
+- tests/ts_alltests.rb
+- bin/hostip
 has_rdoc: true
 homepage: http://bitbucket.org/sideshowcoder/hostip-gem/
 licenses: []
@@ -71,6 +75,9 @@ 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
+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/test_helper.rb
+- tests/ts_alltests.rb