magento 0.8.2 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01b9ac4283305e36500f008a3344c2287efc72e1b56e8fb996161fa7e5d658a7
-  data.tar.gz: 6ce8510dfb9ed0977f50cb78977b98028cc2d34e205272447160d738acac56eb
+  metadata.gz: ba575ef3ae90104d8c2fab63e96762478536391becc467892d0feee3ff9a15ad
+  data.tar.gz: 655504007fb8ff01db537e8d7fa51641fba248ce0fdee9a0b153418b95dce688
 SHA512:
-  metadata.gz: 27a5885f9ede8d3ce9a2c078a6319dd04d0f1a6e74c0b1569da3525f0ca3e229fef1df0b9753e49331a667b21bfe1590575d3466c59d42b56a5349f294a01c09
-  data.tar.gz: 124ab9fbb4ec50b80f1117c2b0ed2af64055a0dbf7304e9ad3b410f1db6e8714be3267229625ec03cc60fdfa9ac98c3df7d4dc21eb660688aa57a1c512cc5869
+  metadata.gz: 720efc55bf0754e8a13dae1230208536743bc6939f53ba7ccf4d116e325e257486e4522188fee86bc1383a11c92c49692e4f193cd6d402ce23f687086549a5d2
+  data.tar.gz: 7984a5870e45ebcd220d0426918bd5b616ae545112fd68bc0ca6ac4cb2e60b1e1891ae2e46ed233a06be9f9ae399b5de9a02e8608400ed668336903f34c71472

data/README.md

@@ -5,7 +5,7 @@
 Add in your Gemfile
 
 ```rb
-gem 'magento', '~> 0.8.2'
+gem 'magento', '~> 0.11.0'
 ```
 
 or run
@@ -32,6 +32,7 @@ Magento::Product
 Magento::Order
 Magento::Country
 Magento::Category
+Magento::Customer
 ```
 
 ## Get details
@@ -68,6 +69,7 @@ Magento::Product.select(:id, :sku, :name, extension_attributes: [:website_ids, {
 #### Filters:
 
 ```rb
+Magento::Product.where(visibility: 4).all
 Magento::Product.where(name_like: 'IPhone%').all
 Magento::Product.where(price_gt: 100).all
 
@@ -130,6 +132,20 @@ products = Magento::Product.select(:sku, :name)
                            .all
 ```
 
+## Get one
+
+```rb
+Magento::Order.where(increment_id: '000013457').first
+# or
+Magento::Order.find_by(increment_id: '000013457')
+```
+
+## Count
+```rb
+Magento::Order.count
+Magento::Order.where(status: :pending).count
+```
+
 \* _same pattern to all models_
 
 ### Response
@@ -255,6 +271,10 @@ product.save
 # or
 
 product.update(name: 'Updated name')
+
+# or
+
+Magento::Product.update('sku-teste', name: 'Updated name')
 ```
 
 ### Delete
@@ -320,7 +340,7 @@ invoice_id = order.invoice(
 ## Create refund for invoice
 
 ```rb
-Magento::Invoice.invoice(refund_id)
+Magento::Invoice.invoice(invoice_id)
 >> 12 # return refund id
 
 # or from instance
@@ -361,6 +381,48 @@ invoice.refund(
 [Complete Refund Documentation](https://magento.redoc.ly/2.4-admin/tag/invoicescomments#operation/salesRefundInvoiceV1ExecutePost)
 
 
+## Create offline refund for order
+
+```rb
+Magento::Order.refund(order_id)
+>> 12 # return refund id
+
+# or from instance
+
+order = Magento::Order.find(order_id)
+
+order.refund
+
+# you can pass parameters too
+
+order.refund(
+  items: [
+    {
+      extension_attributes: {},
+      order_item_id: 0,
+      qty: 0
+    }
+  ],
+  notify: true,
+  appendComment: true,
+  comment: {
+    extension_attributes: {},
+    comment: string,
+    is_visible_on_front: 0
+  },
+  arguments: {
+    shipping_amount: 0,
+    adjustment_positive: 0,
+    adjustment_negative: 0,
+    extension_attributes: {
+      return_to_stock_items: [0]
+    }
+  }
+)
+```
+
+[Complete Refund Documentation](https://magento.redoc.ly/2.4-admin/tag/invoicescomments#operation/salesRefundOrderV1ExecutePost)
+
 ## Other Invoice methods
 
 ```rb

data/lib/magento/customer.rb

@@ -1,17 +1,47 @@
 module Magento
   class Customer < Model
+    self.endpoint = 'customers/search'
+
     def fullname
       "#{@firstname} #{@lastname}"
     end
 
+    def update(attributes)
+      raise "id not present" if @id.nil?
+
+      attributes.each { |key, value| send("#{key}=", value) }
+      save
+    end
+
     class << self
       alias_method :find_by_id, :find
 
+      def update(id, attributes)
+        hash = request.put("customers/#{id}", { customer: attributes }).parse
+
+        block_given? ? yield(hash) : build(hash)
+      end
+
+      def create(attributes)
+        attributes.transform_keys!(&:to_sym)
+        password = attributes.delete :password
+        hash = request.post("customers", {
+          customer: attributes,
+          password: password
+        }).parse
+        build(hash)
+      end
+
       def find_by_token(token)
         user_request = Request.new(token: token)
         customer_hash = user_request.get('customers/me').parse
         build(customer_hash)
       end
+
+      def find(id)
+        hash = request.get("customers/#{id}").parse
+        build(hash)
+      end
     end
   end
 end

data/lib/magento/invoice.rb

@@ -33,7 +33,7 @@ module Magento
     # invoice = Magento::Invoice.find(invoice_id)
     #
     # invoice.refund # or you can pass parameters
-    # invoice.invoice(notify: false) # See the refund class method for more information
+    # invoice.refund(isOnline: true) # See the refund class method for more information
     #
     # @return {Integer} return the refund id
     def refund(refund_params = nil)

data/lib/magento/model.rb

@@ -7,14 +7,17 @@ module Magento
     include Magento::ModelParser
 
     def save
-      self.class.update(send(self.class.primary_key), to_h)
+      self.class.update(send(self.class.primary_key), to_h) do |hash|
+        update_attributes(hash)
+      end
     end
-
+    
     def update(attrs)
       raise "#{self.class.name} not saved" if send(self.class.primary_key).nil?
 
-      attrs.each { |key, value| send("#{key}=", value) }
-      save
+      self.class.update(send(self.class.primary_key), attrs) do |hash|
+        update_attributes(hash)
+      end
     end
 
     def delete
@@ -25,10 +28,15 @@ module Magento
       @id || send(self.class.primary_key)
     end
 
+    protected def update_attributes(hash)
+      ModelMapper.map_hash(self, hash)
+    end
+
     class << self
       extend Forwardable
 
-      def_delegators :query, :all, :page, :per, :page_size, :order, :select, :where
+      def_delegators :query, :all, :page, :per, :page_size, :order, :select, 
+                     :where, :first, :find_by, :count
 
       def find(id)
         hash = request.get("#{api_resource}/#{id}").parse
@@ -48,7 +56,8 @@ module Magento
       def update(id, attributes)
         body = { entity_key => attributes }
         hash = request.put("#{api_resource}/#{id}", body).parse
-        build(hash)
+
+        block_given? ? yield(hash) : build(hash)
       end
 
       def api_resource

data/lib/magento/model_mapper.rb

@@ -17,9 +17,12 @@ module Magento
     end
 
     def self.map_hash(model, values)
-      object = model.new
+      object = model.is_a?(Class) ? model.new : model
       values.each do |key, value|
-        object.singleton_class.instance_eval { attr_accessor key }
+        unless object.respond_to?(key) && object.respond_to?("#{key}=")
+          object.singleton_class.instance_eval { attr_accessor key }
+        end
+
         if value.is_a?(Hash)
           class_name = Magento.inflector.camelize(Magento.inflector.singularize(key))
           value = map_hash(Object.const_get("Magento::#{class_name}"), value)

data/lib/magento/order.rb

@@ -12,8 +12,9 @@ module Magento
     def update(attrs)
       raise "'entity_id' not found" if @entity_id.nil?
 
-      attrs[:entity_id] = @entity_id
-      self.class.update(attrs)
+      self.class.update(@entity_id, attrs) do |hash|
+        update_attributes(hash)
+      end
     end
 
     def cancel
@@ -33,6 +34,20 @@ module Magento
       self.class.invoice(id, params)
     end
 
+    
+    #
+    # Create offline refund for order
+    #
+    # order = Magento::Order.find(order_id)
+    #
+    # order.refund # or you can pass parameters
+    # order.invoice(notify: false) # See the refund class method for more information
+    #
+    # @return {Integer} return the refund id
+    def refund(refund_params = nil)
+      self.class.refund(id, refund_params)
+    end
+
     #
     # Creates new Shipment for given Order.
     #
@@ -47,9 +62,10 @@ module Magento
     end
 
     class << self
-      def update(attributes)
+      def update(entity_id, attributes)
+        attributes[:entity_id] = entity_id
         hash = request.put('orders/create', { entity_key => attributes }).parse
-        build(hash)
+        block_given? ? yield(hash) : build(hash)
       end
 
       # @return {Boolean}
@@ -84,6 +100,49 @@ module Magento
         request.post("order/#{order_id}/invoice", invoice_params).parse
       end
 
+      
+      #
+      # Create offline refund for order
+      #
+      # Magento::Order.refund(order_id)
+      #
+      # or
+      #
+      # Magento::Order.refund(
+      #   order_id,
+      #   items: [
+      #     {
+      #       extension_attributes: {},
+      #       order_item_id: 0,
+      #       qty: 0
+      #     }
+      #   ],
+      #   notify: true,
+      #   appendComment: true,
+      #   comment: {
+      #     extension_attributes: {},
+      #     comment: string,
+      #     is_visible_on_front: 0
+      #   },
+      #   arguments: {
+      #     shipping_amount: 0,
+      #     adjustment_positive: 0,
+      #     adjustment_negative: 0,
+      #     extension_attributes: {
+      #       return_to_stock_items: [
+      #         0
+      #       ]
+      #     }
+      #   }
+      # )
+      #
+      # to complete [documentation](https://magento.redoc.ly/2.4-admin/tag/invoicescomments#operation/salesRefundOrderV1ExecutePost)
+      #
+      # @return {Integer} return the refund id
+      def refund(order_id, refund_params = nil)
+        request.post("order/#{order_id}/refund", refund_params).parse
+      end
+
       #
       # Creates new Shipment for given Order.
       #

data/lib/magento/query.rb

@@ -89,6 +89,18 @@ module Magento
       RecordCollection.from_magento_response(result, model: model, iterable_field: field)
     end
 
+    def first
+      page_size(1).page(1).all.first
+    end
+
+    def find_by(attributes)
+      where(attributes).first
+    end
+
+    def count
+      select(:id).page_size(1).page(1).all.total_count
+    end
+
     private
 
     attr_accessor :current_page, :filter_groups, :request, :sort_orders, :model, :fields
@@ -119,10 +131,11 @@ module Magento
 
     def parse_filter(key)
       patter = /(.*)_([a-z]+)$/
-      raise 'Invalid format' unless key.match(patter)
-      raise 'Condition not accepted' unless ACCEPTED_CONDITIONS.include?(key.match(patter)[2])
+      match = key.match(patter)
+
+      return match.to_a[1..2] if match && ACCEPTED_CONDITIONS.include?(match[2])
 
-      key.match(patter).to_a[1..2]
+      [key, 'eq']
     end
 
     def parse_value_filter(condition, value)

data/lib/magento/version.rb

@@ -1,3 +1,3 @@
 module Magento
-  VERSION = '0.8.2'
+  VERSION = '0.11.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magento
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.11.0
 platform: ruby
 authors:
 - Wallas Faria