fastlane-plugin-circle_ci 0.2.0 → 0.3.0

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

@@ -0,0 +1,152 @@
+require 'fastlane/action'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      CIRCLECI_WAIT_RESULT = :CIRCLECI_WAIT_RESULT
+    end
+
+    class CircleciWaitForPipelineAction < Action
+      def self.run(params)
+        UI.message("Waiting for CircleCI pipeline to complete via API v2...")
+        
+        api_token = params[:api_token]
+        pipeline_id = params[:pipeline_id]
+        timeout = params[:timeout]
+        poll_interval = params[:poll_interval]
+        
+        start_time = Time.now
+        timeout_time = start_time + timeout
+        
+        loop do
+          # Check if we've timed out
+          if Time.now > timeout_time
+            UI.error("Timed out waiting for pipeline to complete after #{timeout} seconds")
+            return { 
+              success: false, 
+              status: "timeout", 
+              pipeline_id: pipeline_id,
+              waited: Time.now - start_time
+            }
+          end
+          
+          # Get pipeline info
+          result = Helper::CircleCiHelper.get_v2("pipeline/#{pipeline_id}", api_token)
+          
+          UI.verbose("Pipeline state: #{result["state"]}")
+          
+          # Return if the pipeline has reached a terminal state
+          if ["success", "failed", "error", "canceled"].include?(result["state"])
+            UI.success("Pipeline completed with state: #{result["state"]}")
+            
+            wait_result = { 
+              success: result["state"] == "success",
+              status: result["state"],
+              pipeline_id: pipeline_id,
+              waited: Time.now - start_time
+            }
+            
+            # Store values in lane context
+            Actions.lane_context[SharedValues::CIRCLECI_WAIT_RESULT] = wait_result
+            
+            return wait_result
+          end
+          
+          # Wait before polling again
+          UI.message("Pipeline #{pipeline_id} is still running (state: #{result["state"]}), waiting #{poll_interval} seconds...")
+          sleep(poll_interval)
+        end
+      end
+
+      def self.description
+        "Waits for a CircleCI pipeline to complete using API v2"
+      end
+
+      def self.details
+        "This action waits for a specific CircleCI pipeline to reach a terminal state (success, failed, error, or canceled) 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: :pipeline_id,
+                                       env_name: "CIRCLE_CI_PIPELINE_ID",
+                                       description: "The ID of the pipeline to wait for",
+                                       is_string: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :timeout,
+                                       env_name: "CIRCLE_CI_WAIT_TIMEOUT",
+                                       description: "Maximum time to wait for the pipeline to complete (in seconds)",
+                                       is_string: false,
+                                       default_value: 1800, # 30 minutes
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :poll_interval,
+                                       env_name: "CIRCLE_CI_POLL_INTERVAL",
+                                       description: "Time between status checks (in seconds)",
+                                       is_string: false,
+                                       default_value: 30,
+                                       optional: true)
+        ]
+      end
+
+      def self.output
+        [
+          ['CIRCLECI_WAIT_RESULT', 'A hash containing the wait result including success status and pipeline state']
+        ]
+      end
+
+      def self.return_value
+        "Returns a hash containing the wait result including success status, final pipeline state, pipeline ID, and time waited."
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_wait_for_pipeline(
+            pipeline_id: "12345-6789-abcd-ef01"
+          )',
+          'circleci_wait_for_pipeline(
+            pipeline_id: "12345-6789-abcd-ef01",
+            timeout: 3600,        # Wait up to 1 hour
+            poll_interval: 60     # Check every minute
+          )',
+          '# Trigger a pipeline and wait for it to complete
+          pipeline = circleci_trigger_pipeline(
+            project_slug: "github/myorg/myrepo",
+            branch: "main"
+          )
+          
+          result = circleci_wait_for_pipeline(
+            pipeline_id: pipeline["id"]
+          )
+          
+          if result[:success]
+            UI.success("Pipeline completed successfully!")
+          else
+            UI.error("Pipeline failed with status: #{result[:status]}")
+          end'
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.category
+        :ci
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/circle_ci/helper/circle_ci_helper.rb

@@ -1,16 +1,117 @@
 require 'fastlane_core/ui/ui'
+require 'faraday'
+require 'json'
 
 module Fastlane
   UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
 
   module Helper
     class CircleCiHelper
+      # Legacy v1.1 API support
       def self.execute(curl_command)
         response = Fastlane::Actions::sh("#{curl_command}", log: false)
 
-        require 'json'
         JSON.parse(response) || {}
       end
+
+      # CircleCI API v2 base URL
+      API_V2_BASE_URL = "https://circleci.com/api/v2".freeze
+
+      # Makes a GET request to CircleCI API v2
+      # @param path [String] The API endpoint path
+      # @param token [String] The CircleCI API token
+      # @param params [Hash] Optional query parameters
+      # @return [Hash] The parsed JSON response
+      def self.get_v2(path, token, params = {})
+        make_request(:get, path, token, nil, params)
+      end
+
+      # Makes a POST request to CircleCI API v2
+      # @param path [String] The API endpoint path
+      # @param token [String] The CircleCI API token
+      # @param body [Hash] The request body
+      # @return [Hash] The parsed JSON response
+      def self.post_v2(path, token, body = {})
+        make_request(:post, path, token, body)
+      end
+
+      # Makes a PUT request to CircleCI API v2
+      # @param path [String] The API endpoint path
+      # @param token [String] The CircleCI API token
+      # @param body [Hash] The request body
+      # @return [Hash] The parsed JSON response
+      def self.put_v2(path, token, body = {})
+        make_request(:put, path, token, body)
+      end
+
+      # Makes a DELETE request to CircleCI API v2
+      # @param path [String] The API endpoint path
+      # @param token [String] The CircleCI API token
+      # @return [Hash] The parsed JSON response
+      def self.delete_v2(path, token)
+        make_request(:delete, path, token)
+      end
+
+      # Makes a PATCH request to CircleCI API v2
+      # @param path [String] The API endpoint path
+      # @param token [String] The CircleCI API token
+      # @param body [Hash] The request body
+      # @return [Hash] The parsed JSON response
+      def self.patch_v2(path, token, body = {})
+        make_request(:patch, path, token, body)
+      end
+
+      # Makes an HTTP request to the CircleCI API v2
+      # @param method [Symbol] The HTTP method (:get, :post, :put, :delete, :patch)
+      # @param path [String] The API endpoint path
+      # @param token [String] The CircleCI API token
+      # @param body [Hash] The request body for POST, PUT, or PATCH requests
+      # @param params [Hash] Query parameters for GET requests
+      # @return [Hash] The parsed JSON response
+      def self.make_request(method, path, token, body = nil, params = {})
+        conn = Faraday.new(url: API_V2_BASE_URL) do |faraday|
+          faraday.headers['Circle-Token'] = token
+          faraday.headers['Content-Type'] = 'application/json'
+          faraday.headers['Accept'] = 'application/json'
+          faraday.adapter Faraday.default_adapter
+        end
+
+        begin
+          response = case method
+                     when :get
+                       conn.get(path, params)
+                     when :post
+                       conn.post(path) do |req|
+                         req.body = body.to_json if body
+                       end
+                     when :put
+                       conn.put(path) do |req|
+                         req.body = body.to_json if body
+                       end
+                     when :patch
+                       conn.patch(path) do |req|
+                         req.body = body.to_json if body
+                       end
+                     when :delete
+                       conn.delete(path)
+                     end
+
+          if response.status >= 200 && response.status < 300
+            response_body = response.body.empty? ? "{}" : response.body
+            JSON.parse(response_body)
+          else
+            error_msg = "CircleCI API error (#{response.status}): #{response.body}"
+            UI.error(error_msg)
+            raise error_msg
+          end
+        rescue Faraday::Error => e
+          UI.error("Network error: #{e.message}")
+          raise e
+        rescue JSON::ParserError => e
+          UI.error("JSON parsing error: #{e.message}")
+          raise e
+        end
+      end
     end
   end
 end

data/lib/fastlane/plugin/circle_ci/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module CircleCi
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-circle_ci
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Manish Rathi
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-06 00:00:00.000000000 Z
+date: 2025-05-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: faraday-follow_redirects
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -136,7 +164,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.150.1
-description: 
+description:
 email: manishrathi19902013@gmail.com
 executables: []
 extensions: []
@@ -145,6 +173,70 @@ files:
 - LICENSE
 - README.md
 - lib/fastlane/plugin/circle_ci.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_add_context_env_var.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_add_project_collaborator.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_approve_job.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_cancel_job.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_cancel_workflow.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_continue_pipeline.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_create_checkout_key.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_create_pipeline_definition.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_create_pipeline_definition_trigger.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_create_pipeline_schedule.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_create_project.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_create_webhook.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_delete_checkout_key.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_delete_context_env_var.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_delete_env_var.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_delete_pipeline_definition.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_delete_pipeline_schedule.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_delete_trigger.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_delete_webhook.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_download_artifact.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_download_workflow_artifacts.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_get_checkout_key.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_get_checkout_keys.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_get_context_env_vars.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_get_env_vars.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_get_flaky_tests.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_get_job_artifacts.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_get_job_details.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_get_job_tests.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_get_job_timeseries.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_get_my_pipelines.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_get_org_summary.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_get_pipeline.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_get_pipeline_by_number.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_get_pipeline_config.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_get_pipeline_definition.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_get_pipeline_definitions.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_get_pipeline_values.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_get_pipeline_workflows.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_get_project_branches.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_get_project_config.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_get_project_workflow_metrics.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_get_trigger.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_get_user_info.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_get_workflow.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_get_workflow_insights.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_get_workflow_job_metrics.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_get_workflow_jobs.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_get_workflow_runs.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_get_workflow_summary.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_get_workflow_test_metrics.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_list_all_pipelines.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_list_contexts.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_list_pipeline_definition_triggers.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_list_pipeline_schedules.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_list_projects.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_list_webhooks.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_rerun_workflow.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_set_env_var.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_trigger_pipeline.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_update_pipeline_definition.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_update_pipeline_schedule.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_update_trigger.rb
+- lib/fastlane/plugin/circle_ci/actions/circleci_wait_for_pipeline.rb
 - lib/fastlane/plugin/circle_ci/actions/download_circle_ci_artifact.rb
 - lib/fastlane/plugin/circle_ci/actions/get_circle_ci_artifacts.rb
 - lib/fastlane/plugin/circle_ci/actions/get_circle_ci_build_status.rb
@@ -155,7 +247,7 @@ homepage: https://github.com/crazymanish/fastlane-plugin-circle_ci
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -170,8 +262,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: "A fastlane plugin for Circle CI. \U0001F680"
 test_files: []