magento 0.24.0 → 0.28.0

data/lib/magento.rb

@@ -25,9 +25,15 @@ require_relative 'magento/guest_cart'
 require_relative 'magento/sales_rule'
 require_relative 'magento/inventory'
 require_relative 'magento/import'
+require_relative 'magento/cart'
+
+require_relative 'magento/params/create_custom_attribute'
+require_relative 'magento/params/create_image'
+require_relative 'magento/params/create_category'
+require_relative 'magento/params/create_product'
+require_relative 'magento/params/create_product_link'
 
 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

data/lib/magento/cart.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Magento
+  class Cart < Model
+    self.endpoint = 'carts'
+    self.primary_key = :id
+
+    #
+    # Add a coupon by code to the current cart.
+    #
+    # Example:
+    #
+    #   cart = Magento::Cart.find(1)
+    #   cart.add_coupon('COAU4HXE0I')
+    #
+    # @return Boolean: true on success, false otherwise
+    def add_coupon(coupon)
+      self.class.add_coupon(id, coupon)
+    end
+
+    #
+    # Delete cart's coupon
+    #
+    # Example:
+    #
+    #   cart = Magento::Cart.find(1)
+    #   cart.delete_coupon()
+    #
+    # @return Boolean: true on success, raise exception otherwise
+    def delete_coupon
+      self.class.delete_coupon(id)
+    end
+
+    class << self
+      #
+      # Add a coupon by code to a specified cart.
+      #
+      # Example:
+      #
+      #   Magento::Cart.add_coupon(
+      #     1,
+      #     '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::Cart.delete_coupon(1)
+      #
+      # @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/order.rb

@@ -34,7 +34,6 @@ module Magento
       self.class.invoice(id, params)
     end
 
-    
     #
     # Create offline refund for order
     #
@@ -61,6 +60,26 @@ module Magento
       self.class.ship(id, params)
     end
 
+    def send_email
+      self.class.send_email(id)
+    end
+
+    #
+    # Creates a comment on the given Order
+    #
+    # order = Magento::Order.find(order_id)
+    #
+    # order.add_comment(
+    #   'comment',
+    #   is_customer_notified: 0,
+    #   is_visible_on_front: 1
+    # )
+    #
+    # Return true on success
+    def add_comment(comment, comment_params = nil)
+      self.class.add_comment(id, comment, comment_params)
+    end
+
     class << self
       def update(entity_id, attributes)
         attributes[:entity_id] = entity_id
@@ -100,7 +119,6 @@ module Magento
         request.post("order/#{order_id}/invoice", invoice_params).parse
       end
 
-      
       #
       # Create offline refund for order
       #
@@ -172,6 +190,33 @@ module Magento
       def ship(order_id, shipment_params = nil)
         request.post("order/#{order_id}/ship", shipment_params).parse
       end
+
+      def send_email(order_id)
+        request.post("orders/#{order_id}/emails").parse
+      end
+
+      #
+      # Creates a comment on the given Order
+      #
+      # Magento::Order.add_comment(
+      #   order_id,
+      #   'comment',
+      #   is_customer_notified: 0,
+      #   is_visible_on_front: 1
+      # )
+      #
+      # to complete [documentation](https://magento.redoc.ly/2.4.2-admin/tag/ordersidcomments#operation/salesOrderManagementV1AddCommentPost)
+      #
+      # @return {Boolean}: return true on success
+      def add_comment(order_id, comment, comment_params = nil)
+        request.post(
+          "orders/#{order_id}/comments",
+          statusHistory: {
+            comment: comment,
+            **comment_params
+          }
+        ).parse
+      end
     end
   end
 end

data/lib/magento/params/create_image.rb

@@ -5,6 +5,35 @@ require 'mini_magick'
 
 module Magento
   module Params
+
+    # Helper class to create product image params.
+    # before generating the hash, the following image treatments are performed:
+    # - resize image
+    # - remove alpha
+    # - leaves square
+    # - convert image to jpg
+    #
+    # Example:
+    #
+    #   params = Magento::Params::CreateImage.new(
+    #     title: 'Image title',
+    #     path: '/path/to/image.jpg', # or url
+    #     position: 1,
+    #     size: 'small', # options: 'large'(defaut), 'medium' and 'small',
+    #     disabled: true, # default is false,
+    #     main: true, # default is false,
+    #   ).to_h
+    #
+    #   Magento::Product.add_media('sku', params)
+    #
+    # The resize defaut confiruration is:
+    #
+    #   Magento.configure do |config|
+    #     config.product_image.small_size  = '200x200>'
+    #     config.product_image.medium_size = '400x400>'
+    #     config.product_image.large_size  = '800x800>'
+    #   end
+    #
     class CreateImage < Dry::Struct
       VARIANTS = {
         'large'  => :image,
@@ -34,6 +63,20 @@ module Magento
         }
       end
 
+      # Generates a list containing an Magento::Params::CreateImage
+      # instance for each size of the same image.
+      #
+      # Example:
+      #
+      #   params = Magento::Params::CreateImage.new(
+      #     title: 'Image title',
+      #     path: '/path/to/image.jpg', # or url
+      #     position: 1,
+      #   ).variants
+      #
+      #   params.map(&:size)
+      #   => ['large', 'medium', 'small']
+      #
       def variants
         VARIANTS.keys.map do |size|
           CreateImage.new(attributes.merge(size: size, disabled: size != 'large'))

data/lib/magento/params/create_product_link.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Magento
+  module Params
+    class CreateProductLink < Dry::Struct
+      LinkType = Type::String.enum(
+        'related',
+        'upsell',
+        'crosssell',
+        'associated'
+      )
+
+      attribute :link_type,           LinkType
+      attribute :linked_product_sku,  Type::String
+      attribute :linked_product_type, Magento::Params::CreateProduct::ProductTypes
+      attribute :position,            Type::Integer
+      attribute :sku,                 Type::String
+
+      def to_h
+        {
+          link_type: link_type,
+          linked_product_sku: linked_product_sku,
+          linked_product_type: linked_product_type,
+          position: position,
+          sku: sku
+        }
+      end
+    end
+  end
+end

data/lib/magento/product.rb

@@ -38,6 +38,34 @@ module Magento
       super || @custom_attributes&.any? { |a| a.attribute_code == attribute_code.to_s }
     end
 
+    # Create new gallery entry
+    # 
+    # Example:
+    #
+    #   product = Magento::Product.find('sku')
+    #
+    #   product.add_media(
+    #     media_type: 'image',
+    #     label: 'Image label',
+    #     position: 1,
+    #     content: {
+    #       base64_encoded_data: 'image-string-base64',
+    #       type: 'image/jpg',
+    #       name: 'filename.jpg'
+    #     },
+    #     types: ['image']
+    #   )
+    #
+    # Or you can use the Magento::Params::CreateImage helper class
+    #
+    #   params = Magento::Params::CreateImage.new(
+    #     title: 'Image title',
+    #     path: '/path/to/image.jpg', # or url
+    #     position: 1,
+    #   ).to_h
+    #
+    #   product.add_media(params)
+    #
     def add_media(attributes)
       self.class.add_media(sku, attributes)
     end
@@ -47,7 +75,6 @@ module Magento
       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
@@ -89,9 +116,57 @@ module Magento
       self.class.update_stock(sku, id, attributes)
     end
 
+    # Assign a product link to another product
+    #
+    #   product = Magento::Product.find('sku')
+    #
+    #   product.create_links([
+    #     {
+    #       link_type: 'upsell',
+    #       linked_product_sku: 'linked_product_sku',
+    #       linked_product_type: 'simple',
+    #       position: position,
+    #       sku: 'product-sku'
+    #     }
+    #   ])
+    #
+    def create_links(product_links)
+      self.class.create_links(sku, product_links)
+    end
+
+    def remove_link(link_type:, linked_product_sku:)
+      self.class.remove_link(sku, link_type: link_type, linked_product_sku: linked_product_sku)
+    end
+
     class << self
       alias_method :find_by_sku, :find
 
+      # Create new gallery entry
+      #
+      # Example:
+      #
+      #   Magento::Product.add_media('sku', {
+      #     media_type: 'image',
+      #     label: 'Image title',
+      #     position: 1,
+      #     content: {
+      #       base64_encoded_data: 'image-string-base64',
+      #       type: 'image/jpg',
+      #       name: 'filename.jpg'
+      #     },
+      #     types: ['image']
+      #   })
+      #
+      # Or you can use the Magento::Params::CreateImage helper class
+      #
+      #   params = Magento::Params::CreateImage.new(
+      #     title: 'Image title',
+      #     path: '/path/to/image.jpg', # or url
+      #     position: 1,
+      #   ).to_h
+      #
+      #   Magento::Product.add_media('sku', params)
+      #
       def add_media(sku, attributes)
         request.post("products/#{sku}/media", { entry: attributes }).parse
       end
@@ -134,6 +209,26 @@ module Magento
       def update_stock(sku, id, attributes)
         request.put("products/#{sku}/stockItems/#{id}", stockItem: attributes).parse
       end
+
+      # Assign a product link to another product
+      #
+      #   Product.create_links('product-sku', [
+      #     {
+      #       link_type: 'upsell',
+      #       linked_product_sku: 'linked_product_sku',
+      #       linked_product_type: 'simple',
+      #       position: position,
+      #       sku: 'product-sku'
+      #     }
+      #   ])
+      #
+      def create_links(sku, product_links)
+        request.post("products/#{sku}/links", { items: product_links })
+      end
+
+      def remove_link(sku, link_type:, linked_product_sku:)
+        request.delete("products/#{sku}/links/#{link_type}/#{linked_product_sku}")
+      end
     end
   end
 end

data/lib/magento/query.rb

@@ -23,7 +23,7 @@ module Magento
       'to'       # The end of a range. Must be used with from
     ].freeze
 
-    def initialize(model, request: Request.new)
+    def initialize(model, request: Request.new, api_resource: nil)
       @model = model
       @request = request
       @filter_groups = nil
@@ -31,6 +31,7 @@ module Magento
       @page_size = 50
       @sort_orders = nil
       @fields = nil
+      @endpoint = api_resource || model.api_resource
     end
 
     def where(attributes)
@@ -69,15 +70,17 @@ module Magento
       self
     end
 
-    def order(attributes)
-      if attributes.is_a?(String)
-        self.sort_orders = [{ field: verify_id(attributes), direction: :asc }]
-      elsif attributes.is_a?(Hash)
-        self.sort_orders = []
-        attributes.each do |field, direction|
-          raise "Invalid sort order direction '#{direction}'" unless %w[asc desc].include?(direction.to_s)
+    def order(*attributes)
+      self.sort_orders = []
+      attributes.each do |sort_order|
+        if sort_order.is_a?(String) || sort_order.is_a?(Symbol)
+          sort_orders << { field: verify_id(sort_order), direction: :asc }
+        elsif sort_order.is_a?(Hash)
+          sort_order.each do |field, direction|
+            raise "Invalid sort order direction '#{direction}'" unless %w[asc desc].include?(direction.to_s)
 
-          sort_orders << { field: verify_id(field), direction: direction }
+            sort_orders << { field: verify_id(field), direction: direction }
+          end
         end
       end
       self
@@ -131,7 +134,7 @@ module Magento
     attr_accessor :current_page, :filter_groups, :request, :sort_orders, :model, :fields
 
     def endpoint
-      model.api_resource
+      @endpoint
     end
 
     def verify_id(field)

data/lib/magento/sales_rule.rb

@@ -27,6 +27,10 @@ module Magento
       def generate_coupon(attributes)
         request.post('coupons/generate', attributes).parse
       end
+
+      protected def query
+        Query.new(self, api_resource: 'salesRules/search')
+      end
     end
   end
 end

data/lib/magento/version.rb

@@ -1,3 +1,3 @@
 module Magento
-  VERSION = '0.24.0'
+  VERSION = '0.28.0'
 end

data/spec/magento/core/model_mapper_spec.rb

@@ -0,0 +1,74 @@
+RSpec.describe Magento::ModelMapper do
+  describe '.to_hash' do
+    it 'serializes object to hash' do
+      class Magento::SameClass
+        attr_accessor :name, :description, :items
+      end
+
+      object = Magento::SameClass.new
+      object.name = 'Some name'
+      object.description = 'Some description'
+      object.items = [object.dup]
+
+      expect(Magento::ModelMapper.to_hash(object)).to eql({
+        'name' => 'Some name',
+        'description' => 'Some description',
+        'items' => [{ 'name' => 'Some name', 'description' => 'Some description' }]
+      })
+    end
+  end
+
+  describe '.map_hash' do
+    it 'returns magento object from hash' do
+      class Magento::SameClass; end
+      hash = { name: 'Some name', price: 10.99 }
+
+      object = Magento::ModelMapper.map_hash(Magento::SameClass, hash)
+
+      expect(object).to be_instance_of(Magento::SameClass)
+      expect(object.name).to eql hash[:name]
+      expect(object.price).to eql hash[:price]
+    end
+  end
+
+  describe '.map_array' do
+    it 'returns magento object list from array of hash' do
+      class Magento::SameClass; end
+      array = [{ name: 'Some name', price: 10.99 }]
+
+      object = Magento::ModelMapper.map_array('same_class', array)
+
+      expect(object).to be_a(Array)
+      expect(object).to all be_instance_of(Magento::SameClass)
+    end
+  end
+
+  describe 'include ModelParser' do
+    before do
+      class Magento::SameClass
+        include Magento::ModelParser
+      end
+    end
+
+    let(:hash) { { name: 'Same name' } }
+
+    describe '.build' do
+      it 'calls Magento::ModelMapper.map_hash' do
+        expect(Magento::ModelMapper).to receive(:map_hash)
+          .with(Magento::SameClass, hash)
+
+        Magento::SameClass.build(hash)
+      end
+    end
+
+    describe '#to_h' do
+      it 'calls Magento::ModelMapper.to_hash' do
+        object = Magento::SameClass.build(hash)
+
+        expect(Magento::ModelMapper).to receive(:to_hash).with(object)
+
+        object.to_h
+      end
+    end
+  end
+end