dear_inventory 0.7.5 → 1.0.0

data/lib/dear_inventory.rb

@@ -8,6 +8,8 @@ require "dear_inventory/config"
 require "dear_inventory/environment"
 
 require "dear_inventory/error"
+require "dear_inventory/errors/api_limit"
+require "dear_inventory/errors/no_more_pages"
 require "dear_inventory/errors/not_paginated"
 require "dear_inventory/errors/validation"
 
@@ -18,6 +20,7 @@ require "dear_inventory/lib/endpoint_class"
 require "dear_inventory/lib/date_time"
 require "dear_inventory/lib/is_a_subclass"
 require "dear_inventory/lib/request"
+require "dear_inventory/lib/strings/urlize"
 
 require "dear_inventory/model"
 require "dear_inventory/models/additional_attributes"
@@ -29,8 +32,8 @@ require "dear_inventory/models/customers/address"
 require "dear_inventory/models/customers/contact"
 require "dear_inventory/models/inventory_movement"
 require "dear_inventory/models/products/movement"
-require "dear_inventory/models/purchase_list"
-require "dear_inventory/models/purchase_lists"
+require "dear_inventory/models/purchases"
+require "dear_inventory/models/purchases_results"
 require "dear_inventory/models/purchases/additional_charge"
 require "dear_inventory/models/purchases/inventory_movement"
 require "dear_inventory/models/purchases/invoice_additional_charge"
@@ -38,11 +41,11 @@ require "dear_inventory/models/purchases/line"
 require "dear_inventory/models/purchases/invoice_line"
 require "dear_inventory/models/purchases/manual_journal_line"
 require "dear_inventory/models/purchases/manual_journal"
+require "dear_inventory/models/purchases/payment_line"
 require "dear_inventory/models/purchases/stock_line"
 require "dear_inventory/models/purchases/stock"
 require "dear_inventory/models/purchases/unstock_line"
 require "dear_inventory/models/reorder_level"
-require "dear_inventory/models/sale_list"
 require "dear_inventory/models/sales/additional_charge"
 require "dear_inventory/models/sales/invoice_additional_charge"
 require "dear_inventory/models/sales/line"
@@ -60,7 +63,7 @@ require "dear_inventory/models/sales/fulfilments/pick_pack"
 require "dear_inventory/models/sales/fulfilments/ship_line"
 require "dear_inventory/models/sales/fulfilments/ship"
 require "dear_inventory/models/sales/fulfilment"
-require "dear_inventory/models/sale_lists"
+require "dear_inventory/models/sales_results"
 
 require "dear_inventory/models/customer"
 require "dear_inventory/models/customers"
@@ -70,9 +73,18 @@ require "dear_inventory/models/purchases/credit_note"
 require "dear_inventory/models/purchases/invoice"
 require "dear_inventory/models/purchases/order"
 require "dear_inventory/models/purchase"
+require "dear_inventory/models/purchases/advanced/credit_note"
+require "dear_inventory/models/purchases/advanced/invoice"
+require "dear_inventory/models/purchases/advanced/manual_journal"
+require "dear_inventory/models/purchases/advanced/put_away_line"
+require "dear_inventory/models/purchases/advanced/put_away"
+require "dear_inventory/models/purchases/advanced/stock_line"
+require "dear_inventory/models/purchases/advanced/stock"
+require "dear_inventory/models/advanced_purchase"
 require "dear_inventory/models/sales/credit_note"
 require "dear_inventory/models/sales/invoice"
 require "dear_inventory/models/sale"
+require "dear_inventory/models/sales"
 require "dear_inventory/models/request"
 
 require "dear_inventory/validator"
@@ -85,20 +97,20 @@ require "dear_inventory/validators/string"
 require "dear_inventory/validators/time"
 
 require "dear_inventory/parameters"
+require "dear_inventory/parameters/advanced_purchase/show"
 require "dear_inventory/parameters/customer/index"
 require "dear_inventory/parameters/product/index"
 require "dear_inventory/parameters/purchase/index"
-require "dear_inventory/parameters/purchase_list/index"
+require "dear_inventory/parameters/purchase/show"
 require "dear_inventory/parameters/sale/index"
-require "dear_inventory/parameters/sale_list/index"
+require "dear_inventory/parameters/sale/show"
 
 require "dear_inventory/resource"
+require "dear_inventory/resources/advanced_purchase"
 require "dear_inventory/resources/customer"
 require "dear_inventory/resources/product"
 require "dear_inventory/resources/purchase"
-require "dear_inventory/resources/purchase_list"
 require "dear_inventory/resources/sale"
-require "dear_inventory/resources/sale_list"
 
 require "dear_inventory/response"
 

data/lib/dear_inventory/config.rb

@@ -1,10 +1,27 @@
 # typed: ignore
 # frozen_string_literal: true
 
+require "logger"
+
 module DearInventory
   class Config
     extend T::Sig
 
+    sig { returns(T.nilable(String)) }
+    attr_accessor :account_id
+
+    sig { returns(T.nilable(String)) }
+    attr_accessor :key
+
+    sig { returns(T.untyped) }
+    attr_accessor :logger
+
+    sig { void }
+    def initialize
+      @logger = Logger.new(STDOUT)
+      @logger.level = Logger::WARN
+    end
+
     sig { returns(DearInventory::Environment.class) }
     def environment
       DearInventory::Environment
@@ -15,12 +32,6 @@ module DearInventory
       DearInventory::Environment.set(value)
     end
 
-    sig { returns(T.nilable(String)) }
-    attr_accessor :account_id
-
-    sig { returns(T.nilable(String)) }
-    attr_accessor :key
-
     sig { params(param: Symbol).returns(String) }
     def require(param)
       value = public_send(param)

data/lib/dear_inventory/errors/api_limit.rb

@@ -0,0 +1,6 @@
+# typed: strong
+# frozen_string_literal: true
+
+module DearInventory
+  class APILimitError < DearInventory::Error; end
+end

data/lib/dear_inventory/errors/no_more_pages.rb

@@ -0,0 +1,6 @@
+# typed: strong
+# frozen_string_literal: true
+
+module DearInventory
+  class NoMorePagesError < Error; end
+end

data/lib/dear_inventory/lib/endpoint_class.rb

@@ -49,7 +49,7 @@ module DearInventory
         name = ["DearInventory"]
         name << @class_type
         name << @resource_class.name.split("::").last
-        name << @endpoint
+        name << @endpoint.split("_").map(&:capitalize).join
         name.join("::")
       end
     end

data/lib/dear_inventory/lib/request.rb

@@ -6,18 +6,25 @@ module DearInventory
     extend T::Sig
 
     sig do
-      params(parameters: DearInventory::Models::Request).
-        returns(DearInventory::Response)
+      params(
+        parameters: DearInventory::Models::Request,
+        num_previous_records: Integer
+      ).returns(DearInventory::Response)
     end
-    def self.call(parameters)
-      new(parameters).call
+    def self.call(parameters, num_previous_records: 0)
+      new(parameters, num_previous_records: num_previous_records).call
     end
 
     sig do
-      params(parameters: DearInventory::Models::Request).void
+      params(
+        parameters: DearInventory::Models::Request,
+        num_previous_records: Integer
+      ).void
     end
-    def initialize(parameters)
-      @parameters = parameters
+    def initialize(parameters, num_previous_records: 0)
+      @parameters = T.let(parameters, DearInventory::Models::Request)
+      @num_previous_records = T.let(num_previous_records, Integer)
+      @retries = T.let(0, Integer)
     end
 
     sig { returns(DearInventory::Response) }
@@ -28,8 +35,11 @@ module DearInventory
 
       DearInventory::Response.new(
         response: response,
-        request: @parameters
+        request: @parameters,
+        num_previous_records: @num_previous_records
       )
+    rescue DearInventory::APILimitError, HTTP::ConnectionError => e
+      retry_request(e)
     end
 
     private
@@ -54,5 +64,32 @@ module DearInventory
         { json: params.to_h }
       end
     end
+
+    ERROR_MESSAGE_PREFIXES = T.let(
+      {
+        DearInventory::APILimitError => "The API request limit was reached",
+        HTTP::ConnectionError => "There was an error connecting to the API",
+      }.freeze,
+      T::Hash[T.class_of(StandardError), String]
+    )
+    MAX_RETRIES = T.let(4, Integer)
+    RETRY_DELAY = T.let(5, Integer)
+
+    sig { params(error: StandardError).returns(DearInventory::Response) }
+    def retry_request(error)
+      @retries += 1
+      raise if @retries >= MAX_RETRIES
+
+      message_prefix = ERROR_MESSAGE_PREFIXES[error.class]
+      retry_time = @retries * RETRY_DELAY
+
+      DearInventory.config.logger.warn(
+        "#{message_prefix} while fetching #{@parameters.uri}. " \
+        "The request will be tried again in #{retry_time} seconds"
+      )
+
+      sleep(retry_time)
+      call
+    end
   end
 end

data/lib/dear_inventory/lib/strings/urlize.rb

@@ -0,0 +1,18 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Strings
+  class Urlize
+    extend T::Sig
+
+    sig { params(camel_cased_word: String).returns(String) }
+    def self.call(camel_cased_word)
+      return camel_cased_word unless /[A-Z_]/.match?(camel_cased_word)
+
+      camel_cased_word.
+        gsub(/([A-Z\d]+)([A-Z][a-z])/, '\1-\2').
+        gsub(/([a-z\d])([A-Z])/, '\1-\2').
+        downcase
+    end
+  end
+end

data/lib/dear_inventory/model.rb

@@ -20,13 +20,23 @@ module DearInventory
       ).void
     end
     def self.fields(fields)
-      if ancestors[1].const_defined?(:FIELDS)
-        fields = ancestors[1]::FIELDS.merge(fields)
+      ancestor = T.must(ancestors[1])
+      if ancestor.const_defined?(:FIELDS)
+        fields = ancestor.const_get(:FIELDS).merge(fields)
       end
       const_set(:FIELDS, fields.freeze)
 
+      define_readers
+    end
+
+    sig { void }
+    def self.define_readers
       enumerate_fields do |_, specifications|
         __send__(:attr_reader, specifications[:name])
+
+        if specifications[:type] == :ResultSet
+          alias_method :records, specifications[:name]
+        end
       end
     end
 
@@ -65,9 +75,6 @@ module DearInventory
 
     private
 
-    # rubocop:disable Metrics/AbcSize
-    # rubocop:disable Metrics/CyclomaticComplexity
-    # rubocop:disable Metrics/MethodLength
     sig do
       params(
         response_name: Symbol,
@@ -83,23 +90,29 @@ module DearInventory
         T.nilable(T.class_of(DearInventory::Model))
       )
       value = values[response_name.to_s]
+      return if value == ""
 
-      case specifications[:type]
+      format_value(value, specifications[:type], model)
+    end
+
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/MethodLength
+    def format_value(value, type, model)
+      case type
+      when :Array, :ResultSet
+        initialize_array_values_in_models(value, T.must(model))
       when :BigDecimal
         value.to_d
       when :Date
         ::Date.parse(value) unless value.nil?
       when :DateTime
         ::DateTime.parse(value) unless value.nil?
-      when :Array
-        initialize_array_values_in_models(value, T.must(model))
       when :Hash
         T.must(model).new(value)
       else
         value
       end
     end
-    # rubocop:enable Metrics/AbcSize
     # rubocop:enable Metrics/CyclomaticComplexity
     # rubocop:enable Metrics/MethodLength
 

data/lib/dear_inventory/models/advanced_purchase.rb

@@ -0,0 +1,176 @@
+# typed: strong
+# frozen_string_literal: true
+
+module DearInventory
+  module Models
+    class AdvancedPurchase < DearInventory::Model
+      extend T::Sig
+
+      fields(
+        ID: {
+          name: :id,
+          type: :Guid,
+        },
+        SupplierID: {
+          name: :supplier_id,
+          type: :Guid,
+        },
+        Supplier: {
+          name: :supplier,
+          type: :String,
+        },
+        Contact: {
+          name: :contact,
+          type: :String,
+        },
+        Phone: {
+          name: :phone,
+          type: :String,
+        },
+        InventoryAccount: {
+          name: :inventory_account,
+          type: :String,
+        },
+        BlindReceipt: {
+          name: :blind_receipt,
+          type: :Boolean,
+        },
+        Approach: {
+          name: :approach,
+          type: :String,
+        },
+        BillingAddress: {
+          name: :billing_address,
+          type: :Hash,
+          model: DearInventory::Models::Address,
+        },
+        ShippingAddress: {
+          name: :shipping_address,
+          type: :Hash,
+          model: DearInventory::Models::Address,
+        },
+        BaseCurrency: {
+          name: :base_currency,
+          type: :String,
+        },
+        SupplierCurrency: {
+          name: :supplier_currency,
+          type: :String,
+        },
+        TaxRule: {
+          name: :tax_rule,
+          type: :String,
+        },
+        TaxCalculation: {
+          name: :tax_calculation,
+          type: :String,
+        },
+        Terms: {
+          name: :terms,
+          type: :String,
+        },
+        RequiredBy: {
+          name: :required_by,
+          type: :Date,
+        },
+        Location: {
+          name: :location,
+          type: :String,
+        },
+        Note: {
+          name: :note,
+          type: :String,
+        },
+        OrderNumber: {
+          name: :order_number,
+          type: :String,
+        },
+        OrderDate: {
+          name: :order_date,
+          type: :Date,
+        },
+        CombinedReceivingStatus: {
+          name: :combined_receiving_status,
+          type: :String,
+        },
+        CombinedInvoiceStatus: {
+          name: :combined_invoice_status,
+          type: :String,
+        },
+        CombinedPaymentStatus: {
+          name: :combined_payment_status,
+          type: :String,
+        },
+        Type: {
+          name: :type,
+          type: :String,
+        },
+        IsServiceOnly: {
+          name: :is_service_only,
+          type: :Boolean,
+        },
+        Status: {
+          name: :status,
+          type: :String,
+        },
+        RelatedDropShipSaleTask: {
+          name: :related_drop_ship_sale_task,
+          type: :Guid,
+        },
+        CurrencyRate: {
+          name: :currency_rate,
+          type: :Decimal,
+        },
+        LastUpdatedDate: {
+          name: :last_updated_date,
+          type: :DateTime,
+        },
+        Order: {
+          name: :order,
+          type: :Hash,
+          model: DearInventory::Models::Purchases::Order,
+        },
+        StockReceived: {
+          name: :stock_received,
+          type: :Array,
+          model: DearInventory::Models::Purchases::Advanced::Stock,
+        },
+        PutAway: {
+          name: :put_away,
+          type: :Array,
+          model: DearInventory::Models::Purchases::Advanced::PutAway,
+        },
+        Invoice: {
+          name: :invoice,
+          type: :Array,
+          model: DearInventory::Models::Purchases::Advanced::Invoice,
+        },
+        CreditNote: {
+          name: :credit_note,
+          type: :Array,
+          model: DearInventory::Models::Purchases::Advanced::CreditNote,
+        },
+        ManualJournals: {
+          name: :manual_journals,
+          type: :Array,
+          model: DearInventory::Models::Purchases::Advanced::ManualJournal,
+        },
+        AdditionalAttributes: {
+          name: :additional_attributes,
+          type: :Hash,
+          model: DearInventory::Models::AdditionalAttributes,
+        },
+        Attachments: {
+          name: :attachments,
+          type: :Array,
+          model: DearInventory::Models::Attachment,
+        },
+        InventoryMovements: {
+          name: :inventory_movements,
+          type: :Array,
+          model: DearInventory::Models::Purchases::InventoryMovement,
+        }
+      )
+    end
+  end
+end