ruby-respoke is a wrapper for the Respoke API. For more information on the Respoke service and API see docs.respoke.io.
Using bundler, add this line to your application's Gemfile:
And then execute:
For details on the ruby-respoke API please refer to the full documentation.
Running the tests
The test suite uses VCR to record API requests and responses once. After the
first run it caches these and works offline. These cached files are checked into
Git and can be found in the
test/vcr_cassettes directory. To run the tests
against the live API just delete the
test/vcr_cassettes directory. Please note
that this will change the expected input of the encrypted
test/test_config.yml.enc file used by Travis and that will need to be updated
if you intend to commit the new VCR cache. Otherwise just omit the new cache
files when making your tests.
Note that the unit tests do not use the VCR cache in favor of stubbing.
Before you can run the specs yourself you will need to remove the VCR cache
files and provide your Respoke API credentials. Copy the
file and replace the example values with the ones in the Respoke
cp test/test_config.example.yml test/test_config.yml
Fill in the test_config.yml values then run the spec rake task.
Building the documentation
The documentation is marked up using Yard + Markdown. The easiest way to build the included docs is to use the rake task.
To cut a new release, you'll need to have permissions to push the
to the rubygems.org repo.
- Install gem-release.
gem install gem-release
- Do the release.
gem bump --version minor --tag --release
If you wish to submit an issue use the issue tracker.
- Fork it ( https://github.com/[my-github-username]/ruby-respoke/fork )
- Create your feature branch (
git checkout -b my-new-feature)
- Commit your changes (
git commit -am 'Add some feature')
- Push to the branch (
git push origin my-new-feature)
- Create a new Pull Request
Copyright 2014, Digium, Inc. All rights reserved.
This source code is licensed under The MIT License found in the LICENSE file in the root directory of this source tree.
For all details and documentation: https://www.respoke.io