magento 0.19.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd6a94c17db3ebc55bcc96cbae5118128326e3d7ca2d0e96bfb5b530edea5561
-  data.tar.gz: a0e86d4bc16f5c4338281fcadb07ee62f18017cc59bcd89cb15804110472021c
+  metadata.gz: 7b2408f7d630a838f697a67fd49e5c9821cb3876867ac1ca3bd895b7907aed3d
+  data.tar.gz: a96cf27ae84be012af63fcb7a85c012680abfcc8a605317176d30b306b75099e
 SHA512:
-  metadata.gz: 1a7ebe7b9a4b24d0644ef31ddaee95ff17c07e702f001ec18ad632886e538187ff5a02ef841fe648d8c5eb0a5348b13579a15c9450c9442ad08f5fd29c17333f
-  data.tar.gz: 3252ea89c262918fce7b206e842197510929e1acb998da5613ba8f7d37f4f68de4b0cde29e765199f0bb0f177882dd33bd16efe98454231e909ee3cd3cb76b34
+  metadata.gz: 11472a37cda254fdec29a954cb96255326bf10abe0d50c2ef5befb2ebf894e446c5d89faec168fd010949edc7a7b009a8ed4aeddebf63a7152f4cf2b2eb52395
+  data.tar.gz: f3d20a4db9adddd584271fc653cffedd9131db1b4ed2d1fa5cdadf18cc48e6086cb3a6e940e2eaee0cc40639071e384442e92535209078d006d30e2c966b20c4

data/README.md

@@ -5,7 +5,7 @@
 Add in your Gemfile
 
 ```rb
-gem 'magento', '~> 0.19.0'
+gem 'magento', '~> 0.22.0'
 ```
 
 or run
@@ -17,9 +17,11 @@ gem install magento
 ### Setup
 
 ```rb
-Magento.url   = 'https://yourstore.com'
-Magento.token = 'MAGENTO_API_KEY'
-Magento.store = :default # optional, Default is :all
+Magento.configure do |config|
+  config.url   = 'https://yourstore.com'
+  config.token = 'MAGENTO_API_KEY'
+  config.store = :default # optional, Default is :all
+end
 
 Magento.with_config(store: :other_store) do # accepts store, url and token parameters
   Magento::Product.find('sku')
@@ -612,6 +614,53 @@ Magento::Product.where(name_like: 'some name%').count
 >> 15
 ```
 
+## Inventory
+
+### Check whether a product is salable
+
+```rb
+Inventory.get_product_salable_quantity(sku: '4321', stock_id: 1)
+>> 1
+```
+
+### Check whether a product is salable for a specified quantity
+
+```rb
+Inventory.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"
+    },
+    ...
+  ]
+}
+```
+
+## Update product stock
+
+```rb
+product = Magento::Product.find('sku')
+product.update_stock(qty: 12, is_in_stock: true)
+```
+
+or by class method
+
+```rb
+Magento::Product.update_stock(sku, id, {
+  qty: 12,
+  is_in_stock: true 
+})
+```
+
+see all available attributes in: https://magento.redoc.ly/2.4.1-admin/tag/productsproductSkustockItemsitemId
+
 ___
 
 ##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/import/csv_reader.rb

@@ -9,7 +9,7 @@ module Magento
       end
 
       def get_products
-        @csv[1..].map do |row|
+        @csv[1..-1].map do |row|
           OpenStruct.new({
             name: row[0],
             sku: row[1],

data/lib/magento/inventory.rb

@@ -0,0 +1,40 @@
+module Magento
+  class Inventory
+    class << self
+      # 
+      # ==== Example
+      #
+      #   Inventory.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/product.rb

@@ -6,6 +6,14 @@ module Magento
       attr(m) || super(m, *params, &block)
     end
 
+    def stock
+      extension_attributes&.stock_item
+    end
+
+    def stock_quantity
+      stock&.qty
+    end
+
     # returns custom_attribute value by custom_attribute code
     # return nil if custom_attribute is not present
     def attr(attribute_code)
@@ -44,6 +52,16 @@ module Magento
       )
     end
 
+    # Update product stock
+    #
+    #   product = Magento::Product.find('sku')
+    #   product.update_stock(qty: 12, is_in_stock: true)
+    #
+    # see all available attributes in: https://magento.redoc.ly/2.4.1-admin/tag/productsproductSkustockItemsitemId
+    def update_stock(attributes)
+      self.class.update_stock(sku, id, attributes)
+    end
+
     class << self
       alias_method :find_by_sku, :find
 
@@ -66,6 +84,18 @@ module Magento
           "products/#{sku}/group-prices/#{customer_group_id}/tiers/#{quantity}/price/#{price}"
         ).parse
       end
+
+      # Update product stock
+      #
+      #   Magento::Product.update_stock(sku, id, {
+      #     qty: 12,
+      #     is_in_stock: true 
+      #   })
+      #
+      # see all available attributes in: https://magento.redoc.ly/2.4.1-admin/tag/productsproductSkustockItemsitemId
+      def update_stock(sku, id, attributes)
+        request.put("products/#{sku}/stockItems/#{id}", stockItem: attributes).parse
+      end
     end
   end
 end

data/lib/magento/version.rb

@@ -1,3 +1,3 @@
 module Magento
-  VERSION = '0.19.0'
+  VERSION = '0.22.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magento
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.22.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