fastlane-plugin-github_api 0.1.0

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

@@ -0,0 +1,187 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_SUBMIT_PULL_REVIEW_STATUS_CODE = :GITHUB_SUBMIT_PULL_REVIEW_STATUS_CODE
+      GITHUB_SUBMIT_PULL_REVIEW_RESPONSE = :GITHUB_SUBMIT_PULL_REVIEW_RESPONSE
+      GITHUB_SUBMIT_PULL_REVIEW_JSON = :GITHUB_SUBMIT_PULL_REVIEW_JSON
+    end
+
+    class GithubSubmitPullReviewAction < 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]
+          event = params[:event]
+          body = params[:body]
+          comments = params[:comments]
+          
+          # Build the body for the request
+          request_body = {}
+          request_body[:event] = event if event
+          request_body[:body] = body if body
+          request_body[:comments] = comments if comments && !comments.empty?
+          
+          # Build the path
+          path = "/repos/#{repo_owner}/#{repo_name}/pulls/#{pull_number}/reviews"
+          
+          UI.message("Submitting a review for pull request ##{pull_number} in #{repo_owner}/#{repo_name}")
+          
+          response = Helper::GithubApiHelper.github_api_request(
+            token: api_token,
+            path: 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 submitted a #{event} review for pull request ##{pull_number}")
+          else
+            UI.error("Error submitting 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_SUBMIT_PULL_REVIEW_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_SUBMIT_PULL_REVIEW_RESPONSE] = response[:body]
+          Actions.lane_context[SharedValues::GITHUB_SUBMIT_PULL_REVIEW_JSON] = json_response
+          
+          return result
+        end
+        
+        #####################################################
+        # @!group Documentation
+        #####################################################
+        
+        def description
+          "Create a review for a pull request"
+        end
+        
+        def details
+          [
+            "Creates a new 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#create-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: :event,
+                                 env_name: "GITHUB_API_REVIEW_EVENT",
+                              description: "The review action (APPROVE, REQUEST_CHANGES, COMMENT)",
+                                 optional: true,
+                                     type: String,
+                            default_value: "COMMENT",
+                             verify_block: proc do |value|
+                               UI.user_error!("Event must be one of: APPROVE, REQUEST_CHANGES, COMMENT") unless ['APPROVE', 'REQUEST_CHANGES', 'COMMENT'].include?(value)
+                             end),
+            FastlaneCore::ConfigItem.new(key: :body,
+                                 env_name: "GITHUB_API_REVIEW_BODY",
+                              description: "The body text of the review",
+                                 optional: true,
+                                     type: String),
+            FastlaneCore::ConfigItem.new(key: :comments,
+                                 env_name: "GITHUB_API_REVIEW_COMMENTS",
+                              description: "Comments to add to the review (array of hashes with path, position, body)",
+                                 optional: true,
+                                     type: Array)
+          ]
+        end
+
+        def output
+          [
+            ['GITHUB_SUBMIT_PULL_REVIEW_STATUS_CODE', 'The status code returned by the GitHub API'],
+            ['GITHUB_SUBMIT_PULL_REVIEW_RESPONSE', 'The full response body returned by the GitHub API'],
+            ['GITHUB_SUBMIT_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_submit_pull_review(
+              repo_owner: "octocat",
+              repo_name: "Hello-World",
+              pull_number: 42,
+              event: "APPROVE",
+              body: "Looks good! 👍"
+            )',
+            'github_submit_pull_review(
+              repo_owner: "octocat",
+              repo_name: "Hello-World",
+              pull_number: 42,
+              event: "REQUEST_CHANGES",
+              body: "Please fix these issues before merging.",
+              comments: [
+                {
+                  path: "file.rb",
+                  position: 10,
+                  body: "Consider refactoring this section."
+                }
+              ]
+            )'
+          ]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,157 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_UNLOCK_ISSUE_STATUS_CODE = :GITHUB_UNLOCK_ISSUE_STATUS_CODE
+      GITHUB_UNLOCK_ISSUE_RESPONSE = :GITHUB_UNLOCK_ISSUE_RESPONSE
+      GITHUB_UNLOCK_ISSUE_JSON = :GITHUB_UNLOCK_ISSUE_JSON
+    end
+
+    class GithubUnlockIssueAction < 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}/lock"
+          
+          UI.message("Unlocking issue ##{issue_number} in #{repo_owner}/#{repo_name}")
+          response = Helper::GithubApiHelper.github_api_request(
+            token: api_token,
+            path: path,
+            method: :delete,
+            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
+            UI.success("Successfully unlocked issue ##{issue_number}")
+          else
+            UI.error("Error unlocking 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_UNLOCK_ISSUE_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_UNLOCK_ISSUE_RESPONSE] = response[:body]
+          Actions.lane_context[SharedValues::GITHUB_UNLOCK_ISSUE_JSON] = json_response
+          
+          return result
+        end
+        
+        #####################################################
+        # @!group Documentation
+        #####################################################
+        
+        def description
+          "Unlocks a GitHub issue"
+        end
+        
+        def details
+          [
+            "Unlocks an issue in a GitHub repository, allowing comments to be added.",
+            "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#unlock-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 unlock",
+                                 optional: false,
+                                     type: Integer)
+          ]
+        end
+        
+        def output
+          [
+            ['GITHUB_UNLOCK_ISSUE_STATUS_CODE', 'The status code returned from the GitHub API'],
+            ['GITHUB_UNLOCK_ISSUE_RESPONSE', 'The full response body from the GitHub API'],
+            ['GITHUB_UNLOCK_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_unlock_issue(
+              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

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

@@ -0,0 +1,202 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_UPDATE_ISSUE_STATUS_CODE = :GITHUB_UPDATE_ISSUE_STATUS_CODE
+      GITHUB_UPDATE_ISSUE_RESPONSE = :GITHUB_UPDATE_ISSUE_RESPONSE
+      GITHUB_UPDATE_ISSUE_JSON = :GITHUB_UPDATE_ISSUE_JSON
+    end
+
+    class GithubUpdateIssueAction < 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}"
+          
+          # Build body parameters
+          body_params = {}
+          body_params[:title] = params[:title] if params[:title]
+          body_params[:body] = params[:body] if params[:body]
+          body_params[:state] = params[:state] if params[:state]
+          body_params[:assignees] = params[:assignees] if params[:assignees]
+          body_params[:milestone] = params[:milestone] if params[:milestone]
+          body_params[:labels] = params[:labels] if params[:labels]
+          
+          UI.message("Updating issue ##{issue_number} in #{repo_owner}/#{repo_name}")
+          response = Helper::GithubApiHelper.github_api_request(
+            token: api_token,
+            path: path,
+            params: body_params,
+            method: :patch,
+            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 updated issue ##{issue_number} in #{repo_owner}/#{repo_name}")
+          else
+            UI.error("Error updating 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_UPDATE_ISSUE_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_UPDATE_ISSUE_RESPONSE] = response[:body]
+          Actions.lane_context[SharedValues::GITHUB_UPDATE_ISSUE_JSON] = json_response
+          
+          return result
+        end
+        
+        #####################################################
+        # @!group Documentation
+        #####################################################
+        
+        def description
+          "Updates an existing GitHub issue"
+        end
+        
+        def details
+          [
+            "Updates an existing issue in a GitHub repository with the specified parameters.",
+            "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#update-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),
+            FastlaneCore::ConfigItem.new(key: :repo_name,
+                                 env_name: "GITHUB_API_REPO_NAME",
+                              description: "Repository name",
+                                 optional: false,
+                                     type: String),
+            FastlaneCore::ConfigItem.new(key: :issue_number,
+                                 env_name: "GITHUB_API_ISSUE_NUMBER",
+                              description: "The issue number to update",
+                                 optional: false,
+                                     type: Integer),
+            FastlaneCore::ConfigItem.new(key: :title,
+                              description: "The title of the issue",
+                                 optional: true,
+                                     type: String),
+            FastlaneCore::ConfigItem.new(key: :body,
+                              description: "The body content of the issue",
+                                 optional: true,
+                                     type: String),
+            FastlaneCore::ConfigItem.new(key: :state,
+                              description: "State of the issue (open or closed)",
+                                 optional: true,
+                                     type: String,
+                              verify_block: proc do |value|
+                                UI.user_error!("State must be 'open' or 'closed'") unless ['open', 'closed'].include?(value)
+                              end),
+            FastlaneCore::ConfigItem.new(key: :assignees,
+                              description: "Array of logins for users to assign to the issue",
+                                 optional: true,
+                                     type: Array),
+            FastlaneCore::ConfigItem.new(key: :milestone,
+                              description: "The milestone number to associate with this issue",
+                                 optional: true,
+                                     type: Integer),
+            FastlaneCore::ConfigItem.new(key: :labels,
+                              description: "Array of labels to associate with this issue",
+                                 optional: true,
+                                     type: Array)
+          ]
+        end
+        
+        def output
+          [
+            ['GITHUB_UPDATE_ISSUE_STATUS_CODE', 'The status code returned from the GitHub API'],
+            ['GITHUB_UPDATE_ISSUE_RESPONSE', 'The full response body from the GitHub API'],
+            ['GITHUB_UPDATE_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_update_issue(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane",
+              issue_number: 123,
+              title: "Updated Title",
+              body: "Updated description",
+              state: "closed",
+              assignees: ["username1", "username2"],
+              labels: ["bug", "enhancement"]
+            )',
+            '# You can also access the response data
+            result = github_update_issue(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane",
+              issue_number: 123,
+              state: "closed"
+            )
+            UI.message("Updated issue title: #{result[:json]["title"]}")'
+          ]
+        end
+        
+        def category
+          :source_control
+        end
+        
+        def is_supported?(platform)
+          true
+        end
+      end
+    end
+  end
+end