ibm-cloud-sdk 0.1.6 → 0.1.11

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

@@ -6,28 +6,28 @@ module IBM
     module SDK
       module VPC
         # Work with VPC reqions
-        class Regions < BaseCollection
+        class Regions < VPCCollection
           def initialize(parent)
             super(parent, 'regions', child_class: Region)
           end
         end
 
         # Work with a single region
-        class Region < BaseInstance
+        class Region < VPCInstance
           def zones
             Zones.new(self)
           end
         end
 
         # Zones are included within a region.
-        class Zones < BaseCollection
+        class Zones < VPCCollection
           def initialize(parent)
             super(parent, 'zones', child_class: Zone)
           end
         end
 
         # A single zone.
-        class Zone < BaseInstance
+        class Zone < VPCInstance
         end
       end
     end

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

@@ -6,14 +6,14 @@ module IBM
     module SDK
       module VPC
         # Work with VPC reqions
-        class SecurityGroups < BaseCollection
+        class SecurityGroups < VPCCollection
           def initialize(parent)
             super(parent, 'security_groups', child_class: SecurityGroup)
           end
         end
 
         # Work with VPC reqions
-        class SecurityGroup < BaseCollection
+        class SecurityGroup < VPCInstance
           def network_interfaces
             SECURITYGROUP::NetworkInterfaces.new(self)
           end
@@ -21,25 +21,25 @@ module IBM
 
         module SECURITYGROUP
           # Work with interfaces associated with parent group.
-          class NetworkInterfaces < BaseCollection
+          class NetworkInterfaces < VPCCollection
             def initialize(parent)
               super(parent, 'network_interfaces', child_class: NetworkInterface)
             end
           end
 
           # Work with a single rule.
-          class NetworkInterface < BaseInstance
+          class NetworkInterface < VPCInstance
           end
 
           # Work with rules associated with parent group.
-          class Rules < BaseCollection
+          class Rules < VPCCollection
             def initialize(parent)
               super(parent, 'rules', child_class: Rule)
             end
           end
 
           # Work with a single rule.
-          class Rule < BaseInstance
+          class Rule < VPCInstance
           end
         end
       end

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

@@ -6,14 +6,14 @@ module IBM
     module SDK
       module VPC
         # A list of submetes
-        class Subnets < BaseCollection
+        class Subnets < VPCCollection
           def initialize(parent)
             super(parent, 'subnets', child_class: Subnet)
           end
         end
 
         # A single subnet
-        class Subnet < BaseInstance
+        class Subnet < VPCInstance
         end
       end
     end

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

@@ -6,14 +6,14 @@ module IBM
     module SDK
       module VPC
         # Work with Volume Profiles.
-        class VolumeProfiles < BaseCollection
+        class VolumeProfiles < VPCCollection
           def initialize(parent)
             super(parent, 'volume/profiles', child_class: VolumeProfile, array_key: 'profiles')
           end
         end
 
         # Work with a single volume profile.
-        class VolumeProfile < BaseInstance
+        class VolumeProfile < VPCInstance
         end
       end
     end

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

@@ -6,14 +6,14 @@ module IBM
     module SDK
       module VPC
         # Work with a collection of volumes.
-        class Volumes < BaseCollection
+        class Volumes < VPCCollection
           def initialize(parent)
             super(parent, 'volumes', child_class: Volume)
           end
         end
 
         # Work with a single volume.
-        class Volume < BaseInstance
+        class Volume < VPCInstance
         end
       end
     end

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

@@ -6,14 +6,14 @@ module IBM
     module SDK
       module VPC
         # A list of Vpc
-        class Vpcs < BaseCollection
+        class Vpcs < VPCCollection
           def initialize(parent)
             super(parent, 'vpcs', child_class: VpcInstance)
           end
         end
 
         # A single Vpc
-        class VpcInstance < BaseInstance
+        class VpcInstance < VPCInstance
           def default_network_acl
             get('default_network_acl')
           end
@@ -33,25 +33,25 @@ module IBM
 
         module VPCS
           # A list of Vpc
-          class AddressPrefixes < BaseCollection
+          class AddressPrefixes < VPCCollection
             def initialize(parent)
               super(parent, 'address_prefixes', child_class: AddressPrefix)
             end
           end
 
           # A single Vpc
-          class AddressPrefix < BaseInstance
+          class AddressPrefix < VPCInstance
           end
 
           # A list of Vpc
-          class Routes < BaseCollection
+          class Routes < VPCCollection
             def initialize(parent)
               super(parent, 'routes', child_class: Route)
             end
           end
 
           # A single Vpc
-          class Route < BaseInstance
+          class Route < VPCInstance
           end
         end
       end

data/lib/ibm/cloud/sdk/vpc/vpn_gateway/connections.rb

@@ -10,7 +10,7 @@ module IBM
       module VPC
         module VPNGATEWAY
           # A list of Connection
-          class Connections < BaseCollection
+          class Connections < VPCCollection
             def initialize(parent)
               @array_key = 'connections'
               @instance = Connection
@@ -19,7 +19,7 @@ module IBM
           end
 
           # A single Connection
-          class Connection < BaseInstance
+          class Connection < VPCInstance
             def local_cidrs
               LocalCIDRs.new(self)
             end

data/lib/ibm/cloud/sdk/vpc/vpn_gateway/local_cidrs.rb

@@ -7,7 +7,7 @@ module IBM
       module VPC
         module VPNGATEWAY
           # A list of Connection
-          class LocalCIDRs < BaseCollection
+          class LocalCIDRs < VPCCollection
             def initialize(parent)
               @array_key = 'local_cidrs'
               @instance = Connection
@@ -20,9 +20,9 @@ module IBM
           end
 
           # A single Connection
-          class LocalCIDR < BaseInstance
+          class LocalCIDR < VPCInstance
             def update(payload)
-              put(payload)
+              put(payload: payload)
             end
           end
         end

data/lib/ibm/cloud/sdk/vpc/vpn_gateway/peer_cidrs.rb

@@ -7,7 +7,7 @@ module IBM
       module VPC
         module VPNGATEWAY
           # A list of Connection
-          class PeerCIDRs < BaseCollection
+          class PeerCIDRs < VPCCollection
             def initialize(parent)
               @array_key = 'peer_cidrs'
               @instance = Connection
@@ -20,9 +20,9 @@ module IBM
           end
 
           # A single Connection
-          class PeerCIDR < BaseInstance
+          class PeerCIDR < VPCInstance
             def update(payload)
-              put(payload)
+              put(payload: payload)
             end
           end
         end

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

@@ -6,14 +6,14 @@ module IBM
     module SDK
       module VPC
         # A list of VPNGateway
-        class VPNGateways < BaseCollection
+        class VPNGateways < VPCCollection
           def initialize(parent)
             super(parent, 'vpn_gateways', child_class: VPNGateway)
           end
         end
 
         # A single VPNGateway
-        class VPNGateway < BaseInstance
+        class VPNGateway < VPCInstance
           # Get a lisst of connections asssociated with this gateway.
           def connections
             VPNGATEWAY::Connections.new(self)

data/lib/ibm/cloud/sdk_http.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative 'sdk_http/connection'
+require_relative 'sdk_http/exceptions'
+require_relative 'sdk_http/base_collection'
+require_relative 'sdk_http/base_instance'
+require_relative 'sdk_http/sdk_response'
+require_relative 'sdk_http/iam_token'
+
+module IBM
+  module Cloud
+    # Module holds basic HTTP functionality.
+    module SDKHTTP
+    end
+  end
+end

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

@@ -0,0 +1,121 @@
+# typed: true
+# frozen_string_literal: true
+
+require_relative 'base_http_mixin'
+require_relative 'has_child'
+
+module IBM
+  module Cloud
+    module SDKHTTP
+      # Container that encapsulates the VPC API.
+      # 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.
+      class BaseCollection
+        include BaseHTTPMixin
+
+        def initialize(parent, endpoint, array_key: nil, child_class: nil, child_id: 'id')
+          # Setup empty base instance variables.
+          @params = {}
+          @token = parent.token
+          array_key ||= endpoint
+
+          # Set the array key and child class.
+          @array_key ||= array_key
+
+          @instance ||= child_class
+          @instance_id ||= child_id
+
+          @connection = parent.connection
+
+          (class << self; include ChildMixin; end) if child_class
+
+          @endpoint = parent.url(endpoint)
+          @logger = parent.logger
+        end
+
+        attr_reader :logger, :endpoint, :token, :connection
+
+        # In a Child base class add the possible query parameters for the API and return self to make it chainable.
+        # When implemented usage would be Collection.params(limit: 2).get
+        # @return [BaseCollection] The instanticated class.
+        def params(limit: nil)
+          raise NotImplementedError('Sample only. The params method needs to be customized in child class.')
+          # rubocop:disable Lint/UnreachableCode
+          @params[:limit] = limit if limit
+          self
+          # rubocop:enable Lint/UnreachableCode
+        end
+
+        def reset_params
+          @params.clear
+        end
+
+        # Retrieve the collection from the cloud.
+        # @return [IBM::Cloud::SDK::VPC::Response] The http response object.
+        def fetch
+          @data ||= get
+        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
+
+        # 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
+
+        # Return a wrapped instance if set.
+        # @param value [Hash] The hash returned from server.
+        def hash_instance(value)
+          return @instance.new(self, data: value, id_key: @instance_id) if @instance
+
+          value
+        end
+
+        # Create a generator that removes the need for pagination.
+        # @param url [String] Full URL to send to server.
+        # @return [Enumerator] Object to page through results.
+        # @yield [BaseInstance] An instance of the instance class.
+        # @yield [Hash] When no BaseInstance set.
+        def each_resource(url, &block)
+          raise NotImplementedError('Sample only. The each_resource method needs to be customized in child class.')
+          # rubocop:disable Lint/UnreachableCode
+          # Sample implementation based on VPC.
+          return enum_for(:each_resource, url) unless block_given?
+          return unless url
+
+          response = get(path: url)
+          resources = response.fetch(@array_key.to_sym)
+
+          resources&.each { |value| yield hash_instance(value) }
+          # VPC has a next key that holds the next URL.
+          return unless response.key?(:next)
+
+          # The next data structure is a hash with a href member.
+          next_url = response.dig(:next, :href)
+          return unless next_url
+
+          each_resource(next_url, &block)
+          # rubocop:enable Lint/UnreachableCode
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require_relative 'sdk_response'
+
+module IBM
+  module Cloud
+    # Module holds basic HTTP functionality.
+    module SDKHTTP
+      # Generic methods for accessing VPC.
+      module BaseHTTPMixin
+        @connection = nil
+
+        # Run a custom query and verify response is 2xx or 404.
+        # @param method [String] The HTTP method to use.
+        # @param path [String] The relative path from the current object location.
+        # @param params [Hash] A hash of query parameters.
+        # @param payload [Hash] A hash to send as the body.
+        # @param payload_type [Hash] If json then convert to json string, else send as form data.
+        # @return [SDKResponse]
+        # @raise [Exceptions::HttpStatusError] Raise if status checks failed.
+        def adhoc(method: 'get', path: nil, params: nil, payload: nil, payload_type: 'json')
+          unchecked_response(method: method, path: path, params: params, payload: payload, payload_type: payload_type).raise_for_status!
+        end
+
+        # Run a custom query do not verify the response.
+        # @param method [String] The HTTP method to use.
+        # @param path [String] The relative path from the current object location.
+        # @param params [Hash] A hash of query parameters.
+        # @param payload [Hash] A hash to send as the body.
+        # @param payload_type [Hash] If json then convert to json string, else send as form data.
+        def unchecked_response(method: 'get', path: nil, params: nil, payload: nil, payload_type: 'json')
+          @connection.request(method.to_sym, url(path), metadata(params, payload, payload_type))
+        end
+
+        attr_reader :endpoint
+
+        # Perform a GET request and verify response is 2xx or 404.
+        # @param path [String] The relative path from the current object location.
+        # @param params [Hash] A hash of query parameters.
+        # @return [SDKResponse]
+        # @raise [Exceptions::HttpStatusError] Raise if status checks failed.
+        def get(path: nil, params: nil)
+          adhoc(method: 'get', path: path, params: params)
+        end
+
+        # Send a POST request and verify response is 2xx or 404.
+        # @param path [String] The relative path from the current object location.
+        # @param params [Hash] A hash of query parameters.
+        # @param payload [Hash] A hash to send as the body.
+        # @param payload_type [Hash] If json then convert to json string, else send as form data.
+        # @raise [Exceptions::HttpStatusError] Raise if status checks failed.
+        # @return [SDKResponse]
+        def post(payload: nil, path: nil, params: nil, payload_type: 'json')
+          adhoc(method: 'post', path: path, params: params, payload: payload, payload_type: payload_type)
+        end
+
+        # Send a PUT request and verify response is 2xx or 404.
+        # @param path [String] The relative path from the current object location.
+        # @param params [Hash] A hash of query parameters.
+        # @param payload [Hash] A hash to send as the body.
+        # @param payload_type [Hash] If json then convert to json string, else send as form data.
+        # @raise [Exceptions::HttpStatusError] Raise if status checks failed.
+        # @return [SDKResponse]
+        def put(payload: nil, path: nil, params: nil, payload_type: 'json')
+          adhoc(method: 'put', path: path, params: params, payload: payload, payload_type: payload_type)
+        end
+
+        # Send a PATCH request and verify response is 2xx or 404.
+        # @param path [String] The relative path from the current object location.
+        # @param params [Hash] A hash of query parameters.
+        # @param payload [Hash] A hash to send as the body.
+        # @param payload_type [Hash] If json then convert to json string, else send as form data.
+        # @raise [Exceptions::HttpStatusError] Raise if status checks failed.
+        # @return [SDKResponse]
+        def patch(payload: nil, path: nil, params: nil, payload_type: 'json')
+          adhoc(method: 'patch', path: path, params: params, payload: payload, payload_type: payload_type)
+        end
+
+        # Send a DELETE request and verify response is 2xx or 404.
+        # @param path [String] The relative path from the current object location.
+        # @param params [Hash] A hash of query parameters.
+        # @raise [Exceptions::HttpStatusError] Raise if status checks failed.
+        # @return [SDKResponse]
+        def delete(path: nil, params: nil)
+          adhoc(method: 'delete', path: path, params: params)
+        end
+
+        # Preprocess request parameters with any additional data.
+        # @param query [Hash] A hash of query parameters.
+        # @param payload [Hash] A hash to send as the body.
+        # @param payload_type [Hash] If json then convert to json string, else send as form data.
+        # @return [Hash]
+        def metadata(query = nil, payload = nil, payload_type = 'json')
+          @params ||= {}
+          @params.merge!(query) if query
+
+          send_parameters = {
+            query: @params,
+            headers: { "Authorization": @token.authorization_header }
+          }
+
+          # Add payload if it is not nil.
+          if payload && payload.empty? == false
+            payload = payload.to_json if payload_type == 'json'
+            send_parameters[:body] = payload
+          end
+          send_parameters
+        end
+
+        # Merge path with current class's endpoint.
+        def url(path = nil)
+          return endpoint unless path
+          return path if URI.parse(path).relative? == false
+
+          "#{endpoint}/#{path}"
+        end
+      end
+    end
+  end
+end