pombo 1.0.0.pre.alpha → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd144d6e1e25eb82dd55c488cd80f16a1c2f874b
-  data.tar.gz: 57544b7c52580cfed848aaeed9c8875f4139b8ad
+  metadata.gz: 0b0cfc72f11328171c4eb9ce98a535b8608cb506
+  data.tar.gz: 297396f9ddbe75fa891903851df087006aca8037
 SHA512:
-  metadata.gz: 864dcbc1efce094de63fef6e5c89e3db5f428bcb4232cd525ec9cc603ba14878ca7ec9872bc7ec916fcda8204ac06738447bb088738b79cf93c457dcd9c13fa0
-  data.tar.gz: 3cb3a7a1dc2092e82664c2fbaad5b6bc613f18c4b42a15ee405c0dd4e3baf51dbf5704c53a2e95e848ab1d5c3037bcfcd995be3a2e41b6d8241a86c1fe37729b
+  metadata.gz: 94d2f7399f38be5b1530bf49ff1db6967b4846ddd0779013770b87dff76e5f5f09aa431cfe179e62f0c890bc6a8c42c029a8cd3396bf6354045bc59f63b80863
+  data.tar.gz: dba0c988653622fb9b247e0390dd45384b64e0ab87feea3668bcbe919b4bf3727245a8cd9dc214828df7f63d7348e8ba4df463277d8c13bece78b7cf48636218

data/.travis.yml

@@ -1,4 +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,13 @@
+## 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
+* It is used to quote a package even if it does not reach the minimum dimensions
+* 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/README.md

@@ -1,5 +1,5 @@
 > ***
-> Attention! It is strongly advised not to use this version in production
+> Attention! if you are looking for documentation in English, [click here!](readmes/README-EN.md)
 > ***
 
 # Pombo
@@ -8,38 +8,230 @@
 [![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)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/pombo`. To experiment with that code, run `bin/console` for an interactive prompt.
+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
 
-TODO: Delete this and the text above, and describe your gem
+## Funcionalidades
 
-## Installation
+* 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)
 
-Add this line to your application's Gemfile:
+## Instalação
+
+    $ gem install pombo
+
+ou adiciona essa linha no seu Gemfile
 
 ```ruby
-gem 'pombo'
+gem 'pombo', '~> 1.0.0.beta'
 ```
 
-And then execute:
+e
 
-    $ bundle
+    $ bundle install
 
-Or install it yourself as:
 
-    $ gem install pombo
+## 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.min_package = true
+  config.request_timeout = 5
+  config.log_level = Pombo::Logger::INFO
+  config.logger = Pombo::Logger.new(STDOUT)
+  config.locale = 'pt-BR'
+end
+```
+
+> Os pacotes enviados pelos Correios possuem limitações de tamanho, usando a opção `min_package` você pode informar se caso o pacote não
+> atinga as dimensões mínimas, que seja realizada a cotação com os tamanhos mínimos permitidos.
+
+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
 
-## Usage
+# => [
+# =>    #<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
 
-TODO: Write usage instructions here
+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)">
+```
 
-## Development
+## 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
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## Como contribuir
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Pombo é mantido pelo time de desenvolvimento da [Adena E-commerce Platform](http://www.adena.com.br/).
 
-## Contributing
+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).
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pombo. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+## Licença
 
+MIT License. Veja o arquivo MIT-LICENSE.

data/lib/pombo.rb

@@ -1,4 +1,8 @@
+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'
@@ -8,39 +12,26 @@ require 'pombo/package/item'
 require 'pombo/package/format'
 require 'pombo/webservice/base'
 require 'pombo/webservice/cpp'
-require 'pombo/webservice/cpp/service'
+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
-  # @option config [String]  :contract_code Its administrative code by the ECT
-  # @option config [String]  :password Password to access the service, associated with its contract code
-  # @option config [Integer] :extends_delivery Days late on a package
-  # @option config [Integer] :request_timeout Second delay when accessing the webservice
-  # @option config [Symbol]  :log_level Log Level, `:info`, `:debug` or `warn`
-  # @option config [Symbol]  :logger object to trigger messages (defaults to `:logger`)
-  #
-  # @example
-  #   Pombo.setup do |config|
-  #     config.contract_code = 'AA99BB'
-  #     config.password = '999999'
-  #     config.extends_delivery = 0
-  #     config.request_timeout = 5
-  #     config.log_level = :info
-  #     config.logger = :logger
-  #   end
+  # @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
-  # @options (see .setup)
   # @return [Pombo::Configuration] current settings
   def self.set(**args)
     @@configurations = Configuration.new args
@@ -51,15 +42,37 @@ module Pombo
     @@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

data/lib/pombo/configuration.rb

@@ -1,39 +1,67 @@
 module Pombo
+  # It allows you to modify the settings of Pombo
+  # @!attribute [rw] contract_code
+  #   Its administrative code by the ECT
+  # @!attribute [rw] password
+  #   Password to access the service, associated with its contract code
+  # @!attribute [rw] extends_delivery
+  #   Days late on a package
+  # @!attribute [rw] request_timeout
+  #   Second delay when accessing the webservice
+  # @!attribute [rw] min_package
+  #   Force Pombo send at least a package of minimum dimensions of Correios
+  # @!attribute [rw] log_level
+  #   Level compatible with Ruby Logger
+  # @!attribute [rw] logger
+  #   Object to trigger messages (defaults to +Pombo::Logger+)
+  # @!attribute [rw] locale
+  #   Tells you what language will be used (defaults to `pt-BR`)
   class Configuration
     @@default = {
       contract_code: nil,
       password: nil,
       extends_delivery: 0,
-      log_level: :info,
-      logger: :logger,
-      request_timeout: 5
+      min_package: true,
+      log_level: Pombo::Logger::INFO,
+      logger: Pombo::Logger.new(STDOUT),
+      request_timeout: 5,
+      locale: 'pt-BR'
     }
 
-    attr_accessor :contract_code, :password, :extends_delivery, :log_level, :logger, :request_timeout
+    attr_accessor :contract_code, :password, :extends_delivery, :log_level, :logger, :request_timeout, :locale, :min_package
 
     def initialize(**args)
       args = @@default.merge(args)
       args.each { |key, value| __send__("#{ key }=", value) }
+
+      logger.level = log_level
+    end
+
+    # @return [Boolean] tells you if a package with minimum size will be sent
+    def min_package?
+      Pombo::Support::TRUE_VALUES.include? @min_package
     end
 
     # Saves the current state of the standard as an object
-    # @return [Hash] The new default settings
+    # @return [Pombo::Configuration] with default settings
     def set_default
       attributes = {}
       instance_variables.each{ |v| attributes[v.to_s.delete('@').to_sym] = instance_variable_get(v) }
       @@default.merge!(attributes)
+      Pombo.logger.info('update.configuration'){ 'Update the default settings' }
+      self
     end
 
     # Inform settings for persisting with default
-    # @see Pombo.setup
-    def self.setup(&block)
-      if block_given?
-        config = new
-        block.call config
-        config.set_default
-      else
-        raise Pombo::ConfigurationError, 'expected block the .setup'
-      end
+    # @param [Proc] with the configuration data.
+    # @return [Pombo::Configuration] the updated settings
+    # @raise [Pombo::ConfigurationError] if not passed a block
+    def self.setup
+      raise(Pombo::ConfigurationError, 'expected block the .setup') unless block_given?
+      config = new
+      yield config
+      config.set_default
+      self
     end
 
     # @return [Hash] The settings that are set as default