webhook_system 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 845cc8863c319a2a78ff235cbb41256a9bdbe850
-  data.tar.gz: afa19be64345c961c0989c09d09fc80341200ab4
+  metadata.gz: 7949660ffcd7499c9ad2cd90030a700c984ee81f
+  data.tar.gz: db0e7b0233716c187c67cd1ec09560eb053ee30b
 SHA512:
-  metadata.gz: 0285d5a6e08624c92cdddf4eceed759c55f2839c139d922c09c8d82302114b0dcfba8416dae5ea5cb965ca8bdcc971c323087397ddae26b309217c9c1fb11820
-  data.tar.gz: de888a90628e3987dc5f4b0416d7eef83e8afc6f1972135c6545ecd8839f4cacb570ef4f1d73900cadc3cd808a10329c6b43c0adb60bd805278942d858b0e3a6
+  metadata.gz: 433ab1c14d97195cb9222247266e5feb06e17e26d36bef61ebb313057cade5a8994600bf2730799e0f25e08c3fc026c345c8223a441a4b6383655919b2a25bb0
+  data.tar.gz: 2142d2b4256bc7abe4a2a3d3f408b5163ad783b61aafdf851485050c82b6ddb7f4bb38a8f438153fb283f5979ed709750abdf8d11776321fdd2289c1644027f7

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## [v0.1.1](https://github.com/payrollhero/webhook_system/tree/v0.1.1) (2016-02-05)
+[Full Changelog](https://github.com/payrollhero/webhook_system/compare/v0.1.0...v0.1.1)
+
+- Fixing hash based attribute definition and a few fixes [\#3](https://github.com/payrollhero/webhook_system/pull/3) ([piotrb](https://github.com/piotrb))
+
 ## [v0.1.0](https://github.com/payrollhero/webhook_system/tree/v0.1.0) (2016-02-05)
 [Full Changelog](https://github.com/payrollhero/webhook_system/compare/v0.0.1...v0.1.0)
 

data/README.md

@@ -28,20 +28,119 @@ tables first:
 
 ```ruby
 create_table :webhook_subscriptions do |t|
-  t.string :url
-  t.boolean :active
+  t.string :url, null: false
+  t.boolean :active, null: false
   t.text :secret
 
   t.index :active
 end
 
 create_table :webhook_subscription_topics do |t|
-  t.string :name
-  t.belongs_to :subscription
+  t.string :name, null: false
+  t.belongs_to :subscription, null: false
 
   t.index :subscription_id
   t.index :name
 end
+
+create_table :webhook_event_logs do |t|
+  t.belongs_to :subscription, null: false
+
+  t.string :event_name, null: false
+  t.string :event_id, null: false
+  t.integer :status, null: false
+
+  t.text :request, limit: 64_000, null: false
+  t.text :response, limit: 64_000, null: false
+
+  t.datetime :created_at, null: false
+
+  t.index :created_at
+  t.index :event_name
+  t.index :status
+  t.index :subscription_id
+  t.index :event_id
+end
+```
+
+### Migrating from version 0.x
+
+First migrate the null constraints in ...
+
+```ruby
+def up
+  change_column :webhook_subscriptions, :url, null: false
+  change_column :webhook_subscriptions, :active, null: false
+  change_column :webhook_subscription_topics, :name, null: false
+  change_column :webhook_subscription_topics, :subscription_id, null: false
+end
+
+def down
+  change_column :webhook_subscription_topics, :subscription_id, null: true
+  change_column :webhook_subscription_topics, :name, null: true
+  change_column :webhook_subscriptions, :active, null: true
+  change_column :webhook_subscriptions, :url, null: true
+end
+```
+
+Then add the new table ...
+
+```ruby
+create_table :webhook_event_logs do |t|
+  t.belongs_to :subscription, null: false
+
+  t.string :event_name, null: false
+  t.string :event_id, null: false
+  t.integer :status, null: false
+
+  t.text :request, limit: 64_000, null: false
+  t.text :response, limit: 64_000, null: false
+
+  t.datetime :created_at, null: false
+
+  t.index :created_at
+  t.index :event_name
+  t.index :status
+  t.index :subscription_id
+  t.index :event_id
+end
+```
+
+## Configuring the ActiveJob Job
+
+There is a couple of things you might need to configure in your handling of these jobs
+
+### Queue Name
+
+You might need to reopen the class and define the queue:
+
+eg:
+```ruby
+class WebhookSystem::Job
+  queue_as :some_queue_name
+end
+```
+
+### Error Handling
+
+By default the job will fail itself when it gets a non 200 response. You can handle these errors by rescuing the
+Request failed exception. eg:
+
+```ruby
+class WebhookSystem::Job
+  rescue_from(WebhookSystem::Job::RequestFailed) do |exception|
+    case exception.code
+    when 200..299
+      # this is ok, ignore it
+    when 300..399
+      # this is kinda ok, but let's log it ..
+      Rails.logger.info "weird response"
+    else
+      # otherwise re-raise it so the job fails
+      raise exception
+    end
+  end
+end
 ```
 
 ## Building Events

data/lib/webhook_system.rb

@@ -13,6 +13,7 @@ module WebhookSystem
   autoload :Job
   autoload :Encoder
   autoload :BaseEvent
+  autoload :EventLog
 
   # Error raised when there is an issue with decoding the payload
   class DecodingError < RuntimeError

data/lib/webhook_system/base_event.rb

@@ -4,6 +4,13 @@ module WebhookSystem
   class BaseEvent
     include PhModel
 
+    def initialize(*args, &block)
+      super(*args, &block)
+      @event_id = SecureRandom.uuid.freeze
+    end
+
+    attr_reader :event_id
+
     def event_name
       mesg = "class #{self.class.name} must implement abstract method `#{self.class.name}#event_name()'."
       raise RuntimeError.new(mesg).tap { |err| err.backtrace = caller }
@@ -15,7 +22,10 @@ module WebhookSystem
     end
 
     def as_json
-      result = { 'event' => event_name }
+      result = {
+        'event_name' => event_name,
+        'event_id' => event_id,
+      }
       each_attribute do |attribute_name, attribute_method|
         validate_attribute_name attribute_name
         result[attribute_name.to_s] = public_send(attribute_method).as_json
@@ -24,7 +34,7 @@ module WebhookSystem
     end
 
     def self.key_is_reserved?(key)
-      key.to_s.in? %w(event)
+      key.to_s.in? %w(event event_id)
     end
 
     private

data/lib/webhook_system/encoder.rb

@@ -49,7 +49,7 @@ module WebhookSystem
   # :nodoc:
   module Payload
     def self.encode(raw_encrypted_data, iv)
-      JSON.dump(
+      JSON.pretty_generate(
         'format' => 'base64+aes256',
         'payload' => Base64.encode64(raw_encrypted_data),
         'iv' => Base64.encode64(iv)

data/lib/webhook_system/event_log.rb

@@ -0,0 +1,39 @@
+module WebhookSystem
+
+  # This is the model holding on to all webhook responses
+  class EventLog < ActiveRecord::Base
+    self.table_name = 'webhook_event_logs'
+
+    belongs_to :subscription, class_name: 'WebhookSystem::Subscription'
+
+    validates :event_id, presence: true
+    validates :subscription_id, presence: true
+    validates :event_name, presence: true
+    validates :status, presence: true
+
+    serialize :request, JSON
+    serialize :response, JSON
+
+    def self.construct(subscription, event, request, response)
+      request_info = {
+        'event' => event,
+        'headers' => request.headers.to_hash,
+        'body' => request.body,
+        'url' => request.path,
+      }
+      response_info = {
+        'headers' => response.headers.to_hash,
+        'body' => response.body,
+      }
+
+      attributes = {
+        event_name: event['event_name'],
+        event_id: event['event_id'],
+        status: response.status,
+        request: request_info,
+        response: response_info,
+      }
+      subscription.event_logs.build(attributes)
+    end
+  end
+end

data/lib/webhook_system/job.rb

@@ -3,20 +3,48 @@ module WebhookSystem
   # This is the ActiveJob in charge of actually sending each event
   class Job < ActiveJob::Base
 
+    # Exception class around non 200 responses
+    class RequestFailed < RuntimeError
+      def initialize(message, code)
+        super(message)
+        @code = code
+      end
+    end
+
     def perform(subscription, event)
-      payload = Encoder.encode(subscription.secret, event)
-      self.class.post(subscription.url, payload)
+      self.class.post(subscription, event)
+    end
+
+    def self.post(subscription, event)
+      client = build_client
+      request = build_request(client, subscription, event)
+      response = client.builder.build_response(client, request)
+      log_response(subscription, event, request, response)
+      ensure_success(response)
     end
 
-    def self.post(endpoint, payload)
-      client_for(endpoint).post do |req|
+    def self.ensure_success(response)
+      status = response.status
+      unless status == 200
+        raise RequestFailed.new("request failed with code: #{status}", status)
+      end
+    end
+
+    def self.build_request(client, subscription, event)
+      payload = Encoder.encode(subscription.secret, event)
+      client.build_request(:post) do |req|
+        req.url subscription.url
         req.headers['Content-Type'] = 'application/json; base64+aes256'
         req.body = payload.to_s
       end
     end
 
-    def self.client_for(endpoint)
-      Faraday.new(url: endpoint) do |faraday|
+    def self.log_response(subscription, event, request, response)
+      EventLog.construct(subscription, event, request, response).save!
+    end
+
+    def self.build_client
+      Faraday.new do |faraday|
         faraday.response :logger if ENV['WEBHOOK_DEBUG']
         faraday.adapter Faraday.default_adapter
       end

data/lib/webhook_system/subscription.rb

@@ -8,6 +8,8 @@ module WebhookSystem
     validates :secret, presence: true
 
     has_many :topics, class_name: 'WebhookSystem::SubscriptionTopic', dependent: :destroy
+    has_many :event_logs, class_name: 'WebhookSystem::EventLog', dependent: :destroy
+
     accepts_nested_attributes_for :topics, allow_destroy: true
 
     scope :active, -> { where(active: true) }

data/lib/webhook_system/version.rb

@@ -1,4 +1,3 @@
-# frozen_string_literal: true
 module WebhookSystem
-  VERSION = '0.1.1'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/webhook_system.gemspec

@@ -36,6 +36,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'webmock'
 
   # static analysis gems
-  gem.add_development_dependency 'rubocop', '~> 0.36.0'
+  gem.add_development_dependency 'rubocop', '~> 0.37.1'
   gem.add_development_dependency 'reek', '~> 3.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webhook_system
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Piotr Banasik
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-05 00:00:00.000000000 Z
+date: 2016-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -226,14 +226,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.36.0
+        version: 0.37.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.36.0
+        version: 0.37.1
 - !ruby/object:Gem::Dependency
   name: reek
   requirement: !ruby/object:Gem::Requirement
@@ -271,6 +271,7 @@ files:
 - lib/webhook_system/base_event.rb
 - lib/webhook_system/dispatcher.rb
 - lib/webhook_system/encoder.rb
+- lib/webhook_system/event_log.rb
 - lib/webhook_system/job.rb
 - lib/webhook_system/subscription.rb
 - lib/webhook_system/subscription_topic.rb