No commit activity in last 3 years
No release in over 3 years
Official Ruby client for Myfreecomm's Ecommerce API. Ecommerce is a solution to control payments for your products.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.7
~> 0.10
~> 10.0
~> 3.2
~> 2.9

Runtime

~> 1.11.2
~> 0.8.0
 Project Readme

Gem Version Build Status Code Climate Test Coverage Inline docs

Ecommerce Client

A Ruby client for Myfreecomm's Ecommerce REST API.

Installation

Add this line to your application's Gemfile:

gem 'ecommerce-client'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ecommerce-client

Configuration

To access the Ecommerce API, you must provide the token and the secret:

Ecommerce.configuration do |config|
  config.token = 'YOUR-TOKEN'
  config.secret = 'YOUR-SECRET'
end

Usage

Ecommerce endpoints are represented as Resources. To check the list of all available Resources, please visit Ecommerce::Resources module folder.

# listing orders of a plan
Ecommerce::Resources::Order.find_all('specific-plan')
=> #<Ecommerce::Resources::OrderCollection:0x000000028739b0...>

Contributing

  1. Fork it ( http://github.com//ecommerce-client-ruby/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