magento 0.21.1 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15c67c62a1922aae194eab45cae0684451a565ff8d7897fd914e8f4c7f2b9934
-  data.tar.gz: 0a75750bf4e0976d81b72d69398d05ca5e7d63ea3588fe161ff6dd46d4223f7f
+  metadata.gz: 05b964b40491a1dc85eab1440137ab38089116468c2bd1d4d3fc86cd63a2c106
+  data.tar.gz: 38f1348057912147922411e91494621e3fc8ad7047b6c275f5ce9be9d67b3eb7
 SHA512:
-  metadata.gz: 02e95ff4336f3312a98acd8158decb1f66241f1183bb75de941f75c2cedaa7705ffcc732a9d8cb73d925cbd5f22a4404f42462bc8be46bfe86d219e880d45949
-  data.tar.gz: 4f70b1965fcaeaf3f67bafee6a2a3f4d2f38296f11eb591f0e42302d796f0b4c810851facfd3d9c757d9fb97d1c4d4e996d653b6c46e4b8184205522560a655b
+  metadata.gz: ea2acea7866041af1c49d8d453fc52c483aa4d0d9e99bc3620447e50630f6e0aec0724a29536fc1f3e9081c88684b6f4a83a9c1b3c9ac6ef1e71fdf662e4478c
+  data.tar.gz: 69593620dfafef7a3e2290471afc6278e4de583cb3762b23a0c891d63680df3d694e2bdbfda05caff0651b907cd6648938e37ca7a7d6f2ce5cecbb8635e49da1

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/.gitignore

@@ -7,7 +7,6 @@
 coverage
 InstalledFiles
 lib/bundler/man
-pkg
 rdoc
 spec/reports
 test/tmp
@@ -25,4 +24,7 @@ test/vcr_cassettes
 
 .vscode
 .byebug_history
-/manual_test
+/manual_test
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

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.21.1'
+gem 'magento', '~> 0.26.0'
 ```
 
 or run
@@ -643,6 +643,24 @@ Inventory.is_product_salable_for_requested_qty(
 }
 ```
 
+## 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:
@@ -662,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'

data/lib/magento/order.rb

@@ -61,6 +61,10 @@ module Magento
       self.class.ship(id, params)
     end
 
+    def send_email
+      self.class.send_email(id)
+    end
+
     class << self
       def update(entity_id, attributes)
         attributes[:entity_id] = entity_id
@@ -172,6 +176,10 @@ module Magento
       def ship(order_id, shipment_params = nil)
         request.post("order/#{order_id}/ship", shipment_params).parse
       end
+
+      def send_email(order_id)
+        request.post("orders/#{order_id}/emails").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/params/create_product_link.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Magento
+  module Params
+    class CreateProductLink < Dry::Struct
+      LinkType = Type::String.enum(
+        'related',
+        'upsell',
+        'crosssell',
+        'associated'
+      )
+
+      attribute :link_type,           LinkType
+      attribute :linked_product_sku,  Type::String
+      attribute :linked_product_type, Magento::Params::CreateProduct::ProductTypes
+      attribute :position,            Type::Integer
+      attribute :sku,                 Type::String
+
+      def to_h
+        {
+          link_type: link_type,
+          linked_product_sku: linked_product_sku,
+          linked_product_type: linked_product_type,
+          position: position,
+          sku: sku
+        }
+      end
+    end
+  end
+end

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
@@ -25,7 +47,6 @@ 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
@@ -44,6 +65,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 +110,37 @@ 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
+
+      def create_links(sku, product_links)
+        request.post("products/#{sku}/links", { items: product_links })
+      end
+
+      def remove_link(sku, link_type:, linked_product_sku:)
+        request.delete("products/#{sku}/links/#{link_type}/#{linked_product_sku}")
+      end
     end
   end
 end

data/lib/magento/query.rb

@@ -23,7 +23,7 @@ module Magento
       'to'       # The end of a range. Must be used with from
     ].freeze
 
-    def initialize(model, request: Request.new)
+    def initialize(model, request: Request.new, api_resource: nil)
       @model = model
       @request = request
       @filter_groups = nil
@@ -31,6 +31,7 @@ module Magento
       @page_size = 50
       @sort_orders = nil
       @fields = nil
+      @endpoint = api_resource || model.api_resource
     end
 
     def where(attributes)
@@ -131,7 +132,7 @@ module Magento
     attr_accessor :current_page, :filter_groups, :request, :sort_orders, :model, :fields
 
     def endpoint
-      model.api_resource
+      @endpoint
     end
 
     def verify_id(field)

data/lib/magento/sales_rule.rb

@@ -27,6 +27,10 @@ module Magento
       def generate_coupon(attributes)
         request.post('coupons/generate', attributes).parse
       end
+
+      protected def query
+        Query.new(self, api_resource: 'salesRules/search')
+      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.21.1'
+  VERSION = '0.26.0'
 end

data/spec/magento/order_spec.rb

@@ -0,0 +1,38 @@
+class RequestMock
+  attr_reader :path
+
+  def post(path)
+    @path = path
+    OpenStruct.new(success?: true, parse: true)
+  end
+end
+
+RSpec.describe Magento::Order do
+  before { Magento.url = 'https://site.com' }
+
+  describe '.send_email' do
+    it 'shuld request POST /orders/:id/emails' do
+      request = RequestMock.new
+      allow(Magento::Order).to receive(:request).and_return(request)
+
+      order_id = 25
+      result = Magento::Order.send_email(order_id)
+
+      expect(request.path).to eql("orders/#{order_id}/emails")
+      expect(result).to be true
+    end
+  end
+
+  describe '#send_email' do
+    it 'shuld request POST /orders/:id/emails' do
+      request = RequestMock.new
+      allow(Magento::Order).to receive(:request).and_return(request)
+
+      order = Magento::Order.build(id: 25)
+      result = order.send_email
+
+      expect(request.path).to eql("orders/25/emails")
+      expect(result).to be true
+    end
+  end
+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.21.1
+  version: 0.26.0
 platform: ruby
 authors:
 - Wallas Faria
@@ -88,8 +88,12 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/gem-push.yml"
 - ".gitignore"
+- ".rspec"
 - Gemfile
 - README.md
+- Rakefile
+- bin/console
+- bin/setup
 - lib/magento.rb
 - lib/magento/category.rb
 - lib/magento/configuration.rb
@@ -113,6 +117,7 @@ files:
 - lib/magento/params/create_custom_attribute.rb
 - lib/magento/params/create_image.rb
 - lib/magento/params/create_product.rb
+- lib/magento/params/create_product_link.rb
 - lib/magento/polymorphic_model.rb
 - lib/magento/product.rb
 - lib/magento/query.rb
@@ -150,8 +155,11 @@ files:
 - lib/magento/shared/total.rb
 - lib/magento/shared/value.rb
 - lib/magento/version.rb
-- magento-ruby.gemspec
 - magento.gemspec
+- spec/magento/order_spec.rb
+- 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