oci 2.4.1 → 2.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7de46f20f8218b5eae43314eea56f26140d3bb7cde0665cbb3d02345f2299da2
-  data.tar.gz: 711d97bdbf04a8238699ab0ba8f7cbe9a31eff0c88eec9c8b1ef339bd1d430cb
+  metadata.gz: c540db2d59f168706fd0419eede5da8c1d45dc9150b77da8d8325ad53fb47495
+  data.tar.gz: 6c44cf54a1dada0fe102b0e4fc0262f7cf5a3cb51463dfcc4106725017ae23db
 SHA512:
-  metadata.gz: 443fb8aeecc3eb2aa198dc5ed19e4f70af29f7d7d262be1228013b11e2e87c5fe349c5ce36fc14ada7778e90218134d91ae0386e441e4d0bad3a20880107cbdd
-  data.tar.gz: fe8bc7d18a5ba2b50ee0efc0f8fe57edf4405bbc1e0c7ef033a9694f973736d0c50571803d4c4310dbe33892e75044ecd7cf76827648a17968ace6789fedf067
+  metadata.gz: 5c4f4ee4b3eb2754e946d66f3154b18e0b40a0690a1002dfe5393c73ed6da1f56fded5edca4db906a0636392da52352211638cec1d8cb9150b0bc1e2d9565540
+  data.tar.gz: f19c66c15aea0a4b765dba3e9ef24cbbc93a4cd41aa55cfe591bba3f82acf9184a35077599dfb9e58da932d387ad06cbdfac77228c42716609ad2d5d9e6b7d7e

data/LICENSE.txt

@@ -1,6 +1,6 @@
 Copyright (c) 2016, 2018, Oracle and/or its affiliates.  All rights reserved.
 
-This software is dual-licensed to you under the Universal Permissive License (UPL) and Apache License 2.0.  See below for license terms.  You may choose either license, or both.
+This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 or Apache License 2.0.  See below for license terms.  You may choose either license.
  ____________________________
 The Universal Permissive License (UPL), Version 1.0
 Copyright (c) 2016, 2018, Oracle and/or its affiliates.  All rights reserved.

data/README.md

@@ -1,5 +1,5 @@
 # Oracle Cloud Infrastructure Ruby SDK
-**Version 2.4.1**
+**Version 2.4.2**
 
 This topic describes how to install, configure, and use the Oracle Cloud Infrastructure Ruby SDK.
 
@@ -158,6 +158,8 @@ To use any of the APIs, you must supply a {OCI::Config Config} object. You can c
 * 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.
 
+Note that the Ruby SDK does not support parsing custom attributes in the configuration file.
+
 ## 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.

data/lib/oci/api_client.rb

@@ -18,6 +18,21 @@ module OCI
   # services. This client also handles request serialization and response deserialization
   class ApiClient
     class << self
+      # Builds the client info string to be sent with each request.
+      def build_request_id
+        SecureRandom.uuid.delete!('-').upcase
+      end
+
+      # Builds the client info string to be sent with each request.
+      def build_user_info
+        "Oracle-RubySDK/#{VERSION}"
+      end
+
+      # Build the user agent string to be sent with each request.
+      def build_user_agent
+        "#{build_user_info}#{OCI.sdk_name} (ruby #{RUBY_VERSION}; #{RUBY_PLATFORM})"
+      end
+
       private
 
       def get_rfc339_formatted_date_string_with_z_offset(date_time)
@@ -158,24 +173,6 @@ module OCI
     end
     # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity, Layout/EmptyLines
 
-    # Builds the client info string to be sent with each request.
-    def build_request_id
-      SecureRandom.uuid.delete!('-').upcase
-    end
-
-    # Builds the client info string to be sent with each request.
-    def build_user_info
-      "Oracle-RubySDK/#{VERSION}"
-    end
-
-    # Build the user agent string to be send with each request.
-    def build_user_agent
-      agent = "#{build_user_info}#{OCI.sdk_name} (ruby #{RUBY_VERSION}; #{RUBY_PLATFORM})"
-      agent = "#{agent} #{config.additional_user_agent}" if config.additional_user_agent
-
-      agent
-    end
-
     def self.build_collection_params(collection, collection_format)
       if collection_format.nil? || !VALID_COLLECTION_FORMATS.key?(collection_format.to_sym)
         raise "Invalid collection_format: #{collection_format}. Must be one of: #{VALID_COLLECTION_FORMATS.keys}"
@@ -265,6 +262,12 @@ module OCI
     end
     # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity, Layout/EmptyLines
 
+    # Build the user agent string that also includes the additional_user_agent to be sent with each request.
+    def build_user_agent
+      agent = self.class.build_user_agent
+      "#{agent} #{config.additional_user_agent}" unless config.nil? || config.additional_user_agent.nil?
+    end
+
     private
 
     # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
@@ -311,8 +314,8 @@ module OCI
         request[key.to_s] = value
       end
 
-      request['opc-client-info'] = build_user_info
-      request['opc-request-id'] ||= build_request_id
+      request['opc-client-info'] = self.class.build_user_info
+      request['opc-request-id'] ||= self.class.build_request_id
       request['User-Agent'] = build_user_agent
 
       http = get_http_object(uri.hostname, uri.port)
@@ -566,6 +569,7 @@ module OCI
 
       OCI::Internal::Util.convert_to_type return_type, data
     end
+
     # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity, Layout/EmptyLines
 
     def build_request_url(path, endpoint)

data/lib/oci/auth/federation_client.rb

@@ -101,6 +101,11 @@ module OCI
           signer.sign(:post, @federation_endpoint, header_params, request.body)
           header_params.each { |key, value| request[key.to_s] = value }
 
+          # Additional header info to aid in debugging issues
+          request['opc-client-info'] = OCI::ApiClient.build_user_info
+          request['opc-request-id'] ||= OCI::ApiClient.build_request_id
+          request['User-Agent'] =  OCI::ApiClient.build_user_agent
+
           raw_body = nil
           @federation_http_client.start do
             @federation_http_client.request(request) do |response|

data/lib/oci/object_storage/models/bucket.rb

@@ -96,6 +96,18 @@ module OCI
     # @return [String]
     attr_accessor :object_lifecycle_policy_etag
 
+    # The approximate number of objects in the bucket. Count statistics are reported periodically. You will see a
+    # lag between what is displayed and the actual object count.
+    #
+    # @return [Integer]
+    attr_accessor :approximate_count
+
+    # The approximate total size of all objects in the bucket. Size statistics are reported periodically. You will
+    # see a lag between what is displayed and the actual size of the bucket.
+    #
+    # @return [Integer]
+    attr_accessor :approximate_size
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -112,7 +124,9 @@ module OCI
         'freeform_tags': :'freeformTags',
         'defined_tags': :'definedTags',
         'kms_key_id': :'kmsKeyId',
-        'object_lifecycle_policy_etag': :'objectLifecyclePolicyEtag'
+        'object_lifecycle_policy_etag': :'objectLifecyclePolicyEtag',
+        'approximate_count': :'approximateCount',
+        'approximate_size': :'approximateSize'
         # rubocop:enable Style/SymbolLiteral
       }
     end
@@ -133,7 +147,9 @@ module OCI
         'freeform_tags': :'Hash<String, String>',
         'defined_tags': :'Hash<String, Hash<String, Object>>',
         'kms_key_id': :'String',
-        'object_lifecycle_policy_etag': :'String'
+        'object_lifecycle_policy_etag': :'String',
+        'approximate_count': :'Integer',
+        'approximate_size': :'Integer'
         # rubocop:enable Style/SymbolLiteral
       }
     end
@@ -157,6 +173,8 @@ module OCI
     # @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property
     # @option attributes [String] :kms_key_id The value to assign to the {#kms_key_id} property
     # @option attributes [String] :object_lifecycle_policy_etag The value to assign to the {#object_lifecycle_policy_etag} property
+    # @option attributes [Integer] :approximate_count The value to assign to the {#approximate_count} property
+    # @option attributes [Integer] :approximate_size The value to assign to the {#approximate_size} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 
@@ -224,6 +242,18 @@ module OCI
       raise 'You cannot provide both :objectLifecyclePolicyEtag and :object_lifecycle_policy_etag' if attributes.key?(:'objectLifecyclePolicyEtag') && attributes.key?(:'object_lifecycle_policy_etag')
 
       self.object_lifecycle_policy_etag = attributes[:'object_lifecycle_policy_etag'] if attributes[:'object_lifecycle_policy_etag']
+
+      self.approximate_count = attributes[:'approximateCount'] if attributes[:'approximateCount']
+
+      raise 'You cannot provide both :approximateCount and :approximate_count' if attributes.key?(:'approximateCount') && attributes.key?(:'approximate_count')
+
+      self.approximate_count = attributes[:'approximate_count'] if attributes[:'approximate_count']
+
+      self.approximate_size = attributes[:'approximateSize'] if attributes[:'approximateSize']
+
+      raise 'You cannot provide both :approximateSize and :approximate_size' if attributes.key?(:'approximateSize') && attributes.key?(:'approximate_size')
+
+      self.approximate_size = attributes[:'approximate_size'] if attributes[:'approximate_size']
     end
     # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
     # rubocop:enable Metrics/LineLength, Metrics/MethodLength, Layout/EmptyLines, Style/SymbolLiteral
@@ -279,7 +309,9 @@ module OCI
         freeform_tags == other.freeform_tags &&
         defined_tags == other.defined_tags &&
         kms_key_id == other.kms_key_id &&
-        object_lifecycle_policy_etag == other.object_lifecycle_policy_etag
+        object_lifecycle_policy_etag == other.object_lifecycle_policy_etag &&
+        approximate_count == other.approximate_count &&
+        approximate_size == other.approximate_size
     end
     # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/LineLength, Layout/EmptyLines
 
@@ -295,7 +327,7 @@ module OCI
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [namespace, name, compartment_id, metadata, created_by, time_created, etag, public_access_type, storage_tier, freeform_tags, defined_tags, kms_key_id, object_lifecycle_policy_etag].hash
+      [namespace, name, compartment_id, metadata, created_by, time_created, etag, public_access_type, storage_tier, freeform_tags, defined_tags, kms_key_id, object_lifecycle_policy_etag, approximate_count, approximate_size].hash
     end
     # rubocop:enable Metrics/AbcSize, Metrics/LineLength, Layout/EmptyLines
 

data/lib/oci/object_storage/object_storage_client.rb

@@ -810,12 +810,27 @@ module OCI
     #   For creating and committing a multipart upload, this is the entity tag of the target object. For uploading a part, this is the entity tag of the target part.
     #
     # @option opts [String] :opc_client_request_id The client request ID for tracing.
+    # @option opts [Array<String>] :fields Bucket summary includes the 'namespace', 'name', 'compartmentId', 'createdBy', 'timeCreated',
+    #   and 'etag' fields. This parameter can also include 'approximateCount' (Approximate number of objects) and 'approximateSize'
+    #   (total approximate size in bytes of all objects). For example 'approximateCount,approximateSize'
+    #
+    #   Allowed values are: approximateCount, approximateSize
     # @return [Response] A Response object with data of type {OCI::ObjectStorage::Models::Bucket Bucket}
     def get_bucket(namespace_name, bucket_name, opts = {})
       logger.debug 'Calling operation ObjectStorageClient#get_bucket.' if logger
 
       raise "Missing the required parameter 'namespace_name' when calling get_bucket." if namespace_name.nil?
       raise "Missing the required parameter 'bucket_name' when calling get_bucket." if bucket_name.nil?
+
+
+      fields_allowable_values = %w[approximateCount approximateSize]
+      if opts[:fields] && !opts[:fields].empty?
+        opts[:fields].each do |val_to_check|
+          unless fields_allowable_values.include?(val_to_check)
+            raise 'Invalid value for "fields", must be one of approximateCount, approximateSize.'
+          end
+        end
+      end
       raise "Parameter value for 'namespace_name' must not be blank" if OCI::Internal::Util.blank_string?(namespace_name)
       raise "Parameter value for 'bucket_name' must not be blank" if OCI::Internal::Util.blank_string?(bucket_name)
 
@@ -825,6 +840,7 @@ module OCI
       # rubocop:disable Style/NegatedIf
       # Query Params
       query_params = {}
+      query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :csv) if opts[:fields] && !opts[:fields].empty?
 
       # Header Params
       header_params = {}

data/lib/oci/regions.rb

@@ -17,6 +17,21 @@ module OCI
       'lhr': REGION_UK_LONDON_1
     }.freeze
 
+    # --- Start of region realm mapping ---
+    REGION_REALM_MAPPING = {
+      'us-phoenix-1': 'oc1'.freeze,
+      'us-ashburn-1': 'oc1'.freeze,
+      'eu-frankfurt-1': 'oc1'.freeze,
+      'uk-london-1': 'oc1'.freeze
+    }.freeze
+    # ---  end of region realm mapping  ---
+
+    # --- Start of realm domain mapping ---
+    REALM_DOMAIN_MAPPING = {
+      'oc1': 'oraclecloud.com'.freeze
+    }.freeze
+    # ---  end of realm domain mapping  ---
+
     # --- Start of service prefixes ---
     SERVICE_ENDPOINT_PREFIX_MAPPING = {
       BlockstorageClient: 'iaas',
@@ -51,6 +66,24 @@ module OCI
       format_endpoint(prefix, region)
     end
 
+    # Returns an endpoint for the given region and service endpoint template.
+    #
+    # @param [String] region A region used to determine the service endpoint. This will usually
+    #   correspond to a value in {OCI::Regions::REGION_ENUM}, but may be an arbitrary string.
+    # @param [String] endpoint_template A service endpoint template defined by service team in spec.
+    #
+    # @return [String] A fully qualified endpoint
+    def self.get_service_endpoint_for_template(region, endpoint_template)
+      endpoint = endpoint_template.clone
+
+      # replace the token inside service_endpoint_template if exists
+      [
+        ['{region}', region],
+        ['{secondLevelDomain}', get_second_level_domain(region).to_s]
+      ].each { |k, v| endpoint.sub!(k, v) }
+      endpoint
+    end
+
     # @return [Boolean] Returns true if the given string corresponds to a known region, as defined in
     # {OCI::Regions::REGION_ENUM}.
     def self.valid_region?(region)
@@ -58,7 +91,32 @@ module OCI
     end
 
     def self.format_endpoint(prefix, region)
-      "https://#{prefix}.#{region}.oraclecloud.com"
+      second_level_domain = get_second_level_domain(region)
+      "https://#{prefix}.#{region}.#{second_level_domain}"
+    end
+
+    # Returns a second level domain for the given region.
+    #
+    # @param [String] region A region used to get the second level domain. This will usually
+    #   correspond to a value in {OCI::Regions::REGION_ENUM}, but may be an arbitrary string.
+    #
+    # @return [String] A second level domain for given region, default to oraclecloud.com
+    def self.get_second_level_domain(region)
+      symbolised_region = region.to_sym
+
+      # get realm from region, default to oc1
+      realm = if REGION_REALM_MAPPING.key?(symbolised_region)
+                REGION_REALM_MAPPING[symbolised_region]
+              else
+                'oc1'
+              end
+
+      # return second level domain if exists
+      symbolised_realm = realm.to_sym
+      return REALM_DOMAIN_MAPPING[symbolised_realm] if REALM_DOMAIN_MAPPING.key?(symbolised_realm)
+
+      # otherwise return oc1 domain by default
+      REALM_DOMAIN_MAPPING[:oc1]
     end
   end
 end

data/lib/oci/version.rb

@@ -1,5 +1,5 @@
 # Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
 
 module OCI
-  VERSION = '2.4.1'.freeze
+  VERSION = '2.4.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oci
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.4.2
 platform: ruby
 authors:
 - Oracle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-14 00:00:00.000000000 Z
+date: 2018-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json