Magenthor (ALPHA)
A Rubygem wrapper for the XMLRPC Magento API.
This code is inspired by, but not based on, magentor gem
Installation
$ gem install magenthor
This gem is still in an early stage of development and I discourage the installation except for debugging (or curiosity) purposes.
Usage
Initialize the connection
Magenthor::Base.setup({
:port => 80,
:host => 'magentohost.tld',
:api_user => 'apiuser',
:api_key => 'apikey'
})
Get the list of customers
Magnethor::Customer.list
Find a customer by ID
Magenthor::Customer.find 1
Find customers by Magento attribute
Magenthor::Customer.find_by_email "[email protected]"
Magenthor::Customer.find_by_group_id 2
#Magenthor::Customer.find_by_[magento customer attribute]
Update a customer attributes
customer = Magenthor::Customer.find 1
customer.firstname = "John"
customer.update
#=> true
Create a new customer
customer = Magenthor::Customer.new
customer.email = "[email protected]"
customer.password = "p4ssw0rd"
customer.website_id = 1
customer.create
#=> true
Delete a customer
customer = Magenthor::Customer.find 1
customer.delete
#=> true
Contributing
- Fork it ( https://github.com/Ryuk87/magenthor/fork )
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request