fastlane-plugin-github_api 0.1.0

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

@@ -0,0 +1,191 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_ADD_ASSIGNEES_RESPONSE = :GITHUB_ADD_ASSIGNEES_RESPONSE
+      GITHUB_ADD_ASSIGNEES_JSON = :GITHUB_ADD_ASSIGNEES_JSON
+      GITHUB_ADD_ASSIGNEES_STATUS_CODE = :GITHUB_ADD_ASSIGNEES_STATUS_CODE
+    end
+
+    class GithubAddAssigneesAction < Action
+      class << self
+        def run(params)
+          # Required parameters
+          token = params[:api_token]
+          repo_owner = params[:repo_owner]
+          repo_name = params[:repo_name]
+          issue_number = params[:issue_number]
+          assignees = params[:assignees]
+          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
+          UI.user_error!("No assignees provided, pass using `assignees: ['username1', 'username2']`") if assignees.nil? || assignees.empty?
+          
+          # Prepare request parameters
+          path = "/repos/#{repo_owner}/#{repo_name}/issues/#{issue_number}/assignees"
+          
+          # Build body parameters
+          body_params = {
+            assignees: assignees
+          }
+          
+          # Make the request
+          UI.message("Adding assignees #{assignees.join(', ')} to issue ##{issue_number} in #{repo_owner}/#{repo_name}")
+          response = Helper::GithubApiHelper.github_api_request(
+            token: token,
+            path: path,
+            params: body_params,
+            method: :post,
+            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
+          
+          # Print assignees for confirmation
+          if response['assignees'] && !response['assignees'].empty?
+            UI.success("Successfully added assignees to issue ##{issue_number}: #{response['assignees'].map { |a| a['login'] }.join(', ')}")
+          else
+            UI.success("Successfully updated issue ##{issue_number}")
+          end
+          
+          # Set the shared values
+          Actions.lane_context[SharedValues::GITHUB_ADD_ASSIGNEES_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_ADD_ASSIGNEES_RESPONSE] = response
+          Actions.lane_context[SharedValues::GITHUB_ADD_ASSIGNEES_JSON] = response
+          
+          return result
+        end
+
+        #####################################################
+        # @!group Documentation
+        #####################################################
+
+        def description
+          "Adds assignees to a GitHub issue"
+        end
+
+        def details
+          [
+            "This action adds one or more assignees to a specific issue in a GitHub repository using the GitHub API.",
+            "It requires a valid GitHub API token with appropriate permissions.",
+            "Documentation: [https://docs.github.com/en/rest/issues/assignees](https://docs.github.com/en/rest/issues/assignees)"
+          ].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 to add assignees to",
+                                    optional: false,
+                                        type: Integer),
+            FastlaneCore::ConfigItem.new(key: :assignees,
+                                 description: "Array of usernames to assign to the issue",
+                                    optional: false,
+                                        type: Array,
+                               verify_block: proc do |value|
+                                  UI.user_error!("No assignees provided, pass using `assignees: ['username1']`") if value.nil? || value.empty?
+                                end)
+          ]
+        end
+
+        def output
+          [
+            ['GITHUB_ADD_ASSIGNEES_STATUS_CODE', 'The status code returned from the GitHub API'],
+            ['GITHUB_ADD_ASSIGNEES_RESPONSE', 'The full response from the GitHub API'],
+            ['GITHUB_ADD_ASSIGNEES_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_add_assignees(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane",
+              issue_number: 123,
+              assignees: ["username1", "username2"]
+            )',
+            '# You can also access the response data
+            result = github_add_assignees(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane",
+              issue_number: 123,
+              assignees: ["username1"]
+            )
+            UI.message("Assigned users: #{result[:json]["assignees"].map { |a| a["login"] }.join(", ")}")'
+          ]
+        end
+
+        def category
+          :source_control
+        end
+
+        def is_supported?(platform)
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,184 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_ADD_ISSUE_COMMENT_STATUS_CODE = :GITHUB_ADD_ISSUE_COMMENT_STATUS_CODE
+      GITHUB_ADD_ISSUE_COMMENT_RESPONSE = :GITHUB_ADD_ISSUE_COMMENT_RESPONSE
+      GITHUB_ADD_ISSUE_COMMENT_JSON = :GITHUB_ADD_ISSUE_COMMENT_JSON
+    end
+
+    class GithubAddIssueCommentAction < 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]
+          issue_number = params[:issue_number]
+          body = params[:body]
+          
+          # Validate parameters
+          UI.user_error!("No GitHub issue number given, pass using `issue_number: 123`") unless issue_number.to_s.length > 0
+          UI.user_error!("No comment body provided, pass using `body: 'Comment text'`") if body.to_s.empty?
+          
+          # Build the path
+          path = "/repos/#{repo_owner}/#{repo_name}/issues/#{issue_number}/comments"
+          
+          # Build body parameters
+          body_params = {
+            body: body
+          }
+          
+          UI.message("Adding comment to issue ##{issue_number} in #{repo_owner}/#{repo_name}")
+          response = Helper::GithubApiHelper.github_api_request(
+            token: api_token,
+            path: path,
+            params: body_params,
+            method: :post,
+            server_url: server_url
+          )
+          
+          status_code = response[:status]
+          json_response = response[:json]
+          result = {
+            status: status_code,
+            body: response[:body],
+            json: json_response
+          }
+
+          # Robust status code check for reusability
+          if status_code.is_a?(Integer) && status_code.between?(200, 299)
+            comment_id = json_response['id']
+            UI.success("Successfully added comment ID: #{comment_id} to issue ##{issue_number} in #{repo_owner}/#{repo_name}")
+          else
+            UI.error("Error adding comment: #{status_code.inspect}")
+            UI.error(response[:body])
+            UI.user_error!("GitHub API returned #{status_code.inspect}: #{response[:body]}")
+            return nil
+          end
+          
+          # Store the results in shared values
+          Actions.lane_context[SharedValues::GITHUB_ADD_ISSUE_COMMENT_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_ADD_ISSUE_COMMENT_RESPONSE] = response[:body]
+          Actions.lane_context[SharedValues::GITHUB_ADD_ISSUE_COMMENT_JSON] = json_response
+          
+          return result
+        end
+        
+        #####################################################
+        # @!group Documentation
+        #####################################################
+        
+        def description
+          "Adds a comment to a GitHub issue"
+        end
+        
+        def details
+          [
+            "Adds a new comment to an issue in a GitHub repository.",
+            "You must provide your GitHub Personal token (get one from https://github.com/settings/tokens/new).",
+            "API Documentation: https://docs.github.com/en/rest/issues/comments#create-an-issue-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: "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 to comment on",
+                                 optional: false,
+                                     type: Integer),
+            FastlaneCore::ConfigItem.new(key: :body,
+                              description: "The body text of the comment",
+                                 optional: false,
+                                     type: String,
+                              verify_block: proc do |value|
+                                UI.user_error!("No comment body provided, pass using `body: 'Comment text'`") if value.to_s.empty?
+                              end)
+          ]
+        end
+        
+        def output
+          [
+            ['GITHUB_ADD_ISSUE_COMMENT_STATUS_CODE', 'The status code returned from the GitHub API'],
+            ['GITHUB_ADD_ISSUE_COMMENT_RESPONSE', 'The full response body from the GitHub API'],
+            ['GITHUB_ADD_ISSUE_COMMENT_JSON', 'The parsed JSON 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_add_issue_comment(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane",
+              issue_number: 123,
+              body: "This is a new comment"
+            )',
+            '# You can also access the response data
+            result = github_add_issue_comment(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane",
+              issue_number: 123,
+              body: "This is a new comment"
+            )
+            UI.message("Created comment ID: #{result[:json]["id"]}")'
+          ]
+        end
+        
+        def category
+          :source_control
+        end
+        
+        def is_supported?(platform)
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,191 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GITHUB_ADD_LABELS_RESPONSE = :GITHUB_ADD_LABELS_RESPONSE
+      GITHUB_ADD_LABELS_JSON = :GITHUB_ADD_LABELS_JSON
+      GITHUB_ADD_LABELS_STATUS_CODE = :GITHUB_ADD_LABELS_STATUS_CODE
+    end
+
+    class GithubAddLabelsAction < 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]
+          labels = params[:labels]
+          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
+          UI.user_error!("No labels provided, pass using `labels: ['bug', 'feature']`") if labels.nil? || labels.empty?
+          
+          # Prepare request parameters
+          path = "/repos/#{repo_owner}/#{repo_name}/issues/#{issue_number}/labels"
+          
+          # Build body parameters
+          body_params = {
+            labels: labels
+          }
+          
+          # Make the request
+          UI.message("Adding labels to issue ##{issue_number} in #{repo_owner}/#{repo_name}")
+          response = Helper::GithubApiHelper.github_api_request(
+            token: token,
+            path: path,
+            params: body_params,
+            method: :post,
+            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
+          
+          # Print labels for confirmation
+          if response.is_a?(Array) && !response.empty?
+            label_names = response.map { |label| label['name'] }.join(', ')
+            UI.success("Successfully added labels to issue ##{issue_number}: #{label_names}")
+          else
+            UI.success("Successfully updated issue ##{issue_number}")
+          end
+          
+          # Set the shared values
+          Actions.lane_context[SharedValues::GITHUB_ADD_LABELS_STATUS_CODE] = status_code
+          Actions.lane_context[SharedValues::GITHUB_ADD_LABELS_RESPONSE] = response
+          Actions.lane_context[SharedValues::GITHUB_ADD_LABELS_JSON] = response
+          
+          return result
+        end
+
+        #####################################################
+        # @!group Documentation
+        #####################################################
+
+        def description
+          "Adds labels to a GitHub issue"
+        end
+
+        def details
+          [
+            "This action adds one or more labels to a specific issue 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#add-labels-to-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 to add labels to",
+                                    optional: false,
+                                        type: Integer),
+            FastlaneCore::ConfigItem.new(key: :labels,
+                                 description: "Array of label names to add to the issue",
+                                    optional: false,
+                                        type: Array,
+                               verify_block: proc do |value|
+                                  UI.user_error!("No labels provided, pass using `labels: ['bug']`") if value.nil? || value.empty?
+                                end)
+          ]
+        end
+
+        def output
+          [
+            ['GITHUB_ADD_LABELS_STATUS_CODE', 'The status code returned from the GitHub API'],
+            ['GITHUB_ADD_LABELS_RESPONSE', 'The full response from the GitHub API'],
+            ['GITHUB_ADD_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_add_labels(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane",
+              issue_number: 123,
+              labels: ["bug", "enhancement"]
+            )',
+            '# You can also access the response data
+            result = github_add_labels(
+              api_token: ENV["GITHUB_API_TOKEN"],
+              repo_owner: "fastlane",
+              repo_name: "fastlane",
+              issue_number: 123,
+              labels: ["bug", "critical"]
+            )
+            UI.message("Labels added: #{result[:json].map { |label| label["name"] }.join(", ")}")'
+          ]
+        end
+
+        def category
+          :source_control
+        end
+
+        def is_supported?(platform)
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+require 'fastlane/action'
+require_relative '../helper/github_api_helper'
+
+module Fastlane
+  module Actions
+    class GithubApiAction < Action
+      def self.run(params)
+        UI.message("The github_api plugin is working!")
+      end
+
+      def self.description
+        "A fastlane plugin forGitHub APIs."
+      end
+
+      def self.authors
+        ["crazymanish"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        "A fastlane plugin forGitHub APIs. 🚀"
+      end
+
+      def self.available_options
+        [
+          # FastlaneCore::ConfigItem.new(key: :your_option,
+          #                         env_name: "GITHUB_API_YOUR_OPTION",
+          #                      description: "A description of your option",
+          #                         optional: false,
+          #                             type: String)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
+        #
+        # [:ios, :mac, :android].include?(platform)
+        true
+      end
+    end
+  end
+end