spain_zip_codes 0.0.1

data/lib/spain_zip_codes/data/zip_provinces_es.yml

@@ -0,0 +1,53 @@
+provinces:
+  '01': Álava
+  '02': Albacete
+  '03': Alicante
+  '04': Almería
+  '05': Ávila
+  '06': Badajoz
+  '07': Baleares (Palma de Mallorca)
+  '08': Barcelona
+  '09': Burgos
+  '10': Cáceres
+  '11': Cádiz
+  '12': Castellón
+  '13': Ciudad Real
+  '14': Córdoba
+  '15': Coruña
+  '16': Cuenca
+  '17': Gerona
+  '18': Granada
+  '19': Guadalajara
+  '20': Guipúzcoa (San Sebastián)
+  '21': Huelva
+  '22': Huesca
+  '23': Jaén
+  '24': León
+  '25': Lérida
+  '26': La Rioja (Logroño)
+  '27': Lugo
+  '28': Madrid
+  '29': Málaga
+  '30': Murcia
+  '31': Navarra (Pamplona)
+  '32': Orense
+  '33': Asturias
+  '34': Palencia
+  '35': Las Palmas
+  '36': Pontevedra
+  '37': Salamanca
+  '38': Santa Cruz de Tenerife
+  '39': Cantabria
+  '40': Segovia
+  '41': Sevilla
+  '42': Soria
+  '43': Tarragona
+  '44': Teruel
+  '45': Toledo
+  '46': Valencia
+  '47': Valladolid
+  '48': Vizcaya
+  '49': Zamora
+  '50': Zaragoza
+  '51': Ceuta
+  '52': Melilla

data/lib/spain_zip_codes/locationer.rb

@@ -0,0 +1,47 @@
+require 'yaml'
+
+# This class has duplicated code some way, but I prefer to keep the methods
+# separated even if they are the same so they are easier to change in the future
+
+module SpainZipCodes
+  class Locationer
+    SOURCE_YAML = %w(lib spain_zip_codes data zip_locations_es.yml).join('/')
+    LOCATIONS   = YAML.load_file(SOURCE_YAML)['locations']
+    SLUGS_YAML  = %w(lib spain_zip_codes data slug_locations_es.yml).join('/')
+    SLUGS_LOCS  = YAML.load_file(SLUGS_YAML)['locations']
+
+    def self.to_location(zip)
+      location = false
+
+      LOCATIONS.keys.each do |key|
+        if LOCATIONS[key].include?(zip)
+          location = key
+          break
+        end
+      end
+
+      location
+    end
+
+    def self.to_zip(location)
+      LOCATIONS[location] || []
+    end
+
+    def self.slug_to_zip(location_slug)
+      SLUGS_LOCS[location_slug] || []
+    end
+
+    def self.zip_to_slug(zip)
+      slug = false
+
+      SLUGS_LOCS.keys.each do |key|
+        if SLUGS_LOCS[key].include?(zip)
+          slug = key
+          break
+        end
+      end
+
+      slug
+    end
+  end
+end

data/lib/spain_zip_codes/provincer.rb

@@ -0,0 +1,21 @@
+require 'yaml'
+
+module SpainZipCodes
+  class Provincer
+    SOURCE_YAML = %w(lib spain_zip_codes data zip_provinces_es.yml).join('/')
+    PROVINCES   = YAML.load_file(SOURCE_YAML).fetch('provinces')
+
+    def self.to_province(zip)
+      return false unless zip.is_a?(String) && zip.length == 5
+
+      truncated_zip = zip[0, 2]
+      PROVINCES[truncated_zip]
+    end
+
+    def self.to_zip(province)
+      zip_prefix = PROVINCES.key(province)
+      return false unless province.length > 0
+      zip_prefix
+    end
+  end
+end

data/lib/spain_zip_codes/version.rb

@@ -0,0 +1,3 @@
+module SpainZipCodes
+  VERSION = '0.0.1'
+end

data/spain_zip_codes.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+require File.expand_path('../lib/spain_zip_codes/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'spain_zip_codes'
+  spec.version       = SpainZipCodes::VERSION
+  spec.authors       = ['Luismi Ramírez', 'Gustavo Caso']
+  spec.email         = ['luismir89@gmail.com', 'gustavocaso@gmail.com']
+  spec.summary       = %q{Obtain provinces and locations based on zip code}
+  spec.homepage      = 'https://github.com/luismiramirez/spain_zip_codes'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.gsub(/\x00/, ',').split(',')
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'simplecov'
+end

data/spec/locationer_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe 'Locationer' do
+  before(:each) do
+    @locationer = SpainZipCodes::Locationer
+  end
+
+  describe '#to_location' do
+    context 'with existing zip code' do
+      it 'returns the correct location' do
+        expect(@locationer.to_location('28922')).to eq('Alcorcón')
+      end
+    end
+
+    context 'with integer zip code' do
+      it 'returns false' do
+        expect(@locationer.to_location(22244)).to be false
+      end
+    end
+
+    context 'with unexisting zip code' do
+      it 'returns false' do
+        expect(@locationer.to_location(222999)).to be false
+      end
+    end
+  end
+
+  describe '#to_zip' do
+    context 'with existing location' do
+      it 'returns an array of zip codes' do
+        expected_result = %w(28920 28921 28922 28923 28924 28925)
+
+        expect(@locationer.to_zip('Alcorcón')).to eq(expected_result)
+      end
+    end
+
+    context 'with unexisting location' do
+      it 'returns an empty array' do
+        expect(@locationer.to_zip('Jamón Serrano')).to eq([])
+      end
+    end
+  end
+
+  describe '#slug_to_zip' do
+    context 'with existing slug' do
+      it 'returns an array of zip codes' do
+        expected_result = %w(28920 28921 28922 28923 28924 28925)
+
+        expect(@locationer.slug_to_zip('alcorcon')).to eq(expected_result)
+      end
+    end
+
+    context 'with unexisting slug' do
+      it 'returns an empty array' do
+        expect(@locationer.slug_to_zip('el-tiroriro')).to eq([])
+      end
+    end
+  end
+
+  describe '#zip_to_slug' do
+    context 'with existing zip code' do
+      it 'returns the correct slug' do
+        expect(@locationer.zip_to_slug('28922')).to eq('alcorcon')
+      end
+    end
+
+    context 'with integer zip code' do
+      it 'returns false' do
+        expect(@locationer.zip_to_slug(66998)).to be false
+      end
+    end
+
+    context 'with unexisting zip code' do
+      it 'returns false' do
+        expect(@locationer.zip_to_slug('6969699')).to be false
+      end
+    end
+  end
+end

data/spec/provincer_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe 'Provincer' do
+  before(:each) do
+    @provincer = SpainZipCodes::Provincer
+  end
+
+  describe '#to_province' do
+    context 'with existing zip code' do
+      it 'returns the correct province' do
+        expect(@provincer.to_province('28047')).to eq('Madrid')
+        expect(@provincer.to_province('08033')).to eq('Barcelona')
+      end
+    end
+
+    context 'with integer zip code' do
+      it 'returns false' do
+        expect(@provincer.to_province(28047)).to be false
+      end
+    end
+
+    context 'with unexisting string zip code' do
+      it 'returns false' do
+        expect(@provincer.to_province(975890)).to be false
+      end
+    end
+  end
+
+  describe '#to_zip' do
+    context 'with existing province' do
+      it 'returns the correct zip prefix' do
+        expect(@provincer.to_zip('Madrid')).to eq('28')
+      end
+    end
+
+    context 'with unexisting province' do
+      it 'returns false' do
+        expect(@provincer.to_province('Gallifrey')).to be false
+      end
+    end
+  end
+end

data/spec/spain_zip_codes_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe 'SpainZipCodes' do
+  before(:each) do
+    @provincer  = SpainZipCodes::Provincer
+    @locationer = SpainZipCodes::Locationer
+  end
+
+  describe '#zip_to_province' do
+    it 'calls Provincer#to_province with params' do
+      zip = '28047'
+
+      expect(@provincer).to receive(:to_province).with(zip)
+
+      SpainZipCodes.zip_to_province(zip)
+    end
+  end
+
+  describe '#province_to_zip' do
+    it 'calls Provincer#to_zip with params' do
+      province = 'Madrid'
+
+      expect(@provincer).to receive(:to_zip).with(province)
+
+      SpainZipCodes.province_to_zip(province)
+    end
+  end
+
+  describe '#zip_to_location' do
+    it 'calls Locationer#to_zip with params' do
+      zip = '28047'
+
+      expect(@locationer).to receive(:to_location).with(zip)
+
+      SpainZipCodes.zip_to_location(zip)
+    end
+  end
+
+  describe '#location_to_zip' do
+    it 'calls Locationer#to_zip with params' do
+      location = 'Fuenlabrada'
+
+      expect(@locationer).to receive(:to_zip).with(location)
+
+      SpainZipCodes.location_to_zip(location)
+    end
+  end
+
+  describe '#location_slug_to_zip' do
+    it 'calls Locationer#slug_to_zip with params' do
+      location_slug = 'alcorcon'
+
+      expect(@locationer).to receive(:slug_to_zip).with(location_slug)
+
+      SpainZipCodes.location_slug_to_zip(location_slug)
+    end
+  end
+
+  describe '#zip_to_location_slug' do
+    it 'calls Locationer#zip_to_slug with params' do
+      zip = '28922'
+
+      expect(@locationer).to receive(:zip_to_slug).with(zip)
+
+      SpainZipCodes.zip_to_location_slug(zip)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'spain_zip_codes'

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: spain_zip_codes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Luismi Ramírez
+- Gustavo Caso
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  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
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- luismir89@gmail.com
+- gustavocaso@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/spain_zip_codes.rb
+- lib/spain_zip_codes/data/slug_locations_es.yml
+- lib/spain_zip_codes/data/zip_locations_es.yml
+- lib/spain_zip_codes/data/zip_provinces_es.yml
+- lib/spain_zip_codes/locationer.rb
+- lib/spain_zip_codes/provincer.rb
+- lib/spain_zip_codes/version.rb
+- spain_zip_codes.gemspec
+- spec/locationer_spec.rb
+- spec/provincer_spec.rb
+- spec/spain_zip_codes_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/luismiramirez/spain_zip_codes
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Obtain provinces and locations based on zip code
+test_files:
+- spec/locationer_spec.rb
+- spec/provincer_spec.rb
+- spec/spain_zip_codes_spec.rb
+- spec/spec_helper.rb