HelpSpot

Ruby gem to talk to the API of a HelpSpot instance.

For information on HelpSpot: www.userscape.com/products/helpspot/

Details of HelpSpot’s API are at: www.userscape.com/helpdesk/index.php?pg=kb.book&id=6

Installation

A gem has been pushed to gemcutter

Once you have gemcutter setup as a gem source:

gem install help_spot

Usage

You’ll need to set your API credentials via either a config file (sample is at config/help_spot.yml.sample):

HelpSpot.configure :config_file => ‘path/to/help_spot.yml’

Or manually:

HelpSpot.configure :root_url => "support.local/api/index.php?format=json", :username => "user@localhost.com", :password => "sekrit"

Documentation

Documentation is hosted at rdoc.info

License

Licensed under the MIT License. See the included LICENSE file.