geolocater 0.0.1.alpha → 0.0.1

data/HISTORY.md

@@ -0,0 +1,13 @@
+HISTORY
+=======
+
+0.0.1 - January 11th 2012
+--------------------------
+* Refactored the core 'geolocater.rb' lib into 2 methods
+* Changed core from Module to Class
+* Wrote simple unit tests - PASSING
+
+0.0.1.alpha - January 11th 2012
+--------------------------
+* Extract code from Rails project
+* Wrote simple functionality tests - PASSED

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2011 Dan Barrett
+
+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.md

@@ -11,6 +11,18 @@ Pass any properly formatted IPv4 address string to a new instance of Geolocater
 
 `Geolocater.ip_lookup(IP_ADDRESS_STRING)`
 
-### More Info
-* Email me at <dbarrett83@gmail.com>
+### Details
+* This library uses the free (and very good) [freegeoip.net](http://freegeoip.net) REST API.
+* Results are returned in JSON format. For friendlier Ruby object-like results (and better nil handling), pipe the result hash into a new [Hashie::Mash](https://github.com/intridea/hashie) like so:
+** `Hashie::Mash.new(Geolocater.ip_lookup(IP_ADDRESS_STRING))`
+
+### Future Features
+* Add multiple geolocation services in the event the freegeoip service goes down
+
+### How You Can Help
+* Suggest additional tests/refactoring
+* Submit a pull request
+
+### Thanks!
+* <dbarrett83@gmail.com>
 * [Twitter](http://www.twitter.com/thoughtpunch)

data/lib/geolocater/version.rb

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

data/spec/geolocater_spec.rb

@@ -3,10 +3,6 @@ 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)
@@ -23,7 +19,9 @@ describe Geolocater do
     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
-
+  end
+  
+  describe "#geolocate_ip" do
     it "successfully makes a HTTP request" do
       expect{Geolocater.ip_lookup("231.4.8.6").success?}.to be_true
     end
@@ -39,7 +37,8 @@ describe Geolocater do
     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
+    
+  end      
 end
 

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: geolocater
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha
-  prerelease: 6
+  version: 0.0.1
+  prerelease: 
 platform: ruby
 authors:
 - Dan Barrett
@@ -13,7 +13,7 @@ date: 2012-01-11 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &19013520 !ruby/object:Gem::Requirement
+  requirement: &18430620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19013520
+  version_requirements: *18430620
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &19013000 !ruby/object:Gem::Requirement
+  requirement: &18430160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19013000
+  version_requirements: *18430160
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &19012420 !ruby/object:Gem::Requirement
+  requirement: &18429680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *19012420
+  version_requirements: *18429680
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &19011860 !ruby/object:Gem::Requirement
+  requirement: &18429220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *19011860
+  version_requirements: *18429220
 description: geolocater is a simple ruby wrapper for the freegeoip.net API
 email:
 - dbarrett83@gmail.com
@@ -65,6 +65,8 @@ files:
 - .gitignore
 - .rspec
 - Gemfile
+- HISTORY.md
+- LICENSE.md
 - README.md
 - Rakefile
 - geolocater.gemspec
@@ -88,9 +90,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: geolocater
 rubygems_version: 1.8.10