geolocal 0.8 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9967a2d045173bb94fd0a2099f9751d6c485d5e2
-  data.tar.gz: 68ccf53dc8987083ea502b65d27742c6f23e29c2
+  metadata.gz: 47113ceb0b482073f831d29622e2bc7beb06131f
+  data.tar.gz: b311e669ffa4b394edc577e6d4d20c307366872b
 SHA512:
-  metadata.gz: 95eb28b17e6676f41ea1684eb156ae562bd56a8d91dca3368c9a43f21f5c039e4969722a5f5830439406436de5ba32ada049f91b79f284645f1810c82a013dad
-  data.tar.gz: 218051f783714e1cdfdf988f3e6e76da636fcc3d4c0b71f4016ed5932e409ea1b246698e0baf13bab07ba5b7235c0333540bece81d149aa4515b3fdf20780626
+  metadata.gz: d66866807b4ac24c99024652453cdbd677f0ea1689df1aa367832bf49e9071e1b295f0ec9293c8fe8f5aac703b2eddeba745254ed4d46de94dd145d1adb4db75
+  data.tar.gz: b0ab1135e3bc4b53af4849dd6ed8163c951a78e66c01d6e12c5c28bc1b6b6cc0227ca61f99d7b9c9101fd92c69ffb24c737f269bceff30b10500f8689199c94f

data/README.md

@@ -1,8 +1,10 @@
 # Geolocal
 
-Allows IP addresses to geocoded with a single Ruby if statement.
+Geocode IP addresses with a single Ruby if statement.
 No network access, no context switches, no delay.  Just one low-calorie lookup:
-`Geolocal.in_spain?(request.remote_ip)`
+`Geolocal.in_spain?(request.remote_ip)`.  500,000 individual lookups
+per second is fairly typical performance.
+
 
 ## Installation
 
@@ -22,7 +24,7 @@ The config file describes the ranges you're interested in.
 Here's an example:
 
 ```ruby
-Geolocal.configure do
+Geolocal.configure do |config|
   config.countries = {
     us: 'US',
     spain: 'ES',
@@ -43,7 +45,9 @@ Geolocal.in_central_america?('200.16.66.0')
 
 #### The in\_*area*? method
 
-The `rake geolocal:update` task generates the Ruby file defining these methods.  You can pass:
+The `rake geolocal:update` task generates a Ruby file defining the methods you asked for.
+You can pass:
+
 * a string: `Geolocal.in_us?("10.1.2.3")`
 * an [IPAddr](http://www.ruby-doc.org/stdlib-2.2.0/libdoc/ipaddr/rdoc/IPAddr.html) object:
   `Geolocal.in_eu?(IPAddr.new('2.16.54.0'))`
@@ -51,6 +55,7 @@ The `rake geolocal:update` task generates the Ruby file defining these methods.
 
 It returns true if the IP address is in the area, false if not.
 
+
 ## Config
 
 Here are the supported configuration options:
@@ -64,6 +69,13 @@ Here are the supported configuration options:
 * **ipv6**: whether the ranges should support ipv6 addresses.
 
 
+## Providers
+
+This gem currently only supoports the [DB-IP](https://db-ip.com/about/) Countries database.
+There are lots of other databases available and this gem is organized to support them one day.
+Patches welcome.
+
+
 ## Examples
 
 There are some examples in the [contrib](https://github.com/bronson/geolocal/tree/master/contrib) directory.
@@ -91,33 +103,42 @@ Geolocal.configure do |config|
 end
 ```
 
+Now you can use it in your app: `cookie_warning if Geolocal.in_eu?(request.remote_ip)`
+
 If European Union membership ever changes, just run `bundle update countries`
 and `rake geolocal` to bring your app back up to date.
 
 
+## Performance
 
-## Providers
+It depends on how large an area you're looking up.  `Geolocal.in_antarctica?` will
+take less than half the time of `Geolocal.in_asia?`.  Generally, you can
+expect to do better than a million lookups every two seconds.
 
-This gem currently only supoports the [DB-IP](https://db-ip.com/about/) Countries database.
-There are lots of other databases available and this gem is organized to support them one day.
-Patches welcome.
+To see for yourself, run the continents benchmark:
+
+```sh
+rake geolocal config=contrib/continents.rb
+ruby contrib/benchmark-continents.rb
+```
 
 
 ## Alternatives
 
 The [Geocoder gem](https://github.com/alexreisner/geocoder) offers
 [local database services](https://github.com/alexreisner/geocoder#ip-address-local-database-services).
-Geolocal is simpler, faster, and production ready, but the Geocoder gem offers more options and more providers.
-Geolocal also doesn't add any dependencies to your deploy, potentially making it easier to get working with oddball
-environments like Heroku.
+It offers more options and more providers than Geolocal, but it's a little more complex and not as fast.
+Geolocal also doesn't add any dependencies to your deploy, potentially making it easier to get working
+with oddball environments like Heroku.
 
 
 ## TODO
 
-- [ ] performance information / benchmarks?
 - [ ] 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?
+- [ ] release 1.0!
+- [ ] Detect nesting?  Putting in_eu?, in_europe?, and in_france? generates a lot of redundant overlap.
 - [ ] Add support for for-pay features like lat/lon and timezones?
 
 

data/contrib/benchmark-continents.rb

@@ -0,0 +1,26 @@
+# Shows timings for the generated continent selectors
+# You must first run:
+#
+#     rake geolocal config=contrib/continents
+
+require 'benchmark'
+require_relative '../tmp/geolocal.rb'
+
+
+N = 1_000_000
+
+puts
+puts "running #{N} lookups on each continent:"
+puts
+
+Benchmark.bm(15, 'africa/asia') do |x|
+  spread = 2**32/N - 500     # tries to cover the IPv4 range reasonably well
+
+  x.report('africa:')        { N.times { |i| Geolocal.in_africa?(i*spread, 2) } }
+  x.report('antarcitca:')    { N.times { |i| Geolocal.in_antarctica?(i*spread, 2) } }
+  x.report('asia:')          { N.times { |i| Geolocal.in_asia?(i*spread, 2) } }
+  x.report('australia:')     { N.times { |i| Geolocal.in_australia?(i*spread, 2) } }
+  x.report('europe:')        { N.times { |i| Geolocal.in_europe?(i*spread, 2) } }
+  x.report('north_america:') { N.times { |i| Geolocal.in_north_america?(i*spread, 2) } }
+  x.report('south_america:') { N.times { |i| Geolocal.in_south_america?(i*spread, 2) } }
+end

data/contrib/continents.rb

@@ -1,3 +1,10 @@
+# to generate selectors for each continent:
+#
+#     rake geolocal config=contrib/continents
+#
+# Now you can call Geolocal.in_africa?, in_antarcitca?, in_asia?, etc.
+
+
 require 'geolocal'
 require 'countries'
 

data/lib/geolocal/provider/base.rb

@@ -1,4 +1,5 @@
 require 'ipaddr'
+require 'fileutils'
 
 
 module Geolocal
@@ -62,6 +63,7 @@ module Geolocal
 
         read_ranges(countries) { |*args| add_to_results(results, *args) }
 
+        FileUtils.mkdir_p File.dirname(config[:file])
         File.open(config[:file], 'w') do |file|
           output(file, results)
         end
@@ -125,6 +127,8 @@ module Geolocal
         file.write <<EOL
 # This file is autogenerated by the Geolocal gem
 
+require 'ipaddr'
+
 module #{modname}
 
   def self.search address, family, v4module, v6module

data/lib/geolocal/version.rb

@@ -1,3 +1,3 @@
 module Geolocal
-  VERSION = "0.8"
+  VERSION = "0.8.1"
 end

data/spec/geolocal/provider/db_ip_spec.rb

@@ -59,6 +59,8 @@ describe Geolocal::Provider::DB_IP do
       <<EOL
 # This file is autogenerated by the Geolocal gem
 
+require 'ipaddr'
+
 module Geolocal
 
   def self.search address, family, v4module, v6module
@@ -78,7 +80,8 @@ EOL
     }
 
     def run_test example_body
-      outfile = 'tmp/geolocal.rb'
+      outdir = "tmp/test-#{$$}"
+      outfile = "#{outdir}/geolocal.rb"
       if File.exist?(outfile)
         File.delete(outfile)
       end
@@ -93,6 +96,7 @@ EOL
       provider.update
       expect(File.read outfile).to eq example_header + example_body
       File.delete(outfile)
+      Dir.rmdir(outdir)
     end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geolocal
 version: !ruby/object:Gem::Version
-  version: '0.8'
+  version: 0.8.1
 platform: ruby
 authors:
 - Scott Bronson
@@ -82,7 +82,8 @@ files:
 - README.md
 - Rakefile
 - config/geolocal.rb
-- contrib/array-vs-range-benchmark.rb
+- contrib/benchmark-array-vs-range.rb
+- contrib/benchmark-continents.rb
 - contrib/continents.rb
 - geolocal.gemspec
 - lib/generators/geolocal/USAGE