magento 0.26.1 → 0.27.0

data/lib/magento/order.rb

@@ -34,7 +34,6 @@ module Magento
       self.class.invoice(id, params)
     end
 
-    
     #
     # Create offline refund for order
     #
@@ -65,6 +64,22 @@ module Magento
       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
@@ -104,7 +119,6 @@ module Magento
         request.post("order/#{order_id}/invoice", invoice_params).parse
       end
 
-      
       #
       # Create offline refund for order
       #
@@ -180,6 +194,29 @@ module Magento
       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/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
@@ -88,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 +210,18 @@ module Magento
         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

data/lib/magento/query.rb

@@ -70,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)
-
-          sort_orders << { field: verify_id(field), direction: direction }
+    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 }
+          end
         end
       end
       self

data/lib/magento/version.rb

@@ -1,3 +1,3 @@
 module Magento
-  VERSION = '0.26.1'
+  VERSION = '0.27.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

data/spec/magento/core/model_spec.rb

@@ -0,0 +1,71 @@
+RSpec.describe Magento::Model do
+  describe 'public method' do
+    describe '.find' do
+      it 'is pending'
+    end
+
+    describe '.create' do
+      it 'is pending'
+    end
+
+    describe '.update' do
+      it 'is pending'
+    end
+
+    describe '.delete' do
+      it 'is pending'
+    end
+
+    describe '#save' do
+      it 'calls the update class method'
+    end
+
+    describe '#update' do
+      it 'calls the update class method'
+    end
+
+    describe '#delete' do
+      it 'calls the delete class method'
+    end
+
+    describe '.api_resource' do
+      it 'is pending'
+    end
+
+    describe '.entity_name' do
+      it 'is pending'
+    end
+
+    describe '.primary_key' do
+      it 'is pending'
+    end
+
+    describe 'delegated methods from query' do
+      it 'respond to .all'
+      it 'respond to .find_each'
+      it 'respond to .page'
+      it 'respond to .per'
+      it 'respond to .page_size'
+      it 'respond to .order'
+      it 'respond to .select'
+      it 'respond to .where'
+      it 'respond to .first'
+      it 'respond to .find_by'
+      it 'respond to .count'
+    end
+  end
+
+  describe 'protected method' do
+    describe '.entity_key' do
+      it 'is pending'
+    end
+
+    describe '.query' do
+      it 'is pending'
+    end
+
+    describe '.request' do
+      it 'is pending'
+    end
+  end
+end

data/spec/magento/core/query_spec.rb

@@ -0,0 +1,207 @@
+class Magento::Faker < Magento::Model; end
+
+RSpec.describe Magento::Query do
+  subject { Magento::Query.new(Magento::Faker) }
+
+  describe '#where' do
+    it 'add the filter to group of filters' do
+      subject.where(price_gt: 50)
+
+      expect(subject.send(:filter_groups)).to eql([
+        { filters: [{ field: 'price', conditionType: 'gt', value: 50 }] }
+      ])
+    end
+
+    context 'when the condition is not passed' do
+      it 'the "eq" condition is used as default' do
+        subject.where(price: 50)
+
+        expect(subject.send(:filter_groups)).to eql([
+          { filters: [{ field: :price, conditionType: 'eq', value: 50 }] }
+        ])
+      end
+    end
+
+    context 'when it is called more than once' do
+      it 'adds filter in diferent groups' do
+        subject.where(price_gt: 10).where(price_lt: 20)
+
+        expect(subject.send(:filter_groups)).to eql([
+          { filters: [{ field: 'price', conditionType: 'gt', value: 10 }] },
+          { filters: [{ field: 'price', conditionType: 'lt', value: 20 }] }
+        ])
+      end
+    end
+
+    context 'when it is called with more than one filter' do
+      it 'adds the filters in same group' do
+        subject.where(price_gt: 10, price_lt: 20)
+
+        expect(subject.send(:filter_groups)).to eql([
+          {
+            filters: [
+              { field: 'price', conditionType: 'gt', value: 10 },
+              { field: 'price', conditionType: 'lt', value: 20 }
+            ]
+          }
+        ])
+      end
+    end
+
+    context 'when the condition is "in" or "nin" and value is a Array' do
+      it 'converts the value to string' do
+        subject.where(status_in: [:pending, :new])
+        subject.where(entity_id_nin: [123, 321])
+
+        expect(subject.send(:filter_groups)).to eql([
+          { filters: [{ field: 'status', conditionType: 'in', value: 'pending,new' }] },
+          { filters: [{ field: 'entity_id', conditionType: 'nin', value: '123,321' }] }
+        ])
+      end
+    end
+  end
+
+  describe '#page' do
+    it do
+      subject.page(2)
+      expect(subject.send(:current_page)).to eql(2)
+    end
+  end
+
+  describe '#page_size' do
+    it do
+      subject.page_size(5)
+      expect(subject.instance_variable_get(:@page_size)).to eql(5)
+    end
+  end
+
+  describe '#select' do
+    it 'set fields inside items[]' do
+      subject.select(:id, :name)
+
+      expect(subject.send(:fields)).to eql('items[id,name],search_criteria,total_count')
+    end
+
+    it 'allow hash' do
+      subject.select(:id, nested_attribute: :name)
+
+      expect(subject.send(:fields)).to eql('items[id,nested_attribute[name]],search_criteria,total_count')
+    end
+
+    it 'allow hash with key and value as array' do
+      subject.select(:id, nested_attribute: [:id, :name])
+
+      expect(subject.send(:fields)).to eql('items[id,nested_attribute[id,name]],search_criteria,total_count')
+    end
+
+    it 'allow hash multiple level' do
+      subject.select(:id, nested_attribute: [:id, :name, stock: :quantity])
+
+      expect(subject.send(:fields)).to eql(
+        'items[id,nested_attribute[id,name,stock[quantity]]],search_criteria,total_count'
+      )
+    end
+
+    context 'when model is Magento::Category' do
+      class Magento::Category < Magento::Model; end
+
+      subject { Magento::Query.new(Magento::Category) }
+
+      it 'set fields inseide children_data[]' do
+        subject.select(:id, :name)
+
+        expect(subject.send(:fields)).to eql('children_data[id,name]')
+      end
+    end
+  end
+
+  describe '#order' do
+    it 'set order in sort_orders' do
+      subject.order(name: :desc)
+
+      expect(subject.send(:sort_orders)).to eql(
+        [{ field: :name, direction: :desc }]
+      )
+
+      subject.order(created_at: :desc, name: :asc)
+
+      expect(subject.send(:sort_orders)).to eql(
+        [
+          { field: :created_at, direction: :desc },
+          { field: :name, direction: :asc }
+        ]
+      )
+    end
+
+    context 'when the direction is not passed' do
+      it 'the :asc direction is used as default' do
+        subject.order(:name)
+
+        expect(subject.send(:sort_orders)).to eql(
+          [{ field: :name, direction: :asc }]
+        )
+
+        subject.order(:created_at, :name)
+
+        expect(subject.send(:sort_orders)).to eql([
+          { field: :created_at, direction: :asc },
+          { field: :name, direction: :asc }
+        ])
+      end
+    end
+  end
+
+  describe '#all' do
+    it 'is pending'
+  end
+
+  describe '#first' do
+    it 'is pending'
+  end
+
+  describe '#find_by' do
+    it 'is pending'
+  end
+
+  describe '#count' do
+    it 'is pending'
+  end
+
+  describe '#find_each' do
+    it 'is pending'
+  end
+
+  describe 'private mathods' do
+    describe 'endpoint' do
+      it 'is pending'
+    end
+
+    describe 'verify_id' do
+      it 'is pending'
+    end
+
+    describe 'query_params' do
+      it 'is pending'
+    end
+
+    describe 'parse_filter' do
+      it 'is pending'
+    end
+
+    describe 'parse_value_filter' do
+      it 'is pending'
+    end
+
+    describe 'parse_field' do
+      it 'is pending'
+    end
+
+    describe 'encode' do
+      it 'is pending'
+    end
+
+    describe 'append_key' do
+      it 'is pending'
+    end
+  end
+end