PyPI - odoo-addon-delivery-ups-oca - Versions diffs - 17.0.1.0.0.2__py3-none-any.whl - Mend

odoo-addon-delivery-ups-oca 17.0.1.0.0.2__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (26) hide show

odoo/addons/delivery_ups_oca/static/description/index.html ADDED Viewed

@@ -0,0 +1,498 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="generator" content="Docutils: https://docutils.sourceforge.io/" />
+<title>README.rst</title>
+<style type="text/css">
+/*
+:Author: David Goodger (goodger@python.org)
+:Id: $Id: html4css1.css 9511 2024-01-13 09:50:07Z milde $
+:Copyright: This stylesheet has been placed in the public domain.
+Default cascading style sheet for the HTML output of Docutils.
+Despite the name, some widely supported CSS2 features are used.
+See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
+customize this style sheet.
+*/
+/* used to remove borders from tables and images */
+.borderless, table.borderless td, table.borderless th {
+  border: 0 }
+table.borderless td, table.borderless th {
+  /* Override padding for "table.docutils td" with "! important".
+     The right padding separates the table cells. */
+  padding: 0 0.5em 0 0 ! important }
+.first {
+  /* Override more specific margin styles with "! important". */
+  margin-top: 0 ! important }
+.last, .with-subtitle {
+  margin-bottom: 0 ! important }
+.hidden {
+  display: none }
+.subscript {
+  vertical-align: sub;
+  font-size: smaller }
+.superscript {
+  vertical-align: super;
+  font-size: smaller }
+a.toc-backref {
+  text-decoration: none ;
+  color: black }
+blockquote.epigraph {
+  margin: 2em 5em ; }
+dl.docutils dd {
+  margin-bottom: 0.5em }
+object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
+  overflow: hidden;
+}
+/* Uncomment (and remove this text!) to get bold-faced definition list terms
+dl.docutils dt {
+  font-weight: bold }
+*/
+div.abstract {
+  margin: 2em 5em }
+div.abstract p.topic-title {
+  font-weight: bold ;
+  text-align: center }
+div.admonition, div.attention, div.caution, div.danger, div.error,
+div.hint, div.important, div.note, div.tip, div.warning {
+  margin: 2em ;
+  border: medium outset ;
+  padding: 1em }
+div.admonition p.admonition-title, div.hint p.admonition-title,
+div.important p.admonition-title, div.note p.admonition-title,
+div.tip p.admonition-title {
+  font-weight: bold ;
+  font-family: sans-serif }
+div.attention p.admonition-title, div.caution p.admonition-title,
+div.danger p.admonition-title, div.error p.admonition-title,
+div.warning p.admonition-title, .code .error {
+  color: red ;
+  font-weight: bold ;
+  font-family: sans-serif }
+/* Uncomment (and remove this text!) to get reduced vertical space in
+   compound paragraphs.
+div.compound .compound-first, div.compound .compound-middle {
+  margin-bottom: 0.5em }
+div.compound .compound-last, div.compound .compound-middle {
+  margin-top: 0.5em }
+*/
+div.dedication {
+  margin: 2em 5em ;
+  text-align: center ;
+  font-style: italic }
+div.dedication p.topic-title {
+  font-weight: bold ;
+  font-style: normal }
+div.figure {
+  margin-left: 2em ;
+  margin-right: 2em }
+div.footer, div.header {
+  clear: both;
+  font-size: smaller }
+div.line-block {
+  display: block ;
+  margin-top: 1em ;
+  margin-bottom: 1em }
+div.line-block div.line-block {
+  margin-top: 0 ;
+  margin-bottom: 0 ;
+  margin-left: 1.5em }
+div.sidebar {
+  margin: 0 0 0.5em 1em ;
+  border: medium outset ;
+  padding: 1em ;
+  background-color: #ffffee ;
+  width: 40% ;
+  float: right ;
+  clear: right }
+div.sidebar p.rubric {
+  font-family: sans-serif ;
+  font-size: medium }
+div.system-messages {
+  margin: 5em }
+div.system-messages h1 {
+  color: red }
+div.system-message {
+  border: medium outset ;
+  padding: 1em }
+div.system-message p.system-message-title {
+  color: red ;
+  font-weight: bold }
+div.topic {
+  margin: 2em }
+h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
+h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
+  margin-top: 0.4em }
+h1.title {
+  text-align: center }
+h2.subtitle {
+  text-align: center }
+hr.docutils {
+  width: 75% }
+img.align-left, .figure.align-left, object.align-left, table.align-left {
+  clear: left ;
+  float: left ;
+  margin-right: 1em }
+img.align-right, .figure.align-right, object.align-right, table.align-right {
+  clear: right ;
+  float: right ;
+  margin-left: 1em }
+img.align-center, .figure.align-center, object.align-center {
+  display: block;
+  margin-left: auto;
+  margin-right: auto;
+}
+table.align-center {
+  margin-left: auto;
+  margin-right: auto;
+}
+.align-left {
+  text-align: left }
+.align-center {
+  clear: both ;
+  text-align: center }
+.align-right {
+  text-align: right }
+/* reset inner alignment in figures */
+div.align-right {
+  text-align: inherit }
+/* div.align-center * { */
+/*   text-align: left } */
+.align-top    {
+  vertical-align: top }
+.align-middle {
+  vertical-align: middle }
+.align-bottom {
+  vertical-align: bottom }
+ol.simple, ul.simple {
+  margin-bottom: 1em }
+ol.arabic {
+  list-style: decimal }
+ol.loweralpha {
+  list-style: lower-alpha }
+ol.upperalpha {
+  list-style: upper-alpha }
+ol.lowerroman {
+  list-style: lower-roman }
+ol.upperroman {
+  list-style: upper-roman }
+p.attribution {
+  text-align: right ;
+  margin-left: 50% }
+p.caption {
+  font-style: italic }
+p.credits {
+  font-style: italic ;
+  font-size: smaller }
+p.label {
+  white-space: nowrap }
+p.rubric {
+  font-weight: bold ;
+  font-size: larger ;
+  color: maroon ;
+  text-align: center }
+p.sidebar-title {
+  font-family: sans-serif ;
+  font-weight: bold ;
+  font-size: larger }
+p.sidebar-subtitle {
+  font-family: sans-serif ;
+  font-weight: bold }
+p.topic-title {
+  font-weight: bold }
+pre.address {
+  margin-bottom: 0 ;
+  margin-top: 0 ;
+  font: inherit }
+pre.literal-block, pre.doctest-block, pre.math, pre.code {
+  margin-left: 2em ;
+  margin-right: 2em }
+pre.code .ln { color: gray; } /* line numbers */
+pre.code, code { background-color: #eeeeee }
+pre.code .comment, code .comment { color: #5C6576 }
+pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
+pre.code .literal.string, code .literal.string { color: #0C5404 }
+pre.code .name.builtin, code .name.builtin { color: #352B84 }
+pre.code .deleted, code .deleted { background-color: #DEB0A1}
+pre.code .inserted, code .inserted { background-color: #A3D289}
+span.classifier {
+  font-family: sans-serif ;
+  font-style: oblique }
+span.classifier-delimiter {
+  font-family: sans-serif ;
+  font-weight: bold }
+span.interpreted {
+  font-family: sans-serif }
+span.option {
+  white-space: nowrap }
+span.pre {
+  white-space: pre }
+span.problematic, pre.problematic {
+  color: red }
+span.section-subtitle {
+  /* font-size relative to parent (h1..h6 element) */
+  font-size: 80% }
+table.citation {
+  border-left: solid 1px gray;
+  margin-left: 1px }
+table.docinfo {
+  margin: 2em 4em }
+table.docutils {
+  margin-top: 0.5em ;
+  margin-bottom: 0.5em }
+table.footnote {
+  border-left: solid 1px black;
+  margin-left: 1px }
+table.docutils td, table.docutils th,
+table.docinfo td, table.docinfo th {
+  padding-left: 0.5em ;
+  padding-right: 0.5em ;
+  vertical-align: top }
+table.docutils th.field-name, table.docinfo th.docinfo-name {
+  font-weight: bold ;
+  text-align: left ;
+  white-space: nowrap ;
+  padding-left: 0 }
+/* "booktabs" style (no vertical lines) */
+table.docutils.booktabs {
+  border: 0px;
+  border-top: 2px solid;
+  border-bottom: 2px solid;
+  border-collapse: collapse;
+}
+table.docutils.booktabs * {
+  border: 0px;
+}
+table.docutils.booktabs th {
+  border-bottom: thin solid;
+  text-align: left;
+}
+h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
+h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
+  font-size: 100% }
+ul.auto-toc {
+  list-style-type: none }
+</style>
+</head>
+<body>
+<div class="document">
+<a class="reference external image-reference" href="https://odoo-community.org/get-involved?utm_source=readme">
+<img alt="Odoo Community Association" src="https://odoo-community.org/readme-banner-image" />
+</a>
+<div class="section" id="delivery-ups-oca">
+<h1>Delivery UPS OCA</h1>
+<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+!! This file is generated by oca-gen-addon-readme !!
+!! changes will be overwritten.                   !!
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+!! source digest: sha256:5c5c1b09dfe20724c425c5b6c39f037b475f251b53e312baa365316b53fad92d
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
+<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/license-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/delivery-carrier/tree/17.0/delivery_ups_oca"><img alt="OCA/delivery-carrier" src="https://img.shields.io/badge/github-OCA%2Fdelivery--carrier-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/delivery-carrier-17-0/delivery-carrier-17-0-delivery_ups_oca"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/delivery-carrier&amp;target_branch=17.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
+<p>This module adds <a class="reference external" href="https://ups.com">UPS</a> to the available carriers.</p>
+<p>It allows you to register shippings, generate labels, get rates from
+order, read shipping states and cancel shipments using UPS webservice,
+so no need of exchanging any kind of file.</p>
+<p>When a sales order is created in Odoo and the UPS carrier is assigned,
+the shipping price that will be obtained will be the price that the UPS
+webservice estimates according to the order information (address and
+products).</p>
+<p><strong>Table of contents</strong></p>
+<div class="contents local topic" id="contents">
+<ul class="simple">
+<li><a class="reference internal" href="#configuration" id="toc-entry-1">Configuration</a></li>
+<li><a class="reference internal" href="#usage" id="toc-entry-2">Usage</a></li>
+<li><a class="reference internal" href="#known-issues-roadmap" id="toc-entry-3">Known issues / Roadmap</a></li>
+<li><a class="reference internal" href="#bug-tracker" id="toc-entry-4">Bug Tracker</a></li>
+<li><a class="reference internal" href="#credits" id="toc-entry-5">Credits</a><ul>
+<li><a class="reference internal" href="#authors" id="toc-entry-6">Authors</a></li>
+<li><a class="reference internal" href="#contributors" id="toc-entry-7">Contributors</a></li>
+<li><a class="reference internal" href="#maintainers" id="toc-entry-8">Maintainers</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="section" id="configuration">
+<h2><a class="toc-backref" href="#toc-entry-1">Configuration</a></h2>
+<p>To configure this module, you need to:</p>
+<ol class="arabic simple">
+<li>Add a Shipping Method with Provider <tt class="docutils literal">UPS</tt> and fill in your UPS
+credentials (Client ID and Client Secret)</li>
+<li>Configure in Odoo all required fields of the UPS tab with your
+account data <a class="reference external" href="https://wwwapps.ups.com/ppc/ppc.html">https://wwwapps.ups.com/ppc/ppc.html</a> (Shipper number,
+Default Packaging, Package Dimension Code, Package Weight Code and
+File Format).</li>
+<li>If yo have “Tracking state update sync” checked all delivery orders
+state check will be done querying UPS services.</li>
+<li>It is possible to create a UPS carrier for cash on delivery parcels.
+Select the <tt class="docutils literal">ups</tt> delivery type and check the “Cash on Delivery”
+checkbox under the “UPS” tab. It is required to select the “UPS COD
+Funds Code” when the “Cash on Delivery” option is selected.</li>
+</ol>
+<p><strong>NOTE</strong> You need to add an APP from <a class="reference external" href="https://developer.ups.com/">https://developer.ups.com/</a> for
+using the webservice.</p>
+</div>
+<div class="section" id="usage">
+<h2><a class="toc-backref" href="#toc-entry-2">Usage</a></h2>
+<p>You have to set the created shipping method in the delivery order to
+ship:</p>
+<ul class="simple">
+<li>When the picking is ‘Transferred’, a <em>Create Shipping Label</em> button
+appears. Just click on it, and if all went well, the label will be
+‘attached’.</li>
+<li>If the shipment creation process fails, a validation error will appear
+displaying UPS error.</li>
+<li>When the delivery order is cancelled, it’s automatically cancelled too
+in UPS.</li>
+<li>If you have “Tracking state update sync” checked in the shipping
+method, a periodical state check will be done querying UPS services.</li>
+</ul>
+</div>
+<div class="section" id="known-issues-roadmap">
+<h2><a class="toc-backref" href="#toc-entry-3">Known issues / Roadmap</a></h2>
+<ul class="simple">
+<li>Support international forms</li>
+<li>Support package service options</li>
+</ul>
+</div>
+<div class="section" id="bug-tracker">
+<h2><a class="toc-backref" href="#toc-entry-4">Bug Tracker</a></h2>
+<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/delivery-carrier/issues">GitHub Issues</a>.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us to smash it by providing a detailed and welcomed
+<a class="reference external" href="https://github.com/OCA/delivery-carrier/issues/new?body=module:%20delivery_ups_oca%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
+<p>Do not contact contributors directly about support or help with technical issues.</p>
+</div>
+<div class="section" id="credits">
+<h2><a class="toc-backref" href="#toc-entry-5">Credits</a></h2>
+<div class="section" id="authors">
+<h3><a class="toc-backref" href="#toc-entry-6">Authors</a></h3>
+<ul class="simple">
+<li>Hunki Enterprises BV</li>
+<li>Tecnativa</li>
+<li>ForgeFlow</li>
+</ul>
+</div>
+<div class="section" id="contributors">
+<h3><a class="toc-backref" href="#toc-entry-7">Contributors</a></h3>
+<ul class="simple">
+<li>Holger Brunn &lt;<a class="reference external" href="mailto:mail&#64;hunki-enterprises.nl">mail&#64;hunki-enterprises.nl</a>&gt;
+(<a class="reference external" href="https://hunki-enterprises.nl">https://hunki-enterprises.nl</a>)</li>
+<li><a class="reference external" href="https://www.tecnativa.com">Tecnativa</a>:<ul>
+<li>Víctor Martínez</li>
+<li>Pedro M. Baeza</li>
+</ul>
+</li>
+<li><a class="reference external" href="https://www.forgeflow.com">ForgeFlow</a>:<ul>
+<li>Jordi Ballester</li>
+</ul>
+</li>
+<li><a class="reference external" href="https://www.sygel.es">Sygel</a>:<ul>
+<li>Manuel Regidor</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="section" id="maintainers">
+<h3><a class="toc-backref" href="#toc-entry-8">Maintainers</a></h3>
+<p>This module is maintained by the OCA.</p>
+<a class="reference external image-reference" href="https://odoo-community.org">
+<img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" />
+</a>
+<p>OCA, or the Odoo Community Association, is a nonprofit organization whose
+mission is to support the collaborative development of Odoo features and
+promote its widespread use.</p>
+<p>This module is part of the <a class="reference external" href="https://github.com/OCA/delivery-carrier/tree/17.0/delivery_ups_oca">OCA/delivery-carrier</a> project on GitHub.</p>
+<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
+</div>
+</div>
+</div>
+</div>
+</body>
+</html>

odoo/addons/delivery_ups_oca/tests/__init__.py ADDED Viewed

@@ -0,0 +1,3 @@
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+from . import test_delivery_ups

odoo/addons/delivery_ups_oca/tests/test_delivery_ups.py ADDED Viewed

@@ -0,0 +1,165 @@
+# Copyright 2020 Hunki Enterprises BV
+# Copyright 2021-2022 Tecnativa - Víctor Martínez
+# Copyright 2024 Sygel - Manuel Regidor
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+import base64
+from unittest import mock
+from odoo.tests import Form, common
+_module_ns = "odoo.addons.delivery_ups_oca"
+_provider_class = _module_ns + ".models.ups_request.UpsRequest"
+class TestDeliveryUpsBase(common.TransactionCase):
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        product_shipping_cost = cls.env["product.product"].create(
+            {
+                "type": "service",
+                "name": "Shipping costs",
+                "standard_price": 10,
+                "list_price": 100,
+            }
+        )
+        cls.carrier = cls.env["delivery.carrier"].create(
+            {
+                "name": "UPS",
+                "delivery_type": "ups",
+                "product_id": product_shipping_cost.id,
+                "price_method": "fixed",
+                "ups_default_packaging_id": cls.env.ref(
+                    "delivery_ups_oca.product_packaging_ups_02"
+                ).id,
+            }
+        )
+        cls.company = cls.env.ref("base.main_company")
+        cls.company.partner_id.write(
+            {
+                "phone": "+%s976123456" % cls.company.country_id.phone_code,
+                "vat": "%s09915370R" % cls.company.country_id.code,
+            }
+        )
+        cls.partner = cls.env["res.partner"].create(
+            {
+                "name": "Test partner",
+                "country_id": cls.company.country_id.id,
+                "phone": cls.company.partner_id.phone,
+                "email": "test@odoo.com",
+                "street": cls.company.partner_id.street,
+                "city": cls.company.partner_id.city,
+                "zip": cls.company.partner_id.zip,
+                "state_id": cls.company.partner_id.state_id.id,
+                "vat": cls.company.partner_id.vat,
+            }
+        )
+        cls.product = cls.env["product.product"].create(
+            {"name": "Test product", "type": "product", "weight": 10}
+        )
+        cls.sale = cls._create_sale_order(cls)
+    def _create_sale_order(self):
+        order_form = Form(self.env["sale.order"])
+        order_form.partner_id = self.partner
+        with order_form.order_line.new() as line_form:
+            line_form.product_id = self.product
+            line_form.product_uom_qty = 10
+        sale = order_form.save()
+        delivery_wizard = Form(
+            self.env["choose.delivery.carrier"].with_context(
+                **{"default_order_id": sale.id, "default_carrier_id": self.carrier.id}
+            )
+        ).save()
+        delivery_wizard.button_confirm()
+        sale.action_confirm()
+        return sale
+class TestDeliveryUps(TestDeliveryUpsBase):
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        cls.picking = cls.sale.picking_ids[0]
+        cls.picking.move_ids.quantity = 10
+    def test_order_ups_rate_shipment(self):
+        with mock.patch(
+            _provider_class + "._rate_shipment",
+            return_value={
+                "RateResponse": {
+                    "RatedShipment": {
+                        "TotalCharges": {"MonetaryValue": 1, "CurrencyCode": "USD"}
+                    }
+                }
+            },
+        ):
+            res = self.carrier.ups_rate_shipment(self.sale)
+            self.assertGreater(res["price"], 0)
+            self.assertTrue(res["success"])
+    def test_order_ups_rate_shipment_currency_extra(self):
+        usd = self.env.ref("base.USD")
+        eur = self.env.ref("base.EUR")
+        currency = self.env.ref("base.main_company").currency_id
+        currency_extra = eur if currency == usd else usd
+        self.sale.currency_id = currency_extra
+        with mock.patch(
+            _provider_class + "._rate_shipment",
+            return_value={
+                "RateResponse": {
+                    "RatedShipment": {
+                        "TotalCharges": {"MonetaryValue": 1, "CurrencyCode": "USD"}
+                    }
+                }
+            },
+        ):
+            res = self.carrier.ups_rate_shipment(self.sale)
+            self.assertGreater(res["price"], 0)
+            self.assertTrue(res["success"])
+    def test_delivery_carrier_ups_integration(self):
+        self.picking.action_confirm()
+        self.picking.action_assign()
+        # Create a simple PDF-like bytes object for testing
+        label = b"%PDF-1.4\n%EOF"
+        with mock.patch(
+            _provider_class + "._send_shipping",
+            return_value={
+                "price": {"CurrencyCode": "USD", "MonetaryValue": "0.0"},
+                "ShipmentIdentificationNumber": "123456",
+                "labels": [
+                    {
+                        "tracking_ref": "123456",
+                        "format_code": "png",
+                        "datas": base64.b64encode(label),
+                    }
+                ],
+            },
+        ):
+            self.picking.send_to_shipper()
+            self.assertEqual(self.picking.message_attachment_count, 1)
+            self.assertTrue(self.picking.carrier_tracking_ref)
+            self.assertFalse(self.picking.tracking_state_history)
+            self.assertEqual(
+                self.picking.delivery_state, "shipping_recorded_in_carrier"
+            )
+            if self.picking.carrier_id.ups_tracking_state_update_sync:
+                with mock.patch(
+                    _provider_class + ".tracking_state_update",
+                    return_value={
+                        "delivery_state": "in_transit",
+                        "tracking_state_history": "history",
+                    },
+                ):
+                    self.picking.tracking_state_update()
+                    self.assertEqual(self.picking.delivery_state, "in_transit")
+                    self.assertTrue(self.picking.tracking_state_history)
+            with mock.patch(
+                _provider_class + ".cancel_shipment",
+                return_value=True,
+            ):
+                self.picking.cancel_shipment()
+                self.assertFalse(self.picking.carrier_tracking_ref)
+                self.assertEqual(self.picking.delivery_state, "canceled_shipment")