Project

help_scout

0.01
No commit activity in last 3 years
No release in over 3 years
HelpScout is an API client for Help Scout
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 0
~> 10.5
~> 3.5
~> 2.1

Runtime

~> 0.14
 Project Readme

HelpScout

Build Status

This is a gem extracted out from our codebase at Springest. That means that it's currently not as general as it can be, we mostly do stuff with conversations and customers. At the moment we also pass in complete hash objects to create these conversations, something we want to improve on, but take note.

Installation

Add this line to your application's Gemfile:

gem 'help_scout'

And then execute:

$ bundle

Or install it yourself as:

$ gem install help_scout

Usage

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/springest/help_scout.

License

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