geolocal 0.8.1 → 0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47113ceb0b482073f831d29622e2bc7beb06131f
-  data.tar.gz: b311e669ffa4b394edc577e6d4d20c307366872b
+  metadata.gz: 65d27c3ffbd6c516bc62cb08663fd536472a24ef
+  data.tar.gz: 85c77e798dab700c8ddb602fce533fad7794b46a
 SHA512:
-  metadata.gz: d66866807b4ac24c99024652453cdbd677f0ea1689df1aa367832bf49e9071e1b295f0ec9293c8fe8f5aac703b2eddeba745254ed4d46de94dd145d1adb4db75
-  data.tar.gz: b0ab1135e3bc4b53af4849dd6ed8163c951a78e66c01d6e12c5c28bc1b6b6cc0227ca61f99d7b9c9101fd92c69ffb24c737f269bceff30b10500f8689199c94f
+  metadata.gz: 8e94cb66a6465c12d7b8111fc99eca1cc2a800bcc7e0e98abfbe42f690cb03ba835ba88665be74330e85eeb9e314bcd8ee98f902ff9fcad989b9717455047cbe
+  data.tar.gz: c97b4d0bc05f06481587c39b1410450036cf83887ee2188870b2e007c6a940914382c44e4a7bea0076a342fa400c098ab1b61f7f5ac52dcc6ff0f8edfc1f192c

data/README.md

@@ -24,6 +24,7 @@ The config file describes the ranges you're interested in.
 Here's an example:
 
 ```ruby
+require 'geolocal/configuration'
 Geolocal.configure do |config|
   config.countries = {
     us: 'US',
@@ -38,6 +39,7 @@ from the default provider (see the [providers](#providers) section) and
 creates the desired methods:
 
 ```ruby
+require 'geolocal'
 Geolocal.in_us?(request.remote_ip)
 Geolocal.in_spain?('2a05:af06::')  # optional IPv6 support
 Geolocal.in_central_america?('200.16.66.0')

data/config/geolocal.rb

@@ -1,4 +1,4 @@
-require 'geolocal'
+require 'geolocal/configuration'
 
 Geolocal.configure do |config|
   # This example creates a Geolocal.in_us?(addr) command:

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

@@ -1,4 +1,4 @@
-require 'geolocal'
+require 'geolocal/configuration'
 
 Geolocal.configure do |config|
   # This example creates a Geolocal.in_us?(addr) command:

data/lib/geolocal.rb

@@ -1,32 +1,5 @@
-require 'geolocal/version'
-require 'geolocal/configuration'
-require 'geolocal/provider/base'
-
-
+# If you're wondering why nothing's here, you probably wanted to require 'geolocal/configuration'
+# Once you define a configuration and generate the geolocation code, this module will have contents.
 module Geolocal
   require 'geolocal/railtie' if defined? Rails
-
-  def self.configuration
-    @configuration ||= Configuration.new
-  end
-
-  def self.configure
-    yield(configuration)
-  end
-
-  def self.reset_configuration
-    @configuration = nil
-  end
-
-  def self.provider
-    @provider ||= configuration.load_provider.new
-  end
-
-  def self.download
-    provider.download
-  end
-
-  def self.update
-    provider.update
-  end
 end

data/lib/geolocal/configuration.rb

@@ -1,45 +1,60 @@
-class Configuration
-  OPTIONS = [ :provider, :module, :file, :tmpdir, :ipv4, :ipv6, :quiet, :countries ]
-  attr_accessor(*OPTIONS)
-
-  def initialize
-    # configuration defaults
-    @provider = 'Geolocal::Provider::DB_IP'
-    @module = 'Geolocal'
-    @file = nil       # default is computed
-    @tmpdir = 'tmp/geolocal'
-    @ipv4 = true
-    @ipv6 = true
-    @quiet = false
-    @countries = {}
-  end
+module Geolocal
+  class Configuration
+    OPTIONS = [ :provider, :module, :file, :tmpdir, :ipv4, :ipv6, :quiet, :countries ]
+    attr_accessor(*OPTIONS)
 
-  # if not set, defaults to lib/module-name
-  def file
-    @file || "lib/#{module_file @module}.rb"
-  end
+    def initialize
+      # configuration defaults
+      @provider = 'Geolocal::Provider::DB_IP'
+      @module = 'Geolocal'
+      @file = nil       # default is computed
+      @tmpdir = 'tmp/geolocal'
+      @ipv4 = true
+      @ipv6 = true
+      @quiet = false
+      @countries = {}
+    end
+
+    # if not set, defaults to lib/module-name
+    def file
+      @file || "lib/#{module_file @module}.rb"
+    end
+
+    def require_provider_file
+      begin
+        # normal ruby/gem load path
+        Kernel.require module_file(@provider)
+      rescue LoadError
+        # used when running source code locally
+        Kernel.require "./lib/#{module_file(@provider)}.rb"
+      end
+    end
+
+    def load_provider
+      require_provider_file
+      @provider.split('::').reduce(Module, :const_get)
+    end
 
-  def require_provider_file
-    begin
-      # normal ruby/gem load path
-      Kernel.require module_file(@provider)
-    rescue LoadError
-      # used when running source code locally
-      Kernel.require "./lib/#{module_file(@provider)}.rb"
+    def to_hash
+      # returned keys will always be symbols
+      OPTIONS.reduce({}) { |a,v| a.merge! v => self.send(v) }
+    end
+
+    def module_file modname
+      modname.gsub('::', '/').gsub(/([a-z])([A-Z])/, '\1_\2').downcase
     end
   end
 
-  def load_provider
-    require_provider_file
-    @provider.split('::').reduce(Module, :const_get)
+
+  def self.configuration
+    @configuration ||= Configuration.new
   end
 
-  def to_hash
-    # returned keys will always be symbols
-    OPTIONS.reduce({}) { |a,v| a.merge! v => self.send(v) }
+  def self.configure
+    yield(configuration)
   end
 
-  def module_file modname
-    modname.gsub('::', '/').gsub(/([a-z])([A-Z])/, '\1_\2').downcase
+  def self.reset_configuration
+    @configuration = nil
   end
 end

data/lib/geolocal/provider/base.rb

@@ -47,7 +47,7 @@ module Geolocal
       end
 
       def countries
-        @countries ||= config[:countries].sort_by { |k, v| k }.reduce({}) { |a, (k, v)|
+        @countries ||= config[:countries].sort_by { |k, v| k.to_s }.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

data/lib/geolocal/provider/db_ip.rb

@@ -1,3 +1,5 @@
+require 'geolocal/provider/base'
+
 require 'csv'
 require 'net/http'
 require 'fileutils'
@@ -69,6 +71,7 @@ class Geolocal::Provider::DB_IP < Geolocal::Provider::Base
   end
 
   # a bit of debugging code to print all non-matched country codes.  should be deleted one day.
+  # The Countries gem doesn't know about these country codes from the csv: CS FX UK YU TP and blank
   def check_country_codes(countries, row)
     @known_codes ||= countries.reduce(Set.new) { |a,(_,v)| a.merge v; a }
     unless @known_codes.include?(row[2])

data/lib/geolocal/version.rb

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

data/lib/tasks/geolocal.rake

@@ -7,18 +7,18 @@ config='config/geolocal'
 #     `rake geolocal config=contrib/continents`
 config=ENV['config'] if ENV['config']
 puts "loading geolocal configuration from #{config}"
-require './'+config
+require './' + config
 
 
 namespace :geolocal do
   desc "Downloads the most recent geocoding information"
   task :download do
-    Geolocal.download
+    Geolocal.configuration.load_provider.new.download
   end
 
   desc "Updates your geocoding statements to use new data."
   task :update => :download do
-    Geolocal.update
+    Geolocal.configuration.load_provider.new.update
   end
 end
 

data/spec/geolocal/provider/base_spec.rb

@@ -50,7 +50,7 @@ describe Geolocal::Provider::Base do
   describe '#countries' do
     it 'preprocesses the countries' do
       Geolocal.configure do |config|
-        config.countries = { ua: :UA, na: ['MX', 'CA', :US] }
+        config.countries = { ua: :UA, Na: ['MX', 'CA', :US] }
       end
 
       expect(provider.countries).to eq({ 'na' => Set['CA', 'MX', 'US'], 'ua' => Set['UA'] })
@@ -58,7 +58,7 @@ describe Geolocal::Provider::Base do
 
     it 'preprocesses countries with an odd name' do
       Geolocal.configure do |config|
-        config.countries = { 'U s-a': 'US', 'Mex': 'MX' }
+        config.countries = { 'U s-a' => 'US', mex: 'MX' }
       end
 
       expect(provider.countries).to eq({ 'mex' => Set['MX'], 'u_s_a' => Set['US'] })

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-require 'geolocal'
+require 'geolocal/configuration'
 require 'webmock/rspec'
 
 WebMock.disable_net_connect!(allow_localhost: true)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geolocal
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: '0.9'
 platform: ruby
 authors:
 - Scott Bronson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-08 00:00:00.000000000 Z
+date: 2015-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler