validates-correios-cep 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb20df2b7029387821c5993e1454d0eeaa2cb52b
+  data.tar.gz: 6613876482cdfba84d3b1da856d91ffc07f72cc9
+SHA512:
+  metadata.gz: 6a0f49bf0ad5b029a84644b5e4106d91a6ac354751dd7b8017866bed389cf9c065085ba72769bc7285ce2da2014a9c4f8301b314469b9165506e83642e0e00c9
+  data.tar.gz: 759c2a4ec6508f18e788a84cd7c25219e88a707675cd723a06064438f0397f5c008fe1ec51ea80e2e0bf5df366f75cc23648efdec21f46184a4af8a4ffef4864

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+sftp-config.json

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Pedro Furtado
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,68 @@
+# validates-correios-cep
+
+[![Gem Version](https://badge.fury.io/rb/validates-correios-cep.svg)](https://badge.fury.io/rb/validates-correios-cep)
+[![Gem](https://img.shields.io/gem/dt/validates-correios-cep.svg)]()
+[![license](https://img.shields.io/github/license/pedrofurtado/validates-correios-cep.svg)]()
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'validates-correios-cep'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install validates-correios-cep
+
+## Usage
+
+### ActiveRecord models
+```ruby
+class Person < ActiveRecord::Base
+  validates :my_attribute, correios_cep: true
+
+  # or
+
+  validates_correios_cep_of :my_attribute
+end
+```
+
+### Plain Old Ruby Objects
+```ruby
+class Person
+  include ActiveModel::Model
+
+  validates :my_attribute, correios_cep: true
+
+  # or
+
+  validates_correios_cep_of :my_attribute
+end
+```
+
+## I18n
+
+To customize your error messages you can create a locale file like this:
+
+```yaml
+en:
+  correios_cep:
+    errors:
+      messages:
+        not_exists: '%{zipcode} is not a existent Brazilian zipcode'
+        connection_failed: 'failure on connection with Brazilian Correios API'
+        invalid: '%{zipcode} is not a valid Brazilian zipcode'
+        timeouted: 'timeout with Brazilian Correios API'
+```
+
+The %{zipcode} contains the zipcode value, filled by user.
+
+## Something wrong with the translations? Contribute it!
+
+Send a pull request! Fix the translations or create it for some missing locale. Help us to improves the quality of translations!

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/config/locales/de.yml

@@ -0,0 +1,8 @@
+de:
+  correios_cep:
+    errors:
+      messages:
+        not_exists: '%{zipcode} es ist nicht eine bestehende brasilianische Postleitzahl'
+        connection_failed: 'fehler bei der API der Post in Brasilien verbinden'
+        invalid: '%{zipcode} es ist keine gültige brasilianische Postleitzahl'
+        timeouted: 'timeout-Antwort mit dem Beitrag API'

data/config/locales/en.yml

@@ -0,0 +1,8 @@
+en:
+  correios_cep:
+    errors:
+      messages:
+        not_exists: '%{zipcode} is not a existent Brazilian zipcode'
+        connection_failed: 'failure on connection with Brazilian Correios API'
+        invalid: '%{zipcode} is not a valid Brazilian zipcode'
+        timeouted: 'timeout with Brazilian Correios API'

data/config/locales/es.yml

@@ -0,0 +1,8 @@
+es:
+  correios_cep:
+    errors:
+      messages:
+        not_exists: '%{zipcode} no es una código postal brasileño existente'
+        connection_failed: 'no se pudo conectar a la API de Correos en Brasil'
+        invalid: '%{zipcode} no es un código postal brasileño válido'
+        timeouted: 'tiempo agotado de respuesta de salida a la API de Correos en Brasil'

data/config/locales/fr.yml

@@ -0,0 +1,8 @@
+fr:
+  correios_cep:
+    errors:
+      messages:
+        not_exists: '%{zipcode} il est pas un code postal brésilien existant'
+        connection_failed: "impossible de se connecter à l'API du bureau de poste au Brésil"
+        invalid: '%{zipcode} il est pas un code postal valide brésilien'
+        timeouted: "réponse du délai d'attente avec l'API Poster"

data/config/locales/it.yml

@@ -0,0 +1,8 @@
+it:
+  correios_cep:
+    errors:
+      messages:
+        not_exists: '%{zipcode} non è un codice postale brasiliano esistente'
+        connection_failed: 'impossibile connettersi alle API delle Poste in Brasile'
+        invalid: '%{zipcode} non è un codice postale brasiliano valida'
+        timeouted: "timeout con l'API Posta"

data/config/locales/pt-BR.yml

@@ -0,0 +1,8 @@
+pt-BR:
+  correios_cep:
+    errors:
+      messages:
+        not_exists: '%{zipcode} não é um CEP existente'
+        connection_failed: 'falha na conexão com a API dos Correios'
+        invalid: '%{zipcode} não é um CEP válido'
+        timeouted: 'tempo esgotado de resposta com a API dos Correios'

data/lib/validates-correios-cep.rb

@@ -0,0 +1,3 @@
+require 'validates-correios-cep/version'
+require 'validates-correios-cep/engine'
+require 'validates-correios-cep/activemodel'

data/lib/validates-correios-cep/activemodel.rb

@@ -0,0 +1,30 @@
+require 'correios-cep'
+require 'active_model'
+
+module ActiveModel
+  module Validations
+    class CorreiosCepValidator < EachValidator
+      CORREIOS_CEP_I18N_SCOPE = 'correios_cep.errors.messages'
+
+      def validate_each(record, attribute, value)
+        error_message_scope = begin
+                                "#{CORREIOS_CEP_I18N_SCOPE}.not_exists" if Correios::CEP::AddressFinder.get(value).blank?
+                              rescue EOFError
+                                "#{CORREIOS_CEP_I18N_SCOPE}.connection_failed"
+                              rescue ArgumentError
+                                "#{CORREIOS_CEP_I18N_SCOPE}.invalid"
+                              rescue Net::OpenTimeout
+                                "#{CORREIOS_CEP_I18N_SCOPE}.timeouted"
+                              end
+
+        record.errors.add(attribute, error_message_scope, zipcode: value) if error_message_scope.present?
+      end
+    end
+
+    module HelperMethods
+      def validates_correios_cep_of(*attributes)
+        validates_with CorreiosCepValidator, _merge_attributes(attributes)
+      end
+    end
+  end
+end

data/lib/validates-correios-cep/engine.rb

@@ -0,0 +1,6 @@
+require 'rails'
+
+module ValidatesCorreiosCep
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/validates-correios-cep/version.rb

@@ -0,0 +1,3 @@
+module ValidatesCorreiosCep
+  VERSION = '0.1.0'.freeze
+end

data/validates-correios-cep.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'validates-correios-cep/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'validates-correios-cep'
+  spec.version       = ValidatesCorreiosCep::VERSION
+  spec.authors       = ['Pedro Furtado']
+  spec.email         = ['pedro.felipe.furtado@usp.br']
+
+  spec.summary       = %q{Brazilian zipcode validations for ActiveRecord, integrated with correios-cep gem.}
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/pedrofurtado/validates-correios-cep'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rails'
+  spec.add_dependency 'activemodel'
+  spec.add_dependency 'correios-cep'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: validates-correios-cep
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pedro Furtado
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: activemodel
+  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: correios-cep
+  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
+    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: 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'
+description: Brazilian zipcode validations for ActiveRecord, integrated with correios-cep
+  gem.
+email:
+- pedro.felipe.furtado@usp.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/locales/de.yml
+- config/locales/en.yml
+- config/locales/es.yml
+- config/locales/fr.yml
+- config/locales/it.yml
+- config/locales/pt-BR.yml
+- lib/validates-correios-cep.rb
+- lib/validates-correios-cep/activemodel.rb
+- lib/validates-correios-cep/engine.rb
+- lib/validates-correios-cep/version.rb
+- validates-correios-cep.gemspec
+homepage: https://github.com/pedrofurtado/validates-correios-cep
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Brazilian zipcode validations for ActiveRecord, integrated with correios-cep
+  gem.
+test_files: []