oraclebmc 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eadf1d620781e08138d8a7811b9d24dc4e24578e
-  data.tar.gz: 5b86dc50c09caab8529dd809c0ff926d046e4167
+  metadata.gz: 618bdb3d3d05f50343ba3ec7f8fc0088a4e76e74
+  data.tar.gz: bf6a43fc1c10492b661167faf7a92f06cf5e0e97
 SHA512:
-  metadata.gz: 9716566a50728b903a25557edcdb0c28a730a281a760a6d65ef0c7be5cf1dee3d2e0e54c2c35c50afbc0fc18b0e9e7ffa2873caa9ded1003b5bdd219a757a6eb
-  data.tar.gz: 1ec1a6c768736c6b5103782b7339b191680cddfa37c9d13198dcdda203b04349e4975ca4236a8ac5b6b87ca166b6b6009019cc2f61149221dd887d05c5350ea8
+  metadata.gz: c2cde2ee5b5c23b1450e59a537328a8cc0aa522e19f36a78a1134724e4cad75b9a379f6f1c0f4b89be47a4c4a76334e4037fc01eeb79a705cc861690c8c7122c
+  data.tar.gz: 1cf7d1c087d69c7abe12933ffe5d42c75a822da2bb68ad3b35df70b3160b297ae80ad9866080e36b6bae7a4e976a87837d4297e9a4db5edd340d5587cd1c9a8e

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2016, Oracle and/or its affiliates.  All rights reserved.
+Copyright (c) 2016, 2017, 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.
  ____________________________

data/README.md

@@ -1,13 +1,9 @@
 # Oracle Bare Metal Cloud Services Ruby SDK
+**Version 1.1.2**
 
 This topic describes how to install, configure, and use the Oracle Bare Metal Cloud Services Ruby SDK.
 
 ## SDK Overview
-Version 1.1.1
-
-What's new in this version?
-
-* Added support for stateless security list rules. See the change log in the download for more details.
 
 The Ruby SDK supports the following services:
 
@@ -17,7 +13,9 @@ The Ruby SDK supports the following services:
 
 **Licensing:** This SDK and sample is dual licensed under the Universal Permissive License 1.0 and the Apache License.
 
-The following table details some of the attributes of the SDK.
+
+## SDK Attributes
+The following table provides details about some of the attributes of the SDK.
 
 <table>
 <tbody>
@@ -56,7 +54,8 @@ The following table details some of the attributes of the SDK.
 </tbody>
 </table>
 
-## Requirements
+
+## SDK Requirements
 
 To use the Ruby SDK, you must have:
 
@@ -65,20 +64,29 @@ To use the Ruby SDK, you must have:
 * A keypair used for signing API requests, with the public key uploaded to Oracle. Only the user calling the API should be in possession of the private key. See the configuration information below.
 * Ruby version 2.2 or later running on Mac or Linux. Windows is not supported at this time.
 
-## Downloading and Installing the Gem File
+# Downloading and Installing the Gem File
+## Installing the SDK
+
+
+ Install from [RubyGems](https://rubygems.org/gems/oraclebmc):
 
-1. Run the following command if you're running one of these operating systems:
+ `gem install oraclebmc`
 
-    * For Oracle Enterprise Linux (OEL) or Red Hat Enterprise Linux (RHEL): `sudo yum upgrade curl`
-    * For Ubuntu: `sudo apt-get install libcurl3 libcurl3-dev`
+You can also [download the SDK](https://docs.us-phoenix-1.oraclecloud.com/tools/ruby/latest/download/oracle-bmcs-ruby-sdk.zip) as a zip file containing the gem file, examples, and documentation.
+
+ Install the gem with the following command:
  
-2. [Download the Ruby SDK](https://docs.us-phoenix-1.oraclecloud.com/tools/ruby/latest/download/oracle-bmcs-ruby-sdk.zip). It's a zip archive that contains the gem, documentation, examples, and licensing information.
 
-3. Install the gem with the following command:
+ `gem install oraclebmc-1.1.2.gem`
+
+
+The SDK depends on `libcurl`, which may need to be installed or upgraded on some operating systems to be compatible with Oracle Bare Metal Cloud Services. 
 
-	    gem install oraclebmc-1.1.1.gem
-   
    
+Use one of the following commands for your particular operating system in order to successfully make requests:
+
+ * For Oracle Linux (OL) or Red Hat Enterprise Linux (RHEL): `sudo yum upgrade curl`
+ * For Ubuntu: `sudo apt-get install libcurl3 libcurl3-dev`
 ### Troubleshooting an Installation
 If you see "Unable to resolve dependencies”, you can install the dependencies manually:
 	
@@ -117,10 +125,14 @@ You can also load a config file from a different location, and/or specify a diff
 
 Or you can create a {OracleBMC::Config Config} programmatically. Note that the global value {OracleBMC#config OracleBMC.config} will always attempt to load the DEFAULT profile from the default config file location (`~/.oraclebmc/config`), unless it has been explicitly set to another value.
 
+## Service Errors
+
+Any operation resulting in a service error will cause an exception of type OracleBMC::Errors::ServiceError to be thrown by the SDK. For information about common service errors returned by BMCS, see [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm). 
+
 ## Examples
 The example code in this section shows how various parts of the Ruby SDK work. More examples can be found in the SDK download.
 
-### Identity Operations
+### Management Operations on a User
 The following example runs create, read, update, and delete (CRUD) operations on users.
 
     require 'oraclebmc'
@@ -212,9 +224,31 @@ 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)
 
+### Signing a Raw Request
+The {OracleBMC::Signer} can be used to sign arbitrary requests to the Bare Metal Cloud Services. The following example uses Net::HTTP to call the IAM service directly.
+
+    require 'oraclebmc'
+    require 'net/http'
+
+    config = OracleBMC::ConfigFileLoader.load_config(config_file_location:my_config_file_location)
+    endpoint = OracleBMC::Regions.get_service_endpoint(config.region, :IdentityClient)
+
+    uri = URI(endpoint + '/20160918/users/' + config.user)
+    request = Net::HTTP::Get.new(uri)
+
+    signer = OracleBMC::Signer.new(config.user, config.fingerprint, config.tenancy, config.key_file, pass_phrase:my_private_key_pass_phrase)
+    signer.sign(:get, uri.to_s, request, nil)
+
+    result = Net::HTTP.start(uri.hostname, uri.port, :use_ssl => true) {|http|
+      http.request(request)
+    }
+
+    puts result.body
+
 ## Questions or Feedback?
 Ways to get in touch:
 
 * [Stack Overflow](https://stackoverflow.com/): Please use the [oracle-bmcs](https://stackoverflow.com/questions/tagged/oracle-bmcs) and [oracle-bmcs-ruby-sdk](https://stackoverflow.com/questions/tagged/oracle-bmcs-ruby-sdk) tags in your post
 * [Developer Tools section](https://community.oracle.com/community/cloud_computing/bare-metal/content?filterID=contentstatus%5Bpublished%5D~category%5Bdeveloper-tools%5D&filterID=contentstatus%5Bpublished%5D~objecttype~objecttype%5Bthread%5D) of the Oracle Cloud forums
-* [My Oracle Support](https://support.oracle.com)
+* [My Oracle Support](https://support.oracle.com)
+

data/lib/oraclebmc.rb

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

data/lib/oraclebmc/api_client.rb

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

data/lib/oraclebmc/config.rb

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

data/lib/oraclebmc/config_file_loader.rb

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

data/lib/oraclebmc/core/blockstorage_client.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2016 Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
 
 require "uri"
 require "logger"
@@ -46,10 +46,6 @@ module OracleBMC
 
       fail 'A region must be specified.' unless @region
 
-      if not OracleBMC::Regions.valid_region? region
-        logger.info "Unknown region '#{@region}', falling back to default endpoint format." if logger
-      end
-
       @endpoint = OracleBMC::Regions.get_service_endpoint(@region, :BlockstorageClient) + '/20160918'
       logger.info "BlockstorageClient endpoint set to '#{endpoint}'." if logger
     end

data/lib/oraclebmc/core/compute_client.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2016 Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
 
 require "uri"
 require "logger"
@@ -46,10 +46,6 @@ module OracleBMC
 
       fail 'A region must be specified.' unless @region
 
-      if not OracleBMC::Regions.valid_region? region
-        logger.info "Unknown region '#{@region}', falling back to default endpoint format." if logger
-      end
-
       @endpoint = OracleBMC::Regions.get_service_endpoint(@region, :ComputeClient) + '/20160918'
       logger.info "ComputeClient endpoint set to '#{endpoint}'." if logger
     end
@@ -571,9 +567,6 @@ module OracleBMC
     #   has been deleted and purged from the system, then a retry of the original creation request
     #   may be rejected).
     #   
-    # @option opts [String] :opc_host_serial For Oracle internal use only.
-    # @option opts [String] :opc_pool_name For Oracle internal use only.
-    # @option opts [String] :opc_vnic_id For Oracle internal use only.
     # @return [Response] A Response object with data of type OracleBMC::Core::Models::Instance
     def launch_instance(launch_instance_details, opts = {})
       logger.debug "Calling operation ComputeClient#launch_instance." if logger
@@ -584,9 +577,6 @@ module OracleBMC
 
       # Query Params
       query_params = {}
-      query_params[:'opc-host-serial'] = opts[:'opc_host_serial'] if opts[:'opc_host_serial']
-      query_params[:'opc-pool-name'] = opts[:'opc_pool_name'] if opts[:'opc_pool_name']
-      query_params[:'opc-vnic-id'] = opts[:'opc_vnic_id'] if opts[:'opc_vnic_id']
 
       # Header Params
       header_params = {}

data/lib/oraclebmc/core/core.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2016 Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
 
 module OracleBMC
   module Core

data/lib/oraclebmc/core/models/attach_i_scsi_volume_details.rb

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

data/lib/oraclebmc/core/models/attach_volume_details.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2016 Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
 
 require 'date'
 
@@ -27,9 +27,10 @@ module OracleBMC
     def self.get_subtype(object_hash)
       type = object_hash[:'type']
 
-      return 'OracleBMC::Core::Models::AttachIScsiVolumeDetails' if not type or type == 'iscsi'
+      return 'OracleBMC::Core::Models::AttachIScsiVolumeDetails' if type == 'iscsi'
 
-      fail 'Could not resolve subtype type based on the object hash.'
+      # TODO: Log a warning when the subtype is not found.
+      return 'OracleBMC::Core::Models::AttachVolumeDetails'
     end
 
     # Initializes the object

data/lib/oraclebmc/core/models/capture_console_history_details.rb

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

data/lib/oraclebmc/core/models/console_history.rb

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

data/lib/oraclebmc/core/models/cpe.rb

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

data/lib/oraclebmc/core/models/create_cpe_details.rb

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

data/lib/oraclebmc/core/models/create_dhcp_details.rb

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

data/lib/oraclebmc/core/models/create_drg_attachment_details.rb

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

data/lib/oraclebmc/core/models/create_drg_details.rb

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

data/lib/oraclebmc/core/models/create_image_details.rb

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

data/lib/oraclebmc/core/models/create_internet_gateway_details.rb

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

data/lib/oraclebmc/core/models/create_ip_sec_connection_details.rb

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

data/lib/oraclebmc/core/models/create_route_table_details.rb

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

data/lib/oraclebmc/core/models/create_security_list_details.rb

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

data/lib/oraclebmc/core/models/create_subnet_details.rb

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

data/lib/oraclebmc/core/models/create_vcn_details.rb

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

data/lib/oraclebmc/core/models/create_volume_backup_details.rb

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

data/lib/oraclebmc/core/models/create_volume_details.rb

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

data/lib/oraclebmc/core/models/dhcp_dns_option.rb

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

data/lib/oraclebmc/core/models/dhcp_option.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2016 Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
 
 require 'date'
 
@@ -13,9 +13,10 @@ module OracleBMC
     def self.get_subtype(object_hash)
       type = object_hash[:'type']
 
-      return 'OracleBMC::Core::Models::DhcpDnsOption' if not type or type == 'DomainNameServer'
+      return 'OracleBMC::Core::Models::DhcpDnsOption' if type == 'DomainNameServer'
 
-      fail 'Could not resolve subtype type based on the object hash.'
+      # TODO: Log a warning when the subtype is not found.
+      return 'OracleBMC::Core::Models::DhcpOption'
     end
 
     # Initializes the object

data/lib/oraclebmc/core/models/dhcp_options.rb

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

data/lib/oraclebmc/core/models/drg.rb

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

data/lib/oraclebmc/core/models/drg_attachment.rb

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

data/lib/oraclebmc/core/models/egress_security_rule.rb

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

data/lib/oraclebmc/core/models/i_scsi_volume_attachment.rb

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

data/lib/oraclebmc/core/models/icmp_options.rb

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

data/lib/oraclebmc/core/models/image.rb

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

data/lib/oraclebmc/core/models/ingress_security_rule.rb

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