magento 0.13.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77636870e263ab5add82976ce07571f75de8d2e70aa89d7e5a371366868e2400
-  data.tar.gz: 0ccf949f28c60fd7eefb8e3388429edeab872d18c9855088c5a6183b947dc9f7
+  metadata.gz: 54c756e43ba125d24cfd2695f5b3b362acf6a489cb0ccc7b7abd853b8488164c
+  data.tar.gz: 103375f7ba57dae9d78e93d19e0cb95d6192365390b4d05005c465eea6737908
 SHA512:
-  metadata.gz: b685a13443e7c996a69a5079c29baccc26ff16fb3d6a630b94e07b21efec5f5f35a93ec36de7986f4881c36791d8a0cb59578cc1c7aaa7e29bf1393b5176a863
-  data.tar.gz: 97ff1f26eef308c00d19c608045eee47c2a43cc254ca3cfd6cc06fc59853aa16a16e23241f45cffe9aaa5cb7625b456c37dcd58d79dd1959ae155a748582c0dd
+  metadata.gz: d839bf8cc47b2a7e639de881d2e8505cd8b3bb2d52428a1e8c58438e96e3bbf84392ccf22498b393a5ec60b812afca078e9f2cd33568f2475081501601f0c919
+  data.tar.gz: 3192fd700e6356b0a58039b26fe8c5b25ab577328d67cce6a4495465f84c4dc9f6aa48e37cacbaafc7068b61ac91a983fe7b41287ff4316920b09951079a0dcf

data/README.md

@@ -5,7 +5,7 @@
 Add in your Gemfile
 
 ```rb
-gem 'magento', '~> 0.13.0'
+gem 'magento', '~> 0.15.1'
 ```
 
 or run
@@ -339,6 +339,28 @@ cart.payment_information(
 >> "234575" # return the order id
 ```
 
+Add coupon to cart
+```rb
+cart = Magento::GuestCart.find('gXsepZcgJbY8RCJXgGioKOO9iBCR20r7')
+
+cart.add_coupon('COAU4HXE0I')
+# You can also use the class method
+Magento::GuestCart.add_coupon('gXsepZcgJbY8RCJXgGioKOO9iBCR20r7', 'COAU4HXE0I')
+
+>> true # return true on success
+```
+
+Delete coupon from cart
+```rb
+cart = Magento::GuestCart.find('gXsepZcgJbY8RCJXgGioKOO9iBCR20r7')
+
+cart.delete_coupon()
+# You can also use the class method
+Magento::GuestCart.delete_coupon('gXsepZcgJbY8RCJXgGioKOO9iBCR20r7')
+
+>> true # return true on success
+```
+
 ## Invoice an Order
 
 ```rb
@@ -540,7 +562,7 @@ rule = Magento::SalesRule.create(
 rule.generate_coupon(quantity: 1, length: 10)
 ```
 
-Renarate by class method
+Generate by class method
 ```rb
 Magento::SalesRule.generate_coupon(
   couponSpec: {
@@ -553,6 +575,8 @@ Magento::SalesRule.generate_coupon(
 see all params in:
 - [Magento docs Coupon](https://magento.redoc.ly/2.3.5-admin/tag/couponsgenerate#operation/salesRuleCouponManagementV1GeneratePost)
 - [Magento docs SalesRules](https://magento.redoc.ly/2.3.5-admin/tag/salesRules#operation/salesRuleRuleRepositoryV1SavePost)
+	
+See [how to add coupons to cart](#guestcart)
 
 ### First result
 ```rb

data/lib/magento.rb

@@ -21,6 +21,7 @@ require_relative 'magento/order'
 require_relative 'magento/invoice'
 require_relative 'magento/guest_cart'
 require_relative 'magento/sales_rule'
+require_relative 'magento/import'
 
 Dir[File.expand_path('magento/shared/*.rb', __dir__)].map { |f| require f }
 Dir[File.expand_path('magento/params/*.rb', __dir__)].map { |f| require f }
@@ -42,12 +43,12 @@ module Magento
   self.token          = ENV['MAGENTO_TOKEN']
   self.store          = ENV['MAGENTO_STORE'] || :all
 
-  def self.with_config(utl: Magento.url, token: Magento.token, store: Magento.store)
+  def self.with_config(url: Magento.url, token: Magento.token, store: Magento.store)
     @old_url   = self.url
     @old_token = self.token
     @old_store = self.store
-    
-    self.url   = utl
+
+    self.url   = url
     self.token = token
     self.store = store
 

data/lib/magento/guest_cart.rb

@@ -32,6 +32,29 @@ module Magento
       self.class.payment_information(attributes)
     end
 
+    #
+    # Add a coupon by code to the current cart.
+    #
+    # Example
+    # cart = Magento::GuestCart.find('gXsepZcgJbY8RCJXgGioKOO9iBCR20r7')
+    # cart.add_coupon('COAU4HXE0I')
+    #
+    # @return Boolean: true on success, false otherwise
+    def add_coupon(coupon)
+      self.class.add_coupon(cart_id, coupon)
+    end
+
+    # Delete cart's coupon
+    #
+    # Example:
+    # cart = Magento::GuestCart.find('gXsepZcgJbY8RCJXgGioKOO9iBCR20r7')
+    # cart.delete_coupon()
+    #
+    # @return Boolean: true on success, raise exception otherwise
+    def delete_coupon
+      self.class.delete_coupon(cart_id)
+    end
+
     class << self
       def create(load_cart_info: false)
         cart = build(cart_id: request.post(api_resource).parse)
@@ -64,6 +87,33 @@ module Magento
         hash = request.post(url, attributes).parse
         Magento::ModelMapper.map_hash(Magento::Item, hash)
       end
+
+      # 
+      # Add a coupon by code to a specified cart.
+      #
+      # Example
+      # Magento::GuestCart.add_coupon(
+      #   'aj8oUtY1Qi44Fror6UWVN7ftX1idbBKN',
+      #   'COAU4HXE0I'
+      # )
+      #
+      # @return Boolean: true on success, false otherwise
+      def add_coupon(id, coupon)
+        url = "#{api_resource}/#{id}/coupons/#{coupon}"
+        request.put(url, nil).parse
+      end
+
+      #
+      # Delete a coupon from a specified cart.
+      #
+      # Example:
+      # Magento::GuestCart.delete_coupon('aj8oUtY1Qi44Fror6UWVN7ftX1idbBKN')
+      #
+      # @return Boolean: true on success, raise exception otherwise
+      def delete_coupon(id)
+        url = "#{api_resource}/#{id}/coupons"
+        request.delete(url).parse
+      end
     end
   end
 end

data/lib/magento/import.rb

@@ -0,0 +1,13 @@
+require_relative 'import/csv_reader'
+require_relative 'import/category'
+require_relative 'import/product'
+
+module Magento
+  module Import
+    def self.from_csv(file, image_path:, website_ids: [0])
+      products = CSVReader.new(file).get_products
+      products = Category.new(products).associate
+      Product.new(image_path, website_ids).import(products)
+    end
+  end
+end

data/lib/magento/import/category.rb

@@ -0,0 +1,51 @@
+module Magento
+  module Import
+    class Category
+      def initialize(products)
+        @products = products
+        @category_root = Magento::Category.all
+        @cats = @category_root.children_data
+      end
+
+      def associate
+        @products.each do |prod|
+          cat1 = find_or_create(name: prod.cat1, parent: @category_root) if prod.cat1
+          cat2 = find_or_create(name: prod.cat2, parent: cat1) if prod.cat2
+          cat3 = find_or_create(name: prod.cat3, parent: cat2) if prod.cat3
+
+          prod.cat1, prod.cat2, prod.cat3 = cat1&.id, cat2&.id, cat3&.id
+
+          @cats.push(*[cat1, cat2, cat3].compact)
+        end
+      end
+
+      private
+
+      def find_or_create(name:, parent:)
+        find(name, cats: @cats, parent_id: parent.id) || create(name, parent: parent)
+      end
+
+      def find(name, cats:, parent_id:)
+        cats.each do |cat|
+          return cat if cat.name == name && cat.parent_id == parent_id
+
+          if cat.respond_to?(:children_data) && cat.children_data&.size.to_i > 0
+            result = find(name, cats: cat.children_data, parent_id: parent_id)
+            return result if result
+          end
+        end
+        nil
+      end
+
+      def create(name, parent:)
+        params = Magento::Params::CreateCategoria.new(
+          name: name,
+          parent_id: parent.id,
+          url: "#{Magento.store}-#{parent.id}-#{name.parameterize}"
+        )
+
+        Magento::Category.create(params.to_h).tap { |c| puts "Create: #{c.id} => #{c.name}" }
+      end
+    end
+  end
+end

data/lib/magento/import/csv_reader.rb

@@ -0,0 +1,30 @@
+require 'csv'
+require 'ostruct'
+
+module Magento
+  module Import
+    class CSVReader
+      def initialize(csv_file)
+        @csv = CSV.read(csv_file, col_sep: ';')
+      end
+
+      def get_products
+        @csv[1..].map do |row|
+          name, sku, ean, description, price, special_price, quantity, cat1, cat2, cat3 = row
+          OpenStruct.new({
+            name: name,
+            sku: sku,
+            ean: ean,
+            description: description,
+            price: price,
+            special_price: special_price,
+            quantity: quantity,
+            cat1: cat1,
+            cat2: cat2,
+            cat3: cat3
+          })
+        end
+      end
+    end
+  end
+end

data/lib/magento/import/product.rb

@@ -0,0 +1,63 @@
+module Magento
+  module Import
+    class Product
+      def initialize(images_path, website_ids)
+        @images_path = images_path
+        @website_ids = website_ids
+      end
+  
+      def import(products)
+        products.each do |product|
+          params = Magento::Params::CreateProduct.new(
+            sku: product.sku,
+            name: product.name.gsub(/[ ]+/, ' '),
+            description: product.description || product.name,
+            brand: product.brand,
+            price: product.price.to_f,
+            special_price: product.special_price ? product.special_price.to_f : nil,
+            quantity: numeric?(product.quantity) ? product.quantity.to_f : 0,
+            weight: 0.3,
+            manage_stock: numeric?(product.quantity),
+            attribute_set_id: 4,
+            category_ids: [product.cat1, product.cat2, product.cat3].compact,
+            website_ids: @website_ids,
+            images: images(product)
+          ).to_h
+  
+          product = Magento::Product.create(params)
+  
+          puts "Produto criado: #{product.sku} => #{product.name}"
+        rescue => e
+          puts "Erro ao criado: #{product.sku} => #{product.name}"
+          puts " - Detalhes do erro: #{e}"
+        end
+      end
+  
+      private
+  
+      def images(product)
+        image = find_image(product)
+        return [] unless image
+  
+        Magento::Params::CreateImage.new(
+          path: image,
+          title: product.name,
+          position: 0,
+          main: true
+        ).variants
+      end
+  
+      def find_image(product)
+        prefix = "#{@images_path}/#{product.sku}"
+  
+        extensions = %w[jpg jpeg png webp]
+        extensions.map { |e| ["#{prefix}.#{e}", "#{prefix}.#{e.upcase}"] }.flatten
+                  .find { |file| File.exist?(file) }
+      end
+  
+      def numeric?(value)
+        !!(value.to_s =~ /^[\d]+$/)
+      end
+    end
+  end
+end

data/lib/magento/params/create_category.rb

@@ -4,17 +4,17 @@ module Magento
   module Params
     class CreateCategoria < Dry::Struct
       attribute :name,      Type::String
-      attribute :parent_id, Type::String.optional
-      attribute :path,      Type::String.optional
+      attribute :parent_id, Type::Integer.optional
+      attribute :url,       Type::String.optional.default(nil)
       attribute :is_active, Type::Bool.default(true)
 
       def to_h
         {
-          "name": name,
-          "parent_id": parent_id,
-          "is_active": is_active,
-          "path": path
-        }
+          name: name,
+          parent_id: parent_id,
+          is_active: is_active,
+          custom_attributes: url ? [{attribute_code: 'url_key', value: url }] : nil
+        }.compact
       end
     end
   end

data/lib/magento/params/create_image.rb

@@ -36,7 +36,7 @@ module Magento
 
       def variants
         VARIANTS.keys.map do |size|
-          CreateImage.new(attributes.merge(size: size, disabled: size != :large))
+          CreateImage.new(attributes.merge(size: size, disabled: size != 'large'))
         end
       end
 
@@ -49,6 +49,7 @@ module Magento
       def file
         @file ||= MiniMagick::Image.open(path).tap do |b|
           b.resize VARIANTS[size][:size]
+          b.format 'jpg'
           b.strip
         end
       end

data/lib/magento/params/create_product.rb

@@ -54,7 +54,7 @@ module Magento
       attribute :sku,               Type::String
       attribute :name,              Type::String
       attribute :description,       Type::String
-      attribute :brand,             Type::String
+      attribute :brand,             Type::String.optional.default(nil)
       attribute :price,             Type::Coercible::Float
       attribute :special_price,     Type::Float.optional.default(nil)
       attribute :attribute_set_id,  Type::Integer
@@ -116,7 +116,7 @@ module Magento
           qty_increments: 0,
           use_config_enable_qty_inc: true,
           enable_qty_increments: true,
-          use_config_manage_stock: true,
+          use_config_manage_stock: manage_stock,
           manage_stock: manage_stock,
           low_stock_date: 'string',
           is_decimal_divided: is_qty_decimal,
@@ -128,10 +128,11 @@ module Magento
         default_attributes = [
           CustomAttribute.new(attribute_code: 'description', value: description),
           CustomAttribute.new(attribute_code: 'url_key', value: name.parameterize ),
-          CustomAttribute.new(attribute_code: 'product_brand', value: brand ),
           CustomAttribute.new(attribute_code: 'featured', value: featured)
         ]
 
+        default_attributes.push(CustomAttribute.new(attribute_code: 'product_brand', value: brand)) if brand
+
         if special_price.to_f > 0
           default_attributes << CustomAttribute.new(attribute_code: 'special_price', value: special_price.to_s)
         end

data/lib/magento/query.rb

@@ -85,8 +85,11 @@ module Magento
 
     def all
       result = request.get("#{endpoint}?#{query_params}").parse
-      field  = model == Magento::Category ? 'children_data' : 'items'
-      RecordCollection.from_magento_response(result, model: model, iterable_field: field)
+      if model == Magento::Category
+        model.build(result)
+      else
+        RecordCollection.from_magento_response(result, model: model)
+      end
     end
 
     def first

data/lib/magento/request.rb

@@ -53,7 +53,7 @@ module Magento
 
       begin
         msg = resp.parse['message']
-        errors = resp.parse['errors']
+        errors = resp.parse['errors'] || resp.parse['parameters']
         if resp.parse['parameters'].is_a? Hash
           resp.parse['parameters'].each { |k, v| msg.sub! "%#{k}", v }
         end

data/lib/magento/version.rb

@@ -1,3 +1,3 @@
 module Magento
-  VERSION = '0.13.0'
+  VERSION = '0.16.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magento
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Wallas Faria
@@ -96,6 +96,10 @@ files:
 - lib/magento/customer.rb
 - lib/magento/errors.rb
 - lib/magento/guest_cart.rb
+- lib/magento/import.rb
+- lib/magento/import/category.rb
+- lib/magento/import/csv_reader.rb
+- lib/magento/import/product.rb
 - lib/magento/invoice.rb
 - lib/magento/model.rb
 - lib/magento/model_mapper.rb