czech_post_b2b_client 1.0.0 → 1.2.2

data/lib/czech_post_b2b_client/request_builders/send_parcels_builder.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
+# rubocop:disable Layout/LineLength, Style/AsciiComments
+
 module CzechPostB2bClient
   module RequestBuilders
-    class SendParcelsBuilder < BaseBuilder
+    class SendParcelsBuilder < BaseBuilder # rubocop:disable Metrics/ClassLength
       attr_reader :common_data, :parcels
 
       def initialize(common_data:, parcels:, request_id: 1)
@@ -34,7 +36,7 @@ module CzechPostB2bClient
          [:sending_post_office_code]].each do |key_chain|
            value = common_data.dig(*key_chain)
            if value.nil? || value == ''
-             errors.add(:common_data, "Missing value for key { :#{key_chain.join(' => :') } }!")
+             errors.add(:common_data, "Missing value for key { :#{key_chain.join(' => :')} }!")
            end
          end
       end
@@ -72,7 +74,7 @@ module CzechPostB2bClient
         end
       end
 
-      def do_parcel_header
+      def do_parcel_header # rubocop:disable Metrics/AbcSize
         new_element('ns2:doParcelHeader').tap do |parcel_header|
           add_element_to(parcel_header, 'ns2:transmissionDate', value: common_data[:parcels_sending_date].strftime('%d.%m.%Y')) # Predpokladane datum podani (format DD.MM.YYYY !)
           add_element_to(parcel_header, 'ns2:customerID', value: common_data[:customer_id]) # Technologicke cislo podavatele
@@ -133,7 +135,7 @@ module CzechPostB2bClient
         end
       end
 
-      def do_parcel_params(parcel_data)
+      def do_parcel_params(parcel_data) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
         params = parcel_data[:params]
         cod = parcel_data[:cash_on_delivery] || {}
         new_element('ns2:doParcelParams').tap do |parcel_params|
@@ -183,7 +185,7 @@ module CzechPostB2bClient
         add_parcel_adress_element('ns2:doParcelAddressDocument', parcel_data[:document_addressee])
       end
 
-      def add_parcel_adress_element(element_name, addressee_data)
+      def add_parcel_adress_element(element_name, addressee_data) # rubocop:disable Metrics/AbcSize
         return nil if addressee_data.nil?
 
         address_data = addressee_data[:address]
@@ -237,7 +239,8 @@ module CzechPostB2bClient
         end
       end
 
-      def add_address_elements(parent_element, address_data, without: []) # Nepovinne. Adresa
+      # Nepovinne. Adresa
+      def add_address_elements(parent_element, address_data, without: [])
         return if address_data.nil?
 
         address_tags_and_values(address_data).each_pair do |xml_tag, value|
@@ -260,7 +263,7 @@ module CzechPostB2bClient
           'ns2:city' => address_data[:city], # Nepovinne: Obec
           'ns2:zipCode' => address_data[:post_code], # Nepovinne: PSC
           'ns2:isoCountry' => address_data[:country_iso_code], # Nepovinne, default 'CZ': ISO kod zeme
-          'ns2:subIsoCountry' => address_data[:subcountry_iso_code], # Nepovinne: ISO kod uzemi
+          'ns2:subIsoCountry' => address_data[:subcountry_iso_code] # Nepovinne: ISO kod uzemi
         }
       end
 
@@ -292,3 +295,5 @@ module CzechPostB2bClient
     end
   end
 end
+
+# rubocop:enable Layout/LineLength, Style/AsciiComments

data/lib/czech_post_b2b_client/response_codes.rb

@@ -1,25 +1,27 @@
+# frozen_string_literal: true
+
 # Codes, which can be returned in response nodes `doParcelStateResponse`
 #
-# Do not miss `CzechPostB2bClient::ResponseCodes.all_code_classes` and `CzechPostB2bClient::ResponseCodes.new_by_code`,
+# Do not miss `CzechPostB2bClient::ResponseCodes.all_classes` and `CzechPostB2bClient::ResponseCodes.new_by_code`,
 # they have to be at end of module to work properly
 module CzechPostB2bClient
-  module ResponseCodes
+  module ResponseCodes # rubocop:disable Metrics/ModuleLength
     class BaseCode
-        @code = 'undefined'
-        @text = '_NONE_'
-        @decription = 'Unspecified B2B response code, is it listed in /doc/.../ResponseCodes.ods'
+      @code = 'undefined'
+      @text = '_NONE_'
+      @decription = 'Unspecified B2B response code, is it listed in /doc/.../ResponseCodes.ods'
 
-      def self.code
-        @code
-      end
+      class << self
+        attr_reader :code
+        end
 
-      def self.text
-        @text
-      end
+      class << self
+        attr_reader :text
+        end
 
-      def self.description
-        @description
-      end
+      class << self
+        attr_reader :description
+        end
 
       def self.error?
         @type == :error
@@ -29,9 +31,9 @@ module CzechPostB2bClient
         @type == :info
       end
 
-      def self.type
-        @type
-      end
+      class << self
+        attr_reader :type
+        end
 
       def self.to_s
         "ResponseCode[#{code} #{text}] #{description}"
@@ -279,7 +281,8 @@ module CzechPostB2bClient
     class InvalidAddressForBigPackage < CzechPostB2bClient::ResponseCodes::BaseCode
       @code = 119
       @text = 'INVALID_ADRESS'
-      @description = 'Adresa odesílatele není vhodná pro produkt Nadrozměrná zásilka(adresa obsahuje údaj P.O.Box nebo Poste restante)!'
+      @description = 'Adresa odesílatele není vhodná pro produkt Nadrozměrná zásilka' \
+                     '(adresa obsahuje údaj P.O.Box nebo Poste restante)!'
       @type = :chyba
     end
 
@@ -587,21 +590,24 @@ module CzechPostB2bClient
     class CODAmountTooBig < CzechPostB2bClient::ResponseCodes::BaseCode
       @code = 177
       @text = 'INVALID_AMOUNT'
-      @description = 'Limit pro uložení zásilky na Výdejním místě je pro Dobírku max. 50.000,- Kč. Zásilka bude uložena na poště, která je Výdejnímu místu nadřízená.'
+      @description = 'Limit pro uložení zásilky na Výdejním místě je pro Dobírku max. 50.000,- Kč.' \
+                     ' Zásilka bude uložena na poště, která je Výdejnímu místu nadřízená.'
       @type = :chyba
     end
 
     class PriceTooBig < CzechPostB2bClient::ResponseCodes::BaseCode
       @code = 178
       @text = 'INVALID_PRICE'
-      @description = 'Limit pro uložení zásilky na Výdejním místě je pro Udanou cenu a Dobírku max. 50.000,- Kč. Zásilka bude uložena na poště, která je Výdejnímu místu nadřízená.'
+      @description = 'Limit pro uložení zásilky na Výdejním místě je pro Udanou cenu a Dobírku max. 50.000,- Kč.' \
+                     ' Zásilka bude uložena na poště, která je Výdejnímu místu nadřízená.'
       @type = :chyba
     end
 
     class PriceAndCODAmountTooBig < CzechPostB2bClient::ResponseCodes::BaseCode
       @code = 179
       @text = 'INVALID_PRICE_AND_AMOUNT'
-      @description = 'Limit pro uložení zásilky na Výdejním místě je pro Udanou cenu a Dobírku max. 50.000,- Kč. Zásilka bude uložena na poště, která je Výdejnímu místu nadřízená.'
+      @description = 'Limit pro uložení zásilky na Výdejním místě je pro Udanou cenu a Dobírku max. 50.000,- Kč.' \
+                     ' Zásilka bude uložena na poště, která je Výdejnímu místu nadřízená.'
       @type = :chyba
     end
 
@@ -1061,7 +1067,6 @@ module CzechPostB2bClient
       @type = :chyba
     end
 
-
     class AddressSuitableForLocalDelivery < CzechPostB2bClient::ResponseCodes::BaseCode
       @code = 257
       @text = 'INVALID_ADRESS' # no kidding! Like 6 times same text?
@@ -1289,7 +1294,8 @@ module CzechPostB2bClient
     class InfoService29And47 < CzechPostB2bClient::ResponseCodes::BaseCode
       @code = 324
       @text = 'INFO_SERVICE_29+47'
-      @description = 'Zásilku s výškou nad 150cm nelze podat jako Balík Do ruky se sl.47, ale musí být využit Balík Nadrozměr v kategorii NZ 2'
+      @description = 'Zásilku s výškou nad 150cm nelze podat jako Balík Do ruky se sl.47,' \
+                     ' ale musí být využit Balík Nadrozměr v kategorii NZ 2'
       @type = :info
     end
 
@@ -1755,14 +1761,14 @@ module CzechPostB2bClient
       @type = :info
     end
 
-    class InfoMissingPartCityServiceDeliveryOnSundayOrHolidayMayNotBeRealized < CzechPostB2bClient::ResponseCodes::BaseCode
+    class InfoMissingPartCityServiceDeliveryOnSundayOrHolidayMayNotBeRealized < CzechPostB2bClient::ResponseCodes::BaseCode # rubocop:disable Layout/LineLength
       @code = 391
       @text = 'INFO_MISSING_PART_CITY_SERVICE_DELIVERY_ON_SUNDAY/HOLIDAY_MAY_NOT_BE_REALIZED'
-      @description = 'Neuvedena část obce - sl. Gar. čas dodání v Ne/Sv nemusí být realizována'
+      @description = 'Neuvedena část obce - služba Garantovaný čas dodání v Ne/Sv nemusí být realizována'
       @type = :info
     end
 
-    class NfoCancelService9 < CzechPostB2bClient::ResponseCodes::BaseCode
+    class InfoCancelService9 < CzechPostB2bClient::ResponseCodes::BaseCode
       @code = 392
       @text = 'NFO_CANCEL_SERVICE_9'
       @description = 'Zrušena nepovolená služba 9 Prioritně'
@@ -1881,20 +1887,17 @@ module CzechPostB2bClient
       @type = :info
     end
 
-    def all_code_classes
-      ObjectSpace.each_object(CzechPostB2bClient::ResponseCodes::BaseCode.singleton_class)
+    # must be at end to collect all classes defined before
+    def self.all_classes
+      base_class = CzechPostB2bClient::ResponseCodes::BaseCode
+      ObjectSpace.each_object(base_class.singleton_class).reject { |c| c == base_class }
     end
 
-    module_function :all_code_classes
-
-    def new_by_code(code)
-      klass = all_code_classes.detect { |k| k.code == code }
+    def self.new_by_code(code)
+      klass = all_classes.detect { |k| k.code == code }
       raise "ResponseCode with code: #{code}  is unknown!" unless klass
 
       klass.new
     end
-
-    module_function :new_by_code
   end
 end
-

data/lib/czech_post_b2b_client/response_parsers.rb

@@ -6,3 +6,4 @@ require 'czech_post_b2b_client/response_parsers/get_parcels_printing_parser'
 require 'czech_post_b2b_client/response_parsers/get_parcel_state_parser'
 require 'czech_post_b2b_client/response_parsers/get_result_parcels_parser'
 require 'czech_post_b2b_client/response_parsers/send_parcels_parser'
+require 'czech_post_b2b_client/response_parsers/parcel_service_sync_parser'

data/lib/czech_post_b2b_client/response_parsers/base_parser.rb

@@ -22,14 +22,14 @@ module CzechPostB2bClient
                                  strip_namespace: true,
                                  symbolize_keys: false,
                                  mode: :hash_no_attrs)
-      rescue Ox::ParseError => error
-        handle_parsing_error(error)
+      rescue Ox::ParseError => e
+        handle_parsing_error(e)
       end
 
       def safely_build_result
         build_result
-      rescue NoMethodError => error # NoMethodError: undefined method `dig' for nil:NilClass
-        handle_result_building_error(error)
+      rescue NoMethodError => e # NoMethodError: undefined method `dig' for nil:NilClass
+        handle_result_building_error(e)
       end
 
       def build_result
@@ -37,7 +37,7 @@ module CzechPostB2bClient
           request: { created_at: request_data.time_stamp,
                      contract_id: request_data.id_contract,
                      request_id: request_data.id_ext_transaction },
-          response: { created_at: Time.parse(response_header.dig('timeStamp')) }
+          response: { created_at: response_time }
         }
       end
 
@@ -50,7 +50,9 @@ module CzechPostB2bClient
       end
 
       def response_root_node
-        return response_service_data.dig(response_root_node_name) if response_service_data.keys.include?(response_root_node_name)
+        if response_service_data.keys.include?(response_root_node_name)
+          return response_service_data.dig(response_root_node_name)
+        end
 
         errors.add(:xml, "Cannot find `#{response_root_node_name}` in `serviceData` node.")
         fail_on_structure_parsing
@@ -67,11 +69,17 @@ module CzechPostB2bClient
                        id_contract: b2b_request_hash.dig('idContract').to_s)
       end
 
+      def response_time
+        Time.parse(response_header.dig('timeStamp'))
+      rescue TypeError
+        Time.now.utc
+      end
+
       def state_hash_from(hash)
         state_hash = hash || { 'responseCode' => '999', 'responseText' => 'Unknown' }
         state_hash = state_hash.first if state_hash.is_a?(Array) # more <doParcelStateResponse> elements
 
-        { code: state_hash['responseCode'].to_i, text: state_hash['responseText'].to_s}
+        { code: state_hash['responseCode'].to_i, text: state_hash['responseText'].to_s }
       end
 
       def handle_parsing_error(error)

data/lib/czech_post_b2b_client/response_parsers/get_parcel_state_parser.rb

@@ -24,11 +24,12 @@ module CzechPostB2bClient
         [response_root_node.dig('parcel')].flatten.compact # to always get array of hash(es)
       end
 
-      def parcel_data_from(rp_hash)
+      def parcel_data_from(rp_hash) # rubocop:disable Metrics/AbcSize
         {
           parcel_type: rp_hash['parcelType'].to_s,
-          weight_in_kg: rp_hash['weight'].nil? ? nil : rp_hash['weight'].to_f,  # hopefully it is in KG
-          cash_on_delivery: { amount: (rp_hash['amount'] || 0).to_f, currency_iso_code: rp_hash['currency'].to_s },
+          weight_in_kg: rp_hash['weight'].nil? ? nil : rp_hash['weight'].to_f,
+          cash_on_delivery: { amount: (rp_hash['amount'] || 0).to_f,
+                              currency_iso_code: rp_hash['currency'].to_s },
           pieces: (rp_hash['quantityParcel'] || 1).to_i,
           deposited_until: rp_hash['depositTo'].nil? ? nil : Date.parse(rp_hash['depositTo']),
           deposited_for_days: rp_hash['timeDeposit'].nil? ? nil : rp_hash['timeDeposit'].to_i,

data/lib/czech_post_b2b_client/response_parsers/get_parcels_printing_parser.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
-require "base64"
+
+require 'base64'
 
 module CzechPostB2bClient
   module ResponseParsers

data/lib/czech_post_b2b_client/response_parsers/get_result_parcels_parser.rb

@@ -38,16 +38,19 @@ module CzechPostB2bClient
       end
 
       def updated_result_value_for(value, parcel_params_result_hash)
-        pd_hash=parcel_data_from(parcel_params_result_hash)
+        pd_hash = parcel_data_from(parcel_params_result_hash)
 
         return pd_hash if value.nil?
 
-        # more doParcelParamsResult nodes for one parcel_id => probably errors
+        # merging states
+        value[:states] = (value[:states] + pd_hash[:states]).sort { |a, b| a[:code] <=> b[:code] }
+
+        # more parcel_codes for one parcel_id => probably errors
         old_p_code = value[:parcel_code]
         new_p_code = pd_hash[:parcel_code]
-
-        value[:states] = (value[:states] + pd_hash[:states]).sort { |a, b| a[:code] <=> b[:code] }
-        raise "Two different parcel_codes [#{old_p_code}, #{new_p_code}] for parcel_id:'#{parcel_id}'" if old_p_code != new_p_code
+        if old_p_code != new_p_code
+          raise "Two different parcel_codes [#{old_p_code}, #{new_p_code}] for parcel_id:'#{parcel_id}'"
+        end
 
         value
       end

data/lib/czech_post_b2b_client/response_parsers/parcel_service_sync_parser.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'base64'
+
+module CzechPostB2bClient
+  module ResponseParsers
+    class ParcelServiceSyncParser < BaseParser
+      def build_result
+        super
+        @result[:response][:state] = state_hash_from(response_state_response)
+        @result[:parcel] = parcel_data_hash
+      end
+
+      def parcel_data_hash
+        parcel_id = nil
+        pdh = response_parcel_hashes.each_with_object({}) do |rp_hash, result|
+          parcel_id = parcel_parcel_id_from(rp_hash)
+          result[parcel_id] = updated_result_value_for(result[parcel_id], rp_hash)
+        end
+        pdh[parcel_id].merge!(printings: print_data_from(response_print_hash))
+
+        pdh
+      end
+
+      def response_root_node_name
+        'parcelServiceSyncResponse'
+      end
+
+      def response_state_response
+        response_root_node.dig('responseHeader', 'resultHeader')
+      end
+
+      def response_parcel_hashes
+        [response_root_node.dig('responseHeader', 'resultParcelData')].flatten.compact # to always get array of hash(es)
+      end
+
+      def response_print_hash
+        response_root_node.dig('responsePrintParams')
+      end
+
+      def parcel_parcel_id_from(rp_hash)
+        rp_hash['recordNumber'].to_s
+      end
+
+      def parcel_data_from(rp_hash)
+        { parcel_code: rp_hash['parcelCode'],
+          states: [state_hash_from(rp_hash.dig('parcelDataResponse'))] }
+      end
+
+      def print_data_from(print_hash)
+        return nil if print_hash.nil? || print_hash.empty?
+
+        { pdf_content: pdf_content_from(print_hash.dig('file')),
+          state: state_hash_from(print_hash.dig('printParamsResponse')) }
+      end
+
+      def pdf_content_from(pdf_content_encoded)
+        return nil if pdf_content_encoded.nil?
+
+        ::Base64.decode64(pdf_content_encoded)
+      end
+
+      def updated_result_value_for(value, parcel_params_result_hash)
+        pd_hash = parcel_data_from(parcel_params_result_hash)
+
+        return pd_hash if value.nil?
+
+        # merging states
+        value[:states] = (value[:states] + pd_hash[:states]).sort { |a, b| a[:code] <=> b[:code] }
+
+        # more parcel_codes for one parcel_id => probably errors
+        old_p_code = value[:parcel_code]
+        new_p_code = pd_hash[:parcel_code]
+        if old_p_code != new_p_code
+          raise "Two different parcel_codes [#{old_p_code}, #{new_p_code}] for parcel_id:'#{parcel_id}'"
+        end
+
+        value
+      end
+    end
+  end
+end

data/lib/czech_post_b2b_client/response_parsers/send_parcels_parser.rb

@@ -5,8 +5,30 @@ module CzechPostB2bClient
     class SendParcelsParser < BaseParser
       def build_result
         super
-        @result[:async_result] = { transaction_id: response_header.dig('idTransaction'),
-                                   processing_end_expected_at: Time.parse(response_header.dig('timeStampProcessing')) } # it is NOT CORRECT! They return CET time value with UTC timezone
+
+        @result[:async_result] = {
+          transaction_id: response_header.dig('idTransaction'),
+          processing_end_expected_at: parse_time_with_correction(response_header.dig('timeStampProcessing'))
+        }
+      end
+
+      def parse_time_with_correction(b2b_time_str)
+        # b2b time in XML is NOT CORRECT! They return CET time value with UTC timezone
+        # Like `2016-02-25T09:30:03.678Z`, which is actually `2016-02-25T09:30:03.678+0100`  (CET)
+        # Or   `2016-05-25T09:30:03.678Z`, which is actually `2016-05-25T09:30:03.678+0200` (CET + DST)
+        # But we must be prepare for unnoticed fix by CPost
+
+        # unfortunattely this can be done for only freshly generated XMLs (comparing b2b_time with Time.now.utc)
+        # but we have to kepp it compatible for old XML
+        # so we pass it up and leave comments in documenation
+        # Users of this gem will have to care of it
+
+        Time.parse(b2b_time_str)
+      end
+
+      # just for info
+      def cpost_time_zone
+        timezone('Europe/Prague')
       end
     end
   end