cdek_api_client 0.2.0 → 0.3.0

data/lib/cdek_api_client/entities/barcode.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require_relative 'validatable'
+
+module CDEKApiClient
+  module Entities
+    # Represents a barcode entity for printing barcodes in the CDEK API.
+    class Barcode
+      include Validatable
+
+      attr_accessor :orders, :copy_count, :type, :format, :lang
+
+      validates :orders, type: :array, presence: true, items: [{ type: :hash, presence: true }]
+      validates :copy_count, type: :integer, presence: false
+      validates :type, type: :string, presence: false
+      validates :format, type: :string, presence: false, inclusion: %w[A4 A5 A6]
+      validates :lang, type: :string, presence: false
+
+      # Initializes a new Barcode object.
+      #
+      # @param orders [Array<Hash>] the list of orders for barcode generation.
+      # @param copy_count [Integer] the number of copies (default: 1).
+      # @param type [String] the type of barcode.
+      # @param format [String] the print format (A4, A5, A6).
+      # @param lang [String] the language code.
+      # @raise [ArgumentError] if any attribute validation fails.
+      def initialize(orders:, copy_count: 1, type: nil, format: 'A4', lang: nil)
+        @orders = orders
+        @copy_count = copy_count
+        @type = type
+        @format = format
+        @lang = lang
+        validate!
+      end
+
+      # Creates a Barcode with orders UUIDs.
+      #
+      # @param orders_uuid [String, Array<String>] the order UUID(s).
+      # @return [Barcode] the barcode instance.
+      def self.with_orders_uuid(orders_uuid)
+        orders = Array(orders_uuid).map do |uuid|
+          { order_uuid: uuid }
+        end
+        new(orders: orders)
+      end
+
+      # Creates a Barcode with CDEK numbers.
+      #
+      # @param cdek_numbers [String, Array<String>] the CDEK number(s).
+      # @return [Barcode] the barcode instance.
+      def self.with_cdek_numbers(cdek_numbers)
+        orders = Array(cdek_numbers).map do |number|
+          { cdek_number: number }
+        end
+        new(orders: orders)
+      end
+
+      # Converts the Barcode object to a JSON representation.
+      #
+      # @return [String] the JSON representation of the Barcode.
+      def to_json(*_args)
+        data = { orders: @orders }
+        data[:copy_count] = @copy_count if @copy_count
+        data[:type] = @type if @type
+        data[:format] = @format if @format
+        data[:lang] = @lang if @lang
+        data.to_json
+      end
+    end
+  end
+end

data/lib/cdek_api_client/entities/check.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative 'validatable'
+
+module CDEKApiClient
+  module Entities
+    # Represents a check entity for retrieving check information in the CDEK API.
+    class Check
+      include Validatable
+
+      attr_accessor :cdek_number, :date
+
+      validates :cdek_number, type: :string, presence: false
+      validates :date, type: :string, presence: false
+
+      # Override validate! to allow both fields to be nil
+      def validate!
+        # Only validate non-nil fields
+        validate_presence(:cdek_number, @cdek_number, { presence: false }) unless @cdek_number.nil?
+        validate_type(:cdek_number, @cdek_number, { type: :string }) unless @cdek_number.nil?
+
+        validate_presence(:date, @date, { presence: false }) unless @date.nil?
+        validate_type(:date, @date, { type: :string }) unless @date.nil?
+      end
+
+      # Initializes a new Check object.
+      #
+      # @param cdek_number [String] the CDEK order number.
+      # @param date [String] the date in YYYY-MM-DD format.
+      # @raise [ArgumentError] if any attribute validation fails.
+      def initialize(cdek_number: nil, date: nil)
+        @cdek_number = cdek_number
+        @date = date
+        validate!
+      end
+
+      # Converts the Check object to a hash for query parameters.
+      #
+      # @return [Hash] the query parameters.
+      def to_query_params
+        params = {}
+        params[:cdek_number] = @cdek_number if @cdek_number
+        params[:date] = @date if @date
+        params
+      end
+
+      # Converts the Check object to a JSON representation.
+      #
+      # @return [String] the JSON representation of the Check.
+      def to_json(*_args)
+        to_query_params.to_json
+      end
+    end
+  end
+end

data/lib/cdek_api_client/entities/currency_mapper.rb

@@ -29,11 +29,14 @@ module CDEKApiClient
 
       # Converts a currency code to its corresponding integer representation.
       #
-      # @param currency [String] the currency code to convert.
+      # @param currency [String, Integer] the currency code (string like 'RUB') or integer code to validate.
       # @return [Integer] the integer representation of the currency code.
       # @raise [ArgumentError] if the currency code is invalid.
       def self.to_code(currency)
-        CURRENCY_CODES[currency] || (raise ArgumentError, "Invalid currency code: #{currency}")
+        return currency if currency.is_a?(Integer) && CURRENCY_CODES.value?(currency)
+        return CURRENCY_CODES[currency] if currency.is_a?(String) && CURRENCY_CODES.key?(currency)
+
+        raise ArgumentError, "Invalid currency code: #{currency}"
       end
     end
   end

data/lib/cdek_api_client/entities/intake_available_days_request.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'validatable'
+
+module CDEKApiClient
+  module Entities
+    # Represents a request for available courier intake days from the CDEK API.
+    class IntakeAvailableDaysRequest
+      include Validatable
+
+      attr_accessor :from_location, :date
+
+      validates :from_location, type: :hash, presence: true
+      validates :date, type: :string
+
+      # Initializes a new IntakeAvailableDaysRequest object.
+      #
+      # @param from_location [Hash] the location details for the intake.
+      # @param date [String, nil] the date up to which to get available days (optional).
+      # @raise [ArgumentError] if any attribute validation fails.
+      def initialize(from_location:, date: nil)
+        @from_location = from_location
+        @date = date
+        validate!
+      end
+
+      # Converts the IntakeAvailableDaysRequest object to a JSON representation.
+      #
+      # @return [String] the JSON representation of the IntakeAvailableDaysRequest.
+      def to_json(*_args)
+        data = { from_location: @from_location }
+        data[:date] = @date if @date
+        data.to_json
+      end
+    end
+  end
+end

data/lib/cdek_api_client/entities/intake_available_days_response.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative 'validatable'
+
+module CDEKApiClient
+  module Entities
+    # Represents a response with available courier intake days from the CDEK API.
+    class IntakeAvailableDaysResponse
+      include Validatable
+
+      attr_accessor :date, :all_days, :errors, :warnings
+
+      validates :date, type: :array
+      validates :all_days, type: :boolean
+      validates :errors, type: :array
+      validates :warnings, type: :array
+
+      # Initializes a new IntakeAvailableDaysResponse object.
+      #
+      # @param date [Array<String>, nil] the available dates for intake.
+      # @param all_days [Boolean, nil] whether all days are available.
+      # @param errors [Array, nil] any errors in the response.
+      # @param warnings [Array, nil] any warnings in the response.
+      # @raise [ArgumentError] if any attribute validation fails.
+      def initialize(date: nil, all_days: nil, errors: nil, warnings: nil)
+        @date = date
+        @all_days = all_days
+        @errors = errors || []
+        @warnings = warnings || []
+        validate!
+      end
+
+      # Converts the IntakeAvailableDaysResponse object to a JSON representation.
+      #
+      # @return [String] the JSON representation of the IntakeAvailableDaysResponse.
+      def to_json(*_args)
+        data = {}
+        data[:date] = @date if @date
+        data[:all_days] = @all_days unless @all_days.nil?
+        data[:errors] = @errors unless @errors.empty?
+        data[:warnings] = @warnings unless @warnings.empty?
+        data.to_json
+      end
+    end
+  end
+end

data/lib/cdek_api_client/entities/intakes.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require_relative 'validatable'
+
+module CDEKApiClient
+  module Entities
+    # Represents an intakes entity for courier intake requests in the CDEK API.
+    class Intakes
+      include Validatable
+
+      attr_accessor :cdek_number, :intake_date, :intake_time_from, :intake_time_to,
+                    :lunch_time_from, :lunch_time_to, :name, :need_call, :comment,
+                    :sender, :from_location, :weight, :length, :width, :height
+
+      validates :cdek_number, type: :string, presence: true
+      validates :intake_date, type: :string, presence: true
+      validates :intake_time_from, type: :string, presence: true
+      validates :intake_time_to, type: :string, presence: true
+      validates :lunch_time_from, type: :string, presence: false
+      validates :lunch_time_to, type: :string, presence: false
+      validates :name, type: :string, presence: true
+      validates :need_call, type: :boolean, presence: false
+      validates :comment, type: :string, presence: false
+      validates :sender, type: :hash, presence: true
+      validates :from_location, type: :hash, presence: true
+      validates :weight, type: :numeric, presence: false
+      validates :length, type: :numeric, presence: false
+      validates :width, type: :numeric, presence: false
+      validates :height, type: :numeric, presence: false
+
+      # Initializes a new Intakes object.
+      #
+      # @param cdek_number [String] the CDEK order number.
+      # @param intake_date [String] the intake date in YYYY-MM-DD format.
+      # @param intake_time_from [String] the start time in HH:MM format.
+      # @param intake_time_to [String] the end time in HH:MM format.
+      # @param lunch_time_from [String] the lunch start time in HH:MM format.
+      # @param lunch_time_to [String] the lunch end time in HH:MM format.
+      # @param name [String] the name/description of the cargo.
+      # @param need_call [Boolean] whether a call is needed.
+      # @param comment [String] the comment for the intake.
+      # @param sender [Contact] the sender contact information.
+      # @param from_location [Location] the pickup location.
+      # @param weight [Numeric] the weight of the cargo.
+      # @param length [Numeric] the length of the cargo.
+      # @param width [Numeric] the width of the cargo.
+      # @param height [Numeric] the height of the cargo.
+      # @raise [ArgumentError] if any attribute validation fails.
+      def initialize(cdek_number:, intake_date:, intake_time_from:, intake_time_to:,
+                     name:, sender:, from_location:, lunch_time_from: nil, lunch_time_to: nil, need_call: nil,
+                     comment: nil, weight: nil, length: nil,
+                     width: nil, height: nil)
+        @cdek_number = cdek_number
+        @intake_date = intake_date
+        @intake_time_from = intake_time_from
+        @intake_time_to = intake_time_to
+        @lunch_time_from = lunch_time_from
+        @lunch_time_to = lunch_time_to
+        @name = name
+        @need_call = need_call
+        @comment = comment
+        @sender = sender
+        @from_location = from_location
+        @weight = weight
+        @length = length
+        @width = width
+        @height = height
+        validate!
+      end
+
+      # Converts the Intakes object to a JSON representation.
+      #
+      # @return [String] the JSON representation of the Intakes.
+      def to_json(*_args)
+        data = {
+          cdek_number: @cdek_number,
+          intake_date: @intake_date,
+          intake_time_from: @intake_time_from,
+          intake_time_to: @intake_time_to,
+          name: @name,
+          sender: @sender,
+          from_location: @from_location
+        }
+        data[:lunch_time_from] = @lunch_time_from if @lunch_time_from
+        data[:lunch_time_to] = @lunch_time_to if @lunch_time_to
+        data[:need_call] = @need_call unless @need_call.nil?
+        data[:comment] = @comment if @comment
+        data[:weight] = @weight if @weight
+        data[:length] = @length if @length
+        data[:width] = @width if @width
+        data[:height] = @height if @height
+        data.to_json
+      end
+    end
+  end
+end

data/lib/cdek_api_client/entities/invoice.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative 'validatable'
+
+module CDEKApiClient
+  module Entities
+    # Represents an invoice entity for printing invoices in the CDEK API.
+    class Invoice
+      include Validatable
+
+      attr_accessor :orders, :copy_count, :type
+
+      validates :orders, type: :array, presence: true, items: [{ type: :hash, presence: true }]
+      validates :copy_count, type: :integer, presence: false
+      validates :type, type: :string, presence: false
+
+      # Initializes a new Invoice object.
+      #
+      # @param orders [Array<Hash>] the list of orders for invoice generation.
+      # @param copy_count [Integer] the number of copies (default: 1).
+      # @param type [String] the type of invoice.
+      # @raise [ArgumentError] if any attribute validation fails.
+      def initialize(orders:, copy_count: 1, type: nil)
+        @orders = orders
+        @copy_count = copy_count
+        @type = type
+        validate!
+      end
+
+      # Creates an Invoice with orders UUIDs.
+      #
+      # @param orders_uuid [String, Array<String>] the order UUID(s).
+      # @return [Invoice] the invoice instance.
+      def self.with_orders_uuid(orders_uuid)
+        orders = Array(orders_uuid).map do |uuid|
+          { order_uuid: uuid }
+        end
+        new(orders: orders)
+      end
+
+      # Creates an Invoice with CDEK numbers.
+      #
+      # @param cdek_numbers [String, Array<String>] the CDEK number(s).
+      # @return [Invoice] the invoice instance.
+      def self.with_cdek_numbers(cdek_numbers)
+        orders = Array(cdek_numbers).map do |number|
+          { cdek_number: number }
+        end
+        new(orders: orders)
+      end
+
+      # Converts the Invoice object to a JSON representation.
+      #
+      # @return [String] the JSON representation of the Invoice.
+      def to_json(*_args)
+        data = { orders: @orders }
+        data[:copy_count] = @copy_count if @copy_count
+        data[:type] = @type if @type
+        data.to_json
+      end
+    end
+  end
+end

data/lib/cdek_api_client/entities/validatable.rb

@@ -38,7 +38,7 @@ module CDEKApiClient
         self.class.validations.each do |attribute, rule|
           value = send(attribute)
           validate_presence(attribute, value, rule)
-          validate_type(attribute, value, rule)
+          validate_type(attribute, value, rule) unless value.nil?
         end
       end
 
@@ -160,6 +160,8 @@ module CDEKApiClient
       # @param rule [Hash] the validation rule.
       # @raise [RuntimeError] if the validation fails.
       def validate_hash(_attribute, hash, rule)
+        return unless rule[:schema]
+
         rule[:schema].each do |attr, validation_rule|
           value = hash[attr]
           validate_presence(attr, value, validation_rule)

data/lib/cdek_api_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CDEKApiClient
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/cdek_api_client.rb

@@ -1,12 +1,20 @@
 # frozen_string_literal: true
 
+require_relative 'cdek_api_client/api/courier'
 require_relative 'cdek_api_client/api/location'
 require_relative 'cdek_api_client/api/order'
+require_relative 'cdek_api_client/api/payment'
+require_relative 'cdek_api_client/api/print'
 require_relative 'cdek_api_client/api/tariff'
 require_relative 'cdek_api_client/api/track_order'
 require_relative 'cdek_api_client/api/webhook'
 require_relative 'cdek_api_client/client'
+require_relative 'cdek_api_client/entities/agreement'
+require_relative 'cdek_api_client/entities/barcode'
+require_relative 'cdek_api_client/entities/check'
 require_relative 'cdek_api_client/entities/currency_mapper'
+require_relative 'cdek_api_client/entities/intakes'
+require_relative 'cdek_api_client/entities/invoice'
 require_relative 'cdek_api_client/entities/item'
 require_relative 'cdek_api_client/entities/location'
 require_relative 'cdek_api_client/entities/order_data'
@@ -18,6 +26,10 @@ require_relative 'cdek_api_client/entities/service'
 require_relative 'cdek_api_client/entities/tariff_data'
 require_relative 'cdek_api_client/entities/validatable'
 require_relative 'cdek_api_client/entities/webhook'
+require_relative 'cdek_api_client/entities/auth_response'
+require_relative 'cdek_api_client/entities/auth_error_response'
+require_relative 'cdek_api_client/entities/intake_available_days_request'
+require_relative 'cdek_api_client/entities/intake_available_days_response'
 require_relative 'cdek_api_client/version'
 
 # frozen_string_literal: true

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: cdek_api_client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Damir Mukimov
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-22 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: This gem provides a Ruby client for interacting with the CDEK API, including
   order creation, tracking, and tariff calculation.
@@ -18,15 +17,29 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - README.md
 - lib/cdek_api_client.rb
+- lib/cdek_api_client/api/courier.rb
 - lib/cdek_api_client/api/location.rb
 - lib/cdek_api_client/api/order.rb
+- lib/cdek_api_client/api/payment.rb
+- lib/cdek_api_client/api/print.rb
 - lib/cdek_api_client/api/tariff.rb
 - lib/cdek_api_client/api/track_order.rb
 - lib/cdek_api_client/api/webhook.rb
 - lib/cdek_api_client/client.rb
+- lib/cdek_api_client/config.rb
+- lib/cdek_api_client/entities/agreement.rb
+- lib/cdek_api_client/entities/auth_error_response.rb
+- lib/cdek_api_client/entities/auth_response.rb
+- lib/cdek_api_client/entities/barcode.rb
+- lib/cdek_api_client/entities/check.rb
 - lib/cdek_api_client/entities/currency_mapper.rb
+- lib/cdek_api_client/entities/intake_available_days_request.rb
+- lib/cdek_api_client/entities/intake_available_days_response.rb
+- lib/cdek_api_client/entities/intakes.rb
+- lib/cdek_api_client/entities/invoice.rb
 - lib/cdek_api_client/entities/item.rb
 - lib/cdek_api_client/entities/location.rb
 - lib/cdek_api_client/entities/order_data.rb
@@ -39,15 +52,16 @@ files:
 - lib/cdek_api_client/entities/validatable.rb
 - lib/cdek_api_client/entities/webhook.rb
 - lib/cdek_api_client/version.rb
-homepage: http://glowing-pixels.com/cdek_api_client
+homepage: https://glowing-pixels.com/cdek_api_client
 licenses:
 - MIT
 metadata:
-  github_repo: git@github.com/SamyRai/cdek_api_client.git
-  homepage_uri: http://glowing-pixels.com/cdek_api_client
-  source_code_uri: http://github.com/SamyRai/cdek_api_client
-  changelog_uri: http://www.glowing-pixels.com/cdek_api_client/CHANGELOG.md
-post_install_message: 
+  homepage_uri: https://glowing-pixels.com/cdek_api_client
+  source_code_uri: https://github.com/SamyRai/cdek_api_client
+  bug_tracker_uri: https://github.com/SamyRai/cdek_api_client/issues
+  changelog_uri: https://github.com/SamyRai/cdek_api_client/blob/main/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/cdek_api_client
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -62,8 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key: 
+rubygems_version: 3.7.2
 specification_version: 4
 summary: A Ruby client for the CDEK API
 test_files: []