speedy-bg 0.1.0

data/lib/speedy/collection.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Speedy
+  class Collection
+    include Enumerable
+
+    def initialize(source, model:, key:)
+      @model = model
+      @key = key
+      @error = Speedy::Models::Error.build_from(source)
+      @items = build_items(source)
+    end
+
+    attr_reader :error
+
+    def error?
+      !error.nil?
+    end
+
+    def each(&)
+      @items.each(&)
+    end
+
+    def to_a
+      @items
+    end
+
+    def size
+      @items.size
+    end
+
+    def empty?
+      @items.empty?
+    end
+
+    alias length size
+    alias count size
+
+    private
+
+    def build_items(source)
+      extract_raw_items(source).map do |item|
+        item.is_a?(@model) ? item : @model.new(item)
+      end
+    end
+
+    def extract_raw_items(source)
+      case source
+      when Hash
+        source[@key] || source[@key.to_s] || []
+      when Array
+        source
+      else
+        []
+      end
+    end
+  end
+end

data/lib/speedy/error.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Speedy
+  class Error < StandardError
+    attr_reader :error, :status
+
+    def initialize(message = nil, error: nil, status: nil)
+      @error = error
+      @status = status
+
+      super(message || error_message || status_message || self.class.name)
+    end
+
+    private
+
+    def error_message
+      return unless error.respond_to?(:full_message)
+
+      message = error.full_message
+      message unless message.to_s.strip.empty?
+    end
+
+    def status_message
+      return if status.nil?
+
+      "Speedy API request failed with status #{status}."
+    end
+  end
+end

data/lib/speedy/model.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Speedy
+  class Model
+    include Speedy::ResourceAttributes
+    include Speedy::Util
+
+    class << self
+      def collection_key(value = nil)
+        return @collection_key || Speedy::Util.pluralize(name).to_sym unless value
+
+        @collection_key = value
+      end
+
+      def collection(source)
+        Speedy::Collection.new(source, model: self, key: collection_key)
+      end
+
+      def build(source, key: nil)
+        data = extract_source(source, key)
+        new(data.is_a?(Hash) ? data : {})
+      end
+
+      private
+
+      def extract_source(source, key)
+        return source unless source.is_a?(Hash)
+        return source unless key && (source.key?(key) || source.key?(key.to_s))
+
+        source[key] || source[key.to_s]
+      end
+    end
+
+    def initialize(attributes = {})
+      @attributes = {}
+      @error = Speedy::Models::Error.build_from(attributes) unless is_a?(Speedy::Models::Error)
+      apply_attributes(attributes)
+    end
+
+    attr_reader :error
+
+    def error?
+      !error.nil?
+    end
+
+    def method_missing(method_name, *args, &)
+      if @attributes.key?(method_name)
+        @attributes[method_name]
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      @attributes.key?(method_name) || super
+    end
+
+    def to_h
+      deep_to_h(@attributes)
+    end
+
+    def to_json(*)
+      camelize_keys(to_h).to_json(*)
+    end
+
+    def apply_attributes(new_attributes)
+      underscore_keys(new_attributes).each do |key, value|
+        setter = "#{key}="
+        if respond_to?(setter)
+          send(setter, value)
+        else
+          @attributes[key.to_sym] = value
+        end
+      end
+    end
+
+    private
+
+    def deep_to_h(value)
+      case value
+      when Speedy::Model
+        value.to_h
+      when Hash
+        value.transform_values { |item| deep_to_h(item) }
+      when Array
+        value.map { |item| deep_to_h(item) }
+      else
+        value
+      end
+    end
+  end
+end

data/lib/speedy/models/calculation/address_location.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Speedy
+  module Models
+    module Calculation
+      class AddressLocation < Speedy::Model
+        field :country_id, type: :integer
+        field :state_id, type: :string
+        field :site_id, type: :integer
+        field :site_type, type: :string
+        field :site_name, type: :string
+        field :post_code, type: :string
+      end
+    end
+  end
+end

data/lib/speedy/models/calculation/calculation_content.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Speedy
+  module Models
+    module Calculation
+      class CalculationContent < Speedy::Model
+        field :parcels_count, type: :integer
+        field :total_weight, type: :float
+        field :documents, type: :boolean
+        field :palletized, type: :boolean
+        field :parcels, type: :array, of: Speedy::Models::Shipments::ShipmentParcel
+      end
+    end
+  end
+end

data/lib/speedy/models/calculation/calculation_recipient.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Speedy
+  module Models
+    module Calculation
+      class CalculationRecipient < Speedy::Model
+        field :client_id, type: :integer
+        field :private_person, type: :boolean
+        field :address_location, type: Speedy::Models::Calculation::AddressLocation
+        field :pickup_office_id, type: :integer
+        field :pickup_geo_pudo_id, type: :string
+      end
+    end
+  end
+end

data/lib/speedy/models/calculation/calculation_result.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Speedy
+  module Models
+    module Calculation
+      class CalculationResult < Speedy::Model
+        collection_key :calculations
+
+        field :service_id, type: :integer
+        field :price, type: Speedy::Models::Shipments::ShipmentPrice
+        field :pickup_date, type: :string
+        field :delivery_deadline, type: :string
+        field :delivery_deadline_work_day_type, type: :string
+        field :additional_services, type: Speedy::Models::Shipments::ShipmentAdditionalServices
+        field :error, type: Speedy::Models::Error
+      end
+    end
+  end
+end

data/lib/speedy/models/calculation/calculation_sender.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Speedy
+  module Models
+    module Calculation
+      class CalculationSender < Speedy::Model
+        field :client_id, type: :integer
+        field :private_person, type: :boolean
+        field :address_location, type: Speedy::Models::Calculation::AddressLocation
+        field :dropoff, type: :boolean
+        field :dropoff_office_id, type: :integer
+        field :dropoff_geo_pudo_id, type: :string
+      end
+    end
+  end
+end

data/lib/speedy/models/calculation/calculation_service.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Speedy
+  module Models
+    module Calculation
+      class CalculationService < Speedy::Model
+        field :pickup_date, type: :string
+        field :auto_adjust_pickup_date, type: :boolean
+        field :service_ids, type: :array
+        field :additional_services
+        field :deferred_days, type: :integer
+        field :saturday_delivery, type: :boolean
+      end
+    end
+  end
+end

data/lib/speedy/models/clients/client.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Speedy
+  module Models
+    module Clients
+      class Client < Speedy::Model
+        collection_key :clients
+
+        field :client_id, type: :integer
+        field :client_name, type: :string
+        field :object_name, type: :string
+        field :contact_name, type: :string
+        field :address, type: Speedy::Models::Common::Address
+        field :email, type: :string
+        field :private_person, type: :boolean
+        field :phones, type: :array, of: Speedy::Models::Shipments::ShipmentPhoneNumber
+        field :external_contact_id, type: :string
+      end
+    end
+  end
+end

data/lib/speedy/models/clients/cod_contract_info.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Speedy
+  module Models
+    module Clients
+      class CODContractInfo < Speedy::Model
+        field :money_transfer_allowed, type: :boolean
+        field :cod_fiscal_receipt_allowed, type: :boolean
+        field :has_cod_annex, type: :boolean
+        field :international_cod_annexes,
+              type: :array,
+              of: Speedy::Models::Clients::CODInternationalAnnex
+      end
+    end
+  end
+end

data/lib/speedy/models/clients/cod_international_annex.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Speedy
+  module Models
+    module Clients
+      class CODInternationalAnnex < Speedy::Model
+        field :country_id, type: :integer
+        field :country_name, type: :string
+      end
+    end
+  end
+end

data/lib/speedy/models/clients/contract_info.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Speedy
+  module Models
+    module Clients
+      class ContractInfo < Speedy::Model
+        field :error, type: Speedy::Models::Error
+        field :id, type: :integer
+        field :special_delivery_requirements,
+              type: Speedy::Models::Clients::SpecialDeliveryRequirements
+        field :cod, type: Speedy::Models::Clients::CODContractInfo
+        field :administrative_fee_allowed, type: :boolean
+      end
+    end
+  end
+end

data/lib/speedy/models/clients/requirement.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Speedy
+  module Models
+    module Clients
+      class Requirement < Speedy::Model
+        field :id, type: :integer
+        field :text, type: :string
+      end
+    end
+  end
+end

data/lib/speedy/models/clients/special_delivery_requirements.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Speedy
+  module Models
+    module Clients
+      class SpecialDeliveryRequirements < Speedy::Model
+        field :required_for_all_shipments, type: :boolean
+        field :requirements, type: :array, of: Speedy::Models::Clients::Requirement
+      end
+    end
+  end
+end

data/lib/speedy/models/common/address.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Speedy
+  module Models
+    module Common
+      class Address < Speedy::Model
+        field :country_id, type: :integer
+        field :state_id, type: :string
+        field :site_id, type: :integer
+        field :site_type, type: :string
+        field :site_name, type: :string
+        field :post_code, type: :string
+        field :street_id, type: :integer
+        field :street_type, type: :string
+        field :street_name, type: :string
+        field :street_no, type: :string
+        field :complex_id, type: :integer
+        field :complex_type, type: :string
+        field :complex_name, type: :string
+        field :block_no, type: :string
+        field :entrance_no, type: :string
+        field :floor_no, type: :string
+        field :apartment_no, type: :string
+        field :poi_id, type: :integer
+        field :address_note, type: :string
+        field :address_line1, type: :string
+        field :address_line2, type: :string
+        field :x, type: :float
+        field :y, type: :float
+        field :full_address_string, type: :string
+        field :site_address_string, type: :string
+        field :local_address_string, type: :string
+      end
+    end
+  end
+end

data/lib/speedy/models/error.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Speedy
+  module Models
+    class Error < Speedy::Model
+      field :context, type: :string
+      field :message, type: :string
+      field :id, type: :string
+      field :code, type: :integer
+      field :component, type: :string
+
+      class << self
+        def build_from(source)
+          error_source = error_source_from(source)
+          return unless error_source
+
+          new(error_source)
+        end
+
+        private
+
+        def error_source_from(source)
+          return unless source.is_a?(Hash)
+
+          root_error = source[:error] || source['error']
+          return root_error if root_error.is_a?(Hash)
+
+          source if source.key?(:message) || source.key?('message')
+        end
+      end
+
+      def full_message
+        [message, context].reject { |value| value.to_s.strip.empty? }.join(' ')
+      end
+    end
+  end
+end

data/lib/speedy/models/location/address_nomenclature_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Speedy
+  module Models
+    module Location
+      class AddressNomenclatureType < Speedy::Model
+        field :name, type: :string
+        field :name_en, type: :string
+      end
+    end
+  end
+end

data/lib/speedy/models/location/block.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Speedy
+  module Models
+    module Location
+      class Block < Speedy::Model
+        collection_key :blocks
+
+        field :site_id, type: :integer
+        field :name, type: :string
+        field :name_en, type: :string
+      end
+    end
+  end
+end

data/lib/speedy/models/location/complex.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Speedy
+  module Models
+    module Location
+      class Complex < Speedy::Model
+        collection_key :complexes
+
+        field :id, type: :integer
+        field :site_id, type: :integer
+        field :actual_id, type: :integer
+        field :type, type: :string
+        field :type_en, type: :string
+        field :name, type: :string
+        field :name_en, type: :string
+        field :actual_type, type: :string
+        field :actual_type_en, type: :string
+        field :actual_name, type: :string
+        field :actual_name_en, type: :string
+      end
+    end
+  end
+end

data/lib/speedy/models/location/country.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Speedy
+  module Models
+    module Location
+      class Country < Speedy::Model
+        collection_key :countries
+
+        field :id, type: :integer
+        field :name, type: :string
+        field :name_en, type: :string
+        field :iso_alpha2, type: :string
+        field :iso_alpha3, type: :string
+        field :currency_code, type: :string
+        field :require_state, type: :boolean
+        field :address_type, type: :integer
+        field :default_office_id, type: :integer
+        field :site_nomen, type: :integer
+        field :street_types, type: :array, of: Speedy::Models::Location::AddressNomenclatureType
+        field :complex_types, type: :array, of: Speedy::Models::Location::AddressNomenclatureType
+        field :post_code_formats, type: :array
+      end
+    end
+  end
+end

data/lib/speedy/models/location/find_office_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Speedy
+  module Models
+    module Location
+      class FindOfficeResponse < Speedy::Model
+        field :offices, type: :array, of: Speedy::Models::Location::Office
+        field :error, type: Speedy::Models::Error
+      end
+    end
+  end
+end

data/lib/speedy/models/location/find_site_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Speedy
+  module Models
+    module Location
+      class FindSiteResponse < Speedy::Model
+        field :sites, type: :array, of: Speedy::Models::Location::Site
+        field :error, type: Speedy::Models::Error
+      end
+    end
+  end
+end

data/lib/speedy/models/location/get_office_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Speedy
+  module Models
+    module Location
+      class GetOfficeResponse < Speedy::Model
+        field :office, type: Speedy::Models::Location::Office
+        field :error, type: Speedy::Models::Error
+      end
+    end
+  end
+end

data/lib/speedy/models/location/get_site_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Speedy
+  module Models
+    module Location
+      class GetSiteResponse < Speedy::Model
+        field :site, type: Speedy::Models::Location::Site
+        field :error, type: Speedy::Models::Error
+      end
+    end
+  end
+end

data/lib/speedy/models/location/office.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Speedy
+  module Models
+    module Location
+      class Office < Speedy::Model
+        collection_key :offices
+
+        field :id, type: :integer
+        field :name, type: :string
+        field :name_en, type: :string
+        field :site_id, type: :integer
+        field :address, type: Speedy::Models::Common::Address
+        field :working_time_from, type: :string
+        field :working_time_to, type: :string
+        field :working_time_half_from, type: :string
+        field :working_time_half_to, type: :string
+        field :working_time_day_off_from, type: :string
+        field :working_time_day_off_to, type: :string
+        field :same_day_departure_cutoff, type: :string
+        field :same_day_departure_cutoff_half, type: :string
+        field :same_day_departure_cutoff_day_off, type: :string
+        field :max_parcel_dimensions, type: Speedy::Models::Shipments::ShipmentParcelSize
+        field :max_parcel_weight, type: :float
+        field :type, type: :string
+        field :vendor, type: :integer
+        field :nearby_office_id, type: :integer
+        field :working_time_schedule, type: :array, of: Speedy::Models::Location::OfficeWorkingTimeSchedule
+        field :valid_from, type: :string
+        field :valid_to, type: :string
+        field :cargo_types_allowed, type: :array
+        field :pick_up_allowed, type: :boolean
+        field :drop_off_allowed, type: :boolean
+        field :routing_information, type: Speedy::Models::Location::RoutingInformation
+        field :pallet_office, type: :boolean
+        field :cash_payment_allowed, type: :boolean
+        field :card_payment_allowed, type: :boolean
+      end
+    end
+  end
+end

data/lib/speedy/models/location/office_result.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Speedy
+  module Models
+    module Location
+      class OfficeResult < Office
+        collection_key :offices
+
+        field :distance, type: :integer
+      end
+    end
+  end
+end

data/lib/speedy/models/location/office_working_time_schedule.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Speedy
+  module Models
+    module Location
+      class OfficeWorkingTimeSchedule < Speedy::Model
+        field :date, type: :string
+        field :working_time_from, type: :string
+        field :working_time_to, type: :string
+        field :same_day_departure_cutoff, type: :string
+        field :standard_schedule, type: :boolean
+      end
+    end
+  end
+end