ZookalMagentoRestApi

Ruby wrapper for backend calls to Zookal's Magento store. Prior authentication & authorization (through oAuth) required.

Installation

Add this line to your application's Gemfile:

gem 'zookal_magento_rest_api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install zookal_magento_rest_api

Setup

Create a file config/initializers/zookal_magento_rest_api.rb with the following content and restart Rails after saving the file:

ZookalMagentoRestApi.configure do |config|
  config.consumer_key = "123dsfdsafQ231"                                                             # from Magento Admin panel
  config.consumer_secret = "23dfsfFdsfsdee"                                                          # from Magento Admin panel
  config.site = "https://www.zookal.com"                                                             # without trailing slash and no redirects (e.g. root domain to www)
  config.access_key = "3434412373rf"                                                                 # from prior authentication
  config.access_secret = "df23sdfsf23a"                                                              # from prior authentication
  config.url_params = "utm_source=some-company&utm_medium=affiliate&utm_campaign=newsletter-01-2014" # optional
end

Important: Make sure the URL in the site configuration is without trailing slash and has no redirect (e.g. https://zookal.com redirects to https://www.zookal.com). Otherwise you'll get a 301 Redirect error for each request.

Information on how to obtain access_key and access_secret can be seen here

Usage

Instantiate a client

zookal_magento_client = ZookalMagentoRestApi::Client.new

Query a book

book_buy_new = zookal_magento_client.find_by(isbn: 9781442531109, purchase_type: "Buy New")
book_rent = zookal_magento_client.find_by(isbn: 9781442531109, purchase_type: "Rent")

Check if a book exists

book_buy_new.present?

Get attributes

book_buy_new.url_with_params    # Full URL with specified params in `config/zookal_magento_rest_api.rb`
book_buy_new.special_price      # Price
book_buy_new.price              # RRP
book_buy_new.author             # Author
book_buy_new.sku                # SKU
book_buy_new.name               # Name
book_buy_new.edition            # Edition
book_buy_new.publisher          # Publisher
book_buy_new.year               # Year
book_buy_new.pages              # Pages

Get list of all attributes in console

book_buy_new.instance_variable_get("@table")

Debugging

book_buy_new.meta_status  # HTTP status code, 200 for successful request, 4xx for client error, 5xx for server error
book_buy_new.meta_message # HTTP status message, e.g. "OK" for 200 or "Unauthorized" for 401
book_buy_new.meta_errors  # Array of detailed error messages, e.g. ["Invalid value for attribute purchase_type", "config.access_secret not specified in initializer file"]

Contributing

1. Fork it ( http://github.com//zookal-magento-rest-api/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request