dear_inventory 0.7.5 → 1.0.0

data/lib/dear_inventory/parameters/sale/show.rb

@@ -0,0 +1,35 @@
+# typed: strict
+# frozen_string_literal: true
+
+module DearInventory
+  class Parameters
+    module Sale
+      class Show < DearInventory::Parameters
+        extend T::Sig
+
+        fields(
+          id: {
+            property: :ID,
+            type: :String,
+            required: true,
+          },
+          combine_additional_charges: {
+            property: :CombineAdditionalCharges,
+            type: :Boolean,
+            required: false,
+          },
+          hide_inventory_movements: {
+            property: :HideInventoryMovements,
+            type: :Boolean,
+            required: false,
+          },
+          include_transactions: {
+            property: :IncludeTransactions,
+            type: :Boolean,
+            required: false,
+          }
+        )
+      end
+    end
+  end
+end

data/lib/dear_inventory/resource.rb

@@ -15,28 +15,25 @@ module DearInventory
       ).returns(DearInventory::Response)
     end
     def request(action, model:, endpoint: nil, params: {})
-      uri = resource_uri(endpoint)
-      params = DearInventory::Parameters.convert(self.class, endpoint, params)
-
       request = DearInventory::Models::Request.new(
         action: action,
         model: model,
-        params: params,
-        uri: uri
+        params: DearInventory::Parameters.convert(self.class, endpoint, params),
+        uri: resource_uri(endpoint)
       )
       DearInventory::Request.(request)
     end
 
     private
 
-    URI_BASE = "https://inventory.dearsystems.com/ExternalApi/v2"
+    URI_BASE = T.let("https://inventory.dearsystems.com/ExternalApi/v2", String)
 
-    sig { params(endpoint: T.nilable(String)).returns(String) }
-    def resource_uri(endpoint)
+    sig { params(_endpoint: T.nilable(String)).returns(String) }
+    def resource_uri(_endpoint)
       resource = T.must(self.class.name).split("::").last
-      uri = "#{URI_BASE}/#{T.must(resource).downcase}"
-      uri += "/#{endpoint}" unless endpoint.nil?
-      uri
+      camel_case = Strings::Urlize.(T.must(resource))
+
+      "#{URI_BASE}/#{camel_case}"
     end
   end
 end

data/lib/dear_inventory/resources/{purchase_list.rb → advanced_purchase.rb}

@@ -2,21 +2,24 @@
 # frozen_string_literal: true
 
 module DearInventory
-  class PurchaseList < Resource
+  class AdvancedPurchase < Resource
     class << self
       extend T::Sig
 
-      # Purchase List
+      # Advanced Purchase
       #
       # @param params [Hash] URL query string parameters that conform to
-      #   DearInventory::Parameters::PurchaseList::Index
+      #   DearInventory::Parameters::Purchase::ShowAdvanced
       sig do
         params(params: T::Hash[Symbol, T.untyped]).
           returns(DearInventory::Response)
       end
-      def index(params = {})
+      def show(params = {})
         new.request(
-          :get, params: params, model: DearInventory::Models::PurchaseLists
+          :get,
+          endpoint: "show",
+          model: DearInventory::Models::AdvancedPurchase,
+          params: params
         )
       end
     end

data/lib/dear_inventory/resources/customer.rb

@@ -19,6 +19,8 @@ module DearInventory
           :get, params: params, model: DearInventory::Models::Customers
         )
       end
+
+      alias call index
     end
   end
 end

data/lib/dear_inventory/resources/product.rb

@@ -19,6 +19,8 @@ module DearInventory
           :get, params: params, model: DearInventory::Models::Products
         )
       end
+
+      alias call index
     end
   end
 end

data/lib/dear_inventory/resources/purchase.rb

@@ -6,7 +6,7 @@ module DearInventory
     class << self
       extend T::Sig
 
-      # Purchase
+      # Purchases
       #
       # @param params [Hash] URL query string parameters that conform to
       #   DearInventory::Parameters::Purchase::Index
@@ -16,9 +16,45 @@ module DearInventory
       end
       def index(params = {})
         new.request(
-          :get, params: params, model: DearInventory::Models::Purchase
+          :get,
+          endpoint: "index",
+          model: DearInventory::Models::PurchasesResults,
+          params: params
+        )
+      end
+
+      alias call index
+
+      # Purchase
+      #
+      # @param params [Hash] URL query string parameters that conform to
+      #   DearInventory::Parameters::Purchase::Show
+      sig do
+        params(params: T::Hash[Symbol, T.untyped]).
+          returns(DearInventory::Response)
+      end
+      def show(params = {})
+        new.request(
+          :get,
+          endpoint: "show",
+          model: DearInventory::Models::Purchase,
+          params: params
         )
       end
     end
+
+    private
+
+    sig { params(endpoint: T.nilable(String)).returns(String) }
+    def resource_uri(endpoint)
+      suffix =
+        case endpoint
+        when "index"
+          "/purchaselist"
+        when "show"
+          "/purchase"
+        end
+      self.class.const_get(:URI_BASE) + suffix
+    end
   end
 end

data/lib/dear_inventory/resources/sale.rb

@@ -6,7 +6,7 @@ module DearInventory
     class << self
       extend T::Sig
 
-      # Sale
+      # Sales
       #
       # @param params [Hash] URL query string parameters that conform to
       #   DearInventory::Parameters::Sale::Index
@@ -15,7 +15,43 @@ module DearInventory
           returns(DearInventory::Response)
       end
       def index(params = {})
-        new.request(:get, params: params, model: DearInventory::Models::Sale)
+        new.request(
+          :get,
+          endpoint: "index",
+          model: DearInventory::Models::SalesResults,
+          params: params
+        )
+      end
+
+      alias call index
+
+      # Sale
+      #
+      # @param params [Hash] URL query string parameters that conform to
+      #   DearInventory::Parameters::Sale::Show
+      sig do
+        params(params: T::Hash[Symbol, T.untyped]).
+          returns(DearInventory::Response)
+      end
+      def show(params = {})
+        new.request(
+          :get,
+          endpoint: "show",
+          model: DearInventory::Models::Sale,
+          params: params
+        )
+      end
+    end
+
+    private
+
+    sig { params(endpoint: T.nilable(String)).returns(String) }
+    def resource_uri(endpoint)
+      case endpoint
+      when "index"
+        self.class.const_get(:URI_BASE) + "/salelist"
+      when "show"
+        self.class.const_get(:URI_BASE) + "/sale"
       end
     end
   end

data/lib/dear_inventory/response.rb

@@ -11,28 +11,54 @@ module DearInventory
     sig { returns(HTTP::Response) }
     attr_reader :response
 
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
     sig do
       params(
         request: DearInventory::Models::Request,
-        response: HTTP::Response
+        response: HTTP::Response,
+        num_previous_records: Integer
       ).void
     end
-    def initialize(request:, response:)
+    def initialize(request:, response:, num_previous_records: 0)
       @request = T.let(request, DearInventory::Models::Request)
       @response = T.let(response, HTTP::Response)
+      @num_previous_records = T.let(num_previous_records, Integer)
+
+      @fields = T.let(nil, T.nilable(T::Array[Symbol]))
       @http_status = T.let(nil, T.nilable(Integer))
-      @model = T.let(nil, T.nilable(DearInventory::Model))
+      @load_full_record = T.let(nil, T.nilable(T::Boolean))
+      @num_records_paged = T.let(nil, T.nilable(Integer))
       @uri = T.let(nil, T.nilable(String))
 
-      assign_values
       raise_error unless success?
+
+      body_copy = T.cast(body, T.nilable(T::Hash[String, T.untyped]))
+      @model = T.let(@request.model.new(body_copy), DearInventory::Model)
+      assign_values
+    end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
+
+    sig { returns(T::Array[Symbol]) }
+    def fields
+      @fields ||= begin
+        values = @request.model.const_get(:FIELDS).values.map do |field|
+          field[:name]
+        end
+        values.unshift(:records) if @model.respond_to?(:records)
+        values
+      end
     end
 
     sig { returns(T.nilable(String)) }
     def error
-      return body.fetch("Exception", nil) if body.respond_to?(:fetch)
+      if body.respond_to?(:fetch)
+        body_copy = T.cast(body, T::Hash[String, T.untyped])
+        return body_copy.fetch("Exception", nil)
+      end
 
-      body
+      T.cast(body, T.nilable(String))
     end
 
     sig { returns(T::Hash[Symbol, String]) }
@@ -45,15 +71,54 @@ module DearInventory
       @http_status ||= @response.status.code
     end
 
+    sig { returns(T::Boolean) }
+    def paginated?
+      @model.respond_to?(:page)
+    end
+
+    sig { params(block: T.proc.params(arg0: DearInventory::Model).void).void }
+    def each(&block)
+      raise_not_paginated unless paginated?
+
+      response = self
+      loop do
+        iterate_over_records(response, block)
+        break unless response.next_page?
+
+        response = response.next_page
+      end
+    end
+
     sig { returns(DearInventory::Response) }
     def next_page
-      unless T.must(@model).respond_to?(:page)
-        raise DearInventory::NotPaginatedError.new(uri: uri)
-      end
+      raise_not_paginated unless paginated?
+      raise DearInventory::NoMorePagesError unless next_page?
 
       request = @request.dup
       T.unsafe(request.params).page = T.unsafe(@model).page + 1
-      DearInventory::Request.(request)
+
+      DearInventory::Request.(request, num_previous_records: num_records_paged)
+    end
+
+    sig { returns(T::Boolean) }
+    def next_page?
+      raise_not_paginated unless paginated?
+
+      num_records_paged < T.unsafe(self).total
+    end
+
+    sig { returns(Integer) }
+    def num_records_paged
+      @num_records_paged ||= begin
+        raise_not_paginated unless paginated?
+
+        @num_previous_records + T.unsafe(self).records.count
+      end
+    end
+
+    sig { void }
+    def raise_not_paginated
+      raise DearInventory::NotPaginatedError.new(uri: uri)
     end
 
     sig { returns(T::Boolean) }
@@ -68,31 +133,67 @@ module DearInventory
 
     protected
 
-    sig { returns(T.untyped) }
+    sig { returns(T.any(T::Hash[String, T.untyped], String)) }
     def body
-      JSON.parse(@response.body.to_s)
+      string_body = @response.body.to_s
+      JSON.parse(string_body)
+    rescue JSON::ParserError
+      string_body
     end
 
     private
 
     sig { void }
     def assign_values
-      @model = @request.model.new(body)
-      @request.model.const_get(:FIELDS).each do |_, specifications|
-        define_singleton_method(specifications[:name]) do
-          @model.public_send(specifications[:name])
-        end
+      fields.each { |field| define_alias_method(field) }
+    end
+
+    sig { params(method_name: Symbol).void }
+    def define_alias_method(method_name)
+      define_singleton_method(method_name) do
+        @model.public_send(method_name)
       end
     end
 
+    API_LIMIT_ERROR = T.let(
+      "You have reached 60 calls per 60 seconds API limit.", String
+    )
+
+    # rubocop:disable Metrics/AbcSize
     sig { returns(DearInventory::Error) }
     def raise_error
       if http_status == 400
         raise T.unsafe(DearInventory::BadRequestError).new(error, self)
       end
 
+      if http_status == 503 && error == API_LIMIT_ERROR
+        raise T.unsafe(DearInventory::APILimitError)
+      end
+
       raise T.unsafe(DearInventory::Error).
         new("Unknown error (#{http_status}): #{error}")
     end
+    # rubocop:enable Metrics/AbcSize
+
+    sig do
+      params(
+        response: DearInventory::Response,
+        block: T.proc.params(arg0: DearInventory::Model).void
+      ).void
+    end
+    def iterate_over_records(response, block)
+      return if T.unsafe(response).records.nil?
+
+      T.unsafe(response).records.each do |record|
+        record = record.full_record if load_full_record?
+        block.call(record)
+      end
+    end
+
+    sig { returns(T::Boolean) }
+    def load_full_record?
+      @load_full_record ||=
+        T.unsafe(self).records.first.respond_to?(:full_record)
+    end
   end
 end

data/lib/dear_inventory/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module DearInventory
-  VERSION = "0.7.5"
+  VERSION = "1.0.0"
 end

data/sorbet/rbi/hidden-definitions/hidden.rbi

@@ -14376,10 +14376,6 @@ module Readline
   def self.vi_editing_mode?(); end
 end
 
-class Regexp
-  def match?(*_); end
-end
-
 module Reline
   def eof?(*args, &block); end
   FILENAME_COMPLETION_PROC = ::T.let(nil, ::T.untyped)