oci 2.2.1 → 2.3.0

data/lib/oci/load_balancer/util.rb

@@ -13,43 +13,30 @@ module OCI
       # @param [Integer] max_wait_seconds The maximum total time to wait, in seconds.
       # @param [Boolean] raise_error_on_failure If true, then a WorkRequestFailedError will be
       # raised if the work request is in a failed state.
-      # @return [WorkRequest] The final work request
+      # @return [OCI::Response] A {OCI::Response} object containing the completed
+      # {OCI::LoadBalancer::Models::WorkRequest}
       def self.wait_on_work_request(client,
                                     work_request_id,
                                     max_interval_seconds: 30,
                                     max_wait_seconds: 1200,
                                     raise_error_on_failure: true)
-        raise 'Work request ID not specified.' unless work_request_id
-
-        interval_seconds = 1
-        start_time = Time.now
-
-        loop do
-          response = client.get_work_request(work_request_id)
-          lifecycle_state = response.data.lifecycle_state
-
-          return response.data if lifecycle_state == OCI::LoadBalancer::Models::WorkRequest::LIFECYCLE_STATE_SUCCEEDED
-
-          if response.data.lifecycle_state == OCI::LoadBalancer::Models::WorkRequest::LIFECYCLE_STATE_FAILED
-            raise OCI::Errors::WorkRequestFailedError, response.data if raise_error_on_failure
-            return response.data
-          end
-
-          elapsed_seconds = (Time.now - start_time).to_i
-
-          if elapsed_seconds + interval_seconds > max_wait_seconds
-            raise OCI::Errors::MaximumWaitTimeExceededError, 'Maximum wait time has been exceeded.' \
-              unless max_wait_seconds > elapsed_seconds
-
-            # Make one last request right at the maximum wait time.
-            interval_seconds = max_wait_seconds - elapsed_seconds
-          end
-
-          sleep(interval_seconds)
-
-          interval_seconds *= 2
-          interval_seconds = max_interval_seconds if interval_seconds > max_interval_seconds
-        end
+        OCI::Waiter::WorkRequest.wait_for_state(
+          client,
+          work_request_id,
+          lambda do |work_request|
+            work_request.lifecycle_state == OCI::LoadBalancer::Models::WorkRequest::LIFECYCLE_STATE_SUCCEEDED
+          end,
+          lambda do |work_request|
+            is_failed_state = work_request.lifecycle_state == \
+              OCI::LoadBalancer::Models::WorkRequest::LIFECYCLE_STATE_FAILED
+            raise OCI::Errors::WorkRequestFailedError.new(work_request, work_request.lifecycle_state) \
+              if raise_error_on_failure && is_failed_state
+
+            is_failed_state
+          end,
+          max_interval_seconds: max_interval_seconds,
+          max_wait_seconds: max_wait_seconds
+        )
       end
     end
   end

data/lib/oci/regions.rb

@@ -29,7 +29,8 @@ module OCI
       Auth: 'auth',
       DnsClient: 'dns',
       FileStorageClient: 'filestorage',
-      EmailClient: 'email'
+      EmailClient: 'email',
+      ContainerEngineClient: 'containerengine'
     }.freeze
 
     # Returns an endpoint for the given region and service.

data/lib/oci/version.rb

@@ -1,5 +1,5 @@
 # Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
 
 module OCI
-  VERSION = '2.2.1'.freeze
+  VERSION = '2.3.0'.freeze
 end

data/lib/oci/waiter.rb

@@ -15,6 +15,53 @@ module OCI
       # waiter to fail with this exception.
       class WaiterFailedError < RuntimeError; end
     end
+
+    # Work request waiter utility method.
+    module WorkRequest
+      # Wait until the work request succeeds or fails, or max_wait_seconds is reached.
+      # The work request will be polled at an increasing rate, with a maximum of
+      # max_interval_seconds between requests.
+      #
+      # @param [Client] client A client that is able to call get_work_request()
+      # @param [String] work_request_id, the work request identifier
+      # @param [Proc] eval_success_proc the proc to evaluate if a wait condition has succeeded.
+      # @param [Proc] eval_error_proc the proc to evaluate if an error based terminal condition has occurred.
+      # @param [Integer] max_interval_seconds The maximum interval between queries, in seconds.
+      # @param [Integer] max_wait_seconds The maximum total time to wait, in seconds.
+      # @return [OCI::Response] A {OCI::Response} object containing the completed work request
+      def self.wait_for_state(client,
+                              work_request_id,
+                              eval_success_proc = nil,
+                              eval_error_proc = nil,
+                              max_interval_seconds: 30,
+                              max_wait_seconds: 1200)
+        raise 'Work request ID not specified.' unless work_request_id
+        raise 'Evaluation proc for determining success not specified' unless eval_success_proc
+        interval_seconds = 1
+        start_time = Time.now
+
+        loop do
+          response = client.get_work_request(work_request_id)
+          return response if eval_success_proc && eval_success_proc.call(response.data)
+          return response if eval_error_proc && eval_error_proc.call(response.data)
+
+          elapsed_seconds = (Time.now - start_time).to_i
+
+          if elapsed_seconds + interval_seconds > max_wait_seconds
+            raise OCI::Errors::MaximumWaitTimeExceededError, 'Maximum wait time has been exceeded.' \
+              unless max_wait_seconds > elapsed_seconds
+
+            # Make one last request right at the maximum wait time.
+            interval_seconds = max_wait_seconds - elapsed_seconds
+          end
+
+          sleep(interval_seconds)
+
+          interval_seconds *= 2
+          interval_seconds = max_interval_seconds if interval_seconds > max_interval_seconds
+        end
+      end
+    end
   end
 
   # Adds to the Response class in lib/oci/response.rb to define wait behavior

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oci
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Oracle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-31 00:00:00.000000000 Z
+date: 2018-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -176,6 +176,38 @@ files:
 - "./lib/oci/base_signer.rb"
 - "./lib/oci/config.rb"
 - "./lib/oci/config_file_loader.rb"
+- "./lib/oci/container_engine/container_engine.rb"
+- "./lib/oci/container_engine/container_engine_client.rb"
+- "./lib/oci/container_engine/container_engine_client_composite_operations.rb"
+- "./lib/oci/container_engine/models/add_on_options.rb"
+- "./lib/oci/container_engine/models/cluster.rb"
+- "./lib/oci/container_engine/models/cluster_create_options.rb"
+- "./lib/oci/container_engine/models/cluster_endpoints.rb"
+- "./lib/oci/container_engine/models/cluster_lifecycle_state.rb"
+- "./lib/oci/container_engine/models/cluster_metadata.rb"
+- "./lib/oci/container_engine/models/cluster_options.rb"
+- "./lib/oci/container_engine/models/cluster_summary.rb"
+- "./lib/oci/container_engine/models/create_cluster_details.rb"
+- "./lib/oci/container_engine/models/create_cluster_kubeconfig_content_details.rb"
+- "./lib/oci/container_engine/models/create_node_pool_details.rb"
+- "./lib/oci/container_engine/models/key_value.rb"
+- "./lib/oci/container_engine/models/kubernetes_network_config.rb"
+- "./lib/oci/container_engine/models/node.rb"
+- "./lib/oci/container_engine/models/node_error.rb"
+- "./lib/oci/container_engine/models/node_pool.rb"
+- "./lib/oci/container_engine/models/node_pool_options.rb"
+- "./lib/oci/container_engine/models/node_pool_summary.rb"
+- "./lib/oci/container_engine/models/sort_order.rb"
+- "./lib/oci/container_engine/models/update_cluster_details.rb"
+- "./lib/oci/container_engine/models/update_node_pool_details.rb"
+- "./lib/oci/container_engine/models/work_request.rb"
+- "./lib/oci/container_engine/models/work_request_error.rb"
+- "./lib/oci/container_engine/models/work_request_log_entry.rb"
+- "./lib/oci/container_engine/models/work_request_operation_type.rb"
+- "./lib/oci/container_engine/models/work_request_resource.rb"
+- "./lib/oci/container_engine/models/work_request_status.rb"
+- "./lib/oci/container_engine/models/work_request_summary.rb"
+- "./lib/oci/container_engine/util.rb"
 - "./lib/oci/core/blockstorage_client.rb"
 - "./lib/oci/core/blockstorage_client_composite_operations.rb"
 - "./lib/oci/core/compute_client.rb"