attack-spotlight 0.1.0

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2009 John Nunemaker (for initial structure)
+Copyright (c) 2009 Mark G.
+
+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/README.rdoc

@@ -0,0 +1,86 @@
+= spotlight
+
+A simple interface to the www.hostip.info API.
+
+= HostIP.info
+
+hostip.info is a "Community Geotarget IP Project" and provides a simple API
+to transform an "IP Address" into a location (including Country, City, and
+coordinates).
+
+No API key or sign-up is required to use the service.
+
+hostip.info does request that if a lot of databases lookups are being done
+that you download the entire database from them instead.
+
+= dependencies
+
+- HTTParty (url=http://github.com/jnunemaker/httparty/tree/master)
+  [version used=0.3.1]
+
+== TESTING environment only
+
+- fakeweb [version used=1.2.0]
+
+= example
+
+== from the command line
+
+ # spotlight 209.85.171.100
+
+== from a ruby script
+
+ require 'rubygems'
+ require 'spotlight'
+ 
+ spotlight = Spotlight.new("209.85.171.100")
+ 
+ puts spotlight.location.coordinates
+
+== from a rails application
+
+=== in config/environment
+ 
+ require 'spotlight'
+ 
+=== in your controller
+ 
+ @spotlight = Spotlight.new("209.85.171.100")
+ 
+=== in your view
+
+ @spotlight.location.coordinates
+
+== from a rails application with caching
+
+Using caching is highly advised if possible.  The ip_address to location
+conversion doesn't normally change over time (if ever) so why continuously
+query it?
+
+Assumption: caching is already enabled and working.\
+
+=== in config/environment
+ 
+ require 'spotlight'
+ 
+=== in your controller
+ 
+ ip_address = "209.85.171.100"
+ @spotlight = Rails.cache.fetch(Spotlight.key(ip_address), :expires_in => 1.weeks) do
+   Spotlight.new(ip_address)
+ end
+ 
+=== in your view
+
+ @spotlight.location.coordinates
+
+= credits
+
+Other then the code written by me (url=http://github.com/attack) and the code
+generated by 'jeweler' (url=http://github.com/jnunemaker) for making  and 
+maintaining gems, there is strong influence from jnunemaker
+(url=http://github.com/jnunemaker) and the gem google-weather.
+
+== Copyright
+
+Copyright (c) 2009 Mark G. See LICENSE for details.

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 1
+:patch: 0

data/bin/spotlight

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+ 
+require File.dirname(__FILE__) + '/../lib/spotlight'
+ 
+if ARGV.size == 0
+  puts 'Spotlight [Powered by hostip.info]'
+  puts 'USAGE: spotlight [ip_address]'
+  puts 'EXAMPLES:'
+  puts ' spotlight 209.85.171.100'
+  exit
+end
+ 
+spotlight = Spotlight.new(ARGV[0])
+
+puts "location -- name: #{spotlight.location.name}, latitude: #{spotlight.location.latitude}, longitude: #{spotlight.location.longitude}"
+puts "country  -- name: #{spotlight.country.name}, code: #{spotlight.country.code}"

data/lib/spotlight.rb

@@ -0,0 +1,67 @@
+require 'rubygems'
+gem 'jnunemaker-httparty'
+require 'httparty'
+
+require File.dirname(__FILE__) + '/spotlight/data'
+require File.dirname(__FILE__) + '/spotlight/country'
+require File.dirname(__FILE__) + '/spotlight/location'
+ 
+class Spotlight
+  include HTTParty
+  base_uri "api.hostip.info"
+
+  attr_reader :ip
+    
+  def initialize(ip_address)
+    # validate ip_address format
+    raise unless Spotlight.valid?(ip_address)
+    # we are all clear, save the ip
+    @ip = ip_address
+    # query hostip.info
+    self.shine
+    self
+  end
+
+  # generate a key from the ip_address
+  def self.key(ip_address, prefix="spotlight")
+    # validate ip_address format
+    raise unless self.valid?(ip_address)
+    # all clear, generate the key
+    segments = [prefix]
+    # this ip_address does not need to be encoded as it is a valid
+    # ip_address and only contains key-friendly chars
+    segments << ip_address
+    segments.join('-')
+  end
+
+  def country
+    @country ||= Country.new(@result)
+  end
+
+  def location
+    @location ||= Location.new(@result)
+  end
+  
+  protected
+  
+  # actually query HostIP.info with the 'IP address'
+  # NOTE: 'shine' might not be the best name for the method, other possibles
+  # include: query, fetch, get, direct, ask, locate, target ... ???
+  def shine
+    @result ||= self.class.get(
+      "/",
+      :query => {:ip => @ip},
+      :format => :xml
+    )['HostipLookupResultSet']['gml:featureMember']
+  end
+  
+  # validate an ip_address
+  # regular expression from http://www.ruby-forum.com/topic/62553
+  def self.valid?(ip_address)
+    return false unless ip_address.is_a?(String)
+    regexp = Regexp.new(/(?:25[0-5]|(?:2[0-4]|1\d|[1-9])?\d)(?:\.(?:25[0-5]|(?:2[0-4]|1\d|[1-9])?\d)){3}/)
+    return false unless regexp =~ ip_address
+    return true
+  end
+  
+end

data/lib/spotlight/country.rb

@@ -0,0 +1,21 @@
+class Spotlight
+  class Country < Data
+
+    def name
+      begin
+        return @data['Hostip']['countryName']
+      rescue
+        return nil
+      end
+    end
+
+    def code
+      begin
+        return @data['Hostip']['countryAbbrev']
+      rescue
+        return nil
+      end
+    end
+
+  end
+end

data/lib/spotlight/data.rb

@@ -0,0 +1,10 @@
+class Spotlight
+  class Data
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+    end
+
+  end
+end

data/lib/spotlight/location.rb

@@ -0,0 +1,31 @@
+class Spotlight
+  class Location < Data
+  
+    def name
+      begin
+        return @data['Hostip']['gml:name']
+      rescue
+        return nil
+      end
+    end
+    
+    def coordinates
+      begin
+        return @data['Hostip']['ipLocation']['gml:PointProperty']['gml:Point']['gml:coordinates']
+      rescue
+        return nil
+      end
+    end
+  
+    def longitude
+      return unless self.coordinates
+      self.coordinates.split(',')[0].to_f
+    end
+  
+    def latitude
+      return unless self.coordinates
+      self.coordinates.split(',')[1].to_f
+    end
+  
+  end
+end

data/spec/fixtures/199_246_67_211.xml

@@ -0,0 +1 @@
+<HostipLookupResultSet xsi:schemaLocation='http://www.hostip.info/api/hostip-1.0.0.xsd' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xmlns:gml='http://www.opengis.net/gml' version='1.0.0' xmlns='http://www.hostip.info/api'><gml:description>This is the Hostip Lookup Service</gml:description><gml:name>hostip</gml:name><gml:boundedBy><gml:Null>inapplicable</gml:Null></gml:boundedBy><gml:featureMember><Hostip><gml:name>TORONTO, ON</gml:name><countryName>CANADA</countryName><countryAbbrev>CA</countryAbbrev><!-- Co-ordinates are available as lng,lat --><ipLocation><gml:PointProperty><gml:Point srsName='http://www.opengis.net/gml/srs/epsg.xml#4326'><gml:coordinates>-79.3833,43.65</gml:coordinates></gml:Point></gml:PointProperty></ipLocation></Hostip></gml:featureMember></HostipLookupResultSet>

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'spec'
+require 'fakeweb'
+
+FakeWeb.allow_net_connect = false
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'spotlight'
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/spotlight_spec.rb

@@ -0,0 +1,191 @@
+require 'spec_helper'
+
+describe "Initialization" do
+  
+  before(:each) do
+    FakeWeb.register_uri(:get, 
+      "http://api.hostip.info/?ip=199.246.67.211",
+      :string => File.read(File.join(File.dirname(__FILE__), 
+        'fixtures', 
+        '199_246_67_211.xml')
+      )
+    )
+  end
+  
+  it "should require an ip address" do
+    lambda { Spotlight.new }.should raise_error
+      
+    Spotlight.new("199.246.67.211").ip.should == "199.246.67.211"
+  end
+  
+  it "should require a proper ip address" do
+    lambda { Spotlight.new(199) }.should raise_error
+    lambda { Spotlight.new(199.246) }.should raise_error
+    lambda { Spotlight.new({:test => "test"}) }.should raise_error
+    lambda { Spotlight.new(["test"]) }.should raise_error
+    lambda { Spotlight.new("199") }.should raise_error
+    lambda { Spotlight.new("199.246") }.should raise_error
+    lambda { Spotlight.new("199.246.67") }.should raise_error
+    lambda { Spotlight.new("aaa.246.67.211") }.should raise_error
+    lambda { Spotlight.new("199.aaa.67.211") }.should raise_error
+    lambda { Spotlight.new("199.246.aaa.211") }.should raise_error
+    lambda { Spotlight.new("199.246.67.aaa") }.should raise_error
+    lambda { Spotlight.new("") }.should raise_error
+    lambda { Spotlight.new(" ") }.should raise_error
+    lambda { Spotlight.new("aaa") }.should raise_error
+    
+    # sanity check
+    lambda { Spotlight.new("199.246.67.211") }.should_not raise_error
+  end
+    
+end
+
+describe "Spotlight" do
+  
+  it "should create an ip based key" do
+    Spotlight.key("199.246.67.211").should == "spotlight-199.246.67.211"
+  end
+    
+  it "should create an ip based key with defined prefix" do
+    Spotlight.key("199.246.67.211", "alternate").should == "alternate-199.246.67.211"
+  end
+
+end
+
+describe "Data" do
+  
+  it "should require data" do
+    lambda { Spotlight::Data.new }.should raise_error
+      
+    data = {'foo' => {'data' => 'bar'}}
+    Spotlight::Data.new(data).data.should == data
+  end
+  
+end
+
+describe "Location" do
+  
+  it "should require data" do
+    lambda { Spotlight::Location.new }.should raise_error
+      
+    data = {'foo' => {'data' => 'bar'}}
+    Spotlight::Location.new(data).data.should == data
+  end
+  
+  it "should return nil when the data does not exist" do
+    data = {}
+    location = Spotlight::Location.new(data)
+    location.should_not be_nil
+    
+    location.name.should be_nil
+    location.coordinates.should be_nil
+    location.longitude.should be_nil
+    location.latitude.should be_nil
+  end
+  
+  # @data['Hostip']['gml:name']
+  it "should respond to name" do
+    data = {'Hostip' => {'gml:name' => "test_name"}}
+    location = Spotlight::Location.new(data)
+    location.should_not be_nil
+    
+    location.name.should == "test_name"
+  end
+  
+  # @data['Hostip']['ipLocation']['gml:PointProperty']['gml:Point']['gml:coordinates']
+  it "should respond to coordinates" do
+    data = {'Hostip' => {'ipLocation' => {'gml:PointProperty' => {'gml:Point' => {'gml:coordinates' => "-79.3833,43.65"}}}}}
+    location = Spotlight::Location.new(data)
+    location.should_not be_nil
+    
+    location.coordinates.should == "-79.3833,43.65"
+  end
+  
+  # @data['Hostip']['ipLocation']['gml:PointProperty']['gml:Point']['gml:coordinates']
+  it "should respond to longitude" do
+    data = {'Hostip' => {'ipLocation' => {'gml:PointProperty' => {'gml:Point' => {'gml:coordinates' => "-79.3833,43.65"}}}}}
+    location = Spotlight::Location.new(data)
+    location.should_not be_nil
+    
+    location.longitude.should == -79.3833
+  end
+
+  # @data['Hostip']['ipLocation']['gml:PointProperty']['gml:Point']['gml:coordinates']
+  it "should respond to latitude" do
+    data = {'Hostip' => {'ipLocation' => {'gml:PointProperty' => {'gml:Point' => {'gml:coordinates' => "-79.3833,43.65"}}}}}
+    location = Spotlight::Location.new(data)
+    location.should_not be_nil
+    
+    location.latitude.should == 43.65
+  end
+  
+end
+  
+describe "Country" do
+
+  it "should require data" do
+    lambda { Spotlight::Country.new }.should raise_error
+
+    data = {'foo' => {'data' => 'bar'}}
+    Spotlight::Country.new(data).data.should == data
+  end
+
+  it "should return nil when the data does not exist" do
+    data = {}
+    country = Spotlight::Country.new(data)
+    country.should_not be_nil
+
+    country.name.should be_nil
+    country.code.should be_nil
+  end
+
+  # @data['Hostip']['countryName']
+  it "should respond to name" do
+    data = {'Hostip' => {'countryName' => "test_name"}}
+    country = Spotlight::Country.new(data)
+    country.should_not be_nil
+
+    country.name.should == "test_name"
+  end
+
+  # @data['Hostip']['countryAbbrev']
+  it "should respond to coordinates" do
+    data = {'Hostip' => {'countryAbbrev' => "CA"}}
+    country = Spotlight::Country.new(data)
+    country.should_not be_nil
+
+    country.code.should == "CA"
+  end
+
+end
+
+describe "Fetching" do
+  
+  before(:each) do
+    FakeWeb.register_uri(:get, 
+      "http://api.hostip.info/?ip=199.246.67.211",
+      :string => File.read(File.join(File.dirname(__FILE__), 
+        'fixtures', 
+        '199_246_67_211.xml')
+      )
+    )
+    @spotlight = Spotlight.new("199.246.67.211")
+  end
+  
+  it "should have location information" do
+    @spotlight.location.should_not be_nil
+    location = @spotlight.location
+    location.name.should == 'TORONTO, ON'
+    location.coordinates.should == '-79.3833,43.65'
+    location.longitude.should == -79.3833
+    location.latitude.should == 43.65
+  end
+  
+  it "should have country information" do
+    @spotlight.country.should_not be_nil
+    country = @spotlight.country
+    country.name.should == 'CANADA'
+    country.code.should == 'CA'
+  end
+  
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: attack-spotlight
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Mark G
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-02 00:00:00 -07:00
+default_executable: spotlight
+dependencies: []
+
+description: 
+email: spotlight@attackcorp.com
+executables: 
+- spotlight
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+files: 
+- README.rdoc
+- VERSION.yml
+- bin/spotlight
+- lib/spotlight
+- lib/spotlight/country.rb
+- lib/spotlight/data.rb
+- lib/spotlight/location.rb
+- lib/spotlight.rb
+- spec/fixtures
+- spec/fixtures/199_246_67_211.xml
+- spec/spec_helper.rb
+- spec/spotlight_spec.rb
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/attack/spotlight
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --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.2.0
+signing_key: 
+specification_version: 2
+summary: TODO
+test_files: []
+