Prestashop API for Ruby
Add this line to your application's Gemfile:
gem 'prestashop', github: 'LeonardoGodoy/prestashop'
Use branch: 'master'
for local repository in case of bundler global config
Create new client for connect to your Prestashop WebService
client = Prestashop::ApiClient.new 'api_key', 'api_url'
Now you are able to communicate with Prestashop WebService
To call API request directly you can use this class.
Call HEAD on WebService API, returns +true+ if was request successfull or raise error, when request failed.
client.head :customer, 2 # => true
client.check :customer, 3 # => true
Call GET on WebService API, returns parsed Prestashop response or raise error, when request failed.
client.get :customer, 1 # => {id: 1 ...}
client.read :customer, [1,2] # => [{id: 1}, {id: 2}]
When you are using get, you can also filter, sort or limit response. In case, when you need to get all users you need to set user id as nil
Available options:
- filter
- display
- sort
- limit
- schema
- date
Call POST on WebService API, returns parsed Prestashop response if was request successfull or raise error, when request failed.
client.post :customer, { name: 'Steve' } # => true
Call PUT on WebService API, returns parsed Prestashop response if was request successfull or raise error, when request failed.
client.put :customer, 1, {surname: 'Jobs'} # => true
client.update :customer, 1, {nope: 'Jobs'} # => false
Call DELETE on WebService API, returns +true+ if was request successfull or raise error, when request failed.
client.delete :customer, 1 # => true
Please read inline docs inside lib/prestashop/mapper/extension.rb
, available models are defined in lib/prestashop/mapper/models
After reading that you can do something like this
id_lang = Prestashop::Mapper::Language.find_by_iso_code(client, 'cs')
id_supplier = Prestashop::Mapper::Supplier.new(name: 'apple').find_or_create(client)
product = Prestashop::Mapper::Product.new(id_lang: id_lang, id_supplier: id_supplier, reference: 'apple-macbook')
if product.find?(client)
product.update(client, price: '1299')
else
product.description = 'My description'
product.price = '1299'
product.create(client)
end
- Fork it
- 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 new Pull Request