magento 0.18.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41955a56a9aff31abc7c7c74adcc72eb84a11e00ebef0e169b40e89e218d3d0b
-  data.tar.gz: d4e846e5407872f2c2909585b148c85ede8f9552456dfd18886fa791c8b2f1e5
+  metadata.gz: 3369907b3576aff1a8d5199396f90b0431b629c9abf2a339917ace10ae3bdefa
+  data.tar.gz: 20149d57d54c0c5be44b1ca1b9006c429db2d254ff41272c201b68e2b6aa5c68
 SHA512:
-  metadata.gz: 5178cf1b839df2db8fd2c5c5e9c891ebdff52f2d1ce2f896c6a3a8d0f7b607960a19cfcadfece2c53289b1637c2cc613b3632b0c8bf564513e71033d2cfcfe93
-  data.tar.gz: 28522d689e5c6a718275174c531e585c26cef4a07347b9ebd70346761a696cc87260aa809acc98fc0f9b883b9ee0c5140b0ecde3e19101ca426dab36227f003c
+  metadata.gz: cd086b7748e54381a71f96af6d1356e6124ca97b169df488ff330a21de63ec4a702dc53c28ad964e4fbbcdc0ed314e83f4ffc5e400264b04de74fc1aaab964d7
+  data.tar.gz: 580ed9f180845668b33a46b88ab237b56e99b4237fe0d3131452b3abe7bd694d48f342b93108d85069550bc241437a503c888e6994c8aad434794def55cc8765

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.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')
@@ -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
+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/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 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/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.0'
+  VERSION = '0.21.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magento
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Wallas Faria
@@ -98,11 +98,12 @@ files:
 - lib/magento/errors.rb
 - lib/magento/guest_cart.rb
 - lib/magento/import.rb
-- lib/magento/import/Image_finder.rb
 - lib/magento/import/category.rb
 - lib/magento/import/csv_reader.rb
+- 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