geolocal 0.6.2 → 0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a576db50e71f6e445ffd7159ca299f6301bcbd71
-  data.tar.gz: 548b0a82bc3e3459e7b2eb7e09ff40b898a654c1
+  metadata.gz: 9967a2d045173bb94fd0a2099f9751d6c485d5e2
+  data.tar.gz: 68ccf53dc8987083ea502b65d27742c6f23e29c2
 SHA512:
-  metadata.gz: e6d417f096f6cb0bf601c4d74bd698a951766cd37bca686af96fcd66c8c43a92d8f48c8b773d436496a24897f73e7de8f7d6a9c2c82aca91ddd4b78306cf9757
-  data.tar.gz: eb79ad467e23ecf5e5d47e262e6ae7a0577b96e261971175bf9a1714f155ad9b53f61d46224546ba73b418ccabfd8a1ad97dd56a90fb606f2ec3444bb1ee23d8
+  metadata.gz: 95eb28b17e6676f41ea1684eb156ae562bd56a8d91dca3368c9a43f21f5c039e4969722a5f5830439406436de5ba32ada049f91b79f284645f1810c82a013dad
+  data.tar.gz: 218051f783714e1cdfdf988f3e6e76da636fcc3d4c0b71f4016ed5932e409ea1b246698e0baf13bab07ba5b7235c0333540bece81d149aa4515b3fdf20780626

data/README.md

@@ -1,12 +1,12 @@
 # Geolocal
 
 Allows IP addresses to geocoded with a single Ruby if statement.
-No network access, no context switches, no delay.  Just one low-calorie local lookup.
-
+No network access, no context switches, no delay.  Just one low-calorie lookup:
+`Geolocal.in_spain?(request.remote_ip)`
 
 ## Installation
 
-The usual method, add this line to your Gemfile:
+Add this line to your Gemfile:
 
 ```ruby
 gem 'geolocal'
@@ -15,38 +15,47 @@ gem 'geolocal'
 
 ## Usage
 
-First create a config file that describes the ranges you're interested in.
+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 config file describes the ranges you're interested in.
 Here's an example:
 
 ```ruby
 Geolocal.configure do
   config.countries = {
     us: 'US',
+    spain: 'ES',
     central_america: %w[ BZ CR SV GT HN NI PA ]
   }
 end
 ```
 
-Now run `rake geolocal:update`.  It will download the geocoding data
+Now run `rake geolocal:update`.  Geolocal downloads the geocoding data
 from the default provider (see the [providers](#providers) section) and
-create `lib/geolocal.rb`.
+creates the desired methods:
 
 ```ruby
 Geolocal.in_us?(request.remote_ip)
-Geolocal.in_central_america?(IPAddr.new('200.16.66.0'))
+Geolocal.in_spain?('2a05:af06::')  # optional IPv6 support
+Geolocal.in_central_america?('200.16.66.0')
 ```
 
-You can pass:
+#### The in\_*area*? method
+
+The `rake geolocal:update` task generates the Ruby file defining these methods.  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'))`
-* an integer/family combo: `Geolocal.in_us?(167838211, Socket::AF_INET)`
+* an integer/family combo: `Geolocal.in_asia?(167838211, Socket::AF_INET)`
+
+It returns true if the IP address is in the area, false if not.
 
 ## Config
 
 Here are the supported configuration options:
 
-* **provider**: Where to download the geocoding data.  Default: DB_IP.
+* **provider**: Where to download the geocoding data.  See [Providers](#providers) below.  Default: DB_IP.
 * **module**: The name of the module to receive the `in_*` methods.  Default: 'Geolocal'.
 * **file**: Path to the file to contain the generated code.  Default: `lib/#{module}.rb`.
 * **tmpdir**: the directory to contain intermediate files.  They will require tens of megabytes
@@ -57,8 +66,20 @@ Here are the supported configuration options:
 
 ## Examples
 
-This uses the [Countries](https://github.com/hexorx/countries) gem
-to discover if an address is in the European Union:
+There are some examples in the [contrib](https://github.com/bronson/geolocal/tree/master/contrib) directory.
+Run them like this:
+
+```sh
+git clone https://github.com/bronson/geolocal
+cd geolocal
+rake geolocal config=contrib/continents.rb
+```
+
+
+#### in_eu?
+
+It's easy to use the [Countries](https://github.com/hexorx/countries) gem
+to create a `Geolocal.in_eu?(ip_addr)` method:
 
 ```ruby
 require 'countries'
@@ -70,13 +91,15 @@ Geolocal.configure do |config|
 end
 ```
 
-Now you can call `Geolocal.in_eu?(ip)`.  If the European Union membership ever changes,
-run `bundle update countries` and then `rake geolocal` to bring your app up to date.
+If European Union membership ever changes, just run `bundle update countries`
+and `rake geolocal` to bring your app back up to date.
+
+
 
 ## Providers
 
-This gem currently only supoports the [DB-IP](https://db-ip.com/about/) database.
-There are lots of other databases available and this gem is organized to support them.
+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.
 
 
@@ -91,8 +114,7 @@ environments like Heroku.
 
 ## TODO
 
-- [ ] include a Rails generator for the config file?
-- [ ] performance information?  benchmarks.  space saving by going ipv4-only?
+- [ ] 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?

data/config/geolocal.rb

@@ -1,5 +1,17 @@
 require 'geolocal'
 
 Geolocal.configure do |config|
+  # This example creates a Geolocal.in_us?(addr) command:
   config.countries = { us: 'US' }
+
+  # This is where the output goes.  You should commit it to your project.
+  # config.module = 'Geolocal'
+  # config.file = 'lib/geolocal.rb'
+
+  # If your host is IPv4 only, you can save space by omitting IPv6 data and vice versa.
+  # config.ipv6 = true
+  # config.ipv4 = true
+
+  # Download and process the geocoding data in this directory.  Don't commit it.
+  # config.tmpdir = './tmp/geolocal'
 end

data/contrib/array-vs-range-benchmark.rb

@@ -0,0 +1,23 @@
+require 'benchmark'
+
+# This shows that Ranges are about twice as fast as 2-element Arrays
+# Unless the range is (1.to_i..2.to_i), which is identical to Arrays
+
+N = 10_000_000
+
+$a = []
+$r = []
+
+def array
+  $a << [1,2]
+end
+
+def range
+  $r << (1..2)
+end
+
+Benchmark.bm(15, 'array/range') do |x|
+  array_report = x.report('array:') { N.times { array } }
+  range_report = x.report('range:') { N.times { range } }
+  [array_report / range_report]
+end

data/contrib/continents.rb

@@ -0,0 +1,20 @@
+require 'geolocal'
+require 'countries'
+
+
+# creates in_x? methods for each continent: in_north_america?, in_europe?, etc.
+
+Geolocal.configure do |config|
+  all_countries = Country.all.map { |c| Country[c[1]] }
+
+  # { 'antarctica' => ['AQ', 'BV', ...], 'australia' => ['AS', 'AU', ...], ... }
+  by_continent = all_countries.reduce({}) { |hash,country|
+    continent = country.continent.downcase;
+    hash[continent] ||= [];
+    hash[continent] << country.alpha2;
+    hash
+  }
+
+  config.countries = by_continent
+  config.ipv6 = false
+end

data/lib/generators/geolocal/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Creates a US-centric config file for Geolocal
+
+Example:
+    rails generate geolocal
+
+    This will create:
+        config/geolocal.rb

data/lib/generators/geolocal/geolocal_generator.rb

@@ -0,0 +1,7 @@
+class GeolocalGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def copy_config_file
+    copy_file 'geolocal.rb', 'config/geolocal.rb'
+  end
+end

data/lib/generators/geolocal/templates/geolocal.rb

@@ -0,0 +1,17 @@
+require 'geolocal'
+
+Geolocal.configure do |config|
+  # This example creates a Geolocal.in_us?(addr) command:
+  config.countries = { us: 'US' }
+
+  # This is where the output goes.  You should commit it to your project.
+  # config.module = 'Geolocal'
+  # config.file = 'lib/geolocal.rb'
+
+  # If your host is IPv4 only, you can save space by omitting IPv6 data and vice versa.
+  # config.ipv6 = true
+  # config.ipv4 = true
+
+  # Download and process the geocoding data in this directory.  Don't commit it.
+  # config.tmpdir = './tmp/geolocal'
+end

data/lib/geolocal/provider/base.rb

@@ -21,29 +21,42 @@ module Geolocal
         hiaddr = IPAddr.new(histr)
         lofam = loaddr.family
         hifam = hiaddr.family
-        raise "#{lostr} is family #{lofam} but #{histr} is #{hifam}" if lofam != hifam
+        if lofam != hifam
+          raise "#{lostr} and #{histr} must be in the same address family"
+        end
+
+        loval = loaddr.to_i
+        hival = hiaddr.to_i
+        if loval > hival
+          raise "range supplied in the wrong order: #{lostr}..#{histr}"
+        end
 
         if lofam == Socket::AF_INET
-          namefam = name + 'v4' if config[:ipv4]
+          namefam = name.upcase + 'v4' if config[:ipv4]
         elsif lofam == Socket::AF_INET6
-          namefam = name + 'v6' if config[:ipv6]
+          namefam = name.upcase + 'v6' if config[:ipv6]
         else
-          raise "unknown family #{lofam} for #{lostr}"
+          raise "unknown address family #{lofam} for #{lostr}"
         end
 
         if namefam
-          results[namefam] << "#{loaddr.to_i}..#{hiaddr.to_i},\n"
+          results[namefam] << (loaddr.to_i..hiaddr.to_i)
         end
+        namefam
       end
 
-      def update
-        countries = config[:countries].reduce({}) { |a, (k, v)|
-          a.merge! k.to_s.upcase => Array(v).map(&:upcase).to_set
+      def countries
+        @countries ||= config[:countries].sort_by { |k, v| k }.reduce({}) { |a, (k, v)|
+          k = k.to_s.gsub(/[ -]/, '_')
+          raise "invalid identifier: '#{k}'" if k =~ /^[^A-Za-z_]|[^A-Za-z0-9_]|^\s*$/
+          a.merge! k.to_s.downcase => Array(v).map { |c| c.to_s.upcase }.sort.to_set
         }
+      end
 
+      def update
         results = countries.keys.reduce({}) { |a, k|
-          a.merge! k.upcase+'v4' => '' if config[:ipv4]
-          a.merge! k.upcase+'v6' => '' if config[:ipv6]
+          a.merge! k.upcase+'v4' => [] if config[:ipv4]
+          a.merge! k.upcase+'v6' => [] if config[:ipv6]
           a
         }
 
@@ -70,7 +83,7 @@ module Geolocal
 
         write_header file, modname
 
-        config[:countries].keys.each do |name|
+        countries.keys.each do |name|
           v4mod = config[:ipv4] ? name.to_s.upcase + 'v4' : 'nil'
           v6mod = config[:ipv6] ? name.to_s.upcase + 'v6' : 'nil'
           write_method file, name, v4mod, v6mod
@@ -78,21 +91,43 @@ module Geolocal
         file.write "end\n\n"
 
         status "  writing "
-        results.each do |name, body|
-          status "#{name} "
-          write_ranges file, modname, name, body
+        results.each do |name, ranges|
+          coalesced = coalesce_ranges(ranges)
+          status "#{name}-#{ranges.length - coalesced.length} "
+          write_ranges file, modname, name, coalesced
         end
         status "\n"
       end
 
 
+      def coalesce_ranges ranges
+        ranges = ranges.sort_by { |r| r.min }
+
+        uniques = []
+        lastr = ranges.shift
+        uniques << lastr if lastr
+
+        ranges.each do |thisr|
+          if lastr.last >= thisr.first - 1
+            lastr = lastr.first..[thisr.last, lastr.last].max
+            uniques[-1] = lastr
+          else
+            lastr = thisr
+            uniques << lastr
+          end
+        end
+
+        uniques
+      end
+
+
       def write_header file, modname
         file.write <<EOL
 # This file is autogenerated by the Geolocal gem
 
 module #{modname}
 
-  def self.search address, family=nil, v4module, v6module
+  def self.search address, family, v4module, v6module
     address = IPAddr.new(address) if address.is_a?(String)
     family = address.family unless family
     num = address.to_i
@@ -117,10 +152,11 @@ EOL
 EOL
       end
 
-      def write_ranges file, modname, name, body
+      def write_ranges file, modname, name, ranges
         file.write <<EOL
 #{modname}::#{name} = [
-#{body}]
+#{ranges.join(",\n")}
+]
 
 EOL
       end

data/lib/geolocal/provider/db_ip.rb

@@ -68,6 +68,14 @@ class Geolocal::Provider::DB_IP < Geolocal::Provider::Base
          "#{(@current_byte/1024/elapsed).round(1)} KB/sec\n"
   end
 
+  # a bit of debugging code to print all non-matched country codes.  should be deleted one day.
+  def check_country_codes(countries, row)
+    @known_codes ||= countries.reduce(Set.new) { |a,(_,v)| a.merge v; a }
+    unless @known_codes.include?(row[2])
+      puts "#{row[2]}: #{row[0]}..#{row[1]}"
+    end
+  end
+
   def read_ranges countries
     status "computing ranges\n"
 
@@ -84,6 +92,7 @@ class Geolocal::Provider::DB_IP < Geolocal::Provider::Base
               match_count += 1
               yield name, row[0], row[1]
             end
+            # check_country_codes(countries, row)
           end
         end
       end

data/lib/geolocal/version.rb

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

data/lib/tasks/geolocal.rake

@@ -1,4 +1,14 @@
-require './config/geolocal'
+# Provides geolocal's rake tasks.
+
+# we use this file by default
+config='config/geolocal'
+
+# 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
+
 
 namespace :geolocal do
   desc "Downloads the most recent geocoding information"

data/spec/geolocal/provider/base_spec.rb

@@ -0,0 +1,181 @@
+require 'spec_helper'
+require 'geolocal/provider/base'
+
+
+describe Geolocal::Provider::Base do
+  let(:it) { described_class }
+  let(:provider) { it.new }
+
+
+  describe '#add_to_results' do
+    it 'adds a v4 address to the results' do
+      result = { 'USv4'=>[] }
+      expect(
+        provider.add_to_results(result, 'US', '192.168.1.3', '192.168.1.4')
+      ).to eq 'USv4'
+      expect(result).to eq({ "USv4" => [3232235779..3232235780] })
+    end
+
+    it 'adds a v6 address to the results' do
+      result = { 'USv6'=>[] }
+      expect(
+        provider.add_to_results(result, 'US', '2001:400::', '2001:404::')
+      ).to eq 'USv6'
+      # wow, rspec bug?  this expectation causes rspec to enter an infinite loop
+      # expect(result).to eq({ "USv6" => ["3232235779..3232235780,\n"] })
+      expect(result).to eq({ "USv6" =>
+        [42540569291614257367232052214305390592..42540569608526907424289402588481191936] })
+    end
+
+    it 'complains if given a bad range' do
+      expect {
+        provider.add_to_results({}, 'US', '192.168.1.5', '192.168.1.4')
+      }.to raise_error(/wrong order: 192.168.1.5\.\.192.168.1.4/)
+    end
+
+    it 'complains if given an illegal address' do
+      expect {
+        provider.add_to_results({}, 'US', 'dog', 'cat')
+      }.to raise_error(/invalid address/)
+    end
+
+    it 'complains if given non-matching addresses' do
+      expect {
+        provider.add_to_results({}, 'US', '192.168.1.5', '2001:400::')
+      }.to raise_error(/must be in the same address family/)
+    end
+  end
+
+
+  describe '#countries' do
+    it 'preprocesses the countries' do
+      Geolocal.configure do |config|
+        config.countries = { ua: :UA, na: ['MX', 'CA', :US] }
+      end
+
+      expect(provider.countries).to eq({ 'na' => Set['CA', 'MX', 'US'], 'ua' => Set['UA'] })
+    end
+
+    it 'preprocesses countries with an odd name' do
+      Geolocal.configure do |config|
+        config.countries = { 'U s-a': 'US', 'Mex': 'MX' }
+      end
+
+      expect(provider.countries).to eq({ 'mex' => Set['MX'], 'u_s_a' => Set['US'] })
+    end
+
+    it 'refuses invalid identifiers' do
+      Geolocal.configure do |config|
+        config.countries = { '1nation': 'US' }
+      end
+
+      expect { provider.countries }.to raise_error(/invalid identifier/)
+    end
+  end
+
+
+  describe '#coalesce_ranges' do
+    it 'can coalesce some ranges' do
+      expect(provider.coalesce_ranges([1..2, 3..4])).to eq [1..4]
+      expect(provider.coalesce_ranges([8..9, 6..7])).to eq [6..9]
+      expect(provider.coalesce_ranges([1..2, 4..5])).to eq [1..2, 4..5]
+      expect(provider.coalesce_ranges([7..9, 0..2])).to eq [0..2, 7..9]
+      expect(provider.coalesce_ranges([1..1, 2..2])).to eq [1..2]
+      expect(provider.coalesce_ranges([3..3, 1..1])).to eq [1..1, 3..3]
+      expect(provider.coalesce_ranges([1..2, 3..4, 2..6, 6..8, 8..9])).to eq [1..9]
+    end
+
+    it 'can coalesce some oddball cases' do
+      expect(provider.coalesce_ranges([])).to eq []
+      expect(provider.coalesce_ranges([1..1])).to eq [1..1]
+    end
+
+    it 'can coalesce some questionable ranges' do
+      expect(provider.coalesce_ranges([1..2, 2..4])).to eq [1..4]
+      expect(provider.coalesce_ranges([1..8, 2..9])).to eq [1..9]
+      expect(provider.coalesce_ranges([2..4, 1..2])).to eq [1..4]
+      expect(provider.coalesce_ranges([2..9, 1..8])).to eq [1..9]
+    end
+  end
+
+
+  describe 'generating' do
+    let(:example_results) { {
+      'USv4' => [0..16777215, 34603520..34604031, 34605568..34606591],
+      'USv6' => [0..42540528726795050063891204319802818559,
+                42540569291614257367232052214305390592..42540570559264857595461453711008595967]
+    } }
+
+    before do
+      Geolocal.configure do |config|
+        config.countries = { 'US': 'US' }
+      end
+    end
+
+    it 'can generate both ipv4 and ipv6' do
+      Geolocal.configure do |config|
+        config.module = 'Geolocal_v4v6'
+      end
+
+      io = StringIO.new
+      provider.output io, example_results
+      expect(io.string).to include '0..42540528726795050063891204319802818559'
+      expect(io.string).to include '34605568..34606591'
+
+      eval io.string
+      expect(Geolocal_v4v6.in_us? '2.16.13.255').to eq true
+      expect(Geolocal_v4v6.in_us? IPAddr.new('2.16.13.255')).to eq true
+      expect(Geolocal_v4v6.in_us? 34606591, Socket::AF_INET).to eq true
+      expect(Geolocal_v4v6.in_us? 34606592, Socket::AF_INET).to eq nil
+
+      expect(Geolocal_v4v6.in_us? '2001:400::').to eq true
+      expect(Geolocal_v4v6.in_us? IPAddr.new('2001:400::')).to eq true
+      expect(Geolocal_v4v6.in_us? 42540570559264857595461453711008595967, Socket::AF_INET6).to eq true
+      expect(Geolocal_v4v6.in_us? 42540570559264857595461453711008595968, Socket::AF_INET6).to eq nil
+    end
+
+    it 'can turn off ipv4' do
+      Geolocal.configure do |config|
+        config.ipv4 = false
+        config.module = 'Geolocal_v6'
+      end
+
+      io = StringIO.new
+      provider.output io, example_results.tap { |h| h.delete('USv4') }
+      expect(io.string).to include '0..42540528726795050063891204319802818559'
+      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? '2001:400::'  ).to eq true
+    end
+
+    it 'can turn off ipv6' do
+      Geolocal.configure do |config|
+        config.ipv6 = false
+        config.module = 'Geolocal_v4'
+      end
+
+      io = StringIO.new
+      provider.output io, example_results.tap { |h| h.delete('USv6') }
+      expect(io.string).to include '34605568..34606591'
+      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? '2.16.13.255' ).to eq true
+    end
+
+    it 'can turn off both ipv4 and ipv6' do
+      Geolocal.configure do |config|
+        config.ipv4 = false
+        config.ipv6 = false
+      end
+
+      io = StringIO.new
+      provider.output io, example_results.tap { |h| h.delete('USv4'); h.delete('USv6') }
+      expect(io.string).not_to include '34605568..34606591'
+      expect(io.string).not_to include '0..42540528726795050063891204319802818559'
+    end
+  end
+end

data/spec/{provider → geolocal/provider}/db_ip_spec.rb

@@ -61,7 +61,7 @@ describe Geolocal::Provider::DB_IP do
 
 module Geolocal
 
-  def self.search address, family=nil, v4module, v6module
+  def self.search address, family, v4module, v6module
     address = IPAddr.new(address) if address.is_a?(String)
     family = address.family unless family
     num = address.to_i
@@ -98,30 +98,30 @@ EOL
 
     it 'can generate countries from a csv' do
       example_output = <<EOL
-  def self.in_us? address, family=nil
-    search address, family, USv4, USv6
-  end
-
   def self.in_au? address, family=nil
     search address, family, AUv4, AUv6
   end
 
+  def self.in_us? address, family=nil
+    search address, family, USv4, USv6
+  end
+
 end
 
-Geolocal::USv4 = [
-0..16777215,
+Geolocal::AUv4 = [
+16777216..16777471
 ]
 
-Geolocal::USv6 = [
-55854460156896106951106838613354086400..55854460790721407065221539361705689087,
+Geolocal::AUv6 = [
+55832834671488781931518904937387917312..55832834671488781949965649011097468927
 ]
 
-Geolocal::AUv4 = [
-16777216..16777471,
+Geolocal::USv4 = [
+0..16777215
 ]
 
-Geolocal::AUv6 = [
-55832834671488781931518904937387917312..55832834671488781949965649011097468927,
+Geolocal::USv6 = [
+55854460156896106951106838613354086400..55854460790721407065221539361705689087
 ]
 
 EOL
@@ -133,22 +133,22 @@ EOL
 
     it 'can generate countries from a csv when ipv6 is turned off' do
       example_output = <<EOL
-  def self.in_us? address, family=nil
-    search address, family, USv4, nil
-  end
-
   def self.in_au? address, family=nil
     search address, family, AUv4, nil
   end
 
+  def self.in_us? address, family=nil
+    search address, family, USv4, nil
+  end
+
 end
 
-Geolocal::USv4 = [
-0..16777215,
+Geolocal::AUv4 = [
+16777216..16777471
 ]
 
-Geolocal::AUv4 = [
-16777216..16777471,
+Geolocal::USv4 = [
+0..16777215
 ]
 
 EOL
@@ -161,22 +161,22 @@ EOL
 
     it 'can generate countries from a csv when ipv4 is turned off' do
       example_output = <<EOL
-  def self.in_us? address, family=nil
-    search address, family, nil, USv6
-  end
-
   def self.in_au? address, family=nil
     search address, family, nil, AUv6
   end
 
+  def self.in_us? address, family=nil
+    search address, family, nil, USv6
+  end
+
 end
 
-Geolocal::USv6 = [
-55854460156896106951106838613354086400..55854460790721407065221539361705689087,
+Geolocal::AUv6 = [
+55832834671488781931518904937387917312..55832834671488781949965649011097468927
 ]
 
-Geolocal::AUv6 = [
-55832834671488781931518904937387917312..55832834671488781949965649011097468927,
+Geolocal::USv6 = [
+55854460156896106951106838613354086400..55854460790721407065221539361705689087
 ]
 
 EOL

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geolocal
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: '0.8'
 platform: ruby
 authors:
 - Scott Bronson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-05 00:00:00.000000000 Z
+date: 2015-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -82,7 +82,12 @@ files:
 - README.md
 - Rakefile
 - config/geolocal.rb
+- contrib/array-vs-range-benchmark.rb
+- contrib/continents.rb
 - geolocal.gemspec
+- lib/generators/geolocal/USAGE
+- lib/generators/geolocal/geolocal_generator.rb
+- lib/generators/geolocal/templates/geolocal.rb
 - lib/geolocal.rb
 - lib/geolocal/configuration.rb
 - lib/geolocal/provider/base.rb
@@ -91,10 +96,10 @@ files:
 - lib/geolocal/railtie.rb
 - lib/geolocal/version.rb
 - lib/tasks/geolocal.rake
-- spec/configuration_spec.rb
 - spec/data/dbip-country.csv.gz
-- spec/provider/base_spec.rb
-- spec/provider/db_ip_spec.rb
+- spec/geolocal/configuration_spec.rb
+- spec/geolocal/provider/base_spec.rb
+- spec/geolocal/provider/db_ip_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/bronson/geolocal
 licenses:
@@ -121,8 +126,8 @@ signing_key:
 specification_version: 4
 summary: Generates plain Ruby if statements to geocode IP addresses
 test_files:
-- spec/configuration_spec.rb
 - spec/data/dbip-country.csv.gz
-- spec/provider/base_spec.rb
-- spec/provider/db_ip_spec.rb
+- spec/geolocal/configuration_spec.rb
+- spec/geolocal/provider/base_spec.rb
+- spec/geolocal/provider/db_ip_spec.rb
 - spec/spec_helper.rb

data/spec/provider/base_spec.rb

@@ -1,86 +0,0 @@
-require 'spec_helper'
-require 'geolocal/provider/base'
-
-
-describe Geolocal::Provider::Base do
-  let(:it) { described_class }
-  let(:provider) { it.new }
-
-  let(:example_results) { {
-    'USv4' => "0..16777215,\n34603520..34604031,\n34605568..34606591,\n",
-    'USv6' => "0..42540528726795050063891204319802818559,\n" +
-              "42540569291614257367232052214305390592..42540570559264857595461453711008595967,\n"
-  } }
-
-  before do
-    Geolocal.configure do |config|
-      config.countries = { 'us': 'US' }
-    end
-  end
-
-  it 'can generate both ipv4 and ipv6' do
-    Geolocal.configure do |config|
-      config.module = 'Geolocal_v4v6'
-    end
-
-    io = StringIO.new
-    provider.output io, example_results
-    expect(io.string).to include '0..42540528726795050063891204319802818559'
-    expect(io.string).to include '34605568..34606591'
-
-    eval io.string
-    expect(Geolocal_v4v6.in_us? '2.16.13.255').to eq true
-    expect(Geolocal_v4v6.in_us? IPAddr.new('2.16.13.255')).to eq true
-    expect(Geolocal_v4v6.in_us? 34606591, Socket::AF_INET).to eq true
-    expect(Geolocal_v4v6.in_us? 34606592, Socket::AF_INET).to eq nil
-
-    expect(Geolocal_v4v6.in_us? '2001:400::').to eq true
-    expect(Geolocal_v4v6.in_us? IPAddr.new('2001:400::')).to eq true
-    expect(Geolocal_v4v6.in_us? 42540570559264857595461453711008595967, Socket::AF_INET6).to eq true
-    expect(Geolocal_v4v6.in_us? 42540570559264857595461453711008595968, Socket::AF_INET6).to eq nil
-  end
-
-  it 'can turn off ipv4' do
-    Geolocal.configure do |config|
-      config.ipv4 = false
-      config.module = 'Geolocal_v6'
-    end
-
-    io = StringIO.new
-    provider.output io, example_results.tap { |h| h.delete('USv4') }
-    expect(io.string).to include '0..42540528726795050063891204319802818559'
-    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? '2001:400::'  ).to eq true
-  end
-
-  it 'can turn off ipv6' do
-    Geolocal.configure do |config|
-      config.ipv6 = false
-      config.module = 'Geolocal_v4'
-    end
-
-    io = StringIO.new
-    provider.output io, example_results.tap { |h| h.delete('USv6') }
-    expect(io.string).to include '34605568..34606591'
-    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? '2.16.13.255' ).to eq true
-  end
-
-  it 'can turn off both ipv4 and ipv6' do
-    Geolocal.configure do |config|
-      config.ipv4 = false
-      config.ipv6 = false
-    end
-
-    io = StringIO.new
-    provider.output io, example_results.tap { |h| h.delete('USv4'); h.delete('USv6') }
-    expect(io.string).not_to include '34605568..34606591'
-    expect(io.string).not_to include '0..42540528726795050063891204319802818559'
-  end
-end