deliveries 0.1.0

data/lib/deliveries/couriers/spring/request.rb

@@ -0,0 +1,43 @@
+module Deliveries
+  module Couriers
+    module Spring
+      module Request
+        module_function
+
+        def execute(params:)
+          response = HTTParty.post(
+            endpoint,
+            body: params.to_json,
+            headers: headers,
+            debug_output: Deliveries.debug ? Deliveries.logger : nil
+          )
+          raise Deliveries::ClientError unless response.success?
+
+          parsed_response = JSON.parse(response.body, symbolize_names: true)
+          error_level = parsed_response[:ErrorLevel]
+
+          if error_level.zero?
+            parsed_response
+          else
+            raise Deliveries::APIError.new(
+              parsed_response[:Error],
+              error_level
+            )
+          end
+        end
+
+        def headers
+          { 'Content-Type' => "text/json; charset='UTF-8'" }
+        end
+
+        def endpoint
+          if Spring.live?
+            Spring::ENDPOINT_LIVE
+          else
+            Spring::ENDPOINT_TEST
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+module Deliveries
+  module Couriers
+    module Spring
+      module Shipments
+        class Create
+          module Defaults
+            PARAMS = {
+              Apikey: '',
+              Command: 'OrderShipment',
+              Shipment: {
+                LabelFormat: 'PDF',
+                ShipperReference: '',
+                DisplayId: '',
+                InvoiceNumber: '',
+                Service: '',
+                ConsignorAddress: {
+                  Name: '',
+                  Company: '',
+                  AddressLine1: '',
+                  AddressLine2: '',
+                  AddressLine3: '',
+                  City: '',
+                  State: '',
+                  Zip: '',
+                  Country: '',
+                  Phone: '',
+                  Email: '',
+                  Vat: ''
+                },
+                ConsigneeAddress: {
+                  Name: '',
+                  Company: '',
+                  AddressLine1: '',
+                  AddressLine2: '',
+                  AddressLine3: '',
+                  City: '',
+                  State: '',
+                  Zip: '',
+                  Country: '',
+                  Phone: '',
+                  Email: '',
+                  Vat: ''
+                },
+                Weight: '1',
+                WeightUnit: 'kg',
+                Length: '',
+                Width: '',
+                Height: '',
+                DimUnit: '',
+                Value: '',
+                Currency: 'EUR',
+                CustomsDuty: 'DDU',
+                Description: '',
+                DeclarationType: 'SaleOfGoods',
+                Products: [
+                  {
+                    Description: '',
+                    Sku: '',
+                    HsCode: '',
+                    OriginCountry: '',
+                    PurchaseUrl: '',
+                    Quantity: '',
+                    Value: ''
+                  }
+                ]
+              }
+            }.freeze
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+module Deliveries
+  module Couriers
+    module Spring
+      module Shipments
+        class Create
+          class FormatParams
+            attr_accessor :sender, :receiver, :parcels, :reference_code
+
+            def initialize(sender:, receiver:, parcels:, reference_code:)
+              self.sender = sender
+              self.receiver = receiver
+              self.parcels = parcels
+              self.reference_code = reference_code
+            end
+
+            def execute
+              shipment = {
+                ShipperReference: reference_code,
+                Service: Deliveries::Couriers::Spring.config("countries.#{receiver.country.downcase.to_sym}.service")
+              }
+
+              # Consignor address (from).
+              shipment[:ConsignorAddress] = {
+                Name: sender.name,
+                Company: sender.name,
+                AddressLine1: sender.street,
+                AddressLine2: sender.street2,
+                AddressLine3: sender.street3,
+                City: sender.city,
+                State: sender.state,
+                Zip: sender.postcode,
+                Country: sender.country,
+                Phone: sender.phone,
+                Email: sender.email
+              }
+
+              # Consignee address (to).
+              shipment[:ConsigneeAddress] = {
+                Name: receiver.name,
+                Company: '',
+                AddressLine1: receiver.street,
+                AddressLine2: receiver.street2,
+                AddressLine3: receiver.street3,
+                City: receiver.city,
+                State: receiver.state,
+                Zip: receiver.postcode,
+                Country: receiver.country,
+                Phone: receiver.phone,
+                Email: receiver.email
+              }
+
+              # Products collection.
+              shipment[:Products] = 1.upto(parcels).map do
+                {
+                  Description: Deliveries::Couriers::Spring.config('default_product.description'),
+                  Sku: '',
+                  HsCode: Deliveries::Couriers::Spring.config('default_product.hs_code'),
+                  OriginCountry: Deliveries::Couriers::Spring.config('default_product.origin_country'),
+                  PurchaseUrl: '',
+                  Quantity: Deliveries::Couriers::Spring.config('default_product.quantity'),
+                  Value: Deliveries::Couriers::Spring.config('default_product.value')
+                }
+              end
+
+              params = {
+                Apikey: Deliveries::Couriers::Spring.config(:api_key),
+                Shipment: shipment
+              }
+
+              Defaults::PARAMS.deep_merge(params)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+module Deliveries
+  module Couriers
+    module Spring
+      module Shipments
+        class Create
+          attr_accessor :sender, :receiver, :parcels, :reference_code
+
+          def initialize(sender:, receiver:, parcels:, reference_code:)
+            self.sender = sender
+            self.receiver = receiver
+            self.parcels = parcels
+            self.reference_code = reference_code
+          end
+
+          def execute
+            params = Deliveries::Couriers::Spring::Shipments::Create::FormatParams.new(
+              sender: sender.courierize(:spring),
+              receiver: receiver.courierize(:spring),
+              parcels: parcels,
+              reference_code: reference_code
+            ).execute
+
+            response = Deliveries::Couriers::Spring::Request.execute(params: params)
+
+            tracking_code = response[:Shipment][:TrackingNumber]
+            label = Label.new(
+              url: response[:Shipment][:CarrierTrackingUrl],
+              raw: Base64.decode64(response[:Shipment][:LabelImage]).force_encoding('binary')
+            )
+
+            Deliveries::Delivery.new(
+              courier_id: Deliveries::Couriers::Spring::COURIER_ID,
+              sender: sender,
+              receiver: receiver,
+              parcels: parcels,
+              reference_code: reference_code,
+              tracking_code: tracking_code,
+              label: label
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+require 'active_support/time'
+
+module Deliveries
+  module Couriers
+    module Spring
+      module Shipments
+        class Trace
+          class FormatResponse
+            attr_accessor :response
+
+            def initialize(response:)
+              self.response = response
+            end
+
+            def execute
+              checkpoints = response[:Events].sort_by { |event| event[:DateTime] }
+
+              tracking_info_params = {}
+              tracking_info_params[:courier_id] = Deliveries::Couriers::Spring::COURIER_ID
+              tracking_info_params[:tracking_code] = response[:TrackingNumber]
+              tracking_info_params[:status] = status(checkpoints.last[:Code])
+              tracking_info_params[:checkpoints] = formatted_checkpoints(checkpoints)
+
+              tracking_info_params
+            end
+
+            private
+
+            def formatted_checkpoints(shipment_statuses)
+              shipment_statuses.map do |shipment_status|
+                formatted_checkpoint(shipment_status)
+              end
+            end
+
+            def formatted_checkpoint(shipment_status)
+              Deliveries::Checkpoint.new(
+                status: status(shipment_status[:Code]),
+                location: shipment_status[:Country],
+                tracked_at: Time.zone.strptime(shipment_status[:DateTime], '%Y-%m-%d %H:%M:%S'),
+                description: shipment_status[:CarrierDescription]
+              )
+            end
+
+            def status(code)
+              # Spring Tracking Event Codes List
+              # ---
+              #   0 - PARCEL CREATED
+              #  20 - ACCEPTED
+              #  21 - IN TRANSIT
+              #  31 - DELIVERY EXCEPTION
+              #  40 - IN CUSTOMS
+              #  41 - CUSTOMS EXCEPTION
+              #  91 - DELIVERY ATTEMPTED
+              #  92 - DELIVERY AWAITING COLLECTION
+              #  93 - DELIVERY SCHEDULED
+              # 100 - DELIVERED
+              # 111 - LOST OR DESTROYED
+              # 124 - RETURN IN TRANSIT
+              # 125 - RETURN RECEIVED
+
+              case code
+              when 0, 20
+                :registered
+              when 21, 40, 41, 91, 93
+                :in_transit
+              when 92
+                :in_collection_point
+              when 100
+                :delivered
+              else
+                :unknown_status
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module Deliveries
+  module Couriers
+    module Spring
+      module Shipments
+        class Trace
+          attr_accessor :tracking_code
+
+          def initialize(tracking_code:)
+            self.tracking_code = tracking_code
+          end
+
+          def execute
+            params = {
+              Apikey: Deliveries::Couriers::Spring.config(:api_key),
+              Command: 'TrackShipment',
+              Shipment: {
+                TrackingNumber: tracking_code
+              }
+            }
+
+            response = Deliveries::Couriers::Spring::Request.execute(params: params)
+
+            response[:Shipment]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/deliveries/couriers/spring.rb

@@ -0,0 +1,84 @@
+require_relative 'spring/shipments/trace/format_response'
+require_relative 'spring/shipments/trace'
+require_relative 'spring/shipments/create/defaults'
+require_relative 'spring/shipments/create/format_params'
+require_relative 'spring/shipments/create'
+require_relative 'spring/labels/generate'
+require_relative 'spring/address'
+require_relative 'spring/request'
+
+module Deliveries
+  module Couriers
+    module Spring
+      extend Courier
+
+      COURIER_ID = :spring
+      ENDPOINT_LIVE = 'https://mtapi.net/'.freeze
+      ENDPOINT_TEST = 'https://mtapi.net/?testMode=1'.freeze
+
+      Config = Struct.new(
+        :api_key,
+        :countries,
+        :default_product
+      )
+
+      module_function
+
+      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 get_label(tracking_code:, **)
+        decoded_label, url = Labels::Generate.new(
+          tracking_code: tracking_code
+        ).execute.values_at(:decoded_label, :url)
+
+        Deliveries::Label.new(
+          raw: decoded_label,
+          url: url
+        )
+      end
+
+      def get_labels(tracking_codes:, **)
+        labels = Deliveries::Labels.new
+
+        tracking_codes.each do |tracking_code|
+          labels << get_label(tracking_code: tracking_code)
+        end
+
+        labels
+      end
+
+      def create_shipment(sender:, receiver:, parcels:, reference_code:, shipment_date: nil, **)
+        delivery = Shipments::Create.new(
+          sender: sender,
+          receiver: receiver,
+          parcels: parcels,
+          reference_code: reference_code
+        ).execute
+
+        Deliveries::Shipment.new(delivery: delivery, shipment_date: shipment_date)
+      end
+
+      def create_pickup(sender:, receiver:, parcels:, reference_code:, pickup_date: nil, **)
+        delivery = Shipments::Create.new(
+          sender: sender,
+          receiver: receiver,
+          parcels: parcels,
+          reference_code: reference_code
+        ).execute
+
+        Deliveries::Pickup.new(delivery: delivery, pickup_date: pickup_date)
+      end
+
+      def pickup_info(tracking_code:, **)
+        shipment_info(tracking_code: tracking_code)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,142 @@
+module Deliveries
+  module Couriers
+    module Ups
+      module CollectionPoints
+        class Search
+          attr_accessor :country, :postcode, :point_id
+
+          def initialize(country:, postcode: nil, point_id: nil)
+            raise Error, 'Both postcode and point_id cannot be nil' if postcode.nil? && point_id.nil?
+
+            self.country = country.to_s.downcase
+            self.postcode = postcode
+            self.point_id = point_id
+          end
+
+          def execute
+            request_id = SecureRandom.uuid
+
+            access = Nokogiri::XML::Builder.new do |xml|
+              xml.AccessRequest('xml:lang': 'en-US') do
+                xml.AccessLicenseNumber Ups.config(:license_number)
+                xml.UserId Ups.config(:username)
+                xml.Password Ups.config(:password)
+              end
+            end
+
+            locator = Nokogiri::XML::Builder.new do |xml|
+              xml.LocatorRequest do
+                xml.Request do
+                  xml.RequestAction 'Locator'
+                  xml.RequestOption '64'
+                  xml.TransactionReference do
+                    xml.CustomerContext request_id
+                    xml.XpciVersion '1.0014'
+                  end
+                end
+                xml.OriginAddress do
+                  xml.AddressKeyFormat do
+                    xml.SingleLineAddress postcode if postcode
+                    xml.CountryCode country.upcase
+                  end
+                end
+
+                xml.LocationSearchCriteria do
+                  xml.AccessPointSearch do
+                    xml.AccessPointStatus '01'
+                    if point_id
+                      xml.PublicAccessPointID point_id
+                    else
+                      xml.IncludeCriteria do
+                        xml.SearchFilter do
+                          xml.ShippingAvailabilityIndicator ''
+                        end
+                      end
+                    end
+                  end
+
+                  xml.MaximumListSize '20'
+                end
+
+                xml.Translate do
+                  xml.Locale locale
+                end
+              end
+            end
+
+            request_body = access.to_xml + locator.to_xml
+
+            response = HTTParty.post(
+              api_endpoint,
+              body: request_body,
+              headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
+              debug_output: Deliveries.debug ? Deliveries.logger : nil
+            )
+
+            response_doc = Nokogiri.XML(response.body)
+            response_id = response_doc.at_xpath('//LocatorResponse/Response/TransactionReference/CustomerContext')&.content
+            raise Error, 'Request and response ID mismatch' if request_id != response_id
+
+            unless response_doc.at_xpath('//LocatorResponse/Response/ResponseStatusCode')&.content == '1'
+              error_code = response_doc.at_xpath('//LocatorResponse/Response/Error/ErrorCode')&.content
+              error_description = response_doc.at_xpath('//LocatorResponse/Response/Error/ErrorDescription')&.content
+
+              raise APIError.new(error_description, error_code)
+            end
+
+            response_doc.xpath('//LocatorResponse/SearchResults/DropLocation').map do |location_doc|
+              timetable = location_doc.xpath('OperatingHours/StandardHours/DayOfWeek').map do |day_doc|
+                wday = day_doc.at_xpath('Day')&.content.to_i % 7
+                open_hours = day_doc.xpath('OpenHours')&.map(&:content)&.map do |h|
+                  h == '0' ? '00:00' : h.insert(-3, ':')
+                end || []
+                close_hours = day_doc.xpath('CloseHours')&.map(&:content)&.map do |h|
+                  h == '0' ? '00:00' : h.insert(-3, ':')
+                end || []
+                hours = open_hours.zip(close_hours).map { |open, close| OpenStruct.new(open: open, close: close) }
+
+                [wday, hours]
+              end.to_h
+
+              {
+                courier_id: Ups::COURIER_ID,
+                point_id: location_doc.at_xpath('AccessPointInformation/PublicAccessPointID')&.content,
+                latitude: location_doc.at_xpath('Geocode/Latitude')&.content,
+                longitude: location_doc.at_xpath('Geocode/Longitude')&.content,
+                timetable: timetable,
+                url_photo: location_doc.at_xpath('AccessPointInformation/ImageURL')&.content,
+                name: location_doc.at_xpath('AddressKeyFormat/ConsigneeName')&.content,
+                email: location_doc.at_xpath('EMailAddress')&.content,
+                phone: location_doc.at_xpath('PhoneNumber')&.content,
+                country: location_doc.at_xpath('AddressKeyFormat/CountryCode')&.content&.downcase,
+                state: location_doc.at_xpath('AddressKeyFormat/PoliticalDivision1')&.content,
+                city: location_doc.at_xpath('AddressKeyFormat/PoliticalDivision2')&.content,
+                street: location_doc.at_xpath('AddressKeyFormat/AddressLine')&.content,
+                postcode: location_doc.at_xpath('AddressKeyFormat/PostcodePrimaryLow')&.content
+              }
+            end
+          end
+
+          private
+
+          def api_endpoint
+            'https://onlinetools.ups.com/ups.app/xml/Locator'
+          end
+
+          def locale
+            case country
+            when 'es' then 'es_ES'
+            when 'it' then 'it_IT'
+            when 'pt' then 'pt_PT'
+            when 'fr' then 'fr_FR'
+            when 'de' then 'de_DE'
+            when 'gb' then 'en_GB'
+            when 'pl' then 'pl_PL'
+            else 'en_US'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/deliveries/couriers/ups/json_request.rb

@@ -0,0 +1,40 @@
+module Deliveries
+  module Couriers
+    module Ups
+      module JsonRequest
+        private
+
+        def call(body, method: :post, url_params: {}, query_params: {})
+          plain_response = HTTParty.public_send(
+            method,
+            api_endpoint % url_params,
+            body: body&.to_json,
+            query: query_params,
+            headers: headers,
+            debug_output: Deliveries.debug ? Deliveries.logger : nil,
+            format: :plain
+          )
+          response = JSON.parse plain_response, symbolize_names: true
+
+          if response.dig(:response, :errors).present?
+            error_code = response.dig(:response, :errors, 0, :code)&.to_i
+            error_message = response.dig(:response, :errors, 0, :message) || 'Unknown error'
+
+            raise APIError.new(error_message, error_code)
+          end
+
+          response
+        end
+
+        def headers
+          {
+            'Content-Type': 'application/json',
+            AccessLicenseNumber: Ups.config(:license_number),
+            Username: Ups.config(:username),
+            Password: Ups.config(:password)
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+module Deliveries
+  module Couriers
+    module Ups
+      module Labels
+        class Generate
+          include JsonRequest
+          include LabelUtils
+
+          API_VERSION = 'V1903'.freeze
+
+          attr_accessor :tracking_code
+
+          def initialize(tracking_code:)
+            self.tracking_code = tracking_code
+          end
+
+          def execute
+            request = {
+              LabelRecoveryRequest: {
+                TrackingNumber: tracking_code,
+                ShipperNumber: account_number,
+                LabelSpecification: {
+                  LabelImageFormat: {
+                    Code: 'GIF'
+                  }
+                },
+                LabelDelivery: {
+                  LabelLinkIndicator: ''
+                }
+              }
+            }
+
+            response = call request
+
+            label_url = response.dig(:LabelRecoveryResponse, :LabelResults, :LabelImage, :URL)
+            label_encoded = response.dig(:LabelRecoveryResponse, :LabelResults, :LabelImage, :GraphicImage)
+            raise Error, 'Cannot obtain encoded label' if label_encoded.nil?
+
+            label_gif = Base64.decode64(label_encoded).force_encoding('binary')
+            label_pdf = image2pdf label_gif, height: 4
+
+            {
+              raw: label_pdf,
+              url: label_url
+            }
+          end
+
+          private
+
+          def api_endpoint
+            if Ups.live?
+              "https://onlinetools.ups.com/ship/#{API_VERSION}/shipments/labels"
+            else
+              "https://wwwcie.ups.com/ship/#{API_VERSION}/shipments/labels"
+            end
+          end
+
+          def account_number
+            number_from_tracking_code = @tracking_code[/1Z([a-z0-9]{6})/i, 1]
+            if number_from_tracking_code&.casecmp? Ups.config(:point_account_number)
+              Ups.config(:point_account_number)
+            elsif number_from_tracking_code&.casecmp? Ups.config(:home_account_number)
+              Ups.config(:home_account_number)
+            else
+              raise Error, 'Invalid tracking code'
+            end
+          end
+        end
+      end
+    end
+  end
+end