countries 1.2.5 → 4.2.3

data/lib/countries/tasks/geocoding.rake

@@ -0,0 +1,97 @@
+require 'geocoder'
+require 'retryable'
+
+Geocoder.configure(
+  lookup: :google,
+  timeout: 10,
+  api_key: GOOGLE_API_KEY
+)
+
+# raise on geocoding errors such as query limit exceeded
+Geocoder.configure(always_raise: :all)
+# Try to geocode a given query, on exceptions it retries up to 3 times then gives up.
+# @param [String] query string to geocode
+# @return [Hash] first valid result or nil
+def geocode(query, params)
+  Retryable.retryable(tries: 3, sleep: ->(n) { 2**n }) do
+    Geocoder.search(query, params: params).first
+  end
+rescue => e
+  warn "Attempts exceeded for query #{query}, last error was #{e.message}"
+  nil
+end
+
+def load_country_yaml(alpha2)
+  YAML.load_file(File.join(ISO3166_ROOT_PATH, 'lib', 'countries', 'data', 'countries', "#{alpha2}.yaml"))
+end
+
+def save_country_yaml(alpha2, data)
+  File.open(File.join(ISO3166_ROOT_PATH, 'lib', 'countries', 'data', 'countries', "#{alpha2}.yaml"), 'w+') { |f| f.write data.to_yaml }
+end
+
+def country_codes
+  @country_codes ||= Dir['lib/countries/data/countries/*.yaml'].map { |x| File.basename(x, File.extname(x)) }.uniq
+end
+
+namespace :geocode do
+  desc 'Retrieve and store countries coordinates'
+  task :fetch_countries do
+    require 'countries'
+    # Iterate over countries
+    ISO3166::Country.all.each do |country|
+      code = country.alpha2
+      # Load unmutated yaml file.
+      data = load_country_yaml(country.alpha2)
+
+      next unless (result = geocode(country.iso_short_name, {region: country.alpha2}))
+      puts "WARNING:: Geocoder returned something that was not a country for #{country.alpha2}" unless result.types.include?('country')
+      geometry = result.geometry
+
+      # Extract center point data
+      if geometry['location']
+        data[code]['geo']['latitude'] = geometry['location']['lat']
+        data[code]['geo']['longitude'] = geometry['location']['lng']
+      end
+
+      # Extract bounding box data
+      next unless geometry['bounds']
+      data[code]['geo']['bounds'] = geometry['bounds']
+      data[code]['geo']['min_latitude'] = geometry['bounds']['southwest']['lat']
+      data[code]['geo']['min_longitude'] = geometry['bounds']['southwest']['lng']
+      data[code]['geo']['max_latitude'] = geometry['bounds']['northeast']['lat']
+      data[code]['geo']['max_longitude'] = geometry['bounds']['northeast']['lng']
+
+      # Persist
+      save_country_yaml(code, data)
+    end
+  end
+
+  desc 'Retrieve and store subdivisions coordinates'
+  task :fetch_subdivisions do
+    require_relative '../../countries'
+    # Iterate all countries with subdivisions
+    ISO3166::Country.all.select(&:subdivisions?).each do |c|
+      # Iterate subdivisions
+      state_data = c.subdivisions.dup
+      state_data.reject { |_, data| data['geo'] }.each do |code, data|
+        location = "#{c.alpha2}-#{code}"
+
+        next unless (result = geocode(location, {region: c.alpha2}))
+
+        geometry = result.geometry
+        if geometry['location']
+          state_data[code]['geo'] ||= {}
+          state_data[code]['geo']['latitude'] = geometry['location']['lat']
+          state_data[code]['geo']['longitude'] = geometry['location']['lng']
+        end
+        next unless geometry['bounds']
+        state_data[code]['geo']['min_latitude'] = geometry['bounds']['southwest']['lat']
+        state_data[code]['geo']['min_longitude'] = geometry['bounds']['southwest']['lng']
+        state_data[code]['geo']['max_latitude'] = geometry['bounds']['northeast']['lat']
+        state_data[code]['geo']['max_longitude'] = geometry['bounds']['northeast']['lng']
+      end
+      # Write updated YAML for current country
+      File.open(File.join(ISO3166_ROOT_PATH, 'lib', 'countries', 'data', 'subdivisions', "#{c.alpha2}.yaml"), 'w+') { |f| f.write state_data.to_yaml }
+    end
+  end
+end

data/lib/countries/tasks/postal_codes.rake

@@ -0,0 +1,48 @@
+namespace :postal_codes do
+  desc 'Retrieve and update postal codes and their format'
+  task :update do
+    require 'json'
+    require 'open-uri'
+    require 'yaml'
+
+    country_files = Dir['lib/countries/data/countries/*.yaml'].sort
+
+    country_files.each do |country_file|
+      yaml = YAML.load_file(country_file)
+      country_code = File.basename(country_file, File.extname(country_file))
+      print "\rUpdating #{country_code}"
+
+      data = yaml[country_code].to_a
+      postal_code_index = data.find_index { |d| d[0] == 'postal_code' }
+      postal_code_format_index = data.find_index { |d| d[0] == 'postal_code_format' }
+
+      response = URI.open("https://chromium-i18n.appspot.com/ssl-address/data/#{country_code}").read
+      json = JSON.parse(response) rescue {}
+      puts ' - Returned empty data. Skipping ' and next if json.empty?
+
+      postal_code = ['postal_code', !!json['zip']]
+      postal_code_format = ['postal_code_format', json['zip']]
+
+      if postal_code_index
+        data[postal_code_index] = postal_code
+      else
+        postal_code_index = data.find_index { |d| d[0] == 'nationality' } + 1 || data.size
+        data.insert(postal_code_index, postal_code)
+      end
+
+      if json['zip']
+        if postal_code_format_index
+          data[postal_code_format_index] = postal_code_format
+        else
+          data.insert(postal_code_index + 1, postal_code_format)
+        end
+      elsif postal_code_format_index
+        data.delete_at(postal_code_format_index)
+      end
+
+      yaml[country_code] = data.to_h
+
+      File.open(country_file, 'w') { |file| file.write(yaml.to_yaml) }
+    end
+  end
+end

data/lib/countries/timezones.rb

@@ -0,0 +1,13 @@
+module ISO3166
+  # Extend Country class with support for timezones. Requires the  {tzinfo}[https://github.com/tzinfo/tzinfo] gem
+  #
+  #   gem 'tzinfo'
+  #
+  module TimezoneExtensions
+    def timezones
+      @tz_country ||= TZInfo::Country.get(alpha2)
+    end
+  end
+end
+
+ISO3166::Country.send(:include, ISO3166::TimezoneExtensions)

data/lib/countries/translations.rb

@@ -0,0 +1,11 @@
+module ISO3166
+  # Extend the hash class to allow locale lookup fall back behavior
+  #
+  # E.g. if a country has translations for +pt+, and the user looks up +pt-br+ fallback
+  # to +pt+ to prevent from showing nil values
+  class Translations < Hash
+    def [](locale)
+      super(locale) || super(locale.to_s.sub(/-.*/, ''))
+    end
+  end
+end

data/lib/countries/version.rb

@@ -1,3 +1,3 @@
 module Countries
-  VERSION = '1.2.5'
+  VERSION = '4.2.3'.freeze
 end

data/lib/countries.rb

@@ -1,3 +1,5 @@
+require 'sixarm_ruby_unaccent'
+
 require 'countries/version'
 
 require 'countries/iso3166'

data/spec/00_global_spec.rb

@@ -0,0 +1,56 @@
+describe 'global Country class', order: :defined do
+  context "when loaded via 'iso3166' existence" do
+    subject { defined?(Country) }
+
+    it { is_expected.to be_falsey }
+  end
+
+  context "when loaded via 'global'" do
+    before { require 'countries/global' }
+
+    it 'does not pollute global namespace with Money gem' do
+      expect(defined?(Money)).not_to be
+      expect(ISO3166::Country.new('DE').respond_to?(:currency)).not_to be
+    end
+
+    describe 'existence' do
+      subject { defined?(Country) }
+
+      it { is_expected.to be_truthy }
+    end
+
+    describe 'superclass' do
+      subject { Country.superclass }
+
+      it { is_expected.to eq(ISO3166::Country) }
+    end
+
+    describe 'to_s' do
+      it 'should return the country name' do
+        expect(Country.new('GB').to_s).to eq('United Kingdom of Great Britain and Northern Ireland')
+      end
+    end
+
+    describe 'currency' do
+      it { expect(Country.new('GB').respond_to?(:currency)).not_to be }
+
+      context 'I enable currency extension via config' do
+        before { ISO3166.configuration.enable_currency_extension! }
+
+        it 'should add currency to global country' do
+          expect(Country.new('GB').currency).to be
+        end
+      end
+    end
+
+    context 'I enable currency extension via config' do
+      before { ISO3166.configuration.enable_currency_extension! }
+
+      it 'should add currency to global country' do
+        expect(Country.new('GB').currency).to be
+        expect(defined?(Money)).to be
+        expect(ISO3166::Country.new('DE').currency).to be
+      end
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'i18n'
+
+describe 'ISO3166.configuration' do
+  it 'has a configuration' do
+    expect(ISO3166.configuration).to be_a ISO3166::Configuration
+  end
+
+  it 'locales can be changed' do
+    ISO3166.configuration.locales = [:es]
+    ISO3166.configuration.locales << :de
+    expect(ISO3166::Country.new('DE').translation(:de)).to eq 'Deutschland'
+    expect(ISO3166::Country.new('DE').translation(:es)).to eq 'Alemania'
+    expect(ISO3166::Country.new('DE').translation(:en)).to eq nil
+  end
+
+  it 'locales are assumed from I18n.available_locales' do
+    I18n.available_locales = [:de, :en]
+    ISO3166.reset
+    expect(ISO3166::Country.new('DE').translation(:de)).to eq 'Deutschland'
+    expect(ISO3166::Country.new('DE').translation(:es)).to eq nil
+  end
+
+  it 'unsupported locales do not affect supported locales' do
+    I18n.available_locales = [:de, :en, :unsupported]
+    ISO3166.reset
+    expect(ISO3166::Country.new('DE').translation(:de)).to eq 'Deutschland'
+    expect(ISO3166::Country.new('DE').translation(:es)).to eq nil
+  end
+
+  it 'locales can be changed' do
+    ISO3166.configuration.locales = [:de]
+    expect(ISO3166::Country.new('DE').translation(:de)).to eq 'Deutschland'
+    expect(ISO3166::Country.new('DE').translation(:es)).to eq nil
+  end
+
+  it 'locales can be changed' do
+    ISO3166.configuration.locales = [:es, :de, :en]
+    expect(ISO3166::Country.new('DE').translation(:es)).to eq 'Alemania'
+    expect(ISO3166::Country.new('DE').translation(:en)).to eq 'Germany'
+    expect(ISO3166::Country.new('DE').translation(:de)).to eq 'Deutschland'
+  end
+
+  it 'locales can be changed with a block' do
+    ISO3166.configure do |config|
+      config.locales = [:af, :am, :ar, :as, :az, :be, :bg, :bn, :br, :bs, :ca, :cs, :cy, :da, :de, :dz, :el, :en, :eo, :es, :et, :eu, :fa, :fi, :fo, :fr, :ga, :gl, :gu, :he, :hi, :hr, :hu, :hy, :ia, :id, :is, :it, :ja, :ka, :kk, :km, :kn, :ko, :ku, :lt, :lv, :mi, :mk, :ml, :mn, :mr, :ms, :mt, :nb, :ne, :nl, :nn, :oc, :or, :pa, :pl, :ps, :pt, :ro, :ru, :rw, :si, :sk, :sl, :so, :sq, :sr, :sv, :sw, :ta, :te, :th, :ti, :tk, :tl, :tr, :tt, :ug, :uk, :ve, :vi, :wa, :wo, :xh, :zh, :zu]
+    end
+
+    expect(ISO3166::Country.new('DE').translations.size).to eq 92
+
+    expect(ISO3166.configuration.loaded_locales.size).to eq 92
+  end
+end