issue 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edf054d58775c3a56083086359673f70b4a67270233ac33959d0f1184b89e625
-  data.tar.gz: b5df077ef1860d4d030c9b23a3a847afd27307a2760200d67037c69c578fc069
+  metadata.gz: 9a0d24902085e9ef25c6765748362b06f5015bbd88848db03513c0cd7f33ce9c
+  data.tar.gz: '099f1cce4e61d95ab0ca87a6c057f59c5b4bae50e2b59cca25df9e334d3b1c39'
 SHA512:
-  metadata.gz: b527de4e23138ee77c2d8740c85df2370e6141d20642276f5a6d2a7d64901ce70a21b1058605d67a084eb110c5e395e75ea56c9ae9eb2e99337e2bcf87576142
-  data.tar.gz: e72e0322a81d36c612006d23fa1fa91aea3ae11f458b29c1ab83d166f6c17deb901fbc59e86ce534d765101b80b9fc10829524de7e93d623a4529218cec66ae2
+  metadata.gz: d5a4bcfa1cb46b5b6a78184e235743cc846f213448c208e0f0da5345c8635e2c635437d57ad66d186f07feb63b5bd0bbcddfae35b42e9e2873d65b4525e8be7f
+  data.tar.gz: 81f10062dc2f189ea2ca8e891139718048a24072ec7d9168391a9ce5eaee5baaf5f6d0359c36cc0cb323fd717821989bb5941a194a6b8c4c3f08159522aeb661

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+
+## 1.0.0 (2021-12-17)
+
+- Webhook can discard requests by multiple sender/events pairs
+
 ## 0.3.0 (2021-10-04)
 
 - Add comment_id to Payload's context

data/README.md

@@ -28,7 +28,7 @@ The `Issue::Webhook` is used to declare and parse a GitHub webhook. At initializ
 
 - **secret_token**: The GitHub secret access token for authorization
 - **origin**: The repository to accept payloads from. If nil any origin will be accepted. If not nil any request from a different repository will be ignored
-- **discard_sender**: The GitHub handle of a user whose events will be ignored. Usually the organization bot. If nil no user will be ignored.
+- **discard_sender**: The GitHub handle of a user whose events will be ignored. Usually the organization bot. If nil no user will be ignored. To ignore only specific events use a Hash where keys are usernames and values are arrays of events to ignore for that username.
 - **accept_events**: An Array of GitHub event types to accept. If nil all events will be accepted.
 
 Once it is initialized a request can be parsed passing it to the **`parse_request`** method. After verifying the request signature and checking for the configurated conditions the `parse_request` method returns a [Payload, Error] pair, where the error is nil if nothing failed, and the payload is nil if an error ocurred.
@@ -66,6 +66,7 @@ The `Issue::Payload` object includes all the parsed information coming from the
   repo:               # the full name of the origin repository
   sender:             # the login of the user triggering the webhook action
   event_action:       # a string: "event.action"
+  comment_id:         # id of the comment
   comment_body:       # body of the comment
   comment_created_at: # created_at value of the comment
   comment_url:        # the html url for the comment

data/lib/issue/version.rb

@@ -1,3 +1,3 @@
 module Issue
-  VERSION = "0.3.0"
+  VERSION = "1.0.0"
 end

data/lib/issue/webhook.rb

@@ -22,8 +22,8 @@ module Issue
     def initialize(settings={})
       @secret_token = settings[:secret_token]
       @accept_origin = settings[:origin]
-      @discard_sender = settings[:discard_sender]
       @accept_events = [settings[:accept_events]].flatten.compact.uniq.map(&:to_s)
+      @discard_sender = parse_discard_senders(settings[:discard_sender])
     end
 
     # This method will parse the passed request.
@@ -53,6 +53,16 @@ module Issue
 
     private
 
+    def parse_discard_senders(discard_sender_settings)
+      if discard_sender_settings.is_a?(String)
+        return { discard_sender_settings => [] }
+      elsif discard_sender_settings.is_a?(Hash)
+        return discard_sender_settings.transform_keys {|k| k.to_s }.transform_values {|v| [v].flatten}
+      else
+        return {}
+      end
+    end
+
     def verify_signature
       gh_signature = request.get_header "HTTP_X_HUB_SIGNATURE"
       return error!(500, "Can't compute signature") if secret_token.nil? || secret_token.empty?
@@ -78,7 +88,7 @@ module Issue
       return error!(422, "No payload") if json_payload.nil? || json_payload.empty?
       return error!(422, "No event") if event.nil?
       return error!(200, "Event discarded") unless (accept_events.empty? || accept_events.include?(event))
-      return error!(200, "Event origin discarded") if (discard_sender && sender == discard_sender)
+      return error!(200, "Event origin discarded") if (discard_sender[sender] == [] || discard_sender[sender].to_a.include?(event))
       return error!(403, "Event origin not allowed") if (accept_origin && origin != accept_origin)
 
       @payload = Issue::Payload.new(json_payload, event)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: issue
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Juanjo Bazán
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-04 00:00:00.000000000 Z
+date: 2021-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: openssl