czech_post_b2b_client 1.0.2 → 1.2.3

data/lib/czech_post_b2b_client/response_codes.rb

@@ -5,7 +5,7 @@
 # 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_'
@@ -281,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
 
@@ -589,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
 
@@ -1290,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
 
@@ -1756,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ě'
@@ -1882,19 +1887,17 @@ module CzechPostB2bClient
       @type = :info
     end
 
-    def all_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_classes
-
-    def new_by_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

@@ -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
 
@@ -69,6 +69,12 @@ 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

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_result_parcels_parser.rb

@@ -42,11 +42,12 @@ module CzechPostB2bClient
 
         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] }
         if old_p_code != new_p_code
           raise "Two different parcel_codes [#{old_p_code}, #{new_p_code}] for parcel_id:'#{parcel_id}'"
         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

data/lib/czech_post_b2b_client/services.rb

@@ -3,10 +3,12 @@
 require 'czech_post_b2b_client/services/orchestrator'
 require 'czech_post_b2b_client/services/communicator'
 require 'czech_post_b2b_client/services/api_caller'
-require 'czech_post_b2b_client/services/parcels_sender'
-require 'czech_post_b2b_client/services/parcels_immediate_sender'
+require 'czech_post_b2b_client/services/parcels_async_sender'
+require 'czech_post_b2b_client/services/parcels_sync_sender'
+require 'czech_post_b2b_client/services/parcels_sender' # deprecated
 require 'czech_post_b2b_client/services/parcels_send_process_updater'
 require 'czech_post_b2b_client/services/address_sheets_generator'
 require 'czech_post_b2b_client/services/parcels_submission_closer'
 require 'czech_post_b2b_client/services/delivering_inspector'
 require 'czech_post_b2b_client/services/time_period_statisticator'
+require 'czech_post_b2b_client/services/xsds_downloader'

data/lib/czech_post_b2b_client/services/api_caller.rb

@@ -32,14 +32,9 @@ module CzechPostB2bClient
       attr_accessor :request_xml, :response, :endpoint_path
 
       def call_api
-        request = Net::HTTP::Post.new service_uri.request_uri, headers
-        request.body = request_xml
-        CzechPostB2bClient.logger.debug("CzechPost B2B REQUEST: #{request} to #{service_uri.request_uri} with body:\n#{request.body}")
-        begin
-          self.response = https_conn.request(request)
-        rescue *KNOWN_CONNECTION_ERRORS => e
-          handle_connection_error(e)
-        end
+        self.response = https_conn.request(request)
+      rescue *KNOWN_CONNECTION_ERRORS => e
+        handle_connection_error(e)
       end
 
       def handle_response
@@ -56,6 +51,16 @@ module CzechPostB2bClient
         @https_conn ||= Net::HTTP.start(service_uri.host, service_uri.port, connection_options)
       end
 
+      def request
+        request = Net::HTTP::Post.new service_uri.request_uri, headers
+        request.body = request_xml
+
+        debug_msg = "CzechPost B2B REQUEST: #{request} to #{service_uri.request_uri} with body:\n#{request.body}"
+        CzechPostB2bClient.logger.debug(debug_msg)
+
+        request
+      end
+
       def service_uri
         @service_uri ||= URI.parse(configuration.b2b_api_base_uri + endpoint_path)
       end
@@ -69,6 +74,7 @@ module CzechPostB2bClient
           use_ssl: true,
           verify_mode: OpenSSL::SSL::VERIFY_PEER,
           keep_alive_timeout: 30,
+          ciphers: secure_and_available_ciphers,
           cert: OpenSSL::X509::Certificate.new(File.read(configuration.certificate_path)),
           # cert_password: configuration.certificate_password,
           key: OpenSSL::PKey::RSA.new(File.read(configuration.private_key_path), configuration.private_key_password),
@@ -95,7 +101,8 @@ module CzechPostB2bClient
       end
 
       def b2b_error_text
-        error_match = result.xml.match(%r{<(?:\w+\:)?errorCode>(\d+)</(?:\w+\:)?errorCode>}) # errorCode tag with stripped out namespace
+        err_code_without_namespace_regexp = %r{<(?:\w+\:)?errorCode>(\d+)</(?:\w+\:)?errorCode>}
+        error_match = result.xml.match(err_code_without_namespace_regexp)
         return 'error code not found in XML' unless error_match
 
         error_code = error_match[1].to_i
@@ -110,6 +117,15 @@ module CzechPostB2bClient
         errors.add(:connection, "#{error.class} > #{service_uri} - #{error}")
         fail!
       end
+
+      def secure_and_available_ciphers
+        # Available non-weak suites for b2b.postaonline.cz (https://www.ssllabs.com/ssltest/analyze.html?d=b2b.postaonline.cz)
+        # TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (0xc030)   ECDH secp384r1 (eq. 7680 bits RSA)   FS	256
+        # TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 (0xc02f)   ECDH secp384r1 (eq. 7680 bits RSA)   FS
+        # which have following names in OpenSSL (see `openssl ciphers`)
+
+        %w[ECDHE-RSA-AES256-GCM-SHA384 ECDHE-RSA-AES128-GCM-SHA256]
+      end
     end
   end
 end

data/lib/czech_post_b2b_client/services/delivering_inspector.rb

@@ -32,7 +32,6 @@ module CzechPostB2bClient
       end
 
       def build_result_from(response_hash)
-        puts("RESPONSE_HASH: #{response_hash}")
         result_hash = {}
         response_hash[:parcels].each_pair do |parcel_code, delivering_hash|
           result_hash[parcel_code] = {
@@ -42,7 +41,6 @@ module CzechPostB2bClient
             all_states: delivering_hash[:states]
           }
         end
-        puts("RESULT_HASH: #{result_hash}")
         result_hash
       end
     end

data/lib/czech_post_b2b_client/services/parcels_async_sender.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module CzechPostB2bClient
+  module Services
+    class ParcelsAsyncSender < CzechPostB2bClient::Services::Communicator
+      attr_reader :sending_data, :parcels
+
+      def initialize(sending_data:, parcels:)
+        @sending_data = sending_data
+        @parcels = parcels
+      end
+
+      private
+
+      def request_builder_args
+        { common_data: common_data, parcels: parcels }
+      end
+
+      def request_builder_class
+        CzechPostB2bClient::RequestBuilders::SendParcelsBuilder
+      end
+
+      def api_caller_class
+        CzechPostB2bClient::Services::ApiCaller
+      end
+
+      def response_parser_class
+        CzechPostB2bClient::ResponseParsers::SendParcelsParser
+      end
+
+      def common_data
+        data_from_config.merge(sending_data)
+      end
+
+      def data_from_config
+        {
+          contract_id: configuration.contract_id,
+          customer_id: configuration.customer_id,
+          sending_post_office_code: configuration.sending_post_office_code
+        }
+      end
+
+      def endpoint_path
+        '/sendParcels'
+      end
+
+      def build_result_from(response_hash)
+        OpenStruct.new(transaction_id: response_hash.dig(:async_result, :transaction_id),
+                       processing_end_expected_at: response_hash.dig(:async_result, :processing_end_expected_at))
+      end
+    end
+  end
+end

data/lib/czech_post_b2b_client/services/parcels_send_process_updater.rb

@@ -63,7 +63,7 @@ module CzechPostB2bClient
           response_code = response_state[:code]
           next if response_code == CzechPostB2bClient::ResponseCodes::Ok.code
 
-          errors.add(:parcels, "Parcel[#{parcel_id}] => #{CzechPostB2bClient::ResponseCodes.new_by_code(response_code)}")
+          errors.add(:parcels, "Parcel[#{parcel_id}] => #{CzechPostB2bClient::ResponseCodes.new_by_code(response_code)}") # rubocop:disable Layout/LineLength
         end
       end
     end

data/lib/czech_post_b2b_client/services/parcels_sender.rb

@@ -2,51 +2,10 @@
 
 module CzechPostB2bClient
   module Services
-    class ParcelsSender < CzechPostB2bClient::Services::Communicator
-      attr_reader :sending_data, :parcels
-
-      def initialize(sending_data:, parcels:)
-        @sending_data = sending_data
-        @parcels = parcels
-      end
-
-      private
-
-      def request_builder_args
-        { common_data: common_data, parcels: parcels }
-      end
-
-      def request_builder_class
-        CzechPostB2bClient::RequestBuilders::SendParcelsBuilder
-      end
-
-      def api_caller_class
-        CzechPostB2bClient::Services::ApiCaller
-      end
-
-      def response_parser_class
-        CzechPostB2bClient::ResponseParsers::SendParcelsParser
-      end
-
-      def common_data
-        data_from_config.merge(sending_data)
-      end
-
-      def data_from_config
-        {
-          contract_id: configuration.contract_id,
-          customer_id: configuration.customer_id,
-          sending_post_office_code: configuration.sending_post_office_code
-        }
-      end
-
-      def endpoint_path
-        '/sendParcels'
-      end
-
-      def build_result_from(response_hash)
-        OpenStruct.new(transaction_id: response_hash.dig(:async_result, :transaction_id),
-                       processing_end_expected_at: response_hash.dig(:async_result, :processing_end_expected_at))
+    class ParcelsSender < CzechPostB2bClient::Services::ParcelsAsyncSender
+      class << self
+        extend Gem::Deprecate
+        deprecate :call, 'CzechPostB2bClient::Services::ParcelsAsyncSender.call', 2020, 8
       end
     end
   end