webhook_system 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05503cb6981ef8a26c904b045fa7ad24b420f6f2
-  data.tar.gz: c870e8c64ffcc3dd09785b4e856e50ee385d1f3d
+  metadata.gz: c8cf0345d592bd7eddd4df0589e308f442300f2e
+  data.tar.gz: e45bc8b040f4e262dcc29ebff36283975cdf658b
 SHA512:
-  metadata.gz: 7f9fa83a0a0cdc22efac7c092807c86fc45e6df6bba6fa61d7b632dc33e146c90d58f7de1860abf15b9c92d0fd0b2683892b99b90b6c3fa690c750fa041770f2
-  data.tar.gz: 309d84dd3b30e2ebe343475ce7ac02fd316b617a86f0e2ba78eff1d2e8a15704b825a7ebf272089b8bb197732a4bd95bea148ec9a9f74300a7c50bbb04203d5a
+  metadata.gz: 2f73f386866cb8dacc605cebc14cd9bf2fa667b451a502eabf72cdef52cf7dfaa4b0e4c28787f5f1f9dc7a584046feb29a95baeb39c60eb343e4a0a99fc88a7a
+  data.tar.gz: bebab60ba8f6780a73aa93c8090acdd3e67ce7b416ab2c2634c249d61d0080010629b7b936a83d0a01e7390e400ba0166ab8a134030f033befbf532b39a13076

data/.reek

@@ -8,3 +8,6 @@ DataClump:
   max_copies: 4
 LongParameterList:
   max_params: 8
+
+exclude_paths:
+  - spec/support

data/README.md

@@ -6,7 +6,7 @@
 
 ## Description
 
-[![Build Status](https://travis-ci.org/payrollhero/webhook_engine.svg?branch=master)](https://travis-ci.org/payrollhero/webhook_engine)
+[![Build Status](https://travis-ci.org/payrollhero/webhook_system.svg?branch=master)](https://travis-ci.org/payrollhero/webhook_system)
 [![Code Climate](https://codeclimate.com/github/payrollhero/webhook_system/badges/gpa.svg)](https://codeclimate.com/github/payrollhero/webhook_system)
 [![Issue Count](https://codeclimate.com/github/payrollhero/webhook_system/badges/issue_count.svg)](https://codeclimate.com/github/payrollhero/webhook_system)
 [![Dependency Status](https://gemnasium.com/payrollhero/webhook_system.svg)](https://gemnasium.com/payrollhero/webhook_system)

data/lib/webhook_system.rb

@@ -2,6 +2,7 @@ require 'active_support/all'
 require 'active_record'
 require 'active_job'
 require 'ph_model'
+require 'validate_url'
 
 module WebhookSystem
   extend ActiveSupport::Autoload

data/lib/webhook_system/encoder.rb

@@ -2,40 +2,40 @@ module WebhookSystem
 
   # Class in charge of encoding and decoding encrypted payload
   module Encoder
-    class << self
-      # Given a secret string, encode the passed payload to json
-      # encrypt it, base64 encode that, and wrap it in its own json wrapper
-      #
-      # @param [String] secret_string some secret string
-      # @param [Object#to_json] payload Any object that responds to to_json
-      # @return [String] The encoded string payload (its a JSON string)
-      def encode(secret_string, payload)
-        cipher = OpenSSL::Cipher::AES256.new(:CBC)
-        cipher.encrypt
-        iv = cipher.random_iv
-        cipher.key = key_from_secret(iv, secret_string)
-        encoded = cipher.update(payload.to_json) + cipher.final
-        Payload.encode(encoded, iv)
-      end
+    # Given a secret string, encode the passed payload to json
+    # encrypt it, base64 encode that, and wrap it in its own json wrapper
+    #
+    # @param [String] secret_string some secret string
+    # @param [Object#to_json] payload Any object that responds to to_json
+    # @return [String] The encoded string payload (its a JSON string)
+    def self.encode(secret_string, payload)
+      cipher = OpenSSL::Cipher::AES256.new(:CBC)
+      cipher.encrypt
+      iv = cipher.random_iv
+      cipher.key = key_from_secret(iv, secret_string)
+      encoded = cipher.update(payload.to_json) + cipher.final
+      Payload.encode(encoded, iv)
+    end
 
-      # Given a secret string, and an encrypted payload, unwrap it, bas64 decode it
-      # decrypt it, and JSON decode it
-      #
-      # @param [String] secret_string some secret string
-      # @param [String] payload String as returned from #encode
-      # @return [Object] return the JSON decode of the encrypted payload
-      def decode(secret_string, payload)
-        encoded, iv = Payload.decode(payload)
-        cipher = OpenSSL::Cipher::AES256.new(:CBC)
-        cipher.decrypt
-        cipher.iv = iv
-        cipher.key = key_from_secret(iv, secret_string)
-        decoded = cipher.update(encoded) + cipher.final
-        JSON.load(decoded)
-      rescue OpenSSL::Cipher::CipherError
-        raise DecodingError, 'Decoding Failed, probably mismatched secret'
-      end
+    # Given a secret string, and an encrypted payload, unwrap it, bas64 decode it
+    # decrypt it, and JSON decode it
+    #
+    # @param [String] secret_string some secret string
+    # @param [String] payload String as returned from #encode
+    # @return [Object] return the JSON decode of the encrypted payload
+    def self.decode(secret_string, payload)
+      encoded, iv = Payload.decode(payload)
+      cipher = OpenSSL::Cipher::AES256.new(:CBC)
+      cipher.decrypt
+      cipher.iv = iv
+      cipher.key = key_from_secret(iv, secret_string)
+      decoded = cipher.update(encoded) + cipher.final
+      JSON.load(decoded)
+    rescue OpenSSL::Cipher::CipherError
+      raise DecodingError, 'Decoding Failed, probably mismatched secret'
+    end
 
+    class << self
       private
 
       def key_from_secret(iv, secret_string)
@@ -48,22 +48,20 @@ module WebhookSystem
   # not exposed to the outside
   # :nodoc:
   module Payload
-    class << self
-      def encode(raw_encrypted_data, iv)
-        JSON.dump(
-          'format' => 'base64+aes256',
-          'payload' => Base64.encode64(raw_encrypted_data),
-          'iv' => Base64.encode64(iv)
-        )
-      end
+    def self.encode(raw_encrypted_data, iv)
+      JSON.dump(
+        'format' => 'base64+aes256',
+        'payload' => Base64.encode64(raw_encrypted_data),
+        'iv' => Base64.encode64(iv)
+      )
+    end
 
-      def decode(payload_string)
-        payload = JSON.load(payload_string)
-        unless payload['format'] == 'base64+aes256'
-          raise ArgumentError, 'only know how to handle base64+aes256 payloads'
-        end
-        [Base64.decode64(payload['payload']), Base64.decode64(payload['iv'])]
+    def self.decode(payload_string)
+      payload = JSON.load(payload_string)
+      unless payload['format'] == 'base64+aes256'
+        raise ArgumentError, 'only know how to handle base64+aes256 payloads'
       end
+      [Base64.decode64(payload['payload']), Base64.decode64(payload['iv'])]
     end
   end
 end

data/lib/webhook_system/job.rb

@@ -5,35 +5,22 @@ module WebhookSystem
 
     def perform(subscription, event)
       payload = Encoder.encode(subscription.secret, event)
-      client = HttpClient.new(subscription.url)
-      client.post(payload)
+      self.class.post(subscription.url, payload)
     end
 
-  end
-
-  # Just a simple internal class to wrap around the http requests to the endpoints
-  class HttpClient
-    def initialize(endpoint)
-      @endpoint = endpoint
-    end
-
-    def post(payload)
-      client.post do |req|
+    def self.post(endpoint, payload)
+      client_for(endpoint).post do |req|
         req.headers['Content-Type'] = 'application/json; base64+aes256'
         req.body = payload.to_s
       end
     end
 
-    private
-
-    attr_reader :endpoint, :client
-
-    def client
-      @client ||= Faraday.new(url: endpoint) do |faraday|
-        # faraday.request :url_encoded # form-encode POST params
-        faraday.response :logger # log requests to STDOUT
+    def self.client_for(endpoint)
+      Faraday.new(url: endpoint) do |faraday|
+        faraday.response :logger if ENV['WEBHOOK_DEBUG']
         faraday.adapter Faraday.default_adapter
       end
     end
+
   end
 end

data/lib/webhook_system/subscription.rb

@@ -1,11 +1,14 @@
 module WebhookSystem
+
+  # This is the model encompassing the actual record of a webhook subscription
   class Subscription < ActiveRecord::Base
     self.table_name = 'webhook_subscriptions'
 
-    validates :url, presence: true
+    validates :url, presence: true, url: { no_local: true }
     validates :secret, presence: true
 
     has_many :topics, class_name: 'WebhookSystem::SubscriptionTopic', dependent: :destroy
+    accepts_nested_attributes_for :topics, allow_destroy: true
 
     scope :active, -> { where(active: true) }
     scope :for_topic, -> (topic) {
@@ -13,5 +16,36 @@ module WebhookSystem
     }
 
     scope :interested_in_topic, -> (topic) { active.for_topic(topic) }
+
+    # Just a helper to get a nice representation of the subscription
+    def url_domain
+      URI.parse(url).host
+    end
+
+    # Abstraction around the topics relation, returns an array of the subscribed topic names
+    def topic_names
+      topics.map(&:name)
+    end
+
+    # Abstraction around the topics relation, sets the topic names, requires save to take effect
+    def topic_names=(new_topics)
+      new_topics.reject!(&:blank?)
+      add_topics = new_topics - topic_names
+
+      new_topics_attributes = []
+
+      topics.each do |topic|
+        new_topics_attributes << {
+          id: topic.id,
+          name: topic.name,
+          _destroy: !new_topics.include?(topic.name),
+        }
+      end
+
+      new_topics_attributes += add_topics.map { |topic| { name: topic } }
+
+      self.topics_attributes = new_topics_attributes
+    end
+
   end
 end

data/lib/webhook_system/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module WebhookSystem
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.1.0'.freeze
 end

data/webhook_system.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'activejob'
   gem.add_runtime_dependency 'faraday'
   gem.add_runtime_dependency 'ph_model'
+  gem.add_runtime_dependency 'validate_url', '~> 1.0'
 
   gem.add_development_dependency 'bundler', '~> 1.0'
   gem.add_development_dependency 'rake'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webhook_system
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Piotr Banasik
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: validate_url
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement