magento 0.16.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54c756e43ba125d24cfd2695f5b3b362acf6a489cb0ccc7b7abd853b8488164c
-  data.tar.gz: 103375f7ba57dae9d78e93d19e0cb95d6192365390b4d05005c465eea6737908
+  metadata.gz: bd6a94c17db3ebc55bcc96cbae5118128326e3d7ca2d0e96bfb5b530edea5561
+  data.tar.gz: a0e86d4bc16f5c4338281fcadb07ee62f18017cc59bcd89cb15804110472021c
 SHA512:
-  metadata.gz: d839bf8cc47b2a7e639de881d2e8505cd8b3bb2d52428a1e8c58438e96e3bbf84392ccf22498b393a5ec60b812afca078e9f2cd33568f2475081501601f0c919
-  data.tar.gz: 3192fd700e6356b0a58039b26fe8c5b25ab577328d67cce6a4495465f84c4dc9f6aa48e37cacbaafc7068b61ac91a983fe7b41287ff4316920b09951079a0dcf
+  metadata.gz: 1a7ebe7b9a4b24d0644ef31ddaee95ff17c07e702f001ec18ad632886e538187ff5a02ef841fe648d8c5eb0a5348b13579a15c9450c9442ad08f5fd29c17333f
+  data.tar.gz: 3252ea89c262918fce7b206e842197510929e1acb998da5613ba8f7d37f4f68de4b0cde29e765199f0bb0f177882dd33bd16efe98454231e909ee3cd3cb76b34

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

@@ -3,8 +3,6 @@ name: Ruby Gem
 on:
   push:
     branches: [ release ]
-  pull_request:
-    branches: [ release ]
 
 jobs:
   build:

data/README.md

@@ -5,7 +5,7 @@
 Add in your Gemfile
 
 ```rb
-gem 'magento', '~> 0.15.1'
+gem 'magento', '~> 0.19.0'
 ```
 
 or run
@@ -83,6 +83,23 @@ product.respond_to? :description
 > true
 ```
 
+## add tier price
+
+Add `price` on product `sku` for specified `customer_group_id`
+
+Param `quantity` is the minimun amount to apply the price
+
+```rb
+product = Magento::Product.find(1)
+product.add_tier_price(3.99, quantity: 1, customer_group_id: :all)
+> true
+
+# OR
+
+Magento::Product.add_tier_price(1, 3.99, quantity: 1, customer_group_id: :all)
+> true
+```
+
 ## Get List
 
 ```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'
@@ -28,7 +29,9 @@ 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|
@@ -37,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

@@ -1,13 +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, image_path:, website_ids: [0])
+    def self.from_csv(file, images_folder: nil, website_ids: [0])
       products = CSVReader.new(file).get_products
       products = Category.new(products).associate
-      Product.new(image_path, website_ids).import(products)
+      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/category.rb

@@ -41,7 +41,7 @@ module Magento
         params = Magento::Params::CreateCategoria.new(
           name: name,
           parent_id: parent.id,
-          url: "#{Magento.store}-#{parent.id}-#{name.parameterize}"
+          url: "#{Magento.configuration.store}-#{parent.id}-#{name.parameterize}"
         )
 
         Magento::Category.create(params.to_h).tap { |c| puts "Create: #{c.id} => #{c.name}" }

data/lib/magento/import/csv_reader.rb

@@ -10,18 +10,18 @@ module Magento
 
       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
+            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

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

@@ -1,9 +1,11 @@
+require 'uri'
+
 module Magento
   module Import
     class Product
-      def initialize(images_path, website_ids)
-        @images_path = images_path
+      def initialize(website_ids, images_folder = nil)
         @website_ids = website_ids
+        @image_finder = images_folder ? ImageFinder.new(images_folder) : nil
       end
   
       def import(products)
@@ -26,17 +28,19 @@ module Magento
   
           product = Magento::Product.create(params)
   
-          puts "Produto criado: #{product.sku} => #{product.name}"
+          puts "Created product: #{product.sku} => #{product.name}"
         rescue => e
-          puts "Erro ao criado: #{product.sku} => #{product.name}"
-          puts " - Detalhes do erro: #{e}"
+          puts "Error on create: #{product.sku} => #{product.name}"
+          puts " - Error details: #{e}"
         end
       end
   
       private
   
       def images(product)
-        image = find_image(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(
@@ -46,15 +50,7 @@ module Magento
           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

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_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,14 +48,23 @@ module Magento
 
       def file
         @file ||= MiniMagick::Image.open(path).tap do |b|
-          b.resize VARIANTS[size][:size]
+          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'
-          b.strip
         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/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,56 @@ 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
+
+    # 
+    # Add {price} on product {sku} for specified {customer_group_id}
+    # 
+    # Param {quantity} is the minimun amount to apply the price
+    # 
+    # product = Magento::Product.find(1)
+    # product.add_tier_price(3.99, quantity: 1, customer_group_id: :all)
+    # 
+    # OR
+    # 
+    # Magento::Product.add_tier_price(1, 3.99, quantity: 1, customer_group_id: :all)
+    # 
+    # @return {Boolean}
+    def add_tier_price(price, quantity:, customer_group_id: :all)
+      self.class.add_tier_price(
+        sku, price, quantity: quantity, customer_group_id: customer_group_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
+
+      # Add {price} on product {sku} for specified {customer_group_id}
+      # 
+      # Param {quantity} is the minimun amount to apply the price
+      # 
+      # @return {Boolean}
+      def add_tier_price(sku, price, quantity:, customer_group_id: :all)
+        request.post(
+          "products/#{sku}/group-prices/#{customer_group_id}/tiers/#{quantity}/price/#{price}"
+        ).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(',')}]"
@@ -92,6 +92,28 @@ module Magento
       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
       page_size(1).page(1).all.first
     end
@@ -149,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)
@@ -54,9 +54,7 @@ module Magento
       begin
         msg = resp.parse['message']
         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
+        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.16.0'
+  VERSION = '0.19.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magento
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Wallas Faria
@@ -92,6 +92,7 @@ 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
@@ -99,7 +100,9 @@ files:
 - lib/magento/import.rb
 - lib/magento/import/category.rb
 - lib/magento/import/csv_reader.rb
+- lib/magento/import/image_finder.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