magento 0.13.1 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb31fed59d9d16923e61b3f77d218087e2c2dc0e40912f59c0f0f447886ec6a4
-  data.tar.gz: 7d93a4d2dcef4ad968a7dacd9eb0445f7f6885791ef202873df555efad9fc4dd
+  metadata.gz: 73c1f0ddb533c84f3cb909d31a6349fc51237965c2e60ff92f23bf30da582454
+  data.tar.gz: f269b8b2a89e8c7726782cbc2638cff88ab020495807baa5ed39f874283ea657
 SHA512:
-  metadata.gz: 0b15c59d8eb5f07ebc3df8e875128463790c3a26f6e96f0b076404a3aa18c7760f0d66636f3292b596f0d527da180f1125a8789dc59ed38b769b215bf02be580
-  data.tar.gz: 193242af27b216087e158b95bd136ee9fc70b66ca0e68711e5eda257b854beba663949a70a385b495191b12273ded59fb7dec44595a28d52704a4fe5ea1f38d5
+  metadata.gz: d6efe97f07e753ef46abe67223d4503c605fbc4d060a0dfc0433f06134fa5b2e59088f7664b7f5e711598f46e801666b70912fcd9fdf38ea1760ef866b9edf76
+  data.tar.gz: 3c3b2c9b3f3d018665e9b0d2b47102a880194446bc8bb4423e002ead7ee345e42beda903f20843862987ad28751a5743a18ae77d100724c95d7884e772e8b9df

data/README.md

@@ -5,7 +5,7 @@
 Add in your Gemfile
 
 ```rb
-gem 'magento', '~> 0.13.1'
+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

@@ -5,6 +5,7 @@ require 'dry/inflector'
 require 'active_support/core_ext/string/inflections'
 require 'active_support/core_ext/hash/keys'
 
+require_relative 'magento/configuration'
 require_relative 'magento/errors'
 require_relative 'magento/request'
 require_relative 'magento/model_mapper'
@@ -21,13 +22,16 @@ 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 }
 
 module Magento
   class << self
-    attr_accessor :url, :open_timeout, :timeout, :token, :store
+    attr_writer :configuration
+
+    delegate :url=, :token=, :store=, :open_timeout=, :timeout=, to: :configuration
 
     def inflector
       @inflector ||= Dry::Inflector.new do |inflections|
@@ -36,26 +40,24 @@ module Magento
     end
   end
 
-  self.url            = ENV['MAGENTO_URL']
-  self.open_timeout   = 30
-  self.timeout        = 90
-  self.token          = ENV['MAGENTO_TOKEN']
-  self.store          = ENV['MAGENTO_STORE'] || :all
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
 
-  def self.with_config(utl: Magento.url, token: Magento.token, store: Magento.store)
-    @old_url   = self.url
-    @old_token = self.token
-    @old_store = self.store
-    
-    self.url   = utl
-    self.token = token
-    self.store = store
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
 
+  def self.with_config(params)
+    @old_configuration = configuration
+    self.configuration = configuration.copy_with(**params)
     yield
   ensure
-    self.url   = @old_url
-    self.token = @old_token
-    self.store = @old_store
+    @configuration = @old_configuration
   end
 
   def self.production?

data/lib/magento/configuration.rb

@@ -0,0 +1,31 @@
+module Magento
+  class Configuration
+    attr_accessor :url, :open_timeout, :timeout, :token, :store, :product_image
+  
+    def initialize(url: nil, token: nil, store: nil)
+      self.url            = url || ENV['MAGENTO_URL']
+      self.open_timeout   = 30
+      self.timeout        = 90
+      self.token          = token || ENV['MAGENTO_TOKEN']
+      self.store          = store || ENV['MAGENTO_STORE'] || :all
+
+      self.product_image  = ProductImageConfiguration.new
+    end
+  
+    def copy_with(params = {})
+      clone.tap do |config|
+        params.each { |key, value| config.send("#{key}=", value) }
+      end
+    end
+  end
+
+  class ProductImageConfiguration
+    attr_accessor :small_size, :medium_size, :large_size
+
+    def initialize
+      self.small_size  = '200x200>'
+      self.medium_size = '400x400>'
+      self.large_size  = '800x800>'
+    end
+  end
+end

data/lib/magento/customer.rb

@@ -33,7 +33,7 @@ module Magento
       end
 
       def find_by_token(token)
-        user_request = Request.new(token: token)
+        user_request = Request.new(config: Magento.configuration.copy_with(token: token))
         customer_hash = user_request.get('customers/me').parse
         build(customer_hash)
       end

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,18 @@
+require_relative 'import/image_finder'
+require_relative 'import/csv_reader'
+require_relative 'import/category'
+require_relative 'import/product'
+
+module Magento
+  module Import
+    def self.from_csv(file, images_folder: nil, website_ids: [0])
+      products = CSVReader.new(file).get_products
+      products = Category.new(products).associate
+      Product.new(website_ids, images_folder).import(products)
+    end
+
+    def self.get_csv_template
+      File.open(__dir__ + '/import/template/products.csv')
+    end
+  end
+end

data/lib/magento/import/Image_finder.rb

@@ -0,0 +1,18 @@
+module Magento
+  module Import
+    class ImageFinder
+      EXTENTIONS = %w[jpg jpeg png webp gif].freeze
+
+      def initialize(images_folder)
+        @images_folder = images_folder
+      end
+
+      def find_by_name(name)
+        prefix = "#{@images_folder}/#{name}"
+
+        EXTENTIONS.map { |e| ["#{prefix}.#{e}", "#{prefix}.#{e.upcase}"] }.flatten
+                  .find { |file| File.exist?(file) }
+      end
+    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.configuration.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|
+          OpenStruct.new({
+            name: row[0],
+            sku: row[1],
+            ean: row[2],
+            description: row[3],
+            price: row[4],
+            special_price: row[5],
+            quantity: row[6],
+            cat1: row[7],
+            cat2: row[8],
+            cat3: row[9],
+            main_image: row[10]
+          })
+        end
+      end
+    end
+  end
+end

data/lib/magento/import/product.rb

@@ -0,0 +1,59 @@
+require 'uri'
+
+module Magento
+  module Import
+    class Product
+      def initialize(website_ids, images_folder = nil)
+        @website_ids = website_ids
+        @image_finder = images_folder ? ImageFinder.new(images_folder) : nil
+      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)
+        return [] unless product.main_image.to_s =~ URI::regexp || @image_finder
+
+        image = product.main_image || @image_finder.find_by_name(product.sku)
+        return [] unless image
+  
+        Magento::Params::CreateImage.new(
+          path: image,
+          title: product.name,
+          position: 0,
+          main: true
+        ).variants
+      end
+
+      def numeric?(value)
+        !!(value.to_s =~ /^[\d]+$/)
+      end
+    end
+  end
+end

data/lib/magento/import/template/products.csv

@@ -0,0 +1,2 @@
+name;sku;gtin;description;price;special price;quantity;category level 1;category level 2;category level 3;main image url
+Apple iPhone 11 Pro;iphone-11-pro;9999999999;"Description: New Apple iPhone 11 Pro Max 64/256/512GB Space Gray Midnight Green Silver Gold\nIncludes all new accessories\n\niPhone is unlocked to work on any GSM carrier!\n\nNo warranty - Warranty can be purchased through squaretrade\n\nShipping: We Normally Ship Out Same or Next Business Day Via USPS. \nDelivery Time Varies Especially During Holidays.\nWe Do NOT Ship Out On Saturday/Sunday\nWe Are Not Responsible For Late Packages, But We Will Find Out If There Are Any Issues.\nWe Only Ship To PayPal Confirmed Address.\nPick Up Also Available In Queens NY (Message For Details)\nPriority Mail USPS Free (1-4 Business Days; Not Guaranteed Service)\nExpress Overnight USPS $25 (Guaranteed By USPS Overnight To Most Places) \n\nAdditional return policy details: \nAs a leading seller of electronics, we want to guarantee that each transaction ends with a five star experience. That's why we offer a FREE no questions asked 30-day return policy. Please message us for more details.\n\nSales Tax:\nNew York orders will have a sales tax of 8.875% add to your cost";1099.99;999.00;45;Technology;Smartphone;Apple;"https://store.storeimages.cdn-apple.com/4982/as-images.apple.com/is/iphone-11-pro-select-2019-family?wid=882&hei=1058&fmt=jpeg&qlt=80&op_usm=0.5,0.5&.v=1586586488946"

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

@@ -7,9 +7,9 @@ module Magento
   module Params
     class CreateImage < Dry::Struct
       VARIANTS = {
-        'large'  => { size: '800x800', type: :image },
-        'medium' => { size: '300x300', type: :small_image },
-        'small'  => { size: '100x100', type: :thumbnail }
+        'large'  => :image,
+        'medium' => :small_image,
+        'small'  => :thumbnail
       }.freeze
 
       attribute :title,    Type::String
@@ -30,7 +30,7 @@ module Magento
             "type": mini_type,
             "name": filename
           },
-          "types": main ? [VARIANTS[size][:type]] : []
+          "types": main ? [VARIANTS[size]] : []
         }
       end
 
@@ -48,9 +48,19 @@ module Magento
 
       def file
         @file ||= MiniMagick::Image.open(path).tap do |b|
-          b.resize VARIANTS[size][:size]
-          b.strip
+          b.resize(Magento.configuration.product_image.send(size + '_size'))
+          bigger_side = b.dimensions.max
+          b.combine_options do |c|
+            c.background '#FFFFFF'
+            c.alpha 'remove'
+            c.gravity 'center'
+            c.extent "#{bigger_side}x#{bigger_side}"
+            c.strip
+          end
+          b.format 'jpg'
         end
+      rescue => e
+        raise "Erro ao ler imagem #{path}: #{e}"
       end
 
       def filename

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
@@ -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

@@ -5,11 +5,10 @@ require 'http'
 
 module Magento
   class Request
-    attr_reader :token, :store
+    attr_reader :config
 
-    def initialize(token: Magento.token, store: Magento.store)
-      @token = token
-      @store = store
+    def initialize(config: Magento.configuration)
+      @config = config
     end
 
     def get(resource)
@@ -36,12 +35,13 @@ module Magento
     private
 
     def http_auth
-      HTTP.auth("Bearer #{token}")
+      HTTP.auth("Bearer #{config.token}")
+          .timeout(connect: config.timeout, read: config.open_timeout)
     end
 
     def base_url
-      url = Magento.url.to_s.sub(%r{/$}, '')
-      "#{url}/rest/#{store}/V1"
+      url = config.url.to_s.sub(%r{/$}, '')
+      "#{url}/rest/#{config.store}/V1"
     end
 
     def url(resource)
@@ -53,10 +53,8 @@ module Magento
 
       begin
         msg = resp.parse['message']
-        errors = resp.parse['errors']
-        if resp.parse['parameters'].is_a? Hash
-          resp.parse['parameters'].each { |k, v| msg.sub! "%#{k}", v }
-        end
+        errors = resp.parse['errors'] || resp.parse['parameters']
+        resp.parse['parameters'].each { |k, v| msg.sub! "%#{k}", v } if resp.parse['parameters'].is_a? Hash
       rescue StandardError
         msg = 'Failed access to the magento server'
         errors = []

data/lib/magento/version.rb

@@ -1,3 +1,3 @@
 module Magento
-  VERSION = '0.13.1'
+  VERSION = '0.17.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magento
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.17.0
 platform: ruby
 authors:
 - Wallas Faria
@@ -92,10 +92,17 @@ files:
 - README.md
 - lib/magento.rb
 - lib/magento/category.rb
+- lib/magento/configuration.rb
 - lib/magento/country.rb
 - lib/magento/customer.rb
 - 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/product.rb
+- lib/magento/import/template/products.csv
 - lib/magento/invoice.rb
 - lib/magento/model.rb
 - lib/magento/model_mapper.rb