0.0
Repository is archived
No commit activity in last 3 years
No release in over 3 years
A ruby client for retentiongrid.com API.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

Runtime

= 0.13.1
 Project Readme

Retentiongrid

Gem Version Build Status Coverage Status Code Climate License

A ruby client for retentiongrid.com API

Installation

Add this line to your application's Gemfile:

gem 'retentiongrid'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install retentiongrid

Usage

set you API key

require 'retentiongrid'
Retentiongrid::Api.api_key = "your_api_key"

Read from retentiongrid

order = Retentiongrid::Order.find(1234)

Write to retentiongrid

order = Retentiongrid::Order.new({
  status:           'ok',
  order_id:         'R123',
  customer_id:      'C321',
  currency:         'EUR',
  total_price:      35.99,
  total_discounts:  0.0,
  order_created_at: Time.now,
})
order.save

Contributing

  1. Fork it ( https://github.com/[my-github-username]/retentiongrid/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 a new Pull Request