belpost 0.7.0 → 0.11.0

data/lib/belpost/validations/batch_item_schema.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+require "dry-validation"
+
+module Belpost
+  module Validation
+    # Schema for validating batch item data
+    class BatchItemSchema < Dry::Validation::Contract
+      params do
+        required(:items).array(:hash) do
+          optional(:recipient_id).maybe(:integer)
+          optional(:recipient_foreign_id).maybe(:string)
+          optional(:recipient_object).maybe(:hash) do
+            optional(:foreign_id).maybe(:string)
+            required(:type).filled(:string, included_in?: %w[legal individual individual_entrepreneur])
+
+            optional(:first_name).maybe(:string)
+            optional(:last_name).maybe(:string)
+            optional(:second_name).maybe(:string)
+
+            optional(:company_name).maybe(:string)
+
+            required(:address).hash do
+              required(:address_type).filled(:string, included_in?: %w[address on_demand subscriber_box])
+              required(:postcode).filled(:string)
+              optional(:ops_id).maybe(:string)
+              required(:country_code).filled(:string)
+              optional(:region).maybe(:string)
+              optional(:district).maybe(:string)
+              required(:city).filled(:string)
+              optional(:building).maybe(:string)
+              optional(:housing).maybe(:string)
+              optional(:apartment).maybe(:string)
+              optional(:cell_number).maybe(:string)
+            end
+
+            optional(:phone).maybe(:string)
+          end
+
+          optional(:s10code).maybe(:string)
+          optional(:notification_s10code).maybe(:string)
+          required(:notification).filled(:integer, included_in?: [0, 1, 2, 5, 7])
+          required(:category).filled(:integer, included_in?: [0, 1, 2])
+          required(:weight).filled(:integer, gt?: 0)
+
+          optional(:addons).maybe(:hash) do
+            optional(:declared_value).maybe(:float, gt?: 0)
+            optional(:cash_on_delivery).maybe(:float, gt?: 0)
+            optional(:careful_fragile).maybe(:bool)
+            optional(:hand_over_personally).maybe(:bool)
+            optional(:subpoena).maybe(:bool)
+            optional(:description).maybe(:bool)
+            optional(:bulky).maybe(:bool)
+            optional(:recipient_payment).maybe(:bool)
+            optional(:documents_return).maybe(:bool)
+            optional(:deliver_to_work).maybe(:bool)
+            optional(:open_upon_delivery).maybe(:bool)
+            optional(:time_of_delivery).maybe(:hash) do
+              required(:type).filled(:string, included_in?: %w[level1 level2 level3 level4])
+              optional(:time_interval).hash do
+                required(:from).filled(:string)
+                required(:to).filled(:string)
+              end
+            end
+            optional(:free_return).maybe(:bool)
+            optional(:partial_return).maybe(:bool)
+            optional(:government).maybe(:bool)
+            optional(:military).maybe(:bool)
+            optional(:service).maybe(:bool)
+            optional(:shelf_life).maybe(:integer, included_in?: (10..30))
+            optional(:email).maybe(:string)
+            optional(:phone).maybe(:string)
+            optional(:coordinate_delivery_interval).maybe(:bool)
+          end
+        end
+      end
+
+      rule('items[].recipient_object.first_name') do
+        if key? && value.is_a?(Array)
+          value.each_with_index do |item, idx|
+            if item[:recipient_object] && item[:recipient_object][:type] == 'individual' && item[:recipient_object][:first_name].nil?
+              key(:"items.#{idx}.recipient_object.first_name").failure('must be filled for individual type')
+            end
+          end
+        end
+      end
+
+      rule('items[].recipient_object.last_name') do
+        if key? && value.is_a?(Array)
+          value.each_with_index do |item, idx|
+            if item[:recipient_object] && item[:recipient_object][:type] == 'individual' && item[:recipient_object][:last_name].nil?
+              key(:"items.#{idx}.recipient_object.last_name").failure('must be filled for individual type')
+            end
+          end
+        end
+      end
+
+      rule('items[].recipient_object.company_name') do
+        if key? && value.is_a?(Array)
+          value.each_with_index do |item, idx|
+            if item[:recipient_object] &&
+               (item[:recipient_object][:type] == 'legal' || item[:recipient_object][:type] == 'individual_entrepreneur') &&
+               item[:recipient_object][:company_name].nil?
+              key(:"items.#{idx}.recipient_object.company_name").failure('must be filled for legal or individual_entrepreneur type')
+            end
+          end
+        end
+      end
+
+      rule('items[].recipient_object.address.ops_id') do
+        if key? && value.is_a?(Array)
+          value.each_with_index do |item, idx|
+            if item[:recipient_object] &&
+               item[:recipient_object][:address] &&
+               item[:recipient_object][:address][:address_type] == 'address' &&
+               item[:recipient_object][:address][:ops_id].nil?
+              key(:"items.#{idx}.recipient_object.address.ops_id").failure('must be filled for address type')
+            end
+          end
+        end
+      end
+
+      rule('items[].recipient_object.address.cell_number') do
+        if key? && value.is_a?(Array)
+          value.each_with_index do |item, idx|
+            if item[:recipient_object] &&
+               item[:recipient_object][:address] &&
+               item[:recipient_object][:address][:address_type] == 'subscriber_box' &&
+               item[:recipient_object][:address][:cell_number].nil?
+              key(:"items.#{idx}.recipient_object.address.cell_number").failure('must be filled for subscriber_box type')
+            end
+          end
+        end
+      end
+
+      rule('items[].recipient_object') do
+        if key? && value.is_a?(Array)
+          value.each_with_index do |item, idx|
+            if item[:recipient_id].nil? && item[:recipient_foreign_id].nil? && item[:recipient_object].nil?
+              key(:"items.#{idx}.recipient_object").failure('must be provided if recipient_id and recipient_foreign_id are null')
+            end
+          end
+        end
+      end
+
+      # Add validation to ensure e-commerce has the proper notifications
+      rule('items[].notification') do
+        if key? && value.is_a?(Array)
+          value.each_with_index do |item, idx|
+            if item[:notification] == 5 && (!item[:addons] || !item[:addons][:email])
+              key(:"items.#{idx}.addons.email").failure('email is required for electronic notification (5)')
+            end
+          end
+        end
+      end
+
+      # Add class method to make it callable directly
+      def self.call(params)
+        new.call(params)
+      end
+    end
+  end
+end

data/lib/belpost/validations/batch_schema.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "dry-validation"
+
+module Belpost
+  module Validation
+    # Schema for validating batch mailing data
+    class BatchSchema < Dry::Validation::Contract
+      params do
+        required(:postal_delivery_type).filled(:str?).value(
+          included_in?: Belpost::PostalDeliveryTypes.all.map(&:to_s)
+        )
+
+        required(:direction).filled(:str?).value(
+          included_in?: %w[internal CIS international]
+        )
+
+        required(:payment_type).filled(:str?).value(
+          included_in?: %w[
+            not_specified
+            cash
+            payment_order
+            electronic_personal_account
+            4
+            5
+            commitment_letter
+          ]
+        )
+
+        required(:negotiated_rate).filled(:bool?)
+
+        optional(:name).maybe(:str?)
+        optional(:card_number).maybe(:str?)
+        optional(:postal_items_in_ops).maybe(:bool?)
+        optional(:category).maybe(:int?)
+        optional(:is_document).maybe(:bool?)
+        optional(:is_declared_value).maybe(:bool?)
+        optional(:is_partial_receipt).maybe(:bool?)
+      end
+
+      rule(:postal_delivery_type) do
+        if key? && value
+          errors = Belpost::PostalDeliveryTypes.validate_params(
+            value,
+            values
+          )
+          errors.each { |error| key.failure(error) }
+        end
+      end
+    end
+  end
+end 

data/lib/belpost/validations/parcel_schema.rb

@@ -1,154 +1,172 @@
 # frozen_string_literal: true
 
-require "dry/schema"
+require "dry-validation"
 
 module Belpost
   # rubocop:disable Metrics/ModuleLength
   module Validation
     # Validation schema for parcel_data
     # rubocop:disable Metrics/BlockLength
-    ParcelSchema = Dry::Schema.JSON do
-      required(:parcel).hash do
-        required(:type).filled(:string, included_in?: %w[package small_package small_valued_package ems])
-        required(:attachment_type).filled(:string, included_in?: %w[products documents])
-        required(:measures).hash do
-          required(:weight).filled(:integer, gt?: 0)
-          optional(:long).value(:integer, gt?: 0)
-          optional(:width).value(:integer, gt?: 0)
-          optional(:height).value(:integer, gt?: 0)
-        end
-        required(:departure).hash do
-          required(:country).filled(:string, eql?: "BY")
-          required(:place).filled(:string, included_in?: %w[post_office])
-          optional(:place_uuid).maybe(:string)
-        end
-        required(:arrival).hash do
-          required(:country).filled(:string)
-          required(:place).filled(:string, included_in?: %w[post_office])
-          optional(:place_uuid).maybe(:string)
+    class ParcelSchema < Dry::Validation::Contract
+      params do
+        required(:parcel).hash do
+          required(:type).filled(:string, included_in?: %w[package small_package small_valued_package ems])
+          required(:attachment_type).filled(:string, included_in?: %w[products documents])
+          required(:measures).hash do
+            required(:weight).filled(:integer, gt?: 0)
+            optional(:long).value(:integer, gt?: 0)
+            optional(:width).value(:integer, gt?: 0)
+            optional(:height).value(:integer, gt?: 0)
+          end
+          required(:departure).hash do
+            required(:country).filled(:string, eql?: "BY")
+            required(:place).filled(:string, included_in?: %w[post_office])
+            optional(:place_uuid).maybe(:string)
+          end
+          required(:arrival).hash do
+            required(:country).filled(:string)
+            required(:place).filled(:string, included_in?: %w[post_office])
+            optional(:place_uuid).maybe(:string)
+          end
+          optional(:s10code).maybe(:string)
         end
-        optional(:s10code).maybe(:string)
-      end
 
-      optional(:addons).hash do
-        optional(:cash_on_delivery).maybe(:hash) do
-          required(:currency).filled(:string, eql?: "BYN")
-          required(:value).filled(:float, gt?: 0)
-        end
-        optional(:declared_value).maybe(:hash) do
-          required(:currency).filled(:string, eql?: "BYN")
-          required(:value).filled(:float, gt?: 0)
-        end
-        optional(:IOSS).maybe(:string)
-        optional(:registered_notification).maybe(:string)
-        optional(:simple_notification).maybe(:bool)
-        optional(:sms_notification).maybe(:bool)
-        optional(:email_notification).maybe(:bool)
-        optional(:priority_parcel).maybe(:bool)
-        optional(:attachment_inventory).maybe(:bool)
-        optional(:paid_shipping).maybe(:bool)
-        optional(:careful_fragile).maybe(:bool)
-        optional(:bulky).maybe(:bool)
-        optional(:ponderous).maybe(:bool)
-        optional(:payment_upon_receipt).maybe(:bool)
-        optional(:hand_over_personally).maybe(:bool)
-        optional(:return_of_documents).maybe(:bool)
-        optional(:open_upon_delivery).maybe(:bool)
-        optional(:delivery_to_work).maybe(:bool)
-        optional(:time_of_delivery).maybe(:hash) do
-          required(:type).filled(:string, included_in?: %w[level1 level2 level3 level4])
-          optional(:time_interval).hash do
-            required(:from).filled(:string)
-            required(:to).filled(:string)
+        optional(:addons).hash do
+          optional(:cash_on_delivery).maybe(:hash) do
+            required(:currency).filled(:string, eql?: "BYN")
+            required(:value).filled(:float, gt?: 0)
+          end
+          optional(:declared_value).maybe(:hash) do
+            required(:currency).filled(:string, eql?: "BYN")
+            required(:value).filled(:float, gt?: 0)
+          end
+          optional(:IOSS).maybe(:string)
+          optional(:registered_notification).maybe(:string)
+          optional(:simple_notification).maybe(:bool)
+          optional(:sms_notification).maybe(:bool)
+          optional(:email_notification).maybe(:bool)
+          optional(:priority_parcel).maybe(:bool)
+          optional(:attachment_inventory).maybe(:bool)
+          optional(:paid_shipping).maybe(:bool)
+          optional(:careful_fragile).maybe(:bool)
+          optional(:bulky).maybe(:bool)
+          optional(:ponderous).maybe(:bool)
+          optional(:payment_upon_receipt).maybe(:bool)
+          optional(:hand_over_personally).maybe(:bool)
+          optional(:return_of_documents).maybe(:bool)
+          optional(:open_upon_delivery).maybe(:bool)
+          optional(:delivery_to_work).maybe(:bool)
+          optional(:time_of_delivery).maybe(:hash) do
+            required(:type).filled(:string, included_in?: %w[level1 level2 level3 level4])
+            optional(:time_interval).hash do
+              required(:from).filled(:string)
+              required(:to).filled(:string)
+            end
           end
         end
-      end
 
-      required(:sender).hash do
-        required(:type).filled(:string, included_in?: %w[legal_person sole_proprietor])
-        required(:info).hash do
-          required(:organization_name).filled(:string)
-          optional(:taxpayer_number).maybe(:string)
-          optional(:bank).maybe(:string)
-          optional(:IBAN).maybe(:string)
-          optional(:BIC).maybe(:string)
-        end
-        required(:location).hash do
-          required(:code).filled(:string)
-          required(:region).filled(:string)
-          required(:district).filled(:string)
-          required(:locality).hash do
-            required(:type).filled(:string)
-            required(:name).filled(:string)
+        optional(:sender).hash do
+          required(:type).filled(:string, included_in?: %w[legal_person natural_person])
+          required(:info).hash do
+            optional(:organization_name).maybe(:string)
+            optional(:taxpayer_number).maybe(:string)
+            optional(:IBAN).maybe(:string)
+            optional(:BIC).maybe(:string)
+            optional(:bank).maybe(:string)
+            optional(:first_name).maybe(:string)
+            optional(:second_name).maybe(:string)
+            optional(:last_name).maybe(:string)
           end
-          required(:road).hash do
-            required(:type).filled(:string)
-            required(:name).filled(:string)
+          required(:location).hash do
+            required(:code).filled(:string)
+            required(:region).filled(:string)
+            required(:district).filled(:string)
+            required(:locality).hash do
+              required(:type).filled(:string)
+              required(:name).filled(:string)
+            end
+            required(:road).hash do
+              required(:type).filled(:string)
+              required(:name).filled(:string)
+            end
+            required(:building).filled(:string)
+            optional(:housing).maybe(:string)
+            optional(:apartment).maybe(:string)
           end
-          required(:building).filled(:string)
-          optional(:housing).maybe(:string)
-          optional(:apartment).maybe(:string)
+          optional(:email).maybe(:string)
+          optional(:phone).maybe(:string)
         end
-        required(:email).filled(:string)
-        required(:phone).filled(:string)
-      end
 
-      required(:recipient).hash do
-        required(:type).filled(:string, included_in?: %w[natural_person legal_person sole_proprietor])
-        required(:info).hash do
-          optional(:organization_name).maybe(:string)
-          optional(:first_name).maybe(:string)
-          optional(:second_name).maybe(:string)
-          optional(:last_name).maybe(:string)
-        end
-        required(:location).hash do
-          optional(:code).maybe(:string)
-          optional(:region).maybe(:string)
-          optional(:district).maybe(:string)
-          optional(:locality).maybe(:hash) do
-            optional(:type).maybe(:string)
-            optional(:name).maybe(:string)
+        optional(:recipient).hash do
+          required(:type).filled(:string, included_in?: %w[legal_person natural_person])
+          required(:info).hash do
+            optional(:organization_name).maybe(:string)
+            optional(:taxpayer_number).maybe(:string)
+            optional(:IBAN).maybe(:string)
+            optional(:BIC).maybe(:string)
+            optional(:bank).maybe(:string)
+            optional(:first_name).maybe(:string)
+            optional(:second_name).maybe(:string)
+            optional(:last_name).maybe(:string)
           end
-          optional(:road).maybe(:hash) do
-            optional(:type).maybe(:string)
-            optional(:name).maybe(:string)
+          required(:location).hash do
+            required(:code).filled(:string)
+            required(:region).filled(:string)
+            required(:district).filled(:string)
+            required(:locality).hash do
+              required(:type).filled(:string)
+              required(:name).filled(:string)
+            end
+            required(:road).hash do
+              required(:type).filled(:string)
+              required(:name).filled(:string)
+            end
+            required(:building).filled(:string)
+            optional(:housing).maybe(:string)
+            optional(:apartment).maybe(:string)
           end
-          optional(:building).maybe(:string)
-          optional(:housing).maybe(:string)
-          optional(:apartment).maybe(:string)
-          optional(:address).maybe(:string)
+          optional(:email).maybe(:string)
+          optional(:phone).maybe(:string)
         end
-        optional(:email).maybe(:string)
-        required(:phone).filled(:string)
-      end
 
-      optional(:cp72).hash do
-        optional(:items).array(:hash) do
-          required(:name).filled(:string)
-          required(:local).filled(:string)
-          required(:unit).hash do
+        optional(:cp72).hash do
+          optional(:items).array(:hash) do
+            required(:name).filled(:string)
             required(:local).filled(:string)
-            required(:en).filled(:string)
+            required(:unit).hash do
+              required(:local).filled(:string)
+              required(:en).filled(:string)
+            end
+            required(:count).filled(:integer, gt?: 0)
+            required(:weight).filled(:integer, gt?: 0)
+            required(:price).hash do
+              required(:currency).filled(:string)
+              required(:value).filled(:float, gt?: 0)
+            end
+            optional(:code).maybe(:string)
+            optional(:country).maybe(:string)
           end
-          required(:count).filled(:integer, gt?: 0)
-          required(:weight).filled(:integer, gt?: 0)
-          required(:price).hash do
+          optional(:price).hash do
             required(:currency).filled(:string)
             required(:value).filled(:float, gt?: 0)
           end
-          optional(:code).maybe(:string)
-          optional(:country).maybe(:string)
-        end
-        optional(:price).hash do
-          required(:currency).filled(:string)
-          required(:value).filled(:float, gt?: 0)
+          optional(:category).filled(:string, included_in?: %w[gift documents sample returned_goods merchandise other])
+          optional(:explanation).maybe(:string)
+          optional(:comments).maybe(:string)
+          optional(:invoice).maybe(:string)
+          optional(:licences).array(:string)
+          optional(:certificates).array(:string)
         end
-        optional(:category).filled(:string, included_in?: %w[gift documents sample returned_goods merchandise other])
-        optional(:explanation).maybe(:string)
-        optional(:comments).maybe(:string)
-        optional(:invoice).maybe(:string)
-        optional(:licences).array(:string)
-        optional(:certificates).array(:string)
+      end
+
+      # Add class method to make it compatible with the tests
+      def self.call(params)
+        new.call(params)
+      end
+
+      # Add validation rule for organization_name when sender type is legal_person
+      rule('sender.info.organization_name') do
+        key.failure('must be filled') if values[:sender] && values[:sender][:type] == 'legal_person' && !values.dig(:sender, :info, :organization_name)
       end
     end
     # rubocop:enable Metrics/BlockLength

data/lib/belpost/validations/postcode_schema.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "dry-validation"
+
+module Belpost
+  module Validation
+    # Schema for validating postcode parameters
+    class PostcodeSchema < Dry::Validation::Contract
+      params do
+        required(:postcode).filled(:string)
+      end
+
+      rule(:postcode) do
+        key.failure("must be 6 digits") unless value.match?(/^\d{6}$/)
+      end
+    end
+  end
+end 

data/lib/belpost/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Belpost
-  VERSION = "0.7.0"
+  VERSION = "0.11.0"
 end

data/lib/belpost.rb

@@ -1,17 +1,28 @@
 # frozen_string_literal: true
 
-require "dotenv/load"
-
 require_relative "belpost/version"
 require_relative "belpost/configuration"
-require_relative "belpost/client"
 require_relative "belpost/errors"
 require_relative "belpost/retry"
-require_relative "belpost/models/parcel"
+require_relative "belpost/api_paths"
+require_relative "belpost/api_service"
+
+# Load models
 require_relative "belpost/models/api_response"
+require_relative "belpost/models/batch"
 require_relative "belpost/models/customs_declaration"
+require_relative "belpost/models/parcel"
 require_relative "belpost/models/parcel_builder"
+
+# Load types and validations
+require_relative "belpost/postal_delivery_types"
+require_relative "belpost/validations/batch_schema"
 require_relative "belpost/validations/parcel_schema"
+require_relative "belpost/validations/address_schema"
+require_relative "belpost/validations/postcode_schema"
+
+# Load client last as it depends on other files
+require_relative "belpost/client"
 
 # Module for working with Belpochta API.
 # Provides an interface for configuring and interacting with the API.

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: belpost
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.11.0
 platform: ruby
 authors:
 - KuberLite
 bindir: exe
 cert_chain: []
-date: 2025-04-01 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -23,6 +23,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: dry-validation
   requirement: !ruby/object:Gem::Requirement
@@ -55,17 +69,24 @@ files:
 - Rakefile
 - belpost.gemspec
 - lib/belpost.rb
+- lib/belpost/api_paths.rb
 - lib/belpost/api_service.rb
 - lib/belpost/client.rb
 - lib/belpost/configuration.rb
 - lib/belpost/errors.rb
 - lib/belpost/models/api_response.rb
+- lib/belpost/models/batch.rb
+- lib/belpost/models/batch_item.rb
 - lib/belpost/models/customs_declaration.rb
 - lib/belpost/models/parcel.rb
 - lib/belpost/models/parcel_builder.rb
+- lib/belpost/postal_delivery_types.rb
 - lib/belpost/retry.rb
 - lib/belpost/validations/address_schema.rb
+- lib/belpost/validations/batch_item_schema.rb
+- lib/belpost/validations/batch_schema.rb
 - lib/belpost/validations/parcel_schema.rb
+- lib/belpost/validations/postcode_schema.rb
 - lib/belpost/version.rb
 homepage: https://github.com/KuberLite/belpost
 licenses:
@@ -90,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Belpost API wrapper
 test_files: []