ibm-cloud-sdk 0.1.9 → 0.1.10

data/lib/ibm/cloud/sdk_http/exceptions.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module IBM
+  module Cloud
+    module SDKHTTP
+      # Module to contain all custom exception classes.
+      module Exceptions
+        # An exception for http with a response attribute.
+        # @param msg [String] A human readable message.
+        # @param response [IBM::Cloud::SDK::VPC::Response] The original response object.
+        class ExceptionWithResponse < RuntimeError
+          def initialize(msg, response)
+            @response = response
+            super(msg)
+          end
+          # @return [IBM::Cloud::SDK::VPC::Response] The response
+          attr_reader :response
+        end
+
+        # An exception for http status errors with a response attribute.
+        # @param response [IBM::Cloud::SDK::VPC::Response] The original response object.
+        class HttpStatusError < ExceptionWithResponse
+          def initialize(response)
+            msg = "Invalid status #{response.code} for url \"#{response.url}\", #{response.reason}. #{response.body}"
+            super(msg, response)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ibm/cloud/{sdk/vpc/base_mixins → sdk_http}/has_child.rb

@@ -3,23 +3,19 @@
 
 module IBM
   module Cloud
-    module SDK
+    module SDKHTTP
       # Access a specific instance by either id or name depending on API.
       module ChildMixin
         # Get an instance of the collection object.
         # @param id [String] ID of Name to search on depending on API.
         # @return [] The instance object.
         def instance(id)
-          @instance.new(self, id)
+          @instance.new(self, endpoint: id).refresh
         end
 
         # Return the first_instance returned from a collection get.
         def first_instance
-          result = params(limit: 1).all.first
-          return nil unless result
-          return nil unless result.key?(:id)
-
-          instance(result.fetch(:id))
+          params(limit: 1).all.first
         end
       end
     end

data/lib/ibm/cloud/sdk_http/iam_token.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module IBM
+  module Cloud
+    # Module holds basic HTTP functionality.
+    module SDKHTTP
+      # Used to authenticate with IAM.
+      class IAMToken
+        include BaseHTTPMixin
+
+        def initialize(api_key, connection, logger: nil)
+          @api_key = api_key
+          @logger = logger
+          @connection = connection
+          @response = nil
+          @data = nil
+        end
+
+        attr_reader :response, :connection
+
+        def fetch
+          payload = {
+            body: {
+              grant_type: 'urn:ibm:params:oauth:grant-type:apikey',
+              apikey: @api_key
+            }
+          }
+          @response = @connection.request('post', 'https://iam.cloud.ibm.com/identity/token', payload)
+        end
+
+        def data
+          fetch unless @response
+          @response.raise_for_status!.json
+        end
+
+        # Check to see if the access_token is expired. Fetch a new token if none exists.
+        # @return [IBM::Cloud::SDK::VPC::Response] Wrapped response to query.
+        # @raise [IBM::Cloud::SDK::VPC::Exceptions::HttpStatusError] Response code is not either in 200-series or 404.
+        def expired?
+          data.fetch(:expiration, 0).to_i <= Time.now.to_i + 600
+        end
+
+        # Get a Bearer token string. Before returning check to see if token is expired.
+        # @return [String] The Bearer token header used in subsequent requests.
+        # @raise [IBM::Cloud::SDK::VPC::Exceptions::HttpStatusError] Response code is not either in 200-series or 404.
+        def authorization_header
+          fetch if expired?
+          "#{data.fetch(:token_type)} #{data.fetch(:access_token)}"
+        end
+      end
+    end
+  end
+end

data/lib/ibm/cloud/sdk_http/sdk_response.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module IBM
+  module Cloud
+    # Module holds basic HTTP functionality.
+    module SDKHTTP
+      # Encapsulate the HTTP response.
+      # @param response [HTTP::Response] The HTTP response object.
+      class SDKResponse
+        def initialize(response)
+          @response = response
+        end
+
+        # The raw HTTP response.
+        # @return [HTTP::Response]
+        attr_reader :response
+
+        # Return the response in a hash or array.
+        # @return [Hash] When response is a hash.
+        # @return [Array] When response is an array.
+        # @raise [Exceptions::ExceptionWithResponse] Contents of body is not properly formatted json.
+        def json
+          JSON.parse(body, symbolize_names: true)
+        rescue StandardError
+          raise Exceptions::ExceptionWithResponse.new("#{url} Error while parsing response body. #{response.body}", self)
+        end
+
+        # Return the raw response string.
+        # @return [String]
+        # @return [nil] Response does not have body method.
+        def body
+          response&.body.to_s
+        end
+
+        # Return the response code.
+        # @return [Integer] Response has code method.
+        # @return [nil] Response does not have code method.
+        def code
+          response&.code
+        end
+
+        alias status code
+
+        # Return the raw connection object.
+        # @return [HTTP::Connection]
+        # @return [nil] Response does not have a connection method.
+        def connection
+          response&.request
+        end
+
+        # Chainable method to verify the status code. Raise an exception for non 200-series or 404 status codes.
+        # @return [Response] Allows for method to be chainable.
+        # @raise [Exceptions::HttpStatusError] Raise if status checks failed.
+        def raise_for_status!
+          return self if (200..299).include?(code)
+          return self if code == 404
+
+          raise Exceptions::HttpStatusError.new(self)
+        end
+
+        # Return the content type of the response.
+        # @return [String] The mimetype of the response.
+        # @return [nil] Response does not have response method that responds to mime_type.
+        def content_type
+          response&.response&.content_type
+        end
+
+        # Return the textual reason.
+        # @return [String] HTTP Reason
+        # @return [nil] Response does not have reaspn method that responds.
+        def reason
+          response&.response&.msg
+        end
+
+        # Return the sent url as a string.
+        # @return [String] Full URL sent
+        # @return [nil] Response does not have response method that responds to mime_type.
+        def url
+          uri.to_s
+        end
+
+        # Return the sent url as a URI class.
+        # @see https://github.com/httprb/http/blob/master/lib/http/uri.rb URI Class doc.
+        # @return [HTTP::URI]
+        # @return [nil] Response does not have response method that responds to mime_type.
+        def uri
+          connection&.uri
+        end
+
+        # Verify that the json response is a hash.
+        # @return [Hash] Response from JSON
+        # @raise [RuntimeError] JSON object is not a Hash.
+        def hash_response
+          check_object(Hash)
+        end
+
+        # Verify that the json response is an array.
+        # @return [Array] Response from JSON
+        # @raise [RuntimeError] JSON object is not a Array.
+        def array_response
+          check_object(Array)
+        end
+
+        # Find a subkey within the returned response.
+        # @param key [String] Name of a first level key.
+        # @return [Any] Response from JSON
+        # @raise [RuntimeError] JSON object is not a Array.
+        def subkey(key)
+          ret = hash_response
+          sym_key = key.to_sym
+          return ret.fetch(sym_key) if ret.key?(sym_key)
+
+          msg = "Key #{key} not found in #{ret}."
+          raise Exceptions::ExceptionWithResponse.new(msg, self)
+        end
+
+        # Check to see if the returned object is the expected object.
+        # @param obj [Object] The object to test the response against.
+        # @raise [Exceptions::ExceptionWithResponse] Parsed JSON is not the expecte class.
+        def check_object(obj)
+          ret = json
+          return ret if ret.instance_of?(obj)
+
+          msg = "Expected #{obj} in response for #{url}. The returned object is a #{ret.class}."
+          raise Exceptions::ExceptionWithResponse.new(msg, self)
+        end
+      end
+    end
+  end
+end

data/lib/ibm/cloud_sdk.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'httparty'
+
+require_relative 'cloud/sdk_http'
+require_relative 'cloud/sdk/vpc'
+require_relative 'cloud/sdk/tags'
+
+module IBM
+  # Holds the SDK pieces.
+  class CloudSDK
+    def initialize(api_key, logger: nil)
+      @logger = logger || Logger.new($stdout, level: :warn)
+      @connection = IBM::Cloud::SDKHTTP::HTTPConnection.new(@logger)
+      @token = IBM::Cloud::SDKHTTP::IAMToken.new(api_key, @connection, logger: @logger)
+    end
+
+    attr_reader :logger, :token, :connection
+
+    # Add a proxy to the configuration.
+    # @param uri [URI::Generic] A URI object with proxy configuration.
+    def add_proxy(uri)
+      raise "URI #{uri} is not set properly. Requires a full url, and optional user & password" if uri.relative?
+
+      path = "#{uri.scheme}://#{uri.hostname}"
+      @connection.class.http_proxy(path, uri.port, uri.user, uri.password)
+    end
+
+    def tags
+      @tags ||= IBM::Cloud::SDK::Tags.new(@connection, @token, logger: @logger)
+    end
+
+    # Get an instance of the VPC API.
+    # @param region [String] The region to use for the VPC connection.
+    def vpc(region = 'us-east')
+      @vpc ||= IBM::Cloud::SDK::Vpc.new(region, @connection, @token, logger: @logger)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ibm-cloud-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors:
 - IBM Cloud Developers
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-02 00:00:00.000000000 Z
+date: 2020-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: http
+  name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -65,18 +65,17 @@ files:
 - lib/ibm/cloud/sdk/power_iaas.rb
 - lib/ibm/cloud/sdk/resource_controller.rb
 - lib/ibm/cloud/sdk/resource_controller/resource.rb
+- lib/ibm/cloud/sdk/tags.rb
+- lib/ibm/cloud/sdk/tags/http.rb
+- lib/ibm/cloud/sdk/tags/http/tag_collection.rb
 - lib/ibm/cloud/sdk/version.rb
 - lib/ibm/cloud/sdk/vpc.rb
-- lib/ibm/cloud/sdk/vpc/base_collection.rb
-- lib/ibm/cloud/sdk/vpc/base_instance.rb
-- lib/ibm/cloud/sdk/vpc/base_mixins/has_child.rb
-- lib/ibm/cloud/sdk/vpc/base_vpc.rb
-- lib/ibm/cloud/sdk/vpc/cloud_sdk.rb
-- lib/ibm/cloud/sdk/vpc/exceptions.rb
 - lib/ibm/cloud/sdk/vpc/floatingips.rb
 - lib/ibm/cloud/sdk/vpc/flowlogcollectors.rb
-- lib/ibm/cloud/sdk/vpc/helpers/connection.rb
-- lib/ibm/cloud/sdk/vpc/helpers/response.rb
+- lib/ibm/cloud/sdk/vpc/http.rb
+- lib/ibm/cloud/sdk/vpc/http/vpc_collection.rb
+- lib/ibm/cloud/sdk/vpc/http/vpc_http.rb
+- lib/ibm/cloud/sdk/vpc/http/vpc_instance.rb
 - lib/ibm/cloud/sdk/vpc/ike_policies.rb
 - lib/ibm/cloud/sdk/vpc/images.rb
 - lib/ibm/cloud/sdk/vpc/instance/actions.rb
@@ -107,12 +106,22 @@ files:
 - lib/ibm/cloud/sdk/vpc/vpn_gateway/local_cidrs.rb
 - lib/ibm/cloud/sdk/vpc/vpn_gateway/peer_cidrs.rb
 - lib/ibm/cloud/sdk/vpc/vpn_gateways.rb
+- lib/ibm/cloud/sdk_http.rb
+- lib/ibm/cloud/sdk_http/base_collection.rb
+- lib/ibm/cloud/sdk_http/base_http_mixin.rb
+- lib/ibm/cloud/sdk_http/base_instance.rb
+- lib/ibm/cloud/sdk_http/connection.rb
+- lib/ibm/cloud/sdk_http/exceptions.rb
+- lib/ibm/cloud/sdk_http/has_child.rb
+- lib/ibm/cloud/sdk_http/iam_token.rb
+- lib/ibm/cloud/sdk_http/sdk_response.rb
+- lib/ibm/cloud_sdk.rb
 homepage: https://github.com/IBM-Cloud/ibm-cloud-sdk-ruby
 licenses:
 - '"Apache-2.0"'
 metadata:
   homepage_uri: https://github.com/IBM-Cloud/ibm-cloud-sdk-ruby
-  changelog_uri: https://github.com/IBM-Cloud/ibm-cloud-sdk-ruby/blob/v0.1.9/CHANGELOG.md
+  changelog_uri: https://github.com/IBM-Cloud/ibm-cloud-sdk-ruby/blob/v0.1.10/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:

data/lib/ibm/cloud/sdk/vpc/base_collection.rb

@@ -1,107 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-require_relative('base_mixins/has_child')
-
-module IBM
-  module Cloud
-    module SDK
-      # Container that encapsulates the VPC API.
-      class BaseCollection < BaseVPC
-        # This class is used as a base for collection APIs.
-        # @param parent [Object] The parent instance in the API chain.
-        # @param endpoint [string] A path from the parent to the desired endpoint. In most cases is should be 1 word.
-        # @param array_key [string] The key that the API response holds the endpoint data. When nil the endpoint will be used.
-        # @param child_class [Object] The Object to be used when instanciating the single instance for this class.
-        def initialize(parent, endpoint, array_key: nil, child_class: nil)
-          # Setup empty base instance variables.
-          @params = nil
-
-          array_key ||= endpoint
-
-          # Set the array key and child class.
-          @array_key ||= array_key
-          @instance ||= child_class
-
-          (class << self; include ChildMixin; end) if child_class
-
-          super(parent, endpoint)
-        end
-
-        # A chainable method to set query filters on the collection.
-        # @example vpc.images.params(limit: 1).all
-        #
-        # @param start [String] A server-supplied token determining what resource to start the page on.
-        # @param limit [Integer] The number of resources to return on a page  allowed values are between 1 and 100
-        # @param resource_group [String] Filters the collection to resources within one of the resource groups identified in a comma-separated list of resource group identifiers
-        # @return [BaseCollection] This class with the param instance variable set.
-        def params(start: nil, limit: nil, resource_group: nil)
-          @params = {}
-          @params[:start] = start if start
-          @params[:limit] = limit if limit
-          @params[:resource_group] = resource_group if resource_group
-          self
-        end
-
-        # Retrieve the collection from the cloud.
-        # @return [IBM::Cloud::SDK::VPC::Response] The http response object.
-        def fetch
-          @data ||= get(params: @params)
-        end
-
-        # Get an iterable for the resource collection.
-        # @return [Enumerator] Use standard each, next idioms.
-        def all
-          each_resource(url)
-        end
-
-        # Fetch all data and return in an array.
-        # @return [Array] Hashes of the returned data.
-        def data
-          all.to_a
-        end
-
-        # Determine if the collection has a total_count key in its response.
-        # @return [Boolean]
-        def has_count?
-          fetch.json&.key?(:total_count)
-        end
-
-        # Get the total count if it exists in the response. Returns nil otherwise.
-        # @return [Integer] The total count reuturned by the server.
-        def count
-          fetch.json&.fetch(:total_count, nil)
-        end
-
-        # A generic post method to create a resource on the collection.
-        # @param payload [Hash] A hash of parameters to send to the server.
-        # @param payload_type [String] One of the following options json, form, or body.
-        # @return [IBM::Cloud::SDK::VPC::Response] The http response object.
-        def create(payload, payload_type = 'json')
-          adhoc(method: 'post', payload_type: payload_type, payload: payload)
-        end
-
-        private
-
-        # Create a generator that removes the need for pagination.
-        def each_resource(url, &block)
-          return enum_for(:each_resource, url) unless block_given?
-          return unless url
-
-          response = @connection.adhoc('get', url, metadata(@params)).json
-          resources = response.fetch(@array_key.to_sym)
-
-          resources&.each do |value|
-            yield value
-          end
-          return unless response.key?(:next)
-
-          next_url = response.dig(:next, :href)
-          return unless next_url
-
-          each_resource(next_url, &block)
-        end
-      end
-    end
-  end
-end