Ruby wrapper for the magento xmlrpc api
Ruby
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 31 commits ahead, 1 commit behind pstuteville:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
.gitignore
MIT-LICENSE
README.rdoc
Rakefile
TODOS
VERSION
init.rb
magentor.gemspec

README.rdoc

Magentor

Simple wrapper for the Magento XMLRPC api

Magento api documentation: www.magentocommerce.com/support/magento_core_api

Usage

Setup your connection to magento

Magento::Base.connection = Magento::Connection.new({
  :username => 'username', 
  :api_key => 'api_key', 
  :host => 'magento.example.org', 
  :path => '/magento/api/xmlrpc', 
  :port => '80'
})

Then get down to business

Magento::Customer.list
Magento::Product.info(1).sku
customer = Magento::Customer.find(:first, {:email => 'example@magentor.ccc'})
customer.update_attributes({:firstname => 'duke', :lastname => 'magentor'})
customer.delete

All classes currently available (cart classes newly added 6/11/2012)

Magento::Cart
Magento::CartProduct
Magento::CartCustomer
Magento::CartShipping
Magento::CartPayment
Magento::CartCoupon
Magento::CategoryAttribute
Magento::Category
Magento::Country
Magento::CustomerAddress
Magento::CustomerGroup
Magento::Customer
Magento::Inventory
Magento::Invoice
Magento::OrderItem
Magento::Order
Magento::ProductAttribute
Magento::ProductAttributeSet
Magento::ProductLink
Magento::ProductMedia
Magento::Product
Magento::ProductStock
Magento::ProductTierPrice
Magento::ProductType
Magento::Region
Magento::Shipment

License

Copyright © 2010 Preston Stuteville

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.