fastlane-plugin-github_api 0.1.0

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

@@ -0,0 +1,206 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_LIST_PULLS_STATUS_CODE = :GITHUB_LIST_PULLS_STATUS_CODE
+      GITHUB_LIST_PULLS_RESPONSE = :GITHUB_LIST_PULLS_RESPONSE
+      GITHUB_LIST_PULLS_JSON = :GITHUB_LIST_PULLS_JSON
+    end
+
+    class GithubListPullsAction < 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]
+          
+          # Build the path
+          path = "/repos/#{repo_owner}/#{repo_name}/pulls"
+          
+          # Build query parameters
+          query_params = {}
+          query_params[:state] = params[:state] if params[:state]
+          query_params[:head] = params[:head] if params[:head]
+          query_params[:base] = params[:base] if params[:base]
+          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]
+          
+          UI.message("Listing pull requests for #{repo_owner}/#{repo_name}")
+          response = Helper::GithubApiHelper.github_api_request(
+            token: api_token,
+            path: path,
+            params: 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)
+            pull_count = json_response.count
+            UI.success("Successfully retrieved #{pull_count} pull requests from #{repo_owner}/#{repo_name}")
+          else
+            UI.error("Error listing pull requests: #{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_PULLS_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_LIST_PULLS_RESPONSE] = response[:body]
+          Actions.lane_context[SharedValues::GITHUB_LIST_PULLS_JSON] = json_response
+          
+          return result
+        end
+        
+        #####################################################
+        # @!group Documentation
+        #####################################################
+        
+        def description
+          "Lists pull requests in a GitHub repository"
+        end
+        
+        def details
+          [
+            "Lists pull requests in a GitHub repository with filtering options.",
+            "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"
+          ].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: :state,
+                                 env_name: "GITHUB_API_PR_STATE",
+                              description: "State of the PR: open, closed, or all",
+                                 optional: true,
+                            default_value: "open",
+                                     type: String,
+                             verify_block: proc do |value|
+                               UI.user_error!("State must be one of: open, closed, all") unless ["open", "closed", "all"].include?(value)
+                             end),
+            FastlaneCore::ConfigItem.new(key: :head,
+                                 env_name: "GITHUB_API_PR_HEAD",
+                              description: "Filter by head user or head organization and branch name in the format of user:ref-name or organization:ref-name",
+                                 optional: true,
+                                     type: String),
+            FastlaneCore::ConfigItem.new(key: :base,
+                                 env_name: "GITHUB_API_PR_BASE",
+                              description: "Filter by base branch name",
+                                 optional: true,
+                                     type: String),
+            FastlaneCore::ConfigItem.new(key: :sort,
+                                 env_name: "GITHUB_API_PR_SORT",
+                              description: "What to sort results by: created, updated, popularity, long-running",
+                                 optional: true,
+                            default_value: "created",
+                                     type: String,
+                             verify_block: proc do |value|
+                               UI.user_error!("Sort must be one of: created, updated, popularity, long-running") unless ["created", "updated", "popularity", "long-running"].include?(value)
+                             end),
+            FastlaneCore::ConfigItem.new(key: :direction,
+                                 env_name: "GITHUB_API_PR_DIRECTION",
+                              description: "The direction of the sort: asc or desc",
+                                 optional: true,
+                            default_value: "desc",
+                                     type: String,
+                             verify_block: proc do |value|
+                               UI.user_error!("Direction must be one of: asc, desc") unless ["asc", "desc"].include?(value)
+                             end),
+            FastlaneCore::ConfigItem.new(key: :per_page,
+                                 env_name: "GITHUB_API_PR_PER_PAGE",
+                              description: "Results per page (max 100)",
+                                 optional: true,
+                                     type: Integer),
+            FastlaneCore::ConfigItem.new(key: :page,
+                                 env_name: "GITHUB_API_PR_PAGE",
+                              description: "Page number of the results to fetch",
+                                 optional: true,
+                                     type: Integer)
+          ]
+        end
+
+        def output
+          [
+            ['GITHUB_LIST_PULLS_STATUS_CODE', 'The status code returned by the GitHub API'],
+            ['GITHUB_LIST_PULLS_RESPONSE', 'The full response body returned by the GitHub API'],
+            ['GITHUB_LIST_PULLS_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_pulls(
+              repo_owner: "octocat",
+              repo_name: "Hello-World",
+              state: "open"
+            )',
+            'pulls = github_list_pulls(
+              repo_owner: "octocat",
+              repo_name: "Hello-World",
+              base: "main",
+              sort: "created",
+              direction: "desc",
+              per_page: 10
+            )
+            
+            pulls[:json].each do |pull|
+              puts "PR ##{pull["number"]}: #{pull["title"]}"
+            end'
+          ]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,185 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_LIST_REPO_ISSUE_EVENTS_RESPONSE = :GITHUB_LIST_REPO_ISSUE_EVENTS_RESPONSE
+      GITHUB_LIST_REPO_ISSUE_EVENTS_JSON = :GITHUB_LIST_REPO_ISSUE_EVENTS_JSON
+      GITHUB_LIST_REPO_ISSUE_EVENTS_STATUS_CODE = :GITHUB_LIST_REPO_ISSUE_EVENTS_STATUS_CODE
+    end
+
+    class GithubListRepoIssueEventsAction < 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}/issues/events"
+          
+          # Build query parameters
+          query_params = {}
+          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 issue events for repository #{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 event count
+          if response.is_a?(Array)
+            UI.success("Successfully fetched #{response.count} issue events from #{repo_owner}/#{repo_name}")
+          else
+            UI.success("Successfully fetched repository issue events from #{repo_owner}/#{repo_name}")
+          end
+          
+          # Set the shared values
+          Actions.lane_context[SharedValues::GITHUB_LIST_REPO_ISSUE_EVENTS_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_LIST_REPO_ISSUE_EVENTS_RESPONSE] = response
+          Actions.lane_context[SharedValues::GITHUB_LIST_REPO_ISSUE_EVENTS_JSON] = response
+          
+          return result
+        end
+
+        #####################################################
+        # @!group Documentation
+        #####################################################
+
+        def description
+          "Lists issue events for a GitHub repository"
+        end
+
+        def details
+          [
+            "This action fetches a list of issue events for an entire GitHub repository.",
+            "It requires a valid GitHub API token with appropriate permissions.",
+            "Documentation: [https://docs.github.com/en/rest/issues/events](https://docs.github.com/en/rest/issues/events#list-issue-events-for-a-repository)"
+          ].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: :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_REPO_ISSUE_EVENTS_STATUS_CODE', 'The status code returned from the GitHub API'],
+            ['GITHUB_LIST_REPO_ISSUE_EVENTS_RESPONSE', 'The full response from the GitHub API'],
+            ['GITHUB_LIST_REPO_ISSUE_EVENTS_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_repo_issue_events(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane"
+            )',
+            '# You can also access the response data
+            result = github_list_repo_issue_events(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane",
+              per_page: 100
+            )
+            result[:json].each do |event|
+              UI.message("Event: #{event["event"]}, issue: ##{event["issue"]["number"]}")
+            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_repo_labels_action.rb

@@ -0,0 +1,184 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_LIST_REPO_LABELS_RESPONSE = :GITHUB_LIST_REPO_LABELS_RESPONSE
+      GITHUB_LIST_REPO_LABELS_JSON = :GITHUB_LIST_REPO_LABELS_JSON
+      GITHUB_LIST_REPO_LABELS_STATUS_CODE = :GITHUB_LIST_REPO_LABELS_STATUS_CODE
+    end
+
+    class GithubListRepoLabelsAction < 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}/labels"
+          
+          # Build query parameters
+          query_params = {}
+          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 labels for repository #{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
+          
+          if response.is_a?(Array)
+            UI.success("Successfully fetched #{response.count} labels from #{repo_owner}/#{repo_name}")
+          else
+            UI.success("Successfully fetched labels from #{repo_owner}/#{repo_name}")
+          end
+          
+          # Set the shared values
+          Actions.lane_context[SharedValues::GITHUB_LIST_REPO_LABELS_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_LIST_REPO_LABELS_RESPONSE] = response
+          Actions.lane_context[SharedValues::GITHUB_LIST_REPO_LABELS_JSON] = response
+          
+          return result
+        end
+
+        #####################################################
+        # @!group Documentation
+        #####################################################
+
+        def description
+          "Lists all labels for a GitHub repository"
+        end
+
+        def details
+          [
+            "This action fetches all labels defined in a GitHub repository.",
+            "It requires a valid GitHub API token with appropriate permissions.",
+            "Documentation: [https://docs.github.com/en/rest/issues/labels](https://docs.github.com/en/rest/issues/labels#list-labels-for-a-repository)"
+          ].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: :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_REPO_LABELS_STATUS_CODE', 'The status code returned from the GitHub API'],
+            ['GITHUB_LIST_REPO_LABELS_RESPONSE', 'The full response from the GitHub API'],
+            ['GITHUB_LIST_REPO_LABELS_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_repo_labels(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane",
+              per_page: 100
+            )',
+            '# You can also access the response data
+            result = github_list_repo_labels(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane"
+            )
+            result[:json].each do |label|
+              UI.message("Label: #{label["name"]}, color: ##{label["color"]}")
+            end'
+          ]
+        end
+
+        def category
+          :source_control
+        end
+
+        def is_supported?(platform)
+          true
+        end
+      end
+    end
+  end
+end