oraclebmc 2.0.4 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13c41c0392380175ee3c43643bd99e99c805d275
-  data.tar.gz: c2e5572fd95c89338dffa524d12e67f3d043b1a2
+  metadata.gz: a28198a99b195ebdd589c4218374c7218f0afcf7
+  data.tar.gz: 72c1ec046a5fc461b1c396a20af867c5dbfa5633
 SHA512:
-  metadata.gz: fc1be9a7f32c738ef13b152ae8d2b62ecb7493a56558c2ce9d049f63a113eea758e6f7fcb580850ac5c6ce0161bb675f42b526ce5f1f1c2cacd679b60fd80530
-  data.tar.gz: a6dc3c4aa2acb1b6b22cf6ebb75684abe883d20eed55d0be09af6fc3f2d6edd5b67ec503ab8f12ebac47a87cd9e0ef620f2613f38c59602d93835ee83bfc5bb7
+  metadata.gz: b53ad7d7aa505a6476401c1eff20137c23f74dc8a93f8e82d0e81cf8f2edb66a92fecb91db5944c0c99521f738eb606598af96100213e25b4f82b46ed03f12cc
+  data.tar.gz: 88a10ca661c45559ee193cc5499fca6d06b1373e95a95746d9210c7cfdfbbe36d868b3398517a50f060d8fafc87d0c9e6865725207f317eb656478939e759df4

data/LICENSE.txt

@@ -1,9 +1,9 @@
-Copyright (c) 2016, 2017, Oracle and/or its affiliates.  All rights reserved.
+Copyright (c) 2016, 2018, Oracle and/or its affiliates.  All rights reserved.
 
 This software is dual-licensed to you under the Universal Permissive License (UPL) and Apache License 2.0.  See below for license terms.  You may choose either license, or both.
  ____________________________
 The Universal Permissive License (UPL), Version 1.0
-Copyright (c) 2016, 2017, Oracle and/or its affiliates.  All rights reserved.
+Copyright (c) 2016, 2018, Oracle and/or its affiliates.  All rights reserved.
 
 Subject to the condition set forth below, permission is hereby granted to any person obtaining a copy of this software, associated documentation and/or data (collectively the "Software"), free of charge and under any and all copyright rights in the Software, and any and all patent rights owned or freely licensable by each licensor hereunder covering either (i) the unmodified Software as contributed to or provided by such licensor, or (ii) the Larger Works (as defined below), to deal in both
 
@@ -19,7 +19,7 @@ The above copyright notice and either this complete permission notice or at a mi
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 The Apache Software License, Version 2.0
-Copyright (c) 2016, 2017, Oracle and/or its affiliates.  All rights reserved.
+Copyright (c) 2016, 2018, Oracle and/or its affiliates.  All rights reserved.
 
 Licensed under the Apache License, Version 2.0 (the "License"); You may not use this product except in compliance with the License.  You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.  A copy of the license is also reproduced below.  Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the specific language governing permissions and  limitations under the License.
 

data/README_BMCS.md

@@ -1,5 +1,5 @@
 # Oracle Cloud Infrastructure Ruby SDK
-**Version 2.0.4**
+**Version 2.0.5**
 
 This topic describes how to install, configure, and use the Oracle Cloud Infrastructure Ruby SDK.
 
@@ -224,6 +224,72 @@ The following example shows how to launch an instance (which assumes that you al
     instance_id = response.data.id
     response = api.get_instance(instance_id).wait_until(:lifecycle_state, OracleBMC::Core::Models::Instance::LIFECYCLE_STATE_RUNNING)
 
+### Waiting for state using a proc/lambda
+Instead of waiting until the attribute of a resource reaches a given state, the `wait_until` method can also be passed a proc/lambda via its `eval_proc` keyword argument.
+Using `eval_proc` may be useful in situations where logic other than checking if an attribute has a certain value is needed, for example checking
+that an attribute is one of a possible set of values. `eval_proc` should take a single argument, which is the raw response received from the service call, and its result
+should be a truthy value if the waiter should stop waiting, and it should be falsey otherwise. If the `eval_proc` is provided, then neither the `property`
+nor `state` parameters should be provided.
+
+An example using a lambda is:
+
+    require 'oraclebmc'
+
+    request = OracleBMC::Core::Models::CreateVcnDetails.new
+    request.cidr_block = '10.0.0.0/16'
+    request.display_name = 'my_test_vcn'
+    request.compartment_id = compartment_id # TODO: set your compartment ID here
+
+    api = OracleBMC::Core::VirtualNetworkClient.new
+    response = api.create_vcn(request)
+    vcn_id = response.data.id
+
+    response = api.get_vcn(vcn.id).wait_until(eval_proc: lambda { |response| response.data.lifecycle_state == OracleBMC::Core::Models::Vcn::LIFECYCLE_STATE_AVAILABLE })
+
+An example using a proc is:
+
+    require 'oraclebmc'
+
+    request = OracleBMC::Core::Models::CreateVcnDetails.new
+    request.cidr_block = '10.0.0.0/16'
+    request.display_name = 'my_test_vcn'
+    request.compartment_id = compartment_id # TODO: set your compartment ID here
+
+    api = OracleBMC::Core::VirtualNetworkClient.new
+    response = api.create_vcn(request)
+    vcn_id = response.data.id
+
+    check_available_proc = Proc.new do |response|
+      [OracleBMC::Core::Models::Vcn::LIFECYCLE_STATE_AVAILABLE].include?(response.data.lifecycle_state)
+    end
+
+    response = api.get_vcn(vcn.id).wait_until(eval_proc: check_available_proc)
+
+### Waiting on terminated/deleted resources
+When waiting for a request to be terminated/deleted, there is a chance that doing a GET of that resource will return a 404 because the resource is no longer available. Instead
+of having to catch this, for example:
+
+    require 'oraclebmc'
+
+    api = OracleBMC::Core::VirtualNetworkClient.new
+    api.delete_vcn(vcn.id)
+
+    begin
+        api.get_vcn(vcn.id).wait_until(:lifecycle_state, OracleBMC::Core::Models::Vcn::LIFECYCLE_STATE_TERMINATED)
+    rescue OracleBMC::Errors::ServiceError => e
+        raise unless e.status_code == 404
+    end
+
+You can instruct the waiter to take care of this for you and consider that a 404 means success. For example:
+
+    require 'oraclebmc'
+
+    api = OracleBMC::Core::VirtualNetworkClient.new
+    api.delete_vcn(vcn.id)
+    api.get_vcn(vcn.id).wait_until(:lifecycle_state, OracleBMC::Core::Models::Vcn::LIFECYCLE_STATE_TERMINATED, succeed_on_not_found: true)
+
+Using the `succeed_on_not_found` keyword argument is likely only useful when waiting on temrinated/deleted resources.
+
 ### Signing a Raw Request
 The {OracleBMC::Signer} can be used to sign arbitrary requests to the Oracle Cloud Infrastructure Services. The following example uses Net::HTTP to call the IAM service directly.
 

data/lib/oraclebmc.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
 
 require 'oci'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oraclebmc
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.0.5
 platform: ruby
 authors:
 - Oracle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-11 00:00:00.000000000 Z
+date: 2018-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oci
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.4
+        version: 2.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.4
+        version: 2.0.5
 description: "Ruby SDK for Oracle Cloud Infrastructure. \n  \n    This gem is deprecated
   and will no longer be maintained starting March 2018. Please move to 'oci' (https://rubygems.org/gems/oci)
   instead to avoid interruption."