shopify_webhook 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f058937197537958a1fc7224da3c205604702a81
+  data.tar.gz: 7695ae69d359173194c2e942d201e6bb0a5781cd
+SHA512:
+  metadata.gz: 3dc092f3a9933c5a46af2ee1f793be26a063baeee74394c1004a7dafa961b057947830f3690b3c01ed7de80c39940e08c9049c158fffba50eb65f72b4e7cb67f
+  data.tar.gz: 818ae4010e7d273a62f3e2e8358121f5053a1aac7974aa766cca31513b398fb873eea5e2ffc823dc8632134296f3547323a4e310556a2819fb6da9ca886c7e3b

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 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,42 @@
+# Shopify Webhook
+
+A Rack endpoint for handling Shopify webhooks, and fires an ActiveSupport notification for each succesful request.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'shopify_webhook', '0.1.0'
+```
+
+## Usage
+
+Mount an instance of `ShopifyWebhook::Endpoint` to your preferred route. In a Rails app, that'd look something like this:
+
+```ruby
+post '/shopify/webhook', to: ShopifyWebhook::Endpoint.new(SHARED_SECRET)
+```
+
+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.shopify.webhook'
+) do |*args|
+  event = ActiveSupport::Notifications::Event.new *args
+  # use event.payload[:json] however you like.
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/inspire9/shopify_webhook/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) 2014, Shopify Webhook is developed and maintained by [Inspire9](http://development.inspire9.com), and is released under the open MIT Licence.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+

data/lib/shopify_webhook.rb

@@ -0,0 +1,12 @@
+require 'base64'
+require 'openssl'
+require 'active_support/notifications'
+require 'active_support/core_ext/module/delegation'
+require 'multi_json'
+
+module ShopifyWebhook
+  #
+end
+
+require 'shopify_webhook/endpoint'
+require 'shopify_webhook/verifier'

data/lib/shopify_webhook/endpoint.rb

@@ -0,0 +1,27 @@
+class ShopifyWebhook::Endpoint
+  delegate :instrument, to: ActiveSupport::Notifications
+
+  def initialize(secret)
+    @secret = secret
+  end
+
+  def call(env)
+    request = Rack::Request.new env
+
+    if ShopifyWebhook::Verifier.new(request, secret).call
+      instrument 'notification.shopify.webhook', json: json(request)
+      [200, {}, ['']]
+    else
+      [400, {}, ['']]
+    end
+  end
+
+  private
+
+  attr_reader :secret
+
+  def json(request)
+    request.body.rewind
+    MultiJson.load request.body.read
+  end
+end

data/lib/shopify_webhook/verifier.rb

@@ -0,0 +1,33 @@
+class ShopifyWebhook::Verifier
+  def initialize(request, secret)
+    @request, @secret = request, secret
+  end
+
+  def call
+    hmac == header
+  end
+
+  private
+
+  attr_reader :request, :secret
+
+  def data
+    request.body.rewind
+    request.body.read
+  end
+
+  def header
+    request.env['HTTP_X_SHOPIFY_HMAC_SHA256'] ||
+    request.env['X-Shopify-Hmac-SHA256']
+  end
+
+  def hmac
+    Base64.encode64(
+      OpenSSL::HMAC.digest(digest, secret, data)
+    ).strip
+  end
+
+  def digest
+    OpenSSL::Digest.new 'sha256'
+  end
+end

data/shopify_webhook.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+Gem::Specification.new do |spec|
+  spec.name          = 'shopify_webhook'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Pat Allan']
+  spec.email         = ['pat@freelancing-gods.com']
+  spec.summary       = %q{A Rack endpoint for handling Shopify webhooks.}
+  spec.description   = %q{A Rack endpoint for handling Shopify webhooks, and fires an ActiveSupport notification for each succesful request.}
+  spec.homepage      = 'http://github.com/inspire9/shopify_webhook'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'activesupport', '>= 3.1.0'
+  spec.add_runtime_dependency 'multi_json',    '>= 1.3.0'
+  spec.add_runtime_dependency 'rack'
+
+  spec.add_development_dependency 'rack-test', '~> 0.6.2'
+  spec.add_development_dependency 'rspec',     '~> 3.1.0'
+end

data/spec/acceptance/notification_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+RSpec.describe 'Shopify Notifications' do
+  include Rack::Test::Methods
+
+  let(:app)           { ShopifyWebhook::Endpoint.new 'SUPERSECRET' }
+  let(:subscriptions) { [] }
+
+  def subscribe(&block)
+    subscriptions << ActiveSupport::Notifications.subscribe(
+      'notification.shopify.webhook', &block
+    )
+  end
+
+  def hmac_for(body)
+    Base64.encode64(
+      OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha256'), 'SUPERSECRET', body)
+    ).strip
+  end
+
+  def post_with_hmac(path, params, headers = {})
+    post path, params, headers.merge(
+      'HTTP_X_SHOPIFY_HMAC_SHA256' => hmac_for(params)
+    )
+  end
+
+  after :each do
+    subscriptions.each do |subscription|
+      ActiveSupport::Notifications.unsubscribe(subscription)
+    end
+  end
+
+  it 'returns a 200' do
+    post_with_hmac '/', '[]'
+
+    expect(last_response.status).to eq(200)
+  end
+
+  it 'fires an event' do
+    notification = false
+    subscribe { |*args| notification = true }
+
+    post_with_hmac '/', '[]'
+
+    expect(notification).to eq(true)
+  end
+
+  it 'includes the JSON body' do
+    subscribe { |*args|
+      event = ActiveSupport::Notifications::Event.new *args
+      expect(event.payload[:json]).to eq([{'foo' => 'bar'}])
+    }
+
+    post_with_hmac '/', '[{"foo":"bar"}]'
+  end
+
+  it 'accepts a dashed HMAC header' do
+    post '/', '[]', {'X-Shopify-Hmac-SHA256' => hmac_for('[]')}
+
+    expect(last_response.status).to eq(200)
+  end
+
+  context 'with invalid HMAC' do
+    it 'returns a 400' do
+      post '/', '[]'
+
+      expect(last_response.status).to eq(400)
+    end
+
+    it 'does not fire an event' do
+      notification = false
+      subscribe { |*args| notification = true }
+
+      post '/', '[]'
+
+      expect(notification).to eq(false)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: shopify_webhook
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pat Allan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-08 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: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.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.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: A Rack endpoint for handling Shopify webhooks, and fires an ActiveSupport
+  notification for each succesful request.
+email:
+- pat@freelancing-gods.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/shopify_webhook.rb
+- lib/shopify_webhook/endpoint.rb
+- lib/shopify_webhook/verifier.rb
+- shopify_webhook.gemspec
+- spec/acceptance/notification_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/inspire9/shopify_webhook
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A Rack endpoint for handling Shopify webhooks.
+test_files:
+- spec/acceptance/notification_spec.rb
+- spec/spec_helper.rb