Ckeditor Webhook

A gem for handling webhooks from CKEditor Cloud Services.

Add this line to your application's Gemfile:

gem 'ckeditor-webhook'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install ckeditor-webhook

Call Ckeditor::Webhook::construct_event with the following keyword arguments to create a verified webhook event (if the webhook is invalid, a Ckedior::Webhook::SignatureVerificationError will be raised):

• secret (String), the CKEditor Cloud Services API secret.
• payload (String), the webhook's payload
• signature (String), the request's X-CS-Signature header
• timestamp (Integer), the request's X-CS-Timestamp header
• url (String), the request's url
• method (String), the request's case-insensitive method (defaults to "POST")

For example:

# Store your CKEditor Cloud Services API key safely.
secret = "SECRET"

payload = request.body.read
# => '{ "event": "foo", "environment_id": "bar", "payload": { baz: "qux" }, "sent_at": Time.now.utc }

url = request.original_url
# => "http://demo.example.com/webhook?a=1"

signature = request.env['X-CS-Signature']
# => "880558bfda70c698099ca1184a0c5c5114e5d91cc254d2532470eecf44819b94"

timestamp = request.env['X-CS-Timestamp']
# => 1563276169752

begin
  event = CKEditor::Webhook.construct_event(
    secret:    secret,
    payload:   payload,
    url:       url,
    signature: signature,
    timestamp: timestamp
  )

  event.type            # => "foo"
  event.environment_id  # => "bar"
  event.payload         # => { baz: "qux" }
  event.sent_at         # => Time
rescue Ckeditor::Webhook::SignatureVerificationError => e
  # Reject the webhook! The signature did not match.
end

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.

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ckeditor-webhook. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

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

Everyone interacting in the Ckeditor::Webhook project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.