oraclebmc 1.1.1

data/lib/oraclebmc/signer.rb

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

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

data/lib/oraclebmc/waiter.rb

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

data/lib/oraclebmc.rb

@@ -0,0 +1,20 @@
+# Copyright (c) 2016 Oracle and/or its affiliates. All rights reserved.
+
+require 'oraclebmc/api_client'
+require 'oraclebmc/config'
+require 'oraclebmc/config_file_loader'
+require 'oraclebmc/errors'
+require 'oraclebmc/global_context'
+require 'oraclebmc/regions'
+require 'oraclebmc/response'
+require 'oraclebmc/signer'
+require 'oraclebmc/version'
+require 'oraclebmc/waiter'
+
+require 'oraclebmc/core/core'
+require 'oraclebmc/identity/identity'
+require 'oraclebmc/load_balancer/load_balancer'
+
+# Top level module for the Oracle Bare Metal Cloud SDK
+module OracleBMC
+end

metadata

@@ -0,0 +1,265 @@
+--- !ruby/object:Gem::Specification
+name: oraclebmc
+version: !ruby/object:Gem::Version
+  version: 1.1.1
+platform: ruby
+authors:
+- Oracle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+- !ruby/object:Gem::Dependency
+  name: inifile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+description: Ruby SDK for Oracle Bare Metal Cloud Services.
+email:
+- joe.levy@oracle.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- "./lib/oraclebmc.rb"
+- "./lib/oraclebmc/api_client.rb"
+- "./lib/oraclebmc/config.rb"
+- "./lib/oraclebmc/config_file_loader.rb"
+- "./lib/oraclebmc/core/blockstorage_client.rb"
+- "./lib/oraclebmc/core/compute_client.rb"
+- "./lib/oraclebmc/core/core.rb"
+- "./lib/oraclebmc/core/models/attach_i_scsi_volume_details.rb"
+- "./lib/oraclebmc/core/models/attach_volume_details.rb"
+- "./lib/oraclebmc/core/models/capture_console_history_details.rb"
+- "./lib/oraclebmc/core/models/console_history.rb"
+- "./lib/oraclebmc/core/models/cpe.rb"
+- "./lib/oraclebmc/core/models/create_cpe_details.rb"
+- "./lib/oraclebmc/core/models/create_dhcp_details.rb"
+- "./lib/oraclebmc/core/models/create_drg_attachment_details.rb"
+- "./lib/oraclebmc/core/models/create_drg_details.rb"
+- "./lib/oraclebmc/core/models/create_image_details.rb"
+- "./lib/oraclebmc/core/models/create_internet_gateway_details.rb"
+- "./lib/oraclebmc/core/models/create_ip_sec_connection_details.rb"
+- "./lib/oraclebmc/core/models/create_route_table_details.rb"
+- "./lib/oraclebmc/core/models/create_security_list_details.rb"
+- "./lib/oraclebmc/core/models/create_subnet_details.rb"
+- "./lib/oraclebmc/core/models/create_vcn_details.rb"
+- "./lib/oraclebmc/core/models/create_volume_backup_details.rb"
+- "./lib/oraclebmc/core/models/create_volume_details.rb"
+- "./lib/oraclebmc/core/models/dhcp_dns_option.rb"
+- "./lib/oraclebmc/core/models/dhcp_option.rb"
+- "./lib/oraclebmc/core/models/dhcp_options.rb"
+- "./lib/oraclebmc/core/models/drg.rb"
+- "./lib/oraclebmc/core/models/drg_attachment.rb"
+- "./lib/oraclebmc/core/models/egress_security_rule.rb"
+- "./lib/oraclebmc/core/models/i_scsi_volume_attachment.rb"
+- "./lib/oraclebmc/core/models/icmp_options.rb"
+- "./lib/oraclebmc/core/models/image.rb"
+- "./lib/oraclebmc/core/models/ingress_security_rule.rb"
+- "./lib/oraclebmc/core/models/instance.rb"
+- "./lib/oraclebmc/core/models/internet_gateway.rb"
+- "./lib/oraclebmc/core/models/ip_sec_connection.rb"
+- "./lib/oraclebmc/core/models/ip_sec_connection_device_config.rb"
+- "./lib/oraclebmc/core/models/ip_sec_connection_device_status.rb"
+- "./lib/oraclebmc/core/models/launch_instance_details.rb"
+- "./lib/oraclebmc/core/models/port_range.rb"
+- "./lib/oraclebmc/core/models/route_rule.rb"
+- "./lib/oraclebmc/core/models/route_table.rb"
+- "./lib/oraclebmc/core/models/security_list.rb"
+- "./lib/oraclebmc/core/models/shape.rb"
+- "./lib/oraclebmc/core/models/subnet.rb"
+- "./lib/oraclebmc/core/models/tcp_options.rb"
+- "./lib/oraclebmc/core/models/tunnel_config.rb"
+- "./lib/oraclebmc/core/models/tunnel_status.rb"
+- "./lib/oraclebmc/core/models/udp_options.rb"
+- "./lib/oraclebmc/core/models/update_cpe_details.rb"
+- "./lib/oraclebmc/core/models/update_dhcp_details.rb"
+- "./lib/oraclebmc/core/models/update_drg_attachment_details.rb"
+- "./lib/oraclebmc/core/models/update_drg_details.rb"
+- "./lib/oraclebmc/core/models/update_image_details.rb"
+- "./lib/oraclebmc/core/models/update_instance_details.rb"
+- "./lib/oraclebmc/core/models/update_internet_gateway_details.rb"
+- "./lib/oraclebmc/core/models/update_ip_sec_connection_details.rb"
+- "./lib/oraclebmc/core/models/update_route_table_details.rb"
+- "./lib/oraclebmc/core/models/update_security_list_details.rb"
+- "./lib/oraclebmc/core/models/update_subnet_details.rb"
+- "./lib/oraclebmc/core/models/update_vcn_details.rb"
+- "./lib/oraclebmc/core/models/update_volume_backup_details.rb"
+- "./lib/oraclebmc/core/models/update_volume_details.rb"
+- "./lib/oraclebmc/core/models/vcn.rb"
+- "./lib/oraclebmc/core/models/vnic.rb"
+- "./lib/oraclebmc/core/models/vnic_attachment.rb"
+- "./lib/oraclebmc/core/models/volume.rb"
+- "./lib/oraclebmc/core/models/volume_attachment.rb"
+- "./lib/oraclebmc/core/models/volume_backup.rb"
+- "./lib/oraclebmc/core/util.rb"
+- "./lib/oraclebmc/core/virtual_network_client.rb"
+- "./lib/oraclebmc/errors.rb"
+- "./lib/oraclebmc/global_context.rb"
+- "./lib/oraclebmc/identity/identity.rb"
+- "./lib/oraclebmc/identity/identity_client.rb"
+- "./lib/oraclebmc/identity/models/add_user_to_group_details.rb"
+- "./lib/oraclebmc/identity/models/api_key.rb"
+- "./lib/oraclebmc/identity/models/availability_domain.rb"
+- "./lib/oraclebmc/identity/models/compartment.rb"
+- "./lib/oraclebmc/identity/models/create_api_key_details.rb"
+- "./lib/oraclebmc/identity/models/create_compartment_details.rb"
+- "./lib/oraclebmc/identity/models/create_group_details.rb"
+- "./lib/oraclebmc/identity/models/create_policy_details.rb"
+- "./lib/oraclebmc/identity/models/create_swift_password_details.rb"
+- "./lib/oraclebmc/identity/models/create_user_details.rb"
+- "./lib/oraclebmc/identity/models/group.rb"
+- "./lib/oraclebmc/identity/models/policy.rb"
+- "./lib/oraclebmc/identity/models/swift_password.rb"
+- "./lib/oraclebmc/identity/models/ui_password.rb"
+- "./lib/oraclebmc/identity/models/update_compartment_details.rb"
+- "./lib/oraclebmc/identity/models/update_group_details.rb"
+- "./lib/oraclebmc/identity/models/update_policy_details.rb"
+- "./lib/oraclebmc/identity/models/update_state_details.rb"
+- "./lib/oraclebmc/identity/models/update_swift_password_details.rb"
+- "./lib/oraclebmc/identity/models/update_user_details.rb"
+- "./lib/oraclebmc/identity/models/user.rb"
+- "./lib/oraclebmc/identity/models/user_group_membership.rb"
+- "./lib/oraclebmc/identity/util.rb"
+- "./lib/oraclebmc/load_balancer/load_balancer.rb"
+- "./lib/oraclebmc/load_balancer/load_balancer_client.rb"
+- "./lib/oraclebmc/load_balancer/models/backend.rb"
+- "./lib/oraclebmc/load_balancer/models/backend_details.rb"
+- "./lib/oraclebmc/load_balancer/models/backend_set.rb"
+- "./lib/oraclebmc/load_balancer/models/backend_set_details.rb"
+- "./lib/oraclebmc/load_balancer/models/certificate.rb"
+- "./lib/oraclebmc/load_balancer/models/certificate_details.rb"
+- "./lib/oraclebmc/load_balancer/models/create_backend_details.rb"
+- "./lib/oraclebmc/load_balancer/models/create_backend_set_details.rb"
+- "./lib/oraclebmc/load_balancer/models/create_certificate_details.rb"
+- "./lib/oraclebmc/load_balancer/models/create_listener_details.rb"
+- "./lib/oraclebmc/load_balancer/models/create_load_balancer_details.rb"
+- "./lib/oraclebmc/load_balancer/models/health_checker.rb"
+- "./lib/oraclebmc/load_balancer/models/health_checker_details.rb"
+- "./lib/oraclebmc/load_balancer/models/ip_address.rb"
+- "./lib/oraclebmc/load_balancer/models/listener.rb"
+- "./lib/oraclebmc/load_balancer/models/listener_details.rb"
+- "./lib/oraclebmc/load_balancer/models/load_balancer.rb"
+- "./lib/oraclebmc/load_balancer/models/load_balancer_policy.rb"
+- "./lib/oraclebmc/load_balancer/models/load_balancer_protocol.rb"
+- "./lib/oraclebmc/load_balancer/models/load_balancer_shape.rb"
+- "./lib/oraclebmc/load_balancer/models/ssl_configuration.rb"
+- "./lib/oraclebmc/load_balancer/models/ssl_configuration_details.rb"
+- "./lib/oraclebmc/load_balancer/models/update_backend_details.rb"
+- "./lib/oraclebmc/load_balancer/models/update_backend_set_details.rb"
+- "./lib/oraclebmc/load_balancer/models/update_health_checker_details.rb"
+- "./lib/oraclebmc/load_balancer/models/update_listener_details.rb"
+- "./lib/oraclebmc/load_balancer/models/update_load_balancer_details.rb"
+- "./lib/oraclebmc/load_balancer/models/work_request.rb"
+- "./lib/oraclebmc/load_balancer/models/work_request_error.rb"
+- "./lib/oraclebmc/load_balancer/util.rb"
+- "./lib/oraclebmc/regions.rb"
+- "./lib/oraclebmc/response.rb"
+- "./lib/oraclebmc/signer.rb"
+- "./lib/oraclebmc/version.rb"
+- "./lib/oraclebmc/waiter.rb"
+- LICENSE.txt
+- README.md
+homepage: https://docs.us-phoenix-1.oraclecloud.com/tools/ruby/latest/frames.html
+licenses:
+- Universal Permissive License 1.0
+- Apache License 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Oracle Bare Metal Cloud Services Ruby SDK
+test_files: []
+has_rdoc: