pombo 1.0.0.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e35c41bc810a96a4517c2a1bd0cf2dfaafb47ad5
+  data.tar.gz: 6b15a04c6ce1c138e5572bdc11d6a556d9eca58a
+SHA512:
+  metadata.gz: 4e1bb9beb588c8bf1e31e8bcab2f4dfb124df2131f1f0d7ffcc7820260dae14badfaefb144db649c41ff9cea2908a545a6adebf7f40624d657871133497e6946
+  data.tar.gz: 6a2de9baa6b927b97180a6e6a8e8a3f9f5e70470681be718a3872e2d247f3e0e79e007eec0a388b97b58cb8c153dc7d931bb4b53747d3430b5b58f76b8db2627

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.0

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.3.0
+  - 2.1.2
+before_install: gem install bundler -v 1.11.2

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+## v1.0.0
+
+#### New features
+
+* It allows you to change the default settings
+* It allows you to change the runtime settings
+* Allows the creation of packages with items
+* Allows the service value of consultation
+* Allows consultation of service delivery time
+* It allows you to see the value and service delivery time
+* It supports internationalization
+* Accepts a logger compatible with the interface [Log4r](http://log4r.rubyforge.org/index.html)

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at leandronunes.dev@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pombo.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Adena E-commerce Platform
+
+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,233 @@
+> ***
+> Attention! if you are looking for documentation in English, [click here!](readmes/README-EN.md)
+> ***
+
+# Pombo
+[![Build Status](https://travis-ci.org/adenaecommerce/pombo.svg?branch=master)](https://travis-ci.org/adenaecommerce/pombo)
+[![Dependency Status](https://gemnasium.com/adenaecommerce/pombo.svg)](https://gemnasium.com/adenaecommerce/pombo)
+[![Inline docs](http://inch-ci.org/github/adenaecommerce/pombo.svg?branch=master)](http://inch-ci.org/github/adenaecommerce/pombo)
+[![Hex.pm](https://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/adenaecommerce/pombo/master)
+[![Gem Version](https://badge.fury.io/rb/pombo.svg)](https://badge.fury.io/rb/pombo)
+[![Code Climate](https://codeclimate.com/github/adenaecommerce/pombo/badges/gpa.svg)](https://codeclimate.com/github/adenaecommerce/pombo)
+
+Pombo é uma gem que permite a utilização do webervice dos [Correios](http://correios.com.br/para-voce) para consulta de informacões
+de envio de encomendas
+
+## Funcionalidades
+
+* Permite montar um pacote com vários itens
+* Permite consultar o valor do transporte de um pacote
+* Permite consultar o prazo de envio de um pacote
+* Permite consultar o valor e o prazo de envio de um pacote
+* Suporta Internacionalização
+* Aceita um logger compatível com a interface do [Log4r](http://log4r.rubyforge.org/index.html)
+
+## Instalação
+
+    $ gem install pombo
+
+ou adiciona essa linha no seu Gemfile
+
+```ruby
+gem 'pombo', '~> 1.0.0.beta'
+```
+
+e
+
+    $ bundle install
+
+
+## Configuração
+
+> Os dados retornados ao realizar uma consulta são os mesmos fornecidos em uma agência dos Correios. As empresas
+> podem contratar um serviço diferenciado e usar o código do seu contrato ao utilizar o Pombo.
+
+Para alterar as configurações padrão, utilize o `#setup`
+
+```ruby
+Pombo.setup do |config|
+  config.contract_code = 'AA99BB'
+  config.password = '999999'
+  config.extends_delivery = 0
+  config.request_timeout = 5
+  config.log_level = Pombo::Logger::INFO
+  config.logger = Pombo::Logger.new(STDOUT)
+  config.locale = 'pt-BR'
+end
+```
+
+Se você precisar modificar qualquer configuração em um determinado momento, use o `#set`
+
+```ruby
+Pombo.set request_timeout: 10, locale: 'en'
+```
+
+> O `#set` não modifica as configurações default
+
+## Formatos
+
+Os formatos são objetos pré-definidos com informações fornecidas pelos Correios
+Os Correios trabalha com os seguintes formatos: caixa, envelope e rolo. Todo item deve possuir um formato.
+
+O formato do pacote é informado conforme os itens adicionado. Para mais de dois itens prevalece o formato caixa.
+
+Listar todos os formatos suportados pelos serviços de entrega
+
+```ruby
+Pombo::Package::Format.all
+
+# => [
+# =>    #<OpenStruct code=3, name="Envelope", max_length=60, min_length=16, max_width=60, min_width=11, max_weight=1>
+# =>    ....
+# => ]
+```
+
+Encontrar um formato específico pelo código ou pelo nome
+
+```ruby
+Pombo::Package::Format.find '3'
+# => #<OpenStruct code=3, name="Envelope", max_length=60, min_length=16, max_width=60, min_width=11, max_weight=1>
+
+# ou
+
+Pombo::Package::Format.find 'envelope'
+# => #<OpenStruct code=3, name="Envelope", max_length=60, min_length=16, max_width=60, min_width=11, max_weight=1>
+```
+
+## Serviços
+
+Os serviços são objetos pré-definidos com informações fornecidas pelos Correios. Para saber mais [clique aqui](http://www.correios.com.br/para-voce/envio/encomendas/encomendas)
+
+Listar todos os serviços de entrega suportados pelos Correios.
+
+```ruby
+Pombo::Services.all
+
+# => [
+# =>    #<OpenStruct code="41106", max_weight=30, name="PAC", description="PAC (sem contrato)">,
+# =>    ....
+# => ]
+```
+
+Listar todos os serviços de um grupo.
+
+```ruby
+Pombo::Services.all :pac
+# => [
+# =>    #<OpenStruct code="41106", max_weight=30, name="PAC", description="PAC (sem contrato)">,
+# =>    ....
+# => ]
+```
+
+Encontrar um serviço pelo seu código.
+
+```ruby
+Pombo::Services.find "41106"
+# => #<OpenStruct code="41106", max_weight=30, name="PAC", description="PAC (sem contrato)">
+```
+
+## Pacotes
+
+Os pacotes são os objetos enviados ao webservice para que seja realizada a consulta. Ele é composto por vários
+items, o CEP de origem e o CEP de destino e alguns serviços opcionais, [veja aqui](https://www.correios.com.br/para-voce/envio/encomendas/servicos-opcionais)
+
+Criando um pacote:
+
+```ruby
+package = Pombo::Package.new ({
+  destination_zip_code: '29160565',
+  origin_zip_code: '29108046',
+  services: "40010",
+  in_hand: false,
+  delivery_notice: false
+})
+# => <Pombo::Package:0x007fcfd32080f0 @items=[], @length=0, @height=0, @width=0, @declared_value=0, @destination_zip_code="29160565", @origin_zip_code="29108046">
+```
+
+> Pode ser informador um array de serviços para realizar a consulta em vários serviços.
+> `Pombo::Package.new services: ["40010", "41068", "40568"]`
+
+Adicionando items:
+
+```ruby
+item = Pombo::Package::Item.new weight: 10, length: 17, height: 22, width: 22
+package.add_item item
+```
+
+ou pode ser informado um hash
+
+```ruby
+package.add_item weight: 10, length: 15, height: 5, width: 10
+```
+
+Agora podemos obter várias informações
+
+```ruby
+package.in_hand? # => false
+package.delivery_notice? # => false
+package.weight # => 10
+package.diameter # => 0
+package.format # => 1
+package.volume # => 8228.0
+package.single_item? # => true
+```
+
+## Utilizando o Pombo
+
+Para realizar uma consulta para saber o valor e o prazo de entrega
+
+```ruby
+Pombo.shipping package
+# =>  [
+# =>    [0] #<Pombo::Webservice::CPP::Service:0x007fae1cd9d1a0 @code="40010", @value=31.3, @delivery_time="1", @value_in_hand=0.0, @value_delivery_notice=0.0, @value_declared_value=0.0, @error_code="0", @value_without_additions=31.3, @delivery_home=true, @delivery_sartuday=true>
+# =>  ]
+```
+
+Para realizar uma consulta para saber o prazo de entrega
+
+```ruby
+Pombo.delivery_time package
+# =>  [
+# =>    [0] #<Pombo::Webservice::CPP::Service:0x007fae1da0b040 @code="40010", @delivery_time="1", @delivery_home=true, @delivery_sartuday=true>
+# =>  ]
+```
+
+Para realizar uma consulta para saber o valor da entrega
+
+```ruby
+Pombo.shipping_value package
+# =>  [
+# =>    [0] #<Pombo::Webservice::CPP::Service:0x007fae1d1cb740 @code="40010", @value=31.3, @value_in_hand=0.0, @value_delivery_notice=0.0, @value_declared_value=0.0, @value_without_additions=31.3>
+# =>  ]
+```
+
+## Log
+
+Pombo aceita qualquer sistema de logger compatível com a interface do [Log4r](http://log4r.rubyforge.org/index.html).
+
+Temos nosso próprio objeto de logger, `Pombo::Logger`, que por padrão envia as mensagens para a `STDOUT` do sistema e o nível é INFO.
+
+```ruby
+Pombo.logger.info('event.namespace'){ 'Any error message' }
+# => 2016-05-13 15:15:49 -0300 | POMBO | event.namespace | INFO: Any error message
+```
+
+Para gravar em arquivo, você pode fazer algo parecido com isso:
+
+```ruby
+Pombo.setup do |config|
+  config.log_level = Pombo::Logger::INFO
+  config.logger = Pombo::Logger.new('caminho do arquivo')
+end
+```
+
+## Como contribuir
+
+Pombo é mantido pela time de desenvolvimento da [Adena E-commerce Platform](http://www.adena.com.br/).
+
+Relatórios de Bugs e pull requests são bem vindos no GitHub em https://github.com/adenaecommerce/pombo.
+Você pode nos enviar a sua colaboração, mas deve aderir ao código de conduta [Contributor Covenant](http://contributor-covenant.org).
+
+## Licença
+
+MIT License. Veja o arquivo MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pombo"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pombo.rb

@@ -0,0 +1,78 @@
+require 'i18n'
+I18n.load_path += Dir[File.expand_path('../../locales/*.yml', __FILE__)]
+
+require 'pombo/version'
+require 'pombo/logger'
+require 'pombo/configuration'
+require 'pombo/exception'
+require 'pombo/support'
+require 'pombo/services'
+require 'pombo/package'
+require 'pombo/package/item'
+require 'pombo/package/format'
+require 'pombo/webservice/base'
+require 'pombo/webservice/cpp'
+require 'pombo/webservice/cpp/service_response'
+require 'pombo/webservice/cpp/response'
+require 'pombo/webservice/cpp/base_request'
+require 'pombo/webservice/cpp/shipping_request'
+require 'pombo/webservice/cpp/shipping_value_request'
+require 'pombo/webservice/cpp/delivery_time_request'
+
+# It allows you to configure and perform consulting delivery services
+#
+# For more information read the file {file:/readmes/README-EN.md}
+module Pombo
+  # Inform settings for persisting with default
+  # @yield [config] with the configuration data.
+  # @return [Pombo::Configuration] with default settings
+  def self.setup(&block)
+    Configuration.setup(&block)
+  end
+
+  # Tells the settings that will be used at this time
+  # @note Does not modify the default settings
+  # @return [Pombo::Configuration] current settings
+  def self.set(**args)
+    @@configurations = Configuration.new args
+  end
+
+  # @return [Pombo::Configuration] current settings
+  def self.configurations
+    @@configurations ||= Configuration.new
+  end
+
+  # Perform the quotation of delivery of consulting services value and delivery time
+  # @param package [Pombo::Package] the package to be consulted
+  # @return [Array<Pombo::Webservice::CPP::ServiceResponse>]
+  def self.shipping(package)
+    Webservice::CPP.shipping(package)
+  end
+
+  # Perform the quotation of delivery of consulting delivery time
+  # @param package [Pombo::Package] the package to be consulted
+  # @return [Array<Pombo::Webservice::CPP::ServiceResponse>]
+  def self.delivery_time(package)
+    Webservice::CPP.delivery_time(package)
+  end
+
+  # Perform the quotation of delivery of consulting services value
+  # @param package [Pombo::Package] the package to be consulted
+  # @return [Array<Pombo::Webservice::CPP::ServiceResponse>]
+  def self.shipping_value(package)
+    Webservice::CPP.shipping_value(package)
+  end
+
+  # Performs internationalization for informed locale in settings
+  # @return [String] internationalized text
+  def self.t(*args)
+    I18n.with_locale configurations.locale do
+      I18n.translate args
+    end.first
+  end
+
+  # @return [Pombo::Logger] the default log object Pombo
+  def self.logger
+    configurations.logger
+  end
+end