corraios 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2dc25cea9a5e60dde42ce515603aec5bba1f5fb7
+  data.tar.gz: 9d93c867ec259333d5d903d00cb623e9dfd6fe2c
+SHA512:
+  metadata.gz: 6c8da3d01efd11ccc24374cc9fbd177ed4b5f7aaaaafdf8b05f171876395316469c70886b8c71528fa217ee0cf642c234b94b7676e267423ea633c2305291971
+  data.tar.gz: bf379ef78277aaeae26d891430b78b58ed5ac898fe2f855b93a911749d5a9f44d24cb6b457c363a8e73017cb1cdbf773a09405bac5bd412bd7457905fc8f1a12

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.ruby-*

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Rodrigo Ra
+
+MIT License
+
+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,134 @@
+# Corraios
+
+[ ![Codeship Status for imaboldcompany/corrails](https://codeship.com/projects/b77b8780-9531-0132-ffbf-466960a0e7d2/status?branch=master)](https://codeship.com/projects/62768)
+
+gem que visa facilitar o cálculo do valor do frete cobrado pelo Correios para entregas
+simples e para entregas com multiplos itens.
+
+Essa gem é focada para aplicações de e-commerce. Assim, os únicos serviços suportados são
+**PAC**, **SEDEX** e **E-SEDEX**.
+
+##Motivação:
+
+Existem outras gems para cálculo de frete, mas elas não incluem todas as regras de cubagem
+que o Correios aplica.
+
+##Regras utilizadas
+
+### Para frete de 1 item:
+
+Esse é o caso mais simples. A documentação do Correios explica bem quais são as restrições nesses casos: http://www.correios.com.br/para-voce/correios-de-a-a-z/pdf/calculador-remoto-de-precos-e-prazos/manual-de-implementacao-do-calculo-remoto-de-precos-e-prazos.
+
+### Para frete de múltiplos itens com embalagens iguais:
+
+Para o frete de múltiplos itens, sempre somaremos o peso dos itens. O que difere são os calculos das medidas finais de acordo com o tipo de embalagem:
+
+- Envelopes
+
+O tamanho do envelope não interfere no valor do frete, apenas o peso.
+Sabendo disso, para unificar os itens e fazer apenas uma requisição ao webservice do Correios,
+somamos os pesos dos envelopes, com limite de 1kg e desconsideramos os tamanhos dos envelopes.
+
+Quando o peso dos itens superam 1kg, tratamos a entrega como um pacote. Por exemplo, o valor do
+frete de 3 envelopes de 30x30 (centímetros) de 500g cada, será calculado como um pacote de 30x30x2
+com 1,5kg.
+
+- Caixas
+
+Os volumes das caixas serão somados e um novo valor para os lados da caixa final são calculados. Por exemplo: 2 Caixa de 30x30x30 com 1kg cada, resulta em uma caixa de 2 kg com 37.7976315 centímetros para cada lado.
+
+- Rolos
+
+Para entrega de multiplos rolos, eles serão convertidos em pacotes. Um rolo com 30 centímetros de comprimero com 10 de diametro é convertido para uma pacote com 30x10x10 e o mesmo peso.
+
+### Para frete de múltiplos itens com embalagens diferentes:
+
+**TODO**
+
+## Instalação
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'corrails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install corrails
+
+## Como usar?
+
+São utilizadas 3 classes principais:
+
+### Corraios::Packer
+
+Classe utilizada para agrupar diferentes tipos de embalagens
+
+```ruby
+packer = Corraios::Packer.new
+packer.add_item weight: 0.3, height: 30, width: 50, length: 30 # pacote
+packer.add_item weight: 1.3, width: 50, length: 30 # envelope
+packer.add_item weight: 0.3, diameter: 20, length: 30 # rolo
+
+```
+
+
+### Corraios::Calculator
+
+Essa classe recebe o cep de origem e destino juntamente com uma instância de `Corraios::Packer`.
+
+O método `perform` deve receber quais serviços devem ser calculados.
+
+```ruby
+
+calculator = Corraios::Calculator.new '38408-090', '38320-000', packer
+calculator.perform :pac #=> [Delivery]
+calculator.perform :pac, :sedex #=> [Delivery, Delivery]
+
+
+# quando possuir contrato
+calculator.contract_number = '1321231123'
+calculator.contract_password = '63h5nch13kd'
+
+````
+
+### Corraios::Delivery
+
+Classe retornada pelo método `Corraios::Calculator#perform`, e possui os valores retornados pelo
+webservices do Correios.
+
+
+```ruby
+
+delivery = calculator.perform :pac #=> Delivery
+
+if delivery.success?
+  delivery.deadline # 3
+  delivery.value # 32.12
+  delivery.number_of_posts # 1
+else
+  delivery.error_message #
+end
+
+````
+
+
+## TODO
+
+- adicionar opção mão própria
+- adicionar opção aviso recebimento
+- adicionar opção valor declarado
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/corrails/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rdoc/task'
+
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test
+

data/corraios.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'corraios/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "corraios"
+  spec.version       = Corraios::VERSION
+  spec.authors       = ["Rodrigo Ra"]
+  spec.email         = ["rodrigorcomp@gmail.com"]
+  spec.summary       = %q{ Gem to calculate Correios' freight values for multiple items }
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/imaboldcompany/corraios"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  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_dependency "httparty", "~>0.13.3"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "activesupport", "~> 4.2"
+  spec.add_development_dependency 'minitest-reporters', '~> 1.0'
+
+end

data/lib/corraios/calculator.rb

@@ -0,0 +1,56 @@
+module Corraios
+
+  class Calculator
+    include HTTParty
+    base_uri 'ws.correios.com.br'
+
+    attr_accessor :contract_number, :contract_password
+
+    def initialize(source, destination, packer)
+      @source = source
+      @destination = destination
+      @packer = packer
+    end
+
+    def perform(*services)
+      services.map do |service|
+        calculate_delivery(service)
+      end.flatten
+    end
+
+
+    private
+
+    def calculate_delivery(service)
+      @packer.containers.map do |container|
+        query_string = "#{to_query_params(service)}&#{container.to_query_params}"
+        parse_delivery(calculate_container(query_string))
+      end
+    end
+
+    def calculate_container(query_string)
+      self.class.get("/calculador/CalcPrecoPrazo.aspx?#{query_string}")
+    end
+
+    def parse_delivery(response)
+      if response.code == 200
+        Delivery.new(response.parsed_response)
+      else
+        raise ServiceUnreachable
+      end
+    end
+
+    def to_query_params(service)
+      query_string = "#{default_query_params}&sCepOrigem=#{@source}&sCepDestino=#{@destination}"
+      query_string << "&nCdServico=#{Corraios::code_for(service)}"
+      query_string << "&nCdEmpresa=#{contract_number}" if contract_number
+      query_string << "&sDsSenha=#{contract_password}" if contract_password
+      query_string
+    end
+
+    def default_query_params
+      "sCdMaoPropria=N&nVlValorDeclarado=0&sCdAvisoRecebimento=N&nIndicaCalculo=3&StrRetorno=XML"
+    end
+  end
+
+end

data/lib/corraios/containers/base.rb

@@ -0,0 +1,82 @@
+module Corraios
+
+  module Containers
+
+    class Base
+
+      def initialize(attributes)
+        attributes.each do |attr, value|
+          send "#{attr}=", value
+        end
+      end
+
+      def is_a?(type)
+        self.class.name.split('::').last.underscore.to_sym == type
+      end
+
+      def to_package
+        raise NotImplementedError
+      end
+
+      def to_query_params
+        attributes_names.map do |attr|
+          "#{self.class.query_attribute_name(attr)}=#{send(attr)}"
+        end.join('&') + "&nCdFormato=#{format}"
+      end
+
+      def format
+        self.class.instance_variable_get('@format')
+      end
+
+      def attributes_names
+        self.class.instance_variable_get('@attributes_restrictions').keys
+      end
+
+      class << self
+
+        def add_attribute name, restrictions, query_attribute_name = nil
+          attributes_restrictions[name] = restrictions
+          query_attribute_names[name] = query_attribute_name
+          attr_accessor name
+        end
+
+        def set_format(format)
+          @format = format
+        end
+
+        def valid_field?(attribute, value)
+          attributes_restrictions[attribute] && attributes_restrictions[attribute].include?(value)
+        end
+
+        def attributes_restrictions
+          @attributes_restrictions ||= {}
+        end
+
+        def query_attribute_names
+          @query_attribute_names ||= {}
+        end
+
+        def valid_fields?(attributes)
+          attributes.keys.size == attributes_restrictions.keys.size &&
+            attributes.all? { |attribute, value| valid_field?(attribute, value) }
+        end
+
+        def floor_for(attribute, value)
+          minimum_value = minimum_value_for(attribute)
+
+          minimum_value < value ? value : minimum_value
+        end
+
+        def minimum_value_for(attribute)
+          attributes_restrictions[attribute].first
+        end
+
+        def query_attribute_name(attribute_name)
+          query_attribute_names[attribute_name]
+        end
+
+      end
+    end
+  end
+
+end

data/lib/corraios/containers/envelope.rb

@@ -0,0 +1,31 @@
+module Corraios
+
+  module Containers
+
+    class Envelope < Base
+      set_format 3
+      add_attribute :weight, 0.0..1, 'nVlPeso'
+      add_attribute :width, 11..60, 'nVlLargura'
+      add_attribute :length, 16..60, 'nVlComprimento'
+
+      def valid?
+        self.class.valid_fields? @attributes
+      end
+
+      def can_merge?(envelope)
+        new_weight = self.weight + envelope.weight
+
+        self.class.valid_field? :weight, new_weight
+      end
+
+      def merge!(other)
+        self.weight += other.weight
+        #TODO: usar maiores
+      end
+
+      def to_package
+        Package.new weight: self.weight, height: 2, width: self.width, length: self.length
+      end
+    end
+  end
+end

data/lib/corraios/containers/package.rb

@@ -0,0 +1,50 @@
+module Corraios
+
+  module Containers
+
+    class Package < Base
+      set_format 1
+      add_attribute :weight, 0.0..30, 'nVlPeso'
+      add_attribute :width, 11..105, 'nVlLargura'
+      add_attribute :length, 16..105, 'nVlComprimento'
+      add_attribute :height, 2..105, 'nVlAltura'
+
+      def valid?
+        self.class.valid_fields? @attributes
+      end
+
+      def can_merge?(other)
+        new_volume = self.volume + other.volume
+        new_sides_size = (new_volume ** (1.0/3))
+
+        attributes = { weight: self.weight + other.weight }
+        [:width, :length, :height].each do |attr|
+          attributes[attr] = self.class.floor_for attr, new_sides_size
+        end
+
+        self.class.valid_fields? attributes
+      end
+
+      def merge!(other)
+        self.weight += other.weight
+        self.width = self.length = self.height = ((self.volume + other.volume) ** (1.0/3))
+      end
+
+      def volume
+        width * length * height
+      end
+
+      def to_package
+        self
+      end
+
+      class << self
+
+        def valid_fields?(attributes)
+          super(attributes) &&
+            (attributes[:width] + attributes[:height] + attributes[:length]) <= 200.0
+        end
+      end
+    end
+  end
+end

data/lib/corraios/containers/roll.rb

@@ -0,0 +1,40 @@
+module Corraios
+
+  module Containers
+
+    class Roll < Base
+      set_format 2
+      add_attribute :weight, 0..30, 'nVlPeso'
+      add_attribute :length, 18..105, 'nVlComprimento'
+      add_attribute :diameter, 5..91, 'nVlDiametro'
+
+      def valid?
+        self.class.valid_fields? @attributes
+      end
+
+      def can_merge?(other)
+        false
+      end
+
+      def merge!(other)
+        raise NotImplementedError
+      end
+
+      def volume
+        3.1415 * (diameter/2)**2 * length
+      end
+
+      def to_package
+        Package.new weight: self.weight, length: self.length, width: self.diameter, height: self.diameter
+      end
+
+      class << self
+
+        def valid_fields?(attributes)
+          super(attributes) &&
+            (attributes[:diameter] * 2 + attributes[:length]) <= 200.0
+        end
+      end
+    end
+  end
+end

data/lib/corraios/delivery.rb

@@ -0,0 +1,45 @@
+module Corraios
+
+  class Delivery
+    attr_reader :value, :deadline, :error_message
+
+    attr_reader :amount_of_posts
+
+    def initialize(correios_response)
+      @amount_of_posts = 1
+      parse_response(correios_response)
+    end
+
+    def error?
+      !!@error_message
+    end
+
+    def success?
+      !error?
+    end
+
+    private
+    def parse_response(response)
+      service = validate_response(response)
+      value = to_float(service['Valor'])
+      if value > 0.0
+        @value = value
+        @deadline = service['PrazoEntrega'].to_i
+      else
+        @error_message = service['MsgErro'].strip
+      end
+    end
+
+    def to_float(string)
+      string.to_s.gsub(',', '.').to_f
+    end
+
+    def validate_response(response)
+      if response['Servicos'] && response['Servicos']['cServico']
+        response['Servicos']['cServico']
+      else
+        raise InvalidResponse
+      end
+    end
+  end
+end

data/lib/corraios/packer.rb

@@ -0,0 +1,91 @@
+module Corraios
+
+  class Packer
+
+    attr_reader :containers
+
+    def initialize()
+      @containers = []
+    end
+
+    def add_item(attributes)
+      container = build_container(attributes)
+      add_to_containers container
+    end
+
+    def total_weight
+      @containers.inject(0) { |sum, item| sum + item.weight }.round(3)
+    end
+
+    def amount_of_posts
+      @containers.size
+    end
+
+    private
+    def build_container(attributes)
+      container = infers_container(attributes)
+      raise UnknownMeasures unless container
+      container.new(attributes)
+    end
+
+    def add_to_containers(container)
+      if @containers.empty?
+        @containers << container
+      else
+        if container.is_a? :package
+          add_package(container.to_package)
+        else
+          add_envelope_or_roll container
+        end
+      end
+    end
+
+    def first_empty
+      @containers.last
+    end
+
+    def add_envelope_or_roll(envelope)
+      unless using_envelope? && try_merge(first_empty, envelope)
+        convert_containers_into_package
+        add_package(envelope.to_package)
+      end
+    end
+
+    def convert_containers_into_package
+      @containers = @containers.map &:to_package
+    end
+
+    def add_package(package)
+      unless try_merge(first_empty, package)
+        @containers << package
+      end
+    end
+
+    def try_merge(container, new_container)
+      if container.can_merge? new_container
+        container.merge! new_container
+        true
+      end
+    end
+
+    def using_package?
+      @containers.any? { |container| container.is_a? :package }
+    end
+
+    def using_envelope?
+      @containers.size == 1 && @containers[0].is_a?(:envelope)
+    end
+
+    def pack_all_into_one_package(container)
+      weight_sum = total_weight + container.weight
+      measures = { height: 2, length: container.length, width: container.width }
+      @containers = [ Containers::Package.new(measures.merge(weight: weight_sum)) ]
+    end
+
+    def infers_container(attributes)
+      [Containers::Package, Containers::Envelope, Containers::Roll].find do |clazz|
+        clazz.valid_fields?(attributes)
+      end
+    end
+  end
+end

data/lib/corraios/services/pac.rb

@@ -0,0 +1,14 @@
+module Corraios
+
+  module Services
+
+    class Pac
+
+      def initialize(items)
+        @items = items
+      end
+
+
+    end
+  end
+end

data/lib/corraios/version.rb

@@ -0,0 +1,3 @@
+module Corraios
+  VERSION = "0.0.1"
+end

data/lib/corraios.rb

@@ -0,0 +1,30 @@
+require 'httparty'
+
+
+module Corraios
+  SERVICES = {
+    pac: 41106,
+    sedex: 40010,
+    e_sedex: 81019
+  }
+
+  def self.code_for(service)
+    SERVICES[service]
+  end
+
+  class CorraiosError < StandardError; end
+  class InvalidMeasures < CorraiosError; end
+  class UnknownMeasures < CorraiosError; end
+  class ServiceUnreachable < CorraiosError; end
+  class InvalidResponse < CorraiosError; end
+end
+
+
+require 'corraios/containers/base'
+require 'corraios/containers/envelope'
+require 'corraios/containers/package'
+require 'corraios/containers/roll'
+require 'corraios/calculator'
+require 'corraios/delivery'
+require 'corraios/packer'
+require 'corraios/version'

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: corraios
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rodrigo Ra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: ''
+email:
+- rodrigorcomp@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- corraios.gemspec
+- lib/corraios.rb
+- lib/corraios/calculator.rb
+- lib/corraios/containers/base.rb
+- lib/corraios/containers/envelope.rb
+- lib/corraios/containers/package.rb
+- lib/corraios/containers/roll.rb
+- lib/corraios/delivery.rb
+- lib/corraios/packer.rb
+- lib/corraios/services/pac.rb
+- lib/corraios/version.rb
+homepage: https://github.com/imaboldcompany/corraios
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Gem to calculate Correios' freight values for multiple items
+test_files: []