whereisthis 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06b23ce989679b47017d3bd80a1e5ce0b76ec038
-  data.tar.gz: f7a8b9ac2780d7f2459e97b964bf0bb1eb7d2a1c
+  metadata.gz: c82ef687409c12636a29e52813bafd64d0d02da8
+  data.tar.gz: 4cb44b41ad65db1f057e2451c104e6ce0ed053a4
 SHA512:
-  metadata.gz: f58141b4fb3a07101c55d8c7ccc7e1217107259191db3a6f37556f0c27364781908bea564089f6f793ef257e30f1ce8d85de23bc82cbe8c53e96f6d119206241
-  data.tar.gz: 2317120bb28439c19f833956515f65463e1541d4d2a0ca101e205ec6e1e0e64b3e605e23871f6ecdc2020c70a798d95b516d6445fe590f92ad936303a4e5374b
+  metadata.gz: bdb6617c56369e350613c11d5ab73b57a8b3258b0725c5a65503006021fe6ea602a492945e0ca435faea0cb1105bce7b8e1ea09572f597dad8692b8511a82454
+  data.tar.gz: b64303c8cb62f00a3131324ebea04bed9d07e024ae9219e52c9a66ed25f17e5ab5f731bc0e110e201235bc269d3694e32bc6cd71a23e6a0d010da65700decc75

data/lib/whereisthis.rb

@@ -1,4 +1,14 @@
-require 'pry'
+#!/usr/bin/env ruby
+#
+# Whereisthis
+#
+# This is a simple command-line application to help determine 
+# the location information from a given ip address or url.
+#
+# Author::    Kent 'picat' Gruber
+# Copyright:: Copyright (c) 2016 Kent Gruber
+# License::   MIT
+
 require 'socket'
 require 'colorize'
 require 'ipaddress'
@@ -6,12 +16,26 @@ require 'trollop'
 require 'unirest'
 
 module Whereisthis
-  VERSION = "1.2.0"
+  
+  # Specify version number.
+  VERSION = "1.3.0"
 
+  # .findout! is the main workhorse of this application. It starts
+  # the option parsing; and performs the main logic for basically
+  # everything.
+  #
+  # == Example
+  #
+  #  # Typical use:
+  #  require 'whereisthis'
+  #  ARGV[0] = "8.8.8.8"
+  #  Whereisthis.findout! 
+  # 
   def self.findout!
-    # Default to a help menu
+    # Default to a help menu if no argument is given.
     foo = ARGV[0] || ARGV[0] = '-h'
-
+    
+    # Parse options into a hash.
     opts = Trollop::options do
       banner "whereisthis?".bold.red + " Find out where that ip or website is.".bold
       version "#{Whereisthis::VERSION}"
@@ -25,12 +49,14 @@ module Whereisthis
       opt :ip,       "Specify the ip address to lookup",  :type => :string
       opt :website,  "Specify the website url to lookup", :type => :string
     end
-
+    
+    # If an ip is specified with -i or --ip at the command-line.
     if opts.ip
       unless IPAddress.valid? opts.ip
         puts "Unable to verify '#{opts.ip}' is a valid ip address."
         exit 1
       end
+    # If an website is specified with -w or --website at the command-line.
     elsif opts.website
       begin
         opts[:ip] = IPSocket::getaddress(opts.website)
@@ -38,6 +64,7 @@ module Whereisthis
         puts "Unable to resolve #{opts.website} to an ip address. Is it legit?"
         exit 1
       end
+    # If the first argument is simply an IP address or website.
     elsif ARGV[0]
       if IPAddress.valid? ARGV[0]
         opts[:ip] = ARGV[0]
@@ -51,17 +78,13 @@ module Whereisthis
       end
     end
 
-    unless opts.ip or opts.website
-      puts "Need to specify an ip address or website to figure out what it is!"
-      exit 1
-    end
-
+    # A container of data for our information.
     Struct.new("WhereIsInfo", :ip, :hostname, :city, :region, :country, :gps, :org, :postal )
 
     # Get response from web service.
     data = Unirest.get('http://ipinfo.io/' + opts.ip).body
     # Change empty values to false.
-    data.each { |k,v| v.empty? ? data[k] = false : data[k] = v  }
+    data.each { |k,v| v.nil? || v.empty? ? data[k] = false : data[k] = v  }
 
     whereisinfo = Struct::WhereIsInfo.new
 
@@ -75,12 +98,13 @@ module Whereisthis
     whereisinfo.org      = data["org"]      || "Not found."
     whereisinfo.postal   = data["postal"]   || "Not found."
 
-    # keep track of the filters & delete the given givens
+    # Keep track of the filters & delete the given givens,
+    # because we don't need to keep track of them.
     filter = Hash[opts.keys.keep_if { |k| k.to_s =~ /_given\b/ } .collect { |i| [i, true] } ]
     filter.delete_if { |k,v| k.to_s == "ip_given" }
     filter.delete_if { |k,v| k.to_s == "website_given" }
 
-    # manage output
+    # Manage output with or without filters/ fancy spaces.
     if filter.count > 0
       puts "ip: " + whereisinfo.ip             if filter[:ip_given]
       puts "hostname: " + whereisinfo.hostname if filter[:hostname_given]
@@ -101,7 +125,6 @@ module Whereisthis
       puts "     org: " + whereisinfo.org
       puts "  postal: " + whereisinfo.postal
     end
-
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whereisthis
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Kent Gruber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-20 00:00:00.000000000 Z
+date: 2016-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ipaddress