fastlane-plugin-github_api 0.1.0

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

@@ -0,0 +1,180 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_LOCK_ISSUE_STATUS_CODE = :GITHUB_LOCK_ISSUE_STATUS_CODE
+      GITHUB_LOCK_ISSUE_RESPONSE = :GITHUB_LOCK_ISSUE_RESPONSE
+      GITHUB_LOCK_ISSUE_JSON = :GITHUB_LOCK_ISSUE_JSON
+    end
+
+    class GithubLockIssueAction < 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]
+          lock_reason = params[:lock_reason]
+          
+          # 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}/lock"
+          
+          # Build body parameters
+          body_params = {}
+          body_params[:lock_reason] = lock_reason if lock_reason
+          
+          UI.message("Locking issue ##{issue_number} in #{repo_owner}/#{repo_name}")
+          response = Helper::GithubApiHelper.github_api_request(
+            token: api_token,
+            path: path,
+            params: body_params,
+            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) || status_code == 204
+            reason_text = lock_reason ? " with reason '#{lock_reason}'" : ""
+            UI.success("Successfully locked issue ##{issue_number}#{reason_text}")
+          else
+            UI.error("Error locking 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_LOCK_ISSUE_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_LOCK_ISSUE_RESPONSE] = response[:body]
+          Actions.lane_context[SharedValues::GITHUB_LOCK_ISSUE_JSON] = json_response
+          
+          return result
+        end
+        
+        #####################################################
+        # @!group Documentation
+        #####################################################
+        
+        def description
+          "Locks a GitHub issue"
+        end
+        
+        def details
+          [
+            "Locks an issue in a GitHub repository, preventing further comments.",
+            "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#lock-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 to lock",
+                                 optional: false,
+                                     type: Integer),
+            FastlaneCore::ConfigItem.new(key: :lock_reason,
+                              description: "The reason for locking the issue (off-topic, too heated, resolved, spam)",
+                                 optional: true,
+                                     type: String,
+                              verify_block: proc do |value|
+                                allowed_reasons = ['off-topic', 'too heated', 'resolved', 'spam']
+                                UI.user_error!("Lock reason must be one of: #{allowed_reasons.join(', ')}") unless allowed_reasons.include?(value) || value.nil?
+                              end)
+          ]
+        end
+        
+        def output
+          [
+            ['GITHUB_LOCK_ISSUE_STATUS_CODE', 'The status code returned from the GitHub API'],
+            ['GITHUB_LOCK_ISSUE_RESPONSE', 'The full response body from the GitHub API'],
+            ['GITHUB_LOCK_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_lock_issue(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane",
+              issue_number: 123
+            )',
+            '# Lock with a reason
+            github_lock_issue(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane",
+              issue_number: 123,
+              lock_reason: "resolved"
+            )'
+          ]
+        end
+        
+        def category
+          :source_control
+        end
+        
+        def is_supported?(platform)
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,191 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_MERGE_PULL_STATUS_CODE = :GITHUB_MERGE_PULL_STATUS_CODE
+      GITHUB_MERGE_PULL_RESPONSE = :GITHUB_MERGE_PULL_RESPONSE
+      GITHUB_MERGE_PULL_JSON = :GITHUB_MERGE_PULL_JSON
+    end
+
+    class GithubMergePullAction < 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]
+          commit_title = params[:commit_title]
+          commit_message = params[:commit_message]
+          merge_method = params[:merge_method]
+          sha = params[:sha]
+          
+          # Build the body for the request
+          body = {}
+          body[:commit_title] = commit_title if commit_title
+          body[:commit_message] = commit_message if commit_message
+          body[:merge_method] = merge_method if merge_method
+          body[:sha] = sha if sha
+          
+          # Build the path
+          path = "/repos/#{repo_owner}/#{repo_name}/pulls/#{pull_number}/merge"
+          
+          UI.message("Merging 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 merged pull request ##{pull_number}")
+          else
+            UI.error("Error merging pull request: #{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_MERGE_PULL_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_MERGE_PULL_RESPONSE] = response[:body]
+          Actions.lane_context[SharedValues::GITHUB_MERGE_PULL_JSON] = json_response
+          
+          return result
+        end
+        
+        #####################################################
+        # @!group Documentation
+        #####################################################
+        
+        def description
+          "Merge a pull request"
+        end
+        
+        def details
+          [
+            "Merges a pull request into the base branch.",
+            "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/pulls#merge-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: :commit_title,
+                                 env_name: "GITHUB_API_COMMIT_TITLE",
+                              description: "Title for the automatic commit message",
+                                 optional: true,
+                                     type: String),
+            FastlaneCore::ConfigItem.new(key: :commit_message,
+                                 env_name: "GITHUB_API_COMMIT_MESSAGE",
+                              description: "Extra detail to append to automatic commit message",
+                                 optional: true,
+                                     type: String),
+            FastlaneCore::ConfigItem.new(key: :merge_method,
+                                 env_name: "GITHUB_API_MERGE_METHOD",
+                              description: "Merge method to use: merge, squash, or rebase",
+                                 optional: true,
+                                     type: String,
+                            default_value: "merge",
+                             verify_block: proc do |value|
+                               UI.user_error!("Merge method must be one of: merge, squash, rebase") unless ['merge', 'squash', 'rebase'].include?(value)
+                             end),
+            FastlaneCore::ConfigItem.new(key: :sha,
+                                 env_name: "GITHUB_API_SHA",
+                              description: "SHA that pull request head must match to allow merge",
+                                 optional: true,
+                                     type: String)
+          ]
+        end
+
+        def output
+          [
+            ['GITHUB_MERGE_PULL_STATUS_CODE', 'The status code returned by the GitHub API'],
+            ['GITHUB_MERGE_PULL_RESPONSE', 'The full response body returned by the GitHub API'],
+            ['GITHUB_MERGE_PULL_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_merge_pull(
+              repo_owner: "octocat",
+              repo_name: "Hello-World",
+              pull_number: 42
+            )',
+            'merged_pull = github_merge_pull(
+              repo_owner: "octocat",
+              repo_name: "Hello-World",
+              pull_number: 42,
+              commit_title: "Merge pull request #42 from octocat/feature-branch",
+              commit_message: "This adds the new feature",
+              merge_method: "squash",
+              sha: "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+            )
+            
+            message = merged_pull[:json]["message"]
+            sha = merged_pull[:json]["sha"]
+            puts "Merge commit message: #{message}"
+            puts "Merge commit SHA: #{sha}"'
+          ]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,160 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_REMOVE_ALL_LABELS_RESPONSE = :GITHUB_REMOVE_ALL_LABELS_RESPONSE
+      GITHUB_REMOVE_ALL_LABELS_JSON = :GITHUB_REMOVE_ALL_LABELS_JSON
+      GITHUB_REMOVE_ALL_LABELS_STATUS_CODE = :GITHUB_REMOVE_ALL_LABELS_STATUS_CODE
+    end
+
+    class GithubRemoveAllLabelsAction < 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]
+          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
+          
+          # Prepare request parameters
+          path = "/repos/#{repo_owner}/#{repo_name}/issues/#{issue_number}/labels"
+          
+          # Make the request
+          UI.message("Removing all labels from issue ##{issue_number} in #{repo_owner}/#{repo_name}")
+          response = Helper::GithubApiHelper.github_api_request(
+            token: token,
+            path: path,
+            method: :delete,
+            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.is_a?(Hash) && 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
+          
+          UI.success("Successfully removed all labels from issue ##{issue_number}")
+          
+          # Set the shared values
+          Actions.lane_context[SharedValues::GITHUB_REMOVE_ALL_LABELS_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_REMOVE_ALL_LABELS_RESPONSE] = response
+          Actions.lane_context[SharedValues::GITHUB_REMOVE_ALL_LABELS_JSON] = response
+          
+          return result
+        end
+
+        #####################################################
+        # @!group Documentation
+        #####################################################
+
+        def description
+          "Removes all labels from a GitHub issue"
+        end
+
+        def details
+          [
+            "This action removes all labels from a specific issue in a GitHub repository.",
+            "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#remove-all-labels-from-an-issue)"
+          ].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 remove labels from",
+                                    optional: false,
+                                        type: Integer)
+          ]
+        end
+
+        def output
+          [
+            ['GITHUB_REMOVE_ALL_LABELS_STATUS_CODE', 'The status code returned from the GitHub API'],
+            ['GITHUB_REMOVE_ALL_LABELS_RESPONSE', 'The full response from the GitHub API'],
+            ['GITHUB_REMOVE_ALL_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_remove_all_labels(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane",
+              issue_number: 123
+            )'
+          ]
+        end
+
+        def category
+          :source_control
+        end
+
+        def is_supported?(platform)
+          true
+        end
+      end
+    end
+  end
+end