magentor 0.1.0

data/lib/magento/invoice.rb

@@ -0,0 +1,132 @@
+module Magento
+  # http://www.magentocommerce.com/wiki/doc/webservices-api/api/sales_order_invoice
+  # 100  Requested shipment does not exists.
+  # 101  Invalid filters given. Details in error message.
+  # 102  Invalid data given. Details in error message.
+  # 103  Requested order does not exists
+  # 104  Invoice status not changed.
+  class Invoice < Base
+    class << self      
+      # sales_order_invoice.list
+      # Retrieve list of invoices by filters
+      # 
+      # Return: array Arguments:
+      # 
+      # array filters - filters for invoices list (optional)
+      def list(*args)
+        results = commit("list", *args)
+        results.collect do |result|
+          new(result)
+        end
+      end
+      
+      # sales_order_invoice.info
+      # Retrieve invoice information
+      # 
+      # Return: array
+      # 
+      # Arguments:
+      # 
+      # string invoiceIncrementId - invoice increment id
+      def info(*args)
+        new(commit("info", *args))
+      end
+      
+      # sales_order_invoice.create
+      # Create new invoice for order
+      # 
+      # Return: string
+      # 
+      # Arguments:
+      # 
+      # string orderIncrementId - order increment id
+      # array itemsQty - items qty to invoice
+      # string comment - invoice comment (optional)
+      # boolean email - send invoice on e-mail (optional)
+      # boolean includeComment - include comments in e-mail (optional)
+      def create(*args)
+        id = commit("create", *args)
+        record = info(id)
+        record
+      end
+      
+      # sales_order_invoice.addComment
+      # Add new comment to shipment
+      # 
+      # Arguments:
+      # 
+      # string invoiceIncrementId - invoice increment id
+      # string comment - invoice comment
+      # boolean email - send invoice on e-mail (optional)
+      # boolean includeComment - include comments in e-mail (optional)
+      def add_comment(*args)
+        commit('addComment', *args)
+      end
+      
+      # sales_order_invoice.capture
+      # Capture invoice
+      # 
+      # Return: boolean
+      # 
+      # Arguments:
+      # 
+      # string invoiceIncrementId - invoice increment id
+      # 
+      # Notes:
+      # 
+      # You should check the invoice to see if can be captured before attempting to capture an invoice, 
+      # otherwise the API call with generate an error.
+      # 
+      # Invoices have states as defined in the model Mage_Sales_Model_Order_Invoice:
+      # 
+      # STATE_OPEN = 1
+      # STATE_PAID = 2
+      # STATE_CANCELED = 3
+      # Also note there is a method call in the model that checks this for you canCapture(), and it also 
+      # verifies that the payment is able to be captured, so the invoice state might not be the only 
+      # condition that’s required to allow it to be captured.
+      def capture(*args)
+        commit('capture', *args)
+      end
+      
+      # sales_order_invoice.void
+      # Void invoice
+      # 
+      # Return: boolean
+      # 
+      # Arguments:
+      # 
+      # string invoiceIncrementId - invoice increment id
+      def void(*args)
+        commit('void', *args)
+      end
+      
+      # sales_order_invoice.cancel
+      # Cancel invoice
+      # 
+      # Return: boolean
+      # 
+      # Arguments:
+      # 
+      # string invoiceIncrementId - invoice increment id
+      def cancel(*args)
+        commit('cancel', *args)
+      end
+      
+      def find_by_id(id)
+        info(id)
+      end
+
+      def find(find_type, options = {})
+        filters = {}
+        options.each_pair { |k, v| filters[k] = {:eq => v} }
+        results = list(filters)
+        if find_type == :first
+          results.first
+        else
+          results
+        end
+      end
+    end
+  end
+end

data/lib/magento/order.rb

@@ -0,0 +1,103 @@
+module Magento
+  class Order < Base
+    # http://www.magentocommerce.com/wiki/doc/webservices-api/api/sales_order
+    # 100  Requested order not exists.
+    # 101  Invalid filters given. Details in error message.
+    # 102  Invalid data given. Details in error message.
+    # 103  Order status not changed. Details in error message.
+    class << self      
+      # sales_order.list
+      # Retrieve list of orders by filters
+      # 
+      # Return: array
+      # 
+      # Arguments:
+      # 
+      # array filters - filters for order list (optional)
+      def list(*args)
+        results = commit("list", *args)
+        results.collect do |result|
+          new(result)
+        end
+      end
+      
+      # sales_order.info
+      # Retrieve order information
+      # 
+      # Return: array
+      # 
+      # Arguments:
+      # 
+      # string orderIncrementId - order increment id
+      def info(*args)
+        new(commit("info", *args))
+      end
+      
+      # sales_order.addComment
+      # Add comment to order
+      # 
+      # Return: boolean
+      # 
+      # Arguments:
+      # 
+      # string orderIncrementId - order increment id
+      # string status - order status
+      # string comment - order comment (optional)
+      # boolean notify - notification flag (optional)
+      def add_comment(*args)
+        commit('addComment', *args)
+      end
+      
+      # sales_order.hold
+      # Hold order
+      # 
+      # Return: boolean
+      # 
+      # Arguments:
+      # 
+      # string orderIncrementId - order increment id
+      def hold(*args)
+        commit('hold', *args)
+      end
+      
+      # sales_order.unhold
+      # Unhold order
+      # 
+      # Return: boolean
+      # 
+      # Arguments:
+      # 
+      # mixed orderIncrementId - order increment id
+      def unhold(*args)
+        commit('unhold', *args)
+      end
+      
+      # sales_order.cancel
+      # Cancel order
+      # 
+      # Return: boolean
+      # 
+      # Arguments:
+      # 
+      # mixed orderIncrementId - order increment id
+      def cancel(*args)
+        commit('cancel', *args)
+      end
+      
+      def find_by_id(id)
+        info(id)
+      end
+
+      def find(find_type, options = {})
+        filters = {}
+        options.each_pair { |k, v| filters[k] = {:eq => v} }
+        results = list(filters)
+        if find_type == :first
+          results.first
+        else
+          results
+        end
+      end
+    end
+  end
+end

data/lib/magento/product.rb

@@ -0,0 +1,159 @@
+module Magento
+  # http://www.magentocommerce.com/wiki/doc/webservices-api/api/catalog_product
+  # 100  Requested store view not found.
+  # 101  Product not exists.
+  # 102  Invalid data given. Details in error message.
+  # 103  Product not deleted. Details in error message.
+  class Product < Base  
+    class << self
+      # catalog_product.list
+      # Retrieve products list by filters
+      # 
+      # Return: array
+      # 
+      # Arguments:
+      # 
+      # array filters - array of filters by attributes (optional)
+      # mixed storeView - store view ID or code (optional)
+      def list(*args)
+        results = commit("list", *args)
+        results.collect do |result|
+          new(result)
+        end
+      end
+
+      # catalog_product.create
+      # Create new product and return product id
+      # 
+      # Return: int
+      # 
+      # Arguments:
+      # 
+      # string type - product type
+      # int set - product attribute set ID
+      # string sku - product SKU
+      # array productData - array of attributes values
+      def create(*args)
+        id = commit("create", *args)
+        record = info(id)
+        record
+      end
+
+      # catalog_product.info
+      # Retrieve product
+      # 
+      # Return: array
+      # 
+      # Arguments:
+      # 
+      # mixed product - product ID or Sku
+      # mixed storeView - store view ID or code (optional)
+      # array attributes - list of attributes that will be loaded (optional)
+      def info(*args)
+        new(commit("info", *args))
+      end
+
+      # catalog_product.update
+      # Update product
+      # 
+      # Return: boolean
+      # 
+      # Arguments:
+      # 
+      # mixed product - product ID or Sku
+      # array productData - array of attributes values
+      # mixed storeView - store view ID or code (optional)
+      def update(*args)
+        commit("update", *args)
+      end
+
+
+      # catalog_product.delete
+      # Delete product
+      # 
+      # Return: boolean
+      # 
+      # Arguments:
+      # 
+      # mixed product - product ID or Sku
+      def delete(*args)
+        commit("delete", *args)
+      end
+
+      # catalog_product.currentStore
+      # Set/Get current store view
+      # 
+      # Return: int
+      # 
+      # Arguments:
+      # 
+      # mixed storeView - store view ID or code (optional)
+      def current_store(*args)
+        commit("currentStore", *args)
+      end
+
+      # catalog_product.setSpecialPrice
+      # Update product special price
+      # 
+      # Return: boolean
+      # 
+      # Arguments:
+      # 
+      # mixed product - product ID or Sku
+      # float specialPrice - special price (optional)
+      # string fromDate - from date (optional)
+      # string toDate - to date (optional)
+      # mixed storeView - store view ID or code (optional)
+      def set_special_price(*args)
+        commit('setSpecialPrice', *args)
+      end
+
+      # catalog_product.getSpecialPrice
+      # Get product special price data
+      # 
+      # Return: array
+      # 
+      # Arguments:
+      # 
+      # mixed product - product ID or Sku
+      # mixed storeView - store view ID or code (optional)
+      def get_special_price(*args)
+        commit('getSpecialPrice', *args)
+      end
+      
+      def find_by_id_or_sku(id)
+        info(id)
+      end
+
+      def find(find_type, options = {})
+        filters = {}
+        options.each_pair { |k, v| filters[k] = {:eq => v} }
+        results = list(filters)
+        if find_type == :first
+          results.first
+        else
+          results
+        end
+      end
+
+      def all
+        list
+      end
+      
+    end
+    
+    def delete
+      self.class.delete(self.id)
+    end
+    
+    def update_attribute(name, value)
+      @attributes[name] = value
+      self.class.update(self.id, Hash[*[name.to_sym, value]])
+    end
+    
+    def update_attributes(attrs)
+      attrs.each_pair { |k, v| @attributes[k] = v }
+      self.class.update(self.id, attrs)
+    end
+  end
+end

data/lib/magento/product_attribute.rb

@@ -0,0 +1,49 @@
+module Magento
+  # http://www.magentocommerce.com/wiki/doc/webservices-api/api/catalog_product_attribute
+  # 100  Requested store view not found.
+  # 101  Requested attribute not found.
+  class ProductAttribute < Base
+    class << self
+      # catalog_product_attribute.list
+      # Retrieve attribute list
+      # 
+      # Return: array
+      # 
+      # Arguments:
+      # 
+      # int setId - attribute set ID
+      def list(*args)
+        results = commit("list", *args)
+        results.collect do |result|
+          new(result)
+        end
+      end
+
+      # catalog_product_attribute.currentStore
+      # Set/Get current store view
+      # 
+      # Return: int
+      # 
+      # Arguments:
+      # 
+      # mixed storeView - store view id or code (optional)
+      def current_store(*args)
+        commit("currentStore", *args)
+      end
+
+
+      # catalog_product_attribute.options
+      # Retrieve attribute options
+      # 
+      # Return: array
+      # 
+      # Arguments:
+      # 
+      # mixed attributeId - attribute ID or code
+      # mixed storeView - store view ID or code (optional)
+      def options(*args)
+        commit("options", *args)
+      end
+    end
+  end
+end

data/lib/magento/product_attribute_set.rb

@@ -0,0 +1,17 @@
+module Magento
+  # http://www.magentocommerce.com/wiki/doc/webservices-api/api/catalog_product_attribute_set
+  class ProductAttributeSet < Base
+    class << self
+      # catalog_product_attribute_set.list
+      # Retrieve product attribute sets
+      # 
+      # Return: array
+      def list
+        results = commit("list", nil)
+        results.collect do |result|
+          new(result)
+        end
+      end
+    end
+  end
+end

data/lib/magento/product_link.rb

@@ -0,0 +1,90 @@
+module Magento
+  # http://www.magentocommerce.com/wiki/doc/webservices-api/api/catalog_product_link
+  # 100  Given invalid link type.
+  # 101  Product not exists.
+  # 102  Invalid data given. Details in error message.
+  # 104  Product link not removed.
+  class ProductLink < Base
+    class << self
+      # catalog_product_link.list
+      # Retrieve linked products
+      # 
+      # Return: array
+      # 
+      # Arguments:
+      # 
+      # string type - link type (cross_sell, up_sell, related, grouped)
+      # mixed product - product ID or Sku
+      def list(*args)
+        results = commit("list", *args)
+        results.collect do |result|
+          new(result)
+        end
+      end
+      
+      # catalog_product_link.assign
+      # Assign product link
+      # 
+      # Return: boolean
+      # 
+      # Arguments:
+      # 
+      # string type - link type (up_sell, cross_sell, related, grouped)
+      # mixed product - product ID or Sku
+      # mixed linkedProduct - product ID or Sku for link
+      # array data - link data (position, qty, etc ...) (optional)
+      def assign(*args)
+        commit('assign', *args)
+      end
+      
+      # catalog_product_link.update
+      # Update product link
+      # 
+      # Return: boolean
+      # 
+      # Arguments:
+      # 
+      # string type - link type (up_sell, cross_sell, related, grouped)
+      # mixed product - product ID or Sku
+      # mixed linkedProduct - product ID or Sku for link
+      # array data - link data (position, qty, etc ...) (optional)
+      def update(*args)
+        commit('update', *args)
+      end
+            
+      # catalog_product_link.remove
+      # Remove product link
+      # 
+      # Return: boolean
+      # 
+      # Arguments:
+      # 
+      # string type - link type (up_sell, cross_sell, related, grouped)
+      # mixed product - product ID or Sku
+      # mixed linkedProduct - product ID or Sku for link
+      def remove(*args)
+        commit('remove', *args)
+      end
+      
+      # catalog_product_link.types
+      # Retrieve product link types
+      # 
+      # Return: array
+      def types
+        commit('types', nil)
+      end
+      
+      # catalog_product_link.attributes
+      # Retrieve product link type attributes
+      # 
+      # Return: array
+      # 
+      # Arguments:
+      # 
+      # string type - link type (cross_sell, up_sell, related, grouped)
+      def attributes(*args)
+        commit('attributes', *args)
+      end
+    end
+  end
+end

data/lib/magento/product_media.rb

@@ -0,0 +1,122 @@
+module Magento
+  # http://www.magentocommerce.com/wiki/doc/webservices-api/api/catalog_product_attribute_media
+  # 100  Requested store view not found.
+  # 101  Product not exists.
+  # 102  Invalid data given. Details in error message.
+  # 103  Requested image not exists in product images’ gallery.
+  # 104  Image creation failed. Details in error message.
+  # 105  Image not updated. Details in error message.
+  # 106  Image not removed. Details in error message.
+  # 107  Requested product doesn’t support images
+  class ProductMedia < Base
+    class << self
+      # catalog_product_attribute_media.list
+      # Retrieve product image list
+      # 
+      # Return: array
+      # 
+      # Arguments:
+      # 
+      # mixed product - product ID or Sku
+      # mixed storeView - store view ID or code (optional)
+      def list(*args)
+        results = commit("list", *args)
+        results.collect do |result|
+          new(result)
+        end
+      end
+
+      # catalog_product_attribute_media.create
+      # Upload new product image
+      # 
+      # Return: string - image file name
+      # 
+      # Arguments:
+      # 
+      # mixed product - product ID or code
+      # array data - image data. requires file content in base64, and image mime-type. 
+      #   Example: array(’file’ ⇒ array(’content’ ⇒ base64_encode($file), ‘mime’ ⇒ ‘type/jpeg’)
+      #   mixed storeView - store view ID or code (optional)
+      def create(*args)
+        id = commit("create", *args)
+        record = info(id)
+        record
+      end
+
+      # catalog_product_attribute_media.info
+      # Retrieve product image data
+      # 
+      # Return: array
+      # 
+      # Arguments:
+      # 
+      # mixed product - product ID or Sku
+      # string file - image file name
+      # mixed storeView - store view ID or code (optional)
+      def info(*args)
+        new(commit("info", *args))
+      end
+
+      # catalog_product_attribute_media.update
+      # Update product image
+      # 
+      # Return: boolean
+      # 
+      # Arguments:
+      # 
+      # mixed product - product ID or code
+      # string file - image file name
+      # array data - image data (label, position, exclude, types)
+      # mixed storeView - store view ID or code (optional)
+      def update(*args)
+        commit("update", *args)
+      end
+
+      # catalog_product_attribute_media.remove
+      # Remove product image
+      # 
+      # Return: boolean
+      # 
+      # Arguments:
+      # 
+      # mixed product - product ID or Sku
+      # string file - image file name
+      def remove(*args)
+        commit("remove", *args)
+      end
+
+      # catalog_product_attribute_media.currentStore
+      # Set/Get current store view
+      # 
+      # Return: int
+      # 
+      # Arguments:
+      # 
+      # mixed storeView - store view code or ID (optional)
+      def current_store(*args)
+        commit("currentStore", *args)
+      end
+
+      # catalog_product_attribute_media.types
+      # Retrieve product image types (image, small_image, thumbnail, etc...)
+      # 
+      # Return: array
+      # 
+      # Arguments:
+      # 
+      # int setId - product attribute set ID
+      def types(*args)
+        commit("types", *args)
+      end
+      
+      def find_by_product_id_or_sku(id)
+        list(id)
+      end
+    end
+    
+    # def delete
+    #   # TODO: get actual field names for product and file
+    #   self.class.remove(self.product, self.file)
+    # end
+  end
+end 

data/lib/magento/product_stock.rb

@@ -0,0 +1,36 @@
+module Magento
+  # http://www.magentocommerce.com/wiki/doc/webservices-api/api/cataloginventory_stock_item
+  # 101  Product not exists.
+  # 102  Product inventory not updated. Details in error message.
+  class ProductStock < Base
+    class << self
+      # cataloginventory_stock_item.list
+      # Retrieve stock data by product ids
+      # 
+      # Return: array
+      # 
+      # Arguments:
+      # 
+      # array products - list of products IDs or Skus
+      def list(*args)
+        results = commit("list", *args)
+        results.collect do |result|
+          new(result)
+        end
+      end
+            
+      # cataloginventory_stock_item.update
+      # Update product stock data
+      # 
+      # Return: boolean
+      # 
+      # Arguments:
+      # 
+      # mixed product - product ID or Sku
+      # array data - data to change (qty, is_in_stock)
+      def update(*args)
+        commit('update', *args)
+      end
+    end
+  end
+end