dear_inventory 1.0.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbdd47a610c9e0211c3172dbefa7f7f01fd8b4f162d56a28278f918cdf5f410d
-  data.tar.gz: 35a216d5c1fef58b34cdeb5e270716b838bb150208c351c72b02efd51c0ddb19
+  metadata.gz: 4517ad48f4b5c66087e36b25e56af1319fd404d9872f2aa1d205293e69f5dfb7
+  data.tar.gz: 03cf1a5cfb5f3e823368073bdeab88032fc365574617364a706fca5c44b283f7
 SHA512:
-  metadata.gz: c367eb7bae39cc13c565b52276d11f108755648a07a975124a8781e104f7019966dbbddac9374bcdd4d06aada9a4ae123fac9202d026fdb7b7dc756108dc3e61
-  data.tar.gz: ab07f448af90b13057588b4cd5aaae384a731be266584c1382640c5666d45636581e867cc306d64b807199dad6d2e074f667e681f6febe6283fe3e9905f34f36
+  metadata.gz: 4568639a86a8aa82a7a75f8d51de75354107a04ac306cdf7383a4d78160f14210dbbecba98ff1974554f809fc74c4f0cb9c59822101ee82047fcd01040132e19
+  data.tar.gz: e7cbb91397ac2fe478b4d4f4f10da7fcd2823412bf89c9579f2e5b50c93ce622aa627b6a9e2f033351de780aa8fbecde44666bb2f1a7f25454dce22487050ff7

data/.gitignore

@@ -13,3 +13,4 @@
 .rspec_status
 /spec/reports/
 /spec/examples.txt
+/spec/vcr_cassettes

data/README.md

@@ -55,11 +55,12 @@ end
 
 ## Endpoints
 
-[Customer](https://github.com/HashNotAdam/dear_inventory-ruby/docs/resources/customer.md)
-[Product](https://github.com/HashNotAdam/dear_inventory-ruby/docs/resources/product.md)
-[Purchase](https://github.com/HashNotAdam/dear_inventory-ruby/docs/resources/purchase.md)
-[Advanced Purchase](https://github.com/HashNotAdam/dear_inventory-ruby/docs/resources/advanced_purchase.md)
-[Sale](https://github.com/HashNotAdam/dear_inventory-ruby/docs/resources/sale.md)
+- [Customer](https://github.com/HashNotAdam/dear_inventory-ruby/blob/master/docs/resources/customer.md)
+- [Product](https://github.com/HashNotAdam/dear_inventory-ruby/blob/master/docs/resources/product.md)
+- [Product Availability](https://github.com/HashNotAdam/dear_inventory-ruby/blob/master/docs/resources/product_availability.md)
+- [Purchase](https://github.com/HashNotAdam/dear_inventory-ruby/blob/master/docs/resources/purchase.md)
+- [Advanced Purchase](https://github.com/HashNotAdam/dear_inventory-ruby/blob/master/docs/resources/advanced_purchase.md)
+- [Sale](https://github.com/HashNotAdam/dear_inventory-ruby/blob/master/docs/resources/sale.md)
 
 ## Managing pagination
 

data/dear_inventory.gemspec

@@ -28,12 +28,13 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "http", ">= 4.0.0", "< 5.0"
+  spec.add_dependency "http", ">= 5.0", "< 6.0"
   spec.add_dependency "sorbet-runtime"
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rubocop", "~> 0.71"

data/docs/resources/product_availability.md

@@ -0,0 +1,33 @@
+# Product resource
+
+## GET
+
+```ruby
+DearInventory::ProductAvailability.index
+DearInventory::ProductAvailability.()
+```
+
+### Parameters
+| Name | Type | Required |
+| --- | --- | --- |
+| id | String | false |
+| page | Integer | false |
+| limit | Integer | false |
+| name | String | false |
+| sku | String | false |
+| location | String | false |
+| batch | String | false |
+| category | String | false |
+
+### Response
+
+The index endpoint returns a paginated set of records.
+
+To see what data is available in the response, you can call the `field` method:
+
+```ruby
+response = DearInventory::ProductAvailability.()
+response.fields # [:records, :total, :page, :product_availabilities]
+records = response.records
+```
+

data/docs/resources/sale.md

@@ -87,3 +87,31 @@ response.fields # [:id, :customer, :customer_id, :contact, :phone, :email, :defa
 id = response.id # abcdef01-2345-6789-abcd-ef0123456789
 ```
 
+
+
+## Delete DELETE
+
+```ruby
+DearInventory::Sale.delete
+```
+
+### Parameters
+
+| Name | Type | Required | Default |
+| --- | --- | --- | --- |
+| id | String | true | N/A |
+| void | Boolean | false | false |
+
+### Response
+
+A new copy of the record is returned. To see what data is available in the
+response, you can call the `field` method:
+
+```ruby
+response = DearInventory::Sale.delete(
+  id: "abcdef01-2345-6789-abcd-ef0123456789",
+  void: true
+)
+response.fields # [:id, :customer, :customer_id, :contact, :phone, :email, :default_account, :skip_quote, :billing_address, :shipping_address, :base_currency, :customer_currency, :tax_rule, :tax_calculation, :terms, :price_tier, :ship_by, :location, :sale_order_date, :last_modified_on, :note, :customer_reference, :cogs_amount, :status, :combined_picking_status, :combined_packing_status, :combined_shipping_status, :fulfilment_status, :combined_invoice_status, :combined_payment_status, :combined_tracking_numbers, :carrier, :currency_rate, :sales_representative, :type, :source_channel, :external_id, :service_only, :quote, :order, :fulfilments, :invoices, :credit_notes, :manual_journals, :additional_attributes, :attachments, :inventory_movements, :transactions]
+id = response.id # abcdef01-2345-6789-abcd-ef0123456789
+```

data/lib/dear_inventory/lib/request.rb

@@ -58,7 +58,7 @@ module DearInventory
         returns(T::Hash[Symbol, T::Hash[Symbol, T.untyped]])
     end
     def request_params(action, params)
-      if action == :get
+      if %i[get delete].include?(action)
         { params: params.to_h }
       else
         { json: params.to_h }

data/lib/dear_inventory/model.rb

@@ -1,6 +1,7 @@
 # typed: true
 # frozen_string_literal: true
 
+require "bigdecimal/util"
 require "json"
 
 module DearInventory

data/lib/dear_inventory/models/customer.rb

@@ -65,7 +65,7 @@ module DearInventory
         },
         TaxNumber: {
           name: :tax_number,
-          type: :Integer,
+          type: :String,
         },
         CreditLimit: {
           name: :credit_limit,

data/lib/dear_inventory/models/customers.rb

@@ -16,7 +16,7 @@ module DearInventory
           type: :Integer,
         },
         CustomerList: {
-          name: :customer_list,
+          name: :customers,
           type: :ResultSet,
           model: DearInventory::Models::Customer,
         }

data/lib/dear_inventory/models/product_availability.rb

@@ -0,0 +1,61 @@
+# typed: strong
+# frozen_string_literal: true
+
+module DearInventory
+  module Models
+    class ProductAvailability < DearInventory::Model
+      extend T::Sig
+
+      fields(
+        ID: {
+          name: :product_id,
+          type: :Guid,
+        },
+        SKU: {
+          name: :sku,
+          type: :String,
+        },
+        Name: {
+          name: :name,
+          type: :String,
+        },
+        Barcode: {
+          name: :barcode,
+          type: :String,
+        },
+        Location: {
+          name: :location,
+          type: :String,
+        },
+        Bin: {
+          name: :bin,
+          type: :String,
+        },
+        ExpiryDate: {
+          name: :expiry_date,
+          type: :DateTime,
+        },
+        OnHand: {
+          name: :on_hand,
+          type: :Float,
+        },
+        Allocated: {
+          name: :allocated,
+          type: :Float,
+        },
+        Available: {
+          name: :available,
+          type: :Float,
+        },
+        OnOrder: {
+          name: :on_order,
+          type: :Float,
+        },
+        StockOnHand: {
+          name: :stock_on_hand,
+          type: :Float,
+        }
+      )
+    end
+  end
+end

data/lib/dear_inventory/models/product_availability_results.rb

@@ -0,0 +1,26 @@
+# typed: strong
+# frozen_string_literal: true
+
+module DearInventory
+  module Models
+    class ProductAvailabilityResults < DearInventory::Model
+      extend T::Sig
+
+      fields(
+        Total: {
+          name: :total,
+          type: :Integer,
+        },
+        Page: {
+          name: :page,
+          type: :Integer,
+        },
+        ProductAvailabilityList: {
+          name: :product_availabilities,
+          type: :ResultSet,
+          model: DearInventory::Models::ProductAvailability,
+        }
+      )
+    end
+  end
+end

data/lib/dear_inventory/models/test_request.rb

@@ -0,0 +1,31 @@
+# typed: strict
+# frozen_string_literal: true
+
+module DearInventory
+  module Models
+    class TestRequest < Request
+      extend T::Sig
+
+      sig { returns(Symbol) }
+      attr_reader :action
+      sig { returns(T.class_of(DearInventory::Model)) }
+      attr_reader :model
+      sig { returns(DearInventory::Parameters) }
+      attr_reader :params
+      sig { returns(String) }
+      attr_reader :uri
+
+      sig { params(parameters: T::Hash[Symbol, T.untyped]).void }
+      def initialize(parameters)
+        @action = T.let(parameters[:action], T.nilable(Symbol))
+        @model = T.let(
+          parameters[:model], T.nilable(T.class_of(DearInventory::Model))
+        )
+        @params = T.let(
+          parameters[:params], T.nilable(DearInventory::Parameters)
+        )
+        @uri = T.let(parameters[:uri], T.nilable(String))
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# typed: strict
+# frozen_string_literal: true
+
+module DearInventory
+  class Parameters
+    module ProductAvailability
+      class Index < DearInventory::Parameters
+        extend T::Sig
+
+        fields(
+          id: {
+            property: :ID,
+            type: :String,
+            required: false,
+          },
+          page: {
+            property: :Page,
+            type: :Integer,
+            required: false,
+          },
+          limit: {
+            property: :Limit,
+            type: :Integer,
+            required: false,
+          },
+          name: {
+            property: :Name,
+            type: :String,
+            required: false,
+          },
+          sku: {
+            property: :Sku,
+            type: :String,
+            required: false,
+          },
+          location: {
+            property: :Location,
+            type: :String,
+            required: false,
+          },
+          batch: {
+            property: :Batch,
+            type: :String,
+            required: false,
+          },
+          category: {
+            property: :Category,
+            type: :String,
+            required: false,
+          }
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# typed: strict
+# frozen_string_literal: true
+
+module DearInventory
+  class Parameters
+    module Sale
+      class Delete < DearInventory::Parameters
+        extend T::Sig
+
+        fields(
+          id: {
+            property: :ID,
+            type: :String,
+            required: true,
+          },
+          void: {
+            property: :Void,
+            type: :Boolean,
+            required: false,
+          }
+        )
+      end
+    end
+  end
+end

data/lib/dear_inventory/resources/advanced_purchase.rb

@@ -9,7 +9,7 @@ module DearInventory
       # Advanced Purchase
       #
       # @param params [Hash] URL query string parameters that conform to
-      #   DearInventory::Parameters::Purchase::ShowAdvanced
+      #   DearInventory::Parameters::AdvancedPurchase::Show
       sig do
         params(params: T::Hash[Symbol, T.untyped]).
           returns(DearInventory::Response)

data/lib/dear_inventory/resources/product_availability.rb

@@ -0,0 +1,35 @@
+# typed: strict
+# frozen_string_literal: true
+
+module DearInventory
+  class ProductAvailability < Resource
+    class << self
+      extend T::Sig
+
+      # ProductAvailability
+      #
+      # @param params [Hash] URL query string parameters that conform to
+      #   DearInventory::Parameters::ProductAvailability::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::ProductAvailabilityResults
+        )
+      end
+
+      alias call index
+    end
+
+    private
+
+    sig { params(_endpoint: T.nilable(String)).returns(String) }
+    def resource_uri(_endpoint)
+      self.class.const_get(:URI_BASE) + "/ref/productavailability"
+    end
+  end
+end

data/lib/dear_inventory/resources/sale.rb

@@ -41,6 +41,23 @@ module DearInventory
           params: params
         )
       end
+
+      # Sale
+      #
+      # @param params [Hash] URL query string parameters that conform to
+      #   DearInventory::Parameters::Sale::Delete
+      sig do
+        params(params: T::Hash[Symbol, T.untyped]).
+          returns(DearInventory::Response)
+      end
+      def delete(params = {})
+        new.request(
+          :delete,
+          endpoint: "delete",
+          model: DearInventory::Models::Sale,
+          params: params
+        )
+      end
     end
 
     private
@@ -49,9 +66,9 @@ module DearInventory
     def resource_uri(endpoint)
       case endpoint
       when "index"
-        self.class.const_get(:URI_BASE) + "/salelist"
-      when "show"
-        self.class.const_get(:URI_BASE) + "/sale"
+        "#{self.class.const_get(:URI_BASE)}/salelist"
+      when "show", "delete"
+        "#{self.class.const_get(:URI_BASE)}/sale"
       end
     end
   end

data/lib/dear_inventory/response.rb

@@ -136,7 +136,13 @@ module DearInventory
     sig { returns(T.any(T::Hash[String, T.untyped], String)) }
     def body
       string_body = @response.body.to_s
-      JSON.parse(string_body)
+      parsed_body = JSON.parse(string_body)
+
+      if parsed_body.is_a?(Array)
+        parsed_body.first
+      else
+        parsed_body
+      end
     rescue JSON::ParserError
       string_body
     end

data/lib/dear_inventory/test_response.rb

@@ -0,0 +1,44 @@
+# typed: strict
+# frozen_string_literal: true
+
+module DearInventory
+  class TestResponse < Response
+    extend T::Sig
+    extend DearInventory::IsASubclass
+
+    sig { returns(DearInventory::Models::Request) }
+    attr_reader :request
+    sig { returns(HTTP::Response) }
+    attr_reader :response
+
+    # rubocop:disable Metrics/AbcSize
+    sig do
+      params(
+        request: DearInventory::Models::TestRequest,
+        body: T.nilable(T::Hash[String, T.untyped]),
+        num_previous_records: Integer
+      ).void
+    end
+    def initialize(request:, body:, num_previous_records: 0)
+      @request = T.let(request, DearInventory::Models::Request)
+      @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))
+      @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))
+
+      raise_error unless success?
+
+      @model = T.let(@request.model.new(body), DearInventory::Model)
+      assign_values
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    sig { returns(Integer) }
+    def http_status
+      200
+    end
+  end
+end

data/lib/dear_inventory/validators/required.rb

@@ -8,10 +8,20 @@ module DearInventory
 
       sig { override.void }
       def call
-        return if instance_variable_get(:@value).present?
+        return if present?(instance_variable_get(:@value))
 
         raise_error("the field is required but no value was provided")
       end
+
+      private
+
+      def present?(value)
+        !blank?(value)
+      end
+
+      def blank?(value)
+        value&.empty? || !value
+      end
     end
   end
 end

data/lib/dear_inventory/version.rb

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

data/lib/dear_inventory.rb

@@ -31,6 +31,8 @@ require "dear_inventory/models/bill_of_materials_service"
 require "dear_inventory/models/customers/address"
 require "dear_inventory/models/customers/contact"
 require "dear_inventory/models/inventory_movement"
+require "dear_inventory/models/product_availability"
+require "dear_inventory/models/product_availability_results"
 require "dear_inventory/models/products/movement"
 require "dear_inventory/models/purchases"
 require "dear_inventory/models/purchases_results"
@@ -86,6 +88,7 @@ require "dear_inventory/models/sales/invoice"
 require "dear_inventory/models/sale"
 require "dear_inventory/models/sales"
 require "dear_inventory/models/request"
+require "dear_inventory/models/test_request"
 
 require "dear_inventory/validator"
 require "dear_inventory/validators/boolean"
@@ -100,8 +103,10 @@ 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/product_availability/index"
 require "dear_inventory/parameters/purchase/index"
 require "dear_inventory/parameters/purchase/show"
+require "dear_inventory/parameters/sale/delete"
 require "dear_inventory/parameters/sale/index"
 require "dear_inventory/parameters/sale/show"
 
@@ -109,10 +114,12 @@ require "dear_inventory/resource"
 require "dear_inventory/resources/advanced_purchase"
 require "dear_inventory/resources/customer"
 require "dear_inventory/resources/product"
+require "dear_inventory/resources/product_availability"
 require "dear_inventory/resources/purchase"
 require "dear_inventory/resources/sale"
 
 require "dear_inventory/response"
+require "dear_inventory/test_response"
 
 require "dear_inventory/version"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dear_inventory
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Adam Rice
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-04-15 00:00:00.000000000 Z
+date: 2022-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +86,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -221,6 +235,7 @@ files:
 - docs/resources/advanced_purchase.md
 - docs/resources/customer.md
 - docs/resources/product.md
+- docs/resources/product_availability.md
 - docs/resources/purchase.md
 - docs/resources/sale.md
 - lib/dear_inventory.rb
@@ -251,6 +266,8 @@ files:
 - lib/dear_inventory/models/customers/contact.rb
 - lib/dear_inventory/models/inventory_movement.rb
 - lib/dear_inventory/models/product.rb
+- lib/dear_inventory/models/product_availability.rb
+- lib/dear_inventory/models/product_availability_results.rb
 - lib/dear_inventory/models/products.rb
 - lib/dear_inventory/models/products/movement.rb
 - lib/dear_inventory/models/purchase.rb
@@ -300,22 +317,27 @@ files:
 - lib/dear_inventory/models/sales_results.rb
 - lib/dear_inventory/models/shipping_address.rb
 - lib/dear_inventory/models/supplier.rb
+- lib/dear_inventory/models/test_request.rb
 - lib/dear_inventory/models/transaction.rb
 - lib/dear_inventory/parameters.rb
 - lib/dear_inventory/parameters/advanced_purchase/show.rb
 - lib/dear_inventory/parameters/customer/index.rb
 - lib/dear_inventory/parameters/product/index.rb
+- lib/dear_inventory/parameters/product_availability/index.rb
 - lib/dear_inventory/parameters/purchase/index.rb
 - lib/dear_inventory/parameters/purchase/show.rb
+- lib/dear_inventory/parameters/sale/delete.rb
 - lib/dear_inventory/parameters/sale/index.rb
 - lib/dear_inventory/parameters/sale/show.rb
 - lib/dear_inventory/resource.rb
 - lib/dear_inventory/resources/advanced_purchase.rb
 - lib/dear_inventory/resources/customer.rb
 - lib/dear_inventory/resources/product.rb
+- lib/dear_inventory/resources/product_availability.rb
 - lib/dear_inventory/resources/purchase.rb
 - lib/dear_inventory/resources/sale.rb
 - lib/dear_inventory/response.rb
+- lib/dear_inventory/test_response.rb
 - lib/dear_inventory/validator.rb
 - lib/dear_inventory/validators/boolean.rb
 - lib/dear_inventory/validators/enum.rb
@@ -374,7 +396,7 @@ homepage: https://morningcoffee.com.au
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -389,8 +411,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.8.11
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Library for connecting to the DEAR Inventory API
 test_files: []