oraclebmc 1.2.4 → 2.0.0

data/lib/oraclebmc/response.rb

@@ -1,86 +0,0 @@
-# Copyright (c) 2016, 2017, 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

data/lib/oraclebmc/signer.rb

@@ -1,119 +0,0 @@
-# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
-
-require 'base64'
-require 'digest'
-require 'openssl'
-require 'securerandom'
-require 'time'
-require 'uri'
-require 'cgi'
-
-module OracleBMC
-
-  # Used to sign HTTP requests as required by Oracle Bare Metal Cloud services.
-  class Signer
-
-    # The Oracle Bare Metal Cloud Services API signature version
-    SIGNATURE_VERSION = "1"
-
-    # Creates a Signer
-    #
-    # @param [String] user OCID of the user to be used for authentication, for example "ocidv1:user:oc1:phx:1460406592659:aaaaaaaawcbqrkycbolrirg2n3xjl5fyxe".
-    # @param [String] fingerprint Fingerprint of the key used for authentication, for example "20:3b:97:13:55:1c:5b:0d:d3:37:d8:50:4e:c5:3a:34"
-    # @param [String] tenancy OCID of the tenancy
-    # @param [String] private_key_file Full path and filename of the unencrypted PEM file, for example "/Users/bgustafs/.ssh/id_rsa.pem"
-    # @param [String] pass_phrase Optional pass phrase used to encrypt the private key
-    def initialize(user, fingerprint, tenancy, private_key_file, pass_phrase:nil)
-      fail 'Missing required parameter user.' unless user
-      fail 'Missing required parameter fingerprint.' unless fingerprint
-      fail 'Missing required parameter tenancy.' unless tenancy
-      fail 'Missing required parameter private_key_file.' unless private_key_file
-
-      @key_id = tenancy + "/" + user + "/" + fingerprint
-      @private_key_file = private_key_file
-      @pass_phrase = pass_phrase
-    end
-
-    # Generates the correct signature and adds it to the
-    # headers that are passed in. Also injects any required
-    # headers that might be missing.
-    #
-    # @param [Symbol] method The HTTP method, such as :get or :post.
-    # @param [String] uri The URI, such as 'https://iaas.us-phoenix-1.oraclecloud.com/20160918/volumeAttachments/'
-    # @param [Hash] headers A hash of headers
-    # @param [String] body The request body
-    def sign(method, uri, headers, body)
-      method = method.to_sym.downcase
-      uri = URI(uri)
-      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
-    end
-
-    private
-
-    GENERIC_HEADERS = [:"date", :"(request-target)", :"host"]
-    BODY_HEADERS = [:"content-length", :"content-type", :"x-content-sha256"]
-
-    OPERATION_HEADER_MAPPING = {
-        options: [],
-        get: GENERIC_HEADERS,
-        head: GENERIC_HEADERS,
-        delete: GENERIC_HEADERS,
-        put: GENERIC_HEADERS + BODY_HEADERS,
-        post: GENERIC_HEADERS + BODY_HEADERS
-    }
-
-    def inject_missing_headers(method, headers, body, uri)
-      headers["date"] ||= Time.now.utc.httpdate
-      headers["content-type"] ||= "application/json"
-      headers["accept"] ||= "*/*"
-      headers["host"] ||= uri.host
-
-      if method == :put || method == :post
-        body ||= ''
-        headers["content-length"] ||= body.length.to_s
-        headers["x-content-sha256"] ||= Digest::SHA256.base64digest(body)
-      end
-    end
-
-    def inject_authorization_header(headers, method, signature)
-      signed_headers = OPERATION_HEADER_MAPPING[method].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)
-      return if OPERATION_HEADER_MAPPING[method].empty?
-      signing_string = OPERATION_HEADER_MAPPING[method].map do |header|
-        if header == :"(request-target)"
-          "#{header}: #{method.downcase} #{path}"
-        else
-          "#{header}: #{headers[header.to_s]}"
-        end
-      end.join("\n")
-
-      signature = private_key.sign(OpenSSL::Digest::SHA256.new, signing_string.encode("ascii"))
-      Base64.strict_encode64(signature)
-    end
-
-    def private_key
-      # If a pass_phase was not provided and the key is in fact encrypted, then passing in
-      # nil for the passphrase here will show a user prompt and block until there is a response.
-      # Passing in an empty string will work for some versions of Ruby's openssl wrapper, but
-      # other versions will enforce the 4 character password minimum at this point. Passing in
-      # a dummy password that's greater than 4 characters avoids both problems, and will
-      # always succeed if the file is not encrypted.
-      @private_key ||= OpenSSL::PKey::RSA.new(File.read(@private_key_file), @pass_phrase || SecureRandom.uuid)
-    end
-  end
-
-end

data/lib/oraclebmc/version.rb

@@ -1,5 +0,0 @@
-# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
-
-module OracleBMC
-  VERSION = "1.2.4"
-end

data/lib/oraclebmc/waiter.rb

@@ -1,111 +0,0 @@
-# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
-
-module OracleBMC
-  module Waiter
-    module Errors
-      # Raised when a call to wait_until reaches the maximum wait time.
-      class MaximumWaitTimeExceededError < RuntimeError; end
-
-      # Raised when wait_until is called on a response that does not
-      # support waiters. Typically, waiters are only supported for
-      # get operations.
-      class WaitUntilNotSupportedError < RuntimeError; end
-
-      # If thrown from the yield statement of a waiter, it will cause the
-      # waiter to fail with this exception.
-      class WaiterFailedError < RuntimeError; end
-    end
-  end
-
-  class Response
-
-    # Wait until the value of the given property in the response data has
-    # the given value. This will block the current thread until the
-    # the desired state is reached, the maximum wait time is reached, or the
-    # optional yield block throws :stop_succeed or :stop_fail. This is only
-    # supported for responses resulting from GET operations. A typical use
-    # case is to wait on an instance until it is in a running state:
-    #
-    #     compute_client.get_instance(@instance_id).wait_until(:lifecycle_state, OracleBMC::Core::Models::Instance::LIFECYCLE_STATE_RUNNING)
-    #
-    # Although this can be run on any property of the data resulting from any
-    # GET operation, the most common use case is to check state properties on
-    # operations that GET a single object.
-    #
-    # The wait will poll at an increasing interval up to 'max_interval_seconds'
-    # for a maximum total time of 'max_wait_seconds'. If the maximum time
-    # is exceeded, then it will raise a {OracleBMC::Waiter::Errors::MaximumWaitTimeExceededError}.
-    #
-    # On successful completion the final Response object will be returned. The
-    # original Response object will not be altered.
-    #
-    # If any responses result in an error, then the error will be thrown as normal
-    # resulting in the wait being aborted.
-    #
-    # @param [Symbol] property The property of the response data to evaluate. For example, :lifecycle_state.
-    # @param state The value of the property that will indicate successful completion of the wait.
-    # @param [Integer] max_interval_seconds The maximum interval between queries, in seconds.
-    # @param [Integer] max_wait_seconds The maximum time to wait, in seconds.
-    # @yieldparam [Response] response A response object for every additional successful call to the get request.
-    #   Throw :stop_succeed from the yield to stop the waiter and return the current response.
-    #   Throw :stop_fail from the yield to stop the waiter and throw a WaiterFailedError.
-    # @return [Response] The final response, which will contain the property in the specified state.
-    def wait_until(property, state, max_interval_seconds: 30, max_wait_seconds: 1200)
-      fail 'Cannot wait on a response without data.' unless self.data
-      fail 'Response data does not contain the given property.' unless self.data.methods.include? property
-
-      raise Waiter::Errors::WaitUntilNotSupportedError.new('wait_until is not supported by this response.') unless @api_call
-
-      response = self
-      count = 0
-      interval_seconds = 1
-      start_time = Time.now
-
-      while true
-        if response.data.send(property) == state
-           return response
-        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 Waiter::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
-
-        response = @api_call.call(nil)
-
-        if block_given?
-          continue = false
-          catch(:stop_fail) {
-            catch(:stop_succeed) {
-              yield response
-              continue = true
-            }
-
-            if not continue
-              return response
-            end
-          }
-
-          if not continue
-            raise Waiter::Errors::WaiterFailedError
-          end
-        end
-      end
-
-    end
-
-  end
-end