czech_post_b2b_client 1.1.0 → 1.2.5

data/doc/top-level-namespace.html

@@ -6,15 +6,15 @@
 <title>
   Top Level Namespace
   
-    &mdash; Documentation by YARD 0.9.19
+    &mdash; Documentation by YARD 0.9.24
   
 </title>
 
-  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
 
-  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
 
-<script type="text/javascript" charset="utf-8">
+<script type="text/javascript">
   pathId = "";
   relpath = '';
 </script>
@@ -100,9 +100,9 @@
 </div>
 
       <div id="footer">
-  Generated on Fri Mar 20 17:49:05 2020 by
+  Generated on Thu May 28 17:06:47 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.19 (ruby-2.4.1).
+  0.9.24 (ruby-2.4.1).
 </div>
 
     </div>

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

@@ -14,25 +14,30 @@ module CzechPostB2bClient
                   :namespaces,
                   :language,
                   :logger,
-                  :b2b_api_base_uri
+                  :b2b_api_base_uri,
+                  :print_options,
+                  :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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# rubocop:disable Style/AsciiComments
+
 # Available printing templates, which can be used in AdressSheetsGenerator `options[:template_id]`
 #
 # Do not miss `CzechPostB2bClient::PrintingTemplates.all_classes` method,
@@ -8,77 +10,82 @@ module CzechPostB2bClient
   module PrintingTemplates
     class Base
       class << self
-        attr_reader :id, :description
+        attr_reader :id, :description, :page_dimensions
       end
     end
 
-    module AdressLabel
+    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'
+        @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 Blank4OnPage < Base
+      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 Blank < Base
+      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 BlankLandscape < Base
+      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čí'
+          @description = 'CP72 - standardní balík do zahraničí' # or 'AŠ - samostatný Standardní balík do zahraničí'
+          @page_dimensions = 'A5 landscape (210 × 148 mm)'
         end
 
-        class Standard2OnPage < Base
+        class StandardTwoOnPage < Base
           @id = 59
-          @description = 'CP72 - standardní balík do zahraničí (2x A4 )'
+          @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 Valuable < Base
+        class Insured < Base
           @id = 60
-          @description = 'CP72 - cenný balík do zahraničí'
+          @description = 'CP72 - cenný balík do zahraničí' # or 'AŠ - samostatný Cenný balík do zahraničí'
+          @page_dimensions = 'A5 landscape (210 × 148 mm)'
         end
 
-        class Valuable4OnPage < Base
+        class InsuredFourOnPage < Base
           @id = 61
-          @description = 'CP72 - cenný balík do zahraničí (2x A4)'
+          @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 EMS2x4 < Base
+        class EMSTwoOnPage < Base
           @id = 63
-          @description = 'AŠ - 2xA4 EMS do zahraničí'
-        end
-
-        # Formulare ID 72 a 73 je mozno pouzit pouze pro zasilky s prefixem CE
-        # do zemi AT, DE, FR, GR, HR, CH, IS, LU, LV, NO, PL, SK
-        class HarmonizedLabel < Base
-          @id = 72
-          @description = 'Obchodní balík do zahraničí – samostatný'
-        end
-
-        class HarmonizedLabel4OnPage < Base
-          @id = 73
-          @description = 'Obchodní balík do zahraničí –  4x (A4)'
+          @description = 'AŠ - EMS do zahraničí : 2x'
+          @page_dimensions = 'unverified A4'
         end
       end
     end
@@ -87,93 +94,172 @@ 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 CODVoucherA3OnPage < Base
+    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 CustomDeclaration
+    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 CN224OnPage < Base
+      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 CN22WithCK4OnPage < Base
+      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'
+      @page_dimensions = 'A4 portrait (210 × 297 mm)'
+    end
+
+    module HarmonizedLabel
+      # Formulare ID 72 a 73 je mozno pouzit pouze pro zasilky s prefixem CE
+      # 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čí' # 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)'
+        @page_dimensions = 'unverified A4'
+      end
+
+      class BiancoFourOnPage < Base
+        @id = 100
+        @description = 'Harmonizovaný štítek bianco : 4x'
+        @page_dimensions = 'A4 portrait (210 × 297 mm)'
+      end
+
+      class Bianco < Base
+        @id = 101
+        @description = 'Harmonizovaný štítek bianco'
+        @page_dimensions = 'A6 portrait (105 × 148 mm)'
+      end
+
+      class BiancoPortrait < Base
+        @id = 102
+        @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); nejde o PDF'
+        @page_dimensions = 'unverified 105 × 148 mm'
+      end
+
+      class ZebraBianco100x150 < Base
+        @id = 201
+        @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); 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
+
+# rubocop:enable Style/AsciiComments