fastlane-plugin-github_api 0.1.0

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

@@ -0,0 +1,205 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_LIST_MILESTONES_RESPONSE = :GITHUB_LIST_MILESTONES_RESPONSE
+      GITHUB_LIST_MILESTONES_JSON = :GITHUB_LIST_MILESTONES_JSON
+      GITHUB_LIST_MILESTONES_STATUS_CODE = :GITHUB_LIST_MILESTONES_STATUS_CODE
+    end
+
+    class GithubListMilestonesAction < Action
+      class << self
+        def run(params)
+          token = params[:api_token]
+          repo_owner = params[:repo_owner]
+          repo_name = params[:repo_name]
+          server_url = params[:server_url]
+          
+          # Validate parameters (additional validation beyond what's in ConfigItem)
+          UI.user_error!("No repository owner provided, pass using `repo_owner: 'owner'`") if repo_owner.to_s.empty?
+          UI.user_error!("No repository name provided, pass using `repo_name: 'name'`") if repo_name.to_s.empty?
+          
+          # Prepare request parameters
+          path = "/repos/#{repo_owner}/#{repo_name}/milestones"
+          
+          # Build query parameters
+          query_params = {}
+          query_params[:state] = params[:state] if params[:state]
+          query_params[:sort] = params[:sort] if params[:sort]
+          query_params[:direction] = params[:direction] if params[:direction]
+          query_params[:per_page] = params[:per_page] if params[:per_page]
+          query_params[:page] = params[:page] if params[:page]
+          
+          # Make the request
+          UI.message("Fetching milestones for #{repo_owner}/#{repo_name}")
+          response = Helper::GithubApiHelper.github_api_request(
+            token: token,
+            path: path,
+            params: query_params,
+            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.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 milestone info
+          if response.is_a?(Array)
+            UI.success("Successfully fetched #{response.count} milestones from #{repo_owner}/#{repo_name}")
+          else
+            UI.success("Successfully fetched milestones from #{repo_owner}/#{repo_name}")
+          end
+          
+          # Set the shared values
+          Actions.lane_context[SharedValues::GITHUB_LIST_MILESTONES_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_LIST_MILESTONES_RESPONSE] = response
+          Actions.lane_context[SharedValues::GITHUB_LIST_MILESTONES_JSON] = response
+          
+          return result
+        end
+
+        #####################################################
+        # @!group Documentation
+        #####################################################
+
+        def description
+          "Lists milestones in a GitHub repository"
+        end
+
+        def details
+          [
+            "This action fetches a list of milestones from a GitHub repository, with various filtering options.",
+            "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#list-milestones)"
+          ].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: :state,
+                                 description: "State of the milestones (open, closed, all)",
+                                    optional: true,
+                               default_value: "open",
+                                        type: String),
+            FastlaneCore::ConfigItem.new(key: :sort,
+                                 description: "Sort by (due_on, completeness)",
+                                    optional: true,
+                               default_value: "due_on",
+                                        type: String),
+            FastlaneCore::ConfigItem.new(key: :direction,
+                                 description: "Sort direction (asc or desc)",
+                                    optional: true,
+                               default_value: "asc",
+                                        type: String),
+            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_LIST_MILESTONES_STATUS_CODE', 'The status code returned from the GitHub API'],
+            ['GITHUB_LIST_MILESTONES_RESPONSE', 'The full response from the GitHub API'],
+            ['GITHUB_LIST_MILESTONES_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_list_milestones(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane",
+              state: "open",
+              sort: "due_on",
+              direction: "asc"
+            )',
+            '# You can also access the response data
+            result = github_list_milestones(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane"
+            )
+            result[:json].each do |milestone|
+              UI.message("Milestone: #{milestone["title"]}, due on: #{milestone["due_on"]}")
+            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_list_pull_comment_reactions_action.rb

@@ -0,0 +1,183 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_LIST_PULL_COMMENT_REACTIONS_STATUS_CODE = :GITHUB_LIST_PULL_COMMENT_REACTIONS_STATUS_CODE
+      GITHUB_LIST_PULL_COMMENT_REACTIONS_RESPONSE = :GITHUB_LIST_PULL_COMMENT_REACTIONS_RESPONSE
+      GITHUB_LIST_PULL_COMMENT_REACTIONS_JSON = :GITHUB_LIST_PULL_COMMENT_REACTIONS_JSON
+    end
+
+    class GithubListPullCommentReactionsAction < 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]
+          per_page = params[:per_page]
+          page = params[:page]
+          
+          # Build query parameters
+          query_params = {}
+          query_params[:content] = content if content
+          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/comments/#{comment_id}/reactions"
+          
+          UI.message("Listing reactions for pull request review comment ##{comment_id} in #{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,
+            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)
+            reaction_count = json_response.is_a?(Array) ? json_response.count : 0
+            UI.success("Successfully retrieved #{reaction_count} reactions for pull request review comment ##{comment_id}")
+          else
+            UI.error("Error listing pull request review comment reactions: #{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_COMMENT_REACTIONS_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_LIST_PULL_COMMENT_REACTIONS_RESPONSE] = response[:body]
+          Actions.lane_context[SharedValues::GITHUB_LIST_PULL_COMMENT_REACTIONS_JSON] = json_response
+          
+          return result
+        end
+        
+        #####################################################
+        # @!group Documentation
+        #####################################################
+        
+        def description
+          "List reactions for a pull request review comment"
+        end
+        
+        def details
+          [
+            "Lists reactions 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#list-reactions-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: "Filter reactions by content (e.g., +1, -1, laugh, confused, heart, hooray, rocket, eyes)",
+                                 optional: true,
+                                     type: String),
+            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_COMMENT_REACTIONS_STATUS_CODE', 'The status code returned by the GitHub API'],
+            ['GITHUB_LIST_PULL_COMMENT_REACTIONS_RESPONSE', 'The full response body returned by the GitHub API'],
+            ['GITHUB_LIST_PULL_COMMENT_REACTIONS_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_comment_reactions(
+              repo_owner: "octocat",
+              repo_name: "Hello-World",
+              comment_id: 123
+            )',
+            'reactions = github_list_pull_comment_reactions(
+              repo_owner: "octocat",
+              repo_name: "Hello-World",
+              comment_id: 123,
+              content: "+1",
+              per_page: 20,
+              page: 1
+            )
+            
+            reactions[:json].each do |reaction|
+              puts "Reaction: #{reaction["content"]}"
+              puts "User: #{reaction["user"]["login"]}"
+              puts "Created at: #{reaction["created_at"]}"
+              puts "---"
+            end'
+          ]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,203 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_LIST_PULL_COMMENTS_STATUS_CODE = :GITHUB_LIST_PULL_COMMENTS_STATUS_CODE
+      GITHUB_LIST_PULL_COMMENTS_RESPONSE = :GITHUB_LIST_PULL_COMMENTS_RESPONSE
+      GITHUB_LIST_PULL_COMMENTS_JSON = :GITHUB_LIST_PULL_COMMENTS_JSON
+    end
+
+    class GithubListPullCommentsAction < 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]
+          sort = params[:sort]
+          direction = params[:direction]
+          since = params[:since]
+          per_page = params[:per_page]
+          page = params[:page]
+          
+          # Build query parameters
+          query_params = {}
+          query_params[:sort] = sort if sort
+          query_params[:direction] = direction if direction
+          query_params[:since] = since if since
+          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}/comments"
+          
+          UI.message("Listing review comments on 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)
+            comment_count = json_response.is_a?(Array) ? json_response.count : 0
+            UI.success("Successfully retrieved #{comment_count} review comments for pull request ##{pull_number}")
+          else
+            UI.error("Error listing pull request comments: #{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_COMMENTS_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_LIST_PULL_COMMENTS_RESPONSE] = response[:body]
+          Actions.lane_context[SharedValues::GITHUB_LIST_PULL_COMMENTS_JSON] = json_response
+          
+          return result
+        end
+        
+        #####################################################
+        # @!group Documentation
+        #####################################################
+        
+        def description
+          "List review comments on a pull request"
+        end
+        
+        def details
+          [
+            "Lists all review comments 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#list-review-comments-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: :sort,
+                                 env_name: "GITHUB_API_SORT",
+                              description: "Sort direction (created, updated)",
+                                 optional: true,
+                                     type: String,
+                             verify_block: proc do |value|
+                               UI.user_error!("Sort must be either 'created' or 'updated'") unless ['created', 'updated'].include?(value)
+                             end),
+            FastlaneCore::ConfigItem.new(key: :direction,
+                                 env_name: "GITHUB_API_DIRECTION",
+                              description: "Sort direction (asc or desc)",
+                                 optional: true,
+                                     type: String,
+                             verify_block: proc do |value|
+                               UI.user_error!("Direction must be either 'asc' or 'desc'") unless ['asc', 'desc'].include?(value)
+                             end),
+            FastlaneCore::ConfigItem.new(key: :since,
+                                 env_name: "GITHUB_API_SINCE",
+                              description: "Only show comments updated at or after this time (ISO 8601 format)",
+                                 optional: true,
+                                     type: String),
+            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_COMMENTS_STATUS_CODE', 'The status code returned by the GitHub API'],
+            ['GITHUB_LIST_PULL_COMMENTS_RESPONSE', 'The full response body returned by the GitHub API'],
+            ['GITHUB_LIST_PULL_COMMENTS_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_comments(
+              repo_owner: "octocat",
+              repo_name: "Hello-World",
+              pull_number: 42
+            )',
+            'comments = github_list_pull_comments(
+              repo_owner: "octocat",
+              repo_name: "Hello-World",
+              pull_number: 42,
+              sort: "updated",
+              direction: "desc",
+              per_page: 20,
+              page: 1
+            )
+            
+            comments[:json].each do |comment|
+              puts "Comment by #{comment["user"]["login"]}: #{comment["body"]}"
+              puts "Path: #{comment["path"]}, Position: #{comment["position"]}"
+              puts "Created at: #{comment["created_at"]}"
+              puts "---"
+            end'
+          ]
+        end
+      end
+    end
+  end
+end