fastlane-plugin-github_api 0.1.0

data/lib/fastlane/plugin/github_api/actions/github_dismiss_pull_review_action.rb

@@ -0,0 +1,168 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_DISMISS_PULL_REVIEW_STATUS_CODE = :GITHUB_DISMISS_PULL_REVIEW_STATUS_CODE
+      GITHUB_DISMISS_PULL_REVIEW_RESPONSE = :GITHUB_DISMISS_PULL_REVIEW_RESPONSE
+      GITHUB_DISMISS_PULL_REVIEW_JSON = :GITHUB_DISMISS_PULL_REVIEW_JSON
+    end
+
+    class GithubDismissPullReviewAction < Action
+      class << self
+        def run(params)
+          require 'json'
+          
+          # Prepare API call parameters
+          server_url = params[:server_url]
+          api_token = params[:api_token]
+          repo_owner = params[:repo_owner]
+          repo_name = params[:repo_name]
+          pull_number = params[:pull_number]
+          review_id = params[:review_id]
+          message = params[:message]
+          
+          # Build the body for the request
+          body = { message: message }
+          
+          # Build the path
+          path = "/repos/#{repo_owner}/#{repo_name}/pulls/#{pull_number}/reviews/#{review_id}/dismissals"
+          
+          UI.message("Dismissing review ##{review_id} for pull request ##{pull_number} in #{repo_owner}/#{repo_name}")
+          response = Helper::GithubApiHelper.github_api_request(
+            token: api_token,
+            path: path,
+            params: body,
+            method: :put,
+            server_url: server_url
+          )
+          
+          status_code = response[:status]
+          json_response = response[:json]
+          result = {
+            status: status_code,
+            body: response[:body],
+            json: json_response
+          }
+          
+          if status_code.between?(200, 299)
+            UI.success("Successfully dismissed review ##{review_id} for pull request ##{pull_number}")
+          else
+            UI.error("Error dismissing review: #{status_code}")
+            UI.error(response[:body])
+            UI.user_error!("GitHub API returned #{status_code}: #{response[:body]}")
+            return nil
+          end
+          
+          # Store the results in shared values
+          Actions.lane_context[SharedValues::GITHUB_DISMISS_PULL_REVIEW_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_DISMISS_PULL_REVIEW_RESPONSE] = response[:body]
+          Actions.lane_context[SharedValues::GITHUB_DISMISS_PULL_REVIEW_JSON] = json_response
+          
+          return result
+        end
+        
+        #####################################################
+        # @!group Documentation
+        #####################################################
+        
+        def description
+          "Dismiss a review for a pull request"
+        end
+        
+        def details
+          [
+            "Dismisses a review for a pull request.",
+            "You must provide your GitHub Personal token (get one from https://github.com/settings/tokens/new).",
+            "API Documentation: https://docs.github.com/en/rest/pulls/reviews#dismiss-a-review-for-a-pull-request"
+          ].join("\n")
+        end
+        
+        def available_options
+          [
+            FastlaneCore::ConfigItem.new(key: :api_token,
+                                 env_name: "GITHUB_API_TOKEN",
+                              description: "GitHub API token",
+                                 optional: false,
+                                sensitive: true,
+                       code_gen_sensitive: true,
+                            default_value: ENV["GITHUB_API_TOKEN"],
+                             verify_block: proc do |value|
+                               UI.user_error!("No GitHub API token given, pass using `api_token: 'token'`") if value.to_s.empty?
+                             end),
+            FastlaneCore::ConfigItem.new(key: :server_url,
+                                 env_name: "GITHUB_API_SERVER_URL",
+                              description: "GitHub API server URL",
+                                 optional: true,
+                            default_value: "https://api.github.com"),
+            FastlaneCore::ConfigItem.new(key: :repo_owner,
+                                 env_name: "GITHUB_API_REPO_OWNER",
+                              description: "Owner of the repository",
+                                 optional: false),
+            FastlaneCore::ConfigItem.new(key: :repo_name,
+                                 env_name: "GITHUB_API_REPO_NAME",
+                              description: "Name of the repository",
+                                 optional: false),
+            FastlaneCore::ConfigItem.new(key: :pull_number,
+                                 env_name: "GITHUB_API_PULL_NUMBER",
+                              description: "The number of the pull request",
+                                 optional: false,
+                                     type: Integer),
+            FastlaneCore::ConfigItem.new(key: :review_id,
+                                 env_name: "GITHUB_API_REVIEW_ID",
+                              description: "The ID of the review",
+                                 optional: false,
+                                     type: Integer),
+            FastlaneCore::ConfigItem.new(key: :message,
+                                 env_name: "GITHUB_API_REVIEW_DISMISS_MESSAGE",
+                              description: "The message for the review dismissal",
+                                 optional: false,
+                                     type: String)
+          ]
+        end
+
+        def output
+          [
+            ['GITHUB_DISMISS_PULL_REVIEW_STATUS_CODE', 'The status code returned by the GitHub API'],
+            ['GITHUB_DISMISS_PULL_REVIEW_RESPONSE', 'The full response body returned by the GitHub API'],
+            ['GITHUB_DISMISS_PULL_REVIEW_JSON', 'The parsed JSON response returned by the GitHub API']
+          ]
+        end
+
+        def return_value
+          "Returns a hash containing the status code, response body, and parsed JSON response from the GitHub API."
+        end
+
+        def authors
+          ["crazymanish"]
+        end
+
+        def is_supported?(platform)
+          true
+        end
+        
+        def example_code
+          [
+            'github_dismiss_pull_review(
+              repo_owner: "octocat",
+              repo_name: "Hello-World",
+              pull_number: 42,
+              review_id: 80,
+              message: "Dismissing this review as the code has been updated."
+            )',
+            'dismissed_review = github_dismiss_pull_review(
+              repo_owner: "octocat",
+              repo_name: "Hello-World",
+              pull_number: 42,
+              review_id: 80,
+              message: "This review is no longer relevant."
+            )
+            
+            puts "Review dismissed successfully with status: #{dismissed_review[:status]}"'
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/github_api/actions/github_get_issue_action.rb

@@ -0,0 +1,166 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_GET_ISSUE_STATUS_CODE = :GITHUB_GET_ISSUE_STATUS_CODE
+      GITHUB_GET_ISSUE_RESPONSE = :GITHUB_GET_ISSUE_RESPONSE
+      GITHUB_GET_ISSUE_JSON = :GITHUB_GET_ISSUE_JSON
+    end
+
+    class GithubGetIssueAction < Action
+      class << self
+        def run(params)
+          require 'json'
+          
+          # Prepare API call parameters
+          server_url = params[:server_url]
+          api_token = params[:api_token]
+          repo_owner = params[:repo_owner]
+          repo_name = params[:repo_name]
+          issue_number = params[:issue_number]
+          
+          # Validate parameters
+          UI.user_error!("No GitHub issue number given, pass using `issue_number: 123`") unless issue_number.to_s.length > 0
+          
+          # Build the path
+          path = "/repos/#{repo_owner}/#{repo_name}/issues/#{issue_number}"
+          
+          UI.message("Fetching issue ##{issue_number} from #{repo_owner}/#{repo_name}")
+          response = Helper::GithubApiHelper.github_api_request(
+            token: api_token,
+            path: path,
+            method: :get,
+            server_url: server_url
+          )
+          
+          status_code = response[:status]
+          json_response = response[:json]
+          result = {
+            status: status_code,
+            body: response[:body],
+            json: json_response
+          }
+          
+          if status_code.between?(200, 299)
+            UI.success("Successfully fetched issue ##{issue_number} from #{repo_owner}/#{repo_name}")
+          else
+            UI.error("Error fetching issue: #{status_code}")
+            UI.error(response[:body])
+            UI.user_error!("GitHub API returned #{status_code}: #{response[:body]}")
+            return nil
+          end
+          
+          # Store the results in shared values
+          Actions.lane_context[SharedValues::GITHUB_GET_ISSUE_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_GET_ISSUE_RESPONSE] = response[:body]
+          Actions.lane_context[SharedValues::GITHUB_GET_ISSUE_JSON] = json_response
+          
+          return result
+        end
+        
+        #####################################################
+        # @!group Documentation
+        #####################################################
+        
+        def description
+          "Gets a specific GitHub issue by number"
+        end
+        
+        def details
+          [
+            "Gets a specific issue from a GitHub repository by its issue number.",
+            "You must provide your GitHub Personal token (get one from https://github.com/settings/tokens/new).",
+            "API Documentation: https://docs.github.com/en/rest/issues/issues#get-an-issue"
+          ].join("\n")
+        end
+        
+        def available_options
+          [
+            FastlaneCore::ConfigItem.new(key: :api_token,
+                                 env_name: "GITHUB_API_TOKEN",
+                              description: "GitHub API token",
+                                 optional: false,
+                                sensitive: true,
+                       code_gen_sensitive: true,
+                            default_value: ENV["GITHUB_API_TOKEN"],
+                             verify_block: proc do |value|
+                               UI.user_error!("No GitHub API token given, pass using `api_token: 'token'`") if value.to_s.empty?
+                             end),
+            FastlaneCore::ConfigItem.new(key: :server_url,
+                                 env_name: "GITHUB_API_SERVER_URL",
+                              description: "GitHub API server URL",
+                                 optional: true,
+                            default_value: "https://api.github.com"),
+            FastlaneCore::ConfigItem.new(key: :repo_owner,
+                                 env_name: "GITHUB_API_REPO_OWNER",
+                              description: "Repository owner (organization or username)",
+                                 optional: false,
+                                     type: String,
+                              verify_block: proc do |value|
+                                UI.user_error!("No repository owner provided, pass using `repo_owner: 'owner'`") if value.to_s.empty?
+                              end),
+            FastlaneCore::ConfigItem.new(key: :repo_name,
+                                 env_name: "GITHUB_API_REPO_NAME",
+                              description: "Repository name",
+                                 optional: false,
+                                     type: String,
+                              verify_block: proc do |value|
+                                UI.user_error!("No repository name provided, pass using `repo_name: 'name'`") if value.to_s.empty?
+                              end),
+            FastlaneCore::ConfigItem.new(key: :issue_number,
+                                 env_name: "GITHUB_API_ISSUE_NUMBER",
+                              description: "The issue number",
+                                 optional: false,
+                                     type: Integer)
+          ]
+        end
+        
+        def output
+          [
+            ['GITHUB_GET_ISSUE_STATUS_CODE', 'The status code returned from the GitHub API'],
+            ['GITHUB_GET_ISSUE_RESPONSE', 'The full response body from the GitHub API'],
+            ['GITHUB_GET_ISSUE_JSON', 'The parsed JSON returned from the GitHub API']
+          ]
+        end
+        
+        def return_value
+          "A hash including the HTTP status code (:status), the response body (:body), and the parsed JSON (:json)."
+        end
+        
+        def authors
+          ["crazymanish"]
+        end
+        
+        def example_code
+          [
+            'github_get_issue(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane",
+              issue_number: 123
+            )',
+            '# You can also access the response data
+            result = github_get_issue(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane",
+              issue_number: 123
+            )
+            UI.message("Issue title: #{result[:json]["title"]}")
+            UI.message("Issue state: #{result[:json]["state"]}")'
+          ]
+        end
+        
+        def category
+          :source_control
+        end
+        
+        def is_supported?(platform)
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/github_api/actions/github_get_issue_comment_action.rb

@@ -0,0 +1,174 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_GET_ISSUE_COMMENT_RESPONSE = :GITHUB_GET_ISSUE_COMMENT_RESPONSE
+      GITHUB_GET_ISSUE_COMMENT_JSON = :GITHUB_GET_ISSUE_COMMENT_JSON
+      GITHUB_GET_ISSUE_COMMENT_STATUS_CODE = :GITHUB_GET_ISSUE_COMMENT_STATUS_CODE
+    end
+
+    class GithubGetIssueCommentAction < Action
+      class << self
+        def run(params)
+          token = params[:api_token]
+          repo_owner = params[:repo_owner]
+          repo_name = params[:repo_name]
+          comment_id = params[:comment_id]
+          server_url = params[:server_url]
+          
+          # Validate parameters (additional validation beyond what's in ConfigItem)
+          UI.user_error!("No comment ID provided, pass using `comment_id: 12345678`") unless comment_id.to_s.length > 0
+          
+          # Prepare request parameters
+          path = "/repos/#{repo_owner}/#{repo_name}/issues/comments/#{comment_id}"
+          
+          # Make the request
+          UI.message("Fetching comment ID #{comment_id} from #{repo_owner}/#{repo_name}")
+          response = Helper::GithubApiHelper.github_api_request(
+            token: token,
+            path: path,
+            method: :get,
+            server_url: server_url
+          )
+          
+          status_code = response.key?('status') ? response['status'] : nil
+          result = {
+            status: status_code,
+            body: response,
+            json: response
+          }
+          
+          if response.key?('error')
+            UI.error("GitHub responded with an error: #{response['error']}")
+            UI.user_error!("GitHub API error: #{response['error']}")
+            return nil
+          end
+          
+          if response['message'] && status_code && status_code >= 400
+            UI.error("GitHub API error: #{response['message']}")
+            UI.user_error!("GitHub API error: #{response['message']} (Status code: #{status_code})")
+            return nil
+          end
+          
+          # Print comment user info
+          if response['user'] && response['user']['login']
+            user = response['user']['login']
+            UI.success("Successfully fetched comment ID #{comment_id} by #{user}")
+          else
+            UI.success("Successfully fetched comment ID #{comment_id}")
+          end
+          
+          # Set the shared values
+          Actions.lane_context[SharedValues::GITHUB_GET_ISSUE_COMMENT_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_GET_ISSUE_COMMENT_RESPONSE] = response
+          Actions.lane_context[SharedValues::GITHUB_GET_ISSUE_COMMENT_JSON] = response
+          
+          return result
+        end
+
+        #####################################################
+        # @!group Documentation
+        #####################################################
+
+        def description
+          "Gets a specific comment from a GitHub issue"
+        end
+
+        def details
+          [
+            "This action fetches a specific comment from a GitHub issue by its comment ID.",
+            "It requires a valid GitHub API token with appropriate permissions.",
+            "Documentation: [https://docs.github.com/en/rest/issues/comments](https://docs.github.com/en/rest/issues/comments#get-an-issue-comment)"
+          ].join("\n")
+        end
+
+        def available_options
+          [
+            FastlaneCore::ConfigItem.new(key: :api_token,
+                                    env_name: "GITHUB_API_TOKEN",
+                                 description: "GitHub API token with repo permissions",
+                                    optional: false,
+                                        type: String,
+                                   sensitive: true,
+                          code_gen_sensitive: true,
+                               default_value: ENV["GITHUB_API_TOKEN"],
+                               verify_block: proc do |value|
+                                  UI.user_error!("No GitHub API token given, pass using `api_token: 'token'`") if value.to_s.empty?
+                                end),
+            FastlaneCore::ConfigItem.new(key: :server_url,
+                                 env_name: "GITHUB_API_SERVER_URL",
+                              description: "GitHub API server URL",
+                                 optional: true,
+                            default_value: "https://api.github.com"),
+            FastlaneCore::ConfigItem.new(key: :repo_owner,
+                                 env_name: "GITHUB_API_REPO_OWNER",
+                              description: "Repository owner (organization or username)",
+                                    optional: false,
+                                        type: String,
+                               verify_block: proc do |value|
+                                  UI.user_error!("No repository owner provided, pass using `repo_owner: 'owner'`") if value.to_s.empty?
+                                end),
+            FastlaneCore::ConfigItem.new(key: :repo_name,
+                                 env_name: "GITHUB_API_REPO_NAME",
+                                 description: "Repository name",
+                                    optional: false,
+                                        type: String,
+                               verify_block: proc do |value|
+                                  UI.user_error!("No repository name provided, pass using `repo_name: 'name'`") if value.to_s.empty?
+                                end),
+            FastlaneCore::ConfigItem.new(key: :comment_id,
+                                 description: "The ID of the comment to fetch",
+                                    optional: false,
+                                        type: Integer)
+          ]
+        end
+
+        def output
+          [
+            ['GITHUB_GET_ISSUE_COMMENT_STATUS_CODE', 'The status code returned from the GitHub API'],
+            ['GITHUB_GET_ISSUE_COMMENT_RESPONSE', 'The full response from the GitHub API'],
+            ['GITHUB_GET_ISSUE_COMMENT_JSON', 'The JSON data returned from the GitHub API']
+          ]
+        end
+
+        def return_value
+          "A hash including the HTTP status code (:status), the response body (:body), and the parsed JSON (:json)."
+        end
+
+        def authors
+          ["crazymanish"]
+        end
+
+        def example_code
+          [
+            'github_get_issue_comment(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane",
+              comment_id: 12345678
+            )',
+            '# You can also access the response data
+            result = github_get_issue_comment(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane",
+              comment_id: 12345678
+            )
+            UI.message("Comment by: #{result[:json]["user"]["login"]}")
+            UI.message("Comment body: #{result[:json]["body"]}")'
+          ]
+        end
+
+        def category
+          :source_control
+        end
+
+        def is_supported?(platform)
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/github_api/actions/github_get_issue_event_action.rb

@@ -0,0 +1,169 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_GET_ISSUE_EVENT_RESPONSE = :GITHUB_GET_ISSUE_EVENT_RESPONSE
+      GITHUB_GET_ISSUE_EVENT_JSON = :GITHUB_GET_ISSUE_EVENT_JSON
+      GITHUB_GET_ISSUE_EVENT_STATUS_CODE = :GITHUB_GET_ISSUE_EVENT_STATUS_CODE
+    end
+
+    class GithubGetIssueEventAction < Action
+      class << self
+        def run(params)
+          token = params[:api_token]
+          repo_owner = params[:repo_owner]
+          repo_name = params[:repo_name]
+          event_id = params[:event_id]
+          server_url = params[:server_url]
+          
+          # Validate parameters (additional validation beyond what's in ConfigItem)
+          UI.user_error!("No event ID provided, pass using `event_id: 12345678`") unless event_id.to_s.length > 0
+          
+          # Prepare request parameters
+          path = "/repos/#{repo_owner}/#{repo_name}/issues/events/#{event_id}"
+          
+          # Make the request
+          UI.message("Fetching issue event ##{event_id} from #{repo_owner}/#{repo_name}")
+          response = Helper::GithubApiHelper.github_api_request(
+            token: token,
+            path: path,
+            method: :get,
+            server_url: server_url
+          )
+          
+          status_code = response.key?('status') ? response['status'] : nil
+          result = {
+            status: status_code,
+            body: response,
+            json: response
+          }
+          
+          if response.key?('error')
+            UI.error("GitHub responded with an error: #{response['error']}")
+            UI.user_error!("GitHub API error: #{response['error']}")
+            return nil
+          end
+          
+          if response['message'] && status_code && status_code >= 400
+            UI.error("GitHub API error: #{response['message']}")
+            UI.user_error!("GitHub API error: #{response['message']} (Status code: #{status_code})")
+            return nil
+          end
+          
+          # Print event details
+          event_type = response['event'] || 'unknown'
+          UI.success("Successfully fetched issue event ##{event_id} from #{repo_owner}/#{repo_name} (type: #{event_type})")
+          
+          # Set the shared values
+          Actions.lane_context[SharedValues::GITHUB_GET_ISSUE_EVENT_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_GET_ISSUE_EVENT_RESPONSE] = response
+          Actions.lane_context[SharedValues::GITHUB_GET_ISSUE_EVENT_JSON] = response
+          
+          return result
+        end
+
+        #####################################################
+        # @!group Documentation
+        #####################################################
+
+        def description
+          "Gets a specific GitHub issue event by ID"
+        end
+
+        def details
+          [
+            "This action fetches a specific issue event from a GitHub repository by its event ID.",
+            "It requires a valid GitHub API token with appropriate permissions.",
+            "Documentation: [https://docs.github.com/en/rest/issues/events](https://docs.github.com/en/rest/issues/events#get-an-issue-event)"
+          ].join("\n")
+        end
+
+        def available_options
+          [
+            FastlaneCore::ConfigItem.new(key: :api_token,
+                                    env_name: "GITHUB_API_TOKEN",
+                                 description: "GitHub API token with repo permissions",
+                                    optional: false,
+                                   sensitive: true,
+                          code_gen_sensitive: true,
+                               default_value: ENV["GITHUB_API_TOKEN"],
+                                        type: String,
+                               verify_block: proc do |value|
+                                  UI.user_error!("No GitHub API token given, pass using `api_token: 'token'`") if value.to_s.empty?
+                                end),
+            FastlaneCore::ConfigItem.new(key: :server_url,
+                                 env_name: "GITHUB_API_SERVER_URL",
+                              description: "GitHub API server URL",
+                                 optional: true,
+                            default_value: "https://api.github.com"),
+            FastlaneCore::ConfigItem.new(key: :repo_owner,
+                                 env_name: "GITHUB_API_REPO_OWNER",
+                              description: "Repository owner (organization or username)",
+                                    optional: false,
+                                        type: String,
+                               verify_block: proc do |value|
+                                  UI.user_error!("No repository owner provided, pass using `repo_owner: 'owner'`") if value.to_s.empty?
+                                end),
+            FastlaneCore::ConfigItem.new(key: :repo_name,
+                                 env_name: "GITHUB_API_REPO_NAME",
+                                 description: "Repository name",
+                                    optional: false,
+                                        type: String,
+                               verify_block: proc do |value|
+                                  UI.user_error!("No repository name provided, pass using `repo_name: 'name'`") if value.to_s.empty?
+                                end),
+            FastlaneCore::ConfigItem.new(key: :event_id,
+                                 description: "The issue event ID",
+                                    optional: false,
+                                        type: Integer)
+          ]
+        end
+
+        def output
+          [
+            ['GITHUB_GET_ISSUE_EVENT_STATUS_CODE', 'The status code returned from the GitHub API'],
+            ['GITHUB_GET_ISSUE_EVENT_RESPONSE', 'The full response from the GitHub API'],
+            ['GITHUB_GET_ISSUE_EVENT_JSON', 'The JSON data returned from the GitHub API']
+          ]
+        end
+
+        def return_value
+          "A hash including the HTTP status code (:status), the response body (:body), and the parsed JSON (:json)."
+        end
+
+        def authors
+          ["crazymanish"]
+        end
+
+        def example_code
+          [
+            'github_get_issue_event(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane",
+              event_id: 12345678
+            )',
+            '# You can also access the response data
+            result = github_get_issue_event(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane",
+              event_id: 12345678
+            )
+            UI.message("Event type: #{result[:json]["event"]}, actor: #{result[:json]["actor"]["login"]}")'
+          ]
+        end
+
+        def category
+          :source_control
+        end
+
+        def is_supported?(platform)
+          true
+        end
+      end
+    end
+  end
+end