solidus_webhooks 0.0.1.v0.1.0.beta.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ee15a8db0ac265823a8f226cabbd4a28881cf04191e27073abf252b4f554097a
+  data.tar.gz: b3888c9cfd6afa9bb6a513223274f60665013541e2c5a8e5d49970320cb0b258
+SHA512:
+  metadata.gz: bd1a0767f65439df1ff2273b36c1df0f04c492ccfd31ec04d676f9492eed61bfe2296890bec228fd3d28ad55b53f8032205bfbc07bb40cf966d3fc5031ccd37b
+  data.tar.gz: a47daaba62f5c9480c2330fd21c261844d35b55d63ff9d057e42fec129a002aee7d842e5e2c8a55eb214b827c2c30dc6c8fa7527c6942d70b74973ee626b2f30

data/.circleci/config.yml

@@ -0,0 +1,35 @@
+version: 2.1
+
+orbs:
+  # Always take the latest version of the orb, this allows us to
+  # run specs against Solidus supported versions only without the need
+  # to change this configuration every time a Solidus version is released
+  # or goes EOL.
+  solidusio_extensions: solidusio/extensions@volatile
+
+jobs:
+  run-specs-with-postgres:
+    executor: solidusio_extensions/postgres
+    steps:
+      - solidusio_extensions/run-tests
+  run-specs-with-mysql:
+    executor: solidusio_extensions/mysql
+    steps:
+      - solidusio_extensions/run-tests
+
+workflows:
+  "Run specs on supported Solidus versions":
+    jobs:
+      - run-specs-with-postgres
+      - run-specs-with-mysql
+  "Weekly run specs against master":
+    triggers:
+      - schedule:
+          cron: "0 0 * * 4" # every Thursday
+          filters:
+            branches:
+              only:
+                - master
+    jobs:
+      - run-specs-with-postgres
+      - run-specs-with-mysql

data/.gem_release.yml

@@ -0,0 +1,5 @@
+bump:
+  recurse: false
+  file: 'lib/solidus_webhooks/version.rb'
+  message: Bump SolidusWebhooks to %{version}
+  tag: true

data/.github/stale.yml

@@ -0,0 +1,17 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 60
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+# Label to use when marking an issue as stale
+staleLabel: wontfix
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.project
+.sass-cache
+coverage
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.swp
+spec/dummy
+spec/examples.txt
+/sandbox

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,7 @@
+require:
+  - solidus_dev_support/rubocop
+
+AllCops:
+  Exclude:
+    - sandbox/**/*
+    - spec/dummy/**/*

data/Gemfile

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+branch = ENV.fetch('SOLIDUS_BRANCH', 'master')
+gem 'solidus', github: 'solidusio/solidus', branch: branch
+
+# Needed to help Bundler figure out how to resolve dependencies,
+# otherwise it takes forever to resolve them.
+# See https://github.com/bundler/bundler/issues/6677
+gem 'rails', '>0.a'
+
+# Provides basic authentication functionality for testing parts of your engine
+gem 'solidus_auth_devise'
+
+case ENV['DB']
+when 'mysql'
+  gem 'mysql2'
+when 'postgresql'
+  gem 'pg'
+else
+  gem 'sqlite3'
+end
+
+gemspec
+
+# Use a local Gemfile to include development dependencies that might not be
+# relevant for the project or for other contributors, e.g. pry-byebug.
+#
+# We use `send` instead of calling `eval_gemfile` to work around an issue with
+# how Dependabot parses projects: https://github.com/dependabot/dependabot-core/issues/1658.
+send(:eval_gemfile, 'Gemfile-local') if File.exist? 'Gemfile-local'

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2020 Nebulab srls
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Solidus nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,176 @@
+SolidusWebhooks
+===============
+
+Provides comprehensive Webhook support for Solidus, with a simple and powerful way to register them and route payloads to appropriate actions, either synchronous or delayed.
+
+Usage
+-----
+
+A Webhook receiver is just a callable and can be registered in the Solidus configuration as follows:
+
+```ruby
+SolidusWebhooks.config.register_webhook_handler :tracking_number, -> payload {
+  order = Spree::Order.find_by!(number: payload[:order])
+  shipment = order.shipments.find_by!(number: payload[:shipment])
+  shipment.update!(tracking: payload[:tracking])
+}
+```
+
+This will enable sending `POST` requests to `/webhooks/tracking-number` with a JSON payload like this:
+
+```json
+{
+  "order": "R1234567890",
+  "shipment": "S1234567890",
+  "tracking": "T123-456-789"
+}
+```
+
+### Handlers requirements
+
+The only requirement on handlers is for them to respond to `#call` and accept a payload.
+
+Example:
+
+```ruby
+class TrackingNumberHandler
+  def call(payload)
+    order = Spree::Order.find_by!(number: payload[:order])
+    shipment = order.shipments.find_by!(number: payload[:shipment])
+    shipment.update!(tracking: payload[:tracking])
+  end
+end
+
+SolidusWebhooks.config.register_webhook_handler :tracking_number, TrackingNumberHandler
+```
+
+
+### Making the handler asynchronous
+
+To make a handler asynchronous just make its implementation internally call your preferred job handler (e.g. ActiveJob). In most cases you'll want to filter, prepare, and validate the payload for the job of your choice, to avoid ingesting and invalid input.
+
+Example:
+
+```ruby
+SolidusWebhooks.config.register_webhook_handler :tracking_number, -> payload {
+  UpdateTrackingNumberJob.perform_later(
+    order: payload.fetch(:order)
+    shipment: payload.fetch(:shipment)
+    tracking: payload.fetch(:tracking)
+  )
+}
+```
+
+
+### Payload routing
+
+If your handler can receive different kind of payloads the most common technique is to route them to appropriate sub-handlers (that can be an ActiveJob class or a service class).
+
+```ruby
+SolidusWebhooks.config.register_webhook_handler :tracking_number, -> payload {
+  case payload[:tracking]
+  when /^FOO(\d+-)+/
+    UpdateFooTrackingNumberJob.perform_later(
+      order: payload.fetch(:order)
+      shipment: payload.fetch(:shipment)
+      tracking: payload.fetch(:tracking)
+    )
+  when /^BAR(\d+-)+/
+    UpdateBarTrackingNumberJob.perform_later(
+      order: payload.fetch(:order)
+      shipment: payload.fetch(:shipment)
+      tracking: payload.fetch(:tracking)
+    )
+  else raise "unknown tracking service"
+  end
+}
+```
+
+### Restricting Permissions
+
+It's good practice not to use admin-user tokens for webhooks, instead you should define a permission set tied to the webhook handler you're providing. Use the standard Solidus permission-sets to do that.
+
+Example:
+
+```ruby
+module ReceiveTrackingWebhookPermission < Spree::PermissionSets::Base
+  def activate!
+    can :receive, Spree::Webhook do |webhook|
+      webhook.id == :tracking_number
+    end
+  end
+end
+
+Spree::RoleConfiguration.configure do |config|
+  config.assign_permissions :foo_tracking_service, %w[
+    ReceiveTrackingWebhookPermission
+  ]
+end
+```
+
+Installation
+------------
+
+Add solidus_webhooks to your Gemfile:
+
+```ruby
+gem 'solidus_webhooks'
+```
+
+Bundle your dependencies and run the installation generator:
+
+```shell
+bundle
+bundle exec rails g solidus_webhooks:install
+```
+
+Testing
+-------
+
+First bundle your dependencies, then run `bin/rake`. `bin/rake` will default to building the dummy app if it does not exist, then it will run specs. The dummy app can be regenerated by using `bin/rake extension:test_app`.
+
+```shell
+bundle
+bin/rake
+```
+
+To run [Rubocop](https://github.com/bbatsov/rubocop) static code analysis run
+
+```shell
+bundle exec rubocop
+```
+
+When testing your application's integration with this extension you may use its factories.
+Simply add this require statement to your spec_helper:
+
+```ruby
+require 'solidus_webhooks/factories'
+```
+
+Sandbox app
+-----------
+
+To run this extension in a sandboxed Solidus application you can run `bin/sandbox`
+The path for the sandbox app is `./sandbox` and `bin/rails` will forward any Rails command
+to `sandbox/bin/rails`.
+
+Example:
+
+```shell
+$ bin/rails server
+=> Booting Puma
+=> Rails 6.0.2.1 application starting in development
+* Listening on tcp://127.0.0.1:3000
+Use Ctrl-C to stop
+```
+
+Releasing
+---------
+
+Your new extension version can be released using `gem-release` like this:
+
+```shell
+bundle exec gem bump -v VERSION --tag --push --remote upstream && gem release
+```
+
+Copyright (c) 2020 Nebulab srls, released under the New BSD License

data/Rakefile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'solidus_dev_support/rake_tasks'
+SolidusDevSupport::RakeTasks.install
+
+task default: 'extension:specs'

data/app/assets/javascripts/spree/backend/solidus_webhooks.js

@@ -0,0 +1,2 @@
+// Placeholder manifest file.
+// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/backend/all.js'

data/app/assets/javascripts/spree/frontend/solidus_webhooks.js

@@ -0,0 +1,2 @@
+// Placeholder manifest file.
+// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/frontend/all.js'

data/app/assets/stylesheets/spree/backend/solidus_webhooks.css

@@ -0,0 +1,4 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/backend/all.css'
+*/

data/app/assets/stylesheets/spree/frontend/solidus_webhooks.css

@@ -0,0 +1,4 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/frontend/all.css'
+*/

data/app/controllers/spree/webhooks_controller.rb

@@ -0,0 +1,14 @@
+class Spree::WebhooksController < Spree::Api::BaseController
+  rescue_from(Spree::Webhook::WebhookNotFound) { head :not_found }
+
+  def receive
+    webhook = Spree::Webhook.find(params[:id])
+    payload = request.request_parameters["webhook"]
+
+    authorize! :receive, webhook
+
+    webhook.receive(payload)
+
+    head :ok
+  end
+end

data/app/models/spree/webhook.rb

@@ -0,0 +1,19 @@
+class Spree::Webhook
+  include ActiveModel::Model
+  attr_accessor :handler, :id
+
+  WebhookNotFound = Class.new(StandardError)
+
+  def receive(payload)
+    handler.call(payload)
+  end
+
+  def self.find(id)
+    id = id.to_sym # normalize incoming ids
+
+    handler = SolidusWebhooks.config.find_webhook_handler(id) or
+      raise WebhookNotFound, "Cannot find a webhook handler for #{id.inspect}"
+
+    new(id: id, handler: handler)
+  end
+end

data/bin/console

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "solidus_webhooks"
+
+# 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.
+$LOAD_PATH.unshift(*Dir["#{__dir__}/../app/*"])
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/r

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/solidus_webhooks/engine', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/bin/rake

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/sandbox

@@ -0,0 +1,84 @@
+#!/usr/bin/env bash
+
+set -e
+
+case "$DB" in
+postgres|postgresql)
+  RAILSDB="postgresql"
+  ;;
+mysql)
+  RAILSDB="mysql"
+  ;;
+sqlite|'')
+  RAILSDB="sqlite3"
+  ;;
+*)
+  echo "Invalid DB specified: $DB"
+  exit 1
+  ;;
+esac
+
+if [ ! -z $SOLIDUS_BRANCH ]
+then
+  BRANCH=$SOLIDUS_BRANCH
+else
+  BRANCH="master"
+fi
+
+extension_name="solidus_webhooks"
+
+# Stay away from the bundler env of the containing extension.
+function unbundled {
+  ruby -rbundler -e'b = proc {system *ARGV}; Bundler.respond_to?(:with_unbundled_env) ? Bundler.with_unbundled_env(&b) : Bundler.with_clean_env(&b)' -- $@
+}
+
+rm -rf ./sandbox
+unbundled bundle exec rails new sandbox --database="$RAILSDB" \
+  --skip-bundle \
+  --skip-git \
+  --skip-keeps \
+  --skip-rc \
+  --skip-spring \
+  --skip-test \
+  --skip-javascript
+
+if [ ! -d "sandbox" ]; then
+  echo 'sandbox rails application failed'
+  exit 1
+fi
+
+cd ./sandbox
+cat <<RUBY >> Gemfile
+gem 'solidus', github: 'solidusio/solidus', branch: '$BRANCH'
+gem 'solidus_auth_devise', '>= 2.1.0'
+gem 'rails-i18n'
+gem 'solidus_i18n'
+
+gem '$extension_name', path: '..'
+
+group :test, :development do
+  platforms :mri do
+    gem 'pry-byebug'
+  end
+end
+RUBY
+
+unbundled bundle install --gemfile Gemfile
+
+unbundled bundle exec rake db:drop db:create
+
+unbundled bundle exec rails generate spree:install \
+  --auto-accept \
+  --user_class=Spree::User \
+  --enforce_available_locales=true \
+  --with-authentication=false \
+  $@
+
+unbundled bundle exec rails generate solidus:auth:install
+
+echo
+echo "🚀 Sandbox app successfully created for $extension_name!"
+echo "🚀 Using $RAILSDB and Solidus $BRANCH"
+echo "🚀 Use 'export DB=[postgres|mysql|sqlite]' to control the DB adapter"
+echo "🚀 Use 'export SOLIDUS_BRANCH=<BRANCH-NAME>' to control the Solidus version"
+echo "🚀 This app is intended for test purposes."

data/bin/sandbox_rails

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+app_root = 'sandbox'
+
+unless File.exist? "#{app_root}/bin/rails"
+  warn 'Creating the sandbox app...'
+  Dir.chdir "#{__dir__}/.." do
+    system "#{__dir__}/sandbox" or begin # rubocop:disable Style/AndOr
+      warn 'Automatic creation of the sandbox app failed'
+      exit 1
+    end
+  end
+end
+
+Dir.chdir app_root
+exec 'bin/rails', *ARGV

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+gem install bundler --conservative
+bundle update
+bin/rake clobber

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: Hello world

data/config/routes.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Spree::Core::Engine.routes.draw do
+  post '/webhooks/:id', to: 'webhooks#receive', as: :receive_webhook
+end

data/lib/generators/solidus_webhooks/install/install_generator.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module SolidusWebhooks
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :auto_run_migrations, type: :boolean, default: false
+
+      def add_javascripts
+        append_file 'vendor/assets/javascripts/spree/frontend/all.js', "//= require spree/frontend/solidus_webhooks\n" # rubocop:disable Metrics/LineLength
+        append_file 'vendor/assets/javascripts/spree/backend/all.js', "//= require spree/backend/solidus_webhooks\n" # rubocop:disable Metrics/LineLength
+      end
+
+      def add_stylesheets
+        inject_into_file 'vendor/assets/stylesheets/spree/frontend/all.css', " *= require spree/frontend/solidus_webhooks\n", before: %r{\*/}, verbose: true # rubocop:disable Metrics/LineLength
+        inject_into_file 'vendor/assets/stylesheets/spree/backend/all.css', " *= require spree/backend/solidus_webhooks\n", before: %r{\*/}, verbose: true # rubocop:disable Metrics/LineLength
+      end
+
+      def add_migrations
+        run 'bin/rails railties:install:migrations FROM=solidus_webhooks'
+      end
+
+      def run_migrations
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]')) # rubocop:disable Metrics/LineLength
+        if run_migrations
+          run 'bin/rails db:migrate'
+        else
+          puts 'Skipping bin/rails db:migrate, don\'t forget to run it!' # rubocop:disable Rails/Output
+        end
+      end
+    end
+  end
+end

data/lib/solidus_webhooks/configuration.rb

@@ -0,0 +1,30 @@
+module SolidusWebhooks
+  class Configuration
+    def initialize
+      @handlers = {}
+    end
+
+    def register_webhook_handler(id, handler)
+      unless handler.respond_to? :call
+        raise Spree::Webhook::InvalidHandler,
+          "Please provide a handler that responds to #call, got: #{handler.inspect}"
+      end
+
+      @handlers[id.to_sym] = handler
+    end
+
+    def find_webhook_handler(id)
+      @handlers[id.to_sym]
+    end
+  end
+
+  def self.config
+    @config
+  end
+
+  def self.reset_config!
+    @config = Configuration.new
+  end
+
+  reset_config! # initialize the extension
+end

data/lib/solidus_webhooks/engine.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'spree/core'
+require 'solidus_webhooks'
+
+module SolidusWebhooks
+  class Engine < Rails::Engine
+    include SolidusSupport::EngineExtensions
+
+    isolate_namespace ::Spree
+
+    engine_name 'solidus_webhooks'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+  end
+end

data/lib/solidus_webhooks/factories.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+end

data/lib/solidus_webhooks/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SolidusWebhooks
+  VERSION = '0.0.1.v0.1.0.beta.1.1'
+end

data/lib/solidus_webhooks.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'solidus_core'
+require 'solidus_support'
+
+require 'solidus_webhooks/version'
+require 'solidus_webhooks/configuration'
+require 'solidus_webhooks/engine'

data/solidus_webhooks.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'lib/solidus_webhooks/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'solidus_webhooks'
+  spec.version = SolidusWebhooks::VERSION
+  spec.authors = ['Elia Schito']
+  spec.email = 'contact@solidus.io'
+
+  spec.summary = 'Webhooks support for Solidus'
+  spec.homepage = 'https://github.com/solidusio-contrib/solidus_webhooks#readme'
+  spec.license = 'BSD-3-Clause'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/solidusio-contrib/solidus_webhooks'
+  spec.metadata['changelog_uri'] = 'https://github.com/solidusio-contrib/solidus_webhooks/releases'
+
+  spec.required_ruby_version = Gem::Requirement.new('~> 2.4')
+
+  # 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.
+  files = Dir.chdir(__dir__) { `git ls-files -z`.split("\x0") }
+
+  spec.files = files.grep_v(%r{^(test|spec|features)/})
+  spec.test_files = files.grep(%r{^(test|spec|features)/})
+  spec.bindir = "exe"
+  spec.executables = files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'solidus_core', ['>= 2.0.0', '< 3']
+  spec.add_dependency 'solidus_support', '~> 0.5.0'
+
+  spec.add_development_dependency 'solidus_dev_support'
+end

data/spec/features/can_register_a_handler_and_receive_webhooks_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+RSpec.feature "Can register a handler and receive Webhooks", type: :request do
+  background do
+    SolidusWebhooks.reset_config!
+    SolidusWebhooks.config.register_webhook_handler :foo, foo_handler
+    SolidusWebhooks.config.register_webhook_handler :bar, bar_handler
+  end
+
+  let(:foo_payloads) { [] }
+  let(:bar_payloads) { [] }
+
+  let(:foo_handler) { ->(payload) { foo_payloads << payload } }
+  let(:bar_handler) { ->(payload) { bar_payloads << payload } }
+
+  let(:token) { create(:admin_user, spree_api_key: "123").spree_api_key }
+  let(:token_without_permission) { create(:user, spree_api_key: "456").spree_api_key }
+
+  scenario "calls the handler passing the payload" do
+    post "/webhooks/foo?token=#{token}", as: :json, params: {a: 123}
+    expect(response).to have_http_status(:ok)
+
+    post "/webhooks/foo?token=#{token}", as: :json, params: {b: 456}
+    expect(response).to have_http_status(:ok)
+
+    post "/webhooks/bar?token=#{token}", as: :json, params: {c: 789}
+    expect(response).to have_http_status(:ok)
+
+    expect(foo_payloads).to eq([{'a' => 123}, {'b' => 456}])
+    expect(bar_payloads).to eq([{'c' => 789}])
+  end
+
+  scenario "receives a bad handler id" do
+    post "/webhooks/baz?token=#{token}", as: :json, params: {a: 123}
+    expect(response).to have_http_status(:not_found)
+  end
+
+  scenario "refuses a bad token" do
+    post "/webhooks/baz?token=b4d-t0k3n", as: :json, params: {a: 123}
+    expect(response).to have_http_status(:unauthorized)
+  end
+
+  scenario "refuses a token without permissions" do
+    post "/webhooks/foo?token=#{token_without_permission}", as: :json, params: {a: 123}
+    expect(response).to have_http_status(:unauthorized)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Configure Rails Environment
+ENV['RAILS_ENV'] = 'test'
+
+# Run Coverage report
+require 'solidus_dev_support/rspec/coverage'
+
+require File.expand_path('dummy/config/environment.rb', __dir__)
+
+# Requires factories and other useful helpers defined in spree_core.
+require 'solidus_dev_support/rspec/feature_helper'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each { |f| require f }
+
+# Requires factories defined in lib/solidus_webhooks/factories.rb
+require 'solidus_webhooks/factories'
+
+RSpec.configure do |config|
+  config.infer_spec_type_from_file_location!
+  config.use_transactional_fixtures = false
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: solidus_webhooks
+version: !ruby/object:Gem::Version
+  version: 0.0.1.v0.1.0.beta.1.1
+platform: ruby
+authors:
+- Elia Schito
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: solidus_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: solidus_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: solidus_dev_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: contact@solidus.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gem_release.yml"
+- ".github/stale.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/spree/backend/solidus_webhooks.js
+- app/assets/javascripts/spree/frontend/solidus_webhooks.js
+- app/assets/stylesheets/spree/backend/solidus_webhooks.css
+- app/assets/stylesheets/spree/frontend/solidus_webhooks.css
+- app/controllers/spree/webhooks_controller.rb
+- app/models/spree/webhook.rb
+- bin/console
+- bin/r
+- bin/rake
+- bin/sandbox
+- bin/sandbox_rails
+- bin/setup
+- config/locales/en.yml
+- config/routes.rb
+- lib/generators/solidus_webhooks/install/install_generator.rb
+- lib/solidus_webhooks.rb
+- lib/solidus_webhooks/configuration.rb
+- lib/solidus_webhooks/engine.rb
+- lib/solidus_webhooks/factories.rb
+- lib/solidus_webhooks/version.rb
+- solidus_webhooks.gemspec
+- spec/features/can_register_a_handler_and_receive_webhooks_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/solidusio-contrib/solidus_webhooks#readme
+licenses:
+- BSD-3-Clause
+metadata:
+  homepage_uri: https://github.com/solidusio-contrib/solidus_webhooks#readme
+  source_code_uri: https://github.com/solidusio-contrib/solidus_webhooks
+  changelog_uri: https://github.com/solidusio-contrib/solidus_webhooks/releases
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Webhooks support for Solidus
+test_files:
+- spec/features/can_register_a_handler_and_receive_webhooks_spec.rb
+- spec/spec_helper.rb