fastlane-plugin-github_api 0.1.0

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

@@ -0,0 +1,175 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_LIST_PULL_COMMITS_STATUS_CODE = :GITHUB_LIST_PULL_COMMITS_STATUS_CODE
+      GITHUB_LIST_PULL_COMMITS_RESPONSE = :GITHUB_LIST_PULL_COMMITS_RESPONSE
+      GITHUB_LIST_PULL_COMMITS_JSON = :GITHUB_LIST_PULL_COMMITS_JSON
+    end
+
+    class GithubListPullCommitsAction < 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]
+          per_page = params[:per_page]
+          page = params[:page]
+          
+          # Build query parameters
+          query_params = {}
+          query_params[:per_page] = per_page if per_page
+          query_params[:page] = page if page
+          
+          # Build the path
+          path = "/repos/#{repo_owner}/#{repo_name}/pulls/#{pull_number}/commits"
+          
+          UI.message("Getting commits for pull request ##{pull_number} from #{repo_owner}/#{repo_name}")
+          response = Helper::GithubApiHelper.github_api_request(
+            token: api_token,
+            path: path,
+            params: query_params.empty? ? nil : query_params,
+            method: :get,
+            server_url: server_url
+          )
+          
+          status_code = response[:status]
+          json_response = response[:json]
+          result = {
+            status: status_code,
+            body: response[:body],
+            json: json_response
+          }
+          
+          if status_code.between?(200, 299)
+            commit_count = json_response.is_a?(Array) ? json_response.count : 0
+            UI.success("Successfully retrieved #{commit_count} commits for pull request ##{pull_number} from #{repo_owner}/#{repo_name}")
+          else
+            UI.error("Error getting pull request commits: #{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_LIST_PULL_COMMITS_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_LIST_PULL_COMMITS_RESPONSE] = response[:body]
+          Actions.lane_context[SharedValues::GITHUB_LIST_PULL_COMMITS_JSON] = json_response
+          
+          return result
+        end
+        
+        #####################################################
+        # @!group Documentation
+        #####################################################
+        
+        def description
+          "Lists commits on a pull request"
+        end
+        
+        def details
+          [
+            "Lists commits on a pull request by its number.",
+            "You must provide your GitHub Personal token (get one from https://github.com/settings/tokens/new).",
+            "API Documentation: https://docs.github.com/en/rest/pulls/pulls#list-commits-on-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: :per_page,
+                                 env_name: "GITHUB_API_PER_PAGE",
+                              description: "Results per page (max 100)",
+                                 optional: true,
+                                     type: Integer),
+            FastlaneCore::ConfigItem.new(key: :page,
+                                 env_name: "GITHUB_API_PAGE",
+                              description: "Page number of the results to fetch",
+                                 optional: true,
+                                     type: Integer)
+          ]
+        end
+
+        def output
+          [
+            ['GITHUB_LIST_PULL_COMMITS_STATUS_CODE', 'The status code returned by the GitHub API'],
+            ['GITHUB_LIST_PULL_COMMITS_RESPONSE', 'The full response body returned by the GitHub API'],
+            ['GITHUB_LIST_PULL_COMMITS_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_list_pull_commits(
+              repo_owner: "octocat",
+              repo_name: "Hello-World",
+              pull_number: 42
+            )',
+            'pull_commits = github_list_pull_commits(
+              repo_owner: "octocat",
+              repo_name: "Hello-World",
+              pull_number: 42,
+              per_page: 30,
+              page: 1
+            )
+            
+            commits = pull_commits[:json]
+            commits.each do |commit|
+              puts "Commit SHA: #{commit["sha"]}"
+              puts "Author: #{commit["commit"]["author"]["name"]}"
+              puts "Message: #{commit["commit"]["message"]}"
+              puts "---"
+            end'
+          ]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,174 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_LIST_PULL_FILES_STATUS_CODE = :GITHUB_LIST_PULL_FILES_STATUS_CODE
+      GITHUB_LIST_PULL_FILES_RESPONSE = :GITHUB_LIST_PULL_FILES_RESPONSE
+      GITHUB_LIST_PULL_FILES_JSON = :GITHUB_LIST_PULL_FILES_JSON
+    end
+
+    class GithubListPullFilesAction < 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]
+          per_page = params[:per_page]
+          page = params[:page]
+          
+          # Build query parameters
+          query_params = {}
+          query_params[:per_page] = per_page if per_page
+          query_params[:page] = page if page
+          
+          # Build the path
+          path = "/repos/#{repo_owner}/#{repo_name}/pulls/#{pull_number}/files"
+          
+          UI.message("Listing files for pull request ##{pull_number} from #{repo_owner}/#{repo_name}")
+          response = Helper::GithubApiHelper.github_api_request(
+            token: api_token,
+            path: path,
+            params: query_params.empty? ? nil : query_params,
+            method: :get,
+            server_url: server_url
+          )
+          
+          status_code = response[:status]
+          json_response = response[:json]
+          result = {
+            status: status_code,
+            body: response[:body],
+            json: json_response
+          }
+          
+          if status_code.between?(200, 299)
+            file_count = json_response.is_a?(Array) ? json_response.count : 0
+            UI.success("Successfully retrieved #{file_count} files for pull request ##{pull_number}")
+          else
+            UI.error("Error listing pull request files: #{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_LIST_PULL_FILES_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_LIST_PULL_FILES_RESPONSE] = response[:body]
+          Actions.lane_context[SharedValues::GITHUB_LIST_PULL_FILES_JSON] = json_response
+          
+          return result
+        end
+        
+        #####################################################
+        # @!group Documentation
+        #####################################################
+        
+        def description
+          "List files in a pull request"
+        end
+        
+        def details
+          [
+            "Lists all files changed in 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/pulls#list-pull-requests-files"
+          ].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: :per_page,
+                                 env_name: "GITHUB_API_PER_PAGE",
+                              description: "Results per page (max 100)",
+                                 optional: true,
+                                     type: Integer),
+            FastlaneCore::ConfigItem.new(key: :page,
+                                 env_name: "GITHUB_API_PAGE",
+                              description: "Page number of the results to fetch",
+                                 optional: true,
+                                     type: Integer)
+          ]
+        end
+
+        def output
+          [
+            ['GITHUB_LIST_PULL_FILES_STATUS_CODE', 'The status code returned by the GitHub API'],
+            ['GITHUB_LIST_PULL_FILES_RESPONSE', 'The full response body returned by the GitHub API'],
+            ['GITHUB_LIST_PULL_FILES_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_list_pull_files(
+              repo_owner: "octocat",
+              repo_name: "Hello-World",
+              pull_number: 42
+            )',
+            'files = github_list_pull_files(
+              repo_owner: "octocat",
+              repo_name: "Hello-World",
+              pull_number: 42,
+              per_page: 50,
+              page: 1
+            )
+            
+            files[:json].each do |file|
+              puts "File: #{file["filename"]}"
+              puts "Status: #{file["status"]}"
+              puts "Additions: #{file["additions"]}, Deletions: #{file["deletions"]}, Changes: #{file["changes"]}"
+              puts "---"
+            end'
+          ]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,163 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_LIST_PULL_REVIEWERS_STATUS_CODE = :GITHUB_LIST_PULL_REVIEWERS_STATUS_CODE
+      GITHUB_LIST_PULL_REVIEWERS_RESPONSE = :GITHUB_LIST_PULL_REVIEWERS_RESPONSE
+      GITHUB_LIST_PULL_REVIEWERS_JSON = :GITHUB_LIST_PULL_REVIEWERS_JSON
+    end
+
+    class GithubListPullReviewersAction < 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]
+          
+          # Build the path
+          path = "/repos/#{repo_owner}/#{repo_name}/pulls/#{pull_number}/requested_reviewers"
+          
+          UI.message("Listing requested reviewers for pull request ##{pull_number} in #{repo_owner}/#{repo_name}")
+          response = Helper::GithubApiHelper.github_api_request(
+            token: api_token,
+            path: path,
+            method: :get,
+            server_url: server_url
+          )
+          
+          status_code = response[:status]
+          json_response = response[:json]
+          result = {
+            status: status_code,
+            body: response[:body],
+            json: json_response
+          }
+          
+          if status_code.between?(200, 299)
+            reviewers_count = 0
+            team_reviewers_count = 0
+            
+            if json_response["users"] && json_response["users"].is_a?(Array)
+              reviewers_count = json_response["users"].count
+            end
+            
+            if json_response["teams"] && json_response["teams"].is_a?(Array)
+              team_reviewers_count = json_response["teams"].count
+            end
+            
+            UI.success("Successfully listed #{reviewers_count} reviewers and #{team_reviewers_count} team reviewers for pull request ##{pull_number}")
+          else
+            UI.error("Error listing 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_LIST_PULL_REVIEWERS_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_LIST_PULL_REVIEWERS_RESPONSE] = response[:body]
+          Actions.lane_context[SharedValues::GITHUB_LIST_PULL_REVIEWERS_JSON] = json_response
+          
+          return result
+        end
+        
+        #####################################################
+        # @!group Documentation
+        #####################################################
+        
+        def description
+          "Lists requested reviewers for a pull request"
+        end
+        
+        def details
+          [
+            "Lists all requested 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#get-all-requested-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)
+          ]
+        end
+
+        def output
+          [
+            ['GITHUB_LIST_PULL_REVIEWERS_STATUS_CODE', 'The status code returned by the GitHub API'],
+            ['GITHUB_LIST_PULL_REVIEWERS_RESPONSE', 'The full response body returned by the GitHub API'],
+            ['GITHUB_LIST_PULL_REVIEWERS_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_list_pull_reviewers(
+              repo_owner: "octocat",
+              repo_name: "Hello-World",
+              pull_number: 42
+            )',
+            'reviewers_info = github_list_pull_reviewers(
+              repo_owner: "octocat",
+              repo_name: "Hello-World",
+              pull_number: 42
+            )
+            
+            users = reviewers_info[:json]["users"]
+            teams = reviewers_info[:json]["teams"]
+            
+            puts "Requested reviewers: #{users.map { |u| u["login"] }.join(", ")}"
+            puts "Requested team reviewers: #{teams.map { |t| t["name"] }.join(", ")}"'
+          ]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,175 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_LIST_PULL_REVIEWS_STATUS_CODE = :GITHUB_LIST_PULL_REVIEWS_STATUS_CODE
+      GITHUB_LIST_PULL_REVIEWS_RESPONSE = :GITHUB_LIST_PULL_REVIEWS_RESPONSE
+      GITHUB_LIST_PULL_REVIEWS_JSON = :GITHUB_LIST_PULL_REVIEWS_JSON
+    end
+
+    class GithubListPullReviewsAction < 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]
+          per_page = params[:per_page]
+          page = params[:page]
+          
+          # Build query parameters
+          query_params = {}
+          query_params[:per_page] = per_page if per_page
+          query_params[:page] = page if page
+          
+          # Build the path
+          path = "/repos/#{repo_owner}/#{repo_name}/pulls/#{pull_number}/reviews"
+          
+          UI.message("Listing reviews for pull request ##{pull_number} from #{repo_owner}/#{repo_name}")
+          response = Helper::GithubApiHelper.github_api_request(
+            token: api_token,
+            path: path,
+            params: query_params.empty? ? nil : query_params,
+            method: :get,
+            server_url: server_url
+          )
+          
+          status_code = response[:status]
+          json_response = response[:json]
+          result = {
+            status: status_code,
+            body: response[:body],
+            json: json_response
+          }
+          
+          if status_code.between?(200, 299)
+            review_count = json_response.is_a?(Array) ? json_response.count : 0
+            UI.success("Successfully retrieved #{review_count} reviews for pull request ##{pull_number}")
+          else
+            UI.error("Error listing pull request reviews: #{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_LIST_PULL_REVIEWS_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_LIST_PULL_REVIEWS_RESPONSE] = response[:body]
+          Actions.lane_context[SharedValues::GITHUB_LIST_PULL_REVIEWS_JSON] = json_response
+          
+          return result
+        end
+        
+        #####################################################
+        # @!group Documentation
+        #####################################################
+        
+        def description
+          "List reviews for a pull request"
+        end
+        
+        def details
+          [
+            "Lists all reviews 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#list-reviews-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: :per_page,
+                                 env_name: "GITHUB_API_PER_PAGE",
+                              description: "Results per page (max 100)",
+                                 optional: true,
+                                     type: Integer),
+            FastlaneCore::ConfigItem.new(key: :page,
+                                 env_name: "GITHUB_API_PAGE",
+                              description: "Page number of the results to fetch",
+                                 optional: true,
+                                     type: Integer)
+          ]
+        end
+
+        def output
+          [
+            ['GITHUB_LIST_PULL_REVIEWS_STATUS_CODE', 'The status code returned by the GitHub API'],
+            ['GITHUB_LIST_PULL_REVIEWS_RESPONSE', 'The full response body returned by the GitHub API'],
+            ['GITHUB_LIST_PULL_REVIEWS_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_list_pull_reviews(
+              repo_owner: "octocat",
+              repo_name: "Hello-World",
+              pull_number: 42
+            )',
+            'reviews = github_list_pull_reviews(
+              repo_owner: "octocat",
+              repo_name: "Hello-World",
+              pull_number: 42,
+              per_page: 20,
+              page: 1
+            )
+            
+            reviews[:json].each do |review|
+              puts "Review by #{review["user"]["login"]}"
+              puts "State: #{review["state"]}"
+              puts "Submitted at: #{review["submitted_at"]}"
+              puts "Body: #{review["body"]}"
+              puts "---"
+            end'
+          ]
+        end
+      end
+    end
+  end
+end