deliveries 0.1.0

data/lib/deliveries/courier.rb

@@ -0,0 +1,69 @@
+require 'ostruct'
+
+module Deliveries
+  module Courier
+    @config = nil
+
+    def configure
+      @config ||= ancestors.first::Config.new
+      yield @config
+    end
+
+    def configured?
+      @config.present?
+    end
+
+    # Get configuration value by key.
+    #
+    # @param key [String, Symbol[]] Dot notation string or array of symbols.
+    # @param default [Mixed]
+    #
+    # @return [Mixed]
+    def config(key, default: nil)
+      raise 'Courier not configured' unless configured?
+
+      key = key.split('.').map(&:to_sym) if key.is_a? String
+      @config.dig(*key) || default
+    end
+
+    def test?
+      Deliveries.test?
+    end
+
+    def live?
+      Deliveries.live?
+    end
+
+    def get_collection_point(global_point_id:)
+      raise NotImplementedError
+    end
+
+    def get_collection_points(country:, postcode:)
+      raise NotImplementedError
+    end
+
+    def create_shipment(sender:, receiver:, collection_point:, parcels:, reference_code:, shipment_date: nil, remarks: nil, language: nil)
+      raise NotImplementedError
+    end
+
+    def create_pickup(sender:, receiver:, parcels:, reference_code:, pickup_date: nil, remarks: nil, language: nil)
+      raise NotImplementedError
+    end
+
+    def get_label(tracking_code:, language: nil)
+      raise NotImplementedError
+    end
+
+    def get_labels(tracking_codes:, language: nil)
+      raise NotImplementedError
+    end
+
+    def shipment_info(tracking_code:, language: nil)
+      raise NotImplementedError
+    end
+
+    def pickup_info(tracking_code:, language: nil)
+      raise NotImplementedError
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+module Deliveries
+  module Couriers
+    module CorreosExpress
+      class Address < Deliveries::Address
+        def name
+          @name.to_s[0, 40]
+        end
+
+        def street
+          @street.to_s[0, 300]
+        end
+
+        def city
+          @city.to_s[0, 40]
+        end
+
+        def phone
+          @phone.to_s[0, 15]
+        end
+
+        def email
+          @email.gsub(/\+.+@/, '@').to_s[0, 75]
+        end
+
+        def country
+          @country.to_s.upcase
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,82 @@
+# "codigoOficina"=>"4894006",
+# "nombreOficina"=>"OF.CORREOS: LAMIAKO - 4894006",
+# "direccionOficina"=>"LANGILERIA 88",
+# "codigoPostalOficina"=>"48940",
+# "poblacionOficina"=>"LAMIAKO",
+# "horarioOficina"=>"L-V:DE 08:30 A 14:30/S:DE 09:30 A 13:00/Festivos:SIN SERVICIO",
+# "horarioOficinaVerano"=>"L-V:08:30-14:30/S:09:30-13:00/Festivos:SIN SERVICIO",
+# "geoposicionOficina"=>"43.32142,-3.00031"
+
+module Deliveries
+  module Couriers
+    module CorreosExpress
+      module CollectionPoints
+        class Search
+          class FormatResponse
+            SATURDAY_HOUR_KEY = 'S:'.freeze
+            WORKDAY_HOUR_KEY = 'L-V:'.freeze
+            HOLIDAY_HOUR_KEY = 'Festivos:'.freeze
+
+            attr_accessor :response
+
+            def initialize(response:)
+              self.response = response
+            end
+
+            def execute
+              collection_point = {}
+              collection_point[:courier_id] = 'correos_express'
+              collection_point[:name] = response['nombreOficina']
+              collection_point[:point_id] = response['codigoOficina']
+              collection_point[:street] = response['direccionOficina']
+              collection_point[:city] = response['poblacionOficina']
+              collection_point[:postcode] = response['codigoPostalOficina']
+              latitude, longitude = response['geoposicionOficina'].split(',')
+              collection_point[:latitude] = latitude.to_f
+              collection_point[:longitude] = longitude.to_f
+              collection_point[:timetable] = formatted_timetable(response['horarioOficina'])
+
+              collection_point
+            end
+
+            private
+
+            def formatted_timetable(params)
+              workday_hour, saturday_hour, holiday_hour = get_week_hours_from_result(params)
+
+              timetable = {}
+
+              if workday_hour.present?
+                1.upto(5) do |weekday|
+                  timetable[weekday] = [formatted_slot(workday_hour, WORKDAY_HOUR_KEY)]
+                end
+              end
+
+              timetable[6] = [formatted_slot(saturday_hour, SATURDAY_HOUR_KEY)] if saturday_hour.present?
+
+              timetable[0] = nil if holiday_hour.present?
+
+              timetable
+            end
+
+            def get_week_hours_from_result(params)
+              week_hours = params.split('/')
+
+              workday_hour = week_hours.select { |o| o.start_with?(WORKDAY_HOUR_KEY) }.first
+              saturday_hour = week_hours.select { |o| o.start_with?(SATURDAY_HOUR_KEY) }.first
+              holiday_hour = week_hours.select { |o| o.start_with?(HOLIDAY_HOUR_KEY) }.first
+
+              [workday_hour, saturday_hour, holiday_hour]
+            end
+
+            def formatted_slot(hour, key)
+              open, close = hour.sub(key, '').sub('DE ', '').split(' A ')
+
+              OpenStruct.new(open: open, close: close)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/deliveries/couriers/correos_express/collection_points/search.rb

@@ -0,0 +1,56 @@
+require 'httparty'
+
+module Deliveries
+  module Couriers
+    module CorreosExpress
+      module CollectionPoints
+        class Search
+          include HTTParty
+
+          attr_accessor :postcode
+
+          def initialize(postcode:)
+            self.postcode = postcode
+          end
+
+          def execute
+            auth = {
+              username: CorreosExpress.config(:username),
+              password: CorreosExpress.config(:password)
+            }
+
+            headers = { 'Content-Type' => 'application/json;charset=UTF-8', 'Accept' => 'application/json' }
+
+            response = self.class.post(
+              api_endpoint,
+              basic_auth: auth,
+              body: { cod_postal: postcode }.to_json,
+              headers: headers,
+              debug_output: Deliveries.debug ? Deliveries.logger : nil
+            )
+            parsed_response = JSON.parse(response.body)
+
+            if parsed_response['tipoRespuesta'] == 'KO'
+              raise Deliveries::APIError.new(
+                parsed_response['listaErrores'].first['descError'],
+                parsed_response['listaErrores'].first['codError']
+              )
+            end
+
+            parsed_response['oficinas']
+          end
+
+          private
+
+          def api_endpoint
+            if CorreosExpress.live?
+              CorreosExpress::COLLECTION_POINTS_ENDPOINT_LIVE
+            else
+              CorreosExpress::COLLECTION_POINTS_ENDPOINT_TEST
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+require 'httparty'
+
+module Deliveries
+  module Couriers
+    module CorreosExpress
+      module Labels
+        class Generate
+          include HTTParty
+
+          attr_accessor :tracking_codes
+
+          def initialize(tracking_codes:)
+            self.tracking_codes = tracking_codes.respond_to?(:each) ? tracking_codes : [tracking_codes]
+          end
+
+          def execute
+            auth = {
+              username: CorreosExpress.config(:username),
+              password: CorreosExpress.config(:password)
+            }
+            decoded_labels = []
+            tracking_codes.each do |tracking_code|
+              params = {
+                keyCli: CorreosExpress.config(:shipment_sender_code),
+                nenvio: tracking_code,
+                tipo: '1' # "1" - pdf, "2" - zpl image
+              }.to_json
+
+              headers = { 'Content-Type' => 'application/json' }
+              response = self.class.post(
+                api_endpoint,
+                basic_auth: auth,
+                body: params,
+                headers: headers,
+                debug_output: Deliveries.debug ? Deliveries.logger : nil
+              )
+              parsed_response = JSON.parse(response.body)
+              if (parsed_response['codErr']).zero?
+                if parsed_response['listaEtiquetas'].any?
+                  parsed_response['listaEtiquetas'].each do |encoded_label|
+                    decoded_labels << Base64.decode64(encoded_label).force_encoding('binary')
+                  end
+                end
+              else
+                raise Deliveries::APIError.new(
+                  parsed_response['desErr'],
+                  parsed_response['codErr']
+                )
+              end
+            end
+
+            decoded_labels
+          end
+
+          private
+
+          def api_endpoint
+            if CorreosExpress.live?
+              CorreosExpress::LABELS_ENDPOINT_LIVE
+            else
+              CorreosExpress::LABELS_ENDPOINT_TEST
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/deliveries/couriers/correos_express/pickups/create/defaults.rb

@@ -0,0 +1,60 @@
+module Deliveries
+  module Couriers
+    module CorreosExpress
+      module Pickups
+        class Create
+          module Defaults
+            PARAMS = {
+              solicitante: '',
+              password: '',
+              canalEntrada: '',
+              refRecogida: '',
+              fechaRecogida: '', # ddmmyyyy
+              horaDesde1: '09:00',
+              horaDesde2: '',
+              horaHasta1: '17:00',
+              horaHasta2: '',
+              clienteRecogida: '',
+              codRemit: '',
+              nomRemit: '',
+              nifRemit: '',
+              dirRecog: '',
+              poblRecog: '',
+              cpRecog: '',
+              contRecog: '',
+              tlfnoRecog: '',
+              oTlfnRecog: '',
+              emailRecog: '',
+              observ: '',
+              tipoServ: '',
+              codDest: '',
+              nomDest: '',
+              nifDest: '',
+              dirDest: '',
+              pobDest: '',
+              cpDest: '',
+              paisDest: '',
+              cpiDest: '',
+              contactoDest: '',
+              tlfnoDest: '',
+              emailDest: '',
+              nEnvio: '',
+              refEnvio: '',
+              producto: '63',
+              kilos: '',
+              bultos: '',
+              volumen: '',
+              tipoPortes: '',
+              importReembol: '',
+              valDeclMerc: '',
+              infTec: '',
+              nSerie: '',
+              modelo: '',
+              latente: '0'
+            }.freeze
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,95 @@
+module Deliveries
+  module Couriers
+    module CorreosExpress
+      module Pickups
+        class Create
+          class FormatParams
+            attr_accessor :sender, :receiver, :parcels, :reference_code,
+                          :pickup_date, :remarks, :time_interval
+
+            def initialize(sender:, receiver:, parcels:, reference_code:,
+                           pickup_date:, remarks:, time_interval: nil)
+              self.sender = sender
+              self.receiver = receiver
+              self.parcels = parcels
+              self.reference_code = reference_code
+              self.pickup_date = pickup_date
+              self.remarks = remarks
+              self.time_interval = time_interval
+            end
+
+            def execute
+              postcode = format_postcode(sender.postcode, sender.country)
+              params = {
+                solicitante: CorreosExpress.config(:client_code),
+                refRecogida: reference_code,
+                fechaRecogida: pickup_date&.strftime('%d%m%Y') || '',
+                clienteRecogida: CorreosExpress.config(:pickup_receiver_code),
+                codRemit: '',
+                nomRemit: sender.name,
+                nifRemit: '',
+                dirRecog: sender.street,
+                poblRecog: sender.city,
+                cpRecog: postcode,
+                contRecog: sender.name,
+                tlfnoRecog: sender.phone,
+                emailRecog: sender.email,
+                codDest: CorreosExpress.config(:pickup_receiver_code),
+                nomDest: receiver.name,
+                dirDest: receiver.street,
+                pobDest: receiver.city,
+                cpDest: receiver.postcode,
+                paisDest: receiver.country,
+                contactoDest: receiver.name,
+                tlfnoDest: receiver.phone,
+                emailDest: receiver.email,
+                bultos: parcels.to_s
+              }
+
+              unless CorreosExpress.test?
+                custom_product = CorreosExpress.config("countries.#{sender.country.to_s.downcase}.product")
+                params[:producto] = custom_product if custom_product
+              end
+
+              defaults = Defaults::PARAMS
+
+              defaults = defaults.merge(params)
+
+              if time_interval
+                defaults[:horaDesde1] = format '%02d:00', time_interval.first
+                defaults[:horaHasta1] = format '%02d:00', time_interval.last
+              else
+                # Try to set cutoff time for the sender postal code.
+                begin
+                  cutoff_time = CutoffTime.new(country: sender.country, postcode: postcode).execute
+                  # Set only when cuttoff time is less than 19:00 (the default cutoff time in correos express)
+                  if cutoff_time.to_i < 19
+                    defaults[:horaHasta1] = cutoff_time
+
+                    # Update start hour if the period if smaller than 2 hours
+                    min_start_hour = cutoff_time.to_i - 2
+                    defaults[:horaDesde1] = format('%02d:00', min_start_hour) if defaults[:horaDesde1].to_i > min_start_hour
+                  end
+                rescue Deliveries::Error => e
+                  Deliveries.logger&.error "Cannot obtain cutoff time: #{e.message}"
+                end
+              end
+
+              defaults.to_json
+            end
+
+            private
+
+            def format_postcode(postcode, country)
+              if country.to_sym.downcase == :pt
+                postcode&.split('-')&.first
+              else
+                postcode
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+require 'httparty'
+
+module Deliveries
+  module Couriers
+    module CorreosExpress
+      module Pickups
+        class Create
+          include HTTParty
+
+          attr_accessor :params
+
+          def initialize(params:)
+            self.params = params
+          end
+
+          def execute
+            auth = {
+              username: CorreosExpress.config(:username),
+              password: CorreosExpress.config(:password)
+            }
+
+            response = self.class.post(
+              api_endpoint,
+              basic_auth: auth,
+              body: params,
+              headers: headers,
+              debug_output: Deliveries.debug ? Deliveries.logger : nil
+            )
+            raise ClientError, "Failed with status code #{response.code}" unless response.success?
+
+            parsed_response = JSON.parse(response.body, symbolize_names: true)
+            if parsed_response[:codigoRetorno]&.zero? && parsed_response[:numRecogida].present?
+              parsed_response[:numRecogida]
+            else
+              exception_class =
+                case parsed_response[:codigoRetorno]
+                when 105 then InvalidDateError
+                when 154 then InvalidTimeIntervalError
+                else APIError
+                end
+
+              raise exception_class.new(
+                parsed_response[:mensajeRetorno],
+                parsed_response[:codigoRetorno]
+              )
+            end
+          end
+
+          private
+
+          def api_endpoint
+            if CorreosExpress.live?
+              CorreosExpress::PICKUPS_ENDPOINT_LIVE
+            else
+              CorreosExpress::PICKUPS_ENDPOINT_TEST
+            end
+          end
+
+          def headers
+            { 'Content-Type' => 'application/json' }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/deliveries/couriers/correos_express/pickups/cutoff_time/format_params.rb

@@ -0,0 +1,40 @@
+module Deliveries
+  module Couriers
+    module CorreosExpress
+      module Pickups
+        class CutoffTime
+          class FormatParams
+            attr_accessor :country, :postcode
+
+            def initialize(country:, postcode:)
+              self.country = country
+              self.postcode = postcode
+            end
+
+            def execute
+              params = {
+                strCP: postcode,
+                strPais: country_code_to_id(country)
+              }
+
+              params.to_json
+            end
+
+            private
+
+            def country_code_to_id(country_code)
+              case country_code.to_sym.downcase
+              when :es
+                '34'
+              when :pt
+                '35'
+              else
+                raise Deliveries::Error, "Invalid country #{country_code}"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/deliveries/couriers/correos_express/pickups/cutoff_time.rb

@@ -0,0 +1,61 @@
+require 'httparty'
+
+module Deliveries
+  module Couriers
+    module CorreosExpress
+      module Pickups
+        class CutoffTime
+          include HTTParty
+
+          attr_accessor :country, :postcode
+
+          def initialize(country:, postcode:)
+            self.country = country
+            self.postcode = postcode
+          end
+
+          def execute
+            auth = {
+              username: CorreosExpress.config(:username),
+              password: CorreosExpress.config(:password)
+            }
+
+            params = FormatParams.new(
+              country: country,
+              postcode: postcode
+            ).execute
+
+            response = self.class.post(
+              api_endpoint,
+              basic_auth: auth,
+              body: params,
+              headers: headers,
+              debug_output: Deliveries.debug ? Deliveries.logger : nil
+            )
+            raise Deliveries::Error unless response.success?
+
+            parsed_response = JSON.parse(response.body, symbolize_names: true)
+            if (parsed_response[:codError]).zero? && parsed_response[:horaCorte].present?
+              parsed_response[:horaCorte]
+            else
+              raise Deliveries::APIError.new(
+                parsed_response[:mensError],
+                parsed_response[:codError]
+              )
+            end
+          end
+
+          private
+
+          def api_endpoint
+            CorreosExpress::CUTOFF_TIME_ENDPOINT_LIVE
+          end
+
+          def headers
+            { 'Content-Type' => 'application/json' }
+          end
+        end
+      end
+    end
+  end
+end