oraclebmc 1.1.1

data/lib/oraclebmc/config.rb

@@ -0,0 +1,80 @@
+# Copyright (c) 2016 Oracle and/or its affiliates. All rights reserved.
+
+require 'uri'
+
+module OracleBMC
+  class Config
+
+    # OCID of the user to use for authentication.
+    # Example: ocidv1:user:oc1:phx:1460406592659:aaaaaaaawcbqrkycbolrirg2n3xjl5fabc
+    #
+    # @return [String]
+    attr_accessor :user
+
+    # SSL Fingerprint to use for authentication.
+    # Example: 20:3b:97:13:55:1c:1c:0d:d3:37:d8:50:4e:c5:3a:12
+    #
+    # @return [String]
+    attr_accessor :fingerprint
+
+    # OCID of the tenancy to use for authentication.
+    # Example: ocid1.tenancy.oc1..aaaaaaaaba3pv6wkcr4jqae5f15p2b2m2yt2j6rx32uzr4h25vqstifsfdsq
+    #
+    # @return [String]
+    attr_accessor :tenancy
+
+    # Client private key file.
+    # Example: ~/.ssh/bmc_key
+    #
+    # @return [String]
+    attr_accessor :key_file
+
+    # Pass phrase used for key file, if it is encrypted.
+    #
+    # @return [String]
+    attr_accessor :pass_phrase
+
+    # A region to use for APIs created with this Config.
+    #
+    # @return [OracleBMC::Regions::REGION_ENUM]
+    attr_accessor :region
+
+    # Defines the logger used for debugging.
+    # For example, log to STDOUT by setting this to Logger.new(STDOUT).
+    # This property cannot be set from a config file.
+    #
+    # @return [Logger]
+    attr_accessor :logger
+
+    # Whether to log detailed request and response
+    # data. This will always write to STDOUT.
+    # Defaults to false.
+    #
+    # @return [true, false]
+    attr_accessor :log_requests
+
+    # The time limit for HTTP request in seconds.
+    # Defaults to 0 (never times out).
+    #
+    # @return [Integer]
+    attr_accessor :timeout
+
+    # The time limit for the connection phase in seconds.
+    # Defaults to 10 seconds.
+    #
+    # @return [Integer]
+    attr_accessor :connection_timeout
+
+    # If set, then this string will be added to the
+    # user agent sent with each request.
+    #
+    # @return [String]
+    attr_accessor :additional_user_agent
+
+    def initialize
+      @timeout = 0
+      @connection_timeout = 10
+      @log_requests = false
+    end
+  end
+end

data/lib/oraclebmc/config_file_loader.rb

@@ -0,0 +1,85 @@
+# Copyright (c) 2016 Oracle and/or its affiliates. All rights reserved.
+
+require 'inifile'
+require_relative 'config'
+
+module OracleBMC
+
+  module ConfigFileLoader
+
+    module Errors
+      class ConfigFileNotFoundError < RuntimeError; end
+      class ProfileNotFoundError < RuntimeError; end
+      class DefaultProfileDoesNotExistError < RuntimeError; end
+    end
+
+    # Name of the default profile to load from a config file
+    DEFAULT_PROFILE = 'DEFAULT'
+
+    # Default config file name and location
+    DEFAULT_CONFIG_FILE = '~/.oraclebmc/config'
+
+    # Loads the a Config from the specified file and profile.
+    #
+    # @param [String] config_file_location Filename and path of the config file. Defaults to "~/.oraclebmc/config"
+    # @param [String] profile_name Name of the profile from the file. Defaults to "DEFAULT".
+    # @return [Config] A Config
+    def self.load_config(config_file_location: DEFAULT_CONFIG_FILE, profile_name: DEFAULT_PROFILE)
+      configs = load_configs(config_file_location)
+
+      if configs && configs.key?(profile_name)
+        return configs[profile_name]
+      else
+        raise Errors::ProfileNotFoundError.new("Profile not found in the given config file.")
+      end
+    end
+
+    # Loads all of the Configs from the specified file.
+    #
+    # @param [String] config_file_location Filename and path of the config file.
+    # @return [Array<Config>] An array containing all the configs found in the given file.
+    def self.load_configs(config_file_location)
+      config_file_location = File.expand_path(config_file_location)
+
+      unless File.file?(config_file_location)
+        raise Errors::ConfigFileNotFoundError.new("Config file does not exist.")
+      end
+
+      config_file = IniFile.load(config_file_location)
+      configs = {}
+
+      if config_file.nil? || !config_file.has_section?(DEFAULT_PROFILE)
+        raise Errors::DefaultProfileDoesNotExistError.new("The DEFAULT profile does not exist.")
+      end
+
+      config_file.each_section do |section|
+        config = Config.new
+
+        unless section.equal? DEFAULT_PROFILE
+          load_section(config_file[DEFAULT_PROFILE], config)
+        end
+        load_section(config_file[section], config)
+
+        configs[section] = config
+      end
+
+      return configs
+    end
+
+    def self.load_section(section, config)
+      section.each_key do |key|
+        value = section[key]
+
+        if key == "key_file"
+          value = File.expand_path(value)
+        end
+
+        config.instance_variable_set("@" + key, value)
+      end
+    end
+
+    private_class_method :load_section
+
+  end
+
+end

data/lib/oraclebmc/core/blockstorage_client.rb

@@ -0,0 +1,459 @@
+# Copyright (c) 2016 Oracle and/or its affiliates. All rights reserved.
+
+require "uri"
+require "logger"
+
+module OracleBMC
+
+  class Core::BlockstorageClient
+
+    # Client used to make HTTP requests.
+    # @return [OracleBMC::ApiClient]
+    attr_reader :api_client
+
+    # Fully qualified endpoint URL
+    # @return [String]
+    attr_reader :endpoint
+
+    # The region, which will usually correspond to a value in {OracleBMC::Regions::REGION_ENUM}.
+    # @return [String]
+    attr_accessor :region
+
+    # Creates a new BlockstorageClient.
+    # If a config is not specified, then the global OracleBMC.config will be used.
+    #
+    # A region must be specified in either the config or the region parameter. If specified
+    # in both, then the region parameter will be used.
+    #
+    # @param [Config] config A Config object.
+    # @param [String] region A region used to determine the service endpoint. This will usually
+    #   correspond to a value in {OracleBMC::Regions::REGION_ENUM}, but may be an arbitrary string.
+    #
+    def initialize(config:nil, region:nil)
+      config ||= OracleBMC.config
+      signer = Signer.new(config.user, config.fingerprint, config.tenancy, config.key_file, pass_phrase: config.pass_phrase)
+      @api_client = ApiClient.new(config, signer)
+
+      region ||= config.region
+      self.region = region
+    end
+
+    # Set the region that will be used to determine the service endpoint.
+    # This will usually correspond to a value in {OracleBMC::Regions::REGION_ENUM},
+    # but may be an arbitrary string.
+    def region=(r)
+      @region = r
+
+      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
+
+    # @return [Logger] The logger for this client. May be nil.
+    def logger
+      @api_client.config.logger
+    end
+
+
+    # Creates a new volume in the specified compartment. The size of a volume can be either 256 GB or 2 TB.
+    # For general information about block volumes, see
+    # [Overview of Block Volume Service](https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/overview.htm).
+    # 
+    # A volume and instance can be in separate compartments but must be in the same Availability Domain. 
+    # For information about access control and compartments, see
+    # [Overview of the IAM Service](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm). For information about 
+    # Availability Domains, see [Regions and Availability Domains](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm).
+    # To get a list of Availability Domains, use the `ListAvailabilityDomains` operation
+    # in the Identity and Access Management Service API.
+    # 
+    # You may optionally specify a *display name* for the volume, which is simply a friendly name or
+    # description. It does not have to be unique, and you can change it.
+    # 
+    # @param [CreateVolumeDetails] create_volume_details Request to create a new volume.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
+    #   server error without risk of executing that same action again. Retry tokens expire after 24
+    #   hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
+    #   has been deleted and purged from the system, then a retry of the original creation request
+    #   may be rejected).
+    #   
+    # @return [Response] A Response object with data of type OracleBMC::Core::Models::Volume
+    def create_volume(create_volume_details, opts = {})
+      logger.debug "Calling operation BlockstorageClient#create_volume." if logger
+
+      fail "Missing the required parameter 'create_volume_details' when calling create_volume." if create_volume_details.nil?
+
+      path = "/volumes"
+
+      # Query Params
+      query_params = {}
+
+      # Header Params
+      header_params = {}
+      header_params['accept'] = 'application/json'
+      header_params['content-type'] = 'application/json'
+      header_params[:'opc-retry-token'] = opts[:'opc_retry_token'] if opts[:'opc_retry_token']
+
+      post_body = @api_client.object_to_http_body(create_volume_details)
+
+      return @api_client.call_api(
+        :POST,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'OracleBMC::Core::Models::Volume')
+    end
+
+    # Creates a new backup of the specified volume. For general information about volume backups,
+    # see [Overview of Block Volume Service Backups](https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/blockvolumebackups.htm)
+    # 
+    # When the request is received, the backup object is in a REQUEST_RECEIVED state.
+    # When the data is imaged, it goes into a CREATING state.
+    # After the backup is fully uploaded to the cloud, it goes into an AVAILABLE state.
+    # 
+    # @param [CreateVolumeBackupDetails] create_volume_backup_details Request to create a new backup of given volume.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
+    #   server error without risk of executing that same action again. Retry tokens expire after 24
+    #   hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
+    #   has been deleted and purged from the system, then a retry of the original creation request
+    #   may be rejected).
+    #   
+    # @return [Response] A Response object with data of type OracleBMC::Core::Models::VolumeBackup
+    def create_volume_backup(create_volume_backup_details, opts = {})
+      logger.debug "Calling operation BlockstorageClient#create_volume_backup." if logger
+
+      fail "Missing the required parameter 'create_volume_backup_details' when calling create_volume_backup." if create_volume_backup_details.nil?
+
+      path = "/volumeBackups"
+
+      # Query Params
+      query_params = {}
+
+      # Header Params
+      header_params = {}
+      header_params['accept'] = 'application/json'
+      header_params['content-type'] = 'application/json'
+      header_params[:'opc-retry-token'] = opts[:'opc_retry_token'] if opts[:'opc_retry_token']
+
+      post_body = @api_client.object_to_http_body(create_volume_backup_details)
+
+      return @api_client.call_api(
+        :POST,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'OracleBMC::Core::Models::VolumeBackup')
+    end
+
+    # Deletes the specified volume. The volume cannot have an active connection to an instance.
+    # To disconnect the volume from a connected instance, see
+    # [Disconnecting From a Volume](https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Tasks/disconnectingfromavolume.htm).
+    # **Warning:** All data on the volume will be permanently lost when the volume is deleted.
+    # 
+    # @param [String] volume_id The OCID of the volume.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
+    #   parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
+    #   will be updated or deleted only if the etag you provide matches the resource's current etag value.
+    #   
+    # @return [Response] A Response object with data of type nil
+    def delete_volume(volume_id, opts = {})
+      logger.debug "Calling operation BlockstorageClient#delete_volume." if logger
+
+      fail "Missing the required parameter 'volume_id' when calling delete_volume." if volume_id.nil?
+
+      path = "/volumes/{volumeId}".sub('{volumeId}', volume_id.to_s)
+
+      # Query Params
+      query_params = {}
+
+      # Header Params
+      header_params = {}
+      header_params['accept'] = 'application/json'
+      header_params['content-type'] = 'application/json'
+      header_params[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
+
+      post_body = nil
+
+      return @api_client.call_api(
+        :DELETE,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body)
+    end
+
+    # Deletes a volume backup.
+    # @param [String] volume_backup_id The OCID of the volume backup.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
+    #   parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
+    #   will be updated or deleted only if the etag you provide matches the resource's current etag value.
+    #   
+    # @return [Response] A Response object with data of type nil
+    def delete_volume_backup(volume_backup_id, opts = {})
+      logger.debug "Calling operation BlockstorageClient#delete_volume_backup." if logger
+
+      fail "Missing the required parameter 'volume_backup_id' when calling delete_volume_backup." if volume_backup_id.nil?
+
+      path = "/volumeBackups/{volumeBackupId}".sub('{volumeBackupId}', volume_backup_id.to_s)
+
+      # Query Params
+      query_params = {}
+
+      # Header Params
+      header_params = {}
+      header_params['accept'] = 'application/json'
+      header_params['content-type'] = 'application/json'
+      header_params[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
+
+      post_body = nil
+
+      return @api_client.call_api(
+        :DELETE,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body)
+    end
+
+    # Gets information for the specified volume.
+    # @param [String] volume_id The OCID of the volume.
+    # @param [Hash] opts the optional parameters
+    # @return [Response] A Response object with data of type OracleBMC::Core::Models::Volume
+    def get_volume(volume_id, opts = {})
+      logger.debug "Calling operation BlockstorageClient#get_volume." if logger
+
+      fail "Missing the required parameter 'volume_id' when calling get_volume." if volume_id.nil?
+
+      path = "/volumes/{volumeId}".sub('{volumeId}', volume_id.to_s)
+
+      # Query Params
+      query_params = {}
+
+      # Header Params
+      header_params = {}
+      header_params['accept'] = 'application/json'
+      header_params['content-type'] = 'application/json'
+
+      post_body = nil
+
+      return @api_client.call_api(
+        :GET,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'OracleBMC::Core::Models::Volume')
+    end
+
+    # Gets information for the specified volume backup.
+    # @param [String] volume_backup_id The OCID of the volume backup.
+    # @param [Hash] opts the optional parameters
+    # @return [Response] A Response object with data of type OracleBMC::Core::Models::VolumeBackup
+    def get_volume_backup(volume_backup_id, opts = {})
+      logger.debug "Calling operation BlockstorageClient#get_volume_backup." if logger
+
+      fail "Missing the required parameter 'volume_backup_id' when calling get_volume_backup." if volume_backup_id.nil?
+
+      path = "/volumeBackups/{volumeBackupId}".sub('{volumeBackupId}', volume_backup_id.to_s)
+
+      # Query Params
+      query_params = {}
+
+      # Header Params
+      header_params = {}
+      header_params['accept'] = 'application/json'
+      header_params['content-type'] = 'application/json'
+
+      post_body = nil
+
+      return @api_client.call_api(
+        :GET,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'OracleBMC::Core::Models::VolumeBackup')
+    end
+
+    # Lists the volume backups in the specified compartment. You can filter the results by volume.
+    # 
+    # @param [String] compartment_id The OCID of the compartment.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :volume_id The OCID of the volume.
+    # @option opts [Integer] :limit The maximum number of items to return in a paginated \"List\" call.
+    #   
+    #   Example: `500`
+    #   
+    # @option opts [String] :page The value of the `opc-next-page` response header from the previous \"List\" call.
+    #   
+    # @return [Response] A Response object with data of type Array<OracleBMC::Core::Models::VolumeBackup>
+    def list_volume_backups(compartment_id, opts = {})
+      logger.debug "Calling operation BlockstorageClient#list_volume_backups." if logger
+
+      fail "Missing the required parameter 'compartment_id' when calling list_volume_backups." if compartment_id.nil?
+
+      path = "/volumeBackups"
+
+      # Query Params
+      query_params = {}
+      query_params[:'compartmentId'] = compartment_id
+      query_params[:'volumeId'] = opts[:'volume_id'] if opts[:'volume_id']
+      query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
+      query_params[:'page'] = opts[:'page'] if opts[:'page']
+
+      # Header Params
+      header_params = {}
+      header_params['accept'] = 'application/json'
+      header_params['content-type'] = 'application/json'
+
+      post_body = nil
+
+      return @api_client.call_api(
+        :GET,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'Array<OracleBMC::Core::Models::VolumeBackup>')
+    end
+
+    # Lists the volumes in the specified compartment and Availability Domain.
+    # 
+    # @param [String] compartment_id The OCID of the compartment.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :availability_domain The name of the Availability Domain.
+    #   
+    #   Example: `Uocm:PHX-AD-1`
+    #   
+    # @option opts [Integer] :limit The maximum number of items to return in a paginated \&quot;List\&quot; call.
+    #   
+    #   Example: `500`
+    #   
+    # @option opts [String] :page The value of the `opc-next-page` response header from the previous \&quot;List\&quot; call.
+    #   
+    # @return [Response] A Response object with data of type Array<OracleBMC::Core::Models::Volume>
+    def list_volumes(compartment_id, opts = {})
+      logger.debug "Calling operation BlockstorageClient#list_volumes." if logger
+
+      fail "Missing the required parameter 'compartment_id' when calling list_volumes." if compartment_id.nil?
+
+      path = "/volumes"
+
+      # Query Params
+      query_params = {}
+      query_params[:'compartmentId'] = compartment_id
+      query_params[:'availabilityDomain'] = opts[:'availability_domain'] if opts[:'availability_domain']
+      query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
+      query_params[:'page'] = opts[:'page'] if opts[:'page']
+
+      # Header Params
+      header_params = {}
+      header_params['accept'] = 'application/json'
+      header_params['content-type'] = 'application/json'
+
+      post_body = nil
+
+      return @api_client.call_api(
+        :GET,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'Array<OracleBMC::Core::Models::Volume>')
+    end
+
+    # Updates the specified volume's display name.
+    # @param [String] volume_id The OCID of the volume.
+    # @param [UpdateVolumeDetails] update_volume_details Update volume&#39;s display name.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
+    #   parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
+    #   will be updated or deleted only if the etag you provide matches the resource&#39;s current etag value.
+    #   
+    # @return [Response] A Response object with data of type OracleBMC::Core::Models::Volume
+    def update_volume(volume_id, update_volume_details, opts = {})
+      logger.debug "Calling operation BlockstorageClient#update_volume." if logger
+
+      fail "Missing the required parameter 'volume_id' when calling update_volume." if volume_id.nil?
+      fail "Missing the required parameter 'update_volume_details' when calling update_volume." if update_volume_details.nil?
+
+      path = "/volumes/{volumeId}".sub('{volumeId}', volume_id.to_s)
+
+      # Query Params
+      query_params = {}
+
+      # Header Params
+      header_params = {}
+      header_params['accept'] = 'application/json'
+      header_params['content-type'] = 'application/json'
+      header_params[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
+
+      post_body = @api_client.object_to_http_body(update_volume_details)
+
+      return @api_client.call_api(
+        :PUT,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'OracleBMC::Core::Models::Volume')
+    end
+
+    # Updates the display name for the specified volume backup.
+    # @param [String] volume_backup_id The OCID of the volume backup.
+    # @param [UpdateVolumeBackupDetails] update_volume_backup_details Update volume backup fields
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
+    #   parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
+    #   will be updated or deleted only if the etag you provide matches the resource&#39;s current etag value.
+    #   
+    # @return [Response] A Response object with data of type OracleBMC::Core::Models::VolumeBackup
+    def update_volume_backup(volume_backup_id, update_volume_backup_details, opts = {})
+      logger.debug "Calling operation BlockstorageClient#update_volume_backup." if logger
+
+      fail "Missing the required parameter 'volume_backup_id' when calling update_volume_backup." if volume_backup_id.nil?
+      fail "Missing the required parameter 'update_volume_backup_details' when calling update_volume_backup." if update_volume_backup_details.nil?
+
+      path = "/volumeBackups/{volumeBackupId}".sub('{volumeBackupId}', volume_backup_id.to_s)
+
+      # Query Params
+      query_params = {}
+
+      # Header Params
+      header_params = {}
+      header_params['accept'] = 'application/json'
+      header_params['content-type'] = 'application/json'
+      header_params[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
+
+      post_body = @api_client.object_to_http_body(update_volume_backup_details)
+
+      return @api_client.call_api(
+        :PUT,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'OracleBMC::Core::Models::VolumeBackup')
+    end
+  end
+end