fastlane-plugin-github_api 0.1.0

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

@@ -0,0 +1,199 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_GET_ISSUE_TIMELINE_RESPONSE = :GITHUB_GET_ISSUE_TIMELINE_RESPONSE
+      GITHUB_GET_ISSUE_TIMELINE_JSON = :GITHUB_GET_ISSUE_TIMELINE_JSON
+      GITHUB_GET_ISSUE_TIMELINE_STATUS_CODE = :GITHUB_GET_ISSUE_TIMELINE_STATUS_CODE
+    end
+
+    class GithubGetIssueTimelineAction < 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}/timeline"
+          
+          # Build query parameters
+          query_params = {}
+          query_params[:per_page] = params[:per_page] if params[:per_page]
+          query_params[:page] = params[:page] if params[:page]
+          
+          # Custom header required for timeline API
+          headers = {
+            'Accept' => 'application/vnd.github.mockingbird-preview+json'
+          }
+          
+          # Make the request
+          UI.message("Fetching timeline for issue ##{issue_number} in #{repo_owner}/#{repo_name}")
+          response = Helper::GithubApiHelper.github_api_request(
+            token: token,
+            path: path,
+            params: query_params,
+            method: :get,
+            server_url: server_url,
+            headers: headers
+          )
+          
+          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
+          
+          # Print timeline events count
+          if response.is_a?(Array)
+            UI.success("Successfully fetched #{response.count} timeline events for issue ##{issue_number}")
+          else
+            UI.success("Successfully fetched timeline for issue ##{issue_number}")
+          end
+          
+          # Set the shared values
+          Actions.lane_context[SharedValues::GITHUB_GET_ISSUE_TIMELINE_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_GET_ISSUE_TIMELINE_RESPONSE] = response
+          Actions.lane_context[SharedValues::GITHUB_GET_ISSUE_TIMELINE_JSON] = response
+          
+          return result
+        end
+
+        #####################################################
+        # @!group Documentation
+        #####################################################
+
+        def description
+          "Gets the timeline of events for a GitHub issue"
+        end
+
+        def details
+          [
+            "This action fetches the timeline of events for a specific issue in a GitHub repository.",
+            "The timeline includes a variety of events beyond basic issue events, such as cross-references, " +
+            "assigned events, labeled events, and more.",
+            "It requires a valid GitHub API token with appropriate permissions.",
+            "Documentation: [https://docs.github.com/en/rest/issues/timeline](https://docs.github.com/en/rest/issues/timeline#list-timeline-events-for-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",
+                                    optional: false,
+                                        type: Integer),
+            FastlaneCore::ConfigItem.new(key: :per_page,
+                                 description: "Results per page (max 100)",
+                                    optional: true,
+                               default_value: 30,
+                                        type: Integer),
+            FastlaneCore::ConfigItem.new(key: :page,
+                                 description: "Page number of the results",
+                                    optional: true,
+                               default_value: 1,
+                                        type: Integer)
+          ]
+        end
+
+        def output
+          [
+            ['GITHUB_GET_ISSUE_TIMELINE_STATUS_CODE', 'The status code returned from the GitHub API'],
+            ['GITHUB_GET_ISSUE_TIMELINE_RESPONSE', 'The full response from the GitHub API'],
+            ['GITHUB_GET_ISSUE_TIMELINE_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_get_issue_timeline(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane",
+              issue_number: 123
+            )',
+            '# You can also access the response data
+            result = github_get_issue_timeline(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane",
+              issue_number: 123
+            )
+            result[:json].each do |event|
+              UI.message("Event: #{event["event_type"] || event["event"]}")
+            end'
+          ]
+        end
+
+        def category
+          :source_control
+        end
+
+        def is_supported?(platform)
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,167 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_GET_MILESTONE_RESPONSE = :GITHUB_GET_MILESTONE_RESPONSE
+      GITHUB_GET_MILESTONE_JSON = :GITHUB_GET_MILESTONE_JSON
+      GITHUB_GET_MILESTONE_STATUS_CODE = :GITHUB_GET_MILESTONE_STATUS_CODE
+    end
+
+    class GithubGetMilestoneAction < Action
+      class << self
+        def run(params)
+          token = params[:api_token]
+          repo_owner = params[:repo_owner]
+          repo_name = params[:repo_name]
+          milestone_number = params[:milestone_number]
+          server_url = params[:server_url]
+          
+          # Validate parameters (additional validation beyond what's in ConfigItem)
+          UI.user_error!("No GitHub milestone number given, pass using `milestone_number: 42`") unless milestone_number.to_s.length > 0
+          
+          # Prepare request parameters
+          path = "/repos/#{repo_owner}/#{repo_name}/milestones/#{milestone_number}"
+          
+          # Make the request
+          UI.message("Fetching milestone ##{milestone_number} from #{repo_owner}/#{repo_name}")
+          response = Helper::GithubApiHelper.github_api_request(
+            token: token,
+            path: path,
+            method: :get,
+            server_url: server_url
+          )
+          
+          status_code = response.key?('status') ? response['status'] : nil
+          result = {
+            status: status_code,
+            body: response,
+            json: response
+          }
+          
+          if response.key?('error')
+            UI.error("GitHub responded with an error: #{response['error']}")
+            UI.user_error!("GitHub API error: #{response['error']}")
+            return nil
+          end
+          
+          if response['message'] && status_code && status_code >= 400
+            UI.error("GitHub API error: #{response['message']}")
+            UI.user_error!("GitHub API error: #{response['message']} (Status code: #{status_code})")
+            return nil
+          end
+          
+          UI.success("Successfully fetched milestone ##{milestone_number} - #{response['title']} from #{repo_owner}/#{repo_name}")
+          
+          # Set the shared values
+          Actions.lane_context[SharedValues::GITHUB_GET_MILESTONE_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_GET_MILESTONE_RESPONSE] = response
+          Actions.lane_context[SharedValues::GITHUB_GET_MILESTONE_JSON] = response
+          
+          return result
+        end
+
+        #####################################################
+        # @!group Documentation
+        #####################################################
+
+        def description
+          "Gets a specific GitHub milestone by number"
+        end
+
+        def details
+          [
+            "This action fetches a specific milestone from a GitHub repository by its milestone number.",
+            "It requires a valid GitHub API token with appropriate permissions.",
+            "Documentation: [https://docs.github.com/en/rest/issues/milestones](https://docs.github.com/en/rest/issues/milestones#get-a-milestone)"
+          ].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: :milestone_number,
+                                 description: "The milestone number",
+                                    optional: false,
+                                        type: Integer)
+          ]
+        end
+
+        def output
+          [
+            ['GITHUB_GET_MILESTONE_STATUS_CODE', 'The status code returned from the GitHub API'],
+            ['GITHUB_GET_MILESTONE_RESPONSE', 'The full response from the GitHub API'],
+            ['GITHUB_GET_MILESTONE_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_get_milestone(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane",
+              milestone_number: 42
+            )',
+            '# You can also access the milestone data
+            result = github_get_milestone(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane",
+              milestone_number: 42
+            )
+            UI.message("Milestone title: #{result[:json]["title"]}")'
+          ]
+        end
+
+        def category
+          :source_control
+        end
+
+        def is_supported?(platform)
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,150 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_GET_PULL_STATUS_CODE = :GITHUB_GET_PULL_STATUS_CODE
+      GITHUB_GET_PULL_RESPONSE = :GITHUB_GET_PULL_RESPONSE
+      GITHUB_GET_PULL_JSON = :GITHUB_GET_PULL_JSON
+    end
+
+    class GithubGetPullAction < 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}"
+          
+          UI.message("Getting pull request ##{pull_number} from #{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)
+            UI.success("Successfully retrieved pull request ##{pull_number} from #{repo_owner}/#{repo_name}")
+          else
+            UI.error("Error getting 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_GET_PULL_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_GET_PULL_RESPONSE] = response[:body]
+          Actions.lane_context[SharedValues::GITHUB_GET_PULL_JSON] = json_response
+          
+          return result
+        end
+        
+        #####################################################
+        # @!group Documentation
+        #####################################################
+        
+        def description
+          "Gets a single pull request from a GitHub repository"
+        end
+        
+        def details
+          [
+            "Gets detailed information about a specific 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#get-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_GET_PULL_STATUS_CODE', 'The status code returned by the GitHub API'],
+            ['GITHUB_GET_PULL_RESPONSE', 'The full response body returned by the GitHub API'],
+            ['GITHUB_GET_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_get_pull(
+              repo_owner: "octocat",
+              repo_name: "Hello-World",
+              pull_number: 42
+            )',
+            'pull_request = github_get_pull(
+              repo_owner: "octocat",
+              repo_name: "Hello-World",
+              pull_number: 42
+            )
+            
+            title = pull_request[:json]["title"]
+            state = pull_request[:json]["state"]
+            puts "Pull Request #42: #{title} (#{state})"'
+          ]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,147 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_GET_PULL_COMMENT_STATUS_CODE = :GITHUB_GET_PULL_COMMENT_STATUS_CODE
+      GITHUB_GET_PULL_COMMENT_RESPONSE = :GITHUB_GET_PULL_COMMENT_RESPONSE
+      GITHUB_GET_PULL_COMMENT_JSON = :GITHUB_GET_PULL_COMMENT_JSON
+    end
+
+    class GithubGetPullCommentAction < 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]
+          
+          # Build the path
+          path = "/repos/#{repo_owner}/#{repo_name}/pulls/comments/#{comment_id}"
+          
+          UI.message("Getting pull request comment #{comment_id} from #{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)
+            UI.success("Successfully retrieved pull request comment #{comment_id}")
+          else
+            UI.error("Error getting 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_GET_PULL_COMMENT_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_GET_PULL_COMMENT_RESPONSE] = response[:body]
+          Actions.lane_context[SharedValues::GITHUB_GET_PULL_COMMENT_JSON] = json_response
+          
+          return result
+        end
+        
+        #####################################################
+        # @!group Documentation
+        #####################################################
+        
+        def description
+          "Gets a specific pull request comment"
+        end
+        
+        def details
+          [
+            "Gets detailed information about a specific review comment on a pull request.",
+            "You must provide your GitHub Personal token (get one from https://github.com/settings/tokens/new).",
+            "API Documentation: https://docs.github.com/en/rest/pulls/comments#get-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: :comment_id,
+                                 env_name: "GITHUB_API_PR_COMMENT_ID",
+                              description: "The ID of the comment",
+                                 optional: false,
+                                     type: Integer)
+          ]
+        end
+
+        def output
+          [
+            ['GITHUB_GET_PULL_COMMENT_STATUS_CODE', 'The status code returned by the GitHub API'],
+            ['GITHUB_GET_PULL_COMMENT_RESPONSE', 'The full response body returned by the GitHub API'],
+            ['GITHUB_GET_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_get_pull_comment(
+              repo_owner: "octocat",
+              repo_name: "Hello-World",
+              comment_id: 12345
+            )',
+            'comment = github_get_pull_comment(
+              repo_owner: "octocat",
+              repo_name: "Hello-World",
+              comment_id: 12345
+            )
+            puts "Comment by #{comment[:json]["user"]["login"]}: #{comment[:json]["body"]}"'
+          ]
+        end
+      end
+    end
+  end
+end