https://github.com/boweihan/easytone
ruby gem for wrapping the Watson Tone Analyzer API
https://github.com/boweihan/easytone
Last synced: 2 months ago
JSON representation
ruby gem for wrapping the Watson Tone Analyzer API
- Host: GitHub
- URL: https://github.com/boweihan/easytone
- Owner: boweihan
- License: mit
- Created: 2016-07-24T19:10:17.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-12-23T23:24:50.000Z (over 7 years ago)
- Last Synced: 2025-03-03T02:17:49.561Z (3 months ago)
- Language: Ruby
- Homepage:
- Size: 10.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Easytone
This gem wraps the Waston Tone Analyzer API to abstract away some of the setup difficulties.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'easytone'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install easytone
## Usage
To use this gem, simply call this method and pass in appropriate arguments:
Easytone::ToneGen.tone(username, password, text, version = OPTIONAL)
This method requires your Watson Tone Analyzer API username and password, along with the text you want to analyze and the version (which is set to 2015 by default, OPTIONAL)
## 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](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/boweihan/easytone. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).