issue 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29925e2f5c0b58136fe7097671b9577766034701c97aeb78fc9999a8fb4e23ee
-  data.tar.gz: 54d441c401a125e0e0ebea5baa48ead70dc3dcd5ad4a49c660673a4c626e3e07
+  metadata.gz: 10960451c8f6e5f752cc0a2b892ae8b8d122a14e1aaedc3671daa2da41cb80b8
+  data.tar.gz: b84a85ae117417a348dacfde4b387128190dcb72232e69abb96805eed8585926
 SHA512:
-  metadata.gz: 495c6477690e7bc7c688876ac242bb7884f87c9746dcc3ba6e0e2b8cbd8a012a758afcf07a2ef9f09b1a9280afac97a255a317fdcbfabb4668860a442dd04f37
-  data.tar.gz: 688bb57f456b5831a0840d8ad847bcd24a11baf42e43c09b1fe66fd2ae5292088da86aef45075c3c5025e39e792f51dff5d73594f7fea7f9a1d4605a2c05a0f2
+  metadata.gz: 60caa264fa776efee538761cfa9d06794859bca2490247e9cfdc76e1ea2c86a6e78b6e19fead11f98f522607c26224114b7db564404dd39657c35043f605ef87
+  data.tar.gz: 501ac0d34f7c80334a66ce90574b2677750b1b23287d2bb65682783fd21413504dec767e6decba5307ac8ddcf0c20beaa5df188f1e23d097ae2849baa66f2da0

data/lib/issue.rb

@@ -1,5 +1,6 @@
-require 'issue/version'
-
 module Issue
-
+  require_relative "issue/version"
+  require_relative "issue/payload"
+  require_relative "issue/webhook"
+  require_relative "issue/error"
 end

data/lib/issue/error.rb

@@ -0,0 +1,15 @@
+module Issue
+  class Error
+    attr :status
+    attr :message
+
+    # Initialize Issue::Error object with:
+    # status: html status code
+    # msg: message to send back in response
+    def initialize(status, msg)
+      @status = status
+      @message = msg
+    end
+
+  end
+end

data/lib/issue/payload.rb

@@ -0,0 +1,112 @@
+require "ostruct"
+require "json"
+
+module Issue
+  class Payload
+    attr_accessor :context
+
+    # Initialize Issue::Payload object with:
+    # json_data: the json sent from a GitHub webhook
+    # event: the value of the HTTP_X_GITHUB_EVENT header
+    #
+    # Initializing a new Issue::Payload instance makes all this info
+    # from the json webhook available via accessor methods:
+    #
+    #   action
+    #   event
+    #   issue_id
+    #   issue_title
+    #   issue_body
+    #   issue_author
+    #   repo
+    #   sender
+    #   event_action
+    #   raw_payload
+    #
+    # And if the case the event is 'issue_comment' also:
+    #
+    #   comment_body
+    #   comment_created_at
+    #   comment_url
+    #
+    def initialize(json_data, event)
+      action = json_data.dig("action")
+      sender = json_data.dig("sender", "login")
+      issue_id = json_data.dig("issue", "number")
+      issue_title = json_data.dig("issue", "title")
+      issue_body = json_data.dig("issue", "body")
+      issue_labels = json_data.dig("issue", "labels")
+      issue_author = json_data.dig("issue", "user", "login")
+      repo = json_data.dig("repository", "full_name")
+
+      @context = OpenStruct.new(
+        action: action,
+        event: event,
+        issue_id: issue_id,
+        issue_title: issue_title,
+        issue_body: issue_body,
+        issue_author: issue_author,
+        issue_labels: issue_labels,
+        repo: repo,
+        sender: sender,
+        event_action: "#{event}.#{action}",
+        raw_payload: json_data
+      )
+
+      if event == "issue_comment"
+        @context[:comment_body] = json_data.dig("comment", "body")
+        @context[:comment_created_at] = json_data.dig("comment", "created_at")
+        @context[:comment_url] = json_data.dig("comment", "html_url")
+      end
+
+      @context.each_pair do |method_name, value|
+        define_singleton_method(method_name) {value}
+      end
+    end
+
+    # True if the payload is coming from an issue that has just been opened
+    def opened?
+      action == "opened" || action == "reopened"
+    end
+
+    # True if the payload is coming from an issue that has just been closed
+    def closed?
+      action == "closed"
+    end
+
+    # True if the payload is coming from a new comment
+    def commented?
+      action == "created"
+    end
+
+    # True if the payload is coming from an edition of a comment or issue
+    def edited?
+      action == "edited"
+    end
+
+    # True if the payload is coming from locking an issue
+    def locked?
+      action == "locked"
+    end
+
+    # True if the payload is coming from unlocking an issue
+    def unlocked?
+      action == "unlocked"
+    end
+
+    # True if the payload is coming from pinning or unpinning an issue
+    def pinned?
+      action == "pinned" || action == "unpinned"
+    end
+
+    # True if the payload is coming from un/assigning an issue
+    def assigned?
+      action == "assigned" || action == "unassigned"
+    end
+
+    # True if the payload is coming from un/labeling an issue
+    def labeled?
+      action == "labeled" || action == "unlabeled"
+    end
+  end
+end

data/lib/issue/version.rb

@@ -1,3 +1,3 @@
 module Issue
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/issue/webhook.rb

@@ -0,0 +1,92 @@
+require "ostruct"
+require "json"
+require "openssl"
+require "rack"
+
+module Issue
+  class Webhook
+    attr_accessor :secret_token
+    attr_accessor :request
+    attr_accessor :accept_origin
+    attr_accessor :discard_sender
+    attr_accessor :accept_events
+    attr_accessor :error
+    attr_accessor :payload
+
+    # Initialize the Issue::Webhook object
+    # This method should receive a Hash with the following settings:
+    #   * secret_token: the GitHub secret token needed to verify the request signature
+    #   * accept_events: an Array of valid values for the HTTP_X_GITHUB_EVENT header. If empty any event will be precessed.
+    #   * origin: the respository where the webhook should be sent to be accepted. If empty any request will be precessed.
+    #   * discard_sender: an optional GitHub user handle to discard all events triggered by it.
+    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)
+    end
+
+    # This method will parse the passed request.
+    # If the request signature is incorrect or any of the conditions set
+    # via the initialization settings are not met an error will be created
+    # with the appropiate html status and message. Otherwise a Issue::Payload
+    # object will be created with the information contained in the request payload.
+    #
+    # This method returns a pair [payload, error] where only one of them will be nil
+    def parse_request(request)
+      @payload = nil
+      @error = nil
+      @request = request
+
+      if verify_signature
+        parse_payload
+      end
+
+      return [payload, error]
+    end
+
+    # This method returns True if parsing a request has generated an Issue::Error object
+    # That object will be available at the #error accessor method.
+    def errored?
+      !error.nil?
+    end
+
+    private
+
+    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?
+      return error!(403, "Request missing signature") if gh_signature.nil? || gh_signature.empty?
+      request.body.rewind
+      payload_body = request.body.read
+      signature = "sha1=" + OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new("sha1"), secret_token, payload_body)
+      return error!(403, "Signatures didn't match!") unless Rack::Utils.secure_compare(signature, gh_signature)
+      true
+    end
+
+    def parse_payload
+      begin
+        request.body.rewind
+        json_payload = JSON.parse(request.body.read)
+        event = request.get_header "HTTP_X_GITHUB_EVENT"
+        sender = json_payload.dig("sender", "login")
+        origin = json_payload.dig("repository", "full_name")
+      rescue JSON::ParserError
+        return error!(400, "Malformed request")
+      end
+
+      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!(403, "Event origin not allowed") if (accept_origin && origin != accept_origin)
+
+      @payload = Issue::Payload.new(json_payload, event)
+    end
+
+    def error!(status, msg)
+      @error = Issue::Error.new(status, msg)
+      false
+    end
+  end
+end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: issue
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Juanjo Bazán
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-29 00:00:00.000000000 Z
+date: 2021-07-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: openssl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -47,14 +75,17 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/issue.rb
+- lib/issue/error.rb
+- lib/issue/payload.rb
 - lib/issue/version.rb
+- lib/issue/webhook.rb
 homepage: http://github.com/xuanxu/issue
 licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/xuanxu/issue/issues
   changelog_uri: https://github.com/xuanxu/issue/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/emoticon
+  documentation_uri: https://www.rubydoc.info/gems/issue
   homepage_uri: http://github.com/xuanxu/issue
   source_code_uri: http://github.com/xuanxu/issue
 post_install_message: