github_webhook 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 884527952c3de87ab10113b15faa48a4a3943557
-  data.tar.gz: e9d7222f4ea4724f6426ccf6643f5270063502c9
+  metadata.gz: 482d71a9312b1b80aeee8af5c230e80ca9b5cd15
+  data.tar.gz: 8e788b3145ab2874ff71f5a4fda3c2a8f89557a3
 SHA512:
-  metadata.gz: 55a2b86574e657e4c2d50149d0c2fbf928a7ba7acbfd0f89032615142c4f03541728a0aee4c666ed5c33ec748d3963ebc4911877be33b0cfcc5ee9a724cd710b
-  data.tar.gz: 507a45eb2713452ad0513e4bf6396a50aae2e639fde460b91a43b03358753faef905102cb1ec2b7db837c584a115f5c881e8da60cecdbf422406ff4c49379e5c
+  metadata.gz: cbe5e47e926c147748387234219b18a2b330b526f2f7804a5e8bb9d1fbe4ef16c978a72437525bdbfbdcd95f2f62901d5b7f26a4eb637721d734ac87c0a0b354
+  data.tar.gz: 8eda80c2a630d17eed37e66b8c15c30ae4eadf57d71430ba1ea1e3665d68c9514d39b8c75bcd1f4d8f8d86c0e550a53dd5bd1203f60438cd5759fffd2171e479

data/.ruby-version

@@ -0,0 +1 @@
+2.4.2

data/.travis.yml

@@ -1,8 +1,7 @@
 language: ruby
 rvm:
-  - 2.4.1
-  - 2.3.4
-  - 2.2.5
+  - 2.4.2
+  - 2.3.5
 addons:
   code_climate:
     repo_token: 50425d682162d68af0b65bd9e5160da8337d2159fc3ebc00d2a5b14386548ac5

data/Gemfile.lock

@@ -1,27 +1,64 @@
 PATH
   remote: .
   specs:
-    github_webhook (1.0.5)
+    github_webhook (1.1.0)
       activesupport (>= 4)
       rack (>= 1.3)
+      railties (>= 4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.1.2)
+    actionpack (5.1.4)
+      actionview (= 5.1.4)
+      activesupport (= 5.1.4)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.4)
+      activesupport (= 5.1.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activesupport (5.1.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
+    builder (3.2.3)
     codeclimate-test-reporter (0.4.8)
       simplecov (>= 0.7.1, < 1.0.0)
     concurrent-ruby (1.0.5)
+    crass (1.0.2)
     diff-lcs (1.2.5)
     docile (1.1.5)
+    erubi (1.6.1)
     i18n (0.8.6)
     json (1.8.6)
+    loofah (2.1.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.0)
+    mini_portile2 (2.3.0)
     minitest (5.10.3)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
     rack (2.0.3)
+    rack-test (0.7.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.1.4)
+      actionpack (= 5.1.4)
+      activesupport (= 5.1.4)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
     rake (10.3.1)
     rspec (2.14.1)
       rspec-core (~> 2.14.0)
@@ -36,6 +73,7 @@ GEM
       json (~> 1.8)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
+    thor (0.20.0)
     thread_safe (0.3.6)
     tzinfo (1.2.3)
       thread_safe (~> 0.1)
@@ -51,4 +89,4 @@ DEPENDENCIES
   rspec (~> 2.14)
 
 BUNDLED WITH
-   1.15.3
+   1.16.0.pre.2

data/README.md

@@ -13,7 +13,7 @@ to a [GitHub webhook](https://developer.github.com/webhooks/)
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'github_webhook', '~> 1.0.5'
+gem 'github_webhook', '~> 1.1'
 ```
 
 And then execute:
@@ -46,6 +46,8 @@ class GithubWebhooksController < ActionController::Base
     # TODO: handle create webhook
   end
 
+  private
+
   def webhook_secret(payload)
     ENV['GITHUB_WEBHOOK_SECRET']
   end

data/github_webhook.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "rack", ">= 1.3"
   spec.add_dependency "activesupport", ">= 4"
+  spec.add_dependency "railties", ">= 4"
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake", "~> 10.1"

data/lib/github_webhook.rb

@@ -4,4 +4,11 @@ require 'active_support/concern'
 require 'active_support/core_ext/hash/indifferent_access'
 
 require 'github_webhook/version'
-require 'github_webhook/processor'
+require 'github_webhook/processor'
+require 'github_webhook/railtie'
+
+module GithubWebhook
+  class <<self
+    attr_accessor :logger
+  end
+end

data/lib/github_webhook/processor.rb

@@ -64,7 +64,7 @@ module GithubWebhook::Processor
   )
 
   def create
-    if self.respond_to? event_method
+    if self.respond_to?(event_method, true)
       self.send event_method, json_body
       head(:ok)
     else
@@ -73,7 +73,8 @@ module GithubWebhook::Processor
   end
 
   def github_ping(payload)
-    puts "[GithubWebhook::Processor] Hook ping received, hook_id: #{payload[:hook_id]}, #{payload[:zen]}"
+    GithubWebhook.logger && GithubWebhook.logger.info("[GithubWebhook::Processor] Hook ping "\
+      "received, hook_id: #{payload[:hook_id]}, #{payload[:zen]}")
   end
 
   private
@@ -81,12 +82,14 @@ module GithubWebhook::Processor
   HMAC_DIGEST = OpenSSL::Digest.new('sha1')
 
   def authenticate_github_request!
-    raise UnspecifiedWebhookSecretError.new unless respond_to?(:webhook_secret)
+    raise UnspecifiedWebhookSecretError.new unless respond_to?(:webhook_secret, true)
     secret = webhook_secret(json_body)
 
     expected_signature = "sha1=#{OpenSSL::HMAC.hexdigest(HMAC_DIGEST, secret, request_body)}"
     if signature_header != expected_signature
-      raise SignatureError.new "Actual: #{signature_header}, Expected: #{expected_signature}"
+      GithubWebhook.logger && GithubWebhook.logger.warn("[GithubWebhook::Processor] signature "\
+        "invalid, actual: #{signature_header}, expected: #{expected_signature}")
+      raise SignatureError
     end
   end
 

data/lib/github_webhook/railtie.rb

@@ -0,0 +1,9 @@
+require 'rails'
+
+module GithubWebhook
+  class Railties < ::Rails::Railtie
+    initializer 'Rails logger' do
+      GithubWebhook.logger = Rails.logger
+    end
+  end
+end

data/lib/github_webhook/version.rb

@@ -1,3 +1,3 @@
 module GithubWebhook
-  VERSION = "1.0.5"
+  VERSION = "1.1.0"
 end

data/spec/github_webhook/processor_spec.rb

@@ -28,25 +28,49 @@ module GithubWebhook
       end
     end
 
+    class ControllerWithPrivateSecret < ControllerWithoutSecret
+      private
+      def webhook_secret(payload)
+        "secret"
+      end
+    end
+
     class Controller < ControllerWithoutSecret
       def webhook_secret(payload)
         "secret"
       end
     end
 
+    let(:controller_class) { Controller }
+
     let(:controller) do
-      controller = Controller.new
+      controller = controller_class.new
       controller.request = Request.new
       controller
     end
 
-    let(:controller_without_secret) do
-      ControllerWithoutSecret.new
-    end
-
     describe "#create" do
-      it "raises an error when secret is not defined" do
-        expect { controller_without_secret.send :authenticate_github_request! }.to raise_error(Processor::UnspecifiedWebhookSecretError)
+      context 'when #webhook_secret is not defined' do
+        let(:controller_class) { ControllerWithoutSecret }
+
+        it "raises a Processor::UnspecifiedWebhookSecretError" do
+          expect { controller.send :authenticate_github_request! }
+            .to raise_error(Processor::UnspecifiedWebhookSecretError)
+        end
+      end
+
+      context 'when #webhook_secret is private' do
+        let(:controller_class) { ControllerWithPrivateSecret }
+
+        it "calls the #push method in controller" do
+          expect(controller).to receive(:github_push)
+          controller.request.body = StringIO.new({ :foo => "bar" }.to_json.to_s)
+          controller.request.headers['X-Hub-Signature'] = "sha1=52b582138706ac0c597c315cfc1a1bf177408a4d"
+          controller.request.headers['X-GitHub-Event'] = 'push'
+          controller.request.headers['Content-Type'] = 'application/json'
+          controller.send :authenticate_github_request!  # Manually as we don't have the before_filter logic in our Mock object
+          controller.create
+        end
       end
 
       it "calls the #push method in controller (json)" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github_webhook
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Sebastien Saunier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-24 00:00:00.000000000 Z
+date: 2017-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -102,6 +116,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -111,6 +126,7 @@ files:
 - github_webhook.gemspec
 - lib/github_webhook.rb
 - lib/github_webhook/processor.rb
+- lib/github_webhook/railtie.rb
 - lib/github_webhook/version.rb
 - spec/github_webhook/processor_spec.rb
 - spec/spec_helper.rb
@@ -134,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Process GitHub Webhooks in your Rails app (Controller mixin)