czech_post_b2b_client 1.2.8 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3f8150daa70de566a1a90f4287c3bb29f1547e9269409e573b6e7521a446df5
-  data.tar.gz: 23a3271bcf33470fc45e85d4e1db58ee9ea192a864fc0266c887acc9a2d6b56b
+  metadata.gz: 4966f6b2ba55ab0f3d48abcdadff8d56ca1fdd8208d830a37d803b05a0017329
+  data.tar.gz: 47585947e57849957b8770d28d1814cc1f4d0fd425c38e2213fe98dce4c0ff15
 SHA512:
-  metadata.gz: bbd09471e42a1af7f0f4bb7e8c6c34309e083dd224ad392ae11a84ec15c1aebedc178782f944a51d5be678a455daa769171dc02e2bf4d8cf50d18d0f98c9c643
-  data.tar.gz: 84bdfde9c41917ffa85c0f191123aca5a6d8b6373907c4969d3bf38c65b8782e6d4466e912a3a0db48c258cf089ca8ca74ea7d5b27f421b5f0ff7ae5c6615b85
+  metadata.gz: a2581677a5993c5f053d0cac45da5d6352406f7e368c5181621740d625eaa3f6440d3066493886e9758b443a05c83982855574bf82c7fb572c92e802e06acce8
+  data.tar.gz: 176dc98628cec8bd7e0aa5cfcfb32d130ffec49d2ec19d6661f78b01c7fd8b4b0c2f6467fef2de0c413a1a4e0d14fed2ba8670437777739d260cc93d6a1bf203

data/.rubocop.yml

@@ -13,7 +13,10 @@ AllCops:
     - "**/*.jb"
   Exclude:
     - "bin/*"
-Documentation:
+    - "documents/**/*"
+    - "test/fixtures/**/*"
+
+Style/Documentation:
   Enabled: false
 Layout/LineLength:
   Max: 140

data/CHANGELOG.md

@@ -2,60 +2,75 @@
 
 All changes to the gem are documented here.
 
+## [1.4.0] - 2022-10-20
+
+- upgrade of all required gems to handle ruby 3
+- CP cert can be passed by file path or content
+
+## [1.3.0] - 2022-04-07
+
+- checked currently available  Print Templates codes
+- enhanced address sheet printing with ability to print ZPL sheets (templates 200, 201 and 202).
+  Result of `AddressSheetGenerator` now have `pdf_content` and `zpl_content`.
+- found new(?) API from Czech Post , see `documents/B2B-ZSKService-1.4.0.yaml` and <https://www.ceskaposta.cz/napi/b2b>.
+
 ## [1.2.8] - 2022-03-22
- - added new response codes
+
+- added new response codes
 
 ## [1.2.6] - 2020-10-27
 
- - fixed passing all errors from `parcelsServiceSync` response.
+- fixed passing all errors from `parcelsServiceSync` response.
 
 ## [1.2.5] - 2020-10-06
 
- - `errorDescription` from `B2BError` response is now merged into error message.
+- `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)
+- 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
+- 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)
+- 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
- - Added options `custom_card_number` and `print_options` to `Configuration`
+- **Breaking** Introducing new Printing templates, improved some template names and scopes
+- Added options `custom_card_number` and `print_options` to `Configuration`
 
 ## [1.1.0] - 2020-05-28
 
- - Introducing new API documentation from Czech Post
- - Added service `ParcelSyncSender` service which uses newly discovered `parcelsServiceSync` API endpoint
- - Renamed `ParcelSender` to `ParcelAsyncSender` . And created deprecating clone `ParcelSender`, so no Breaking change! If You usit it calls `ParcelAsyncSender` and displays deprecation message.
+- Introducing new API documentation from Czech Post
+- Added service `ParcelSyncSender` service which uses newly discovered `parcelsServiceSync` API endpoint
+- Renamed `ParcelSender` to `ParcelAsyncSender` . And created deprecating clone `ParcelSender`, so no Breaking change! If You usit it calls `ParcelAsyncSender` and displays deprecation message.
 
 ## [1.0.3] - 2020-05-20
 
- - Added Czech Post service  DiscountForOnlinePosting.
- - **Breaking**: Renamed Post service "Size" classes `CzechPostB2bClient::PostServices::Size???` to `CzechPostB2bClient::PostServices::ParcelSize???` (eg. : `CzechPostB2bClient::PostServices::ParcelSizeXL`)
+- Added Czech Post service  DiscountForOnlinePosting.
+- **Breaking**: Renamed Post service "Size" classes `CzechPostB2bClient::PostServices::Size???` to `CzechPostB2bClient::PostServices::ParcelSize???` (eg. : `CzechPostB2bClient::PostServices::ParcelSizeXL`)
   I know, that I have **breaking** in every new version, I hope You are not fast enough.
 
 ## [1.0.2] - 2020-05-08
 
- - Added Czech Post services as classes, not just list in docs.
- - **Breaking**: Renamed methods `CzechPostB2bClient::PrintingTemplate.all_template_classes` and `CzechPostB2bClient::ResponseCodes.all_code_classes` to  `CzechPostB2bClient::PrintingTemplate.all_classes`  , and `CzechPostB2bClient::ResponseCodes.all_classes`
+- Added Czech Post services as classes, not just list in docs.
+- **Breaking**: Renamed methods `CzechPostB2bClient::PrintingTemplate.all_template_classes` and `CzechPostB2bClient::ResponseCodes.all_code_classes` to  `CzechPostB2bClient::PrintingTemplate.all_classes`  , and `CzechPostB2bClient::ResponseCodes.all_classes`
 
 ## [1.0.0] - 2020-03-19
 
 Production ready release
 
 ### Fixed
+
 ### Changed
+
 ### Added
-- All the stuff
 
+- All the stuff

data/README.md

@@ -1,5 +1,11 @@
 
 # FRESH NEWS
+7.4.2022
+Finally there is some online documentation about nAPI of Czech post (https://www.ceskaposta.cz/napi/b2b)
+Not yet checked  if this is the same api we use or new one. Seems that authorization is different.
+
+
+26.8.2020
 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"?>
@@ -91,7 +97,11 @@ CzechPostB2bClient.configure do |config|
   config.contract_id = 'contract_id'
   config.customer_id = 'customer_id'
   config.certificate_path = 'full_path/to/your/postsignum_certificate.pem'
+  # or you can use cert directly from env
+  config.certificate = ENC['CP_CRT_CONTENT']
+
   config.private_key_path = 'full_path/to/your/postsignum_private.key'
+  # same here,  filepath or content directly
   config.private_key_password = 'your_password or nil'
 
   # these two just save Your time, can be overwritten for each call

data/lib/czech_post_b2b_client/configuration.rb

@@ -9,8 +9,10 @@ module CzechPostB2bClient
                   :sending_post_office_code,
                   :sending_post_office_location_number,
                   :certificate_path,
+                  :certificate,
                   :private_key_password,
                   :private_key_path,
+                  :private_key,
                   :namespaces,
                   :language,
                   :logger,
@@ -32,7 +34,7 @@ module CzechPostB2bClient
       }
 
       @language = :cs
-      @logger = defined?(Rails) ? ::Rails.logger : ::Logger.new($stdout)
+      @logger = defined?(Rails::Logger) ? ::Rails.logger : ::Logger.new($stdout)
       @b2b_api_base_uri = 'https://b2b.postaonline.cz/services/POLService/v1'
       @sending_post_office_location_number = 1
 

data/lib/czech_post_b2b_client/printing_templates.rb

@@ -9,6 +9,10 @@ module CzechPostB2bClient
     class Base
       class << self
         attr_reader :id, :description, :page_dimensions
+
+        def content_type
+          :pdf
+        end
       end
     end
 
@@ -132,12 +136,6 @@ module CzechPostB2bClient
       @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'
@@ -175,29 +173,23 @@ module CzechPostB2bClient
         @page_dimensions = 'A5 landscape (210 × 148 mm)'
       end
 
-      class CN22FourOnPage < Base
-        @id = 74
-        @description = 'Celní prohlášení CN22 : 4x (A4)'
-        @page_dimensions = 'unverified A4'
-      end
-
-      class CN22WithCK < Base
-        @id = 75
-        @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)'
-        @page_dimensions = 'unverified A4'
-      end
-    end
-
-    class CN22FourOnPage < Base
-      @id = 74
-      @description = 'Celní prohlášení CN22 : 4x'
-      @page_dimensions = 'A4 portrait (210 × 297 mm)'
+      # class CN22FourOnPage < Base
+      #   @id = 74
+      #   @description = 'Celní prohlášení CN22 : 4x (A4)'
+      #   @page_dimensions = 'unverified A4'
+      # end
+
+      # class CN22WithCK < Base
+      #   @id = 75
+      #   @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)'
+      #   @page_dimensions = 'unverified A4'
+      # end
     end
 
     module HarmonizedLabel
@@ -232,20 +224,28 @@ module CzechPostB2bClient
         @description = 'Harmonizovaný štítek bianco - na výšku'
         @page_dimensions = 'A6 landscape (148 × 105 mm)'
       end
+    end
 
-      class ZebraBianco105x148 < Base
+    module ZebraLabel
+      class Base < CzechPostB2bClient::PrintingTemplates::Base
+        def self.content_type
+          :zpl
+        end
+      end
+
+      class Bianco105x148 < ZebraLabel::Base
         @id = 200
         @description = 'Harmonizovaný štítek bianco - (Zebra - 105x148); nejde o PDF'
         @page_dimensions = 'unverified 105 × 148 mm'
       end
 
-      class ZebraBianco100x150 < Base
+      class Bianco100x150 < ZebraLabel::Base
         @id = 201
         @description = 'Harmonizovaný štítek bianco - (Zebra - 100x150); nejde o PDF'
         @page_dimensions = 'unverified 100 × 150 mm'
       end
 
-      class ZebraBianco100x125 < Base
+      class Bianco100x125 < ZebraLabel::Base
         @id = 202
         @description = 'Harmonizovaný štítek bianco - (Zebra - 100x125); nejde o PDF'
         @page_dimensions = 'unverified 100 × 125 mm'
@@ -257,5 +257,12 @@ module CzechPostB2bClient
       base_class = CzechPostB2bClient::PrintingTemplates::Base
       ObjectSpace.each_object(base_class.singleton_class).reject { |c| c == base_class }
     end
+
+    def self.find(id)
+      klass = all_classes.detect { |k| k.id == id }
+      raise "PrintingTemplate with id: #{id}  is unknown!" unless klass
+
+      klass
+    end
   end
 end

data/lib/czech_post_b2b_client/response_parsers/get_parcels_printing_parser.rb

@@ -8,8 +8,8 @@ module CzechPostB2bClient
       def build_result
         super
         @result[:response][:state] = state_hash_from(printing_response_header_result['doPrintingStateResponse'])
-        @result[:printings] = { options: options_hash,
-                                pdf_content: pdf_content }
+        opt_hash = options_hash
+        @result[:printings] = { options: opt_hash }.merge(content_hash(opt_hash[:template_id]))
       end
 
       def options_hash
@@ -24,11 +24,23 @@ module CzechPostB2bClient
         }
       end
 
-      def pdf_content
-        pdf_content_encoded = response_root_node.dig('doPrintingDataResult', 'file')
-        return nil if pdf_content_encoded.nil?
+      def content_hash(template_id)
+        if zpl_template?(template_id)
+          { zpl_content: response_content.force_encoding('utf-8') }
+        else
+          { pdf_content: response_content }
+        end
+      end
+
+      def zpl_template?(template_id)
+        CzechPostB2bClient::PrintingTemplates.find(template_id).content_type == :zpl
+      end
+
+      def response_content
+        content_encoded = response_root_node.dig('doPrintingDataResult', 'file')
+        return nil if content_encoded.nil?
 
-        ::Base64.decode64(pdf_content_encoded)
+        ::Base64.decode64(content_encoded)
       end
 
       def response_root_node_name

data/lib/czech_post_b2b_client/services/address_sheets_generator.rb

@@ -5,7 +5,7 @@ module CzechPostB2bClient
     class AddressSheetsGenerator < CzechPostB2bClient::Services::Communicator
       attr_reader :parcel_codes, :options
 
-      AddressSheetsGeneratorResult = Struct.new(:pdf_content, :state_text, :state_code, keyword_init: true)
+      AddressSheetsGeneratorResult = Struct.new(:pdf_content, :zpl_content, :state_text, :state_code, keyword_init: true)
 
       def initialize(parcel_codes:, options: {})
         super()
@@ -41,6 +41,7 @@ module CzechPostB2bClient
 
       def build_result_from(response_hash)
         AddressSheetsGeneratorResult.new(pdf_content: response_hash.dig(:printings, :pdf_content),
+                                         zpl_content: response_hash.dig(:printings, :zpl_content),
                                          state_text: response_hash.dig(:response, :state, :text),
                                          state_code: response_hash.dig(:response, :state, :code))
       end

data/lib/czech_post_b2b_client/services/api_caller.rb

@@ -73,15 +73,23 @@ module CzechPostB2bClient
         { 'Content-Type': 'text/xml' }
       end
 
+      def certificate
+        configuration.certificate || File.read(configuration.certificate_path)
+      end
+
+      def private_key
+        configuration.private_key || File.read(configuration.private_key_path)
+      end
+
       def connection_options
         {
           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: OpenSSL::X509::Certificate.new(certificate),
           # cert_password: configuration.certificate_password,
-          key: OpenSSL::PKey::RSA.new(File.read(configuration.private_key_path), configuration.private_key_password),
+          key: OpenSSL::PKey::RSA.new(private_key, configuration.private_key_password),
           cert_store: post_signum_ca_store
         }
       end

data/lib/czech_post_b2b_client/services/orchestrator.rb

@@ -8,7 +8,8 @@ module CzechPostB2bClient
       def result_of_subservice(service_hash)
         service_name = service_hash.keys.first
         service_class = send("#{service_name}_class")
-        service = service_class.call(service_hash.values.first)
+
+        service = service_class.call(**service_hash.values.first)
 
         if service.failed?
           errors.add_from_hash({ service_name => service.errors.full_messages })

data/lib/czech_post_b2b_client/version.rb

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

data/lib/stepped_service/base.rb

@@ -87,7 +87,13 @@ module SteppedService
     attr_reader :result
 
     def self.call(*args, **keyword_args)
-      new(*args, **keyword_args).call
+      if args.blank?
+        new(**keyword_args).call
+      elsif keyword_args.blank?
+        new(*args).call
+      else
+        new(*args, **keyword_args).call
+      end
     end
 
     # You can override it, to not use steps

metadata

@@ -1,141 +1,141 @@
 --- !ruby/object:Gem::Specification
 name: czech_post_b2b_client
 version: !ruby/object:Gem::Version
-  version: 1.2.8
+  version: 1.4.0
 platform: ruby
 authors:
 - Petr Mlčoch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-22 00:00:00.000000000 Z
+date: 2022-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ox
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.26.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.26.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 description: 
 email:
 - foton@centrum.cz
@@ -218,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.28
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Accessing B2B API of Czech Post for bulk processing of packages ("B2B - WS