fastlane-plugin-circle_ci 0.2.0 → 0.3.0

data/lib/fastlane/plugin/circle_ci/actions/circleci_delete_env_var.rb

@@ -0,0 +1,86 @@
+require 'fastlane/action'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    class CircleciDeleteEnvVarAction < Action
+      def self.run(params)
+        UI.message("Deleting environment variable for CircleCI project via API v2...")
+        
+        api_token = params[:api_token]
+        project_slug = params[:project_slug]
+        name = params[:name]
+        
+        # Make API request
+        Helper::CircleCiHelper.delete_v2("project/#{project_slug}/envvar/#{name}", api_token)
+        
+        UI.success("Successfully deleted environment variable '#{name}' for project #{project_slug}")
+        
+        return { success: true, name: name }
+      end
+
+      def self.description
+        "Deletes an environment variable for a CircleCI project using API v2"
+      end
+
+      def self.details
+        "This action deletes an environment variable for a specific CircleCI project using the CircleCI API v2."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :api_token,
+                                       env_name: "CIRCLE_CI_API_TOKEN",
+                                       description: "API Token for CircleCI API",
+                                       sensitive: true,
+                                       code_gen_sensitive: true,
+                                       is_string: true,
+                                       default_value: ENV["CIRCLE_CI_API_TOKEN"],
+                                       default_value_dynamic: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :project_slug,
+                                       env_name: "CIRCLE_CI_PROJECT_SLUG",
+                                       description: "Project slug in the form of :vcs-type/:org-name/:project-name (e.g. github/myorg/myrepo)",
+                                       is_string: true,
+                                       default_value: ENV["CIRCLE_CI_PROJECT_SLUG"],
+                                       default_value_dynamic: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :name,
+                                       env_name: "CIRCLE_CI_ENV_VAR_NAME",
+                                       description: "Name of the environment variable to delete",
+                                       is_string: true,
+                                       optional: false)
+        ]
+      end
+
+      def self.return_value
+        "Returns a hash with success status and name of the deleted environment variable."
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_delete_env_var(
+            project_slug: "github/myorg/myrepo",
+            name: "API_KEY"
+          )',
+          'circleci_delete_env_var(
+            project_slug: "github/myorg/myrepo",
+            name: "DEPLOY_ENVIRONMENT"
+          )'
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.category
+        :ci
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/circle_ci/actions/circleci_delete_pipeline_definition.rb

@@ -0,0 +1,91 @@
+require 'fastlane/action'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    class CircleciDeletePipelineDefinitionAction < Action
+      def self.run(params)
+        UI.message("Deleting CircleCI pipeline definition via API v2...")
+        
+        api_token = params[:api_token]
+        project_id = params[:project_id]
+        pipeline_definition_id = params[:pipeline_definition_id]
+        
+        # Make API request
+        result = Helper::CircleCiHelper.delete_v2("projects/#{project_id}/pipeline-definitions/#{pipeline_definition_id}", api_token)
+        
+        UI.success("Successfully deleted pipeline definition with ID #{pipeline_definition_id}")
+        
+        return result
+      end
+
+      def self.description
+        "Deletes a pipeline definition from CircleCI using API v2"
+      end
+
+      def self.details
+        "This action deletes a specific pipeline definition from CircleCI using the CircleCI API v2."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :api_token,
+                                       env_name: "CIRCLE_CI_API_TOKEN",
+                                       description: "API Token for CircleCI API",
+                                       sensitive: true,
+                                       code_gen_sensitive: true,
+                                       is_string: true,
+                                       default_value: ENV["CIRCLE_CI_API_TOKEN"],
+                                       default_value_dynamic: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :project_id,
+                                       env_name: "CIRCLE_CI_PROJECT_ID",
+                                       description: "The ID of the CircleCI project",
+                                       is_string: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :pipeline_definition_id,
+                                       description: "The ID of the pipeline definition to delete",
+                                       is_string: true,
+                                       optional: false)
+        ]
+      end
+
+      def self.return_value
+        "Returns a hash with a 'message' key indicating success or failure."
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_delete_pipeline_definition(
+            project_id: "01234567-89ab-cdef-0123-456789abcdef",
+            pipeline_definition_id: "fedcba98-7654-3210-fedc-ba9876543210"
+          )',
+          '# Get definitions first, then delete one
+          definitions = circleci_get_pipeline_definitions(
+            project_id: "01234567-89ab-cdef-0123-456789abcdef"
+          )
+          
+          # Delete the first definition
+          if definitions["items"].any?
+            circleci_delete_pipeline_definition(
+              project_id: "01234567-89ab-cdef-0123-456789abcdef",
+              pipeline_definition_id: definitions["items"].first["id"]
+            )
+          end'
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.category
+        :ci
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/circle_ci/actions/circleci_delete_pipeline_schedule.rb

@@ -0,0 +1,95 @@
+require 'fastlane/action'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    class CircleciDeletePipelineScheduleAction < Action
+      def self.run(params)
+        UI.message("Deleting CircleCI pipeline schedule via API v2...")
+        
+        api_token = params[:api_token]
+        project_slug = params[:project_slug]
+        schedule_id = params[:schedule_id]
+        
+        # Make API request
+        Helper::CircleCiHelper.delete_v2("project/#{project_slug}/schedule/#{schedule_id}", api_token)
+        
+        UI.success("Successfully deleted pipeline schedule with ID #{schedule_id}")
+        
+        return { success: true, schedule_id: schedule_id }
+      end
+
+      def self.description
+        "Deletes a pipeline schedule for a CircleCI project using API v2"
+      end
+
+      def self.details
+        "This action deletes a specific pipeline schedule for a CircleCI project using the CircleCI API v2."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :api_token,
+                                       env_name: "CIRCLE_CI_API_TOKEN",
+                                       description: "API Token for CircleCI API",
+                                       sensitive: true,
+                                       code_gen_sensitive: true,
+                                       is_string: true,
+                                       default_value: ENV["CIRCLE_CI_API_TOKEN"],
+                                       default_value_dynamic: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :project_slug,
+                                       env_name: "CIRCLE_CI_PROJECT_SLUG",
+                                       description: "Project slug in the form of :vcs-type/:org-name/:project-name (e.g. github/myorg/myrepo)",
+                                       is_string: true,
+                                       default_value: ENV["CIRCLE_CI_PROJECT_SLUG"],
+                                       default_value_dynamic: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :schedule_id,
+                                       env_name: "CIRCLE_CI_SCHEDULE_ID",
+                                       description: "The ID of the schedule to delete",
+                                       is_string: true,
+                                       optional: false)
+        ]
+      end
+
+      def self.return_value
+        "Returns a hash with success status and the deleted schedule ID."
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_delete_pipeline_schedule(
+            project_slug: "github/myorg/myrepo",
+            schedule_id: "0000-1111-2222-3333"
+          )',
+          '# First get all schedules, then delete a specific one
+          schedules = circleci_list_pipeline_schedules(
+            project_slug: "github/myorg/myrepo"
+          )
+          
+          nightly_build = schedules.find { |schedule| schedule["name"] == "Nightly Build" }
+          
+          if nightly_build
+            circleci_delete_pipeline_schedule(
+              project_slug: "github/myorg/myrepo",
+              schedule_id: nightly_build["id"]
+            )
+          end'
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.category
+        :ci
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/circle_ci/actions/circleci_delete_trigger.rb

@@ -0,0 +1,92 @@
+require 'fastlane/action'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    class CircleciDeleteTriggerAction < Action
+      def self.run(params)
+        UI.message("Deleting CircleCI trigger via API v2...")
+        
+        api_token = params[:api_token]
+        project_id = params[:project_id]
+        trigger_id = params[:trigger_id]
+        
+        # Make API request
+        result = Helper::CircleCiHelper.delete_v2("projects/#{project_id}/triggers/#{trigger_id}", api_token)
+        
+        UI.success("Successfully deleted trigger with ID #{trigger_id}")
+        
+        return result
+      end
+
+      def self.description
+        "Deletes a trigger from CircleCI using API v2"
+      end
+
+      def self.details
+        "This action deletes a specific trigger from CircleCI using the CircleCI API v2."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :api_token,
+                                       env_name: "CIRCLE_CI_API_TOKEN",
+                                       description: "API Token for CircleCI API",
+                                       sensitive: true,
+                                       code_gen_sensitive: true,
+                                       is_string: true,
+                                       default_value: ENV["CIRCLE_CI_API_TOKEN"],
+                                       default_value_dynamic: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :project_id,
+                                       env_name: "CIRCLE_CI_PROJECT_ID",
+                                       description: "The ID of the CircleCI project",
+                                       is_string: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :trigger_id,
+                                       description: "The ID of the trigger to delete",
+                                       is_string: true,
+                                       optional: false)
+        ]
+      end
+
+      def self.return_value
+        "Returns a hash with a 'message' key indicating success or failure."
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_delete_trigger(
+            project_id: "01234567-89ab-cdef-0123-456789abcdef",
+            trigger_id: "fedcba98-7654-3210-fedc-ba9876543210"
+          )',
+          '# Get triggers first, then delete one
+          triggers = circleci_list_pipeline_definition_triggers(
+            project_id: "01234567-89ab-cdef-0123-456789abcdef",
+            pipeline_definition_id: "aaaabbbb-cccc-dddd-eeee-ffff00001111"
+          )
+          
+          # Delete the first trigger
+          if triggers["items"].any?
+            circleci_delete_trigger(
+              project_id: "01234567-89ab-cdef-0123-456789abcdef",
+              trigger_id: triggers["items"].first["id"]
+            )
+          end'
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.category
+        :ci
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/circle_ci/actions/circleci_delete_webhook.rb

@@ -0,0 +1,86 @@
+require 'fastlane/action'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    class CircleciDeleteWebhookAction < Action
+      def self.run(params)
+        UI.message("Deleting CircleCI webhook via API v2...")
+        
+        api_token = params[:api_token]
+        webhook_id = params[:webhook_id]
+        
+        # Make API request
+        Helper::CircleCiHelper.delete_v2("webhook/#{webhook_id}", api_token)
+        
+        UI.success("Successfully deleted webhook with ID #{webhook_id}")
+        
+        return { success: true, webhook_id: webhook_id }
+      end
+
+      def self.description
+        "Deletes a webhook from CircleCI using API v2"
+      end
+
+      def self.details
+        "This action deletes a specific webhook from CircleCI using the CircleCI API v2."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :api_token,
+                                       env_name: "CIRCLE_CI_API_TOKEN",
+                                       description: "API Token for CircleCI API",
+                                       sensitive: true,
+                                       code_gen_sensitive: true,
+                                       is_string: true,
+                                       default_value: ENV["CIRCLE_CI_API_TOKEN"],
+                                       default_value_dynamic: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :webhook_id,
+                                       env_name: "CIRCLE_CI_WEBHOOK_ID",
+                                       description: "The ID of the webhook to delete",
+                                       is_string: true,
+                                       optional: false)
+        ]
+      end
+
+      def self.return_value
+        "Returns a hash with success status and the deleted webhook ID."
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_delete_webhook(
+            webhook_id: "webhook-uuid"
+          )',
+          '# First get all webhooks, then delete a specific one
+          webhooks = circleci_list_webhooks(
+            scope_id: "project-uuid",
+            scope_type: "project"
+          )
+          
+          slack_webhook = webhooks.find { |webhook| webhook["name"].include?("Slack") }
+          
+          if slack_webhook
+            circleci_delete_webhook(
+              webhook_id: slack_webhook["id"]
+            )
+          end'
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.category
+        :ci
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/circle_ci/actions/circleci_download_artifact.rb

@@ -0,0 +1,119 @@
+require 'fastlane/action'
+require 'faraday'
+require 'faraday/follow_redirects'
+require 'fileutils'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    class CircleciDownloadArtifactAction < Action
+      def self.run(params)
+        UI.message("Downloading CircleCI artifact...")
+        
+        artifact_url = params[:artifact_url]
+        destination_path = params[:destination_path]
+        api_token = params[:api_token]
+        
+        # Ensure the directory exists
+        FileUtils.mkdir_p(File.dirname(destination_path))
+        
+        # Configure Faraday
+        conn = Faraday.new do |f|
+          f.headers['Circle-Token'] = api_token if api_token
+          f.response :follow_redirects
+          f.adapter Faraday.default_adapter
+        end
+        
+        # Download the file
+        begin
+          response = conn.get(artifact_url)
+          
+          if response.status >= 200 && response.status < 300
+            # Write the response body to the destination file
+            File.binwrite(destination_path, response.body)
+            UI.success("Successfully downloaded artifact to #{destination_path}")
+            return { success: true, path: destination_path }
+          else
+            UI.error("Failed to download artifact: HTTP #{response.status} - #{response.body}")
+            return { success: false, error: "HTTP #{response.status}" }
+          end
+        rescue => e
+          UI.error("Error downloading artifact: #{e.message}")
+          return { success: false, error: e.message }
+        end
+      end
+
+      def self.description
+        "Downloads an artifact from CircleCI"
+      end
+
+      def self.details
+        "This action downloads an artifact from CircleCI to a local path. It works with artifacts from the CircleCI API v2."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :artifact_url,
+                                       env_name: "CIRCLE_CI_ARTIFACT_URL",
+                                       description: "URL of the artifact to download",
+                                       is_string: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :destination_path,
+                                       env_name: "CIRCLE_CI_ARTIFACT_DESTINATION",
+                                       description: "Local path where the artifact should be saved",
+                                       is_string: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :api_token,
+                                       env_name: "CIRCLE_CI_API_TOKEN",
+                                       description: "API Token for CircleCI API (only needed for private artifacts)",
+                                       sensitive: true,
+                                       code_gen_sensitive: true,
+                                       is_string: true,
+                                       default_value: ENV["CIRCLE_CI_API_TOKEN"],
+                                       default_value_dynamic: true,
+                                       optional: true)
+        ]
+      end
+
+      def self.return_value
+        "Returns a hash with success status and the path of the downloaded artifact or error information."
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_download_artifact(
+            artifact_url: "https://dl.circleci.com/private/output/job/12345/artifacts/0/path/to/artifact.zip",
+            destination_path: "./artifacts/build.zip"
+          )',
+          '# First get artifacts, then download a specific one
+          artifacts = circleci_get_job_artifacts(
+            project_slug: "github/myorg/myrepo",
+            job_number: "123"
+          )
+          
+          # Find and download a test results artifact
+          test_results = artifacts.find { |a| a["path"].end_with?("test-results.xml") }
+          
+          if test_results
+            circleci_download_artifact(
+              artifact_url: test_results["url"],
+              destination_path: "./test-results/circle-results.xml"
+            )
+          end'
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.category
+        :ci
+      end
+    end
+  end
+end