lita-github-web-hooks-storer
This gem is a Lita handler that demonstrates the capabilities of lita-github-web-hooks-core.
Installing, configuring and deploying this gem as a part of your litabot will store the JSON payloads of your GitHub web hooks on disk in a location you specify. You may find it useful in creating your own GitHub web hook powered handler, as it has the capability of capturing your own edge cases while your handler is in operation!
Installation
Add lita-github-web-hooks-storer to your Lita instance's Gemfile:
gem "lita-github-web-hooks-storer"
Configuration
In your lita_config.rb
file, add a stanza like the following:
config.handlers.lita_github_web_hooks_storer.directory = "/path/you/would/prefer"
Otherwise your files will be stored in /tmp.
Usage
After installation and configuration, there is no step 3! Enjoy.
Rolling your own
Information on using this gem as a reference to use lita-github-web-hooks-core in your own handler? Our handler walkthrough has what you're looking for.
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/GetLevvel/lita-github-web-hooks-storer. 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 Apache License 2.0.