Project

octoks

0.0
No commit activity in last 3 years
No release in over 3 years
github hooks receiver.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.5
>= 0
>= 0
>= 0

Runtime

 Project Readme

Octoks

Octoks is Github Hooks Receiver. inspired by GitHub::Hooks::Receiver

https://github.com/Songmu/Github-Hooks-Receiver

Installation

Add this line to your application's Gemfile:

gem 'octoks'

And then execute:

$ bundle

Or install it yourself as:

$ gem install octoks

Usage

# this file name is `config.ru`
require 'octoks'

receiver = Octoks::Receiver.new
receiver.on :push do |event|
  # event is Octoks::Event object
  p event.name
  p event.payload
end

run receiver

And rackup

# run receiver
rackup config.ru

You can check the following hook name. https://developer.github.com/v3/activity/events/types/

Contributing

  1. Fork it ( http://github.com/hisaichi5518/octoks/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request