fastlane-plugin-github_api 0.1.0

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

@@ -0,0 +1,202 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_CREATE_PULL_STATUS_CODE = :GITHUB_CREATE_PULL_STATUS_CODE
+      GITHUB_CREATE_PULL_RESPONSE = :GITHUB_CREATE_PULL_RESPONSE
+      GITHUB_CREATE_PULL_JSON = :GITHUB_CREATE_PULL_JSON
+    end
+
+    class GithubCreatePullAction < 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]
+          
+          # Validate parameters
+          UI.user_error!("No title provided for pull request, pass using `title: 'PR Title'`") if params[:title].to_s.empty?
+          UI.user_error!("Head branch is required for pull request") if params[:head].to_s.empty?
+          UI.user_error!("Base branch is required for pull request") if params[:base].to_s.empty?
+          
+          # Build the path
+          path = "/repos/#{repo_owner}/#{repo_name}/pulls"
+          
+          # Build body parameters
+          body_params = {
+            title: params[:title],
+            head: params[:head],
+            base: params[:base]
+          }
+          
+          # Add optional parameters if provided
+          body_params[:body] = params[:body] if params[:body]
+          body_params[:maintainer_can_modify] = params[:maintainer_can_modify] unless params[:maintainer_can_modify].nil?
+          body_params[:draft] = params[:draft] unless params[:draft].nil?
+          body_params[:issue] = params[:issue] if params[:issue]
+          
+          UI.message("Creating pull request in #{repo_owner}/#{repo_name}: #{params[:title]}")
+          response = Helper::GithubApiHelper.github_api_request(
+            token: api_token,
+            path: path,
+            params: body_params,
+            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)
+            pr_number = json_response['number']
+            UI.success("Successfully created pull request ##{pr_number} in #{repo_owner}/#{repo_name}")
+          else
+            UI.error("Error creating 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_CREATE_PULL_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_CREATE_PULL_RESPONSE] = response[:body]
+          Actions.lane_context[SharedValues::GITHUB_CREATE_PULL_JSON] = json_response
+          
+          return result
+        end
+        
+        #####################################################
+        # @!group Documentation
+        #####################################################
+        
+        def description
+          "Creates a new pull request in a GitHub repository"
+        end
+        
+        def details
+          [
+            "Creates a new pull request in a GitHub repository with the specified title, head branch, base branch, and other optional 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/pulls/pulls#create-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: :title,
+                                 env_name: "GITHUB_API_PR_TITLE",
+                              description: "The title of the pull request",
+                                 optional: false,
+                                     type: String),
+            FastlaneCore::ConfigItem.new(key: :head,
+                                 env_name: "GITHUB_API_PR_HEAD",
+                              description: "The name of the branch where your changes are implemented (or user:branch for cross-repo PRs)",
+                                 optional: false,
+                                     type: String),
+            FastlaneCore::ConfigItem.new(key: :base,
+                                 env_name: "GITHUB_API_PR_BASE",
+                              description: "The name of the branch you want the changes pulled into",
+                                 optional: false,
+                                     type: String),
+            FastlaneCore::ConfigItem.new(key: :body,
+                                 env_name: "GITHUB_API_PR_BODY",
+                              description: "The body text content of the pull request",
+                                 optional: true,
+                                     type: String),
+            FastlaneCore::ConfigItem.new(key: :maintainer_can_modify,
+                                 env_name: "GITHUB_API_PR_MAINTAINER_CAN_MODIFY",
+                              description: "Whether maintainers can modify the pull request",
+                                 optional: true,
+                                     type: Boolean),
+            FastlaneCore::ConfigItem.new(key: :draft,
+                                 env_name: "GITHUB_API_PR_DRAFT",
+                              description: "Whether the pull request is a draft",
+                                 optional: true,
+                                     type: Boolean),
+            FastlaneCore::ConfigItem.new(key: :issue,
+                                 env_name: "GITHUB_API_PR_ISSUE",
+                              description: "The issue number to convert to a pull request",
+                                 optional: true,
+                                     type: Integer)
+          ]
+        end
+
+        def output
+          [
+            ['GITHUB_CREATE_PULL_STATUS_CODE', 'The status code returned by the GitHub API'],
+            ['GITHUB_CREATE_PULL_RESPONSE', 'The full response body returned by the GitHub API'],
+            ['GITHUB_CREATE_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_create_pull(
+              repo_owner: "octocat",
+              repo_name: "Hello-World",
+              title: "Amazing new feature",
+              head: "feature-branch",
+              base: "main",
+              body: "Please pull these awesome changes"
+            )',
+            'github_create_pull(
+              repo_owner: "octocat",
+              repo_name: "Hello-World",
+              title: "Bug fix for issue #42",
+              head: "fix-branch",
+              base: "main",
+              body: "This PR fixes issue #42",
+              draft: true
+            )'
+          ]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,229 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_CREATE_PULL_COMMENT_STATUS_CODE = :GITHUB_CREATE_PULL_COMMENT_STATUS_CODE
+      GITHUB_CREATE_PULL_COMMENT_RESPONSE = :GITHUB_CREATE_PULL_COMMENT_RESPONSE
+      GITHUB_CREATE_PULL_COMMENT_JSON = :GITHUB_CREATE_PULL_COMMENT_JSON
+    end
+
+    class GithubCreatePullCommentAction < 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]
+          
+          # Validate required parameters
+          UI.user_error!("Comment body is required") if params[:body].to_s.empty?
+          
+          # Build the path
+          path = "/repos/#{repo_owner}/#{repo_name}/pulls/#{pull_number}/comments"
+          
+          # Build body parameters
+          body_params = {
+            body: params[:body]
+          }
+          
+          # Add required parameters for different comment types
+          if params[:commit_id] && params[:path] && !params[:in_reply_to]
+            body_params[:commit_id] = params[:commit_id]
+            body_params[:path] = params[:path]
+            body_params[:position] = params[:position] if params[:position]
+            body_params[:line] = params[:line] if params[:line]
+            body_params[:side] = params[:side] if params[:side]
+            body_params[:start_line] = params[:start_line] if params[:start_line]
+            body_params[:start_side] = params[:start_side] if params[:start_side]
+          elsif params[:in_reply_to]
+            body_params[:in_reply_to] = params[:in_reply_to]
+          else
+            UI.user_error!("Either provide commit_id and path OR in_reply_to parameter")
+          end
+          
+          UI.message("Creating comment on pull request ##{pull_number} in #{repo_owner}/#{repo_name}")
+          response = Helper::GithubApiHelper.github_api_request(
+            token: api_token,
+            path: path,
+            params: body_params,
+            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)
+            comment_id = json_response['id']
+            UI.success("Successfully created comment #{comment_id} on pull request ##{pull_number}")
+          else
+            UI.error("Error creating pull request 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_CREATE_PULL_COMMENT_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_CREATE_PULL_COMMENT_RESPONSE] = response[:body]
+          Actions.lane_context[SharedValues::GITHUB_CREATE_PULL_COMMENT_JSON] = json_response
+          
+          return result
+        end
+        
+        #####################################################
+        # @!group Documentation
+        #####################################################
+        
+        def description
+          "Creates a review comment on a pull request"
+        end
+        
+        def details
+          [
+            "Creates a review comment on a pull request. Can create a comment on a specific line/position or in reply to another comment.",
+            "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 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: :body,
+                                 env_name: "GITHUB_API_PR_COMMENT_BODY",
+                              description: "The text of the review comment",
+                                 optional: false,
+                                     type: String),
+            FastlaneCore::ConfigItem.new(key: :commit_id,
+                                 env_name: "GITHUB_API_PR_COMMENT_COMMIT_ID",
+                              description: "The SHA of the commit to comment on (required when not replying to a comment)",
+                                 optional: true,
+                                     type: String),
+            FastlaneCore::ConfigItem.new(key: :path,
+                                 env_name: "GITHUB_API_PR_COMMENT_PATH",
+                              description: "The relative path to the file being commented on (required when not replying to a comment)",
+                                 optional: true,
+                                     type: String),
+            FastlaneCore::ConfigItem.new(key: :position,
+                                 env_name: "GITHUB_API_PR_COMMENT_POSITION",
+                              description: "The position in the diff to comment on (required when not replying to a comment and line/side not specified)",
+                                 optional: true,
+                                     type: Integer),
+            FastlaneCore::ConfigItem.new(key: :line,
+                                 env_name: "GITHUB_API_PR_COMMENT_LINE",
+                              description: "The line number in the file to comment on (required when position is not specified)",
+                                 optional: true,
+                                     type: Integer),
+            FastlaneCore::ConfigItem.new(key: :side,
+                                 env_name: "GITHUB_API_PR_COMMENT_SIDE",
+                              description: "Side of the diff (LEFT or RIGHT)",
+                                 optional: true,
+                                     type: String,
+                             verify_block: proc do |value|
+                               UI.user_error!("Side must be one of: LEFT, RIGHT") unless ["LEFT", "RIGHT"].include?(value)
+                             end),
+            FastlaneCore::ConfigItem.new(key: :start_line,
+                                 env_name: "GITHUB_API_PR_COMMENT_START_LINE",
+                              description: "The start line number for multi-line comments",
+                                 optional: true,
+                                     type: Integer),
+            FastlaneCore::ConfigItem.new(key: :start_side,
+                                 env_name: "GITHUB_API_PR_COMMENT_START_SIDE",
+                              description: "Side of the diff for the start line (LEFT or RIGHT)",
+                                 optional: true,
+                                     type: String,
+                             verify_block: proc do |value|
+                               UI.user_error!("Start side must be one of: LEFT, RIGHT") unless ["LEFT", "RIGHT"].include?(value)
+                             end),
+            FastlaneCore::ConfigItem.new(key: :in_reply_to,
+                                 env_name: "GITHUB_API_PR_COMMENT_IN_REPLY_TO",
+                              description: "The ID of the comment to reply to (when creating a reply)",
+                                 optional: true,
+                                     type: Integer)
+          ]
+        end
+
+        def output
+          [
+            ['GITHUB_CREATE_PULL_COMMENT_STATUS_CODE', 'The status code returned by the GitHub API'],
+            ['GITHUB_CREATE_PULL_COMMENT_RESPONSE', 'The full response body returned by the GitHub API'],
+            ['GITHUB_CREATE_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_create_pull_comment(
+              repo_owner: "octocat",
+              repo_name: "Hello-World",
+              pull_number: 42,
+              body: "Great improvement to this section!",
+              commit_id: "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+              path: "file.rb",
+              line: 42,
+              side: "RIGHT"
+            )',
+            'github_create_pull_comment(
+              repo_owner: "octocat",
+              repo_name: "Hello-World",
+              pull_number: 42,
+              body: "I agree with your suggestion",
+              in_reply_to: 123456
+            )'
+          ]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,168 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_CREATE_PULL_COMMENT_REACTION_STATUS_CODE = :GITHUB_CREATE_PULL_COMMENT_REACTION_STATUS_CODE
+      GITHUB_CREATE_PULL_COMMENT_REACTION_RESPONSE = :GITHUB_CREATE_PULL_COMMENT_REACTION_RESPONSE
+      GITHUB_CREATE_PULL_COMMENT_REACTION_JSON = :GITHUB_CREATE_PULL_COMMENT_REACTION_JSON
+    end
+
+    class GithubCreatePullCommentReactionAction < 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]
+          comment_id = params[:comment_id]
+          content = params[:content]
+          
+          # Build the request body
+          body = {
+            content: content
+          }
+          
+          # Build the path
+          path = "/repos/#{repo_owner}/#{repo_name}/pulls/comments/#{comment_id}/reactions"
+          
+          UI.message("Creating '#{content}' reaction for pull request review comment ##{comment_id} in #{repo_owner}/#{repo_name}")
+          response = Helper::GithubApiHelper.github_api_request(
+            token: api_token,
+            path: path,
+            params: body,
+            method: :post,
+            server_url: server_url,
+            headers: { 'Accept' => 'application/vnd.github.squirrel-girl-preview+json' }
+          )
+          
+          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 '#{content}' reaction for pull request review comment ##{comment_id}")
+          else
+            UI.error("Error creating reaction: #{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_CREATE_PULL_COMMENT_REACTION_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_CREATE_PULL_COMMENT_REACTION_RESPONSE] = response[:body]
+          Actions.lane_context[SharedValues::GITHUB_CREATE_PULL_COMMENT_REACTION_JSON] = json_response
+          
+          return result
+        end
+        
+        #####################################################
+        # @!group Documentation
+        #####################################################
+        
+        def description
+          "Create a reaction for a pull request review comment"
+        end
+        
+        def details
+          [
+            "Creates a reaction for a pull request review comment.",
+            "You must provide your GitHub Personal token (get one from https://github.com/settings/tokens/new).",
+            "API Documentation: https://docs.github.com/en/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment"
+          ].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: :comment_id,
+                                 env_name: "GITHUB_API_COMMENT_ID",
+                              description: "The ID of the pull request review comment",
+                                 optional: false,
+                                     type: Integer),
+            FastlaneCore::ConfigItem.new(key: :content,
+                                 env_name: "GITHUB_API_REACTION_CONTENT",
+                              description: "The reaction type (+1, -1, laugh, confused, heart, hooray, rocket, eyes)",
+                                 optional: false,
+                                     type: String,
+                             verify_block: proc do |value|
+                               valid_reactions = ['+1', '-1', 'laugh', 'confused', 'heart', 'hooray', 'rocket', 'eyes']
+                               UI.user_error!("Invalid reaction content: '#{value}'. Must be one of: #{valid_reactions.join(', ')}") unless valid_reactions.include?(value)
+                             end)
+          ]
+        end
+
+        def output
+          [
+            ['GITHUB_CREATE_PULL_COMMENT_REACTION_STATUS_CODE', 'The status code returned by the GitHub API'],
+            ['GITHUB_CREATE_PULL_COMMENT_REACTION_RESPONSE', 'The full response body returned by the GitHub API'],
+            ['GITHUB_CREATE_PULL_COMMENT_REACTION_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_create_pull_comment_reaction(
+              repo_owner: "octocat",
+              repo_name: "Hello-World",
+              comment_id: 123,
+              content: "+1"
+            )',
+            'reaction = github_create_pull_comment_reaction(
+              repo_owner: "octocat",
+              repo_name: "Hello-World",
+              comment_id: 123,
+              content: "heart"
+            )
+            
+            puts "Created reaction: #{reaction[:json]["content"]}"
+            puts "Reaction ID: #{reaction[:json]["id"]}"'
+          ]
+        end
+      end
+    end
+  end
+end