ibm-cloud-sdk 0.1.2 → 0.1.7

data/lib/ibm/cloud/sdk/vpc/helpers/connection.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require 'time'
+require 'http'
+require_relative 'response'
+
+module IBM
+  module Cloud
+    module SDK
+      module VPC
+        # The Connection object to be used for all HTTP requests.
+        # @param api_key [String] The API Key to be used for this account.
+        # @param logger [Logger] An instantiated logger instance.
+        # @param client [HTTP::Client] An instantiated HTTP client.
+        class Connection
+          def initialize(api_key, logger: nil, client: nil)
+            @api_key = api_key
+            @logger = logger
+            @client = client
+            @token = Token.new(api_key, logger: logger, client: client)
+          end
+
+          attr_reader :client
+
+          # Send a HTTP request. Checks the validity of the response.
+          # @param verb [String] THe HTTP verb to use for this request.
+          # @param uri [String] The Full URL to send.
+          # @option opts [Hash] :params Parameters for URL encoding parameters.
+          # @option opts [Hash] :json Used when sending a hash as application/json content type.
+          # @option opts [Hash] :form Used when sending a hash as a form.
+          # @option opts [Hash] :headers Used to modify headers for request.
+          # @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 adhoc(verb, uri, opts = {})
+            unverified_request(verb, uri, opts).raise_for_status?
+          end
+
+          # Send a HTTP request. Don't do any validation checks.
+          # @see :adhoc for options.
+          def unverified_request(verb, uri, opts = {})
+            response = @client.auth(@token.authorization_header).request(verb.to_s.downcase.to_sym, uri, opts)
+            Response.new(response)
+          end
+
+          # Get bearer token string for clients not using the adhoc method.
+          def authorization_header
+            @token.authorization_header
+          end
+        end
+
+        # The IAM token manager.
+        # @param api_key [String] The API Key to be used for this account.
+        # @param logger [Logger] An instantiated logger instance.
+        # @param client [HTTP::Client] An instantiated HTTP client.
+        class Token
+          def initialize(api_key, logger: nil, client: nil)
+            @api_key = api_key
+            @logger = logger
+            @client = client
+            @data = fetch
+          end
+
+          # Retrieve a new access_token from IAM.
+          # @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 fetch
+            payload = {
+              form: {
+                grant_type: 'urn:ibm:params:oauth:grant-type:apikey',
+                apikey: @api_key
+              }
+            }
+            response = HTTP.post('https://iam.cloud.ibm.com/identity/token', payload)
+            @data = Response.new(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?
+            fetch unless @data
+            @data.fetch(:expiration).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
+end

data/lib/ibm/cloud/sdk/vpc/helpers/response.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+require 'time'
+require 'http'
+
+module IBM
+  module Cloud
+    module SDK
+      module VPC
+        # Encapsulate the HTTP response.
+        # @param response [HTTP::Response] The HTTP response object.
+        class Response
+          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(self, "#{url} Error while parsing response body. #{response.body}")
+          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&.connection
+          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&.mime_type
+          end
+
+          # Return the textual reason.
+          # @return [String] HTTP Reason
+          # @return [nil] Response does not have reaspn method that responds.
+          def reason
+            response&.reason
+          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
+            response&.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
+            response&.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(self, msg)
+          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(self, msg)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# typed: true
+# frozen_string_literal: true
+
+module IBM
+  module Cloud
+    module SDK
+      module VPC
+        # A list of IKEPolicy
+        class IKEPolicies < BaseCollection
+          def initialize(parent)
+            super(parent, 'ike_policies', child_class: IKEPolicy)
+          end
+        end
+
+        # A single IKEPolicy
+        class IKEPolicy < BaseInstance
+          def connections
+            get('connections')
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# typed: true
+# frozen_string_literal: true
+
+module IBM
+  module Cloud
+    module SDK
+      module VPC
+        # Work with multiple images.
+        class Images < BaseCollection
+          def initialize(parent)
+            super(parent, 'images', child_class: Image)
+          end
+        end
+
+        # Work with a single image.
+        class Image < BaseInstance
+        end
+      end
+    end
+  end
+end

data/lib/ibm/cloud/sdk/vpc/instance/actions.rb

@@ -0,0 +1,19 @@
+# typed: true
+# frozen_string_literal: true
+
+module IBM
+  module Cloud
+    module SDK
+      module VPC
+        module INSTANCES
+          # Actions for an instance.
+          class Actions < BaseCollection
+            def initialize(parent)
+              super(parent, 'actions')
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ibm/cloud/sdk/vpc/instance/floating_ips.rb

@@ -0,0 +1,23 @@
+# typed: true
+# frozen_string_literal: true
+
+module IBM
+  module Cloud
+    module SDK
+      module VPC
+        module INSTANCES
+          # Get a Floating IP.
+          class FloatingIps < BaseCollection
+            def initialize(parent)
+              super(parent, 'floating_ips', child_class: FloatingIp)
+            end
+          end
+
+          # Get a single floating IP.
+          class FloatingIp < BaseInstance
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ibm/cloud/sdk/vpc/instance/network_interfaces.rb

@@ -0,0 +1,28 @@
+# typed: true
+# frozen_string_literal: true
+
+require_relative('floating_ips')
+
+module IBM
+  module Cloud
+    module SDK
+      module VPC
+        module INSTANCES
+          # All netowrk interfaces.
+          class NetworkInterfaces < BaseCollection
+            def initialize(parent)
+              super(parent, 'network_interfaces', child_class: NetworkInterface)
+            end
+          end
+
+          # A single network insterface.
+          class NetworkInterface < BaseInstance
+            def floating_ips
+              FloatingIps.new(self)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ibm/cloud/sdk/vpc/instance/volume_attachments.rb

@@ -0,0 +1,23 @@
+# typed: true
+# frozen_string_literal: true
+
+module IBM
+  module Cloud
+    module SDK
+      module VPC
+        module INSTANCES
+          # Get all attached volumes.
+          class VolumeAttachments < BaseCollection
+            def initialize(parent)
+              super(parent, 'volume_attachments', child_class: VolumeAttachment)
+            end
+          end
+
+          # A single attached volume.
+          class VolumeAttachment < BaseInstance
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# typed: true
+# frozen_string_literal: true
+
+module IBM
+  module Cloud
+    module SDK
+      module VPC
+        # Work with multiple profiles.
+        class InstanceProfiles < BaseCollection
+          def initialize(parent)
+            super(parent, 'instance/profiles', child_class: Profile, array_key: 'profiles')
+          end
+        end
+
+        # Get a single profile.
+        class Profile < BaseInstance
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# typed: true
+# frozen_string_literal: true
+
+require_relative 'instance/actions'
+require_relative 'instance/network_interfaces'
+require_relative 'instance/volume_attachments'
+
+module IBM
+  module Cloud
+    module SDK
+      # Work with VPC instances.
+      module VPC
+        # Work with multiple VM instances.
+        class Instances < BaseCollection
+          def initialize(parent)
+            super(parent, 'instances', child_class: Instance)
+          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 name [String] Filters the collection to resources with the exact specified name
+          # @param vpc_id [String] Filters the collection to resources in the VPC with the specified identifier
+          # @param vpc_crn [String] Filters the collection to resources in the VPC with the specified CRN
+          # @param vpc_name [String] Filters the collection to resources in the VPC with the exact specified name
+          # @return [BaseCollection] This class with the param instance variable set.
+          def params(start: nil, limit: nil, name: nil, vpc_id: nil, vpc_crn: nil, vpc_name: nil)
+            super(start: start, limit: limit)
+            @params['name'] = name if name
+            @params['vpc.id'] = vpc_id if vpc_id
+            @params['vpc.crn'] = vpc_crn if vpc_crn
+            @params['vpc.name'] = vpc_name if vpc_name
+            self
+          end
+        end
+
+        # Work with a single instance.
+        class Instance < BaseInstance
+          def actions
+            INSTANCE::Actions.new(self)
+          end
+
+          def network_interfaces
+            INSTANCE::NetworkInterfaces.new(self)
+          end
+
+          def volume_attachments
+            INSTANCE::VolumeAttachments.new(self)
+          end
+
+          def profiles
+            INSTANCE::Profiles.new(self)
+          end
+
+          def initialization
+            adhoc(method: 'get', path: 'initialization').json
+          end
+        end
+      end
+    end
+  end
+end