0.01
No commit activity in last 3 years
No release in over 3 years
A Ruby interface that allows to integrate any Epages Shop with any ruby framework via Epages Rest API.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.13

Runtime

~> 2.1
 Project Readme

Build Status Code Climate Test Coverage

The ePages REST Ruby Gem

A Ruby interface to the ePages REST API.

Installation

gem install epages-rest

You can require it in the Ruby Interpreter using:

require 'epages-rest'

or add it to your Rails application adding the gem to your Gemfile.

Usage

This gem is used to connect any Ruby application with any ePages shop. You can get any public information of any shop indicating only the name of the shop. But for security reasons, to modify content from your shop, you need the token you will get in the developer environment of your test shop.

Usage examples

The first thing is create your REST shop. shop = Epages::REST::Shop.new(shop_host, shop_name) or shop = Epages::REST::Shop.new(shop_host, shop_name, token)

Additionally, you can indicate if your shop uses https or not (default true) shop = Epages::REST::Shop.new(shop_host, shop_name, token, https: false)

Once this is done, you can use the API calls.

products = shop.products sorted_products = shop.products(sort: name)

categories = shop.categories

Full collection of examples here

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ePages-de/epages-rest-ruby.

License

The gem is available as open source under the terms of the MIT License.