magento 0.20.1 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68aa93fb639c7e6d3cab0a521e91c08d38aa28dd7d508f50190ce9e718ed8022
-  data.tar.gz: ccde7c0ccbe949e12fb97fab1c80d2dfbc18c9e8de80181b0e0dab1c763f0ee6
+  metadata.gz: 6cc3c4705cb31c6aab0ee3e39b0513bd9e21fa7f98fa6c0564e832a01c488b68
+  data.tar.gz: 20354ed49b5e998940775d8e3f07aea5ca0a0e2be5d482634c77528f3209e330
 SHA512:
-  metadata.gz: d5ddc1d9471997748938d0942e97125b0dd6620efda44c2d80d967968677595e6837bbfbcbd43eb92a9992a50fd8c2dbd3adfef880fb84e3f322ac1ba8400bd1
-  data.tar.gz: 631f5d649fa1bfde37f1b9662685ea400f967792b1ed293fc1d1fb20d5d49f775dacbba332f97736079dada2cc67aaecec8f6cd5ca41012537ef8a76fd61e401
+  metadata.gz: 8e927a070c8b469cc0b3019ca27c9d74c51cb270b4165e3fb2343fd3c54d406d0d33507ad2aba9a53250d4c513e70eeb3c92adea579c0b2c775e23667e4fd1c8
+  data.tar.gz: f91fd2fcaca2777d599eac5eb665553adf5054eaa8a42593c2bad95226b953c43e14e1e7687e4c64c4351cc9f6e05fc35b3edd1e181fcd99976f481706e2d791

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

@@ -22,6 +22,7 @@ jobs:
         touch $HOME/.gem/credentials
         chmod 0600 $HOME/.gem/credentials
         printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        sed "s/'magento'/'magento-ruby'/" magento.gemspec > magento-ruby.gemspec
         gem build magento-ruby.gemspec
         gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
       env:

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rspec_status

@@ -0,0 +1,5 @@
+example_id                      | status | run_time        |
+------------------------------- | ------ | --------------- |
+./spec/magento_spec.rb[1:1]     | passed | 0.00057 seconds |
+./spec/product_spec.rb[1:1:1:1] | passed | 0.00102 seconds |
+./spec/product_spec.rb[1:1:2:1] | passed | 0.00111 seconds |

data/Gemfile

@@ -4,3 +4,7 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in magento.gemspec
 gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem 'byebug', '~> 11.1', '>= 11.1.3'

data/README.md

@@ -5,7 +5,7 @@
 Add in your Gemfile
 
 ```rb
-gem 'magento', '~> 0.20.1'
+gem 'magento', '~> 0.24.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:
@@ -633,3 +680,14 @@ Magento::Product.where(name_like: 'some name%').last
 ```
 
 ### Tests
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/WallasFaria/nfce_crawler.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+Bundler::GemHelper.install_tasks name: 'magento'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "magento"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/magento.rb

@@ -4,6 +4,7 @@ require 'time'
 require 'dry/inflector'
 require 'active_support/core_ext/string/inflections'
 require 'active_support/core_ext/hash/keys'
+require 'active_support/core_ext/module/delegation'
 
 require_relative 'magento/configuration'
 require_relative 'magento/errors'
@@ -22,6 +23,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 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,12 +6,34 @@ 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)
       @custom_attributes&.find { |a| a.attribute_code == attribute_code.to_s }&.value
     end
 
+    def set_custom_attribute(code, value)
+      @custom_attributes ||= []
+      attribute = @custom_attributes.find { |a| a.attribute_code == code.to_s }
+
+      if attribute
+        attribute.value = value
+      else
+        @custom_attributes << Magento::CustomAttribute.build(
+          attribute_code: code.to_s,
+          value: value
+        )
+      end
+    end
+
     def respond_to?(attribute_code)
       super || @custom_attributes&.any? { |a| a.attribute_code == attribute_code.to_s }
     end
@@ -44,6 +66,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 +111,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/shared/custom_attribute.rb

@@ -1,4 +1,5 @@
 module Magento
   class CustomAttribute
+    include Magento::ModelParser
   end
 end

data/lib/magento/version.rb

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

data/spec/magento_spec.rb

@@ -0,0 +1,5 @@
+RSpec.describe Magento do
+  it "has a version number" do
+    expect(Magento::VERSION).not_to be nil
+  end
+end

data/spec/product_spec.rb

@@ -0,0 +1,31 @@
+RSpec.describe Magento::Product do
+  describe '#set_custom_attribute' do
+    let(:product) { Magento::Product.build(
+      sku: 25,
+      custom_attributes: [
+        { attribute_code: 'description', value: 'Some description' }
+      ]
+    ) }
+
+    context 'when the custom attribute already exists' do
+      it 'must change the attribute value' do
+        expect(product.description).to eql('Some description')
+        product.set_custom_attribute(:description, 'description updated')
+        expect(product.attr(:description)).to eql('description updated')
+      end
+    end
+
+    context 'when the custom attribute does not exists' do
+      it 'must add a new attribute' do
+        expect(product.attr(:new_attribute)).to be_nil
+        expect(product.attr(:other_new_attribute)).to be_nil
+
+        product.set_custom_attribute(:new_attribute, 'value')
+        product.set_custom_attribute('other_new_attribute', [1, 2])
+
+        expect(product.attr(:new_attribute)).to eql('value')
+        expect(product.attr(:other_new_attribute)).to eql([1, 2])
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require "bundler/setup"
+require 'byebug'
+require "magento"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magento
 version: !ruby/object:Gem::Version
-  version: 0.20.1
+  version: 0.24.0
 platform: ruby
 authors:
 - Wallas Faria
@@ -88,8 +88,13 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/gem-push.yml"
 - ".gitignore"
+- ".rspec"
+- ".rspec_status"
 - Gemfile
 - README.md
+- Rakefile
+- bin/console
+- bin/setup
 - lib/magento.rb
 - lib/magento/category.rb
 - lib/magento/configuration.rb
@@ -103,6 +108,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
@@ -149,8 +155,10 @@ files:
 - lib/magento/shared/total.rb
 - lib/magento/shared/value.rb
 - lib/magento/version.rb
-- magento-ruby.gemspec
 - magento.gemspec
+- spec/magento_spec.rb
+- spec/product_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/WallasFaria/magento-ruby
 licenses: []
 metadata: {}

data/magento-ruby.gemspec

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require 'magento/version'
-
-Gem::Specification.new do |s|
-  s.name          = 'magento-ruby'
-  s.version       = Magento::VERSION
-  s.date          = '2020-07-31'
-  s.summary       = 'Magento Ruby library'
-  s.description   = 'Magento Ruby library'
-  s.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
-  s.authors       = ['Wallas Faria']
-  s.email         = 'wallasfaria@hotmail.com'
-  s.homepage      = 'https://github.com/WallasFaria/magento-ruby'
-  s.require_paths = ['lib']
-
-  s.add_dependency 'dry-inflector', '~> 0.2.0'
-  s.add_dependency 'http', '~> 4.4'
-  s.add_dependency 'dry-struct'
-  s.add_dependency 'activesupport'
-  s.add_dependency 'mini_magick'
-end