magento 0.18.1 → 0.21.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bab9845aefc480901b6d4fae6181054bcb4337f52c7ecdcb5c43d9256489c498
-  data.tar.gz: 31510059e22ae9c29eb9ad8d134122342fc58330ca6f382867f530e700035aef
+  metadata.gz: 15c67c62a1922aae194eab45cae0684451a565ff8d7897fd914e8f4c7f2b9934
+  data.tar.gz: 0a75750bf4e0976d81b72d69398d05ca5e7d63ea3588fe161ff6dd46d4223f7f
 SHA512:
-  metadata.gz: 7a03f247c66668011492453cc90e146968cc39c1ead0dc8823593187f3169a5cd63885f0d5bc53abd781840520df0a7c026228fcf9a501f8338ea342b7874ab7
-  data.tar.gz: cce4a8ee5d5abe1b4c6d2f93e11aa21b5724e6965c9c6812a31020967c56d8b572ef2e92012346b7848de2da3e9e56189be663b0a9a05ae7155d75e29712a272
+  metadata.gz: 02e95ff4336f3312a98acd8158decb1f66241f1183bb75de941f75c2cedaa7705ffcc732a9d8cb73d925cbd5f22a4404f42462bc8be46bfe86d219e880d45949
+  data.tar.gz: 4f70b1965fcaeaf3f67bafee6a2a3f4d2f38296f11eb591f0e42302d796f0b4c810851facfd3d9c757d9fb97d1c4d4e996d653b6c46e4b8184205522560a655b

data/.github/workflows/gem-push.yml

@@ -3,8 +3,6 @@ name: Ruby Gem
 on:
   push:
     branches: [ release ]
-  pull_request:
-    branches: [ release ]
 
 jobs:
   build:

data/README.md

@@ -5,7 +5,7 @@
 Add in your Gemfile
 
 ```rb
-gem 'magento', '~> 0.15.1'
+gem 'magento', '~> 0.21.1'
 ```
 
 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')
@@ -83,6 +85,23 @@ product.respond_to? :description
 > true
 ```
 
+## add tier price
+
+Add `price` on product `sku` for specified `customer_group_id`
+
+Param `quantity` is the minimun amount to apply the price
+
+```rb
+product = Magento::Product.find(1)
+product.add_tier_price(3.99, quantity: 1, customer_group_id: :all)
+> true
+
+# OR
+
+Magento::Product.add_tier_price(1, 3.99, quantity: 1, customer_group_id: :all)
+> true
+```
+
 ## Get List
 
 ```rb
@@ -595,6 +614,35 @@ 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"
+    },
+    ...
+  ]
+}
+```
+
 ___
 
 ##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

@@ -25,6 +25,25 @@ module Magento
       self.class.remove_media(sku, media_id)
     end
 
+    # 
+    # Add {price} on product {sku} for specified {customer_group_id}
+    # 
+    # Param {quantity} is the minimun amount to apply the price
+    # 
+    # product = Magento::Product.find(1)
+    # product.add_tier_price(3.99, quantity: 1, customer_group_id: :all)
+    # 
+    # OR
+    # 
+    # Magento::Product.add_tier_price(1, 3.99, quantity: 1, customer_group_id: :all)
+    # 
+    # @return {Boolean}
+    def add_tier_price(price, quantity:, customer_group_id: :all)
+      self.class.add_tier_price(
+        sku, price, quantity: quantity, customer_group_id: customer_group_id
+      )
+    end
+
     class << self
       alias_method :find_by_sku, :find
 
@@ -36,6 +55,17 @@ module Magento
       def remove_media(sku, media_id)
         request.delete("products/#{sku}/media/#{media_id}").parse
       end
+
+      # Add {price} on product {sku} for specified {customer_group_id}
+      # 
+      # Param {quantity} is the minimun amount to apply the price
+      # 
+      # @return {Boolean}
+      def add_tier_price(sku, price, quantity:, customer_group_id: :all)
+        request.post(
+          "products/#{sku}/group-prices/#{customer_group_id}/tiers/#{quantity}/price/#{price}"
+        ).parse
+      end
     end
   end
 end

data/lib/magento/version.rb

@@ -1,3 +1,3 @@
 module Magento
-  VERSION = '0.18.1'
+  VERSION = '0.21.1'
 end

metadata

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