oraclebmc 1.1.1

data/lib/oraclebmc/load_balancer/models/work_request.rb

@@ -0,0 +1,269 @@
+# Copyright (c) 2016 Oracle and/or its affiliates. All rights reserved.
+
+require 'date'
+
+module OracleBMC
+  class LoadBalancer::Models::WorkRequest
+
+    LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED',
+                LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS',
+                LIFECYCLE_STATE_FAILED = 'FAILED',
+                LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED']
+
+    # The [OCID](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the work request.
+    # @return [String]
+    attr_accessor :id
+
+    # The [OCID](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the load balancer with which the work request
+    # is associated.
+    # 
+    # @return [String]
+    attr_accessor :load_balancer_id
+
+    # The type of action the work request represents.
+    # 
+    # @return [String]
+    attr_accessor :type
+
+    # @return [String]
+    attr_accessor :lifecycle_state
+
+    # A collection of data, related to the load balancer provisioning process, that helps with debugging in the event of failure.
+    # Possible data elements include:
+    # 
+    # - workflow name
+    # - event ID
+    # - work request ID
+    # - load balancer ID
+    # - workflow completion message
+    # 
+    # @return [String]
+    attr_accessor :message
+
+    # The date and time the work request was created, in the format defined by RFC3339.
+    # 
+    # Example: `2016-08-25T21:10:29.600Z`
+    # 
+    # @return [DateTime]
+    attr_accessor :time_accepted
+
+    # The date and time the work request was completed, in the format defined by RFC3339.
+    # 
+    # Example: `2016-08-25T21:10:29.600Z`
+    # 
+    # @return [DateTime]
+    attr_accessor :time_finished
+
+    # @return [Array<OracleBMC::LoadBalancer::Models::WorkRequestError>]
+    attr_accessor :error_details
+
+
+    # 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[:'id']
+        self.id = attributes[:'id']
+      end
+      
+      if attributes[:'loadBalancerId']
+        self.load_balancer_id = attributes[:'loadBalancerId']
+      end
+      
+      if attributes[:'type']
+        self.type = attributes[:'type']
+      end
+      
+      if attributes[:'lifecycleState']
+        self.lifecycle_state = attributes[:'lifecycleState']
+      end
+      
+      if attributes[:'message']
+        self.message = attributes[:'message']
+      end
+      
+      if attributes[:'timeAccepted']
+        self.time_accepted = attributes[:'timeAccepted']
+      end
+      
+      if attributes[:'timeFinished']
+        self.time_finished = attributes[:'timeFinished']
+      end
+      
+      if attributes[:'errorDetails']
+        self.error_details = attributes[:'errorDetails']
+      end
+      
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] lifecycle_state Object to be assigned
+    def lifecycle_state=(lifecycle_state)
+      if lifecycle_state && !LIFECYCLE_STATE_ENUM.include?(lifecycle_state)
+        fail "Invalid value for 'lifecycle_state': this must be one of the values in LIFECYCLE_STATE_ENUM."
+      end
+      @lifecycle_state = lifecycle_state
+    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 &&
+          id == other_object.id &&
+          load_balancer_id == other_object.load_balancer_id &&
+          type == other_object.type &&
+          lifecycle_state == other_object.lifecycle_state &&
+          message == other_object.message &&
+          time_accepted == other_object.time_accepted &&
+          time_finished == other_object.time_finished &&
+          error_details == other_object.error_details
+    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
+      [id, load_balancer_id, type, lifecycle_state, message, time_accepted, time_finished, error_details].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| _deserialize($1, v) } )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(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 = self.send(attr)
+        next if value.nil?
+        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
+
+    # Deserializes the data based on type
+    # @param [String] type Data type
+    # @param [String] value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /^(true|t|yes|y|1)$/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = OracleBMC.const_get(type.to_s).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      { 
+        :'id' => :'id',
+        :'load_balancer_id' => :'loadBalancerId',
+        :'type' => :'type',
+        :'lifecycle_state' => :'lifecycleState',
+        :'message' => :'message',
+        :'time_accepted' => :'timeAccepted',
+        :'time_finished' => :'timeFinished',
+        :'error_details' => :'errorDetails'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      { 
+        :'id' => :'String',
+        :'load_balancer_id' => :'String',
+        :'type' => :'String',
+        :'lifecycle_state' => :'String',
+        :'message' => :'String',
+        :'time_accepted' => :'DateTime',
+        :'time_finished' => :'DateTime',
+        :'error_details' => :'Array<OracleBMC::LoadBalancer::Models::WorkRequestError>'
+      }
+    end
+  end
+end

data/lib/oraclebmc/load_balancer/models/work_request_error.rb

@@ -0,0 +1,185 @@
+# Copyright (c) 2016 Oracle and/or its affiliates. All rights reserved.
+
+require 'date'
+
+module OracleBMC
+  class LoadBalancer::Models::WorkRequestError
+
+    ERROR_CODE_ENUM = [ERROR_CODE_BAD_INPUT = 'BAD_INPUT',
+                ERROR_CODE_INTERNAL_ERROR = 'INTERNAL_ERROR']
+
+    # @return [String]
+    attr_accessor :error_code
+
+    # A human-readable error string.
+    # @return [String]
+    attr_accessor :message
+
+
+    # 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[:'errorCode']
+        self.error_code = attributes[:'errorCode']
+      end
+      
+      if attributes[:'message']
+        self.message = attributes[:'message']
+      end
+      
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] error_code Object to be assigned
+    def error_code=(error_code)
+      if error_code && !ERROR_CODE_ENUM.include?(error_code)
+        fail "Invalid value for 'error_code': this must be one of the values in ERROR_CODE_ENUM."
+      end
+      @error_code = error_code
+    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 &&
+          error_code == other_object.error_code &&
+          message == other_object.message
+    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
+      [error_code, message].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| _deserialize($1, v) } )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(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 = self.send(attr)
+        next if value.nil?
+        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
+
+    # Deserializes the data based on type
+    # @param [String] type Data type
+    # @param [String] value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /^(true|t|yes|y|1)$/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = OracleBMC.const_get(type.to_s).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      { 
+        :'error_code' => :'errorCode',
+        :'message' => :'message'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      { 
+        :'error_code' => :'String',
+        :'message' => :'String'
+      }
+    end
+  end
+end

data/lib/oraclebmc/load_balancer/util.rb

@@ -0,0 +1,55 @@
+# Copyright (c) 2016 Oracle and/or its affiliates. All rights reserved.
+
+module OracleBMC::LoadBalancer
+
+  # Load balancer utility methods
+  module Util
+
+    # Wait until the work request succeeds or fails, or max_wait_seconds is reached.
+    # The work request will be polled at an increasing rate, with a maximum of
+    # max_interval_seconds between requests.
+    #
+    # @param [LoadBalancerClient] client A load balancer client
+    # @param [Integer] max_interval_seconds The maximum interval between queries, in seconds.
+    # @param [Integer] max_wait_seconds The maximum total time to wait, in seconds.
+    # @param [Boolean] raise_error_on_failure If true, then a WorkRequestFailedError will be raised if the work request is in a failed state.
+    # @return [WorkRequest] The final work request
+    def self.wait_on_work_request(client, work_request_id, max_interval_seconds: 30, max_wait_seconds: 1200, raise_error_on_failure:true)
+      fail "Work request ID not specified." unless work_request_id
+
+      interval_seconds = 1
+      start_time = Time.now
+
+      while true
+        response = client.get_work_request(work_request_id)
+        if response.data.lifecycle_state == OracleBMC::LoadBalancer::Models::WorkRequest::LIFECYCLE_STATE_SUCCEEDED
+          return response.data
+        elsif response.data.lifecycle_state == OracleBMC::LoadBalancer::Models::WorkRequest::LIFECYCLE_STATE_FAILED
+          if raise_error_on_failure
+            raise OracleBMC::Errors::WorkRequestFailedError.new(response.data)
+          else
+            return response.data
+          end
+        end
+
+        elapsed_seconds = (Time.now - start_time).to_i
+
+        if elapsed_seconds + interval_seconds > max_wait_seconds
+          if max_wait_seconds > elapsed_seconds
+            # Make one last request right at the maximum wait time.
+            interval_seconds = max_wait_seconds - elapsed_seconds
+          else
+            raise OracleBMC::Errors::MaximumWaitTimeExceededError.new('Maximum wait time has been exceeded.')
+          end
+        end
+
+        sleep(interval_seconds)
+
+        interval_seconds *= 2
+        if interval_seconds > max_interval_seconds
+          interval_seconds = max_interval_seconds
+        end
+      end
+    end
+  end
+end

data/lib/oraclebmc/regions.rb

@@ -0,0 +1,41 @@
+# Copyright (c) 2016 Oracle and/or its affiliates. All rights reserved.
+
+module OracleBMC
+  module Regions
+
+    REGION_ENUM = [REGION_US_PHOENIX_1 = 'us-phoenix-1']
+
+    # Returns an endpoint for the given region and service.
+    #
+    # @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.
+    # @param [Symbol] service A symbol representing a service client class (e.g. :IdentityClient)
+    #
+    # @return [String] A fully qualified endpoint
+    def self.get_service_endpoint(region, service)
+      prefix = SERVICE_ENDPOINT_PREFIX_MAPPING[service]
+      fail "Service '#{service}' is not supported." unless prefix
+      format_endpoint(prefix, region)
+    end
+
+    # @return [Boolean] Returns true if the given string corresponds to a known region, as defined in {OracleBMC::Regions::REGION_ENUM}.
+    def self.valid_region? region
+      return REGION_ENUM.include? region
+    end
+
+    private
+
+    SERVICE_ENDPOINT_PREFIX_MAPPING = {
+        :BlockstorageClient => 'iaas',
+        :ComputeClient => 'iaas',
+        :VirtualNetworkClient => 'iaas',
+        :IdentityClient => 'identity',
+        :LoadBalancerClient => 'iaas',
+    }
+
+    def self.format_endpoint(prefix, region)
+      "https://#{prefix}.#{region}.oraclecloud.com"
+    end
+
+  end
+end

data/lib/oraclebmc/response.rb

@@ -0,0 +1,86 @@
+# Copyright (c) 2016 Oracle and/or its affiliates. All rights reserved.
+
+module OracleBMC
+
+  # A response, which represents all successful API calls.
+  class Response
+    # The HTTP status, such as 200, 401, etc
+    #
+    # @return [Integer]
+    attr_reader :status
+
+    # A hash containing all response headers
+    #
+    # @return [Hash]
+    attr_reader :headers
+
+    # The body of the response. For example, this
+    # may contain a User object, or a list of Users.
+    attr_reader :data
+
+    # The value of the next page token, if available,
+    # taken from the opc-next-page header.
+    #
+    # @return [String]
+    attr_reader :next_page
+
+    # The request ID, taken from the opc-request-id header.
+    #
+    # @return [String]
+    attr_reader :request_id
+
+    def initialize(status, headers, data)
+      @status = status
+      @headers = headers
+      @data = data
+
+      if headers
+        @next_page = headers["opc-next-page"]
+        @request_id = headers["opc-request-id"]
+      end
+    end
+
+    # Returns true if there is another page available.
+    def has_next_page?
+      return !next_page.nil?
+    end
+
+    include Enumerable
+
+    # For paged responses, yields each page until the last page is reached.
+    # For example:
+    #
+    #     OracleBMC::Identity::IdentityClient.new.list_users(compartment, limit:'3').each { |r| r.data.each { |user| puts user.name }}
+    #
+    # The first response yielded is always the response that 'each' is being
+    # called on.
+    #
+    # If any of the requests result in an error, that error will be thrown
+    # as normal, which will abort the enumeration.
+    #
+    # While this can be called on non-paged responses, it will simply result
+    # in the response itself being yielded.
+    #
+    # @yieldparam [Response] response A response object for each page, starting with the response used to call 'each'.
+    def each
+      yield self
+      page = @next_page
+
+      while @api_call && page
+        next_response = @api_call.call(page)
+
+        if page == next_response.next_page
+          fail "Paging failure: Two consecutive responses had the same next page token."
+        end
+
+        page = next_response.next_page
+        yield next_response
+      end
+    end
+
+    def api_call=(c)
+      @api_call = c
+    end
+
+  end
+end