correios_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d43b602df7c491dc86c8d97c8cd1d3d79301b3387ac7213448202d94e28117ce
+  data.tar.gz: 72816d1bf92cc2cc03aaf2598e313a4f3bc78fd744ef0dbcf4fe0f0fe9b13326
+SHA512:
+  metadata.gz: c480fc1288acfb2e6d60928c6861c919aa993c7270c5ab8b6966729ff6317ad439dadf6976a61b3ab35cc9e5fb5bb5f020de403fc84f77956f220624f4690ff7
+  data.tar.gz: 11b7ef53df6aaef295c61872756ef63ace7d37229cf8b5710cdb3dacfbe4aa7adcdd6f9ebfc274df4461e40f205e2fa2271ab520d161225300200e23c83dcf30

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-09-23
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 ulysses
+
+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 @@
+# CorreiosApi

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/correios_api/client.rb

@@ -0,0 +1,208 @@
+module CorreiosApi
+  class Client < Ac::Base
+    BASE_URL = "https://api.correios.com.br"
+    MAX_RETRIES = 2
+
+    SERVICES = [
+      {
+        code: "03220",
+        name: "SEDEX CONTRATO AG"
+      },
+      {
+        code: "03298",
+        name: "PAC CONTRATO AG"
+      },
+      {
+        code: "04227",
+        name: "CORREIOS MINI ENVIOS CTR AG"
+      }
+    ]
+    SERVICE_NAMES = {
+      "03220" => "SEDEX CONTRATO AG",
+      "03298" => "PAC CONTRATO AG",
+      "04227" => "CORREIOS MINI ENVIOS CTR AG"
+    }
+
+    attr_reader :username, :password, :post_card, :contract_number, :access_token, :expires_in
+    def initialize username:, password:, post_card:, contract_number: nil, access_token: nil, expires_in: nil
+      @username = username
+      @password = password
+      @post_card = post_card
+      @contract_number = contract_number
+      if @access_token.nil? || @expires_in < Time.now
+        authenticate
+      end
+    end
+
+    def authenticate
+      body = {
+        numero: @post_card
+      }
+      response = post(
+        "/token/v1/autentica/cartaopostagem",
+        headers: {
+          "Authorization" => "Basic #{Base64.strict_encode64("#{@username}:#{@password}")}",
+          "Content-Type" => "application/json"
+        },
+        body: JSON.dump(body)
+      ) { |response| validate_response(response, "token") }
+
+      @access_token = response.json.dig("token")
+      @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
+      body = {
+        idCorreios: @username,
+        remetente: {
+          nome: nome_remet,
+          cpfCnpj: cpf_cnpj_remet,
+          endereco: {
+            cep: cep_remet,
+            logradouro: rua_remet,
+            numero: numero_remet,
+            bairro: bairro_remet,
+            cidade: cidade_remet,
+            uf: uf_remet
+          }
+        },
+        destinatario: {
+          nome: nome_dest,
+          cpfCnpj: cpf_cnpj_dest,
+          endereco: {
+            cep: cep_dest,
+            logradouro: rua_dest,
+            numero: numero_dest,
+            bairro: bairro_dest,
+            cidade: cidade_dest,
+            uf: uf_dest
+          }
+        },
+        codigoServico: codigo_servico,
+        precoPrePostagem: preco_pre_postagem,
+        numeroCartaoPostagem: @post_card,
+        itensDeclaracaoConteudo: itens, # conteudo, quantidade, valor
+        pesoInformado: peso_gramas,
+        codigoFormatoObjetoInformado: "2",
+        alturaInformada: altura_cm,
+        larguraInformada: largura_cm,
+        comprimentoInformado: comprimento_cm,
+        cienteObjetoNaoProibido: "1",
+        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"
+      }
+
+      response = post(
+        "/prepostagem/v1/prepostagens",
+        headers: headers,
+        body: JSON.dump(body)
+      ) { |response| validate_response(response, "id") }
+      PreShipping.new(response.json)
+    end
+
+    def create_label pre_shipping
+      body = {
+        codigosObjeto: [
+          pre_shipping.codigo_objeto
+        ],
+        idCorreios: @username,
+        numeroCartaoPostagem: @post_card,
+        tipoRotulo: "P", # P (padrão) ou R (reduzido)
+        formatoRotulo: "ET", # ET (Etiqueta) ou EV (Envelope)
+        imprimeRemetente: "S", # S (Sim) ou N (não)
+        layoutImpressao: "PADRAO" # PADRAO, LINEAR_100_150, LINEAR_100_80, LINEAR_A4, LINEAR_A
+      }
+
+      response = post(
+        "/prepostagem/v1/prepostagens/rotulo/assincrono/pdf",
+        headers: headers,
+        body: JSON.dump(body)
+      ) { |response| validate_response(response, "idRecibo") }
+      sleep(0.5) # Tem que esperar o PDF ficar pronto
+      get_label(response.json.dig("idRecibo"))
+    end
+
+    def get_label id
+      response = get(
+        "/prepostagem/v1/prepostagens/rotulo/download/assincrono/#{id}",
+        headers: headers
+      ) { |response| validate_response(response, "nome") }
+      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)
+
+      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"]],
+          service_code: service_time["coProduto"],
+          price: service_cost["pcFinal"],
+          delivery_time_in_days: service_time["prazoEntrega"],
+          max_delivery_time: service_time["dataMaxima"],
+          message: service_time["msgPrazo"],
+          errors: [
+            service_cost.dig("txErro"),
+            service_time.dig("txErro")
+          ].compact
+        )
+      end
+    end
+
+    def delivery_time cep_origem, cep_destino
+      body = {
+        idLote: "1",
+        parametrosPrazo: SERVICES.map { |service| { coProduto: service[:code], nuRequisicao: 1, cepOrigem: cep_origem, cepDestino: cep_destino } }
+      }
+      response = post(
+        "/prazo/v1/nacional",
+        headers: headers,
+        body: JSON.dump(body)
+      ) { |response| validate_response(response, "coProduto") }
+      response.json
+    end
+
+    def delivery_cost cep_origem, cep_destino, 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,
+          psObjeto: weight_g,
+          altura: height_cm,
+          largura: width_cm,
+          comprimento: length_cm,
+          tpObjeto: "2"
+        }
+      end
+      body = {
+        idLote: "1",
+        parametrosProduto: params_produto
+      }
+      response = post(
+        "/preco/v1/nacional",
+        headers: headers,
+        body: JSON.dump(body)
+      ) { |response| validate_response(response, "coProduto") }
+      response.json
+    end
+
+    private
+
+    def headers
+      {
+        "Authorization" => "Bearer #{@access_token}",
+        "Content-Type" => "application/json"
+      }
+    end
+
+    def validate_response(response, required_response_key)
+      puts response.json unless response.success?
+      ![500, 429].include?(response.code) || response.json.dig(*required_response_key)
+    end
+  end
+end

data/lib/correios_api/label.rb

@@ -0,0 +1,12 @@
+class Label
+  attr_reader :response, :name, :data
+  def initialize response
+    @response = response
+    @name = response.dig("nome")
+    @data = response.dig("dados")
+  end
+
+  def download_file
+    File.write(@name, Base64.decode64(@data))
+  end
+end

data/lib/correios_api/pre_shipping.rb

@@ -0,0 +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
+    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")
+      @status = response.dig("statusAtual")
+      @desc_status = response.dig("descStatusAtual")
+      @tipo_rotulo = response.dig("tipoRotulo")
+      @tipo_objeto = response.dig("tipoObjeto")
+    end
+  end
+end

data/lib/correios_api/rate.rb

@@ -0,0 +1,26 @@
+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
+      @service_name = service_name
+      @service_code = service_code
+      @price = transform_price(price)
+      @delivery_time_in_days = delivery_time_in_days
+      @max_delivery_time = transform_date(max_delivery_time)
+      @message = message
+      @errors = errors
+    end
+
+    private
+
+    def transform_price price
+      return nil unless price
+      price.gsub(",", ".").to_f
+    end
+
+    def transform_date date
+      return nil unless date
+      Time.new(date)
+    end
+  end
+end

data/lib/correios_api/version.rb

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

data/lib/correios_api.rb

@@ -0,0 +1,13 @@
+require_relative "correios_api/version"
+
+require "base64"
+require "ac"
+
+require "correios_api/client"
+require "correios_api/rate"
+require "correios_api/pre_shipping"
+require "correios_api/label"
+
+module CorreiosApi
+  class Error < StandardError; end
+end

data/sig/correios_api.rbs

@@ -0,0 +1,4 @@
+module CorreiosApi
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: correios_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Todas Essas Coisas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  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: ac
+  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'
+description: ''
+email:
+- ulyssesh.20@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/correios_api.rb
+- lib/correios_api/client.rb
+- lib/correios_api/label.rb
+- lib/correios_api/pre_shipping.rb
+- lib/correios_api/rate.rb
+- lib/correios_api/version.rb
+- sig/correios_api.rbs
+homepage: https://github.com/todasessascoisas/correios_api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/todasessascoisas/correios_api
+  source_code_uri: https://github.com/todasessascoisas/correios_api
+  changelog_uri: https://github.com/todasessascoisas/correios_api
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []