dear_inventory 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbdd47a610c9e0211c3172dbefa7f7f01fd8b4f162d56a28278f918cdf5f410d
-  data.tar.gz: 35a216d5c1fef58b34cdeb5e270716b838bb150208c351c72b02efd51c0ddb19
+  metadata.gz: 8a10f4b371f702e3d3f39802e81dfd26b15488bef5b0dc46cf3e545091337ac7
+  data.tar.gz: efeea74d5c331483b7da7d0981d7fd70c18520e2a9e436ee9d8dec33e4f1582c
 SHA512:
-  metadata.gz: c367eb7bae39cc13c565b52276d11f108755648a07a975124a8781e104f7019966dbbddac9374bcdd4d06aada9a4ae123fac9202d026fdb7b7dc756108dc3e61
-  data.tar.gz: ab07f448af90b13057588b4cd5aaae384a731be266584c1382640c5666d45636581e867cc306d64b807199dad6d2e074f667e681f6febe6283fe3e9905f34f36
+  metadata.gz: 6589864faab4bd89da10f91bb0350201d1c0fa422e14640c63bbaddadb733c3ae3bbbaa0dfe0b09424271fa3a4c057d5fc50c64d9125d804160b971854c4ec75
+  data.tar.gz: b8b68f8e77e14472f7e45998d2ed0f05c9cb197b17864bdba649b849c101c11eab56741cb34875b3f24aab7b779981a0c78a2a979ef271ed224876d6ce1ec4a2

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/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/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/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/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/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/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.1.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"
@@ -100,6 +102,7 @@ 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/index"
@@ -109,6 +112,7 @@ 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"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dear_inventory
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Adam Rice
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-15 00:00:00.000000000 Z
+date: 2020-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -221,6 +221,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 +252,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
@@ -305,6 +308,7 @@ files:
 - 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/index.rb
@@ -313,6 +317,7 @@ files:
 - 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