ceps 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e6c5306fd2ad80bdd6663776b0d48fccf445f21
-  data.tar.gz: 4235a3a60f49cbcca3be83d5bd81475a20558d03
+  metadata.gz: 8b3a7b380c76920d10a307a1e23f28bdf5d2a407
+  data.tar.gz: 70d587c1ed83c16db19eafb6977d0a636ac8690e
 SHA512:
-  metadata.gz: 191cb4ec2fceaabbf1d9d17c379025f93245bfa945eb8a33212c79dbfa2689314b696f1976d96e900e2f008c4e3485befb45fc782fcd2ba0f306122b1e394d69
-  data.tar.gz: ac54e7a5d459cb408d8be745c6dc93afbca1ba1dc758b34466bf44832e07ac054672123595f45b10ddc59238ff0354109528d6cf8942520d5850994b124ce7e7
+  metadata.gz: c8a6379551b631c0c6b74b2f0538ac7ce329f195042fd510a3a82cbfa490f1be4d2243bc00cd0b757f11dff46a0dbbaa98b67030492029745026aad5e50df97f
+  data.tar.gz: e8c19492b98dc4c912ff11df30b04493bc00c0c04030d22c945e5b86af6ca661988faf771fbdb94fd85d426244e2052163447d7aca79fc90dfdde79fd1df9de6

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+*.swp
+*.swo
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.2.0

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+gem 'rake'
+gem 'mdb'
+gem 'ruby-progressbar'
+# gem 'geocoder'
+# gem 'retryable'
+
+# Specify your gem's dependencies in countries.gemspec
+gemspec

data/README.md

@@ -0,0 +1,43 @@
+CEPs
+====
+
+Ceps is a collection of all sorts of useful information about every brazilian CEP packaged as pretty little cep objects.
+
+[![Build Status](https://travis-ci.org/theprogramer/ceps.png)](https://travis-ci.org/theprogramer/ceps)
+
+Installation
+------------
+
+    gem install ceps
+
+Basic Usage
+-----------
+
+Simply load a new CEP object using Cep.new(23045000) or the shortcut Cep[23045000].
+
+    c = Cep.new(23045400)
+    c = Cep.new[23045400]
+
+Cep Info
+--------
+
+  Address
+
+    c.location     #=> "Peter Pan"
+    c.type         #=> "Rua"
+    c.neighborhood #=> "Campo Grande"
+    c.city         #=> "Rio de Janeiro"
+    c.state        #=> "Rio de Janeiro"
+
+ToDo
+----
+
+* Geocoding
+* Tests
+* Import scripts
+
+Note about GPBe (Guia Postal Brasileiro Eletrônico)
+---------------------------------------------------
+
+To generate ceps.yaml data file it is necessary get a valid version of a GPBe.
+GPBe is property of Correios do Brasil SA.

data/Rakefile

@@ -0,0 +1,55 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+
+require 'rake'
+require 'rspec/core/rake_task'
+
+desc 'Run all examples'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w(--color --warnings)
+end
+
+task default: [:spec]
+
+
+desc 'Import MDB file'
+task :import do
+
+  require 'mdb'
+  require_relative 'lib/ceps/mdb'
+  require 'ruby-progressbar'
+
+  db = Mdb.open ARGV[1]
+  puts "Loading routes"
+  puts "This should take some time!"
+  routes = db["LOG_LOGRADOURO"]
+  puts "Loading neighborhoods"
+  neighborhoods = db["LOG_BAIRRO"]
+  puts "Loading cities"
+  cities = db["LOG_LOCALIDADE"]
+  puts "Loading states"
+  states = db["LOG_FAIXA_UF"]
+  
+  ceps = {}
+  puts "Generating new hash"
+  progressbar = ProgressBar.create title: "Progress",
+                                   starting_at: 0,
+                                   total: routes.count,
+                                   format: "%c from %C |%b>>%i| %a (%e) %p%%"
+  routes.each do |route|
+    cep = Correios::Mdb.decript route[:LOG_KEY_DNE]
+    ceps[cep.to_sym] = {
+      location: route[:LOG_NO],
+      type: route[:LOG_TIPO_LOGRADOURO],
+      city: cities.select{|c| c[:LOC_NU_SEQUENCIAL] == route[:LOC_NU_SEQUENCIAL].to_s}.first[:LOC_NO],
+      state: states.select{|s| s[:UFE_SG] == route[:UFE_SG]}.first[:UFE_NO],
+      neighborhood: neighborhoods.select{|n| n[:BAI_NU_SEQUENCIAL] == route[:BAI_NU_SEQUENCIAL_INI].to_s}.first[:BAI_NO]
+    }
+    progressbar.increment
+    progressbar.refresh
+  end
+  puts "Saving new ceps.yaml"
+  File.open('ceps.yml','w') do |h| 
+    h.write ceps.to_yaml
+  end
+end

data/lib/ceps/mdb.rb

@@ -0,0 +1,38 @@
+module Correios
+  
+  class Mdb
+
+    def self.decript(cep = "")
+      decripted = ""
+      unless cep.empty?
+      	cep.scan(/../).each do |k|
+      	  case k
+            when "X8", "CN", "8X", "NC"
+          	  decripted << "1"
+            when "Z0", "EP", "0Z", "PE"
+          	  decripted << "2"
+            when "1B", "GR", "B1", "RG"
+          	  decripted << "3"
+            when "3D", "ID", "D3", "DI"
+          	  decripted << "4"
+            when "4C", "JS", "C4", "SJ"
+          	  decripted << "5"
+            when "2A", "HQ", "A2", "QH"
+          	  decripted << "6"
+            when "09", "FO", "90", "OF"
+          	  decripted << "7"
+            when "Y7", "DM", "7Y", "MD"
+          	  decripted << "8"
+            when "5V", "BK", "V5", "KB"
+              decripted << "9"
+            when "UG", "AL", "GU", "LA"
+          	  decripted << "0"
+          end
+        end
+      end
+      decripted
+    end
+
+  end
+
+end

data/lib/ceps/version.rb

@@ -1,3 +1,3 @@
 module Ceps
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/data/ceps.yaml

@@ -2,24 +2,24 @@
 10000000:
   location: Paulista
   type: Rua
-  neighbourhood: Centro
+  neighborhood: Centro
   city: São Paulo
   state: São Paulo
 20000000:
   location: Carioca
   type: Rua
-  neighbourhood: Centro
+  neighborhood: Centro
   city: Rio de Janeiro
   state: Rio de Janeiro
 20000500:
   location: Carioquinha
   type: Avenida
-  neighbourhood: Copacabana
+  neighborhood: Copacabana
   city: Rio de Janeiro
   state: Rio de Janeiro
 30000000:
   location: Mineira
   type: Avenida
-  neighbourhood: Centro
+  neighborhood: Centro
   city: Belo Horizonte
   state: Minas Gerais

data/spec/cep_spec.rb

@@ -0,0 +1,85 @@
+# encoding: utf-8
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Correios::Cep do
+  
+  let(:cep) { Correios::Cep.new(20000000) }
+
+  it 'allows to create a cep object from an integer' do
+    cep = described_class.new(20000000)
+    expect(cep.data).not_to be_nil
+  end
+
+  it 'should return Carioca location' do
+    expect(cep.location).to eq('Carioca')
+  end
+
+  it 'should return Rua type' do
+    expect(cep.type).to eq('Rua')
+  end
+
+  it 'should return Centro neighborhood' do
+    expect(cep.neighborhood).to eq('Centro')
+  end
+
+  it 'should return Rio de Janeiro city name' do
+    expect(cep.city).to eq('Rio de Janeiro')
+  end
+
+  it 'should return Rio de Janeiro state name' do
+    expect(cep.state).to eq('Rio de Janeiro')
+  end
+
+  describe 'valid?' do
+    it 'should return true if cep is valid' do
+      expect(Correios::Cep.new(10000000)).to be_valid
+    end
+
+    it 'should return false if cep is invalid' do
+      expect(Correios::Cep.new({})).not_to be_valid
+    end
+  end
+
+  describe 'new' do
+    it 'should return new cep object when a valid cep string is passed' do
+      expect(Correios::Cep.new(20000000)).to be_a(Correios::Cep)
+    end
+
+    it 'should return nil when an invalid cep is passed' do
+      expect(Correios::Cep.new(00000000)).to be_nil
+    end
+
+  end
+
+  describe 'Cep class' do
+    context "when loaded via 'Correios' existance" do
+      subject { defined?(Cep) }
+
+      it { is_expected.to be_falsey }
+    end
+
+    context "when loaded via 'ceps'" do
+      before { require 'ceps' }
+
+      describe 'existance' do
+        subject { defined?(Cep) }
+
+        it { is_expected.to be_truthy }
+      end
+
+      describe 'superclass' do
+        subject { Cep.superclass }
+
+        it { is_expected.to eq(Correios::Cep) }
+      end
+
+      # describe 'to_s' do
+      #   it 'should return the cep key' do
+      #     expect(Cep.new(20000000).to_s).to eq('20000-000')
+      #   end
+      # end
+    end
+  end
+
+end

data/spec/setup_spec.rb

@@ -0,0 +1,10 @@
+# enconding: utf-8
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Correios::Setup do
+  let(:setup) { Correios::Setup.new }
+
+  it 'responds to ceps' do
+    expect(setup.ceps).to be_a Hash
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'correios'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ceps
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Thiago Miranda
@@ -33,14 +33,22 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
 - README.md
+- Rakefile
 - ceps.gemspec
 - lib/ceps.rb
 - lib/ceps/cep.rb
+- lib/ceps/mdb.rb
 - lib/ceps/setup.rb
 - lib/ceps/version.rb
 - lib/correios.rb
 - lib/data/ceps.yaml
+- spec/cep_spec.rb
+- spec/setup_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/theprogramer/ceps
 licenses: []
 metadata: {}
@@ -64,4 +72,7 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Gives you a cep object full of all sorts of useful information.
-test_files: []
+test_files:
+- spec/cep_spec.rb
+- spec/setup_spec.rb
+- spec/spec_helper.rb