dear_inventory 0.2.0

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

@@ -0,0 +1,35 @@
+# typed: strict
+# frozen_string_literal: true
+
+module DearInventory
+  class Parameters
+    module Sale
+      class Index < 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/parameters/sale_list/index.rb

@@ -0,0 +1,119 @@
+# typed: strict
+# frozen_string_literal: true
+
+module DearInventory
+  class Parameters
+    module SaleList
+      class Index < DearInventory::Parameters
+        extend T::Sig
+
+        fields({
+          page: {
+            property: :Page,
+            type: :Integer,
+            required: false,
+          },
+          limit: {
+            property: :Limit,
+            type: :Integer,
+            required: false,
+          },
+          search: {
+            property: :Search,
+            type: :String,
+            required: false,
+          },
+          created_since: {
+            property: :CreatedSince,
+            type: :DateTime,
+            required: false,
+          },
+          updated_since: {
+            property: :UpdatedSince,
+            type: :DateTime,
+            required: false,
+          },
+          ship_by: {
+            property: :ShipBy,
+            type: :DateTime,
+            required: false,
+          },
+          quote_status: {
+            property: :QuoteStatus,
+            type: :Enum,
+            values: ["NOT AVAILABLE", "DRAFT", "AUTHORISED", "VOIDED"],
+            required: false,
+          },
+          order_status: {
+            property: :OrderStatus,
+            type: :Enum,
+            values: [
+              "NOT AVAILABLE", "DRAFT", "AUTHORISED", "VOIDED", "AUTH_NO_ALLOC",
+              "FULFILLED", "CLOSED"
+            ],
+            required: false,
+          },
+          combined_pick_status: {
+            property: :CombinedPickStatus,
+            type: :Enum,
+            values: [
+              "VOIDED", "NOT AVAILABLE", "PICKED", "PICKING", "NOT PICKED",
+              "PARTIALLY PICKED"
+            ],
+            required: false,
+          },
+          combined_pack_status: {
+            property: :CombinedPackStatus,
+            type: :Enum,
+            values: [
+              "VOIDED", "NOT AVAILABLE", "PACKED", "PACKING", "NOT PACKED",
+              "PARTIALLY PACKED"
+            ],
+            required: false,
+          },
+          combined_shipp_status: {
+            property: :CombinedShippStatus,
+            type: :Enum,
+            values: [
+              "VOIDED", "NOT AVAILABLE", "SHIPPED", "SHIPPING", "NOT SHIPPED",
+              "PARTIALLY SHIPPED"
+            ],
+            required: false,
+          },
+          combined_invoice_status: {
+            property: :CombinedInvoiceStatus,
+            type: :Enum,
+            values: ["VOIDED", "DRAFT", "AUTHORISED", "NOT AVAILABLE", "PAID"],
+            required: false,
+          },
+          credit_note_status: {
+            property: :CreditNoteStatus,
+            type: :Enum,
+            values: ["VOIDED", "DRAFT", "AUTHORISED", "NOT AVAILABLE"],
+            required: false,
+          },
+          external_id: {
+            property: :ExternalID,
+            type: :String,
+            required: false,
+          },
+          status: {
+            property: :Status,
+            type: :Enum,
+            values: %w[
+              DRAFT VOIDED ESTIMATING ESTIMATED ORDERING ORDERED BACKORDERED
+              PICKING PICKED PACKING PACKED SHIPPING INVOICING INVOICED CREDITED
+              COMPLETED
+            ],
+            required: false,
+          },
+          ready_for_shipping: {
+            property: :ReadyForShipping,
+            type: :Boolean,
+            required: false,
+          },
+        })
+      end
+    end
+  end
+end

data/lib/dear_inventory/resource.rb

@@ -0,0 +1,59 @@
+# typed: strict
+# frozen_string_literal: true
+
+module DearInventory
+  class Resource
+    extend T::Sig
+    extend DearInventory::IsASubclass
+
+    sig do
+      params(
+        action: Symbol,
+        model: T.class_of(DearInventory::Model),
+        endpoint: T.nilable(String),
+        params: T::Hash[Symbol, T.untyped]
+      ).returns(DearInventory::Response)
+    end
+    def request(action, model:, endpoint: nil, params: {})
+      url = resource_url(endpoint)
+      params = DearInventory::Parameters.convert(self.class, endpoint, params)
+      options = request_params(action, params)
+
+      response = HTTP.headers(headers).public_send(action, url, options)
+      DearInventory::Response.new(response: response, model: model)
+    end
+
+    private
+
+    URL_BASE = "https://inventory.dearsystems.com/ExternalApi/v2"
+
+    sig { params(endpoint: T.nilable(String)).returns(String) }
+    def resource_url(endpoint)
+      resource = T.must(self.class.name).split("::").last
+      url = "#{URL_BASE}/#{T.must(resource).downcase}"
+      url += "/#{endpoint}" unless endpoint.nil?
+      url
+    end
+
+    sig { returns(T::Hash[Symbol, String]) }
+    def headers
+      {
+        "Content-Type": "application/json",
+        "api-auth-accountid": DearInventory.config.require(:account_id),
+        "api-auth-applicationkey": DearInventory.config.require(:key),
+      }
+    end
+
+    sig do
+      params(action: Symbol, params: DearInventory::Parameters).
+        returns(T::Hash[Symbol, T.untyped])
+    end
+    def request_params(action, params)
+      if action == :get
+        { params: params.to_h }
+      else
+        { json: params.to_h }
+      end
+    end
+  end
+end

data/lib/dear_inventory/resources/sale.rb

@@ -0,0 +1,22 @@
+# typed: strict
+# frozen_string_literal: true
+
+module DearInventory
+  class Sale < Resource
+    class << self
+      extend T::Sig
+
+      # Sale
+      #
+      # @param params [Hash] URL query string parameters that conform to
+      #   DearInventory::Parameters::Sale::Index
+      sig do
+        params(params: T::Hash[Symbol, T.untyped]).
+          returns(DearInventory::Response)
+      end
+      def index(params: {})
+        new.request(:get, params: params, model: DearInventory::Models::Sale)
+      end
+    end
+  end
+end

data/lib/dear_inventory/resources/sale_list.rb

@@ -0,0 +1,24 @@
+# typed: strict
+# frozen_string_literal: true
+
+module DearInventory
+  class SaleList < Resource
+    class << self
+      extend T::Sig
+
+      # Sale List
+      #
+      # @param params [Hash] URL query string parameters that conform to
+      #   DearInventory::Parameters::SaleList::Index
+      sig do
+        params(params: T::Hash[Symbol, T.untyped]).
+          returns(DearInventory::Response)
+      end
+      def index(params: {})
+        new.request(
+          :get, params: params, model: DearInventory::Models::SaleLists
+        )
+      end
+    end
+  end
+end

data/lib/dear_inventory/response.rb

@@ -0,0 +1,75 @@
+# typed: strict
+# frozen_string_literal: true
+
+module DearInventory
+  class Response
+    extend T::Sig
+    extend DearInventory::IsASubclass
+
+    sig do
+      params(
+        model: T.class_of(DearInventory::Model),
+        response: HTTP::Response
+      ).void
+    end
+    def initialize(model:, response:)
+      @model = T.let(nil, T.nilable(DearInventory::Model))
+      @response = T.let(response, HTTP::Response)
+      @body = T.let(nil, T.nilable(String))
+      @http_status = T.let(nil, T.nilable(Integer))
+      @uri = T.let(nil, T.nilable(String))
+
+      assign_values(model)
+      raise_error unless success?
+    end
+
+    sig { returns(T.untyped) }
+    def body
+      @body ||= JSON.parse(@response.body.to_s)
+    end
+
+    sig { returns(T.nilable(String)) }
+    def error
+      # body.fetch("message", nil) if body.respond_to?(:fetch)
+      "Error goes here"
+    end
+
+    sig { returns(T::Hash[Symbol, String]) }
+    def headers
+      @response.headers
+    end
+
+    sig { returns(Integer) }
+    def http_status
+      @http_status ||= @response.status.code
+    end
+
+    sig { returns(T::Boolean) }
+    def success?
+      http_status == 200
+    end
+
+    sig { returns(String) }
+    def uri
+      @uri ||= @response.uri.to_s
+    end
+
+    private
+
+    sig { params(model: T.class_of(DearInventory::Model)).void }
+    def assign_values(model)
+      @model = model.new(body)
+      model.const_get(:FIELDS).each do |response_name, specifications|
+        define_singleton_method(specifications[:name]) do
+          @model.public_send(specifications[:name])
+        end
+      end
+    end
+
+    sig { returns(DearInventory::Error) }
+    def raise_error
+      raise T.unsafe(DearInventory::Error).
+        new("Unknown error (#{http_status}): #{error}", self)
+    end
+  end
+end

data/lib/dear_inventory/validator.rb

@@ -0,0 +1,61 @@
+# typed: strict
+# frozen_string_literal: true
+
+module DearInventory
+  class Validator
+    extend T::Sig
+
+    extend T::Helpers
+    abstract!
+
+    DEFAULT_OPTIONS = T.let(
+      {
+        limit: nil,
+        max_length: nil,
+        values: nil,
+      }.freeze,
+      T::Hash[Symbol, T.nilable(T.any(Integer, T::Array[String]))]
+    )
+    private_constant :DEFAULT_OPTIONS
+
+    sig do
+      params(
+        field_name: Symbol,
+        value: T.nilable(T.any(Date, Numeric, String, T::Boolean, Time)),
+        options: T::Hash[Symbol, T.untyped]
+      ).void
+    end
+    def self.call(field_name, value, options: DEFAULT_OPTIONS)
+      new(field_name, value, options: options).call
+    end
+
+    sig do
+      params(
+        field_name: Symbol,
+        value: T.nilable(T.any(Date, Numeric, String, T::Boolean, Time)),
+        options: T::Hash[Symbol, T.untyped]
+      ).void
+    end
+    def initialize(field_name, value, options: DEFAULT_OPTIONS)
+      @field_name = T.let(field_name, Symbol)
+      @value =
+        T.let(value, T.nilable(T.any(Date, Numeric, String, T::Boolean, Time)))
+
+      @limit = T.let(options[:limit], T.nilable(Integer))
+      @max_length = T.let(options[:limit], T.nilable(Integer))
+      @values = T.let(options[:values], T.nilable(T::Array[String]))
+    end
+
+    private
+
+    sig { abstract.void }
+    def call; end
+
+    protected
+
+    sig { params(message: String).void }
+    def raise_error(message)
+      raise ValidationError, "#{@field_name} is invalid, #{message}"
+    end
+  end
+end

data/lib/dear_inventory/validators/boolean.rb

@@ -0,0 +1,18 @@
+# typed: strict
+# frozen_string_literal: true
+
+module DearInventory
+  module Validators
+    class Boolean < DearInventory::Validator
+      extend T::Sig
+
+      sig { override.void }
+      def call
+        value = instance_variable_get(:@value)
+        return if [true, false, nil].include?(value)
+
+        raise_error("expected a Boolean but received #{value.inspect}")
+      end
+    end
+  end
+end

data/lib/dear_inventory/validators/enum.rb

@@ -0,0 +1,23 @@
+# typed: strict
+# frozen_string_literal: true
+
+module DearInventory
+  module Validators
+    class Enum < DearInventory::Validator
+      extend T::Sig
+
+      sig { override.void }
+      def call
+        value = instance_variable_get(:@value)
+        return if value.nil?
+        return if T.must(@values).include?(value)
+
+        raise_error(
+          "expected one of " \
+          "#{T.must(@values).map { |val| val.inspect }.join(", ")} " \
+          "but received #{value.inspect}"
+        )
+      end
+    end
+  end
+end