stevenbarragan / nacre-old

The old/original Nacre gem

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Build Status Code Climate Coverage Status

Nacre

Nacre is a Ruby gem that wraps the API of the Brightpearl accounting software service.

http://www.brightpearl.com/developer/latest/

Installation

Add this line to your application's Gemfile:

gem "nacre", :git => "git://github.com/allolex/nacre.git"

And then execute:

$ bundle

Usage

require 'nacre'
api = Nacre::Api.new( file: 'config/test_config.yml' )
products_list = Nacre::API::Product.all
product = Nacre::API::Product.find(1000)

Make sure you copy the sample config file to test_config.yml with your credentials.

Features

  • Configuration support. See config/ for a sample YAML file.
  • API authentication

These are functional, but definitely need some work:

  • Product
  • Order

Todo

  • Services
    • Accounting
    • Contact
    • Warehouse

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Thanks

Many thanks go to Angela Heenan at and Helen Bowling at Brightpearl.

Alex Stupakov, you're an absolute ace for helping to unstick this project.

About

The old/original Nacre gem

License:MIT License


Languages

Language:Ruby 100.0%