magento 0.12.0 → 0.15.1

data/lib/magento.rb

@@ -2,10 +2,13 @@
 
 require 'time'
 require 'dry/inflector'
+require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/hash/keys'
 
 require_relative 'magento/errors'
 require_relative 'magento/request'
 require_relative 'magento/model_mapper'
+require_relative 'magento/params'
 require_relative 'magento/polymorphic_model'
 require_relative 'magento/model'
 require_relative 'magento/record_collection'
@@ -20,6 +23,7 @@ require_relative 'magento/guest_cart'
 require_relative 'magento/sales_rule'
 
 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
@@ -38,12 +42,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/params.rb

@@ -0,0 +1,9 @@
+require 'dry/struct'
+
+module Magento
+  module Params
+    module Type
+      include Dry.Types()
+    end
+  end
+end

data/lib/magento/params/create_category.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Magento
+  module Params
+    class CreateCategoria < Dry::Struct
+      attribute :name,      Type::String
+      attribute :parent_id, Type::String.optional
+      attribute :path,      Type::String.optional
+      attribute :is_active, Type::Bool.default(true)
+
+      def to_h
+        {
+          "name": name,
+          "parent_id": parent_id,
+          "is_active": is_active,
+          "path": path
+        }
+      end
+    end
+  end
+end

data/lib/magento/params/create_custom_attribute.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Magento
+  module Params
+    class CreateCustomAttribute < Dry::Struct
+      attribute :code, Type::String
+      attribute :value, Type::String
+
+      def to_h
+        {
+          "attribute_code": code,
+          "value": value
+        }
+      end
+    end
+  end
+end

data/lib/magento/params/create_image.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'open-uri'
+require 'mini_magick'
+
+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 }
+      }.freeze
+
+      attribute :title,    Type::String
+      attribute :path,     Type::String
+      attribute :position, Type::Integer
+      attribute :size,     Type::String.default('large').enum(*VARIANTS.keys)
+      attribute :disabled, Type::Bool.default(false)
+      attribute :main,     Type::Bool.default(false)
+
+      def to_h
+        {
+          "disabled": disabled,
+          "media_type": 'image',
+          "label": title,
+          "position": position,
+          "content": {
+            "base64_encoded_data": base64,
+            "type": mini_type,
+            "name": filename
+          },
+          "types": main ? [VARIANTS[size][:type]] : []
+        }
+      end
+
+      def variants
+        VARIANTS.keys.map do |size|
+          CreateImage.new(attributes.merge(size: size, disabled: size != 'large'))
+        end
+      end
+
+      private
+
+      def base64
+        Base64.strict_encode64(File.open(file.path).read).to_s
+      end
+
+      def file
+        @file ||= MiniMagick::Image.open(path).tap do |b|
+          b.resize VARIANTS[size][:size]
+          b.strip
+        end
+      end
+
+      def filename
+        title.parameterize
+      end
+
+      def mini_type
+        file.mime_type
+      end
+    end
+  end
+end

data/lib/magento/params/create_product.rb

@@ -0,0 +1,147 @@
+require_relative 'create_image'
+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)
+    # 
+    class CreateProduct < Dry::Struct
+      ProductTypes = Type::String.default('simple'.freeze).enum(
+        'simple',
+        'bundle',
+        'configurable',
+        'downloadable',
+        'grouped',
+        'Virtual'
+      )
+
+      Visibilities = Type::String.default('catalog_and_search'.freeze).enum(
+        'not_visible_individually' => 1,
+        'catalog' => 1,
+        'search' => 3,
+        'catalog_and_search' => 4
+      )
+
+      Statuses = Type::String.default('enabled'.freeze).enum('enabled' => 1, 'disabled' => 2)
+
+      attribute :sku,               Type::String
+      attribute :name,              Type::String
+      attribute :description,       Type::String
+      attribute :brand,             Type::String
+      attribute :price,             Type::Coercible::Float
+      attribute :special_price,     Type::Float.optional.default(nil)
+      attribute :attribute_set_id,  Type::Integer
+      attribute :status,            Statuses
+      attribute :visibility,        Visibilities
+      attribute :type_id,           ProductTypes
+      attribute :weight,            Type::Coercible::Float
+      attribute :quantity,          Type::Coercible::Float
+      attribute :featured,          Type::String.default('0'.freeze).enum('0', '1')
+      attribute :is_qty_decimal,    Type::Bool.default(false)
+      attribute :manage_stock,      Type::Bool.default(true)
+      attribute :category_ids,      Type::Array.of(Type::Integer).default([].freeze)
+      attribute :images,            Type::Array.of(Type::Instance(CreateImage)).default([].freeze)
+      attribute :website_ids,       Type::Array.of(Type::Integer).default([0].freeze)
+      attribute :custom_attributes, Type::Array.default([], shared: true) do
+        attribute :attribute_code,  Type::String
+        attribute :value,           Type::Coercible::String
+      end
+
+      alias orig_custom_attributes custom_attributes
+
+      def to_h
+        {
+          sku: sku,
+          name: name.titlecase,
+          price: price,
+          status: Statuses.mapping[status],
+          visibility: Visibilities.mapping[visibility],
+          type_id: type_id,
+          weight: weight,
+          attribute_set_id: attribute_set_id,
+          extension_attributes: {
+            website_ids: website_ids,
+            category_links: categories,
+            stock_item: stock
+          },
+          media_gallery_entries: images.map(&:to_h),
+          custom_attributes: custom_attributes.map(&:to_h)
+        }
+      end
+
+      def stock
+        {
+          qty: quantity,
+          is_in_stock: quantity.to_i > 0,
+          is_qty_decimal: is_qty_decimal,
+          show_default_notification_message: false,
+          use_config_min_qty: true,
+          min_qty: 1,
+          use_config_min_sale_qty: 0,
+          min_sale_qty: 0,
+          use_config_max_sale_qty: true,
+          max_sale_qty: 0,
+          use_config_backorders: true,
+          backorders: 0,
+          use_config_notify_stock_qty: true,
+          notify_stock_qty: 0,
+          use_config_qty_increments: true,
+          qty_increments: 0,
+          use_config_enable_qty_inc: true,
+          enable_qty_increments: true,
+          use_config_manage_stock: manage_stock,
+          manage_stock: manage_stock,
+          low_stock_date: 'string',
+          is_decimal_divided: is_qty_decimal,
+          stock_status_changed_auto: 0
+        }
+      end
+
+      def custom_attributes
+        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)
+        ]
+
+        if special_price.to_f > 0
+          default_attributes << CustomAttribute.new(attribute_code: 'special_price', value: special_price.to_s)
+        end
+
+        default_attributes + orig_custom_attributes
+      end
+
+      def categories
+        category_ids.map { |c| { "category_id": c, "position": 0 } }
+      end
+    end
+  end
+end

data/lib/magento/product.rb

@@ -2,6 +2,20 @@ module Magento
   class Product < Model
     self.primary_key = :sku
 
+    def method_missing(m)
+      attr(m) || super
+    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 respond_to?(attribute_code)
+      super || @custom_attributes&.any? { |a| a.attribute_code == attribute_code.to_s }
+    end
+
     class << self
       alias_method :find_by_sku, :find
     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

@@ -69,7 +69,7 @@ module Magento
 
     def save_request(method, url, body = nil)
       begin
-        body = body[:product].reject { |e| e == :media_gallery_entries }
+        body = body.symbolize_keys[:product].reject { |e| e == :media_gallery_entries }
       rescue StandardError
       end
 

data/lib/magento/version.rb

@@ -1,3 +1,3 @@
 module Magento
-  VERSION = '0.12.0'
+  VERSION = '0.15.1'
 end

data/magento-ruby.gemspec

@@ -19,4 +19,7 @@ Gem::Specification.new do |s|
 
   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

data/magento.gemspec

@@ -19,4 +19,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'http', '~> 4.4'
   s.add_dependency 'dry-inflector', '~> 0.2.0'
+  s.add_dependency 'dry-struct'
+  s.add_dependency 'activesupport'
+  s.add_dependency 'mini_magick'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magento
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.15.1
 platform: ruby
 authors:
 - Wallas Faria
@@ -38,6 +38,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Magento Ruby library
 email: wallasfaria@hotmail.com
 executables: []
@@ -58,6 +100,11 @@ files:
 - lib/magento/model.rb
 - lib/magento/model_mapper.rb
 - lib/magento/order.rb
+- lib/magento/params.rb
+- lib/magento/params/create_category.rb
+- lib/magento/params/create_custom_attribute.rb
+- lib/magento/params/create_image.rb
+- lib/magento/params/create_product.rb
 - lib/magento/polymorphic_model.rb
 - lib/magento/product.rb
 - lib/magento/query.rb