magento 0.5.3 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aec02bf72da9b4812e5adbc2a2a8fd9d66b3ad31c287feff93b337de98aa8a65
-  data.tar.gz: cef460b2b97f8d8d1af44f0bbfdf02f7f871f259b2128c79a7c446594390f33c
+  metadata.gz: 8ad71d2a627ff149bce29e8ad50d8f71926a19079c2af86000db29109d305c65
+  data.tar.gz: bc2f85e76ff1da204aa8d613a770401763bee486e6dd045af6b4e97df8758f62
 SHA512:
-  metadata.gz: 579fe0607e167da30ef2a7b96ad6211a5adbfe7ffcfd6d9bf0460dc21bf1b9636910f1d05180ab5630975d782cec2b2ee556d7d23d37cb264163e8e243fd1f79
-  data.tar.gz: a279b99945260866c161ed5720113efbcd9e3571be2cf8a35be742a7acf1f3fb8398c9b1d58a68727daa35874a40de715291350304f5d889e8b4cd49ca8d0bc2
+  metadata.gz: 2166a5412b4f41a7298efe838d5ad927d60905206af025a745420109ff87700c56d0adaaea49da0d2a4519fb34b2abafcedbabb810bfc6972fe28c92bd29c61a
+  data.tar.gz: 400d5d6ef1669fb147a0281312a9504ee252d7d1a46debab0bb61cdc51286d6c0c4956dfeb355a691d49bd4d0f06e044f9fe0f9968a0d3529dcdde8b36ebd732

data/README.md

@@ -5,7 +5,7 @@
 Add in your Gemfile
 
 ```rb
-gem 'magento', '~> 0.5.3'
+gem 'magento', '~> 0.8.1'
 ```
 
 or run
@@ -155,6 +155,12 @@ products.size
 products.current_page
 >> 1
 
+products.next_page
+>> 2
+
+products.last_page?
+>> false
+
 products.page_size
 >> 5
 
@@ -170,6 +176,8 @@ All Methods:
 ```rb
 # Information about search criteria
 :current_page
+:next_page
+:last_page?
 :page_size
 :total_count
 :filter_groups
@@ -280,6 +288,140 @@ cart.payment_information(
 >> "234575" # return the order id
 ```
 
+## Invoice an Order
+
+```rb
+Magento::Order.invoice(order_id)
+>> 25 # return incoice id
+
+# or from instance
+
+order = Magento::Order.find(order_id)
+
+invoice_id = order.invoice
+
+# you can pass parameters too
+
+invoice_id = order.invoice(
+  capture: false,
+  appendComment: true,
+  items: [{ order_item_id: 123, qty: 1 }], # pass items to partial invoice
+  comment: {
+    extension_attributes: { },
+    comment: "string",
+    is_visible_on_front: 0
+  },
+  notify: true
+)
+```
+
+[Complete Invoice Documentation](https://magento.redoc.ly/2.4-admin/tag/orderorderIdinvoice#operation/salesInvoiceOrderV1ExecutePost)
+
+## Create refund for invoice
+
+```rb
+Magento::Invoice.invoice(refund_id)
+>> 12 # return refund id
+
+# or from instance
+
+invoice = Magento::Invoice.find(invoice_id)
+
+refund_id = invoice.refund
+
+# you can pass parameters too
+
+invoice.refund(
+  items: [
+    {
+      extension_attributes: {},
+      order_item_id: 0,
+      qty: 0
+    }
+  ],
+  isOnline: true,
+  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/salesRefundInvoiceV1ExecutePost)
+
+
+## Other Invoice methods
+
+```rb
+invoice = Magento::Invoice.find(invoice_id)
+
+invoice.capture # or
+Magento::Invoice.capture(invoice_id)
+
+invoice.void # or
+Magento::Invoice.void(invoice_id)
+
+invoice.send_email # or
+Magento::Invoice.send_email(invoice_id)
+
+Magento::Invoice.comments(invoice_id).all
+Magento::Invoice.comments(invoice_id).where(created_at_gt: Date.today.prev_day).all
+```
+
+## Creates new Shipment for given Order.
+
+```rb
+Magento::Order.ship(order_id)
+>> 25 # return shipment id
+
+# or from instance
+
+order = Magento::Order.find(order_id)
+
+order.ship
+
+# you can pass parameters too
+
+order.ship(
+  capture: false,
+  appendComment: true,
+  items: [{ order_item_id: 123, qty: 1 }], # pass items to partial shipment
+  tracks: [
+    {
+      extension_attributes: { },
+      track_number: "string",
+      title: "string",
+      carrier_code: "string"
+    }
+  ]
+  notify: true
+)
+```
+
+[Complete Shipment Documentation](https://magento.redoc.ly/2.4-admin/tag/orderorderIdship#operation/salesShipOrderV1ExecutePost)
+
+
+## Cancel an Order
+
+```rb
+order = Magento::Order.find(order_id)
+
+order.cancel # or
+
+Magento::Order.cancel(order_id)
+```
+
 ___
 
 ##TODO:
@@ -288,3 +430,31 @@ ___
 ```rb
 Magento::Product.search('tshort')
 ```
+
+### First result
+```rb
+Magento::Product.first
+>> <Magento::Product @sku="some-sku" ...>
+
+Magento::Product.where(name_like: 'some name%').first
+>> <Magento::Product @sku="some-sku" ...>
+```
+
+### Last result
+```rb
+Magento::Product.last
+>> <Magento::Product @sku="some-sku" ...>
+
+Magento::Product.where(name_like: 'some name%').last
+>> <Magento::Product @sku="some-sku" ...>
+```
+
+### Count result
+```rb
+Magento::Product.count
+>> 7855
+Magento::Product.where(name_like: 'some name%').count
+>> 15
+```
+
+### Tests

data/lib/magento.rb

@@ -6,6 +6,7 @@ require 'dry/inflector'
 require_relative 'magento/errors'
 require_relative 'magento/request'
 require_relative 'magento/model_mapper'
+require_relative 'magento/polymorphic_model'
 require_relative 'magento/model'
 require_relative 'magento/record_collection'
 require_relative 'magento/query'
@@ -14,6 +15,7 @@ require_relative 'magento/product'
 require_relative 'magento/country'
 require_relative 'magento/customer'
 require_relative 'magento/order'
+require_relative 'magento/invoice'
 require_relative 'magento/guest_cart'
 
 Dir[File.expand_path('magento/shared/*.rb', __dir__)].map { |f| require f }

data/lib/magento/invoice.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+module Magento
+  class Invoice < Model
+    self.primary_key = :entity_id
+    self.entity_key = :entity
+
+    #
+    # Sets invoice capture.
+    def capture
+      self.class.capture(id)
+    end
+
+    #
+    # Voids a specified invoice.
+    #
+    # @return {Boolean}
+    def void
+      self.class.void(id)
+    end
+
+    #
+    # Emails a user a specified invoice.
+    #
+    # @return {Boolean}
+    def send_email
+      self.class.send_email(id)
+    end
+
+    #
+    # Create refund for invoice
+    #
+    # 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
+    #
+    # @return {Integer} return the refund id
+    def refund(refund_params = nil)
+      self.class.refund(id, refund_params)
+    end
+
+    class << self
+      def save
+        raise NotImplementedError
+      end
+
+      def update(_attributes)
+        raise NotImplementedError
+      end
+
+      def create(_attributes)
+        raise NotImplementedError
+      end
+
+      #
+      # Sets invoice capture.
+      def capture(invoice_id)
+        request.post("invoices/#{invoice_id}/capture").parse
+      end
+
+      #
+      # Voids a specified invoice.
+      #
+      # @return {Boolean}
+      def void(invoice_id)
+        request.post("invoices/#{invoice_id}/avoid").parse
+      end
+
+      #
+      # Emails a user a specified invoice.
+      #
+      # @return {Boolean}
+      def send_email(invoice_id)
+        request.post("invoices/#{invoice_id}/emails").parse
+      end
+
+      #
+      # Lists comments for a specified invoice.
+      #
+      # Magento::Invoice.comments(invoice_id).all
+      # Magento::Invoice.comments(invoice_id).where(created_at_gt: Date.today.prev_day).all
+      def comments(invoice_id)
+        api_resource = "invoices/#{invoice_id}/comments"
+        Query.new(PolymorphicModel.new(Comment, api_resource))
+      end
+
+      #
+      # Create refund for invoice
+      #
+      # Magento::Invoice.refund(invoice_id)
+      #
+      # or
+      #
+      # Magento::Invoice.refund(
+      #   invoice_id,
+      #   items: [
+      #     {
+      #       extension_attributes: {},
+      #       order_item_id: 0,
+      #       qty: 0
+      #     }
+      #   ],
+      #   isOnline: true,
+      #   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/salesRefundInvoiceV1ExecutePost)
+      #
+      # @return {Integer} return the refund id
+      def refund(invoice_id, refund_params=nil)
+        request.post("invoice/#{invoice_id}/refund", invoice_params).parse
+      end
+    end
+  end
+end

data/lib/magento/order.rb

@@ -16,11 +16,103 @@ module Magento
       self.class.update(attrs)
     end
 
+    def cancel
+      self.class.cancel(id)
+    end
+
+    #
+    # Invoice current order
+    #
+    # order = Magento::Order.find(order_id)
+    #
+    # order.invoice # or you can pass parameters
+    # order.invoice(capture: false) # See the invoice class method for more information
+    #
+    # @return String: return the invoice id
+    def invoice(params=nil)
+      self.class.invoice(id, params)
+    end
+
+    #
+    # Creates new Shipment for given Order.
+    #
+    # order = Magento::Order.find(order_id)
+    #
+    # order.ship # or you can pass parameters
+    # order.ship(notify: false) # See the shipment class method for more information
+    #
+    # Return the shipment id
+    def ship(params=nil)
+      self.class.ship(id, params)
+    end
+
     class << self
       def update(attributes)
         hash = request.put('orders/create', { entity_key => attributes }).parse
         build(hash)
       end
+
+      # @return {Boolean}
+      def cancel(order_id)
+        request.post("orders/#{order_id}/cancel").parse
+      end
+
+      #
+      # Invoice an order
+      #
+      # Magento::Order.invoice(order_id)
+      #
+      # or
+      #
+      # Magento::Order.invoice(
+      #   order_id,
+      #   capture: false,
+      #   appendComment: true,
+      #   items: [{ order_item_id: 123, qty: 1 }], # pass items to partial invoice
+      #   comment: {
+      #     extension_attributes: { },
+      #     comment: "string",
+      #     is_visible_on_front: 0
+      #   },
+      #   notify: true
+      # )
+      #
+      # to complete [documentation](https://magento.redoc.ly/2.4-admin/tag/orderorderIdinvoice#operation/salesInvoiceOrderV1ExecutePost)
+      #
+      # @return String: return the invoice id
+      def invoice(order_id, invoice_params=nil)
+        request.post("order/#{order_id}/invoice", invoice_params).parse
+      end
+
+      #
+      # Creates new Shipment for given Order.
+      #
+      # Magento::Order.ship(order_id)
+      #
+      # or
+      #
+      # Magento::Order.ship(
+      #   order_id,
+      #   capture: false,
+      #   appendComment: true,
+      #   items: [{ order_item_id: 123, qty: 1 }], # pass items to partial shipment
+      #   tracks: [
+      #     {
+      #       extension_attributes: { },
+      #       track_number: "string",
+      #       title: "string",
+      #       carrier_code: "string"
+      #     }
+      #   ]
+      #   notify: true
+      # )
+      #
+      # to complete [documentation](https://magento.redoc.ly/2.4-admin/tag/orderorderIdship#operation/salesShipOrderV1ExecutePost)
+      #
+      # @return {String}: return the shipment id
+      def ship(order_id, shipment_params = nil)
+        request.post("order/#{order_id}/ship", shipment_params).parse
+      end
     end
   end
 end

data/lib/magento/polymorphic_model.rb

@@ -0,0 +1,18 @@
+module Magento
+  class PolymorphicModel
+    attr_reader :api_resource
+
+    def initialize(model, api_resource)
+      @model = model
+      @api_resource = api_resource
+    end
+
+    def new
+      @model.new
+    end
+
+    def build(attributes)
+      @model.build(attributes)
+    end
+  end
+end

data/lib/magento/record_collection.rb

@@ -23,6 +23,17 @@ module Magento
 
     alias per page_size
 
+    def last_page?
+      current_page * page_size >= total_count
+    end
+
+    #
+    # Returns the {number} of the next page or {nil} 
+    # when the current_page is the last page
+    def next_page
+      current_page + 1 unless last_page?
+    end
+
     class << self
       def from_magento_response(response, model:, iterable_field: 'items')
         Magento::RecordCollection.new(

data/lib/magento/shared/comment.rb

@@ -0,0 +1,5 @@
+module Magento
+  class Comment
+    include Magento::ModelParser
+  end
+end

data/lib/magento/version.rb

@@ -1,3 +1,3 @@
 module Magento
-  VERSION = '0.5.3'
+  VERSION = '0.8.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magento
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.8.1
 platform: ruby
 authors:
 - Wallas Faria
@@ -54,9 +54,11 @@ files:
 - lib/magento/customer.rb
 - lib/magento/errors.rb
 - lib/magento/guest_cart.rb
+- lib/magento/invoice.rb
 - lib/magento/model.rb
 - lib/magento/model_mapper.rb
 - lib/magento/order.rb
+- lib/magento/polymorphic_model.rb
 - lib/magento/product.rb
 - lib/magento/query.rb
 - lib/magento/record_collection.rb
@@ -66,6 +68,7 @@ files:
 - lib/magento/shared/billing_address.rb
 - lib/magento/shared/bundle_product_option.rb
 - lib/magento/shared/category_link.rb
+- lib/magento/shared/comment.rb
 - lib/magento/shared/configurable_product_option.rb
 - lib/magento/shared/currency.rb
 - lib/magento/shared/custom_attribute.rb