quadhook 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7faa47d65ab2b4808fddfea83e1e3bcca8c1b7e9
+  data.tar.gz: 71135c6a0ef3d879c0aade93cd1084e80a74f42f
+SHA512:
+  metadata.gz: 1f6464d1889828fb08af87334682c76a9d14dd7bc3cab5bbfef4c8c293029db5175646a5ff5d5802b8c713a180ee3849fb6a987e426bc22f7788069b26e6222f
+  data.tar.gz: 04478ccf74f767dfe5cc6234120eb728026711a91821813ad5da09128534fab69fbe5d73c6ce6ec274564410012f8b83b855801317bedf5728c14678f6553761

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+script: bundle exec rspec
+cache: bundler
+rvm:
+  - 2.2.1
+notifications:
+  slack:
+    secure: "RUwMNyz+MYc7VvH+ZhcxyLxUKO1/CqqE11/AxCPrWIf0nJUAjb5qlAYaj6HaJqIiW/JgV19pQgZgtA2bZZE9vOjm2w0i+G7a+89betFEKHkCifiok9DBYJ8jynvWaB1KFWaHYUWbJ5VuBQGFBqGCLHzxIFautBN9FfxIdNaKGZM="
+  on_success: change
+  on_failure: change

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Inspire9
+
+MIT License
+
+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,56 @@
+# Quadhook
+
+A Rack endpoint for handling Quaderno webhooks, and fires an ActiveSupport notification for each succesful request.
+
+[![Build Status](https://travis-ci.org/inspire9/quadhook.svg)](https://travis-ci.org/inspire9/quadhook)
+[![Code Climate](https://codeclimate.com/github/inspire9/quadhook/badges/gpa.svg)](https://codeclimate.com/github/inspire9/quadhook)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'quadhook', '~> 0.0.1'
+```
+
+## Usage
+
+Mount an instance of `Quadhook::Endpoint` to your preferred route. In a Rails app, that'd look something like this:
+
+```ruby
+post '/quaderno/webhook', to: Quaderno::Endpoint.new(
+  ENV['QUADERNO_AUTH_KEY'],
+  ENV['QUADERNO_HOOK_URI']
+)
+```
+
+Then, handle the notifications using something like the following (which would probably go in an initialiser for a Rails app):
+
+```ruby
+ActiveSupport::Notifications.subscribe(
+  'notification.quaderno.webhook'
+) do |*args|
+  event = ActiveSupport::Notifications::Event.new *args
+  # use event.payload[:event_type] and event.payload[:data] however you like.
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Firstly, please note the Code of Conduct for all contributions to this project. If you accept that, then the steps for contributing are probably something along the lines of:
+
+1. Fork it ( https://github.com/inspire9/quadhook/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 a new Pull Request
+
+## Licence
+
+Copyright (c) 2015, Quadhook is developed and maintained by [Inspire9](http://development.inspire9.com), and is released under the open MIT Licence.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "quadhook"
+
+# 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

data/bin/setup

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

data/lib/quadhook.rb

@@ -0,0 +1,13 @@
+require 'base64'
+require 'openssl'
+require 'rack'
+require 'json'
+require 'active_support/notifications'
+require 'active_support/core_ext/module/delegation'
+
+module Quadhook
+  #
+end
+
+require 'quadhook/endpoint'
+require 'quadhook/verifier'

data/lib/quadhook/endpoint.rb

@@ -0,0 +1,33 @@
+class Quadhook::Endpoint
+  delegate :instrument, to: ActiveSupport::Notifications
+
+  def initialize(api_key, uri)
+    @api_key, @uri = api_key, uri
+  end
+
+  def call(env)
+    request = Rack::Request.new env
+
+    if Quadhook::Verifier.new(request, api_key, uri).call
+      json = json_from_body request
+
+      instrument 'notification.quadhook.webhook',
+        event_type: json['event_type'],
+        data:       json['data']
+
+      [200, {}, ['']]
+    else
+      [400, {}, ['']]
+    end
+  end
+
+  private
+
+  attr_reader :api_key, :uri
+
+  def json_from_body(request)
+    request.body.rewind
+
+    JSON.parse request.body.read
+  end
+end

data/lib/quadhook/verifier.rb

@@ -0,0 +1,45 @@
+class Quadhook::Verifier
+  def initialize(request, api_key, uri)
+    @request, @api_key, @uri = request, api_key, uri
+  end
+
+  def call
+    hmac == header
+  end
+
+  private
+
+  attr_reader :request, :api_key, :uri
+
+  def body
+    request.body.rewind
+    request.body.read
+  end
+
+  def data
+    "#{uri}#{params.sort.flatten.join}"
+  end
+
+  def digest
+    OpenSSL::Digest.new 'sha1'
+  end
+
+  def header
+    request.env['HTTP_X_QUADERNO_SIGNATURE'] ||
+    request.env['X-Quaderno-Signature']
+  end
+
+  def hmac
+    Base64.encode64(
+      OpenSSL::HMAC.digest(digest, api_key, data)
+    ).strip
+  end
+
+  def params
+    @params ||= begin
+      JSON.parse body
+    rescue JSON::ParserError
+      {}
+    end
+  end
+end

data/quadhook.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+Gem::Specification.new do |spec|
+  spec.name          = "quadhook"
+  spec.version       = '0.0.1'
+  spec.authors       = ["Pat Allan"]
+  spec.email         = ["pat@freelancing-gods.com"]
+
+  spec.summary       = %q{Webhook handler for Quaderno}
+  spec.description   = %q{Rack endpoint for capturing webhook requests from Quaderno's invoicing service.}
+  spec.homepage      = "https://github.com/inspire9/quadhook"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'activesupport', '>= 3.1.0'
+  spec.add_runtime_dependency 'json',          '>= 1.8.0'
+  spec.add_runtime_dependency 'rack'
+
+  spec.add_development_dependency 'rack-test', '~> 0.6.3'
+  spec.add_development_dependency 'rspec',     '~> 3.2.0'
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: quadhook
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pat Allan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: Rack endpoint for capturing webhook requests from Quaderno's invoicing
+  service.
+email:
+- pat@freelancing-gods.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/quadhook.rb
+- lib/quadhook/endpoint.rb
+- lib/quadhook/verifier.rb
+- quadhook.gemspec
+homepage: https://github.com/inspire9/quadhook
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Webhook handler for Quaderno
+test_files: []
+has_rdoc: