geolocater 0.0.1.alpha

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Guardfile
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in geolocater.gemspec
+gemspec

data/README.md

@@ -0,0 +1,16 @@
+Geolocater
+==========
+Yet Another IP Geolocation Gem for Fun and Profit!
+--------------------------------------------------
+
+### Installation
+`gem install geolocater`
+
+### Usage
+Pass any properly formatted IPv4 address string to a new instance of Geolocater like so.
+
+`Geolocater.ip_lookup(IP_ADDRESS_STRING)`
+
+### More Info
+* Email me at <dbarrett83@gmail.com>
+* [Twitter](http://www.twitter.com/thoughtpunch)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/geolocater.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "geolocater/version"
+
+Gem::Specification.new do |s|
+  s.name        = "geolocater"
+  s.license     = 'MIT'
+  s.version     = Geolocater::VERSION
+  s.authors     = ["Dan Barrett"]
+  s.email       = ["dbarrett83@gmail.com"]
+  s.homepage    = "http://www.about.me/thoughtpunch"
+  s.summary     = "Yet Another IP Geolocation Gem"
+  s.description = "geolocater is a simple ruby wrapper for the freegeoip.net API"
+
+  s.rubyforge_project = "geolocater"
+  
+  s.required_ruby_version = '>= 1.9.0'
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "guard"
+  s.add_dependency "faraday"
+  s.add_dependency "json"
+end

data/lib/geolocater.rb

@@ -0,0 +1,47 @@
+require "geolocater/version"
+require 'faraday'
+require 'json'
+
+class Geolocater
+
+  class << self
+
+    def ip_lookup(ip_address)
+      #IP Regex check
+      if /\b(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\b/.match(ip_address).nil?
+        raise "Not a valid IPv4 address"
+      #Localhost Check
+      elsif ip_address == "127.0.0.1"
+        raise "Can't lookup localhost address. Please use an external IP address!"
+      #If valid, pass the ip address to the 'geolocate' method
+      else
+        geolocate_ip ip_address
+      end
+    end
+
+    private
+    def geolocate_ip ip_address
+      #the request URI
+      uri = "http://freegeoip.net/json/#{ip_address}"
+      #Get the response with Faraday and store to 'http_response' var
+      http_response = Faraday.get uri
+      #If the HTTP request is successful...
+      if http_response.success? == true && http_response.status == 200;
+        #JSON PARSE THE BODY
+        result = JSON.parse(http_response.body)
+        #If the response is missing basic info, like 'city'...
+        if result["city"].empty?
+          raise "Incomplete record. Please try another address"
+        #otherwise return the result
+        else
+          return result
+        end
+      #If the HTTP request fails...
+      else
+        raise "IP address not found"
+      end
+    end    
+  
+  end
+  
+end

data/lib/geolocater/version.rb

@@ -0,0 +1,3 @@
+class Geolocater
+  VERSION = "0.0.1.alpha"
+end

data/spec/geolocater_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+require 'geolocater'
+
+describe Geolocater do
+
+  before :each do
+    @geolocater = Geolocater.new
+  end
+
+  describe "#ip_lookup" do    
+    it "throws an ArgumentError error if no parameters passed" do
+      expect {Geolocater.ip_lookup}.to raise_error(ArgumentError)
+    end
+
+    it "throws an ArgumentError error if more than one parameter passed" do
+      expect {Geolocater.ip_lookup("sdfsdf","sdfsadf")}.to raise_error(ArgumentError)
+    end
+    
+    it "only accepts input that passes a basic IP regex" do
+      expect {Geolocater.ip_lookup("sdfsadfsdf")}.to raise_error(RuntimeError,"Not a valid IPv4 address")
+    end
+    
+    it "should not accept localhost/loopback address" do
+      expect {Geolocater.ip_lookup("127.0.0.1")}.to raise_error(RuntimeError,"Can't lookup localhost address. Please use an external IP address!")
+    end
+
+    it "successfully makes a HTTP request" do
+      expect{Geolocater.ip_lookup("231.4.8.6").success?}.to be_true
+    end
+    
+    it "throws an error for HTTP statuses other than 200" do
+      expect {Geolocater.ip_lookup("0.0.0.0")}.to raise_error(RuntimeError,"IP address not found")
+    end
+    
+    it "parses the HTTP body with JSON" do
+      Geolocater.ip_lookup("123.45.6.28").should be_an_instance_of Hash
+    end
+    
+    it "has a value for city" do
+      @result = Geolocater.ip_lookup("123.45.6.28")["city"].should_not be_empty
+      expect {Geolocater.ip_lookup("240.0.0.0")}.to raise_error(RuntimeError,"Incomplete record. Please try another address")
+    end      
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'geolocater'
+

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: geolocater
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha
+  prerelease: 6
+platform: ruby
+authors:
+- Dan Barrett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-11 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &19013520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *19013520
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &19013000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *19013000
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: &19012420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *19012420
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &19011860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *19011860
+description: geolocater is a simple ruby wrapper for the freegeoip.net API
+email:
+- dbarrett83@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- geolocater.gemspec
+- lib/geolocater.rb
+- lib/geolocater/version.rb
+- spec/geolocater_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.about.me/thoughtpunch
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: geolocater
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Yet Another IP Geolocation Gem
+test_files: []
+has_rdoc: