correios_api 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d43b602df7c491dc86c8d97c8cd1d3d79301b3387ac7213448202d94e28117ce
-  data.tar.gz: 72816d1bf92cc2cc03aaf2598e313a4f3bc78fd744ef0dbcf4fe0f0fe9b13326
+  metadata.gz: dcc4ca0305423aba4587a2cc331db7764a1f3847762a08efecb5690d8d53f959
+  data.tar.gz: a1944f100d9652beb0eae95cad0b4aa55e6ad02dacafad3566c7e4909072b7df
 SHA512:
-  metadata.gz: c480fc1288acfb2e6d60928c6861c919aa993c7270c5ab8b6966729ff6317ad439dadf6976a61b3ab35cc9e5fb5bb5f020de403fc84f77956f220624f4690ff7
-  data.tar.gz: 11b7ef53df6aaef295c61872756ef63ace7d37229cf8b5710cdb3dacfbe4aa7adcdd6f9ebfc274df4461e40f205e2fa2271ab520d161225300200e23c83dcf30
+  metadata.gz: e7557ba5531342f6a782183318409a3fe77d6574731324a8369899ec7b7dbdb0d1f5a8e1913eb29cc4e60afd69cb584f00e5da47db592cb5c52ee8b5e8f2cca6
+  data.tar.gz: 99b84e4160ea1730c74cbe2d6d035a4334cfa008fa12a7cdf3a17682f700d5cfe1de5e632a143f3a071a54e994bef68297569c8855611f919a4c5a59cf4d45ff

data/lib/correios_api/client.rb

@@ -51,46 +51,51 @@ module CorreiosApi
       @expires_in = Time.new(response.json.dig("expiraEm"))
     end
 
-    def create_pre_shipping nome_remet:, cpf_cnpj_remet:, cep_remet:, rua_remet:, numero_remet:, bairro_remet:, cidade_remet:, uf_remet:, nome_dest:, cpf_cnpj_dest:, cep_dest:, rua_dest:, numero_dest:, bairro_dest:, cidade_dest:, uf_dest:, codigo_servico:, preco_pre_postagem:, itens:, peso_gramas:, altura_cm: 15, largura_cm: 15, comprimento_cm: 15
+    def tracking_package tracking_code, result_type = "T"
+      response = get("/srorastro/v1/objetos/#{tracking_code}?resultado=#{result_type}")
+      Tracking.new(response.json)
+    end
+
+    def create_pre_shipping shipper_name:, shipper_tax_id:, shipper_zipcode:, shipper_street:, shipper_address_number:, shipper_district:, shipper_city:, shipper_state_code:, receiver_name:, receiver_tax_id:, receiver_zipcode:, receiver_street:, receiver_address_number:, receiver_district:, receiver_city:, receiver_state_code:, service_code:, price:, items:, weight_g:, height_cm: 15, width_cm: 15, length_cm: 15
       body = {
         idCorreios: @username,
         remetente: {
-          nome: nome_remet,
-          cpfCnpj: cpf_cnpj_remet,
+          nome: shipper_name,
+          cpfCnpj: shipper_tax_id,
           endereco: {
-            cep: cep_remet,
-            logradouro: rua_remet,
-            numero: numero_remet,
-            bairro: bairro_remet,
-            cidade: cidade_remet,
-            uf: uf_remet
+            cep: shipper_zipcode,
+            logradouro: shipper_street,
+            numero: shipper_address_number,
+            bairro: shipper_district,
+            cidade: shipper_city,
+            uf: shipper_state_code
           }
         },
         destinatario: {
-          nome: nome_dest,
-          cpfCnpj: cpf_cnpj_dest,
+          nome: receiver_name,
+          cpfCnpj: receiver_tax_id,
           endereco: {
-            cep: cep_dest,
-            logradouro: rua_dest,
-            numero: numero_dest,
-            bairro: bairro_dest,
-            cidade: cidade_dest,
-            uf: uf_dest
+            cep: receiver_zipcode,
+            logradouro: receiver_street,
+            numero: receiver_address_number,
+            bairro: receiver_district,
+            cidade: receiver_city,
+            uf: receiver_state_code
           }
         },
-        codigoServico: codigo_servico,
-        precoPrePostagem: preco_pre_postagem,
+        codigoServico: service_code,
+        precoPrePostagem: price,
         numeroCartaoPostagem: @post_card,
-        itensDeclaracaoConteudo: itens, # conteudo, quantidade, valor
-        pesoInformado: peso_gramas,
+        itensDeclaracaoConteudo: items, # conteudo, quantidade, valor
+        pesoInformado: weight_g,
         codigoFormatoObjetoInformado: "2",
-        alturaInformada: altura_cm,
-        larguraInformada: largura_cm,
-        comprimentoInformado: comprimento_cm,
+        alturaInformada: height_cm,
+        larguraInformada: width_cm,
+        comprimentoInformado: length_cm,
         cienteObjetoNaoProibido: "1",
-        modalidadePagamento: "2" # 1-à vista, 2-à faturar, 3- à avista e à afaturar e 4- Prestação de contas recebimento ou pagamento
+        modalidadePagamento: "2", # 1-à vista, 2-à faturar, 3- à avista e à afaturar e 4- Prestação de contas recebimento ou pagamento
         # solicitarColeta: "N",
-        # dataPrevistaPostagem: "20/09/2024"
+        # dataPrevistaPostagem: "29/09/2024"
       }
 
       response = post(
@@ -104,7 +109,7 @@ module CorreiosApi
     def create_label pre_shipping
       body = {
         codigosObjeto: [
-          pre_shipping.codigo_objeto
+          pre_shipping.tracking_code
         ],
         idCorreios: @username,
         numeroCartaoPostagem: @post_card,
@@ -131,11 +136,11 @@ module CorreiosApi
       Label.new(response.json)
     end
 
-    def create_rates cep_origem:, cep_destino:, weight_g: 1000, height_cm: 15, width_cm: 15, length_cm: 15
-      services_with_time = delivery_time(cep_origem, cep_destino)
-      services_with_cost = delivery_cost(cep_origem, cep_destino, weight_g, height_cm, width_cm, length_cm)
+    def create_rates zipcode_from:, zipcode_to:, weight_g: 1000, height_cm: 15, width_cm: 15, length_cm: 15
+      services_with_time = delivery_time(zipcode_from, zipcode_to)
+      services_with_cost = delivery_cost(zipcode_from, zipcode_to, weight_g, height_cm, width_cm, length_cm)
 
-      services_with_time.map do |service_time|
+      rates = services_with_time.map do |service_time|
         service_cost = services_with_cost.find { |service| service["coProduto"] == service_time["coProduto"] }
         Rate.new(
           service_name: SERVICE_NAMES[service_time["coProduto"]],
@@ -150,12 +155,13 @@ module CorreiosApi
           ].compact
         )
       end
+      ShippingQuotes.new(rates)
     end
 
-    def delivery_time cep_origem, cep_destino
+    def delivery_time zipcode_from, zipcode_to
       body = {
         idLote: "1",
-        parametrosPrazo: SERVICES.map { |service| { coProduto: service[:code], nuRequisicao: 1, cepOrigem: cep_origem, cepDestino: cep_destino } }
+        parametrosPrazo: SERVICES.map { |service| { coProduto: service[:code], nuRequisicao: 1, cepOrigem: zipcode_from, cepDestino: zipcode_to } }
       }
       response = post(
         "/prazo/v1/nacional",
@@ -165,13 +171,13 @@ module CorreiosApi
       response.json
     end
 
-    def delivery_cost cep_origem, cep_destino, weight_g, height_cm, width_cm, length_cm
+    def delivery_cost zipcode_from, zipcode_to, weight_g, height_cm, width_cm, length_cm
       params_produto = SERVICES.map do |service|
         {
           coProduto: service[:code],
           nuRequisicao: "1",
-          cepOrigem: cep_origem,
-          cepDestino: cep_destino,
+          cepOrigem: zipcode_from,
+          cepDestino: zipcode_to,
           psObjeto: weight_g,
           altura: height_cm,
           largura: width_cm,

data/lib/correios_api/pre_shipping.rb

@@ -1,21 +1,21 @@
 module CorreiosApi
   class PreShipping
 
-    attr_reader :response, :external_id, :codigo_objeto, :codigo_servico, :modalidade_pagamento, :preco_pre_postagem, :itens_declarados, :data_prevista_postagem, :prazo_postagem, :status, :desc_status, :tipo_rotulo, :tipo_objeto
+    attr_reader :response, :external_id, :tracking_code, :service_code, :payment_method_id, :price, :items, :post_prevision, :posting_deadline, :status, :status_detail, :label_type, :package_type
     def initialize response
       @response = response
       @external_id = response.dig("id")
-      @codigo_objeto = response.dig("codigoObjeto")
-      @codigo_servico = response.dig("codigoServico")
-      @modalidade_pagamento = response.dig("modalidadePagamento")
-      @preco_pre_postagem = response.dig("precoPrePostagem")
-      @itens_declarados = response.dig("itensDeclaracaoConteudo")
-      @data_prevista_postagem = response.dig("dataPrevistaPostagem")
-      @prazo_postagem = response.dig("prazoPostagem")
+      @tracking_code = response.dig("codigoObjeto")
+      @service_code = response.dig("codigoServico")
+      @payment_method_id = response.dig("modalidadePagamento")
+      @price = response.dig("precoPrePostagem")
+      @items = response.dig("itensDeclaracaoConteudo")
+      @post_prevision = response.dig("dataPrevistaPostagem")
+      @posting_deadline = response.dig("prazoPostagem")
       @status = response.dig("statusAtual")
-      @desc_status = response.dig("descStatusAtual")
-      @tipo_rotulo = response.dig("tipoRotulo")
-      @tipo_objeto = response.dig("tipoObjeto")
+      @status_detail = response.dig("descStatusAtual")
+      @label_type = response.dig("tipoRotulo")
+      @package_type = response.dig("tipoObjeto")
     end
   end
 end

data/lib/correios_api/rate.rb

@@ -1,7 +1,7 @@
 module CorreiosApi
   class Rate
     attr_reader :service_name, :service_code, :price, :delivery_time_in_days, :max_delivery_time, :message, :errors
-    def initialize service_name:, service_code:, price:, delivery_time_in_days:, max_delivery_time:, message: nil, errors: nil
+    def initialize service_name:, service_code:, price:, delivery_time_in_days:, max_delivery_time:, message: nil, errors: []
       @service_name = service_name
       @service_code = service_code
       @price = transform_price(price)
@@ -14,7 +14,7 @@ module CorreiosApi
     private
 
     def transform_price price
-      return nil unless price
+      return 0.0 unless price
       price.gsub(",", ".").to_f
     end
 

data/lib/correios_api/shipping_quotes.rb

@@ -0,0 +1,21 @@
+module CorreiosApi
+  class ShippingQuotes
+
+    attr_reader :rates
+    def initialize rates
+      @rates = rates
+    end
+
+    def cheaper_rate
+      valid_rates.sort_by(&:price).first
+    end
+
+    def faster_rate
+      valid_rates.sort_by(&:delivery_time_in_days).first
+    end
+
+    def valid_rates
+      @rates.select { |rate| rate.price > 0 && rate.errors.empty? }
+    end
+  end
+end

data/lib/correios_api/tracking.rb

@@ -0,0 +1,20 @@
+module CorreiosApi
+  class Tracking
+
+    attr_reader :response, :tracking_code, :sigla, :descricao, :categoria, :data_prevista, :weight_g, :height_cm, :width_cm, :length_cm, :formato, :modalidade, :eventos
+    def initialize response
+      @tracking_code = response.dig("objetos", 0, "codObjeto")
+      @sigla = response.dig("objetos", 0, "tipoPostal", "sigla")
+      @descricao = response.dig("objetos", 0, "tipoPostal", "descricao")
+      @categoria = response.dig("objetos", 0, "tipoPostal", "categoria")
+      @data_prevista = response.dig("objetos", 0, "dtPrevista")
+      @weight_g = response.dig("objetos", 0, "peso") * 1000
+      @height_cm = response.dig("objetos", 0, "altura")
+      @width_cm = response.dig("objetos", 0, "largura")
+      @length_cm = response.dig("objetos", 0, "comprimento")
+      @formato = response.dig("objetos", 0, "formato")
+      @modalidade = response.dig("objetos", 0, "modalidade")
+      @eventos = response.dig("objetos", 0, "eventos")
+    end
+  end
+end

data/lib/correios_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CorreiosApi
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/lib/correios_api.rb

@@ -7,6 +7,8 @@ require "correios_api/client"
 require "correios_api/rate"
 require "correios_api/pre_shipping"
 require "correios_api/label"
+require "correios_api/shipping_quotes"
+require "correios_api/tracking"
 
 module CorreiosApi
   class Error < StandardError; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: correios_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Todas Essas Coisas
@@ -56,6 +56,8 @@ files:
 - lib/correios_api/label.rb
 - lib/correios_api/pre_shipping.rb
 - lib/correios_api/rate.rb
+- lib/correios_api/shipping_quotes.rb
+- lib/correios_api/tracking.rb
 - lib/correios_api/version.rb
 - sig/correios_api.rbs
 homepage: https://github.com/todasessascoisas/correios_api