Ahub

A gem to interact with the Answer Hub API

Gem Version Build Status Code Climate Test Coverage

Warning :warning:

Ahub will strictly follow Semantic Version...AFTER version 1.0.0. Until then, the gem will pivot as I see fit :smiling_imp:. At the moment, however, Ahub is best used for data management tasks (like importing questions/answers/topics/users) & exploration of the data (groups/spaces) in your environment.

In otherwords, please wait until I remove this warning message before rolling it into your production stack. :sweat_smile:

Installation

Add this line to your application's Gemfile:

gem 'ahub'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ahub

Usage

By default, this gem will use the answer hub default connection credentials (answerhub/answerhub). You can override defaults by setting content in a .env file like the example and reference it like this for example:

AHUB_ENV_FILE=~/workspace/.ahub_env irb

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec or simply rspec 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/abelmartin/ahub/issues. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

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