deliveries 0.1.0

data/lib/deliveries/couriers/mondial_relay/pickups/create/format_params.rb

@@ -0,0 +1,57 @@
+module Deliveries
+  module Couriers
+    module MondialRelay
+      module Pickups
+        class Create
+          class FormatParams
+            attr_accessor :sender, :receiver, :parcels, :reference_code, :pickup_date, :remarks, :language
+
+            def initialize(sender:, receiver:, parcels:, reference_code:, pickup_date:, remarks:, language:)
+              self.sender = sender
+              self.receiver = receiver
+              self.parcels = parcels
+              self.reference_code = reference_code
+              self.pickup_date = pickup_date
+              self.remarks = remarks
+              self.language = language
+            end
+
+            def execute
+              params = {
+                'Enseigne' => Deliveries::Couriers::MondialRelay.config(:mondial_relay_merchant),
+                'ModeCol' => 'REL',
+                'ModeLiv' => 'LCC',
+                'COL_Rel_Pays' => 'XX',
+                'COL_Rel' => 'AUTO',
+                'NDossier' => reference_code,
+                'Expe_Langage' => language.to_s.upcase,
+                'Expe_Ad1' => sender.name,
+                'Expe_Ad3' => sender.street,
+                'Expe_Ville' => sender.city,
+                'Expe_CP' => sender.postcode,
+                'Expe_Pays' => sender.country,
+                'Expe_Tel1' => sender.phone,
+                'Expe_Mail' => sender.email,
+                'Dest_Langage' => language.to_s.upcase,
+                'Dest_Ad1' => receiver.name,
+                'Dest_Ad3' => receiver.street,
+                'Dest_Ville' => receiver.city,
+                'Dest_CP' => receiver.postcode,
+                'Dest_Pays' => receiver.country,
+                'Dest_Tel1' => receiver.phone,
+                'Dest_Mail' => receiver.email,
+                'NbColis' => parcels,
+                'Instructions' => I18n.transliterate(remarks.to_s).gsub(%r{[^0-9A-Z_\-'., /]}i, '').upcase.truncate(30,
+                                                                                                                    omission: '')
+              }
+
+              defaults = Shipments::Create::Defaults::PARAMS
+
+              defaults.merge(params)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/deliveries/couriers/mondial_relay/shipments/create/defaults.rb

@@ -0,0 +1,96 @@
+# COLLECTION MODES:
+# CCC: Merchant collection
+# CDR: Home collection standard shipments
+# CDS: Home collection heavy shipments
+# REL: Point relais collection
+
+# DELIVERY MODES:
+# 24R: Point relais delivery
+# 24L: POint relais XL delivery
+# 24X: Point relais XXL delivery
+# DRI: Colis drive delivery
+# LD1: Home delivery(1 delivery man)
+# LDS: Home delivery(2 delivery men)
+# HOM: Home delivery < 30kg
+# HOC: Home delivery (specific for Spain)
+# LCC: Reverse
+
+module Deliveries
+  module Couriers
+    module MondialRelay
+      module Shipments
+        class Create
+          module Defaults
+            COLLECTION_MODES = {
+              home_collection_standard: 'CDR',
+              point_relais_collection: 'REL'
+            }.freeze
+
+            DELIVERY_MODES = {
+              home_delivery_standard: 'LD1',
+              point_relais_delivery: '24R'
+            }.freeze
+
+            PARAMS = {
+              'Enseigne' => '',
+              'ModeCol' => 'CCC', # Collection mode
+              'ModeLiv' => '', # Delivery mode
+              'NDossier' => '', # Reference code
+
+              'NClient' => '', # sender reference
+              'Expe_Langage' => '',
+              'Expe_Ad1' => '',
+              'Expe_Ad2' => '',
+              'Expe_Ad3' => '',
+              'Expe_Ad4' => '',
+              'Expe_Ville' => '',
+              'Expe_CP' => '',
+              'Expe_Pays' => '',
+              'Expe_Tel1' => '',
+              'Expe_Tel2' => '',
+              'Expe_Mail' => '',
+
+              'Dest_Langage' => '',
+              'Dest_Ad1' => '',
+              'Dest_Ad2' => '',
+              'Dest_Ad3' => '',
+              'Dest_Ad4' => '',
+              'Dest_Ville' => '',
+              'Dest_CP' => '',
+              'Dest_Pays' => '',
+              'Dest_Tel1' => '',
+              'Dest_Tel2' => '',
+              'Dest_Mail' => '',
+
+              'Poids' => '1000', # weight in grams
+              'Longueur' => '', # length
+              'Taille' => '', # size
+              'NbColis' => '1', # Number of parcels
+
+              # TODO: COD shipment value in cents?
+              'CRT_Valeur' => '0',
+              'CRT_Devise' => '',
+              'Exp_Valeur' => '', # Price
+              'Exp_Devise' => '', # Currency
+
+              # Collection point info
+              'COL_Rel_Pays' => '',
+              'COL_Rel' => '',
+
+              # Delivery point info
+              'LIV_Rel_Pays' => '',
+              'LIV_Rel' => '',
+
+              'TAvisage' => '', # notify
+              'TReprise' => '',
+              'Montage' => '', # assembly time
+              'TRDV' => '', # request for delivery appointment
+              'Assurance' => '',
+              'Instructions' => ''
+            }.freeze
+          end
+        end
+      end
+    end
+  end
+end

data/lib/deliveries/couriers/mondial_relay/shipments/create/format_params.rb

@@ -0,0 +1,68 @@
+module Deliveries
+  module Couriers
+    module MondialRelay
+      module Shipments
+        class Create
+          class FormatParams
+            attr_accessor :sender, :receiver, :parcels, :reference_code, :collection_point, :remarks, :language
+
+            def initialize(sender:, receiver:, parcels:, reference_code:, collection_point:, remarks:, language:)
+              self.sender = sender
+              self.receiver = receiver
+              self.parcels = parcels
+              self.reference_code = reference_code
+              self.collection_point = collection_point
+              self.remarks = remarks
+              self.language = language
+            end
+
+            def execute
+              params = {
+                'Enseigne' => Deliveries::Couriers::MondialRelay.config(:mondial_relay_merchant),
+                'NDossier' => reference_code,
+                'Expe_Langage' => language.to_s.upcase,
+                'Expe_Ad1' => sender.name,
+                'Expe_Ad3' => sender.street,
+                'Expe_Ville' => sender.city,
+                'Expe_CP' => sender.postcode,
+                'Expe_Pays' => sender.country,
+                'Expe_Tel1' => sender.phone,
+                'Expe_Mail' => sender.email,
+                'Dest_Langage' => language.to_s.upcase,
+                'Dest_Ad1' => receiver.name,
+                'Dest_Ad3' => receiver.street,
+                'Dest_Ville' => receiver.city,
+                'Dest_CP' => receiver.postcode,
+                'Dest_Pays' => receiver.country.to_s.upcase,
+                'Dest_Tel1' => receiver.phone,
+                'Dest_Mail' => receiver.email,
+                'NbColis' => parcels,
+                'Instructions' => I18n.transliterate(remarks.to_s).gsub(%r{[^0-9A-Z_\-'., /]}i, '').upcase.truncate(30,
+                                                                                                                    omission: '')
+              }
+
+              # Receiving in a collection point
+              receive_mode_params = if collection_point.present?
+                                      {
+                                        'ModeLiv' => '24R',
+                                        'LIV_Rel_Pays' => receiver.country,
+                                        'LIV_Rel' => collection_point.point_id,
+                                        'COL_Rel_Pays' => receiver.country,
+                                        'COL_Rel' => collection_point.point_id
+                                      }
+                                    else
+                                      {
+                                        'ModeLiv' => 'HOM'
+                                      }
+                                    end
+
+              defaults = Defaults::PARAMS
+
+              defaults.merge(params).merge(receive_mode_params)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/deliveries/couriers/mondial_relay/shipments/create.rb

@@ -0,0 +1,36 @@
+module Deliveries
+  module Couriers
+    module MondialRelay
+      module Shipments
+        class Create
+          attr_accessor :params
+
+          def initialize(params:)
+            self.params = params
+          end
+
+          def execute
+            params['Security'] = Deliveries::Couriers::MondialRelay.calculate_security_param params
+
+            # Call web service.
+            response = MondialRelay.api_client.call :wsi2_creation_etiquette, message: params
+            # If response returns OK stat code.
+            response_result = response.body[:wsi2_creation_etiquette_response][:wsi2_creation_etiquette_result]
+            if response_result && response_result[:stat] == '0'
+              {
+                tracking_code: response_result[:expedition_num],
+                label_url: "http://www.mondialrelay.com#{response_result[:url_etiquette].gsub('format=A4',
+                                                                                              'format=10x15')}"
+              }
+            else
+              raise Deliveries::APIError.new(
+                StatusCodes.message_for(response_result[:stat].to_i),
+                response_result[:stat]
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/deliveries/couriers/mondial_relay/shipments/trace/format_response.rb

@@ -0,0 +1,94 @@
+require 'active_support/time'
+
+module Deliveries
+  module Couriers
+    module MondialRelay
+      module Shipments
+        class Trace
+          class FormatResponse
+            attr_accessor :response
+
+            def initialize(response:)
+              self.response = response
+            end
+
+            def execute
+              statuses = response[:tracing][:ret_wsi2_sub_tracing_colis_detaille].delete_if do |key, _value|
+                key[:libelle].blank?
+              end
+
+              tracking_info_params = {}
+              tracking_info_params[:courier_id] = 'mondial_relay'
+              tracking_info_params[:status] = shipment_status(response[:stat].to_i, last_status(statuses))
+              tracking_info_params[:checkpoints] = formatted_checkpoints(statuses)
+
+              tracking_info_params
+            end
+
+            private
+
+            def last_status(statuses)
+              statuses.map { |s| s[:libelle] }
+                      .compact
+                      .last
+            end
+
+            def formatted_checkpoints(statuses)
+              checkpoints = []
+              statuses.each do |status|
+                checkpoints << formatted_checkpoint(status)
+              end
+
+              checkpoints
+            end
+
+            def formatted_checkpoint(status)
+              Deliveries::Checkpoint.new(
+                status: checkpoint_status(status[:libelle]),
+                location: status[:emplacement],
+                tracked_at: Time.zone.strptime("#{status[:date]} #{status[:heure]}", '%d/%m/%y %H:%M'),
+                description: status[:libelle]
+              )
+            end
+
+            def shipment_status(stat, last_checkpoint_status)
+              case stat
+              when 80
+                :registered
+              when 82
+                :delivered
+              when 81
+                if ['Disponible en el Punto Pack', 'DISPONIBLE AU POINT RELAIS'].include?(last_checkpoint_status)
+                  :in_collection_point
+                else
+                  :in_transit
+                end
+              else
+                :unknown_status
+              end
+            end
+
+            def checkpoint_status(message)
+              case message
+              when 'Disponible en el Punto Pack', 'Recepcionado en el Punto Pack',
+                   'DISPONIBLE AU POINT RELAIS', 'PRISE EN CHARGE POINT RELAIS'
+                :in_collection_point
+              when 'Recogido en agencia Punto Pack',
+                   'RÉCEPTION DES DONNÉES'
+                :registered
+              when 'Recogido en el hub', 'En reparto',
+                   'PRISE EN CHARGE EN AGENCE', 'COLIS REMIS AU LIVREUR'
+                :in_transit
+              when 'Paquete entregado al Destinata', 'Liquidado en Ensena',
+                   'COLIS LIVRÉ'
+                :delivered
+              else
+                :unknown_status
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/deliveries/couriers/mondial_relay/shipments/trace.rb

@@ -0,0 +1,47 @@
+module Deliveries
+  module Couriers
+    module MondialRelay
+      module Shipments
+        class Trace
+          SUPPORTED_LANGUAGES = %i[fr es nl en].freeze
+
+          attr_accessor :tracking_code, :language
+
+          def initialize(tracking_code:, language:)
+            self.tracking_code = tracking_code
+            self.language =
+              if SUPPORTED_LANGUAGES.include? language&.to_sym&.downcase
+                language
+              else
+                'en'
+              end
+          end
+
+          def execute
+            params = { 'Enseigne' => Deliveries::Couriers::MondialRelay.config(:mondial_relay_merchant),
+                       'Expedition' => tracking_code,
+                       'Langue' => language }
+
+            params['Security'] = Deliveries::Couriers::MondialRelay.calculate_security_param params
+
+            # Call web service.
+            response = MondialRelay.api_client.call :wsi2_tracing_colis_detaille, message: params
+
+            response_result = response.body.dig(:wsi2_tracing_colis_detaille_response,
+                                                :wsi2_tracing_colis_detaille_result)
+            if  response_result.present? &&
+                StatusCodes.tracking_info_success?(response_result[:stat].to_i)
+
+              response_result
+            else
+              raise Deliveries::APIError.new(
+                StatusCodes.message_for(response_result[:stat].to_i),
+                response_result[:stat]
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/deliveries/couriers/mondial_relay/status_codes.rb

@@ -0,0 +1,105 @@
+module Deliveries
+  module Couriers
+    module MondialRelay
+      STATUS_CODES = {
+        0 => 'Successful operation',
+        1 => 'Incorrect merchant',
+        2 => 'Merchant number empty',
+        3 => 'Incorrect merchant account number',
+
+        5 => 'Incorrect Merchant shipment reference',
+
+        7 => 'Incorrect Consignee reference',
+        8 => 'Incorrect password or hash',
+        9 => 'Unknown or not unique city',
+        10 => 'Incorrect type of collection',
+        11 => 'Point Relais collection number incorrect',
+        12 => 'Point Relais collection country incorrect',
+        13 => 'Incorrect type of delivery',
+        14 => 'Incorrect delivery Point Relais number',
+        15 => 'Point Relais delivery country incorrect',
+
+        20 => 'Incorrect parcel weight',
+        21 => 'Incorrect developped lenght (length + height)',
+        22 => 'Incorrect parcel size',
+
+        24 => 'Incorrect shipment number',
+
+        26 => 'Incorrect assembly time',
+        27 => 'Incorrect mode of collection or delivery',
+        28 => 'Incorrect mode of collection',
+        29 => 'Incorrect mode of delivery',
+        30 => 'Incorrect address (L1)',
+        31 => 'Incorrect address (L2)',
+
+        33 => 'Incorrect address (L3)',
+        34 => 'Incorrect address (L4)',
+
+        35 => 'Incorrect city',
+        36 => 'Incorrect zip code',
+        37 => 'Incorrect country',
+        38 => 'Incorrect phone number',
+        39 => 'Incorrect e-mail',
+        40 => 'Missing parameters',
+
+        42 => 'Incorrect COD value',
+        43 => 'Incorrect COD currency',
+        44 => 'Incorrect shipment value',
+        45 => 'Incorrect shipment value currency',
+        46 => 'End of shipments number range reached',
+        47 => 'Incorrect number of parcels',
+        48 => 'Multi-Parcel not permitted at Point Relais',
+        49 => 'Incorrect action',
+
+        60 => 'Incorrect text field (this error code has no impact)',
+        61 => 'Incorrect notification request',
+        62 => 'Incorrect extra delivery information',
+        63 => 'Incorrect insurance',
+        64 => 'Incorrect assembly time',
+        65 => 'Incorrect appointement',
+        66 => 'Incorrect take back',
+        67 => 'Incorrect latitude',
+        68 => 'Incorrect longitude',
+        69 => 'Incorrect merchant code',
+        70 => 'Incorrect Point Relais number',
+        71 => 'Incorrect Nature de point de vente non valide',
+        74 => 'Incorrect language',
+        78 => 'Incorrect country of collection',
+        79 => 'Incorrect country of delivery',
+        80 => 'Tracking code : Recorded parcel',
+        81 => 'Tracking code : Parcel in process at Mondial Relay',
+        82 => 'Tracking code : Delivered parcel',
+        83 => 'Tracking code : Anomaly',
+        84 => '(Reserved tracking code)',
+        85 => '(Reserved tracking code)',
+        86 => '(Reserved tracking code)',
+        87 => '(Reserved tracking code)',
+        88 => '(Reserved tracking code)',
+        89 => '(Reserved tracking code)',
+        92 => 'The Point Relais country code and the consignee’s country code are different',
+        93 => 'No information given by the sorting plan',
+        94 => 'Unknown parcel',
+        95 => 'Merchant account not activated',
+        97 => 'Incorrect security key',
+        98 => 'Generic error (Incorrect parameters)',
+        99 => 'Generic error of service system (technical). Contact MR'
+      }.freeze
+
+      module StatusCodes
+        module_function
+
+        def success?(status)
+          status&.zero? || (80..83).cover?(status)
+        end
+
+        def tracking_info_success?(status)
+          status&.zero? || (80..89).cover?(status)
+        end
+
+        def message_for(status)
+          STATUS_CODES[status] || 'Unknown status'
+        end
+      end
+    end
+  end
+end