czech_post_b2b_client 1.2.1 → 1.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 195b8ec3ce8eb8a50a8e930a2629917fb7a452d9
-  data.tar.gz: b78e4f92cc14b98265ab6d595fa7c2011ec32208
+SHA256:
+  metadata.gz: 74fa378ca71040acf1adb94fb61fa1d371ae2491273b3585bed2ef14ce6911e8
+  data.tar.gz: efda7da207ddf3146be8181c4765f8cca645020131f3cda81e211fb5ff9ea828
 SHA512:
-  metadata.gz: 54ef2187484cf754ee7fd92f903e3252472da1d30af90927ee64af447bea861df97581342af4dfe9d7193a123bd1a4c2d4f35ea2253836eb74bd2b4c1d05092b
-  data.tar.gz: b72195f63bb3153ae95473211f68756ea162599e4f617e7b77d5e93ca35b3eb5eb5bfc4fa83cdd496a4a4b7d2b8bece76eb8b255e3f77c4a4bbe16510e3dd510
+  metadata.gz: 9752291d61873388331118b6167d212e40aab3ce344d0306f664ba245ac5e6515296dba98a97788b0604a39355a4514ac3d409b548d14e63efe3786f920cb627
+  data.tar.gz: 257ceece993bb225b3ec020667af0fab9c26edd0b2eb16c35d41c470f70c7b8377443da68dc7c057e9d1d237e4bc74743cf70a585a5ad7c6fe10152c86990a63

data/.rubocop.yml

@@ -15,7 +15,7 @@ AllCops:
 Documentation:
   Enabled: false
 Layout/LineLength:
-  Max: 120
+  Max: 140
 Metrics/AbcSize:
   Max: 20
 Metrics/MethodLength:

data/CHANGELOG.md

@@ -2,6 +2,29 @@
 
 All changes to the gem are documented here.
 
+## [1.2.6] - 2020-10-27
+
+ - fixed passing all errors from `parcelsServiceSync` response.
+
+## [1.2.5] - 2020-10-06
+
+ - `errorDescription` from `B2BError` response is now merged into error message.
+
+## [1.2.4] - 2020-10-06
+
+ - Added `configuration.log_messages_at_least_as` option, to be able debug client behaviour when app log level is higher (eg. production)
+
+## [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
+ - Forced secure SSL ciphers for requests
+ - `examples/try_api_call.rb` refactored to be more versatile (download XSDs [:do not work], pritn_selected_combinations)
+
 ## [1.2.0] - 2020-06-07
 
  - **Breaking** Introducing new Printing templates, improved some template names and scopes
@@ -33,4 +56,3 @@ Production ready release
 ### Added
 - All the stuff
 
-

data/README.md

@@ -1,3 +1,40 @@
+
+# FRESH NEWS
+After full usage in production (vyvolej.to, squared.one), we found that Czech POst have trouble with `parcelServiceSync` (maybe `sendParcels` too). When You try to register package with `:customs_documents`, you get `INVALID_BATCH` response with no error, but with `parcelCode`:
+```
+<?xml version="1.0" encoding="UTF-8"?>
+<v1:b2bSyncResponse xmlns:v1="https://b2b.postaonline.cz/schema/B2BCommon-v1" xmlns:v1_1="https://b2b.postaonline.cz/schema/POLServices-v1">
+  <v1:header>
+    <v1:b2bRequestHeader>
+      <v1:idExtTransaction>1</v1:idExtTransaction>
+      <v1:timeStamp>2020-08-22T07:32:20.496Z</v1:timeStamp>
+      <v1:idContract>356936003</v1:idContract>
+    </v1:b2bRequestHeader>
+  </v1:header>
+  <v1:serviceData><v1_1:parcelServiceSyncResponse>
+      <v1_1:responseHeader>
+        <v1_1:resultHeader>
+          <v1_1:responseCode>19</v1_1:responseCode>
+          <v1_1:responseText>BATCH_INVALID</v1_1:responseText>
+        </v1_1:resultHeader>
+        <v1_1:resultParcelData>
+          <v1_1:recordNumber>52427</v1_1:recordNumber>
+          <v1_1:parcelCode>RR950819194CZ</v1_1:parcelCode>
+          <v1_1:parcelDataResponse>
+            <v1_1:responseCode>1</v1_1:responseCode>
+            <v1_1:responseText>OK</v1_1:responseText>
+          </v1_1:parcelDataResponse>
+        </v1_1:resultParcelData>
+      </v1_1:responseHeader>
+    </v1_1:parcelServiceSyncResponse></v1:serviceData>
+</v1:b2bSyncResponse>
+```
+
+*Reality is, that Parcel IS NOT registered!*
+
+They say, that this should be fixed in 2020-10-01 release. But I still can not grab new XSD.
+
+
 # CzechPostB2bClient
 Accessing B2B API of Czech Post for bulk processing of parcels ("B2B - WS PodáníOnline").
 
@@ -10,6 +47,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)
@@ -70,6 +108,7 @@ CzechPostB2bClient.configure do |config|
   # config.language => :cs # other languages are not supported now
   # config.logger => ::Rails.logger or ::Logger.new(STDOUT),
   # config.b2b_api_base_uri => 'https://b2b.postaonline.cz/services/POLService/v1'
+  # config.log_messages_at_least_as = :debug
 end
 ```
 
@@ -277,6 +316,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.rb

@@ -5,6 +5,7 @@ require 'stepped_service'
 
 require 'czech_post_b2b_client/version'
 require 'czech_post_b2b_client/configuration'
+require 'czech_post_b2b_client/logger'
 
 require 'czech_post_b2b_client/b2b_errors'
 require 'czech_post_b2b_client/response_codes'
@@ -26,7 +27,7 @@ module CzechPostB2bClient
   end
 
   def self.logger
-    self.configuration.logger
+    CzechPostB2bClient::Logger.new(self.configuration)
   end
 
   def self.root

data/lib/czech_post_b2b_client/b2b_errors.rb

@@ -35,12 +35,17 @@ module CzechPostB2bClient
         attr_reader :message
       end
 
+      def initialize(details = '')
+        self.details = details
+      end
+
+      attr_accessor :details
       def code
         self.class.code
       end
 
       def message
-        self.class.message
+        "#{self.class.message} -- #{details}"
       end
     end
 
@@ -94,11 +99,11 @@ module CzechPostB2bClient
       ObjectSpace.each_object(CzechPostB2bClient::B2BErrors::BaseError.singleton_class)
     end
 
-    def self.new_by_code(code)
+    def self.new_by_code(code, details = '')
       klass = all_error_classes.detect { |k| k.code == code }
       raise "B2BError with code: #{code} is unknown!" unless klass
 
-      klass.new
+      klass.new(details)
     end
   end
 end

data/lib/czech_post_b2b_client/configuration.rb

@@ -16,25 +16,28 @@ module CzechPostB2bClient
                   :logger,
                   :b2b_api_base_uri,
                   :print_options,
-                  :custom_card_number
+                  :custom_card_number,
+                  :log_messages_at_least_as
 
     def initialize
       # 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'
       @sending_post_office_location_number = 1
+
+      # set this to :error in production for API debug logs in production.log
+      @log_messages_at_least_as = :debug # so all logs keeps their level
     end
   end
 end

data/lib/czech_post_b2b_client/logger.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module CzechPostB2bClient
+  class Logger
+    attr_reader :target_logger, :min_log_level
+
+    LEVELS = { debug: 0, info: 1, error: 2 }.freeze
+
+    def initialize(configuration)
+      @target_logger = configuration.logger
+      @min_log_level = configuration.log_messages_at_least_as
+    end
+
+    def log(original_level, message)
+      target_logger.send(modified_log_level(original_level), message)
+    end
+
+    LEVELS.each_key do |level|
+      define_method(level) { |message| log(level, message) }
+    end
+
+    private
+
+    def modified_log_level(original_level)
+      LEVELS[original_level] > LEVELS[min_log_level] ? original_level : min_log_level
+    end
+  end
+end

data/lib/czech_post_b2b_client/post_services.rb

@@ -768,7 +768,8 @@ module CzechPostB2bClient
 
     # has to be at the end, to load all subcasses before
     def self.all_classes
-      ObjectSpace.each_object(CzechPostB2bClient::PostServices::Base.singleton_class)
+      base_class = CzechPostB2bClient::PostServices::Base
+      ObjectSpace.each_object(base_class.singleton_class).reject { |c| c == base_class }
     end
   end
 end

data/lib/czech_post_b2b_client/printing_templates.rb

@@ -10,70 +10,82 @@ module CzechPostB2bClient
   module PrintingTemplates
     class Base
       class << self
-        attr_reader :id, :description
+        attr_reader :id, :description, :page_dimensions
       end
     end
 
     module AddressLabel
       class Simple < Base
         @id = 7
-        @description = 'adresní štítek (alonž) - samostatný'
+        @description = 'adresní štítek (alonž) [1x1/4 A4'
+        @page_dimensions = 'A4 portrait (210 × 297 mm)'
       end
 
       class SimpleA6FourOnPage < Base
         @id = 103
-        @description = 'Adresní štítek A6 – 4x'
+        @description = 'Adresní štítek A6 : 4x'
+        @page_dimensions = 'A4 portrait (210 × 297 mm)'
       end
 
       class SimpleWithCODVoucherA < Base
         @id = 8
-        @description = 'adresní štítek (alonž) + dobírková poukázka A'
+        @description = 'adresní štítek (alonž) + dobírková poukázka A [(1x1/4 A4 + 1x1/2 A4)'
+        @page_dimensions = 'A4 portrait (210 × 297 mm)'
       end
 
       class BiancoFourOnPage < Base
         @id = 20
-        @description = 'adresní štítek bianco - 4x (A4)'
+        @description = 'adresní štítek bianco : 4x'
+        @page_dimensions = 'A4 landscape (297 × 210 mm)'
       end
 
       class Bianco < Base
         @id = 21
-        @description = 'adresní štítek bianco - samostatný'
+        @description = 'adresní štítek bianco'
+        @page_dimensions = 'A6 portrait (105 × 148 mm)'
       end
 
       class BiancoLandscape < Base
         @id = 39
-        @description = 'adresní štítek bianco - samostatný (na šířku)'
+        @description = 'adresní štítek bianco - na šířku'
+        @page_dimensions = 'A6 landscape (148 × 105 mm)'
       end
 
       module ForeignPackage
         class Standard < Base
           @id = 58
           @description = 'CP72 - standardní balík do zahraničí' # or 'AŠ - samostatný Standardní balík do zahraničí'
+          @page_dimensions = 'A5 landscape (210 × 148 mm)'
         end
 
         class StandardTwoOnPage < Base
           @id = 59
-          @description = 'CP72 - standardní balík do zahraničí (2x A4 )' # or 'AŠ - 4xA4 Standardní balík do zahraničí'
+          @description = 'CP72 - standardní balík do zahraničí : 2x' # or 'AŠ - 4xA4 Standardní balík do zahraničí'
+          @page_dimensions = 'A4 portrait (297 × 210 mm)'
         end
 
         class Insured < Base
           @id = 60
           @description = 'CP72 - cenný balík do zahraničí' # or 'AŠ - samostatný Cenný balík do zahraničí'
+          @page_dimensions = 'A5 landscape (210 × 148 mm)'
         end
 
         class InsuredFourOnPage < Base
           @id = 61
-          @description = 'CP72 - cenný balík do zahraničí (2x A4)' # or '4xA4 Cenný balík do zahraničí'
+          @description = 'CP72 - cenný balík do zahraničí : 2x' # or '4xA4 Cenný balík do zahraničí'
+          @page_dimensions = 'A4 portrait (297 × 210 mm)'
         end
 
         class EMS < Base
           @id = 62
           @description = 'AŠ - samostatný EMS zahraničí'
+          @page_dimensions = 'unverified'
         end
 
         class EMSTwoOnPage < Base
           @id = 63
-          @description = 'AŠ - 2xA4 EMS do zahraničí'
+          @description = 'AŠ - EMS do zahraničí : 2x'
+          @page_dimensions = 'unverified A4'
         end
       end
     end
@@ -82,94 +94,112 @@ module CzechPostB2bClient
       class EnvelopeC6 < Base
         @id = 22
         @description = 'obálka 1 - C6'
+        @page_dimensions = 'C6 portrait (114 × 162 mm)'
       end
 
       class EnvelopeC5 < Base
         @id = 23
         @description = 'obálka 2 - C5'
+        @page_dimensions = 'C5/prc7 portrait (162 × 229 mm)'
       end
 
       class EnvelopeB4 < Base
         @id = 24
         @description = 'obálka 3 - B4'
+        @page_dimensions = 'B4 portrait (250 × 353 mm)'
       end
 
       class EnvelopeDL < Base
         @id = 25
         @description = 'obálka 4 - DL bez okénka'
+        @page_dimensions = 'DL/prc5 portrait (109 × 219 mm)'
       end
     end
 
     class CODVoucherA < Base
       @id = 10
       @description = 'poštovní dobírková poukázka A - samostatná'
+      @page_dimensions = '102 × 210 mm'
     end
 
     class CODVoucherAThreeOnPage < Base
       @id = 11
-      @description = 'poštovní dobírková poukázka A - 3x (A4)'
+      @description = 'poštovní dobírková poukázka A - 3x'
+      @page_dimensions = '210 × 306 mm'
     end
 
     class CODVoucherC < Base
       @id = 12
       @description = 'Poštovní dobírková poukázka C'
+      @page_dimensions = 'unverified'
     end
 
     class CODVoucherForCSOB < Base
       @id = 13
       @description = 'Dobírková složenka ČSOB'
+      @page_dimensions = 'unverified'
     end
 
     class RRLabels3x8 < Base
       @id = 26
-      @description = 'štítky pro RR - 3x8 (A4)'
+      @description = 'štítky pro RR : 3x8'
+      @page_dimensions = 'A4 portrait (210 × 297 mm)'
     end
 
     class IntegratedDocument < Base
       @id = 38
       @description = 'Integrovaný doklad'
+      @page_dimensions = 'unverified'
     end
 
     class AddressData3x8 < Base
       @id = 40
-      @description = 'Adresní údaje 3x8 (A4)'
+      @description = 'Adresní údaje : 3x8'
+      @page_dimensions = 'A4 portrait (210 × 297 mm)'
     end
 
     class DeliveryTicket < Base
       @id = 41
       @description = 'Dodejka'
+      @page_dimensions = 'unverified'
     end
 
     module CustomsDeclaration
       class CN22 < Base
         @id = 56
-        @description = 'Celní prohlášení CN22 - 1x (A4)'
+        @description = 'Celní prohlášení CN22 [samotný tisk je velikosti cca A6 vlevo nahořu od středu]'
+        @page_dimensions = 'A4 portrait (210 × 297 mm)'
       end
 
       class CN23 < Base
         @id = 57
-        @description = 'Celní prohlášení CN23 - 1x (A4)'
+        @description = 'Celní prohlášení CN23'
+        @page_dimensions = 'A5 landscape (210 × 148 mm)'
       end
 
       class CN22FourOnPage < Base
         @id = 74
-        @description = 'Celní prohlášení CN22 - 4x (A4)'
+        @description = 'Celní prohlášení CN22 : 4x (A4)'
+        @page_dimensions = 'unverified A4'
       end
 
       class CN22WithCK < Base
         @id = 75
-        @description = 'Celní prohlášení CN22  s ČK - 1x (A4)'
+        @description = 'Celní prohlášení CN22 s ČK (A4)'
+        @page_dimensions = 'unverified A4'
       end
 
       class CN22WithCKFourOnPage < Base
         @id = 76
-        @description = 'Celní prohlášení CN22  s ČK - 4x (A4)'
+        @description = 'Celní prohlášení CN22 s ČK : 4x (A4)'
+        @page_dimensions = 'unverified A4'
       end
     end
 
     class CN22FourOnPage < Base
       @id = 74
-      @description = 'Celní prohlášení CN22 - 4x (A4)'
+      @description = 'Celní prohlášení CN22 : 4x'
+      @page_dimensions = 'A4 portrait (210 × 297 mm)'
     end
 
     module HarmonizedLabel
@@ -177,48 +207,57 @@ module CzechPostB2bClient
       # do zemi AT, DE, FR, GR, HR, CH, IS, LU, LV, NO, PL, SK
       class Simple < Base
         @id = 72
-        @description = 'Obchodní balík do zahraničí – samostatný' # or 'Harmonizovaný štítek pro MZ produkty-samostatný'
+        @description = 'Obchodní balík do zahraničí' # or 'Harmonizovaný štítek pro MZ produkty-samostatný'
+        @page_dimensions = 'unverified'
       end
 
       class SimpleFourOnPage < Base
         @id = 73
-        @description = 'Obchodní balík do zahraničí –  4x (A4)' # or 'Harmonizovaný štítek pro MZ produkty – 4x (A4)'
+        @description = 'Obchodní balík do zahraničí : 4x (A4)' # or 'Harmonizovaný štítek pro MZ produkty – 4x (A4)'
+        @page_dimensions = 'unverified A4'
       end
 
       class BiancoFourOnPage < Base
         @id = 100
-        @description = 'Harmonizovaný štítek bianco – 4x (A4)'
+        @description = 'Harmonizovaný štítek bianco : 4x'
+        @page_dimensions = 'A4 portrait (210 × 297 mm)'
       end
 
       class Bianco < Base
         @id = 101
-        @description = 'Harmonizovaný štítek bianco – samostatný'
+        @description = 'Harmonizovaný štítek bianco'
+        @page_dimensions = 'A6 portrait (105 × 148 mm)'
       end
 
       class BiancoPortrait < Base
         @id = 102
-        @description = 'Harmonizovaný štítek bianco – samostatný (na výšku)'
+        @description = 'Harmonizovaný štítek bianco - na výšku'
+        @page_dimensions = 'A6 landscape (148 × 105 mm)'
       end
 
       class ZebraBianco105x148 < Base
         @id = 200
-        @description = 'Harmonizovaný štítek bianco - (Zebra - 105x148)'
+        @description = 'Harmonizovaný štítek bianco - (Zebra - 105x148); nejde o PDF'
+        @page_dimensions = 'unverified 105 × 148 mm'
       end
 
       class ZebraBianco100x150 < Base
         @id = 201
-        @description = 'Harmonizovaný štítek bianco - (Zebra - 100x150)'
+        @description = 'Harmonizovaný štítek bianco - (Zebra - 100x150); nejde o PDF'
+        @page_dimensions = 'unverified 100 × 150 mm'
       end
 
       class ZebraBianco100x125 < Base
         @id = 202
-        @description = 'Harmonizovaný štítek bianco - (Zebra - 100x125)'
+        @description = 'Harmonizovaný štítek bianco - (Zebra - 100x125); nejde o PDF'
+        @page_dimensions = 'unverified 100 × 125 mm'
       end
     end
 
     # has to be at the end, to load all subcasses before
     def self.all_classes
-      ObjectSpace.each_object(CzechPostB2bClient::PrintingTemplates::Base.singleton_class)
+      base_class = CzechPostB2bClient::PrintingTemplates::Base
+      ObjectSpace.each_object(base_class.singleton_class).reject { |c| c == base_class }
     end
   end
 end