fastlane-plugin-github_api 0.1.0

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

@@ -0,0 +1,169 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_REQUEST_PULL_REVIEW_STATUS_CODE = :GITHUB_REQUEST_PULL_REVIEW_STATUS_CODE
+      GITHUB_REQUEST_PULL_REVIEW_RESPONSE = :GITHUB_REQUEST_PULL_REVIEW_RESPONSE
+      GITHUB_REQUEST_PULL_REVIEW_JSON = :GITHUB_REQUEST_PULL_REVIEW_JSON
+    end
+
+    class GithubRequestPullReviewAction < 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]
+          reviewers = params[:reviewers]
+          team_reviewers = params[:team_reviewers]
+          
+          # Build the body for the request
+          body = {}
+          body[:reviewers] = reviewers if reviewers && !reviewers.empty?
+          body[:team_reviewers] = team_reviewers if team_reviewers && !team_reviewers.empty?
+          
+          # Build the path
+          path = "/repos/#{repo_owner}/#{repo_name}/pulls/#{pull_number}/requested_reviewers"
+          
+          UI.message("Requesting reviewers for pull request ##{pull_number} from #{repo_owner}/#{repo_name}")
+          response = Helper::GithubApiHelper.github_api_request(
+            token: api_token,
+            path: path,
+            params: body,
+            method: :post,
+            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)
+            reviewer_count = reviewers ? reviewers.count : 0
+            team_count = team_reviewers ? team_reviewers.count : 0
+            UI.success("Successfully requested #{reviewer_count} reviewers and #{team_count} team reviewers for pull request ##{pull_number}")
+          else
+            UI.error("Error requesting reviewers: #{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_REQUEST_PULL_REVIEW_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_REQUEST_PULL_REVIEW_RESPONSE] = response[:body]
+          Actions.lane_context[SharedValues::GITHUB_REQUEST_PULL_REVIEW_JSON] = json_response
+          
+          return result
+        end
+        
+        #####################################################
+        # @!group Documentation
+        #####################################################
+        
+        def description
+          "Requests reviewers for a pull request"
+        end
+        
+        def details
+          [
+            "Requests reviewers 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/review-requests#request-reviewers-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: :reviewers,
+                                 env_name: "GITHUB_API_PULL_REVIEWERS",
+                              description: "An array of user logins that will be requested to review",
+                                 optional: true,
+                                     type: Array),
+            FastlaneCore::ConfigItem.new(key: :team_reviewers,
+                                 env_name: "GITHUB_API_PULL_TEAM_REVIEWERS",
+                              description: "An array of team slugs that will be requested to review",
+                                 optional: true,
+                                     type: Array)
+          ]
+        end
+
+        def output
+          [
+            ['GITHUB_REQUEST_PULL_REVIEW_STATUS_CODE', 'The status code returned by the GitHub API'],
+            ['GITHUB_REQUEST_PULL_REVIEW_RESPONSE', 'The full response body returned by the GitHub API'],
+            ['GITHUB_REQUEST_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_request_pull_review(
+              repo_owner: "octocat",
+              repo_name: "Hello-World",
+              pull_number: 42,
+              reviewers: ["username1", "username2"]
+            )',
+            'github_request_pull_review(
+              repo_owner: "octocat",
+              repo_name: "Hello-World",
+              pull_number: 42,
+              reviewers: ["username1"],
+              team_reviewers: ["engineering-team"]
+            )'
+          ]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,191 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_SET_LABELS_RESPONSE = :GITHUB_SET_LABELS_RESPONSE
+      GITHUB_SET_LABELS_JSON = :GITHUB_SET_LABELS_JSON
+      GITHUB_SET_LABELS_STATUS_CODE = :GITHUB_SET_LABELS_STATUS_CODE
+    end
+
+    class GithubSetLabelsAction < Action
+      class << self
+        def run(params)
+          token = params[:api_token]
+          repo_owner = params[:repo_owner]
+          repo_name = params[:repo_name]
+          issue_number = params[:issue_number]
+          labels = params[:labels]
+          server_url = params[:server_url]
+          
+          # Validate parameters (additional validation beyond what's in ConfigItem)
+          UI.user_error!("No GitHub issue number given, pass using `issue_number: 123`") unless issue_number.to_s.length > 0
+          UI.user_error!("No labels provided, pass using `labels: ['bug', 'feature']`") if labels.nil? || labels.empty?
+          
+          # Prepare request parameters
+          path = "/repos/#{repo_owner}/#{repo_name}/issues/#{issue_number}/labels"
+          
+          # Build body parameters
+          body_params = {
+            labels: labels
+          }
+          
+          # Make the request
+          UI.message("Setting labels on issue ##{issue_number} in #{repo_owner}/#{repo_name}")
+          response = Helper::GithubApiHelper.github_api_request(
+            token: token,
+            path: path,
+            params: body_params,
+            method: :put,
+            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 labels for confirmation
+          if response.is_a?(Array) && !response.empty?
+            label_names = response.map { |label| label['name'] }.join(', ')
+            UI.success("Successfully set labels on issue ##{issue_number}: #{label_names}")
+          else
+            UI.success("Successfully updated labels on issue ##{issue_number}")
+          end
+          
+          # Set the shared values
+          Actions.lane_context[SharedValues::GITHUB_SET_LABELS_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_SET_LABELS_RESPONSE] = response
+          Actions.lane_context[SharedValues::GITHUB_SET_LABELS_JSON] = response
+          
+          return result
+        end
+
+        #####################################################
+        # @!group Documentation
+        #####################################################
+
+        def description
+          "Replaces all labels on a GitHub issue"
+        end
+
+        def details
+          [
+            "This action replaces all existing labels on an issue with the specified list of labels.",
+            "It requires a valid GitHub API token with appropriate permissions.",
+            "Documentation: [https://docs.github.com/en/rest/issues/labels](https://docs.github.com/en/rest/issues/labels)"
+          ].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: :issue_number,
+                                 env_name: "GITHUB_API_ISSUE_NUMBER",
+                                 description: "The issue number to set labels on",
+                                    optional: false,
+                                        type: Integer),
+            FastlaneCore::ConfigItem.new(key: :labels,
+                                 description: "Array of label names to set on the issue",
+                                    optional: false,
+                                        type: Array,
+                               verify_block: proc do |value|
+                                  UI.user_error!("No labels provided, pass using `labels: ['bug']`") if value.nil? || value.empty?
+                                end)
+          ]
+        end
+
+        def output
+          [
+            ['GITHUB_SET_LABELS_STATUS_CODE', 'The status code returned from the GitHub API'],
+            ['GITHUB_SET_LABELS_RESPONSE', 'The full response from the GitHub API'],
+            ['GITHUB_SET_LABELS_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_set_labels(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane",
+              issue_number: 123,
+              labels: ["feature", "reviewed"]
+            )',
+            '# You can also access the response data
+            result = github_set_labels(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane",
+              issue_number: 123,
+              labels: ["bug", "critical"]
+            )
+            UI.message("Labels set: #{result[:json].map { |label| label["name"] }.join(", ")}")'
+          ]
+        end
+
+        def category
+          :source_control
+        end
+
+        def is_supported?(platform)
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,185 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_SUBMIT_PULL_COMMENT_STATUS_CODE = :GITHUB_SUBMIT_PULL_COMMENT_STATUS_CODE
+      GITHUB_SUBMIT_PULL_COMMENT_RESPONSE = :GITHUB_SUBMIT_PULL_COMMENT_RESPONSE
+      GITHUB_SUBMIT_PULL_COMMENT_JSON = :GITHUB_SUBMIT_PULL_COMMENT_JSON
+    end
+
+    class GithubSubmitPullCommentAction < 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]
+          body = params[:body]
+          commit_id = params[:commit_id]
+          path = params[:path]
+          position = params[:position]
+          
+          # Build the body for the request
+          request_body = {
+            body: body
+          }
+          
+          request_body[:commit_id] = commit_id if commit_id
+          request_body[:path] = path if path
+          request_body[:position] = position if position
+          
+          # Build the path
+          api_path = "/repos/#{repo_owner}/#{repo_name}/pulls/#{pull_number}/comments"
+          
+          UI.message("Creating a comment on pull request ##{pull_number} in #{repo_owner}/#{repo_name}")
+          response = Helper::GithubApiHelper.github_api_request(
+            token: api_token,
+            path: api_path,
+            params: request_body,
+            method: :post,
+            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 created a comment on pull request ##{pull_number}")
+          else
+            UI.error("Error creating comment: #{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_SUBMIT_PULL_COMMENT_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_SUBMIT_PULL_COMMENT_RESPONSE] = response[:body]
+          Actions.lane_context[SharedValues::GITHUB_SUBMIT_PULL_COMMENT_JSON] = json_response
+          
+          return result
+        end
+        
+        #####################################################
+        # @!group Documentation
+        #####################################################
+        
+        def description
+          "Create a review comment on a pull request"
+        end
+        
+        def details
+          [
+            "Creates a review comment on 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/comments#create-a-review-comment-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 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: :body,
+                                 env_name: "GITHUB_API_COMMENT_BODY",
+                              description: "The body text of the comment",
+                                 optional: false,
+                                     type: String),
+            FastlaneCore::ConfigItem.new(key: :commit_id,
+                                 env_name: "GITHUB_API_COMMIT_ID",
+                              description: "The SHA of the commit to comment on",
+                                 optional: true,
+                                     type: String),
+            FastlaneCore::ConfigItem.new(key: :path,
+                                 env_name: "GITHUB_API_FILE_PATH",
+                              description: "The relative path to the file to comment on",
+                                 optional: true,
+                                     type: String),
+            FastlaneCore::ConfigItem.new(key: :position,
+                                 env_name: "GITHUB_API_FILE_POSITION",
+                              description: "The position in the diff to comment on",
+                                 optional: true,
+                                     type: Integer)
+          ]
+        end
+
+        def output
+          [
+            ['GITHUB_SUBMIT_PULL_COMMENT_STATUS_CODE', 'The status code returned by the GitHub API'],
+            ['GITHUB_SUBMIT_PULL_COMMENT_RESPONSE', 'The full response body returned by the GitHub API'],
+            ['GITHUB_SUBMIT_PULL_COMMENT_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_submit_pull_comment(
+              repo_owner: "octocat",
+              repo_name: "Hello-World",
+              pull_number: 42,
+              body: "This is a great improvement!"
+            )',
+            'github_submit_pull_comment(
+              repo_owner: "octocat",
+              repo_name: "Hello-World",
+              pull_number: 42,
+              body: "This could be improved",
+              commit_id: "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+              path: "file.rb",
+              position: 10
+            )'
+          ]
+        end
+      end
+    end
+  end
+end