geolocal 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f7cad64f85f04f0bd9971651e2470ad2f344640
-  data.tar.gz: 3e309a0a2464feb9c2431e34b2aacddfea18635c
+  metadata.gz: 8792c02f07fa1ef48a72bb33f2d4023ec213e09e
+  data.tar.gz: d2f653dc43c43adf4525c93028dc3743dd14c4a7
 SHA512:
-  metadata.gz: c9735c98cb5e6268510d41d792c9dcfb88428d4123f69855f74e03f2c48e133fdac101d6ee7a9dd6c3a90093f5bd0fa7b41a96b9a16508e1fa2f90282f1c57d8
-  data.tar.gz: 04cee72abe241e39642c681b87f003a6ab963d30d16182e1f206c438b1cdf5ec51711c1b0b4618deb462232a714c667856bff656fe174c404c7ffadc58c71148
+  metadata.gz: 57320e94ff4c7edb61b73ba4c00e9475c44bc2f992ae52926ec3f26bf495fcde9270605e17f18d29b10d6d079967c22761dc4875a2d1a85ac3864b9220dfd42d
+  data.tar.gz: f753383614e00db0dd56101e9915300f7082e00e050ab8179a7469e1089067c52bb659598982191994dc0f7e1ed9a24b6ed6bae7f8689e4038a8c75ce7ca5fb3

data/README.md

@@ -2,7 +2,11 @@
 
 Geocode IP addresses with a single Ruby if statement.
 No network access, no context switches, no delay,
-just one low-calorie lookup like `Geolocal.in_spain?(request.remote_ip)`.
+just one low-calorie lookup.
+
+```ruby
+Geolocal.in_spain?(request.remote_ip)
+```
 
 500,000 individual lookups per second is fairly typical performance.
 
@@ -21,13 +25,15 @@ And this line to your Rakefile:
 require 'geolocal/tasks'
 ```
 
+
 ## Usage
 
 If you're using Rails, run `rails generate geolocal` to create the configuration file.
 Otherwise, crib from [config/geolocal.rb](https://github.com/bronson/geolocal/tree/master/config/geolocal.rb).
 
 The configuration file describes the ranges you're interested in.
-Here's an example:
+Here's an example that creates three queries: `in_us?`, `in_spain?`,
+and `in_central_america?`:
 
 ```ruby
 require 'geolocal/configuration'
@@ -43,7 +49,7 @@ end
 
 Now run `rake geolocal:update`.  Geolocal downloads the geocoding data
 from the default provider (see the [providers](#providers) section) and
-creates the desired methods:
+generates the methods:
 
 ```ruby
 require 'geolocal'
@@ -55,7 +61,7 @@ Geolocal.in_central_america?('200.16.66.0')
 
 #### The in\_*area*? method
 
-The `rake geolocal:update` task generates a Ruby file defining the methods you asked for.
+Call this routine to discover whether an address is inside or outside the given area.
 You can pass:
 
 * a string: `Geolocal.in_us?("10.1.2.3")`
@@ -65,6 +71,10 @@ You can pass:
 
 It returns true if the IP address is in the area, false if not.
 
+It works by generating a static array of ranges.  `in_area?` binary
+searches the appropriate array to determine whether the desired
+address is contained or not.
+
 
 ## Config
 
@@ -77,6 +87,11 @@ Here are the supported configuration options:
   for countries, hundreds for cities).  Default: `./tmp/geolocal`
 * **countries**: the ISO-codes of the countries to include in the lookup.
 * **ipv6**: whether the ranges should support ipv6 addresses.
+* **ipv4**: whether the ranges should support ipv4 addresses.
+
+If you don't compile in an address family, but you pass Geolocal an address in that
+family (say, you omit ipv6 but call `Geolocal.in_us?('::1')`), then Geolocal will
+return false.  It will always assume the address is outside your ranges.
 
 
 ## Providers
@@ -144,6 +159,9 @@ with oddball environments like Heroku.
 
 ## Roadmap
 
+Geolocal is running on multiple production sites.  It has proven itself to be fast and stable.
+Therefore, we may or may not ever get around to implementing these.  Just depends on interest.
+
 * Add support for cities
 * other sources for this data? [MainFacts](http://mainfacts.com/ip-address-space-addresses), [NirSoft](http://www.nirsoft.net/countryip/)
   Also maybe allow providers to accept their own options?
@@ -154,7 +172,7 @@ with oddball environments like Heroku.
 
 ## License
 
-Pain-free MIT.  Downloaded data is copyrighted by the provider you downloaded it from.
+MIT.  Any downloaded data is copyrighted by the provider you downloaded it from.
 
 
 ## Contributing

data/lib/geolocal/provider/base.rb

@@ -140,7 +140,7 @@ module #{modname}
       when Socket::AF_INET6 then mod = v6module
       else raise "Unknown family \#{family} for address \#{address}"
     end
-    raise "ipv\#{family == 2 ? 4 : 6} was not compiled in" unless mod
+    return false unless mod # if we didn't compile in ipv6, assume nothing's local
     true if mod.bsearch { |range| num > range.max ? 1 : num < range.min ? -1 : 0 }
   end
 

data/lib/geolocal/tasks.rb

@@ -8,7 +8,6 @@ namespace :geolocal do
     # but you can specify the config file on the command line:
     #     `rake geolocal config=contrib/continents`
     config=ENV['config'] if ENV['config']
-    puts "loading geolocal configuration from #{config}"
     require './' + config
 
     Geolocal.configuration.load_provider.new

data/lib/geolocal/version.rb

@@ -1,3 +1,3 @@
 module Geolocal
-  VERSION = "0.9.2"
+  VERSION = "0.9.3"
 end

data/spec/geolocal/provider/base_spec.rb

@@ -146,7 +146,7 @@ describe Geolocal::Provider::Base do
       expect(io.string).not_to include '34605568..34606591'
 
       eval io.string
-      expect{ Geolocal_v6.in_us? '2.16.13.255' }.to raise_error(/ipv4 was not compiled in/)
+      expect( Geolocal_v6.in_us? '2.16.13.255' ).to eq false
       expect( Geolocal_v6.in_us? '2001:400::'  ).to eq true
     end
 
@@ -162,7 +162,7 @@ describe Geolocal::Provider::Base do
       expect(io.string).not_to include '0..42540528726795050063891204319802818559'
 
       eval io.string
-      expect{ Geolocal_v4.in_us? '2001:400::'  }.to raise_error(/ipv6 was not compiled in/)
+      expect( Geolocal_v4.in_us? '2001:400::'  ).to eq false
       expect( Geolocal_v4.in_us? '2.16.13.255' ).to eq true
     end
 

data/spec/geolocal/provider/db_ip_spec.rb

@@ -72,7 +72,7 @@ module Geolocal
       when Socket::AF_INET6 then mod = v6module
       else raise "Unknown family \#{family} for address \#{address}"
     end
-    raise "ipv\#{family == 2 ? 4 : 6} was not compiled in" unless mod
+    return false unless mod # if we didn't compile in ipv6, assume nothing's local
     true if mod.bsearch { |range| num > range.max ? 1 : num < range.min ? -1 : 0 }
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geolocal
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors:
 - Scott Bronson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-11 00:00:00.000000000 Z
+date: 2015-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -120,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Generates plain Ruby if statements to geocode IP addresses