deliveries 0.1.0

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

@@ -0,0 +1,101 @@
+require 'httparty'
+
+module Deliveries
+  module Couriers
+    module CorreosExpress
+      module Shipments
+        class Create
+          include HTTParty
+
+          attr_accessor :sender, :receiver, :collection_point, :parcels,
+                        :reference_code, :shipment_date, :remarks
+
+          def initialize(sender:, receiver:, collection_point:, parcels:,
+                         reference_code:, shipment_date:, remarks:)
+            self.sender = sender
+            self.receiver = receiver
+            self.collection_point = collection_point
+            self.parcels = parcels
+            self.reference_code = reference_code
+            self.shipment_date = shipment_date
+            self.remarks = remarks
+          end
+
+          def execute
+            auth = {
+              username: CorreosExpress.config(:username),
+              password: CorreosExpress.config(:password)
+            }
+
+            params = FormatParams.new(
+              sender: sender.courierize(:correos_express),
+              receiver: receiver.courierize(:correos_express),
+              collection_point: collection_point,
+              parcels: parcels,
+              reference_code: reference_code,
+              shipment_date: shipment_date,
+              remarks: remarks
+            ).execute
+
+            response = self.class.post(
+              api_endpoint,
+              basic_auth: auth,
+              body: params,
+              headers: headers,
+              debug_output: Deliveries.debug ? Deliveries.logger : nil
+            )
+            raise Deliveries::ClientError unless response.success?
+
+            parsed_response = JSON.parse(response.body, symbolize_names: true)
+            if parsed_response[:codigoRetorno].zero? && parsed_response.key?(:datosResultado)
+              tracking_code = parsed_response[:datosResultado]
+              decoded_label = decode_label(parsed_response.dig(:etiqueta, 0, :etiqueta1))
+              label = Label.new(raw: decoded_label) if decoded_label
+
+              Deliveries::Shipment.new(
+                courier_id: 'correos_express',
+                sender: sender,
+                receiver: receiver,
+                parcels: parcels,
+                reference_code: reference_code,
+                tracking_code: tracking_code,
+                shipment_date: shipment_date,
+                label: label
+              )
+            else
+              raise Deliveries::APIError.new(
+                parsed_response[:mensajeRetorno],
+                parsed_response[:codigoRetorno]
+              )
+            end
+          end
+
+          private
+
+          def api_endpoint
+            if CorreosExpress.live?
+              CorreosExpress::SHIPMENTS_ENDPOINT_LIVE
+            else
+              CorreosExpress::SHIPMENTS_ENDPOINT_TEST
+            end
+          end
+
+          def headers
+            { 'Content-Type' => "application/json; charset='UTF-8'" }
+          end
+
+          def decode_label(encoded_label)
+            return nil if encoded_label.blank?
+
+            decoded_label = Base64.decode64(Base64.decode64(encoded_label)).force_encoding('binary')
+
+            # Check pdf file signature
+            return nil unless decoded_label[0..4].unpack1('H*').hex == 0x255044462d
+
+            decoded_label
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+require 'active_support/time'
+
+module Deliveries
+  module Couriers
+    module CorreosExpress
+      module Shipments
+        class Trace
+          class FormatResponse
+            attr_accessor :response
+
+            def initialize(response:)
+              self.response = response
+            end
+
+            def execute
+              tracking_info_params = {}
+              tracking_info_params[:courier_id] = 'correos_express'
+              tracking_info_params[:tracking_code] = response['NumEnvio']
+              tracking_info_params[:status] = status(response['DescEstado'])
+              tracking_info_params[:checkpoints] = formatted_checkpoints(response['EstadoEnvios'])
+
+              tracking_info_params
+            end
+
+            private
+
+            def formatted_checkpoints(shipment_statuses)
+              checkpoints = []
+              if shipment_statuses.is_a?(Array)
+                shipment_statuses.each do |shipment_status|
+                  checkpoints << formatted_checkpoint(shipment_status)
+                end
+              else
+                checkpoints << formatted_checkpoint(shipment_statuses)
+              end
+
+              checkpoints
+            end
+
+            def formatted_checkpoint(shipment_status)
+              Deliveries::Checkpoint.new(
+                status: status(shipment_status['DescEstado']),
+                location: nil,
+                tracked_at: Time.zone.strptime("#{shipment_status['FechaEstado']} #{shipment_status['HoraEstado']}",
+                                               '%d%m%Y %H%M%S'),
+                description: shipment_status['DescEstado']
+              )
+            end
+
+            def status(code)
+              case code
+              when 'SIN RECEPCION'
+                :registered
+              when 'EN ARRASTRE', 'DELEGACION DESTINO', 'EN REPARTO', 'TRAMO ORIGEN'
+                :in_transit
+              when 'ENTREGADO'
+                :delivered
+              else
+                :unknown_status
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+require 'httparty'
+require 'active_support/core_ext/hash/conversions'
+
+module Deliveries
+  module Couriers
+    module CorreosExpress
+      module Shipments
+        class Trace
+          include HTTParty
+
+          attr_accessor :tracking_code
+
+          def initialize(tracking_code:)
+            self.tracking_code = tracking_code
+          end
+
+          def execute
+            auth = {
+              username: CorreosExpress.config(:username),
+              password: CorreosExpress.config(:password)
+            }
+            solicitante = CorreosExpress.config(:client_code)
+
+            xml = "<?xml version='1.0'?>
+              <SeguimientoEnviosRequest xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
+              xsi:noNamespaceSchemaLocation='SeguimientoEnviosRequest.xsd'>
+                                <Solicitante>#{solicitante}</Solicitante>
+                                <Dato>#{tracking_code}</Dato>
+              </SeguimientoEnviosRequest>"
+
+            response = self.class.post(
+              api_endpoint,
+              basic_auth: auth,
+              body: xml,
+              headers: { 'Content-Type' => 'application/xml' },
+              debug_output: Deliveries.debug ? Deliveries.logger : nil
+            )
+
+            raise Deliveries::ClientError unless response.success?
+
+            result = Hash.from_xml response.force_encoding(Encoding::ISO_8859_1).encode(Encoding::UTF_8)
+            if result['SeguimientoEnviosResponse']['Error'] == '0'
+              result['SeguimientoEnviosResponse']
+            else
+              raise Deliveries::APIError.new(
+                result['SeguimientoEnviosResponse']['MensajeError'],
+                result['SeguimientoEnviosResponse']['Error']
+              )
+            end
+          end
+
+          private
+
+          def api_endpoint
+            if CorreosExpress.live?
+              CorreosExpress::TRACKING_INFO_ENDPOINT_LIVE
+            else
+              CorreosExpress::TRACKING_INFO_ENDPOINT_TEST
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/deliveries/couriers/correos_express.rb

@@ -0,0 +1,162 @@
+require_relative 'correos_express/shipments/trace/format_response'
+require_relative 'correos_express/shipments/trace'
+require_relative 'correos_express/shipments/create/defaults'
+require_relative 'correos_express/shipments/create/format_params'
+require_relative 'correos_express/shipments/create'
+require_relative 'correos_express/collection_points/search'
+require_relative 'correos_express/collection_points/search/format_response'
+require_relative 'correos_express/labels/generate'
+require_relative 'correos_express/pickups/create/defaults'
+require_relative 'correos_express/pickups/create/format_params'
+require_relative 'correos_express/pickups/create'
+require_relative 'correos_express/pickups/trace/format_response'
+require_relative 'correos_express/pickups/trace'
+require_relative 'correos_express/pickups/cutoff_time/format_params'
+require_relative 'correos_express/pickups/cutoff_time'
+require_relative 'correos_express/address'
+
+module Deliveries
+  module Couriers
+    module CorreosExpress
+      extend Courier
+
+      Config = Struct.new(
+        :username,
+        :password,
+        :client_code,
+        :shipment_sender_code,
+        :pickup_receiver_code,
+        :countries
+      )
+
+      COLLECTION_POINTS_ENDPOINT_TEST = 'https://www.correosexpress.com/wspsc/apiRestOficina/v1/oficinas/listadoOficinasCoordenadas'.freeze
+      COLLECTION_POINTS_ENDPOINT_LIVE = 'https://www.correosexpress.com/wpsc/apiRestOficina/v1/oficinas/listadoOficinasCoordenadas'.freeze
+      SHIPMENTS_ENDPOINT_LIVE = 'https://www.correosexpress.com/wpsc/apiRestGrabacionEnvio/json/grabacionEnvio'.freeze
+      SHIPMENTS_ENDPOINT_TEST = 'https://test.correosexpress.com/wspsc/apiRestGrabacionEnvio/json/grabacionEnvio'.freeze
+      TRACKING_INFO_ENDPOINT_LIVE = 'https://www.correosexpress.com/wpsc/apiRestSeguimientoEnvios/rest/seguimientoEnvios'.freeze
+      TRACKING_INFO_ENDPOINT_TEST = 'https://test.correosexpress.com/wspsc/apiRestSeguimientoEnvios/rest/seguimientoEnvios'.freeze
+      LABELS_ENDPOINT_LIVE = 'https://www.cexpr.es/wspsc/apiRestEtiquetaTransporte/json/etiquetaTransporte'.freeze
+      LABELS_ENDPOINT_TEST = 'https://www.test.cexpr.es/wsps/apiRestEtiquetaTransporte/json/etiquetaTransporte'.freeze
+      PICKUPS_ENDPOINT_LIVE = 'https://www.correosexpress.com/wpsc/apiRestGrabacionRecogida/json/grabarRecogida'.freeze
+      PICKUPS_ENDPOINT_TEST = 'https://test.correosexpress.com/wpsn/apiRestGrabacionRecogida/json/grabarRecogida'.freeze
+      CUTOFF_TIME_ENDPOINT_LIVE = 'https://www.correosexpress.com/wpsc/apiRestGrabacionRecogida/json/horaCorte'.freeze
+
+      module_function
+
+      def get_collection_points(postcode:, **)
+        raise Deliveries::APIError, 'Postcode cannot be null' if postcode.blank?
+
+        collection_points = []
+
+        points = CollectionPoints::Search.new(postcode: postcode).execute
+        points.each do |point|
+          collection_point_params = CollectionPoints::Search::FormatResponse.new(response: point).execute
+          collection_points << Deliveries::CollectionPoint.new(collection_point_params)
+        end
+
+        collection_points
+      end
+
+      def get_collection_point(global_point_id:)
+        global_point = Deliveries::CollectionPoint.parse_global_point_id(global_point_id: global_point_id)
+
+        collection_points = get_collection_points(postcode: global_point.postcode)
+        collection_point = collection_points.select { |col| col.point_id == global_point.point_id }.first
+
+        if collection_point.blank?
+          raise Deliveries::APIError.new(
+            "Collection Point not found - #{global_point.point_id}",
+            1
+          )
+        end
+
+        collection_point
+      end
+
+      def shipment_info(tracking_code:, **)
+        response = Shipments::Trace.new(
+          tracking_code: tracking_code
+        ).execute
+
+        tracking_info_params = Shipments::Trace::FormatResponse.new(response: response).execute
+        Deliveries::TrackingInfo.new(tracking_info_params)
+      end
+
+      def pickup_info(tracking_code:, **)
+        response = Pickups::Trace.new(
+          tracking_code: tracking_code
+        ).execute
+
+        tracking_info_params = Pickups::Trace::FormatResponse.new(response: response).execute
+
+        Deliveries::TrackingInfo.new(tracking_info_params)
+      end
+
+      def get_label(tracking_code:, **)
+        pdf = Labels::Generate.new(
+          tracking_codes: tracking_code
+        ).execute.first
+
+        Deliveries::Label.new(raw: pdf)
+      end
+
+      def get_labels(tracking_codes:, **)
+        labels = Deliveries::Labels.new
+
+        Labels::Generate.new(
+          tracking_codes: tracking_codes
+        ).execute.each do |pdf|
+          labels << pdf
+        end
+
+        labels
+      end
+
+      def create_shipment(sender:, receiver:, parcels:, reference_code:, collection_point: nil, shipment_date: nil, remarks: nil, **)
+        Shipments::Create.new(
+          sender: sender,
+          receiver: receiver,
+          collection_point: collection_point,
+          shipment_date: shipment_date,
+          parcels: parcels,
+          reference_code: reference_code,
+          remarks: remarks
+        ).execute
+      end
+
+      def create_pickup(sender:, receiver:, parcels:, reference_code:,
+                        pickup_date: nil, remarks: nil, **)
+        time_interval = nil
+        begin
+          params = Pickups::Create::FormatParams.new(
+            sender: sender.courierize(:correos_express),
+            receiver: receiver.courierize(:correos_express),
+            parcels: parcels,
+            reference_code: reference_code,
+            pickup_date: pickup_date,
+            remarks: remarks,
+            time_interval: time_interval
+          ).execute
+
+          pickup_number = Pickups::Create.new(params: params).execute
+        rescue InvalidTimeIntervalError => e
+          raise e if time_interval
+          raise e unless (cutoff_time = e.message[/\b(\d+):\d{2}\z/, 1])
+
+          time_interval = 9..cutoff_time.to_i
+          retry
+        end
+
+        Deliveries::Pickup.new(
+          courier_id: 'correos_express',
+          sender: sender,
+          receiver: receiver,
+          parcels: parcels,
+          reference_code: reference_code,
+          tracking_code: pickup_number,
+          pickup_date: pickup_date
+        )
+      end
+    end
+  end
+end

data/lib/deliveries/couriers/dummy.rb

@@ -0,0 +1,106 @@
+module Deliveries
+  module Couriers
+    module Dummy
+      extend Courier
+
+      module_function
+
+      def get_collection_point(global_point_id:)
+        point = CollectionPoint.parse_global_point_id global_point_id: global_point_id
+        CollectionPoint.new name: 'Dummy',
+                            email: 'dummy@dummy.com',
+                            phone: '555 555 555',
+                            country: point.country.to_sym,
+                            state: 'Bizkaia',
+                            city: 'Erandio',
+                            street: 'Axpe',
+                            postcode: point.postcode,
+                            courier_id: 'dummy',
+                            point_id: point.point_id,
+                            latitude: 43.312132,
+                            longitude: -2.979586,
+                            timetable: {
+                              0 => [],
+                              1 => [OpenStruct.new(open: '8:00', close: '14:00'),
+                                    OpenStruct.new(open: '16:00', close: '20:00')],
+                              2 => [OpenStruct.new(open: '8:00', close: '14:00'),
+                                    OpenStruct.new(open: '16:00', close: '20:00')],
+                              3 => [OpenStruct.new(open: '8:00', close: '14:00'),
+                                    OpenStruct.new(open: '16:00', close: '20:00')],
+                              4 => [OpenStruct.new(open: '8:00', close: '14:00'),
+                                    OpenStruct.new(open: '16:00', close: '20:00')],
+                              5 => [OpenStruct.new(open: '8:00', close: '15:00')],
+                              6 => []
+                            },
+                            url_map: nil,
+                            url_photo: nil
+      end
+
+      def get_collection_points(country:, postcode:)
+        [
+          get_collection_point(global_point_id: "dummy~#{country}~#{postcode}~1"),
+          get_collection_point(global_point_id: "dummy~#{country}~#{postcode}~2")
+        ]
+      end
+
+      def shipment_info(tracking_code:, **)
+        TrackingInfo.new courier_id: 'dummy',
+                         tracking_code: tracking_code,
+                         status: :in_transit,
+                         checkpoints: [
+                           Checkpoint.new(status: :registered, location: 'Source city', tracked_at: 1.week.ago,
+                                          description: 'Parcel taken'),
+                           Checkpoint.new(status: :in_transit, location: 'Halfway city', tracked_at: 1.day.ago,
+                                          description: 'There is some delay')
+                         ],
+                         url: 'https://google.com'
+      end
+
+      def pickup_info(tracking_code:, **)
+        TrackingInfo.new courier_id: 'dummy',
+                         tracking_code: tracking_code,
+                         status: :in_transit,
+                         checkpoints: [
+                           Checkpoint.new(status: :registered, location: 'Source city', tracked_at: 1.week.ago,
+                                          description: 'Parcel taken'),
+                           Checkpoint.new(status: :in_transit, location: 'Halfway city', tracked_at: 1.day.ago,
+                                          description: 'There is some delay')
+                         ],
+                         url: 'https://google.com'
+      end
+
+      def create_shipment(sender:, receiver:, parcels:, reference_code:, shipment_date: nil, **)
+        Shipment.new courier_id: 'dummy',
+                     sender: sender,
+                     receiver: receiver,
+                     parcels: parcels,
+                     reference_code: reference_code,
+                     tracking_code: reference_code,
+                     shipment_date: shipment_date
+      end
+
+      def create_pickup(sender:, receiver:, parcels:, reference_code:, pickup_date: nil, **)
+        Pickup.new courier_id: 'dummy',
+                   sender: sender,
+                   receiver: receiver,
+                   parcels: parcels,
+                   reference_code: reference_code,
+                   tracking_code: reference_code,
+                   pickup_date: pickup_date
+      end
+
+      def get_label(**)
+        pdf = <<~PDF
+          %PDF-1.0
+          1 0 obj<</Pages 2 0 R>>endobj 2 0 obj<</Kids[3 0 R]/Count 1>>endobj 3 0 obj<</MediaBox[0 0 3 3]>>endobj
+          trailer<</Root 1 0 R>>
+        PDF
+        Deliveries::Label.new(raw: pdf)
+      end
+
+      def get_labels(tracking_codes:, language: nil)
+        get_label tracking_code: tracking_codes, language: language
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+module Deliveries
+  module Couriers
+    module MondialRelay
+      class Address < Deliveries::Address
+        def name
+          I18n.transliterate(@name.to_s).gsub(%r{[^0-9A-Z_\-'., /]}i, '').upcase.truncate(32, omission: '')
+        end
+
+        def street
+          I18n.transliterate(@street.to_s).gsub(%r{[^0-9A-Z_\-'., /]}i, '').upcase.truncate(32, omission: '')
+        end
+
+        def city
+          I18n.transliterate(@city.to_s).gsub(/[^A-Z_\-' ]/i, '').upcase.truncate(25, omission: '')
+        end
+
+        def country
+          @country.to_s.upcase
+        end
+
+        def phone
+          format_international_phone
+        end
+
+        def email
+          format_email
+        end
+      end
+    end
+  end
+end

data/lib/deliveries/couriers/mondial_relay/collection_points/search/format_response.rb

@@ -0,0 +1,103 @@
+# :stat=>"0",
+# :num=>"070912",
+# :lg_adr1=>"VENANDCOM                      ",
+# :lg_adr2=>nil,
+# :lg_adr3=>"CL LANGILERIA 126              ",
+# :lg_adr4=>nil,
+# :cp=>"48940",
+# :ville=>"LEIOA                     ",
+# :pays=>"ES",
+# :localisation1=>"ENTRE METRO LAMIACO Y ROMO    ",
+# :localisation2=>nil,
+# :horaires_lundi=>{:string=>["1000", "1330", "1700", "2000"]},
+# :horaires_mardi=>{:string=>["1000", "1330", "1700", "2000"]},
+# :horaires_mercredi=>{:string=>["1000", "1330", "1700", "2000"]},
+# :horaires_jeudi=>{:string=>["1000", "1330", "1700", "2000"]},
+# :horaires_vendredi=>{:string=>["1000", "1330", "1700", "2000"]},
+# :horaires_samedi=>{:string=>["1000", "1330", "0000", "0000"]},
+# :horaires_dimanche=>{:string=>["0000", "0000", "0000", "0000"]},
+# :information=>nil,
+# :url_photo=>"https://ww2.mondialrelay.com/public/permanent/photo_relais.aspx?ens=CC______41&num=070912&pays=ES&crc=17576B6AE31EA66C7C66463BCDD955A4",
+# :url_plan=>"https://ww2.mondialrelay.com/public/permanent/plan_relais.aspx?ens=test11&num=070912&pays=ES&crc=4F83CD143A1506242F025F9C11311A3C"}
+
+# Deliveries.courier('mondial_relay').get_collection_point(point_id: 23191, country: 'ES')
+
+module Deliveries
+  module Couriers
+    module MondialRelay
+      module CollectionPoints
+        class Search
+          class FormatResponse
+            WEEKDAYS_STARTING_SUNDAY = %w[
+              dimanche
+              lundi
+              mardi
+              mercredi
+              jeudi
+              vendredi
+              samedi
+            ].freeze
+
+            attr_accessor :response
+
+            def initialize(response:)
+              self.response = response
+            end
+
+            def execute
+              point = {}
+
+              point[:courier_id] = 'mondial_relay'
+              point[:point_id] = response[:num]
+              point[:country] = response[:pays]
+              point[:city] = response[:ville].strip unless response[:ville].nil?
+              point[:postcode] = response[:cp].strip unless response[:cp].nil?
+              point[:url_map] = response[:url_plan]
+              point[:latitude] = response[:latitude].tr(',', '.').to_f
+              point[:longitude] = response[:longitude].tr(',', '.').to_f
+              point[:timetable] = formatted_timetable(response)
+              point[:url_photo] = response[:url_photo]
+              point[:name] = response[:lg_adr1].strip
+              point[:street] = response[:lg_adr3].strip
+
+              point
+            end
+
+            private
+
+            def formatted_timetable(result)
+              timetable = {}
+
+              week_hours = get_week_hours_from_result(result)
+              week_hours.each do |i, times|
+                timetable[i] = []
+                if times[0] == '0000'
+                  timetable[i] << nil
+                else
+                  timetable[i] << formatted_slot(open: times[0], close: times[1])
+                  timetable[i] << formatted_slot(open: times[2], close: times[3]) if times[2] != '0000'
+                end
+                timetable[i] = nil unless timetable[i].any?
+              end
+
+              timetable
+            end
+
+            def get_week_hours_from_result(result)
+              week_hours = {}
+              WEEKDAYS_STARTING_SUNDAY.each_with_index do |day, i|
+                week_hours[i] = result["horaires_#{day}".to_sym][:string]
+              end
+
+              week_hours
+            end
+
+            def formatted_slot(open:, close:)
+              OpenStruct.new(open: open.insert(2, ':'), close: close.insert(2, ':'))
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/deliveries/couriers/mondial_relay/labels/generate.rb

@@ -0,0 +1,40 @@
+module Deliveries
+  module Couriers
+    module MondialRelay
+      module Labels
+        class Generate
+          attr_accessor :tracking_codes, :language
+
+          def initialize(tracking_codes:, language:)
+            self.tracking_codes = [tracking_codes].flatten.join(';')
+            self.language = language.to_s.upcase
+          end
+
+          def execute
+            params = {
+              'Enseigne' => Deliveries::Couriers::MondialRelay.config(:mondial_relay_merchant),
+              'Expeditions' => tracking_codes,
+              'Langue' => language
+            }
+
+            # Calculate security parameters.
+            params['Security'] = Deliveries::Couriers::MondialRelay.calculate_security_param params
+
+            response = MondialRelay.api_client.call :wsi3_get_etiquettes, message: params
+            response_stat = response.body.dig(:wsi3_get_etiquettes_response, :wsi3_get_etiquettes_result, :stat)
+            if response_stat == '0'
+              # Get path for 10x15 format.
+              "http://www.mondialrelay.com#{response.body.dig(:wsi3_get_etiquettes_response,
+                                                              :wsi3_get_etiquettes_result, :url_pdf_10x15)}"
+            else
+              raise Deliveries::APIError.new(
+                StatusCodes.message_for(response_stat.to_i),
+                response_stat
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end