github_webhook 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68085b2caf36fbd2af5d858a0fd98ce539d0c98a0c23b45e399eca378f17175b
-  data.tar.gz: 547ce4ef7686bb5a886a03e2f7c550a8602729608302aa1f9daeaacee9a26acd
+  metadata.gz: ec22b9a09fcb0d2833a46cffacf39ac9703b33fd0b909bfee2258f4191fdfc21
+  data.tar.gz: 0f0fc361b3f1ccccb93dc66baf1b75d3ebc1f34fa3ef6022a0598dd6abc20c1b
 SHA512:
-  metadata.gz: e4cd1c3ff4f074510e1228e950b9d71d2e663869cb78e5f7f98cc0028d365ece7ddacd447c0bfd1525ed04739d3b156ffe1cc8f9fde12a865212ab379eed5252
-  data.tar.gz: 549b72dcc5a79abddbd693c1771c96f51a35a58dd53012240bad08164f5217f71c399d71ca4c4d30aff3d8047775907bb1132515601c6d0f0eea37bce4bff519
+  metadata.gz: 4292322d0e533e85de5fdedf0c67efe57847114beda60ba710a3fe191d9a59ad3c61fe8ead9c68272ba8067b53f709a10980059c6cb4a37f3898a6bc6b0b1f3a
+  data.tar.gz: 767ce312e69c381ac91cc6bd4c9cf913b1297ca9d4ee990f38cf8e55f306c8607421dcaf1b0ab9941da41003f20674346512c53595d5d61c6a9866cdb6f5a559

data/README.md

@@ -21,7 +21,7 @@ If you are on Rails, please read on!
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'github_webhook', '~> 1.2'
+gem 'github_webhook', '~> 1.4'
 ```
 
 And then execute:

data/lib/github_webhook/processor.rb

@@ -1,16 +1,12 @@
 module GithubWebhook::Processor
   extend ActiveSupport::Concern
+  require 'abstract_controller'
 
   included do
     before_action :authenticate_github_request!, only: :create
     before_action :check_github_event!, only: :create
   end
 
-  class SignatureError < StandardError; end
-  class UnspecifiedWebhookSecretError < StandardError; end
-  class UnsupportedGithubEventError < StandardError; end
-  class UnsupportedContentTypeError < StandardError; end
-
   # To fetch list from https://developer.github.com/v3/activity/events/types
   # run this little JS code in the console:
   #    document.querySelectorAll('.list-style-none li.lh-condensed a').forEach(e => console.log(e.text))
@@ -75,7 +71,7 @@ module GithubWebhook::Processor
       self.send event_method, json_body
       head(:ok)
     else
-      raise NoMethodError.new("GithubWebhooksController##{event_method} not implemented")
+      raise AbstractController::ActionNotFound.new("GithubWebhooksController##{event_method} not implemented")
     end
   end
 
@@ -89,20 +85,20 @@ module GithubWebhook::Processor
   HMAC_DIGEST = OpenSSL::Digest.new('sha256')
 
   def authenticate_github_request!
-    raise UnspecifiedWebhookSecretError.new unless respond_to?(:webhook_secret, true)
+    raise AbstractController::ActionNotFound.new unless respond_to?(:webhook_secret, true)
     secret = webhook_secret(json_body)
 
     expected_signature = "sha256=#{OpenSSL::HMAC.hexdigest(HMAC_DIGEST, secret, request_body)}"
     unless ActiveSupport::SecurityUtils.secure_compare(signature_header, expected_signature)
       GithubWebhook.logger && GithubWebhook.logger.warn("[GithubWebhook::Processor] signature "\
         "invalid, actual: #{signature_header}, expected: #{expected_signature}")
-      raise SignatureError
+      raise AbstractController::ActionNotFound
     end
   end
 
   def check_github_event!
     unless GITHUB_EVENTS.include?(request.headers['X-GitHub-Event'])
-      raise UnsupportedGithubEventError.new("#{request.headers['X-GitHub-Event']} is not a whitelisted GitHub event. See https://developer.github.com/v3/activity/events/types/")
+      raise AbstractController::ActionNotFound.new("#{request.headers['X-GitHub-Event']} is not a whitelisted GitHub event. See https://developer.github.com/v3/activity/events/types/")
     end
   end
 
@@ -123,7 +119,7 @@ module GithubWebhook::Processor
       when 'application/json'
         payload = request_body
       else
-        raise UnsupportedContentTypeError.new(
+        raise AbstractController::ActionNotFound.new(
           "Content-Type #{content_type} is not supported. Use 'application/x-www-form-urlencoded' or 'application/json")
       end
       ActiveSupport::HashWithIndifferentAccess.new(JSON.load(payload))

data/lib/github_webhook/version.rb

@@ -1,3 +1,3 @@
 module GithubWebhook
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

data/spec/github_webhook/processor_spec.rb

@@ -53,9 +53,9 @@ module GithubWebhook
       context 'when #webhook_secret is not defined' do
         let(:controller_class) { ControllerWithoutSecret }
 
-        it "raises a Processor::UnspecifiedWebhookSecretError" do
+        it "raises a AbstractController::ActionNotFound" do
           expect { controller.send :authenticate_github_request! }
-            .to raise_error(Processor::UnspecifiedWebhookSecretError)
+            .to raise_error(AbstractController::ActionNotFound)
         end
       end
 
@@ -99,19 +99,25 @@ module GithubWebhook
         controller.request.headers['X-Hub-Signature-256'] = "sha256=FOOBAR"
         controller.request.headers['X-GitHub-Event'] = 'push'
         controller.request.headers['Content-Type'] = 'application/json'
-        expect { controller.send :authenticate_github_request! }.to raise_error(Processor::SignatureError)
+        expect { controller.send :authenticate_github_request! }.to raise_error(AbstractController::ActionNotFound)
       end
 
       it "raises an error when the github event method is not implemented" do
         controller.request.headers['X-GitHub-Event'] = 'deployment'
         controller.request.headers['Content-Type'] = 'application/json'
-        expect { controller.create }.to raise_error(NoMethodError)
+        expect { controller.create }.to raise_error(
+          AbstractController::ActionNotFound,
+          "GithubWebhooksController#github_deployment not implemented",
+        )
       end
 
       it "raises an error when the github event is not in the whitelist" do
         controller.request.headers['X-GitHub-Event'] = 'fake_event'
         controller.request.headers['Content-Type'] = 'application/json'
-        expect { controller.send :check_github_event! }.to raise_error(Processor::UnsupportedGithubEventError)
+        expect { controller.send :check_github_event! }.to raise_error(
+          AbstractController::ActionNotFound,
+          "fake_event is not a whitelisted GitHub event. See https://developer.github.com/v3/activity/events/types/",
+        )
       end
 
       it "raises an error when the content type is not correct" do
@@ -119,14 +125,17 @@ module GithubWebhook
         controller.request.headers['X-Hub-Signature-256'] = "sha256=3f3ab3986b656abb17af3eb1443ed6c08ef8fff9fea83915909d1b421aec89be"
         controller.request.headers['X-GitHub-Event'] = 'ping'
         controller.request.headers['Content-Type'] = 'application/xml'
-        expect { controller.send :authenticate_github_request! }.to raise_error(Processor::UnsupportedContentTypeError)
+        expect { controller.send :authenticate_github_request! }.to raise_error(
+          AbstractController::ActionNotFound,
+          "Content-Type application/xml is not supported. Use 'application/x-www-form-urlencoded' or 'application/json",
+        )
       end
 
       it 'raises SignatureError when the X-Hub-Signature header is missing' do
         controller.request.body = StringIO.new('{}')
         controller.request.headers['Content-Type'] = 'application/json'
         controller.request.headers['X-GitHub-Event'] = 'ping'
-        expect { controller.send :authenticate_github_request! }.to raise_error(Processor::SignatureError)
+        expect { controller.send :authenticate_github_request! }.to raise_error(AbstractController::ActionNotFound)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github_webhook
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Sebastien Saunier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-11 00:00:00.000000000 Z
+date: 2021-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack