oci 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 488c00cdc5eeffc80b243c41eda2e48a3a636d13
+  data.tar.gz: dc295148c7edd143d92421cfbe7a4b11c95711e6
+SHA512:
+  metadata.gz: a012d576d2f27aebeef2e26ea37ec52038e51a550aa73b684a816e73c109b2b6686195ac4ebd7c996e6a891a9b4941a71b1ab5ae03a7fc16af758fd3bbf19869
+  data.tar.gz: 27faeab73bd7fa8359969ce79a54b830597ac310bbe590b294b556759d289ca51581e5d6cabeefc3445304e3657292e875dfa17862517af6df32d74fa4256253

data/LICENSE.txt

@@ -0,0 +1,82 @@
+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.
+ ____________________________
+The Universal Permissive License (UPL), Version 1.0
+Copyright (c) 2016, 2017, 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
+
+(a) the Software, and
+(b) any piece of software and/or hardware listed in the lrgrwrks.txt file if one is included with the Software (each a "Larger Work" to which the Software is contributed by such licensors),
+
+without restriction, including without limitation the rights to copy, create derivative works of, display, perform, and distribute the Software and make, use, sell, offer for sale, import, export, have made, and have sold the Software and the Larger Work(s), and to sublicense the foregoing rights on either these or other terms.
+
+This license is subject to the following condition:
+
+The above copyright notice and either this complete permission notice or at a minimum a reference to the UPL must be included in all copies or substantial portions of the Software.
+
+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.
+
+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.
+
+Apache License
+
+Version 2.0, January 2004
+
+http://www.apache.org/licenses/
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+1. Definitions.
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+You must give any other recipients of the Work or Derivative Works a copy of this License; and
+You must cause any modified files to carry prominent notices stating that You changed the files; and
+You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   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.md

@@ -0,0 +1,262 @@
+# Oracle Cloud Infrastructure Ruby SDK
+**Version 2.0.0**
+
+This topic describes how to install, configure, and use the Oracle Cloud Infrastructure Ruby SDK.
+
+## SDK Overview
+
+The Ruby SDK supports the following services:
+
+* Core Services (which includes Networking Service, Compute Service, and Block Volume Service)
+* Identity and Access Management Service
+* Load Balancing Service
+* Object Storage Service
+
+**Licensing:** This SDK and sample is dual licensed under the Universal Permissive License 1.0 and the Apache License.
+
+
+## SDK Attributes
+The following table provides details about some of the attributes of the SDK.
+
+<table>
+<tbody>
+	<tr>
+		<td>Requests</td>
+		<td>API methods expose required parameters as arguments and optional arguments as a hash (opts = {}). Create and update operations take request objects that mirror the properties of those objects.</td>
+	</tr>
+	<tr>
+		<td>Responses</td>
+		<td>All API methods return a Response object, which contains an HTTP status (200, 204, etc), headers, and data, and also directly exposes some commonly used response headers such as <code>opc-next_page</code>, and <code>opc-request_id</code>.</td>
+	</tr>
+	<tr>
+		<td>Models</td>
+		<td>Get, update, and create operations return first class objects of the corresponding type (such as User, Instance, etc) in Response.data.</td>
+	</tr>
+	<tr>
+		<td>Errors</td>
+		<td>Unsuccessful requests will always raise an exception. {OCI::Errors::ServiceError ServiceError} is raised when the service returns an error, and {OCI::Errors::NetworkError NetworkError} is raised for network issues (such as failed host resolution).</td>
+	</tr>
+    <tr>
+		<td>Signing</td>
+		<td>Requests made through the API classes are automatically signed, but you can also use the {OCI::Signer Signer} directly to sign your own requests if needed.</td>
+	</tr>
+	<tr>
+		<td>Automatic Paging</td>
+		<td>Response objects for lists support {OCI::Response#each page enumeration}. See example code later in this file.</td>
+	</tr>
+	<tr>
+		<td>Waiters</td>
+		<td>Responses for get requests support waiting for a particular states using {OCI::Response#wait_until wait_until}. See example code later in this file.</td>
+	</tr>
+	<tr>
+		<td>HTTP Client</td>
+		<td>The Ruby SDK uses Net::HTTP for HTTP requests, if needed, options may be passed to each Net::HTTP by specifying them in {OCI::ApiClient#request_option_overrides ApiClient.request_option_overrides}.</br>
+		Please check http://ruby-doc.org/stdlib-2.4.1/libdoc/net/http/rdoc/Net/HTTP.html#method-c-start for the supported options.</td>
+	</tr>
+</tbody>
+</table>
+
+
+## SDK Requirements
+
+To use the Ruby SDK, you must have:
+
+* An Oracle Cloud Infrastructure account.
+* A user created in that account, in a group with a policy that grants the desired permissions. This can be a user for yourself, or another person/system that needs to call the API. For an example of how to set up a new user, group, compartment, and policy, see [Adding Users](https://docs.us-phoenix-1.oraclecloud.com/Content/GSG/Tasks/addingusers.htm) in the Getting Started Guide. For a list of typical policies you may want to use, see [Common Policies](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/commonpolicies.htm) in the User Guide.
+* 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
+## Installing the SDK
+
+
+ Install from [RubyGems](https://rubygems.org/gems/oci):
+
+ `gem install oci`
+
+You can also [download the SDK](https://docs.us-phoenix-1.oraclecloud.com/tools/ruby/latest/download/oci-ruby-sdk.zip) as a zip file containing the gem file, examples, and documentation.
+
+ Install the gem with the following command:
+ 
+
+ `gem install oci-*.gem`
+
+### Troubleshooting an Installation
+If you see "Unable to resolve dependencies”, you can install the dependencies manually:
+	
+	gem install inifile
+
+## SDK modules and namespacing
+The top level module name for the Ruby SDK is `OCI`, however using `OracleBMC` as the top level namespace is also supported. For example, you can reference the configuration object as both `OCI::Config` and `OracleBMC::Config`. 
+
+Using `OCI` as the top level module name is preferred and it is also used in the SDK API Reference. Additionally, if you inspect the type of an SDK object it will always be reported as being under the `OCI::` module.
+
+## Configuring the SDK
+
+To use any of the APIs, you must supply a {OCI::Config Config} object. You can create the object directly in code, or you can create one in a config file. The configuration includes:
+
+* Required credentials and settings: See [SDK and Tool Configuration](https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/sdkconfig.htm) in the User Guide.
+* Optional SDK-specific settings: See the {OCI::Config Config} object for the full list of config options.
+
+## Forward Compatibility
+
+Some response fields are enum-typed. In the future, individual services may return values not covered by existing enums for that field. To address this possibility, every enum-type response field has an additional value named "UNKNOWN_ENUM_VALUE". If a service returns a value that is not recognized by your version of the SDK, then the response field will be set to this value. Please ensure that your code handles the "UNKNOWN_ENUM_VALUE" case if you have conditional logic based on an enum-typed field. 
+
+## Writing Your First Ruby Program with the SDK
+
+    require 'oci'
+
+    # This will load the config file at the default location, and will
+    # use the tenancy from that config as the compartment in the
+    # call to list_users.
+    api = OCI::Identity::IdentityClient.new(region: OCI::Regions::REGION_US_PHOENIX_1)
+    response = api.list_users(OCI.config.tenancy)
+    response.data.each { |user| puts user.name }
+
+## Loading Alternate Configurations
+
+You can also load a config file from a different location, and/or specify a different profile from the config file:
+
+    require 'oci'
+
+    my_config = OCI::ConfigFileLoader.load_config(config_file_location:'my_config', profile_name:'USER_TWO')
+    api = OCI::Identity::IdentityClient.new(config:my_config)
+    response = api.get_user(my_config.user)
+    puts 'User Name: ' + response.data.name
+
+Or you can create a {OCI::Config Config} programmatically. Note that the global value {OCI#config OCI.config} will always attempt to load the DEFAULT profile from the default config file location unless it has been explicitly set to another value.
+
+The default config file location is `~/.oci/config` (on Windows `C:\Users\{user}\.oci\config`).
+
+## Service Errors
+
+Any operation resulting in a service error will cause an exception of type OCI::Errors::ServiceError to be thrown by the SDK. For information about common service errors returned by OCI, 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.
+
+### Management Operations on a User
+The following example runs create, read, update, and delete (CRUD) operations on users.
+
+    require 'oci'
+
+    compartment = OCI.config.tenancy
+
+    api = OCI::Identity::IdentityClient.new
+    users = api.list_users(compartment_id = compartment).data
+    puts "There are currently " + users.length.to_s + " users."
+
+    # Create User
+    request = OCI::Identity::Models::CreateUserDetails.new
+    request.compartment_id = compartment
+    request.name = "userA"
+    request.description = "example user"
+    response =  api.create_user(request)
+
+    puts "Created user " + response.data.name
+    user_id = response.data.id
+
+    users = api.list_users(compartment_id = compartment).data
+    puts "There are now " + users.length.to_s + " users."
+
+    # Get User
+    response =  api.get_user(user_id = user_id)
+
+    # Update User (using a request object)
+    newDescription = "updated user description"
+    request = OCI::Identity::Models::UpdateUserDetails.new
+    request.description = "Updated description"
+    response = api.update_user(user_id, request)
+
+    puts "Updated description to:" + response.data.description
+
+    # Update User (using a hash)
+    newDescription = "updated without a request object"
+    response = api.update_user(user_id, { description: "Updated again, but using a hash instead of an object." })
+
+    # Delete User
+    api.delete_user(user_id)
+
+    users = api.list_users(compartment_id = compartment).data
+    puts "Back to " + users.length.to_s + " users."
+
+### Paging Through Results
+The following example shows how to page through results. It also gives an example of supplying optional parameters.
+
+    require 'oci'
+
+    api = OCI::Identity::IdentityClient.new
+    compartment = OCI.config.tenancy
+
+    ### Automatic paging:
+    api.list_users(compartment, limit:'3').each { |r| r.data.each { |user| puts user.name }}
+
+    ### Manual paging:
+    request_number = 0
+    next_page = nil
+
+    loop do
+      response = api.list_users(compartment, {limit: '3', page: next_page})
+
+      puts "Page " + request_number.to_s
+      response.data.each { |user| puts user.name }
+
+      break unless response.has_next_page?
+      next_page = response.next_page
+      request_number += 1
+    end
+
+### Launching an Instance and Waiting for a State
+The following example shows how to launch an instance (which assumes that you already have a subnet created), and then wait until the instance is running.
+
+    require 'oci'
+
+    ssh_public_key = File.open(File.expand_path(public_key_file), "rb").read
+
+    request = OCI::Core::Models::LaunchInstanceDetails.new
+    request.availability_domain = availability_domain # TODO: Set an availability domain, such as 'kIdk:PHX-AD-2'
+    request.compartment_id = compartment_id # TODO: set your compartment ID here
+    request.display_name = 'my_instance'
+    request.image_id = image_id # TODO: set your image ID here. You can see the available options with list_images.
+    request.shape = shape # TODO: set your instance shape. You can see the available options with list_shapes.
+    request.subnet_id = subnet_id # TODO: set your subnet ID here
+    request.metadata = {'ssh_authorized_keys' => ssh_public_key}
+
+    api = OCI::Core::ComputeClient.new
+    response = api.launch_instance(request)
+    instance_id = response.data.id
+    response = api.get_instance(instance_id).wait_until(:lifecycle_state, OCI::Core::Models::Instance::LIFECYCLE_STATE_RUNNING)
+
+### Signing a Raw Request
+The {OCI::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.
+
+    require 'oci'
+    require 'net/http'
+
+    config = OCI::ConfigFileLoader.load_config(config_file_location:my_config_file_location)
+    endpoint = OCI::Regions.get_service_endpoint(config.region, :IdentityClient)
+
+    uri = URI(endpoint + '/20160918/users/' + config.user)
+    request = Net::HTTP::Get.new(uri)
+
+    signer = OCI::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
+
+## Notifications
+To be notified when a new version of the Ruby SDK is released, subscribe to the [Atom feed](https://rubygems.org/gems/oci/versions.atom).
+
+## Questions or Feedback?
+Ways to get in touch:
+
+* [Stack Overflow](https://stackoverflow.com/): Please use the [oracle-cloud-infrastructure](https://stackoverflow.com/questions/tagged/oracle-cloud-infrastructure) and [oci-ruby-sdk](https://stackoverflow.com/questions/tagged/oci-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)
+
+
+

data/lib/oci.rb

@@ -0,0 +1,25 @@
+# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
+
+require 'oci/api_client'
+require 'oci/config'
+require 'oci/config_file_loader'
+require 'oci/errors'
+require 'oci/global_context'
+require 'oci/internal/internal'
+require 'oci/regions'
+require 'oci/response_headers'
+require 'oci/response'
+require 'oci/signer'
+require 'oci/version'
+require 'oci/waiter'
+
+require 'oci/core/core'
+require 'oci/identity/identity'
+require 'oci/load_balancer/load_balancer'
+require 'oci/object_storage/object_storage'
+
+# Top level module for the Oracle Cloud Infrastructure SDK
+module OCI
+end
+
+OracleBMC = OCI

data/lib/oci/api_client.rb

@@ -0,0 +1,389 @@
+# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
+
+require 'date'
+require 'json'
+require 'logger'
+require 'net/http'
+require 'securerandom'
+require 'tempfile'
+require 'uri'
+
+require_relative 'signer'
+require_relative 'version'
+require_relative 'response'
+
+module OCI
+  class ApiClient
+    # The Config object holding settings to be used in the API client.
+    attr_accessor :config
+
+    # Defines the headers to be used in HTTP requests of all API calls by default.
+    #
+    # @return [Hash]
+    attr_accessor :default_headers
+
+    # Request options to be sent with Net::HTTP.
+    # These options will override any defaults normally set by ApiClient.
+    # See {http://ruby-doc.org/stdlib-2.4.1/libdoc/net/http/rdoc/Net/HTTP.html#method-c-start} for
+    # some of the available options.
+    #
+    # @return [Hash]
+    attr_accessor :request_option_overrides
+
+    def initialize(config, signer)
+      raise "Missing the required parameter 'config' when initializing ApiClient." if config.nil?
+      raise "Missing the required parameter 'signer' when initializing ApiClient." if signer.nil?
+
+      @config = config
+      @signer = signer
+      @default_headers = {}
+      @request_option_overrides = {}
+    end
+
+    # Call an API with given options.
+    #
+    # @param [Symbol] http_method HTTP method/verb (e.g. :post, :get)
+    # @param [String] path URL path (e.g. /volumeAttachments/)
+    # @param [String] endpoint URL of the endpoint (e.g https://iaas.us-phoenix-1.oraclecloud.com/20160918)
+    # @option opts [Hash] :header_params Header parameters
+    # @option opts [Hash] :query_params Query parameters
+    # @option opts [Hash] :form_params Form parameters
+    # @option opts [Object] :body HTTP body in JSON
+    # @option [Block] block Allow to receive data from http body as streaming
+    #
+    # @return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:
+    #   the data deserialized from response body (could be nil), response status code,
+    #   and response headers.
+    def call_api(http_method, path, endpoint, opts, &block)
+      http_method = http_method.to_sym.downcase
+
+      return call_api_inner(http_method, path, endpoint, opts, &block) unless http_method == :get
+
+      # Wrap get calls in a lambda that can be called later for paging
+      # and wait_until.
+      proc = lambda { |page|
+        unless page.nil?
+          opts[:query_params] ||= {}
+          opts[:query_params][:page] = page
+        end
+
+        return call_api_inner(http_method, path, endpoint, opts, &block)
+      }
+
+      response = proc.call(nil)
+      response.api_call = proc
+      response
+    end
+
+    # Convert object (array, hash, object, etc) to JSON string.
+    # @param [Object] model object to be converted into JSON string
+    # @return [String] JSON string representation of the object
+    def object_to_http_body(model)
+      # to support IO-like object as well like StringIO
+      return model if model.nil? || model.is_a?(String) || (model.respond_to?(:read) && model.respond_to?(:write))
+      if model.is_a?(Array)
+        local_body = model.map{|m| object_to_hash(m) }
+      else
+        local_body = object_to_hash(model)
+      end
+      local_body.to_json
+    end
+
+    # Builds the client info string to be sent with each request.
+    def build_request_id
+      return SecureRandom.uuid.gsub!('-', '').upcase
+    end
+
+    # Builds the client info string to be sent with each request.
+    def build_user_info
+      return "Oracle-RubySDK/#{VERSION}"
+    end
+
+    # Build the user agent string to be send with each request.
+    def build_user_agent
+      agent = "#{build_user_info} (ruby #{RUBY_VERSION}; #{RUBY_PLATFORM})"
+
+      if config.additional_user_agent
+        agent = "#{agent} #{config.additional_user_agent}"
+      end
+
+      agent
+    end
+
+    private
+
+    def call_api_inner(http_method, path, endpoint, opts, &block)
+      query_params = opts[:query_params] || {}
+      header_params = @default_headers.merge(opts[:header_params] || {})
+      form_params = opts[:form_params] || {}
+      body = opts[:body] || nil
+
+      url = ApiClient.append_query_params(build_request_url(path, endpoint), query_params)
+      uri = URI(url)
+
+      request = nil
+
+      if http_method == :get
+        request = Net::HTTP::Get.new(uri)
+      elsif http_method == :put
+        request = Net::HTTP::Put.new(uri)
+      elsif http_method == :post
+        request = Net::HTTP::Post.new(uri)
+      elsif http_method == :delete
+        request = Net::HTTP::Delete.new(uri)
+      elsif http_method == :head
+        request = Net::HTTP::Head.new(uri)
+      else
+        fail "new http method (#{http_method}) needs to be supported!"
+      end
+
+      if body.respond_to?(:read) && body.respond_to?(:write)
+        request.body_stream = body
+      else
+        if %i[post, put, delete].include?(http_method)
+          body = build_request_body(header_params, form_params, body)
+        end
+
+        request.body = body
+      end
+
+      if @config.logger
+        @config.logger.debug "HTTP request body param ~BEGIN~\n#{body}\n~END~\n"
+      end
+
+      @signer.sign(http_method, url, header_params, body)
+
+      header_params.each do |key, value|
+        request[key.to_s] = value
+      end
+
+      request['opc-client-info'] = build_user_info
+      request['opc-request-id'] ||= build_request_id
+      request['User-Agent'] = build_user_agent
+
+      http = Net::HTTP.new(uri.hostname, uri.port)
+
+      unless @request_option_overrides.empty?
+        http.methods.grep(/\A(\w+)=\z/) do |meth|
+          key = $1.to_sym
+          @request_option_overrides.key?(key) or next
+          http.__send__(meth, @request_option_overrides[key])
+        end
+      end
+
+      http.use_ssl = (uri.scheme == 'https')
+      http.set_debug_output(@config.log_requests ? $stdout : nil)
+      http.open_timeout = @config.connection_timeout
+      http.read_timeout = @config.timeout.zero? ? 31_536_000 : @config.timeout # 31536000 means 365 days
+
+      begin
+        http.start do
+          http.request request do |response|
+
+            # If the response is timeout already, does not make sense to parse the http body because partial
+            # response may be returned, we should skip JSON parser and raise exception immediately
+            if response.is_a? Net::HTTPRequestTimeOut
+              raise Errors::NetworkError, response.message
+            end
+
+            # process headers for opc-meta- key
+            metadata = {}
+            prefix_size = 'opc-meta-'.length.freeze
+            response.each_header do |key, value|
+              if key.start_with? 'opc-meta-'
+                metadata[key[prefix_size..-1]] = value
+              end
+            end
+
+            metadata.each do |key, value|
+              response.delete "opc-meta-#{key}"
+              response[key] = value
+            end
+
+            if block.nil? || !success?(response)
+              if @config.logger
+                @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
+              end
+
+              # In the case of an error, deserialize to a plain hash by indicating 'Object'.
+              return_type = success?(response) ? opts[:return_type] : 'Object'
+              data = return_type ? deserialize(response, return_type) : nil
+
+              unless success? response
+                if data
+                  raise Errors::ServiceError.new(response.code.to_i,
+                                                 data[:code],
+                                                 response.header['opc-request-id'],
+                                                 data[:message])
+                else
+                  raise Errors::NetworkError, response.message
+                end
+              end
+
+              if @config.logger
+                @config.logger.debug "API Response Received:\nData: #{data.inspect}\nStatus code: #{response.code}\nHeaders: #{response.header}"
+              end
+
+              return Response.new(response.code.to_i, response.header, data)
+            else
+              response.read_body do |chunk|
+                yield chunk, response
+              end
+              return Response.new(response.code.to_i, response.header, nil)
+            end
+          end
+        end
+      rescue Errors::NetworkError, Errors::ServiceError, JSON::ParserError
+        raise
+      rescue => ex
+        raise Errors::NetworkError, ex.message
+      end
+    end
+
+    def success?(response)
+      response.is_a?(Net::HTTPSuccess)
+    end
+
+    def self.append_query_params(url, query_params)
+      if query_params.empty?
+        url
+      else
+        # First divide our query params into ones where the param value is and isn't a hash. The params where the value is a hash
+        # are, for example, tags we need to handle differently for inclusion in the query string. An example query_params is:
+        #
+        #   { 
+        #       "stuff" => "things",
+        #       "definedTags" => { "tag1" => ["val1", "val2", "val3"], "tag2" => ["val1"] },
+        #       "definedTagsExists" => { "tag3" => true, "tag4" => true }
+        #   }
+        #
+        # So our non_hash_params will be: { "stuff" => "things" }
+        # And our hash_params will be: { "definedTags" => { "tag1" => ["val1", "val2", "val3"], "tag2" => ["val1"] }, "definedTagsExists" => { "tag3" => true, "tag4" => true } }
+        non_hash_params = query_params.select { |k,v| !v.is_a?(Hash) }.to_h
+        hash_params = query_params.select { |k,v| v.is_a?(Hash) }.to_h
+
+        # Simple params just go key to value
+        base_query_string = ''
+        base_query_string << non_hash_params.map{|k,v| "#{k}=#{CGI.escape(v.to_s)}"}.join('&') unless non_hash_params.empty?
+
+        # Using the previous comment:
+        #    k = "definedTags", v = { "tag1" => [...] }
+        #
+        # Hash params are exploded as follows:
+        #
+        #    - If value in v is an array then we explode the content like: #{k}.#{v.key}=#{v.value[0]}&#{k}.#{v.key}=#{v.value[1]}&... so that there is
+        #      one query string parameter per item in the array
+        #    - If value in v is not an array then we explode the content like: #{k}.#{v.key}=#{v.value}
+        hash_params.each do |k,v|
+          v.each do |tag_key, tag_val|
+            # TODO: Should this be ERB::Util.url_encode instead? CGI.escape gives "+" here but url_encode will give %20
+            # CGI.escape is what we've been using until now, and it looks like it works...A literal "+" in the string will
+            # be encoded to %2B
+            query_string_val = if tag_val.is_a?(Array)
+                                  # to_s tag_key to avoid errors around implicit conversion of symbols to strings
+                                  tag_val.map { |tv| "#{k}.#{CGI.escape(tag_key.to_s)}=#{CGI.escape(tv.to_s)}" }.join('&')
+                                else
+                                  "#{k}.#{CGI.escape(tag_key.to_s)}=#{CGI.escape(tag_val.to_s)}" 
+                                end
+            base_query_string << '&' unless base_query_string.empty?
+            base_query_string << query_string_val
+          end
+        end
+
+        url << '?' unless base_query_string.empty?
+        url << base_query_string
+
+        url
+      end
+    end
+
+    # Check if the given MIME is a JSON MIME.
+    # JSON MIME examples:
+    #   application/json
+    #   application/json; charset=UTF8
+    #   APPLICATION/JSON
+    # @param [String] mime MIME
+    # @return [Boolean] True if the MIME is applicaton/json
+    def json_mime?(mime)
+      !(mime =~ /\Aapplication\/json(;.*)?\z/i).nil?
+    end
+
+    # Deserialize the response to the given return type.
+    #
+    # @param [Response] response HTTP response
+    # @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
+    def deserialize(response, return_type)
+      body = response.body
+      return if body.nil? || body.empty?
+
+      # ensuring a default content type
+      content_type = response.content_type || 'application/json'
+
+      return body if (return_type == 'String' && !json_mime?(content_type)) || return_type == 'Stream'
+
+      fail "content-type is not supported: #{content_type}" unless json_mime?(content_type)
+
+      begin
+        data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
+      rescue JSON::ParserError => e
+        if %w(String Date DateTime).include?(return_type)
+          data = body
+        else
+          raise e
+        end
+      end
+
+      OCI::Internal::Util.convert_to_type return_type, data
+    end
+
+    def build_request_url(path, endpoint)
+      # Add leading and trailing slashes to path
+      path = "/#{path}".gsub(/\/+/, '/')
+
+      if endpoint.end_with? '/'
+        endpoint = endpoint.chop
+      end
+      URI.encode(endpoint + path)
+    end
+
+    # Builds the HTTP request body
+    #
+    # @param [Hash] header_params Header parameters
+    # @param [Hash] form_params Query parameters
+    # @param [Object] body HTTP body (JSON/XML)
+    # @return [String] HTTP body data in the form of string
+    def build_request_body(header_params, form_params, body)
+      # http form
+      if header_params['content-type'] == 'application/x-www-form-urlencoded' ||
+          header_params['content-type'] == 'multipart/form-data'
+        data = {}
+        form_params.each do |key, value|
+          case value
+          when File, Array, nil
+            # let typhoeus handle File, Array and nil parameters
+            data[key] = value
+          else
+            data[key] = value.to_s
+          end
+        end
+      elsif body
+        data = body.is_a?(String) ? body : body.to_json
+      else
+        data = nil
+      end
+      data
+    end
+
+    # Convert object(non-array) to hash.
+    # @param [Object] obj object to be converted into JSON string
+    # @return [String] JSON string representation of the object
+    def object_to_hash(obj)
+      if obj.respond_to?(:to_hash)
+        obj.to_hash
+      else
+        obj
+      end
+    end
+
+  end
+end