magento 0.15.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d7a340d50d7233fcb8e0eb877d49e1c29e0785fb76413c2216bf79c86bb420b
-  data.tar.gz: 6c1ad15d2b246e145d7d83082749431d89303f9c82a6fe74dd525ed52615fe28
+  metadata.gz: 41955a56a9aff31abc7c7c74adcc72eb84a11e00ebef0e169b40e89e218d3d0b
+  data.tar.gz: d4e846e5407872f2c2909585b148c85ede8f9552456dfd18886fa791c8b2f1e5
 SHA512:
-  metadata.gz: a1e2e8fc442888fc6cd2e45f16d10186a1abf86ca990517cd0b9dbba60b2a57d015c9af2dc25e93d492413491cc4e7e1c37efa479c8e74581ce319b5d623a1ec
-  data.tar.gz: 219111f025c6189e6c83605e6a08f0479e1080e7ae40ff8f740aa0190df298ab71ef3b1c6c8a3757466e5a74b4d78e64c50827ad84da0a7b1a47774e6571aff8
+  metadata.gz: 5178cf1b839df2db8fd2c5c5e9c891ebdff52f2d1ce2f896c6a3a8d0f7b607960a19cfcadfece2c53289b1637c2cc613b3632b0c8bf564513e71033d2cfcfe93
+  data.tar.gz: 28522d689e5c6a718275174c531e585c26cef4a07347b9ebd70346761a696cc87260aa809acc98fc0f9b883b9ee0c5140b0ecde3e19101ca426dab36227f003c

data/README.md

@@ -5,7 +5,7 @@
 Add in your Gemfile
 
 ```rb
-gem 'magento', '~> 0.15.0'
+gem 'magento', '~> 0.15.1'
 ```
 
 or run

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(url: Magento.url, token: Magento.token, store: Magento.store)
-    @old_url   = self.url
-    @old_token = self.token
-    @old_store = self.store
+  def self.reset
+    @configuration = Configuration.new
+  end
 
-    self.url   = url
-    self.token = token
-    self.store = store
+  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/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 "Created product: #{product.sku} => #{product.name}"
+        rescue => e
+          puts "Error on create: #{product.sku} => #{product.name}"
+          puts " - Error details: #{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/model.rb

@@ -35,7 +35,7 @@ module Magento
     class << self
       extend Forwardable
 
-      def_delegators :query, :all, :page, :per, :page_size, :order, :select, 
+      def_delegators :query, :all, :find_each, :page, :per, :page_size, :order, :select, 
                      :where, :first, :find_by, :count
 
       def find(id)

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,13 +48,23 @@ 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 "Error on read image #{path}: #{e}"
       end
 
       def filename
-        title.parameterize
+        "#{title.parameterize}-#{VARIANTS[size]}.jpg"
       end
 
       def mini_type

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/product.rb

@@ -2,8 +2,8 @@ module Magento
   class Product < Model
     self.primary_key = :sku
 
-    def method_missing(m)
-      attr(m) || super
+    def method_missing(m, *params, &block)
+      attr(m) || super(m, *params, &block)
     end
 
     # returns custom_attribute value by custom_attribute code
@@ -16,8 +16,26 @@ module Magento
       super || @custom_attributes&.any? { |a| a.attribute_code == attribute_code.to_s }
     end
 
+    def add_media(attributes)
+      self.class.add_media(sku, attributes)
+    end
+
+    # returns true if the media was deleted
+    def remove_media(media_id)
+      self.class.remove_media(sku, media_id)
+    end
+
     class << self
       alias_method :find_by_sku, :find
+
+      def add_media(sku, attributes)
+        request.post("products/#{sku}/media", { entry: attributes }).parse
+      end
+
+      # returns true if the media was deleted
+      def remove_media(sku, media_id)
+        request.delete("products/#{sku}/media/#{media_id}").parse
+      end
     end
   end
 end

data/lib/magento/query.rb

@@ -58,7 +58,7 @@ module Magento
     alias_method :per, :page_size
 
     def select(*fields)
-      fields = fields.map { |field| parse_field(field) }
+      fields = fields.map { |field| parse_field(field, root: true) }
 
       if model == Magento::Category
         self.fields = "children_data[#{fields.join(',')}]"
@@ -85,8 +85,33 @@ 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
+
+    #
+    # Loop all products on each page, starting from the first to the last page
+    def find_each
+      if @model == Magento::Category
+        raise NoMethodError, 'undefined method `find_each` for Magento::Category'
+      end
+
+      @current_page = 1
+
+      loop do
+        redords = all
+
+        redords.each do |record|
+          yield record
+        end
+
+        break if redords.last_page?
+
+        @current_page = redords.next_page
+      end
     end
 
     def first
@@ -146,8 +171,8 @@ module Magento
       value
     end
 
-    def parse_field(value)
-      return verify_id(value) unless value.is_a? Hash
+    def parse_field(value, root: false)
+      return (root ? verify_id(value) : value) unless value.is_a? Hash
 
       value.map do |k, v|
         fields = v.is_a?(Array) ? v.map { |field| parse_field(field) } : [parse_field(v)]

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.15.0'
+  VERSION = '0.18.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magento
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.18.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