magentor 0.1.0

data/lib/magento/product_tier_price.rb

@@ -0,0 +1,51 @@
+module Magento
+  # http://www.magentocommerce.com/wiki/doc/webservices-api/api/catalog_product_type
+  # 100  Product not exists.
+  # 101  Invalid data given. Details in error message.
+  # 102  Tier prices not updated. Details in error message.
+  class ProductTierPrice < Base
+    class << self
+      # catalog_product_attribute_tier_price.info
+      # Retrieve product tier prices
+      # 
+      # Return: array - array of tier prices array(array(’website’ ⇒ ..., ‘customer_group_id’ ⇒ ..., ‘qty’ ⇒ ..., ‘price’ ⇒ ...))
+      # 
+      # Arguments:
+      # 
+      # mixed product - product ID or Sku
+      def info(*args)
+        new(commit("info", *args))
+      end
+
+      # catalog_product_attribute_tier_price.update
+      # Update product tier prices
+      # 
+      # Return: boolean
+      # 
+      # Arguments:
+      # 
+      # mixed product - product ID or Sku
+      # array tierPrices - array of tier prices 
+      #   =>  array(array(’website’ ⇒ ..., ‘customer_group_id’ ⇒ ..., ‘qty’ ⇒ ..., ‘price’ ⇒ ...))
+      def update(*args)
+        commit("update", *args)
+      end
+      
+      def find_by_product_id_or_sku(id)
+        list(id)
+      end
+    end
+    
+    # def update_attribute(name, value)
+    #   # TODO: find actual name of field for product id or sku
+    #   @attributes[name] = value
+    #   self.class.update(self.product, Hash[*[name.to_sym, value]])
+    # end
+    # 
+    # def update_attributes(attrs)
+    #   # TODO: find actual name of field for product id or sku
+    #   attrs.each_pair { |k, v| @attributes[k] = v }
+    #   self.class.update(self.product, attrs)
+    # end
+  end
+end

data/lib/magento/product_type.rb

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

data/lib/magento/region.rb

@@ -0,0 +1,25 @@
+module Magento
+  # http://www.magentocommerce.com/wiki/doc/webservices-api/api/directory_region
+  class Region < Base
+    class << self
+      # directory_region.list
+      # List of regions in specified country
+      # 
+      # Return: array
+      # 
+      # Arguments:
+      # 
+      # string $country - Country code in ISO2 or ISO3
+      def list(*args)
+        results = commit("list", *args)
+        results.collect do |result|
+          new(result)
+        end
+      end
+      
+      def find_by_country(iso)
+        list(iso)
+      end
+    end
+  end
+end

data/lib/magento/shipment.rb

@@ -0,0 +1,127 @@
+module Magento
+  # http://www.magentocommerce.com/wiki/doc/webservices-api/api/sales_order_shipment
+  # 100  Requested shipment not exists.
+  # 101  Invalid filters given. Details in error message.
+  # 102  Invalid data given. Details in error message.
+  # 103  Requested order not exists.
+  # 104  Requested tracking not exists.
+  # 105  Tracking not deleted. Details in error message.
+  class Shipment < Base
+    class << self      
+      # sales_order_shipment.list
+      # Retrieve list of shipments by filters
+      # 
+      # Return: array
+      # 
+      # Arguments:
+      # 
+      # array filters - filters for shipments list
+      def list(*args)
+        results = commit("list", *args)
+        results.collect do |result|
+          new(result)
+        end
+      end
+      
+      # sales_order_shipment.info
+      # Retrieve shipment information
+      # 
+      # Return: array
+      # 
+      # Arguments:
+      # 
+      # string shipmentIncrementId - order shipment increment id
+      def info(*args)
+        new(commit("info", *args))
+      end
+      
+      # sales_order_shipment.create
+      # Create new shipment for order
+      # 
+      # Return: string - shipment increment id
+      # 
+      # Arguments:
+      # 
+      # string orderIncrementId - order increment id
+      # array itemsQty - items qty to ship as associative array (order_item_id ⇒ qty)
+      # string comment - shipment comment (optional)
+      # boolean email - send e-mail flag (optional)
+      # boolean includeComment - include comment in e-mail flag (optional)
+      def create(*args)
+        id = commit("create", *args)
+        record = info(id)
+        record
+      end
+      
+      # sales_order_shipment.addComment
+      # Add new comment to shipment
+      # 
+      # Return: boolean
+      # 
+      # Arguments:
+      # 
+      # string shipmentIncrementId - shipment increment id
+      # string comment - shipment comment
+      # boolean email - send e-mail flag (optional)
+      # boolean includeInEmail - include comment in e-mail flag (optional)
+      def add_comment(*args)
+        commit('addComment', *args)
+      end
+      
+      # sales_order_shipment.addTrack
+      # Add new tracking number
+      # 
+      # Return: int
+      # 
+      # Arguments:
+      # 
+      # string shipmentIncrementId - shipment increment id
+      # string carrier - carrier code
+      # string title - tracking title
+      # string trackNumber - tracking number
+      def add_track(*args)
+        commit('addTrack', *args)
+      end
+      
+      # sales_order_shipment.removeTrack
+      # Remove tracking number
+      # 
+      # Return: boolean
+      # 
+      # Arguments:
+      # 
+      # string shipmentIncrementId - shipment increment id
+      # int trackId - track id
+      def remove_track(*args)
+        commit('removeTrack', *args)
+      end
+      
+      # sales_order_shipment.getCarriers
+      # Retrieve list of allowed carriers for order
+      # 
+      # Return: array
+      # 
+      # Arguments:
+      # 
+      # string orderIncrementId - order increment id
+      def get_carriers(*args)
+        commit('getCarriers', *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.rb

@@ -0,0 +1,16 @@
+# Ruby wrapper for the magento api
+#
+# Author::    Preston Stuteville  (mailto:preston.stuteville@gmail.com)
+# License::   MIT
+#
+# Inspiration from the Magento plugin from Tim Matheson (http://github.com/timmatheson/Magento) 
+       
+require 'magento/connection'
+
+#require 'xmlrpc'
+require 'xmlrpc/client'
+
+require 'magento/base'
+
+XMLRPC::Config::ENABLE_NIL_PARSER = true
+XMLRPC::Config::ENABLE_NIL_CREATE = true

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: magentor
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Preston Stuteville
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-24 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: preston.stuteville@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- TODOS
+- VERSION
+- init.rb
+- lib/magento.rb
+- lib/magento/base.rb
+- lib/magento/category.rb
+- lib/magento/category_attribute.rb
+- lib/magento/connection.rb
+- lib/magento/country.rb
+- lib/magento/customer.rb
+- lib/magento/customer_address.rb
+- lib/magento/customer_group.rb
+- lib/magento/inventory.rb
+- lib/magento/invoice.rb
+- lib/magento/order.rb
+- lib/magento/product.rb
+- lib/magento/product_attribute.rb
+- lib/magento/product_attribute_set.rb
+- lib/magento/product_link.rb
+- lib/magento/product_media.rb
+- lib/magento/product_stock.rb
+- lib/magento/product_tier_price.rb
+- lib/magento/product_type.rb
+- lib/magento/region.rb
+- lib/magento/shipment.rb
+has_rdoc: true
+homepage: http://github.com/pstuteville/magentor
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --inline-source
+- --line-numbers
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for the Magento xmlrpc api
+test_files: []
+