magento 0.20.1 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68aa93fb639c7e6d3cab0a521e91c08d38aa28dd7d508f50190ce9e718ed8022
-  data.tar.gz: ccde7c0ccbe949e12fb97fab1c80d2dfbc18c9e8de80181b0e0dab1c763f0ee6
+  metadata.gz: 3369907b3576aff1a8d5199396f90b0431b629c9abf2a339917ace10ae3bdefa
+  data.tar.gz: 20149d57d54c0c5be44b1ca1b9006c429db2d254ff41272c201b68e2b6aa5c68
 SHA512:
-  metadata.gz: d5ddc1d9471997748938d0942e97125b0dd6620efda44c2d80d967968677595e6837bbfbcbd43eb92a9992a50fd8c2dbd3adfef880fb84e3f322ac1ba8400bd1
-  data.tar.gz: 631f5d649fa1bfde37f1b9662685ea400f967792b1ed293fc1d1fb20d5d49f775dacbba332f97736079dada2cc67aaecec8f6cd5ca41012537ef8a76fd61e401
+  metadata.gz: cd086b7748e54381a71f96af6d1356e6124ca97b169df488ff330a21de63ec4a702dc53c28ad964e4fbbcdc0ed314e83f4ffc5e400264b04de74fc1aaab964d7
+  data.tar.gz: 580ed9f180845668b33a46b88ab237b56e99b4237fe0d3131452b3abe7bd694d48f342b93108d85069550bc241437a503c888e6994c8aad434794def55cc8765

data/README.md

@@ -5,7 +5,7 @@
 Add in your Gemfile
 
 ```rb
-gem 'magento', '~> 0.20.1'
+gem 'magento', '~> 0.21.0'
 ```
 
 or run
@@ -614,6 +614,35 @@ Magento::Product.where(name_like: 'some name%').count
 >> 15
 ```
 
+## Inventory
+
+### Check whether a product is salable
+
+```rb
+Inventoty.get_product_salable_quantity(sku: '4321', stock_id: 1)
+>> 1
+```
+
+### Check whether a product is salable for a specified quantity
+
+```rb
+Inventoty.is_product_salable_for_requested_qty(
+  sku: '4321',
+  stock_id: 1,
+  requested_qty: 2
+)
+>> OpenStruct {
+  :salable => false,
+  :errors => [
+    [0] {
+      "code" => "back_order-disabled",
+      "message" => "Backorders are disabled"
+    },
+    ...
+  ]
+}
+```
+
 ___
 
 ##TODO:

data/lib/magento.rb

@@ -22,6 +22,7 @@ require_relative 'magento/order'
 require_relative 'magento/invoice'
 require_relative 'magento/guest_cart'
 require_relative 'magento/sales_rule'
+require_relative 'magento/inventory'
 require_relative 'magento/import'
 
 Dir[File.expand_path('magento/shared/*.rb', __dir__)].map { |f| require f }

data/lib/magento/inventory.rb

@@ -0,0 +1,40 @@
+module Magento
+  class Inventoty
+    class << self
+      # 
+      # ==== Example
+      #
+      #   Inventoty.is_product_salable_for_requested_qty(
+      #     sku: '4321',
+      #     stock_id: 1,
+      #     requested_qty: 2
+      #   )
+      #   # =>
+      #   OpenStruct {
+      #     :salable => false,
+      #     :errors => [
+      #       [0] {
+      #         "code" => "back_order-disabled",
+      #         "message" => "Backorders are disabled"
+      #       },
+      #       ...
+      #     ]
+      #   }
+      #
+      # @return OpenStruct
+      def is_product_salable_for_requested_qty(sku:, stock_id:, requested_qty:)
+        result = Request.new.get(
+          "inventory/is-product-salable-for-requested-qty/#{sku}/#{stock_id}/#{requested_qty}"
+        ).parse
+
+        OpenStruct.new(result)
+      end
+
+      def get_product_salable_quantity(sku:, stock_id:)
+        Request.new.get(
+          "inventory/get-product-salable-quantity/#{sku}/#{stock_id}"
+        ).parse
+      end
+    end
+  end
+end

data/lib/magento/version.rb

@@ -1,3 +1,3 @@
 module Magento
-  VERSION = '0.20.1'
+  VERSION = '0.21.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magento
 version: !ruby/object:Gem::Version
-  version: 0.20.1
+  version: 0.21.0
 platform: ruby
 authors:
 - Wallas Faria
@@ -103,6 +103,7 @@ files:
 - lib/magento/import/image_finder.rb
 - lib/magento/import/product.rb
 - lib/magento/import/template/products.csv
+- lib/magento/inventory.rb
 - lib/magento/invoice.rb
 - lib/magento/model.rb
 - lib/magento/model_mapper.rb