oraclebmc 1.2.4 → 2.0.0

data/lib/oraclebmc/api_client.rb

@@ -1,306 +0,0 @@
-# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
-
-require 'date'
-require 'json'
-require 'logger'
-require 'securerandom'
-require 'tempfile'
-require 'typhoeus'
-require 'uri'
-require_relative 'signer'
-require_relative 'version'
-require_relative 'response'
-
-module OracleBMC
-  class ApiClient
-    # The Config object holding settings to be used in the API client.
-    attr_accessor :config
-
-    # Defines the headers to be used in HTTP requests of all API calls by default.
-    #
-    # @return [Hash]
-    attr_accessor :default_headers
-
-    # Request options to be sent with each Typhoeus request.
-    # These options will override any defaults normally set by ApiClient.
-    # See {https://github.com/typhoeus/ethon/blob/master/lib/ethon/curls/options.rb} for
-    # some of the available options.
-    #
-    # @return [Hash]
-    attr_accessor :request_option_overrides
-
-    def initialize(config, signer)
-      fail "Missing the required parameter 'config' when initializing ApiClient." if config.nil?
-      fail "Missing the required parameter 'signer' when initializing ApiClient." if signer.nil?
-
-      @config = config
-      @signer = signer
-      @default_headers = {}
-      @request_option_overrides = {}
-    end
-
-    # Call an API with given options.
-    #
-    # @param [Symbol] http_method HTTP method/verb (e.g. :post, :get)
-    # @param [String] path URL path (e.g. /volumeAttachments/)
-    # @param [String] endpoint URL of the endpoint (e.g https://iaas.us-phoenix-1.oraclecloud.com/20160918)
-    # @option opts [Hash] :header_params Header parameters
-    # @option opts [Hash] :query_params Query parameters
-    # @option opts [Hash] :form_params Form parameters
-    # @option opts [Object] :body HTTP body in JSON
-    #
-    # @return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:
-    #   the data deserialized from response body (could be nil), response status code, and response headers.
-    def call_api(http_method, path, endpoint, opts)
-      http_method = http_method.to_sym.downcase
-
-      if http_method == :get
-        # Wrap get calls in a lambda that can be called later for paging
-        # and wait_until.
-        proc = lambda { |page|
-          if !page.nil?
-            opts[:query_params] ||= {}
-            opts[:query_params][:page] = page
-          end
-
-          return call_api_inner(http_method, path, endpoint, opts)
-        }
-
-        response = proc.call(nil)
-        response.api_call = proc
-        return response
-      else
-        # No need to wrap methods other than GET, just call them directly.
-        return call_api_inner(http_method, path, endpoint, opts)
-      end
-
-    end
-
-    # Convert object (array, hash, object, etc) to JSON string.
-    # @param [Object] model object to be converted into JSON string
-    # @return [String] JSON string representation of the object
-    def object_to_http_body(model)
-      return model if model.nil? || model.is_a?(String)
-      local_body = nil
-      if model.is_a?(Array)
-        local_body = model.map{|m| object_to_hash(m) }
-      else
-        local_body = object_to_hash(model)
-      end
-      local_body.to_json
-    end
-
-    # Builds the client info string to be sent with each request.
-    def build_request_id
-      return SecureRandom.uuid.gsub!('-', '').upcase
-    end
-
-    # Builds the client info string to be sent with each request.
-    def build_user_info
-      return "Oracle-RubySDK/#{VERSION}"
-    end
-
-    # Build the user agent string to be send with each request.
-    def build_user_agent
-      agent = "#{build_user_info} (ruby #{RUBY_VERSION}; #{RUBY_PLATFORM})"
-
-      if config.additional_user_agent
-        agent = "#{agent} #{config.additional_user_agent}"
-      end
-
-      agent
-    end
-
-    private
-
-    def call_api_inner(http_method, path, endpoint, opts)
-      request = build_request(http_method, path, endpoint, opts)
-
-      if defined? ResponseMocker
-        ResponseMocker.instance.process_request(request)
-      end
-
-      response = request.run
-
-      if defined? ResponseMocker
-        ResponseMocker.instance.process_response(response)
-      end
-
-      if @config.logger
-        @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
-      end
-
-      # In the case of an error, deserialize to a plain hash by indicating 'Object'.
-      return_type = response.success? ? opts[:return_type] : 'Object'
-
-      # If the response is timeout already ready, does not make sense to parse the http body because for lower
-      # version of CURL, partial response will be returned as well, we should ignore it.
-      if response.return_code.to_sym.downcase == :operation_timedout
-        fail Errors::NetworkError.new(response.return_code)
-      end
-
-      if return_type
-        data = deserialize(response, return_type)
-      else
-        data = nil
-      end
-
-      unless response.success?
-        if data and not response.success?
-          fail Errors::ServiceError.new(response.code, data[:code], response.headers['opc-request-id'], data[:message])
-        else
-          fail Errors::NetworkError.new(response.return_code)
-        end
-      end
-
-      if @config.logger
-        @config.logger.debug "API Response Received:\nData: #{data.inspect}\nStatus code: #{response.code}\nHeaders: #{response.headers}"
-      end
-
-      return Response.new(status=response.code, headers=response.headers, data=data)
-    end
-
-
-    # Builds the HTTP request
-    #
-    # @param [Symbol] http_method HTTP method/verb (e.g. :post, :get)
-    # @param [String] path URL path (e.g. /account/new)
-    # @param [String] endpoint URL of the endpoint
-    # @option opts [Hash] :header_params Header parameters
-    # @option opts [Hash] :query_params Query parameters
-    # @option opts [Hash] :form_params Query parameters
-    # @option opts [Object] :body HTTP body (JSON/XML)
-    # @return [Typhoeus::Request] A Typhoeus Request
-    def build_request(http_method, path, endpoint, opts = {})
-      url = build_request_url(path, endpoint)
-
-      header_params = @default_headers.merge(opts[:header_params] || {})
-      query_params = opts[:query_params] || {}
-      form_params = opts[:form_params] || {}
-      body = opts[:body] || nil
-
-      @signer.sign(http_method, ApiClient::append_query_params(url, query_params), header_params, body)
-
-      req_opts = {
-        :method => http_method,
-        :headers => header_params,
-        :params => query_params,
-        :connecttimeout => @config.connection_timeout,
-        :timeout => @config.timeout,
-        :verbose => @config.log_requests
-      }.merge(@request_option_overrides)
-
-      if [:post, :patch, :put, :delete].include?(http_method)
-        req_body = build_request_body(header_params, form_params, opts[:body])
-        req_opts.update :body => req_body
-        if @config.logger
-          @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
-        end
-      end
-
-      request = Typhoeus::Request.new(url, req_opts)
-      request.options[:headers]['opc-client-info'] = build_user_info
-      request.options[:headers]['opc-request-id'] ||= build_request_id
-      request.options[:headers]['User-Agent'] = build_user_agent
-
-      return request
-    end
-
-    def self.append_query_params(url, query_params)
-      if query_params.empty?
-        url
-      else
-        # This must mirror the logic in Typhoeus for building query strings.
-        # Unfortunately, Typhoeus does not appear to expose this logic or the result,
-        # so we have to replicate it here.
-        url + '?' + query_params.map{|k,v| "#{k}=#{CGI.escape(v)}"}.join('&')
-      end
-    end
-
-    # Check if the given MIME is a JSON MIME.
-    # JSON MIME examples:
-    #   application/json
-    #   application/json; charset=UTF8
-    #   APPLICATION/JSON
-    # @param [String] mime MIME
-    # @return [Boolean] True if the MIME is applicaton/json
-    def json_mime?(mime)
-       !(mime =~ /\Aapplication\/json(;.*)?\z/i).nil?
-    end
-
-    # Deserialize the response to the given return type.
-    #
-    # @param [Response] response HTTP response
-    # @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
-    def deserialize(response, return_type)
-      body = response.body
-      return nil if body.nil? || body.empty?
-
-      # return response body directly for String return type
-      return body if return_type == 'String'
-
-      # ensuring a default content type
-      content_type = response.headers['content-type'] || 'application/json'
-
-      fail "content-type is not supported: #{content_type}" unless json_mime?(content_type)
-
-      begin
-        data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
-      rescue JSON::ParserError => e
-        if %w(String Date DateTime).include?(return_type)
-          data = body
-        else
-          raise e
-        end
-      end
-
-      OracleBMC::Internal::Util.convert_to_type return_type, data
-    end
-
-    def build_request_url(path, endpoint)
-      # Add leading and trailing slashes to path
-      path = "/#{path}".gsub(/\/+/, '/')
-      URI.encode(endpoint + path)
-    end
-
-    # Builds the HTTP request body
-    #
-    # @param [Hash] header_params Header parameters
-    # @param [Hash] form_params Query parameters
-    # @param [Object] body HTTP body (JSON/XML)
-    # @return [String] HTTP body data in the form of string
-    def build_request_body(header_params, form_params, body)
-      # http form
-      if header_params['content-type'] == 'application/x-www-form-urlencoded' ||
-          header_params['content-type'] == 'multipart/form-data'
-        data = {}
-        form_params.each do |key, value|
-          case value
-          when File, Array, nil
-            # let typhoeus handle File, Array and nil parameters
-            data[key] = value
-          else
-            data[key] = value.to_s
-          end
-        end
-      elsif body
-        data = body.is_a?(String) ? body : body.to_json
-      else
-        data = nil
-      end
-      data
-    end
-
-    # Convert object(non-array) to hash.
-    # @param [Object] obj object to be converted into JSON string
-    # @return [String] JSON string representation of the object
-    def object_to_hash(obj)
-      if obj.respond_to?(:to_hash)
-        obj.to_hash
-      else
-        obj
-      end
-    end
-
-  end
-end

data/lib/oraclebmc/config.rb

@@ -1,80 +0,0 @@
-# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
-
-require 'uri'
-
-module OracleBMC
-  class Config
-
-    # OCID of the user to use for authentication.
-    # Example: ocidv1:user:oc1:phx:1460406592659:aaaaaaaawcbqrkycbolrirg2n3xjl5fabc
-    #
-    # @return [String]
-    attr_accessor :user
-
-    # SSL Fingerprint to use for authentication.
-    # Example: 20:3b:97:13:55:1c:1c:0d:d3:37:d8:50:4e:c5:3a:12
-    #
-    # @return [String]
-    attr_accessor :fingerprint
-
-    # OCID of the tenancy to use for authentication.
-    # Example: ocid1.tenancy.oc1..aaaaaaaaba3pv6wkcr4jqae5f15p2b2m2yt2j6rx32uzr4h25vqstifsfdsq
-    #
-    # @return [String]
-    attr_accessor :tenancy
-
-    # Client private key file.
-    # Example: ~/.ssh/bmc_key
-    #
-    # @return [String]
-    attr_accessor :key_file
-
-    # Pass phrase used for key file, if it is encrypted.
-    #
-    # @return [String]
-    attr_accessor :pass_phrase
-
-    # A region to use for APIs created with this Config.
-    #
-    # @return [OracleBMC::Regions::REGION_ENUM]
-    attr_accessor :region
-
-    # Defines the logger used for debugging.
-    # For example, log to STDOUT by setting this to Logger.new(STDOUT).
-    # This property cannot be set from a config file.
-    #
-    # @return [Logger]
-    attr_accessor :logger
-
-    # Whether to log detailed request and response
-    # data. This will always write to STDOUT.
-    # Defaults to false.
-    #
-    # @return [true, false]
-    attr_accessor :log_requests
-
-    # The time limit for HTTP request in seconds.
-    # Defaults to 0 (never times out).
-    #
-    # @return [Integer]
-    attr_accessor :timeout
-
-    # The time limit for the connection phase in seconds.
-    # Defaults to 10 seconds.
-    #
-    # @return [Integer]
-    attr_accessor :connection_timeout
-
-    # If set, then this string will be added to the
-    # user agent sent with each request.
-    #
-    # @return [String]
-    attr_accessor :additional_user_agent
-
-    def initialize
-      @timeout = 0
-      @connection_timeout = 10
-      @log_requests = false
-    end
-  end
-end

data/lib/oraclebmc/config_file_loader.rb

@@ -1,85 +0,0 @@
-# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
-
-require 'inifile'
-require_relative 'config'
-
-module OracleBMC
-
-  module ConfigFileLoader
-
-    module Errors
-      class ConfigFileNotFoundError < RuntimeError; end
-      class ProfileNotFoundError < RuntimeError; end
-      class DefaultProfileDoesNotExistError < RuntimeError; end
-    end
-
-    # Name of the default profile to load from a config file
-    DEFAULT_PROFILE = 'DEFAULT'
-
-    # Default config file name and location
-    DEFAULT_CONFIG_FILE = '~/.oraclebmc/config'
-
-    # Loads the a Config from the specified file and profile.
-    #
-    # @param [String] config_file_location Filename and path of the config file. Defaults to "~/.oraclebmc/config"
-    # @param [String] profile_name Name of the profile from the file. Defaults to "DEFAULT".
-    # @return [Config] A Config
-    def self.load_config(config_file_location: DEFAULT_CONFIG_FILE, profile_name: DEFAULT_PROFILE)
-      configs = load_configs(config_file_location)
-
-      if configs && configs.key?(profile_name)
-        return configs[profile_name]
-      else
-        raise Errors::ProfileNotFoundError.new("Profile not found in the given config file.")
-      end
-    end
-
-    # Loads all of the Configs from the specified file.
-    #
-    # @param [String] config_file_location Filename and path of the config file.
-    # @return [Array<Config>] An array containing all the configs found in the given file.
-    def self.load_configs(config_file_location)
-      config_file_location = File.expand_path(config_file_location)
-
-      unless File.file?(config_file_location)
-        raise Errors::ConfigFileNotFoundError.new("Config file does not exist.")
-      end
-
-      config_file = IniFile.load(config_file_location)
-      configs = {}
-
-      if config_file.nil? || !config_file.has_section?(DEFAULT_PROFILE)
-        raise Errors::DefaultProfileDoesNotExistError.new("The DEFAULT profile does not exist.")
-      end
-
-      config_file.each_section do |section|
-        config = Config.new
-
-        unless section.equal? DEFAULT_PROFILE
-          load_section(config_file[DEFAULT_PROFILE], config)
-        end
-        load_section(config_file[section], config)
-
-        configs[section] = config
-      end
-
-      return configs
-    end
-
-    def self.load_section(section, config)
-      section.each_key do |key|
-        value = section[key]
-
-        if key == "key_file"
-          value = File.expand_path(value)
-        end
-
-        config.instance_variable_set("@" + key, value)
-      end
-    end
-
-    private_class_method :load_section
-
-  end
-
-end