oci 2.0.6 → 2.0.7

data/lib/oci/base_signer.rb

@@ -9,17 +9,16 @@ require 'uri'
 require 'cgi'
 
 module OCI
-
   # The base class for other classes which are meant to generate a signature
   class BaseSigner
     # enum to define the signing strategy
-    SIGNING_STRATEGY_ENUM = [STANDARD = 'standard', OBJECT_STORAGE = 'object_storage']
+    SIGNING_STRATEGY_ENUM = [STANDARD = 'standard'.freeze, OBJECT_STORAGE = 'object_storage'.freeze].freeze
 
     # The Oracle Cloud Infrastructure API signature version
-    SIGNATURE_VERSION = "1"
+    SIGNATURE_VERSION = '1'.freeze
 
-    GENERIC_HEADERS = [:"date", :"(request-target)", :"host"]
-    BODY_HEADERS = [:"content-length", :"content-type", :"x-content-sha256"]
+    GENERIC_HEADERS = %i[date (request-target) host].freeze
+    BODY_HEADERS = %i[content-length content-type x-content-sha256].freeze
 
     # Creates a BaseSigner
     #
@@ -27,11 +26,18 @@ module OCI
     # @param [String] private_key_content The private key as a PEM-formatted string
     # @param [String] pass_phrase Optional the pass phrase for the private key (if any)
     # @param [SIGNING_STRATEGY_ENUM] signing_strategy Optional signing for standard service or object storage service
-    # @param [Array<String>] headers_to_sign_in_all_requests Optional headers which should be signed on each request 
+    # @param [Array<String>] headers_to_sign_in_all_requests Optional headers which should be signed on each request
     # @param [Array<String>] body_headers_to_sign Optional headers which should be signed on requests with bodies
-    def initialize(api_key, private_key_content, pass_phrase:nil, signing_strategy:STANDARD, headers_to_sign_in_all_requests:GENERIC_HEADERS, body_headers_to_sign:BODY_HEADERS)
-      fail 'Missing required parameter api_key.' unless api_key
-      fail 'Missing required parameter private_key_content.' unless private_key_content
+    def initialize(
+      api_key,
+      private_key_content,
+      pass_phrase: nil,
+      signing_strategy: STANDARD,
+      headers_to_sign_in_all_requests: GENERIC_HEADERS,
+      body_headers_to_sign: BODY_HEADERS
+    )
+      raise 'Missing required parameter api_key.' unless api_key
+      raise 'Missing required parameter private_key_content.' unless private_key_content
 
       @key_id = api_key
       @private_key_content = private_key_content
@@ -39,7 +45,7 @@ module OCI
       @signing_strategy = signing_strategy
 
       @headers_to_sign_all_requests = headers_to_sign_in_all_requests
-      @body_headers_to_sign = body_headers_to_sign  
+      @body_headers_to_sign = body_headers_to_sign
       @operation_header_mapping = {
         options: [],
         get: headers_to_sign_in_all_requests,
@@ -65,65 +71,63 @@ module OCI
       path = uri.query.nil? ? uri.path : "#{uri.path}?#{uri.query}"
       inject_missing_headers(method, headers, body, uri)
       signature = compute_signature(headers, method, path)
-      unless signature.nil?
-        inject_authorization_header(headers, method, signature)
-      end
+      inject_authorization_header(headers, method, signature) unless signature.nil?
     end
 
     private
 
     def inject_missing_headers(method, headers, body, uri)
-      headers["date"] ||= Time.now.utc.httpdate
-      headers["accept"] ||= "*/*"
-      headers["host"] ||= uri.host if @headers_to_sign_all_requests.include?(:"host")
+      headers['date'] ||= Time.now.utc.httpdate
+      headers['accept'] ||= '*/*'
+      headers['host'] ||= uri.host if @headers_to_sign_all_requests.include?(:host)
 
       # For object storage service's put method, we don't need to set content type
       if method != :put || @signing_strategy != OBJECT_STORAGE
-        headers["content-type"] ||= "application/json"
+        headers['content-type'] ||= 'application/json'
       else
         headers[:'Content-Type'] ||= 'application/octet-stream'
       end
 
-      if method == :put || method == :post
-        body ||= ''
+      return unless %i[put post patch].include?(method)
 
-        # For object storage service's put method, we don't need to set content length and x-content sha256
-        if method != :put || @signing_strategy != OBJECT_STORAGE
-          headers["content-length"] ||= body.length.to_s
-          headers["x-content-sha256"] ||= Digest::SHA256.base64digest(body)
-        else
-          if body.respond_to?(:read) && body.respond_to?(:write)
-            headers['Content-Length'] ||= body.respond_to?('size') ? body.size : body.stat.size
-          else
-            headers['Content-Length'] ||= body.length.to_s
-          end
-        end
-      end
-    end
+      body ||= ''
 
-    def inject_authorization_header(headers, method, signature)
-      if method == :put && @signing_strategy == OBJECT_STORAGE
-        header_mapping = @headers_to_sign_all_requests
+      # For object storage service's put method, we don't need to set content length and x-content sha256
+      if method != :put || @signing_strategy != OBJECT_STORAGE
+        headers['content-length'] ||= body.length.to_s
+        headers['x-content-sha256'] ||= Digest::SHA256.base64digest(body)
       else
-        header_mapping = @operation_header_mapping[method]
+        headers['Content-Length'] ||= if body.respond_to?(:read) && body.respond_to?(:write)
+                                        body.respond_to?('size') ? body.size : body.stat.size
+                                      else
+                                        body.length.to_s
+                                      end
       end
+    end
 
-      signed_headers = header_mapping.map(&:to_s).join(" ")
-      headers["authorization"] = [
-          %(Signature headers="#{signed_headers}"),
-          %(keyId="#{@key_id}"),
-          %(algorithm="rsa-sha256"),
-          %(signature="#{signature}"),
-          %(version="#{SIGNATURE_VERSION}")
-      ].join(",")
+    def inject_authorization_header(headers, method, signature)
+      header_mapping = if method == :put && @signing_strategy == OBJECT_STORAGE
+                         @headers_to_sign_all_requests
+                       else
+                         @operation_header_mapping[method]
+                       end
+
+      signed_headers = header_mapping.map(&:to_s).join(' ')
+      headers['authorization'] = [
+        %(Signature headers="#{signed_headers}"),
+        %(keyId="#{@key_id}"),
+        %(algorithm="rsa-sha256"),
+        %(signature="#{signature}"),
+        %(version="#{SIGNATURE_VERSION}")
+      ].join(',')
     end
 
     def compute_signature(headers, method, path)
-      if method == :put && @signing_strategy == OBJECT_STORAGE
-        header_mapping = @headers_to_sign_all_requests
-      else
-        header_mapping = @operation_header_mapping[method]
-      end
+      header_mapping = if method == :put && @signing_strategy == OBJECT_STORAGE
+                         @headers_to_sign_all_requests
+                       else
+                         @operation_header_mapping[method]
+                       end
 
       return if header_mapping.empty?
       signing_string = header_mapping.map do |header|
@@ -134,7 +138,7 @@ module OCI
         end
       end.join("\n")
 
-      signature = private_key.sign(OpenSSL::Digest::SHA256.new, signing_string.encode("ascii"))
+      signature = private_key.sign(OpenSSL::Digest::SHA256.new, signing_string.encode('ascii'))
       Base64.strict_encode64(signature)
     end
 

data/lib/oci/config_file_loader.rb

@@ -50,10 +50,7 @@ module OCI
     # @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, 'Config file does not exist.'
-      end
+      raise Errors::ConfigFileNotFoundError, 'Config file does not exist.' unless File.file?(config_file_location)
 
       config_file = IniFile.load(config_file_location)
       configs = {}
@@ -65,9 +62,7 @@ module OCI
       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[DEFAULT_PROFILE], config) unless section.equal? DEFAULT_PROFILE
         load_section(config_file[section], config)
 
         configs[section] = config
@@ -83,10 +78,7 @@ module OCI
 
         # key_content is not allowed in configuration file
         next if key == 'key_content'
-
-        if config.respond_to?("#{key}=") && config.respond_to?(key)
-          config.instance_variable_set('@' + key, value)
-        end
+        config.instance_variable_set('@' + key, value) if config.respond_to?("#{key}=") && config.respond_to?(key)
         # TODO: log the key been ignored by Ruby SDK
       end
     end

data/lib/oci/core/blockstorage_client.rb

@@ -168,6 +168,40 @@ module OCI
         :return_type => 'OCI::Core::Models::VolumeBackup')
     end
 
+    # Assigns a policy to the specified asset, such as a volume. Note that a given asset can
+    # only have one policy assigned to it; if this method is called for an asset that previously
+    # has a different policy assigned, the prior assignment will be silently deleted.
+    # 
+    # @param [CreateVolumeBackupPolicyAssignmentDetails] create_volume_backup_policy_assignment_details Request to assign a specified policy to a particular asset.
+    # @param [Hash] opts the optional parameters
+    # @return [Response] A Response object with data of type OCI::Core::Models::VolumeBackupPolicyAssignment
+    def create_volume_backup_policy_assignment(create_volume_backup_policy_assignment_details, opts = {})
+      logger.debug "Calling operation BlockstorageClient#create_volume_backup_policy_assignment." if logger
+
+      fail "Missing the required parameter 'create_volume_backup_policy_assignment_details' when calling create_volume_backup_policy_assignment." if create_volume_backup_policy_assignment_details.nil?
+
+      path = "/volumeBackupPolicyAssignments"
+
+      # Query Params
+      query_params = {}
+
+      # Header Params
+      header_params = {}
+      header_params['accept'] = 'application/json'
+      header_params['content-type'] = 'application/json'
+
+      post_body = @api_client.object_to_http_body(create_volume_backup_policy_assignment_details)
+
+      return @api_client.call_api(
+        :POST,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'OCI::Core::Models::VolumeBackupPolicyAssignment')
+    end
+
     # Deletes the specified boot volume. The volume cannot have an active connection to an instance.
     # To disconnect the boot volume from a connected instance, see
     # [Disconnecting From a Boot Volume](https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Tasks/deletingbootvolume.htm).
@@ -281,6 +315,41 @@ module OCI
         :body => post_body)
     end
 
+    # Deletes a volume backup policy assignment (i.e. unassigns the policy from an asset).
+    # @param [String] policy_assignment_id The OCID of the volume backup policy assignment.
+    # @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_policy_assignment(policy_assignment_id, opts = {})
+      logger.debug "Calling operation BlockstorageClient#delete_volume_backup_policy_assignment." if logger
+
+      fail "Missing the required parameter 'policy_assignment_id' when calling delete_volume_backup_policy_assignment." if policy_assignment_id.nil?
+
+      path = "/volumeBackupPolicyAssignments/{policyAssignmentId}".sub('{policyAssignmentId}', policy_assignment_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 boot volume.
     # @param [String] boot_volume_id The OCID of the boot volume.
     # @param [Hash] opts the optional parameters
@@ -374,6 +443,111 @@ module OCI
         :return_type => 'OCI::Core::Models::VolumeBackup')
     end
 
+    # Gets information for the specified volume backup policy.
+    # @param [String] policy_id The OCID of the volume backup policy.
+    # @param [Hash] opts the optional parameters
+    # @return [Response] A Response object with data of type OCI::Core::Models::VolumeBackupPolicy
+    def get_volume_backup_policy(policy_id, opts = {})
+      logger.debug "Calling operation BlockstorageClient#get_volume_backup_policy." if logger
+
+      fail "Missing the required parameter 'policy_id' when calling get_volume_backup_policy." if policy_id.nil?
+
+      path = "/volumeBackupPolicies/{policyId}".sub('{policyId}', policy_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 => 'OCI::Core::Models::VolumeBackupPolicy')
+    end
+
+    # Gets the volume backup policy assignment for the specified asset. Note that the
+    # assetId query parameter is required, and that the returned list will contain at most
+    # one item (since any given asset can only have one policy assigned to it).
+    # 
+    # @param [String] asset_id The OCID of an asset (e.g. a volume).
+    # @param [Hash] opts the optional parameters
+    # @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<OCI::Core::Models::VolumeBackupPolicyAssignment>
+    def get_volume_backup_policy_asset_assignment(asset_id, opts = {})
+      logger.debug "Calling operation BlockstorageClient#get_volume_backup_policy_asset_assignment." if logger
+
+      fail "Missing the required parameter 'asset_id' when calling get_volume_backup_policy_asset_assignment." if asset_id.nil?
+
+      path = "/volumeBackupPolicyAssignments"
+
+      # Query Params
+      query_params = {}
+      query_params[:'assetId'] = asset_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<OCI::Core::Models::VolumeBackupPolicyAssignment>')
+    end
+
+    # Gets information for the specified volume backup policy assignment.
+    # @param [String] policy_assignment_id The OCID of the volume backup policy assignment.
+    # @param [Hash] opts the optional parameters
+    # @return [Response] A Response object with data of type OCI::Core::Models::VolumeBackupPolicyAssignment
+    def get_volume_backup_policy_assignment(policy_assignment_id, opts = {})
+      logger.debug "Calling operation BlockstorageClient#get_volume_backup_policy_assignment." if logger
+
+      fail "Missing the required parameter 'policy_assignment_id' when calling get_volume_backup_policy_assignment." if policy_assignment_id.nil?
+
+      path = "/volumeBackupPolicyAssignments/{policyAssignmentId}".sub('{policyAssignmentId}', policy_assignment_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 => 'OCI::Core::Models::VolumeBackupPolicyAssignment')
+    end
+
     # Lists the boot volumes in the specified compartment and Availability Domain.
     # 
     # @param [String] availability_domain The name of the Availability Domain.
@@ -421,6 +595,43 @@ module OCI
         :return_type => 'Array<OCI::Core::Models::BootVolume>')
     end
 
+    # Lists all volume backup policies available to the caller.
+    # @param [Hash] opts the optional parameters
+    # @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<OCI::Core::Models::VolumeBackupPolicy>
+    def list_volume_backup_policies(opts = {})
+      logger.debug "Calling operation BlockstorageClient#list_volume_backup_policies." if logger
+
+
+      path = "/volumeBackupPolicies"
+
+      # Query Params
+      query_params = {}
+      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<OCI::Core::Models::VolumeBackupPolicy>')
+    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.

data/lib/oci/core/compute_client.rb

@@ -284,7 +284,7 @@ module OCI
 
       fail "Missing the required parameter 'create_image_details' when calling create_image." if create_image_details.nil?
 
-      path = "/images/"
+      path = "/images"
 
       # Query Params
       query_params = {}
@@ -1209,6 +1209,7 @@ module OCI
     #   
     #   Example: `7.2`
     #   
+    # @option opts [String] :shape Shape name.
     # @option opts [Integer] :limit The maximum number of items to return in a paginated \"List\" call.
     #   
     #   Example: `500`
@@ -1249,7 +1250,7 @@ module OCI
         fail 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::Image::LIFECYCLE_STATE_ENUM.'
       end
 
-      path = "/images/"
+      path = "/images"
 
       # Query Params
       query_params = {}
@@ -1257,6 +1258,7 @@ module OCI
       query_params[:'displayName'] = opts[:'display_name'] if opts[:'display_name']
       query_params[:'operatingSystem'] = opts[:'operating_system'] if opts[:'operating_system']
       query_params[:'operatingSystemVersion'] = opts[:'operating_system_version'] if opts[:'operating_system_version']
+      query_params[:'shape'] = opts[:'shape'] if opts[:'shape']
       query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
       query_params[:'page'] = opts[:'page'] if opts[:'page']
       query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']