0.0
No commit activity in last 3 years
No release in over 3 years
Solidus eCommerce API Ruby client
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 13.0
~> 3.9

Runtime

 Project Readme

Ruby Solidus API client

Requirements

Installation

gem install solidus_client

Usage

Client class

Use SolidusClient:Client class

require 'solidus_client/client'

client = SolidusClient::Client.new(url: 'app url', api_key: 'user api key')

item_data_hash = { ... }
response_hash = client.add_item(order_number, item_data_hash)

Command line

Run solidus command

$ solidus -h

Usage: solidus [options] command [target] [JSON data]

Commands:
 - add_item <order_number> <data>
 - ..

Options:
    -u, --url   Solidus URL
    -k, --key   Solidus API key
    -t, --token Solidus guest token

Development

Install dependencies

bundle install

Export required environment Variables

export SOLIDUS_API_KEY=your API key
export SOLIDUS_URL=Solidus endpoint

Run specs WARNING: checkout_spec.rb requires a running Solidus instance and writes Product and Order data to it

bundle exec rake spec

License

Copyright © 2019 Nebulab. It is free software, and may be redistributed under the terms specified in the license.

About

Nebulab

Solidus API Client is funded and maintained by the Nebulab team.

We firmly believe in the power of open-source. Contact us if you like our work and you need help with your project design or development.