oci 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: deead642983dcb680e7023da308d6b99c2194f2c
-  data.tar.gz: 94480a7fb20b82892e19d2323a0ebb62d0166ef4
+  metadata.gz: a2547706fa1e10fb27e6c82edc90e6ee138f65d1
+  data.tar.gz: e2f85e45a41f48d2a92174468bed39ac1658804c
 SHA512:
-  metadata.gz: 7185a217ff85b513d623f6af44e182c7512ef3c6a471db0a542a32fb6ba22bc738da7013ffbc14004d5a4b2dcf40572a86464b473f2f1333f58ce8bd7f6253bb
-  data.tar.gz: a4f3524b1ac8ac683a005df58529087aee58893409d191403b93135eeb5f671957a14cfe733e02b7abb00b628f837e5dc84c1f4340468378964e64611780fd16
+  metadata.gz: 537d4e1e3a4d61314e6d48f88c5f5a6f5450358c6d3bca3a3742a7ab9b1f2ca4ce7a2ff2ebddb9b0b4b023569f6d60190bb04887e50b6d8fbf9fadb85db6ecfe
+  data.tar.gz: d7862eed2f006296f3b9797d05a027cda94ceb4de85d0a867bf5dc36d7bd47b9addc47758efb928cba7228920731e8d01a564a452087d106efdb5e22df45dce3

data/README.md

@@ -1,5 +1,5 @@
 # Oracle Cloud Infrastructure Ruby SDK
-**Version 2.0.1**
+**Version 2.0.2**
 
 This topic describes how to install, configure, and use the Oracle Cloud Infrastructure Ruby SDK.
 
@@ -7,11 +7,12 @@ This topic describes how to install, configure, and use the Oracle Cloud Infrast
 
 The Ruby SDK supports the following services:
 
+* Audit
 * Core Services (which includes Networking Service, Compute Service, and Block Volume Service)
+* Database Service
 * Identity and Access Management Service
 * Load Balancing Service
 * Object Storage Service
-* Database Service
 
 **Licensing:** This SDK and sample is dual licensed under the Universal Permissive License 1.0 and the Apache License.
 

data/lib/oci.rb

@@ -13,11 +13,12 @@ require 'oci/signer'
 require 'oci/version'
 require 'oci/waiter'
 
+require 'oci/audit/audit'
 require 'oci/core/core'
+require 'oci/database/database'
 require 'oci/identity/identity'
 require 'oci/load_balancer/load_balancer'
 require 'oci/object_storage/object_storage'
-require 'oci/database/database'
 
 # Top level module for the Oracle Cloud Infrastructure SDK
 module OCI

data/lib/oci/audit/audit.rb

@@ -0,0 +1,19 @@
+# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
+
+module OCI
+  module Audit
+    module Models
+    end
+  end
+end
+
+# Require models
+require 'oci/audit/models/audit_event'
+require 'oci/audit/models/configuration'
+require 'oci/audit/models/update_configuration_details'
+
+# Require generated clients
+require 'oci/audit/audit_client'
+
+# Require service utilities
+require 'oci/audit/util'

data/lib/oci/audit/audit_client.rb

@@ -0,0 +1,176 @@
+# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
+
+require "uri"
+require "logger"
+
+module OCI
+
+  class Audit::AuditClient
+
+    # Client used to make HTTP requests.
+    # @return [OCI::ApiClient]
+    attr_reader :api_client
+
+    # Fully qualified endpoint URL
+    # @return [String]
+    attr_reader :endpoint
+
+    # The region, which will usually correspond to a value in {OCI::Regions::REGION_ENUM}.
+    # @return [String]
+    attr_accessor :region
+
+    # Creates a new AuditClient.
+    # If a config is not specified, then the global OCI.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 {OCI::Regions::REGION_ENUM}, but may be an arbitrary string.
+    #
+    def initialize(config:nil, region:nil)
+      config ||= OCI.config
+      config.validate
+
+      signer = Signer.new(config.user, config.fingerprint, config.tenancy, config.key_file, pass_phrase: config.pass_phrase, private_key_content: config.key_content, signing_strategy: Signer::STANDARD)
+      @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 {OCI::Regions::REGION_ENUM},
+    # but may be an arbitrary string.
+    def region=(r)
+      @region = r
+
+      fail 'A region must be specified.' unless @region
+
+      @endpoint = OCI::Regions.get_service_endpoint(@region, :AuditClient) + '/20160918'
+      logger.info "AuditClient endpoint set to '#{endpoint}'." if logger
+    end
+
+    # @return [Logger] The logger for this client. May be nil.
+    def logger
+      @api_client.config.logger
+    end
+
+
+    # Get the configuration
+    # @param [String] compartment_id ID of the root compartment (tenancy)
+    # @param [Hash] opts the optional parameters
+    # @return [Response] A Response object with data of type OCI::Audit::Models::Configuration
+    def get_configuration(compartment_id, opts = {})
+      logger.debug "Calling operation AuditClient#get_configuration." if logger
+
+      fail "Missing the required parameter 'compartment_id' when calling get_configuration." if compartment_id.nil?
+
+      path = "/configuration"
+
+      # Query Params
+      query_params = {}
+      query_params[:'compartmentId'] = compartment_id
+
+      # 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::Audit::Models::Configuration')
+    end
+
+    # Returns all audit events for the specified compartment that were processed within the specified time range.
+    # @param [String] compartment_id The OCID of the compartment.
+    # @param [DateTime] start_time Returns events that were processed at or after this start date and time, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
+    #   For example, a start value of `2017-01-15T11:30:00Z` will retrieve a list of all events processed since 30 minutes after the 11th hour of January 15, 2017, in Coordinated Universal Time (UTC).
+    #   You can specify a value with granularity to the minute. Seconds (and milliseconds, if included) must be set to `0`.
+    #   
+    # @param [DateTime] end_time Returns events that were processed before this end date and time, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. For example, a start value of `2017-01-01T00:00:00Z` and an end value of `2017-01-02T00:00:00Z` will retrieve a list of all events processed on January 1, 2017.
+    #   Similarly, a start value of `2017-01-01T00:00:00Z` and an end value of `2017-02-01T00:00:00Z` will result in a list of all events processed between January 1, 2017 and January 31, 2017.
+    #   You can specify a value with granularity to the minute. Seconds (and milliseconds, if included) must be set to `0`.
+    #   
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :page The value of the `opc-next-page` response header from the previous list query.
+    # @option opts [String] :opc_request_id Unique Oracle-assigned identifier for the request.
+    #   If you need to contact Oracle about a particular request, please provide the request ID.
+    #   
+    # @return [Response] A Response object with data of type Array<OCI::Audit::Models::AuditEvent>
+    def list_events(compartment_id, start_time, end_time, opts = {})
+      logger.debug "Calling operation AuditClient#list_events." if logger
+
+      fail "Missing the required parameter 'compartment_id' when calling list_events." if compartment_id.nil?
+      fail "Missing the required parameter 'start_time' when calling list_events." if start_time.nil?
+      fail "Missing the required parameter 'end_time' when calling list_events." if end_time.nil?
+
+      path = "/auditEvents"
+
+      # Query Params
+      query_params = {}
+      query_params[:'compartmentId'] = compartment_id
+      query_params[:'startTime'] = start_time
+      query_params[:'endTime'] = end_time
+      query_params[:'page'] = opts[:'page'] if opts[:'page']
+
+      # Header Params
+      header_params = {}
+      header_params['accept'] = 'application/json'
+      header_params['content-type'] = 'application/json'
+      header_params[:'opc-request-id'] = opts[:'opc_request_id'] if opts[:'opc_request_id']
+
+      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::Audit::Models::AuditEvent>')
+    end
+
+    # Update the configuration
+    # @param [String] compartment_id ID of the root compartment (tenancy)
+    # @param [UpdateConfigurationDetails] update_configuration_details The configuration properties
+    # @param [Hash] opts the optional parameters
+    # @return [Response] A Response object with data of type nil
+    def update_configuration(compartment_id, update_configuration_details, opts = {})
+      logger.debug "Calling operation AuditClient#update_configuration." if logger
+
+      fail "Missing the required parameter 'compartment_id' when calling update_configuration." if compartment_id.nil?
+      fail "Missing the required parameter 'update_configuration_details' when calling update_configuration." if update_configuration_details.nil?
+
+      path = "/configuration"
+
+      # Query Params
+      query_params = {}
+      query_params[:'compartmentId'] = compartment_id
+
+      # Header Params
+      header_params = {}
+      header_params['accept'] = 'application/json'
+      header_params['content-type'] = 'application/json'
+
+      post_body = @api_client.object_to_http_body(update_configuration_details)
+
+      return @api_client.call_api(
+        :PUT,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body)
+    end
+  end
+end

data/lib/oci/audit/models/audit_event.rb

@@ -0,0 +1,307 @@
+# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
+
+require 'date'
+
+module OCI
+  class Audit::Models::AuditEvent
+    # The OCID of the tenant.
+    # @return [String]
+    attr_accessor :tenant_id
+
+    # The OCID of the compartment.
+    # @return [String]
+    attr_accessor :compartment_id
+
+    # The GUID of the event.
+    # @return [String]
+    attr_accessor :event_id
+
+    # The source of the event.
+    # @return [String]
+    attr_accessor :event_source
+
+    # The type of the event.
+    # @return [String]
+    attr_accessor :event_type
+
+    # The time the event occurred, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
+    # @return [DateTime]
+    attr_accessor :event_time
+
+    # The OCID of the user whose action triggered the event.
+    # @return [String]
+    attr_accessor :principal_id
+
+    # The credential ID of the user. This value is extracted from the HTTP 'Authorization' request header. It consists of the tenantId, userId, and user fingerprint, all delimited by a slash (/).
+    # @return [String]
+    attr_accessor :credential_id
+
+    # The HTTP method of the request.
+    # @return [String]
+    attr_accessor :request_action
+
+    # The opc-request-id of the request.
+    # @return [String]
+    attr_accessor :request_id
+
+    # The user agent of the client that made the request.
+    # @return [String]
+    attr_accessor :request_agent
+
+    # The HTTP header fields and values in the request.
+    # @return [Hash<String, Array<String>>]
+    attr_accessor :request_headers
+
+    # The IP address of the source of the request.
+    # @return [String]
+    attr_accessor :request_origin
+
+    # The query parameter fields and values for the request.
+    # @return [Hash<String, Array<String>>]
+    attr_accessor :request_parameters
+
+    # The resource targeted by the request.
+    # @return [String]
+    attr_accessor :request_resource
+
+    # The headers of the response.
+    # @return [Hash<String, Array<String>>]
+    attr_accessor :response_headers
+
+    # The status code of the response.
+    # @return [String]
+    attr_accessor :response_status
+
+    # The time of the response to the audited request, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
+    # @return [DateTime]
+    attr_accessor :response_time
+
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      if attributes[:'tenantId']
+        self.tenant_id = attributes[:'tenantId']
+      end
+
+      if attributes[:'compartmentId']
+        self.compartment_id = attributes[:'compartmentId']
+      end
+
+      if attributes[:'eventId']
+        self.event_id = attributes[:'eventId']
+      end
+
+      if attributes[:'eventSource']
+        self.event_source = attributes[:'eventSource']
+      end
+
+      if attributes[:'eventType']
+        self.event_type = attributes[:'eventType']
+      end
+
+      if attributes[:'eventTime']
+        self.event_time = attributes[:'eventTime']
+      end
+
+      if attributes[:'principalId']
+        self.principal_id = attributes[:'principalId']
+      end
+
+      if attributes[:'credentialId']
+        self.credential_id = attributes[:'credentialId']
+      end
+
+      if attributes[:'requestAction']
+        self.request_action = attributes[:'requestAction']
+      end
+
+      if attributes[:'requestId']
+        self.request_id = attributes[:'requestId']
+      end
+
+      if attributes[:'requestAgent']
+        self.request_agent = attributes[:'requestAgent']
+      end
+
+      if attributes[:'requestHeaders']
+        self.request_headers = attributes[:'requestHeaders']
+      end
+
+      if attributes[:'requestOrigin']
+        self.request_origin = attributes[:'requestOrigin']
+      end
+
+      if attributes[:'requestParameters']
+        self.request_parameters = attributes[:'requestParameters']
+      end
+
+      if attributes[:'requestResource']
+        self.request_resource = attributes[:'requestResource']
+      end
+
+      if attributes[:'responseHeaders']
+        self.response_headers = attributes[:'responseHeaders']
+      end
+
+      if attributes[:'responseStatus']
+        self.response_status = attributes[:'responseStatus']
+      end
+
+      if attributes[:'responseTime']
+        self.response_time = attributes[:'responseTime']
+      end
+
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] other_object to be compared
+    def ==(other_object)
+      return true if self.equal?(other_object)
+      self.class == other_object.class &&
+          tenant_id == other_object.tenant_id &&
+          compartment_id == other_object.compartment_id &&
+          event_id == other_object.event_id &&
+          event_source == other_object.event_source &&
+          event_type == other_object.event_type &&
+          event_time == other_object.event_time &&
+          principal_id == other_object.principal_id &&
+          credential_id == other_object.credential_id &&
+          request_action == other_object.request_action &&
+          request_id == other_object.request_id &&
+          request_agent == other_object.request_agent &&
+          request_headers == other_object.request_headers &&
+          request_origin == other_object.request_origin &&
+          request_parameters == other_object.request_parameters &&
+          request_resource == other_object.request_resource &&
+          response_headers == other_object.response_headers &&
+          response_status == other_object.response_status &&
+          response_time == other_object.response_time
+    end
+
+    # @see the `==` method
+    # @param [Object] other_object to be compared
+    def eql?(other_object)
+      self == other_object
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [tenant_id, compartment_id, event_id, event_source, event_type, event_time, principal_id, credential_id, request_action, request_id, request_agent, request_headers, request_origin, request_parameters, request_resource, response_headers, response_status, response_time].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /^Array<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = send(attr)
+        next if value.nil? && !instance_variable_defined?("@#{attr}")
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    private
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value 
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map{ |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      { 
+        :'tenant_id' => :'tenantId',
+        :'compartment_id' => :'compartmentId',
+        :'event_id' => :'eventId',
+        :'event_source' => :'eventSource',
+        :'event_type' => :'eventType',
+        :'event_time' => :'eventTime',
+        :'principal_id' => :'principalId',
+        :'credential_id' => :'credentialId',
+        :'request_action' => :'requestAction',
+        :'request_id' => :'requestId',
+        :'request_agent' => :'requestAgent',
+        :'request_headers' => :'requestHeaders',
+        :'request_origin' => :'requestOrigin',
+        :'request_parameters' => :'requestParameters',
+        :'request_resource' => :'requestResource',
+        :'response_headers' => :'responseHeaders',
+        :'response_status' => :'responseStatus',
+        :'response_time' => :'responseTime'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      { 
+        :'tenant_id' => :'String',
+        :'compartment_id' => :'String',
+        :'event_id' => :'String',
+        :'event_source' => :'String',
+        :'event_type' => :'String',
+        :'event_time' => :'DateTime',
+        :'principal_id' => :'String',
+        :'credential_id' => :'String',
+        :'request_action' => :'String',
+        :'request_id' => :'String',
+        :'request_agent' => :'String',
+        :'request_headers' => :'Hash<String, Array<String>>',
+        :'request_origin' => :'String',
+        :'request_parameters' => :'Hash<String, Array<String>>',
+        :'request_resource' => :'String',
+        :'response_headers' => :'Hash<String, Array<String>>',
+        :'response_status' => :'String',
+        :'response_time' => :'DateTime'
+      }
+    end
+  end
+end