czech_post_b2b_client 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7bfcab9012bcc1bdb68a40691d169192bbe563e3
-  data.tar.gz: f8ab6f6daca0ef901e640b855e1525125b2e113c
+  metadata.gz: 2a85b06fa34faeb7213e1441a6545383e8643f33
+  data.tar.gz: 91bc102f0d2f2686b9d0e64fdb42db9ba7f295e6
 SHA512:
-  metadata.gz: 7d70c14295933177860de0d4b9ed845f479f64e28469cb13416152337c9e367eb1fb75337fbc8a3303446355765efbd184f6dcef0ecaf118387f05642a105ff2
-  data.tar.gz: cb1933bd56a3859fe895d4e4b4884f530e36b300a781219957f619e155e7ca5b0cac668ab8ac9b7c63a04f96cd9abfc2160203b5dd405aa205ae5f3247cee8fc
+  metadata.gz: 25c9c40f2da073568cdb86f391caf378b6a2005c17433486d8e88354e24bad2e0b388e3c2e4331e0b15f241fee1845b6ad9d541db2f2c624e86d869a9e649196
+  data.tar.gz: 6ef1357723687047dc2483f262214a2a01b91f368119af7b1c2608713c7a12d9649bb22da65f28d8b3d005106b07e3a192fa581a668cb0529c0fdbf51d3a478c

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 All changes to the gem are documented here.
 
+## [1.2.3] - 2020-08-21
+
+ - Corrected order in XML `sequence` elements
+ - Added `schemaLocation` to root element and placed publicly accessible XSDs into Github repo
+
 ## [1.2.2] - 2020-08-19
 
  - Printing templates now include @page_dimensions

data/README.md

@@ -10,6 +10,7 @@ There are these supported operations of API:
 - *getParcelState* - returns all known states for listed parcels [HTTP GET - sync response]
 - *getParcelsPrinting* - returns PDF with address labels/stickers for listed parcels [HTTP GET - sync response]
 
+## Development of this gem is donated by [Squared s.r.o.](https://www.vyvolej.to)
 
 ## Installation
 ### 1) Registration at Czech Post (CP)
@@ -277,6 +278,8 @@ end
 
 ## Troubleshooting
 
+  You can validate request XML against XSD in [`documents/latest_xsds`](./documents/latest_xsds) (There are no public  files from Czech Post :-( )
+
   1) Read all stuff in [`./documents`](./documents/) and [Yard docs](./doc/index.html), maybe it helps.
   2) If You get "handshake protocol failed" You do not have correct setup for certificates. If You get any xml response (see logger in debug mode) certificates are ok.
      You can always try `TimePeriodStatisticator` for that check, it do not need any "before" actions.

data/lib/czech_post_b2b_client/configuration.rb

@@ -22,15 +22,14 @@ module CzechPostB2bClient
       # set defaults here
 
       # ours, accessible, but maybe out of date, for test usage
-      @namespaces = {
-        'xmlns' => 'https://raw.githubusercontent.com/foton/czech_post_b2b_client/master/documents/B2B_CP_POL_2020-05-21/B2BCommon-v1.1.xsd',
-        'xmlns:ns2' => 'https://raw.githubusercontent.com/foton/czech_post_b2b_client/master/documents/B2B_CP_POL_2020-05-21/B2B-POLServices-v1.8.xsd'
-      }
-      # original, accessible only with setup certificates
       @namespaces = {
         'xmlns' => 'https://b2b.postaonline.cz/schema/B2BCommon-v1',
-        'xmlns:ns2' => 'https://b2b.postaonline.cz/schema/POLServices-v1'
+        'xmlns:ns2' => 'https://b2b.postaonline.cz/schema/POLServices-v1',
+        'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
+        'xsi:noNamespaceSchemaLocation' => 'https://raw.githubusercontent.com/foton/czech_post_b2b_client/master/documents/latest_xsds/B2BCommon.xsd',
+        'xsi:schemaLocation' => 'https://b2b.postaonline.cz/schema/POLServices-v1 https://raw.githubusercontent.com/foton/czech_post_b2b_client/master/documents/latest_xsds/B2BPOLServices.xsd'
       }
+
       @language = :cs
       @logger = defined?(Rails) ? ::Rails.logger : ::Logger.new(STDOUT)
       @b2b_api_base_uri = 'https://b2b.postaonline.cz/services/POLService/v1'

data/lib/czech_post_b2b_client/request_builders/parcel_service_sync_builder.rb

@@ -107,15 +107,6 @@ module CzechPostB2bClient
         end
       end
 
-      def cache_on_delivery_address
-        adr_data = common_data.dig(:cash_on_delivery, :address)
-        return nil unless adr_data
-
-        new_element('ns2:codAddress').tap do |cod_address|
-          add_address_elements(cod_address, adr_data, without: ['ns2:firstName', 'ns2:surname'])
-        end
-      end
-
       def cache_on_delivery_bank
         data = common_data.dig(:cash_on_delivery, :bank_account)
         return nil unless data
@@ -184,20 +175,32 @@ module CzechPostB2bClient
         add_parcel_adress_element('ns2:doPOLParcelAddressDocument', parcel[:document_addressee])
       end
 
-      def add_parcel_adress_element(element_name, addressee_data) # rubocop:disable Metrics/AbcSize
+      def add_parcel_adress_element(element_name, addressee_data) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
         return nil if addressee_data.nil?
 
         address_data = addressee_data[:address]
+
         new_element(element_name).tap do |do_parcel_address|
           add_element_to(do_parcel_address, 'ns2:recordID', value: addressee_data[:addressee_id]) # Nepovinne: Interni oznaceni adresata
-
-          add_address_elements(do_parcel_address, address_data) # Nepovinne: Adresa
+          add_element_to(do_parcel_address, 'ns2:firstName', value: address_data[:first_name]) # Nepovinne: Jmeno
+          add_element_to(do_parcel_address, 'ns2:surname', value: address_data[:last_name]) # Nepovinne: Prijmeni
+          add_element_to(do_parcel_address, 'ns2:companyName', value: address_data[:company_name]) # Nepovinne: Nazev spolecnosti
+          add_element_to(do_parcel_address, 'ns2:aditionAddress', value: address_data[:addition_to_name]) # Nepovinne: Doplnujici iformace k nazvu podavatele
 
           add_element_to(do_parcel_address, 'ns2:subject', value: addressee_data[:addressee_type]) # Nepovinne: Typ adresata
           add_element_to(do_parcel_address, 'ns2:ic', value: addressee_data[:ic]) # Nepovinne: ICO
           add_element_to(do_parcel_address, 'ns2:dic', value: addressee_data[:dic]) # Nepovinne: DIC
           add_element_to(do_parcel_address, 'ns2:specification', value: addressee_data[:addressee_specification]) # Nepovinne: Specifikace napr. datum narozeni
 
+          add_element_to(do_parcel_address, 'ns2:street', value: address_data[:street]) # Nepovinne: Ulice
+          add_element_to(do_parcel_address, 'ns2:houseNumber', value: address_data[:house_number]) # Nepovinne: Cislo popisne
+          add_element_to(do_parcel_address, 'ns2:sequenceNumber', value: address_data[:sequence_number]) # Nepovinne: Cislo orientacni
+          add_element_to(do_parcel_address, 'ns2:partCity', value: address_data[:city_part]) # Nepovinne: Cast obce
+          add_element_to(do_parcel_address, 'ns2:city', value: address_data[:city]) # Nepovinne: Obec
+          add_element_to(do_parcel_address, 'ns2:zipCode', value: address_data[:post_code]) # Nepovinne: PSC
+          add_element_to(do_parcel_address, 'ns2:isoCountry', value: address_data[:country_iso_code]) # Nepovinne, default 'CZ': ISO kod zeme
+          add_element_to(do_parcel_address, 'ns2:subIsoCountry', value: address_data[:subcountry_iso_code]) # Nepovinne: ISO kod uzemi
+
           add_bank_elements(do_parcel_address, addressee_data[:bank_account]) # Nepovinne. Kod banky, cislo a predcisli uctu
           add_contact_elements(do_parcel_address, addressee_data) # Nepovinne. Telefon, Mobil a Email
 
@@ -206,7 +209,6 @@ module CzechPostB2bClient
           (addressee_data[:advice_informations] || []).each_with_index do |adv_info, index|
             add_element_to(do_parcel_address, 'ns2:adviceInformation' + (index + 1).to_s, value: adv_info) # Nepovinne: Informace 1- 6 k dodejce
           end
-
           add_element_to(do_parcel_address, 'ns2:adviceNote', value: addressee_data[:advice_note]) # Nepovinne: Poznamka k dodejce
         end
       end
@@ -242,7 +244,7 @@ module CzechPostB2bClient
 
       def custom_goods_for(description_data)
         new_element('ns2:doPOLParcelCustomsGoods').tap do |do_p_customs_goods|
-          add_element_to(do_p_customs_goods, 'ns2:sequence', value: description_data[:order]) # Nepovinne: Poradi
+          add_element_to(do_p_customs_goods, 'ns2:sequence', value: description_data[:order].to_i) # Nepovinne: Poradi , cisl0 1-20
           add_element_to(do_p_customs_goods, 'ns2:customCont', value: description_data[:description]) # Nepovinne: Popis zbozi
           add_element_to(do_p_customs_goods, 'ns2:quantity', value: description_data[:quantity]) # Nepovinne: Mnozstvi
           add_element_to(do_p_customs_goods, 'ns2:weight', value: description_data[:weight_in_kg]) # Nepovinne: Hmotnost
@@ -252,34 +254,6 @@ module CzechPostB2bClient
         end
       end
 
-      # 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|
-          unless without.include?(xml_tag)
-            add_element_to(parent_element, xml_tag, value: value) unless value.nil?
-          end
-        end
-      end
-
-      def address_tags_and_values(address_data)
-        {
-          'ns2:firstName' => address_data[:first_name], # Nepovinne: Jmeno
-          'ns2:surname' => address_data[:last_name], # Nepovinne: Prijmeni
-          'ns2:companyName' => address_data[:company_name], # Nepovinne: Nazev spolecnosti
-          'ns2:aditionAddress' => address_data[:addition_to_name], # Nepovinne: Doplnujici iformace k nazvu podavatele
-          'ns2:street' => address_data[:street], # Nepovinne: Ulice
-          'ns2:houseNumber' => address_data[:house_number], # Nepovinne: Cislo popisne
-          'ns2:sequenceNumber' => address_data[:sequence_number], # Nepovinne: Cislo orientacni
-          'ns2:partCity' => address_data[:city_part], # Nepovinne: Cast obce
-          '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
-        }
-      end
-
       def add_bank_elements(parent_element, bank_account)
         return if bank_account.to_s == ''
 
@@ -291,9 +265,9 @@ module CzechPostB2bClient
           prefix, account, bank = nil
         end
 
+        add_element_to(parent_element, 'ns2:bank', value: bank) # Nepovinne: kod banky
         add_element_to(parent_element, 'ns2:prefixAccount', value: prefix) # Nepovinne: Predcisli k uctu
         add_element_to(parent_element, 'ns2:account', value: account) # Nepovinne: cislo uctu
-        add_element_to(parent_element, 'ns2:bank', value: bank) # Nepovinne: kod banky
       end
 
       def add_contact_elements(parent_element, data_hash)

data/lib/czech_post_b2b_client/request_builders/send_parcels_builder.rb

@@ -102,20 +102,11 @@ module CzechPostB2bClient
       end
 
       def sender_address
-        return nil unless sender_data[:address]
-
-        new_element('ns2:senderAddress').tap do |s_address|
-          add_address_elements(s_address, sender_data[:address], without: ['ns2:firstName', 'ns2:surname'])
-        end
+        add_header_address_element('ns2:senderAddress', sender_data)
       end
 
       def cache_on_delivery_address
-        adr_data = common_data.dig(:cash_on_delivery, :address)
-        return nil unless adr_data
-
-        new_element('ns2:codAddress').tap do |cod_address|
-          add_address_elements(cod_address, adr_data, without: ['ns2:firstName', 'ns2:surname'])
-        end
+        add_header_address_element('ns2:codAddress', common_data[:cash_on_delivery])
       end
 
       def cache_on_delivery_bank
@@ -135,7 +126,7 @@ module CzechPostB2bClient
         end
       end
 
-      def do_parcel_params(parcel_data) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      def do_parcel_params(parcel_data) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
         params = parcel_data[:params]
         cod = parcel_data[:cash_on_delivery] || {}
         new_element('ns2:doParcelParams').tap do |parcel_params|
@@ -185,20 +176,51 @@ module CzechPostB2bClient
         add_parcel_adress_element('ns2:doParcelAddressDocument', parcel_data[:document_addressee])
       end
 
-      def add_parcel_adress_element(element_name, addressee_data) # rubocop:disable Metrics/AbcSize
+      def add_header_address_element(element_name, addressee_data) # rubocop:disable Metrics/AbcSize
         return nil if addressee_data.nil?
 
         address_data = addressee_data[:address]
+
         new_element(element_name).tap do |do_parcel_address|
-          add_element_to(do_parcel_address, 'ns2:recordID', value: addressee_data[:addressee_id]) # Nepovinne: Interni oznaceni adresata
+          add_element_to(do_parcel_address, 'ns2:companyName', value: address_data[:company_name]) # Nepovinne: Nazev spolecnosti
+          add_element_to(do_parcel_address, 'ns2:aditionAddress', value: address_data[:addition_to_name]) # Nepovinne: Doplnujici iformace k nazvu podavatele
+          add_element_to(do_parcel_address, 'ns2:street', value: address_data[:street]) # Nepovinne: Ulice
+          add_element_to(do_parcel_address, 'ns2:houseNumber', value: address_data[:house_number]) # Nepovinne: Cislo popisne
+          add_element_to(do_parcel_address, 'ns2:sequenceNumber', value: address_data[:sequence_number]) # Nepovinne: Cislo orientacni
+          add_element_to(do_parcel_address, 'ns2:partCity', value: address_data[:city_part]) # Nepovinne: Cast obce
+          add_element_to(do_parcel_address, 'ns2:city', value: address_data[:city]) # Nepovinne: Obec
+          add_element_to(do_parcel_address, 'ns2:zipCode', value: address_data[:post_code]) # Nepovinne: PSC
+          add_element_to(do_parcel_address, 'ns2:isoCountry', value: address_data[:country_iso_code]) # Nepovinne, default 'CZ': ISO kod zeme
+          add_element_to(do_parcel_address, 'ns2:subIsoCountry', value: address_data[:subcountry_iso_code]) # Nepovinne: ISO kod uzemi
+        end
+      end
+
+      def add_parcel_adress_element(element_name, addressee_data) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+        return nil if addressee_data.nil?
+
+        address_data = addressee_data[:address]
 
-          add_address_elements(do_parcel_address, address_data) # Nepovinne: Adresa
+        new_element(element_name).tap do |do_parcel_address|
+          add_element_to(do_parcel_address, 'ns2:recordID', value: addressee_data[:addressee_id]) # Nepovinne: Interni oznaceni adresata
+          add_element_to(do_parcel_address, 'ns2:firstName', value: address_data[:first_name]) # Nepovinne: Jmeno
+          add_element_to(do_parcel_address, 'ns2:surname', value: address_data[:last_name]) # Nepovinne: Prijmeni
+          add_element_to(do_parcel_address, 'ns2:companyName', value: address_data[:company_name]) # Nepovinne: Nazev spolecnosti
+          add_element_to(do_parcel_address, 'ns2:aditionAddress', value: address_data[:addition_to_name]) # Nepovinne: Doplnujici iformace k nazvu podavatele
 
           add_element_to(do_parcel_address, 'ns2:subject', value: addressee_data[:addressee_type]) # Nepovinne: Typ adresata
           add_element_to(do_parcel_address, 'ns2:ic', value: addressee_data[:ic]) # Nepovinne: ICO
           add_element_to(do_parcel_address, 'ns2:dic', value: addressee_data[:dic]) # Nepovinne: DIC
           add_element_to(do_parcel_address, 'ns2:specification', value: addressee_data[:addressee_specification]) # Nepovinne: Specifikace napr. datum narozeni
 
+          add_element_to(do_parcel_address, 'ns2:street', value: address_data[:street]) # Nepovinne: Ulice
+          add_element_to(do_parcel_address, 'ns2:houseNumber', value: address_data[:house_number]) # Nepovinne: Cislo popisne
+          add_element_to(do_parcel_address, 'ns2:sequenceNumber', value: address_data[:sequence_number]) # Nepovinne: Cislo orientacni
+          add_element_to(do_parcel_address, 'ns2:partCity', value: address_data[:city_part]) # Nepovinne: Cast obce
+          add_element_to(do_parcel_address, 'ns2:city', value: address_data[:city]) # Nepovinne: Obec
+          add_element_to(do_parcel_address, 'ns2:zipCode', value: address_data[:post_code]) # Nepovinne: PSC
+          add_element_to(do_parcel_address, 'ns2:isoCountry', value: address_data[:country_iso_code]) # Nepovinne, default 'CZ': ISO kod zeme
+          add_element_to(do_parcel_address, 'ns2:subIsoCountry', value: address_data[:subcountry_iso_code]) # Nepovinne: ISO kod uzemi
+
           add_bank_elements(do_parcel_address, addressee_data[:bank_account]) # Nepovinne. Kod banky, cislo a predcisli uctu
           add_contact_elements(do_parcel_address, addressee_data) # Nepovinne. Telefon, Mobil a Email
 
@@ -207,7 +229,6 @@ module CzechPostB2bClient
           (addressee_data[:advice_informations] || []).each_with_index do |adv_info, index|
             add_element_to(do_parcel_address, 'ns2:adviceInformation' + (index + 1).to_s, value: adv_info) # Nepovinne: Informace 1- 6 k dodejce
           end
-
           add_element_to(do_parcel_address, 'ns2:adviceNote', value: addressee_data[:advice_note]) # Nepovinne: Poznamka k dodejce
         end
       end
@@ -278,9 +299,9 @@ module CzechPostB2bClient
           prefix, account, bank = nil
         end
 
+        add_element_to(parent_element, 'ns2:bank', value: bank) # Nepovinne: kod banky
         add_element_to(parent_element, 'ns2:prefixAccount', value: prefix) # Nepovinne: Predcisli k uctu
         add_element_to(parent_element, 'ns2:account', value: account) # Nepovinne: cislo uctu
-        add_element_to(parent_element, 'ns2:bank', value: bank) # Nepovinne: kod banky
       end
 
       def add_contact_elements(parent_element, data_hash)

data/lib/czech_post_b2b_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CzechPostB2bClient
-  VERSION = '1.2.2'
+  VERSION = '1.2.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: czech_post_b2b_client
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors:
 - Petr Mlčoch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-19 00:00:00.000000000 Z
+date: 2020-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ox