geolocal 0.5 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42ed22b2aefba01694af9ec4f3fb0f969f307ef8
-  data.tar.gz: 969d5d208bb9fd73e83d363c2b628a370af600b7
+  metadata.gz: 94b1ea23b169d938aedf7afa726b35f8c59025e7
+  data.tar.gz: 7bde790f3742741c3ea0f94f0640927f93c02b6c
 SHA512:
-  metadata.gz: 319338e43dac19ca42ef0e7d6d3ff59e4862a71f95b1e6f34f17f1b96675bbf966e4d190c68b26c9342ff3cc1bd1f3efc3c1287ea053f316e57b4e9653948490
-  data.tar.gz: c36302f7fa49e21a064410754030276cc2e71398618eca05dad5d0bfacfd11285a61b173627f10c6547a9ad57c0cb01b4aaaaa8c3e1205ef32883afdbb833b25
+  metadata.gz: 5c3267bab152d3583da3aeedb7d2ba1467c9d3762061392d972db95974a5297a56f03056d96e7274c2897bd0f98dc7174710a7e67570c90eddfd26ef38131569
+  data.tar.gz: 9427d86aa844125c4259c356801a3ad10716651b0b825306af08e3c3eb289d59fd98bc29e530526b72a0302278aa0a425d2e0b37284762fbfba5ff3183ee0974

data/README.md

@@ -36,18 +36,21 @@ Geolocal.in_us?(request.remote_ip)
 Geolocal.in_central_america?(IPAddr.new('200.16.66.0'))
 ```
 
+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)`
 
 ## Config
 
-Here are the most common config keys.  See the docs for the provider
-you're using for more.
+Here are the supported configuration options:
 
 * **provider**: Where to download the geocoding data.  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
   for countries, hundreds for cities).  Default: `./tmp/geolocal`
-* **expires**: the amount of time to consider downloaded data valid.  Default: 1.month
 * **countries**: the ISO-codes of the countries to include in the lookup.
 * **ipv6**: whether the ranges should support ipv6 addresses.
 
@@ -67,8 +70,8 @@ Geolocal.configure do |config|
 end
 ```
 
-Now you can call `Geolocal.in_eu?(ip)`.  If the European Union ever changes,
-run `bundle update countries` and then `rake geolocal`.
+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.
 
 ## Providers
 
@@ -88,12 +91,11 @@ environments like Heroku.
 
 ## TODO
 
-- [ ] performance information?  benchmarks.  space saving by going ipv4-only?
 - [ ] include a Rails generator for the config file?
-- [ ] write a command that takes the config on the command line and writes the result to stdout?
+- [ ] performance information?  benchmarks.  space saving by going ipv4-only?
 - [ ] Add support for cities
-- [ ] replace Nokogiri dependency with a single regex?  Shame to force that dependency on all clients.
 - [ ] 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?
 - [ ] Add support for for-pay features like lat/lon and timezones?
 
 

data/geolocal.gemspec

@@ -17,9 +17,6 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  # hm...  this is only required when running 'rake download'.
-  spec.add_runtime_dependency "nokogiri"
-
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"

data/lib/geolocal/configuration.rb

@@ -1,5 +1,5 @@
 class Configuration
-  OPTIONS = [ :provider, :module, :file, :tmpdir, :expires, :ipv6, :quiet, :countries ]
+  OPTIONS = [ :provider, :module, :file, :tmpdir, :ipv4, :ipv6, :quiet, :countries ]
   attr_accessor(*OPTIONS)
 
   def initialize
@@ -8,7 +8,7 @@ class Configuration
     @module = 'Geolocal'
     @file = nil       # default is computed
     @tmpdir = 'tmp/geolocal'
-    @expires = nil    # provider chooses the most sensible
+    @ipv4 = true
     @ipv6 = true
     @quiet = false
     @countries = {}

data/lib/geolocal/provider/base.rb

@@ -13,20 +13,39 @@ module Geolocal
       end
 
       def download
-        # TODO: skip download if local files are new enough
-        # TODO: provide a FORCE argument to force download anyway
         download_files
       end
 
       def update
-        countries = config[:countries].merge(config[:countries]) { |name, country_codes|
-          Array(country_codes).map(&:upcase).to_set
+        countries = config[:countries].reduce({}) { |a, (k, v)|
+          a.merge! k.to_s.upcase => Array(v).map(&:upcase).to_set
         }
 
-        results = countries.merge(countries) { "" }
+        ipv4 = Socket::AF_INET  if config[:ipv4]
+        ipv6 = Socket::AF_INET6 if config[:ipv6]
 
-        read_ranges(countries) do |name,lo,hi|
-          results[name] << "#{IPAddr.new(lo).to_i}..#{IPAddr.new(hi).to_i},\n"
+        results = countries.keys.reduce({}) { |a, k|
+          a.merge! k.upcase+'v4' => '' if ipv4
+          a.merge! k.upcase+'v6' => '' if ipv6
+          a
+        }
+
+        read_ranges(countries) do |name,lostr,histr|
+          loaddr = IPAddr.new(lostr)
+          hiaddr = IPAddr.new(histr)
+          lofam = loaddr.family
+          hifam = hiaddr.family
+          raise "#{lostr} is family #{lofam} but #{histr} is #{hifam}" if lofam != hifam
+
+          if lofam == ipv4
+            namefam = name+'v4'
+          elsif lofam == ipv6
+            namefam = name+'v6'
+          else
+            raise "unknown family #{lofam} for #{lostr}"
+          end
+
+          results[namefam] << "#{loaddr.to_i}..#{hiaddr.to_i},\n"
         end
 
         File.open(config[:file], 'w') do |file|
@@ -36,15 +55,24 @@ module Geolocal
         status "done, result in #{config[:file]}\n"
       end
 
+      def up_to_date?(file, expiry)
+        return false unless File.exist?(file)
+        diff = Time.now - File.mtime(file)
+        if diff < expiry
+          status "using #{file} since it's #{diff.round} seconds old\n"
+          return true
+        end
+      end
+
       def output file, results
-        names = results.keys
         modname = config[:module]
 
-        write_header file, names, modname
+        write_header file, modname
 
-        file.write "module #{modname}\n"
-        names.each do |name|
-          write_method file, name
+        config[: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
         end
         file.write "end\n\n"
 
@@ -57,28 +85,40 @@ module Geolocal
       end
 
 
-      def write_header file, names, modname
+      def write_header file, modname
         file.write <<EOL
-# This file is autogenerated
-
-# Defines #{names.map { |n| "#{modname}.in_#{n}?" }.join(', ')}
-#     and #{names.map { |n| "#{modname}::#{n.upcase}" }.join(', ')}
+# This file is autogenerated by the Geolocal gem
+
+module #{modname}
+
+  def self.search address, family=nil, v4module, v6module
+    address = IPAddr.new(address) if address.is_a?(String)
+    family = address.family unless family
+    num = address.to_i
+    case family
+      when Socket::AF_INET  then mod = v4module
+      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
+    true if mod.bsearch { |range| num > range.max ? 1 : num < range.min ? -1 : 0 }
+  end
 
 EOL
       end
 
-      def write_method file, name
+      def write_method file, name, v4mod, v6mod
         file.write <<EOL
-  def self.in_#{name}? addr
-    num = addr.to_i
-    #{name.upcase}.bsearch { |range| num > range.max ? 1 : num < range.min ? -1 : 0 }
+  def self.in_#{name}? address, family=nil
+    search address, family, #{v4mod}, #{v6mod}
   end
+
 EOL
       end
 
       def write_ranges file, modname, name, body
         file.write <<EOL
-#{modname}::#{name.upcase} = [
+#{modname}::#{name} = [
 #{body}]
 
 EOL

data/lib/geolocal/provider/db_ip.rb

@@ -3,8 +3,6 @@ require 'net/http'
 require 'fileutils'
 require 'zlib'
 
-require 'nokogiri'
-
 
 class Geolocal::Provider::DB_IP < Geolocal::Provider::Base
   START_URL = 'https://db-ip.com/db/download/country'
@@ -34,9 +32,19 @@ class Geolocal::Provider::DB_IP < Geolocal::Provider::Base
   end
 
   def download_files
+    # they update the file every month but no idea which day they upload it
+    return if up_to_date?(csv_file, 86400)
+
     page = Net::HTTP.get(URI START_URL)
-    doc = Nokogiri::HTML(page)
-    href = URI.parse doc.css('a.btn-primary').attr('href').to_s
+
+    # if we used Nokogiri: (we don't since we don't want to force the dependency)
+    # doc = Nokogiri::HTML(page)
+    # href = URI doc.css('a.btn-primary').attr('href').to_s
+
+    elem = page.match(/<a\b[^>]*class=['"][^'"]*btn-primary[^>]*>/) or
+      raise "no <a class='btn-primary'> element found in #{START_URL}"
+    attr = elem.to_s.match(/href=['"]([^'"]+)['"]/) or raise "no href found in #{elem}"
+    href = URI attr[1]
 
     # stream result because it's large
     FileUtils.mkdir_p(config[:tmpdir])

data/lib/geolocal/version.rb

@@ -1,3 +1,3 @@
 module Geolocal
-  VERSION = "0.5"
+  VERSION = "0.6.1"
 end

data/spec/configuration_spec.rb

@@ -15,7 +15,7 @@ describe "configuration" do
     expect(defaults.module).to   eq 'Geolocal'
     expect(defaults.file).to     eq 'lib/geolocal.rb'
     expect(defaults.tmpdir).to   eq 'tmp/geolocal'
-    expect(defaults.expires).to  eq nil
+    expect(defaults.ipv4).to     eq true
     expect(defaults.ipv6).to     eq true
     expect(defaults.quiet).to    eq false
     expect(defaults.countries).to eq({})
@@ -67,7 +67,7 @@ describe "configuration" do
         module: 'Geolocal',
         file: 'lib/geolocal.rb',
         tmpdir: 'tmp/geolocal',
-        expires: nil,
+        ipv4: true,
         ipv6: true,
         quiet: true,
         countries: {}

data/spec/provider/base_spec.rb

@@ -0,0 +1,86 @@
+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

data/spec/provider/db_ip_spec.rb

@@ -36,6 +36,10 @@ describe Geolocal::Provider::DB_IP do
     end
 
     it 'can download the csv' do
+      Geolocal.configure do |config|
+        config.tmpdir = 'tmp/geolocal-test'
+      end
+
       # wow!!  can't do this in an around hook because it gets the ordering completely wrong.
       # since around hooks wrap ALL before hooks, they end up using the previous test's config.
       if File.exist?(provider.csv_file)
@@ -53,30 +57,47 @@ describe Geolocal::Provider::DB_IP do
   describe 'generating' do
     let(:example_output) {
       <<EOL
-# This file is autogenerated
-
-# Defines Geolocal.in_us?, Geolocal.in_au?
-#     and Geolocal::US, Geolocal::AU
+# This file is autogenerated by the Geolocal gem
 
 module Geolocal
-  def self.in_us? addr
-    num = addr.to_i
-    US.bsearch { |range| num > range.max ? 1 : num < range.min ? -1 : 0 }
+
+  def self.search address, family=nil, v4module, v6module
+    address = IPAddr.new(address) if address.is_a?(String)
+    family = address.family unless family
+    num = address.to_i
+    case family
+      when Socket::AF_INET  then mod = v4module
+      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
+    true if mod.bsearch { |range| num > range.max ? 1 : num < range.min ? -1 : 0 }
+  end
+
+  def self.in_us? address, family=nil
+    search address, family, USv4, USv6
   end
-  def self.in_au? addr
-    num = addr.to_i
-    AU.bsearch { |range| num > range.max ? 1 : num < range.min ? -1 : 0 }
+
+  def self.in_au? address, family=nil
+    search address, family, AUv4, AUv6
   end
+
 end
 
-Geolocal::US = [
+Geolocal::USv4 = [
 0..16777215,
 ]
 
-Geolocal::AU = [
+Geolocal::USv6 = [
+]
+
+Geolocal::AUv4 = [
 16777216..16777471,
 ]
 
+Geolocal::AUv6 = [
+]
+
 EOL
     }
 

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: geolocal
 version: !ruby/object:Gem::Version
-  version: '0.5'
+  version: 0.6.1
 platform: ruby
 authors:
 - Scott Bronson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-04 00:00:00.000000000 Z
+date: 2015-02-05 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -107,6 +93,7 @@ files:
 - 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/spec_helper.rb
 homepage: http://github.com/bronson/geolocal
@@ -136,5 +123,6 @@ 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/spec_helper.rb