ckeditor-webhook 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2622d4d8d3296347733a4b641fb7a0d0c8df34db4d9f4d1cc8ab7aa2b691e9ac
+  data.tar.gz: 0bc9768e5ee06e28299eea28dc11d78910d03b3ec3b16ca3abe9bc149899d562
+SHA512:
+  metadata.gz: 4480ed9e0a2155a00ce04ab2d1c05230de91cf6f9fe33961e8004cbe3c3ee76aa9edce8b494018b6d37b48c18645c02aef5ae760a4fa606c20ef7db4c876583f
+  data.tar.gz: 471e38cde6d23de664319753c36009a8b477c64bb8335c425c3e312133ed79cc52b63b3475d180f4840113bacc9b6b1b680f99fb8386f05f5895665fe7fb802a

data/.circleci/config.yml

@@ -0,0 +1,40 @@
+version: 2.1
+orbs:
+  ruby: circleci/ruby@0.1.2
+
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.7.2
+    executor: ruby/default
+    steps:
+      - checkout
+      - run:
+          name: Update bundler
+          command: gem install bundler
+      - run:
+          name: Which bundler?
+          command: bundle -v
+      # Restore bundle cache
+      # Read about caching dependencies: https://circleci.com/docs/2.0/caching/
+      - restore_cache:
+          key: vendor-bundle-{{ checksum "Gemfile.lock" }}
+      # Install Ruby dependencies.
+      - run:
+          name: Bundle install
+          command: bundle check --path=vendor/bundle || bundle install --path=vendor/bundle
+      # Store bundle cache for Ruby dependencies.
+      - save_cache:
+          key: vendor-bundle-{{ checksum "Gemfile.lock" }}
+          paths:
+            - vendor/bundle
+      - run:
+          name: Run rspec in parallel
+          command: |
+            bundle exec rspec --profile 10 \
+              --format RspecJunitFormatter \
+              --out test_results/rspec.xml \
+              --format progress \
+              $(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)
+      - store_test_results:
+          path: test_results

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 0.1.0 - 2020-10-30
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at clayjs0@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ckeditor-webhook.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+
+group :test do
+  gem "rspec", "~> 3.0"
+  gem "rspec_junit_formatter", "~>0.4"
+end

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    ckeditor-webhook (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ckeditor-webhook!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rspec_junit_formatter (~> 0.4)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Jack Clayton
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,90 @@
+[![CircleCI](https://circleci.com/gh/jahuty/ckeditor-webhook.svg?style=svg)](https://circleci.com/gh/jahuty/ckeditor-webhook)
+
+# Ckeditor Webhook
+
+A gem for handling [webhooks](https://ckeditor.com/docs/cs/latest/guides/webhooks/overview.html#webhook-format) from CKEditor Cloud Services.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ckeditor-webhook'
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+Or install it yourself as:
+
+```
+$ gem install ckeditor-webhook
+```
+
+## Usage
+
+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](https://ckeditor.com/docs/cs/latest/guides/security/api-secret.html).
+- `payload` (`Hash`), 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:
+
+```ruby
+# Store your CKEditor Cloud Services API key safely.
+secret = "SECRET"
+
+payload = JSON.parse(request.body.read, symbolize_names: true)
+# => { 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
+```
+
+## 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/[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](https://github.com/[USERNAME]/ckeditor-webhook/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Ckeditor::Webhook project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ckeditor-webhook/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ckeditor/webhook"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ckeditor-webhook.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/ckeditor/webhook/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ckeditor-webhook"
+  spec.version       = Ckeditor::Webhook::VERSION
+  spec.authors       = ["Jack Clayton"]
+  spec.email         = ["jack@jahuty.com"]
+
+  spec.summary       = %q{Handle webhooks from CKEditor Cloud Services.}
+  spec.homepage      = "https://github.com/jahuty/ckeditor-webhook"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/jahuty/ckeditor-webhook"
+  spec.metadata["changelog_uri"] = "https://github.com/jahuty/ckeditor-webhook/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/ckeditor/webhook.rb

@@ -0,0 +1,59 @@
+require "ckeditor/webhook/version"
+
+require "ckeditor/webhook/event"
+
+require "json"
+require "openssl"
+require "uri"
+
+module Ckeditor
+  module Webhook
+    class Error < StandardError; end
+    class SignatureVerificationError < StandardError; end
+
+    class << self
+      # Returns an Event if the webhook signature is valid.
+      #
+      # @param  secret     [String]   the CKEditor Cloud Services API secret
+      # @param  payload    [Hash]     the webhook's payload as a hash
+      # @param  signature  [String]   the request's `X-CS-Signature` header
+      # @param  timestamp  [Integer]  the request's `X-CS-Timestamp` header
+      # @param  method     [String]   the request's method (defaults to "POST")
+      # @param  url        [String]   the request's url
+      #
+      # @raise  [SignatureVerificationError]  if signature's don't match
+      #
+      # @return  [Event]
+      #
+      def construct_event(secret:, payload:, signature:, timestamp:, url:, method: "POST")
+        event = message(method: method, url: url, timestamp: timestamp, payload: payload)
+
+        raise SignatureVerificationError if signature != message_signature(message: event, secret: secret)
+
+        Event.new(payload)
+      end
+
+      private
+
+      # Returns the event's message for signing following CKEditor's rules.
+      #
+      # @see  https://ckeditor.com/docs/cs/latest/examples/security/request-signature-nodejs.html
+      def message(method:, url:, timestamp:, payload:)
+        uri    = URI.parse(url)
+        path   = "#{uri.path}?#{uri.query}"
+        method = method.upcase
+        body   = payload.to_json
+
+        "#{method}#{path}#{timestamp}#{body}"
+      end
+
+      def message_signature(message:, secret:)
+        ::OpenSSL::HMAC.hexdigest(
+          "SHA256",
+          secret,
+          message
+        )
+      end
+    end
+  end
+end

data/lib/ckeditor/webhook/event.rb

@@ -0,0 +1,39 @@
+require "time"
+
+# A generic webhook notification from Ckeditor Cloud Services.
+#
+# @see  https://ckeditor.com/docs/cs/latest/guides/webhooks/overview.html
+module Ckeditor
+  module Webhook
+    class InvalidPayload < StandardError; end
+
+    class Event
+      PROPERTIES = %i[event environment_id payload sent_at]
+
+      # @raise  [InvalidPayload]  raised if required properties are missing
+      def initialize(payload)
+        raise InvalidPayload.new(
+          "Expected a hash with :#{PROPERTIES.join(", :")} keys"
+        ) unless PROPERTIES.all? { |s| payload.key? s }
+
+        @payload = payload
+      end
+
+      def environment_id
+        @payload[:environment_id]
+      end
+
+      def payload
+        @payload[:payload]
+      end
+
+      def sent_at
+        ::Time.parse @payload[:sent_at]
+      end
+
+      def type
+        @payload[:event]
+      end
+    end
+  end
+end

data/lib/ckeditor/webhook/version.rb

@@ -0,0 +1,5 @@
+module Ckeditor
+  module Webhook
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: ckeditor-webhook
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jack Clayton
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-10-30 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- jack@jahuty.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ckeditor-webhook.gemspec
+- lib/ckeditor/webhook.rb
+- lib/ckeditor/webhook/event.rb
+- lib/ckeditor/webhook/version.rb
+homepage: https://github.com/jahuty/ckeditor-webhook
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/jahuty/ckeditor-webhook
+  source_code_uri: https://github.com/jahuty/ckeditor-webhook
+  changelog_uri: https://github.com/jahuty/ckeditor-webhook/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Handle webhooks from CKEditor Cloud Services.
+test_files: []