magento 0.20.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc9582af53b1373798281de5d95c312d7821edd2e597ab7eb98b756b9b44acb0
-  data.tar.gz: fcdca10d53017a38791ee474a001580af31291db167cbd7cf9064d0315c3220d
+  metadata.gz: 2212acd226570a0dc73fc66683290aca3469006680b1e7946f3426177d0368a3
+  data.tar.gz: 1b3029f0f0eb3f0c6b583e4c025f8ab5d53dba8bfeed197e6e8ffc3c08ebf473
 SHA512:
-  metadata.gz: 773f2e7c8d4d11b1f33003645d3b3343d84ac96909ba2209aabe43d34ba0908ffb7d93d0ee9b95da9b4a1f14c7babe71269f7798e6f43b583959a66e2f801c14
-  data.tar.gz: 703fe39e39b45026fdc17fd93439701ca5c1632da57e97f2b81385d79fd1396e896dff1700cac85d7e0f16108443b04108e472f41c6e0f87147ecba754ca029f
+  metadata.gz: 6d4b55ba92ddfe5e7831da80ccdf170139a6b8f3459be07d35bfc877ee0638cbcaf15f98d7215f01b017510bb4d8458cf45e229acca7b3dc5d5fa2054e8f00b1
+  data.tar.gz: e35feff6cb0a82ece59cf57cb4bde0b0f9d7ea5989ff307c17211045fee78fff1dafbbcc8aaec34be3249e14c784679569d2d9d8dfc773124033592cc82189cf

data/README.md

@@ -5,7 +5,7 @@
 Add in your Gemfile
 
 ```rb
-gem 'magento', '~> 0.20.0'
+gem 'magento', '~> 0.23.0'
 ```
 
 or run
@@ -614,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/params/create_product.rb

@@ -4,33 +4,33 @@ require_relative 'create_custom_attribute'
 module Magento
   module Params
     # Example
-    # 
-    # params = Magento::Params::CreateProduct.new(
-    #   sku: '556-teste-builder',
-    #   name: 'REFRIGERANTE PET COCA-COLA 1,5L ORIGINAL',
-    #   description: 'Descrição do produto',
-    #   brand: 'Coca-Cola',
-    #   price: 4.99,
-    #   special_price: 3.49,
-    #   quantity: 2,
-    #   weight: 0.3,
-    #   attribute_set_id: 4,
-    #   images: [
-    #     *Magento::Params::CreateImage.new(
-    #       path: 'https://urltoimage.com/image.jpg',
-    #       title: 'REFRIGERANTE PET COCA-COLA 1,5L ORIGINAL',
-    #       position: 0,
-    #       main: true
-    #     ).variants, # it's generate all variants thumbnail => '100x100', small_image => '300x300' and image => '800x800'
-    #     Magento::Params::CreateImage.new(
-    #       path: '/path/to/image.jpg',
-    #       title: 'REFRIGERANTE PET COCA-COLA 1,5L ORIGINAL',
-    #       position: 1
-    #     )
-    #   ]
-    # )
     #
-    # Magento::Product.create(params.to_h)
+    #   params = Magento::Params::CreateProduct.new(
+    #     sku: '556-teste-builder',
+    #     name: 'REFRIGERANTE PET COCA-COLA 1,5L ORIGINAL',
+    #     description: 'Descrição do produto',
+    #     brand: 'Coca-Cola',
+    #     price: 4.99,
+    #     special_price: 3.49,
+    #     quantity: 2,
+    #     weight: 0.3,
+    #     attribute_set_id: 4,
+    #     images: [
+    #       *Magento::Params::CreateImage.new(
+    #         path: 'https://urltoimage.com/image.jpg',
+    #         title: 'REFRIGERANTE PET COCA-COLA 1,5L ORIGINAL',
+    #         position: 0,
+    #         main: true
+    #       ).variants, # it's generate all variants thumbnail => '100x100', small_image => '300x300' and image => '800x800'
+    #       Magento::Params::CreateImage.new(
+    #         path: '/path/to/image.jpg',
+    #         title: 'REFRIGERANTE PET COCA-COLA 1,5L ORIGINAL',
+    #         position: 1
+    #       )
+    #     ]
+    #   )
+    #
+    #   Magento::Product.create(params.to_h)
     # 
     class CreateProduct < Dry::Struct
       ProductTypes = Type::String.default('simple'.freeze).enum(

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,29 @@ module Magento
       )
     end
 
+    #
+    # Remove tier price
+    #
+    #   product = Magento::Product.find(1)
+    #   product.remove_tier_price(quantity: 1, customer_group_id: :all)
+    #
+    # @return {Boolean}
+    def remove_tier_price(quantity:, customer_group_id: :all)
+      self.class.remove_tier_price(
+        sku, quantity: quantity, customer_group_id: customer_group_id
+      )
+    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 +97,29 @@ module Magento
           "products/#{sku}/group-prices/#{customer_group_id}/tiers/#{quantity}/price/#{price}"
         ).parse
       end
+
+      # Remove tier price
+      #
+      #   Product.remove_tier_price('sku', quantity: 1, customer_group_id: :all)
+      # 
+      # @return {Boolean}
+      def remove_tier_price(sku, quantity:, customer_group_id: :all)
+        request.delete(
+          "products/#{sku}/group-prices/#{customer_group_id}/tiers/#{quantity}"
+        ).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.20.0'
+  VERSION = '0.23.0'
 end

metadata

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