BillHicks

Ruby library for Bill Hicks ERP system.

Installation

Add this line to your application's Gemfile:

gem 'bill_hicks'

And then execute:

$ bundle

Or install it yourself as:

$ gem install bill_hicks

Usage

Note: Nearly all methods require :username and :password keys in the options hash.

options = {
  username: 'dealer@example.com',
  password: 'sekret-passwd'
}

BillHicks::Catalog

To get all items in the catalog:

catalog = BillHicks::Catalog.all(options)

See BillHicks::Catalog for the response structure.

BillHicks::Inventory

To get your inventory details (availability, price, etc.):

inventory = BillHicks::Inventory.all(options)

See BillHicks::Inventory for the response structure.

BillHicks::Category

Returns an array of category codes and descriptions.

categories = BillHicks::Category.all(options)

# [
#   {:code=>"H648", :description=>"AIRGUNS"},
#   {:code=>"H610", :description=>"AMMUNITION"},
#   ...,
# ]

BillHicks::Order

To build and submit an order, the basic steps are: 1) instantiate an Order object, 2) add header information, 3) add item information (multiple items if needed), 4) submit the order.

# Instantiate the Order instance, passing in your :username and :password
order = BillHicks::Order.new(options)

# Add header information:
header_opts = {
  customer: '...',  # customer number
  purchase_order: '...',  # application specific purchase order
  ffl: '...',  # your FFL number
  shipping: {  # shipping information (all fields except :address_2 are required)
    name: '...',
    address_1: '...',
    address_2: '...',
    city: '...',
    state: '...',
    zip: '...',
  },

  # Optional fields:
  shipping_method: '...',
  notes: '...',
}
order.add_header(header_opts)

# Add item information:
item_opts = {
  item_number: '...',  # Bill Hicks item number
  description: '...',
  quantity: 1,
  price: '123.45',  # Decimal formatted price, without currency sign
}
order.add_item(item_opts)  # Multiple items may be added, just call #add_item for each one.

# Submit the order (returns true on success, raises an exception on failgure):
order.submit!

See BillHicks::Order for details on required options.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ammoready/bill_hicks.

License

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