ibm-cloud-sdk 0.1.2 → 0.1.7

data/lib/ibm/cloud/sdk/version.rb

@@ -1,7 +1,7 @@
 module IBM
   module Cloud
     module SDK
-      VERSION = "0.1.2"
+      VERSION = "0.1.7"
     end
   end
 end

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

@@ -0,0 +1,133 @@
+# typed: true
+# frozen_string_literal: true
+
+require_relative 'vpc/base_vpc'
+require_relative 'vpc/base_collection'
+require_relative 'vpc/base_instance'
+require_relative 'vpc/exceptions'
+
+require_relative 'vpc/floatingips'
+require_relative 'vpc/flowlogcollectors'
+require_relative 'vpc/ike_policies'
+require_relative 'vpc/images'
+require_relative 'vpc/instance_profiles'
+require_relative 'vpc/instances'
+require_relative 'vpc/ipsec_policies'
+require_relative 'vpc/keys'
+require_relative 'vpc/load_balancers'
+require_relative 'vpc/network_acls'
+require_relative 'vpc/operating_systems'
+require_relative 'vpc/public_gateways'
+require_relative 'vpc/regions'
+require_relative 'vpc/security_groups'
+require_relative 'vpc/subnets'
+require_relative 'vpc/volume_profiles'
+require_relative 'vpc/volumes'
+require_relative 'vpc/vpcs'
+require_relative 'vpc/vpn_gateways'
+
+module IBM
+  module Cloud
+    module SDK
+      # Container that encapsulates the VPC API.
+      class Vpc < BaseVPC
+        # Create an API Client object for the  VPC IaaS service
+        #
+        # @param region [String] the IBM Power Cloud instance region
+        # @param connection [IBM::Cloud::SDK::VPC::Connection] A connection object.
+        # @param logger [Logger] An instance of an instanciated logger.
+        def initialize(region, connection, logger: nil)
+          @region = region
+          @connection = connection
+
+          @logger = logger || Logger.new($stdout, level: :warn)
+        end
+
+        attr_reader :connection, :logger
+        attr_accessor :region
+
+        # The Region API endpoint.
+        def endpoint
+          "https://#{region.sub(/-\d$/, '')}.iaas.cloud.ibm.com/v1"
+        end
+
+        # Entry point to the Floating IPs API.
+        def floating_ips
+          VPC::FloatingIPs.new(self)
+        end
+
+        def flowlog_collectors
+          VPC::FlowLogCollectors.new(self)
+        end
+
+        def ike_policies
+          VPC::IKEPolicies.new(self)
+        end
+
+        def images
+          VPC::Images.new(self)
+        end
+
+        def instance_profiles
+          VPC::InstanceProfiles.new(self)
+        end
+
+        def instances
+          VPC::Instances.new(self)
+        end
+
+        def ipsec_policies
+          VPC::IPSecPolicies.new(self)
+        end
+
+        def keys
+          VPC::Keys.new(self)
+        end
+
+        def load_balancers
+          VPC::LoadBalancers.new(self)
+        end
+
+        def network_acls
+          VPC::NetworkACLs.new(self)
+        end
+
+        def operating_systems
+          VPC::OperatingSystems.new(self)
+        end
+
+        def public_gateways
+          VPC::PublicGateways.new(self)
+        end
+
+        def regions
+          VPC::Regions.new(self)
+        end
+
+        def security_groups
+          VPC::SecurityGroups.new(self)
+        end
+
+        def subnets
+          VPC::Subnets.new(self)
+        end
+
+        def volumes_profiles
+          VPC::VolumeProfiles.new(self)
+        end
+
+        def volumes
+          VPC::Volumes.new(self)
+        end
+
+        def vpcs
+          VPC::Vpcs.new(self)
+        end
+
+        def vpn_gateways
+          VPC::VPNGateways.new(self)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,108 @@
+# typed: true
+# frozen_string_literal: true
+
+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
+
+          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)
+        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
+
+        # Access a specific instance by either id or name depending on API.
+        def instance(id)
+          @instance.new(self, id)
+        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

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

@@ -0,0 +1,23 @@
+# typed: true
+# frozen_string_literal: true
+
+module IBM
+  module Cloud
+    module SDK
+      # Container that encapsulates the VPC API.
+      class BaseInstance < BaseVPC
+        def details
+          get.hash_response
+        end
+
+        def update(payload)
+          patch(payload)
+        end
+
+        def remove
+          delete
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# typed: true
+# frozen_string_literal: true
+
+module IBM
+  module Cloud
+    module SDK
+      # Container that encapsulates the VPC API.
+      class BaseVPC
+        def initialize(parent, endpoint = nil)
+          @endpoint = parent.url(endpoint)
+          @connection = parent.connection
+          @logger = parent.logger
+        end
+
+        attr_reader :endpoint, :connection, :logger
+
+        def adhoc(method: 'get', path: nil, params: {}, payload_type: 'json', payload: {})
+          @connection.adhoc(method.to_sym, url(path), metadata(params, payload_type, payload))
+        end
+
+        def get(path: nil, params: {})
+          adhoc(method: 'get', path: path, params: params)
+        end
+
+        def post(payload = {}, path: nil, params: {}, type: 'json')
+          adhoc(method: 'post', path: path, params: params, payload: payload, payload_type: type)
+        end
+
+        def put(payload = {}, path: nil, params: {})
+          adhoc(method: 'put', path: path, params: params, payload: payload)
+        end
+
+        def patch(payload = {},  path: nil, params: {})
+          adhoc(method: 'patch', path: path, params: params, payload: payload)
+        end
+
+        def delete(path: nil, params: {})
+          adhoc(method: 'delete', path: path, params: params)
+        end
+
+        def url(path = nil)
+          return endpoint unless path
+
+          "#{endpoint}/#{path}"
+        end
+
+        private
+
+        def metadata(params = {}, payload_type = 'json', payload = {})
+          params ||= {}
+          pt = {
+            params: { version: '2020-08-01', generation: 2 }.merge(params)
+          }
+
+          pt[payload_type.to_sym] = payload unless payload.empty?
+          pt
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'http'
+require 'ibm/cloud/sdk/vpc/helpers/connection'
+require 'ibm/cloud/sdk/vpc'
+
+module IBM
+    # Holds the SDK pieces.
+    class CloudSDK
+      def initialize(api_key, logger: nil, options: {})
+        @logger = logger
+        @logger ||= Logger.new($stdout, level: :warn)
+
+        @client = HTTP.use(http_options(options))
+        @connection = IBM::Cloud::SDK::VPC::Connection.new(api_key, logger: @logger, client: @client)
+      end
+
+      def http_options(options = {})
+        options.merge(
+          {
+            logging: { logger: @logger },
+            auto_deflate: {}
+          }
+        )
+      end
+
+      attr_reader :logger, :connection
+
+      def vpc(region = 'us-east')
+        IBM::Cloud::SDK::Vpc.new(region, @connection, logger: @logger)
+      end
+    end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module IBM
+  module Cloud
+    module SDK
+      module VPC
+        # Module to contain all custom exception classes.
+        module Exceptions
+          # An exception for http with a response attribute.
+          # @param response [IBM::Cloud::SDK::VPC::Response] The original response object.
+          # @param msg [String] A human readable message.
+          class ExceptionWithResponse < RuntimeError
+            def initialize(response, msg)
+              @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(response, msg)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# typed: false
+# frozen_string_literal: true
+
+module IBM
+  module Cloud
+    module SDK
+      module VPC
+        # Class that deals with groups of floating IPs.
+        class FloatingIPs < BaseCollection
+          def initialize(parent)
+            super(parent, 'floating_ips', child_class: FloatingIP)
+          end
+        end
+
+        # Class that deals with a single floating IP.
+        class FloatingIP < BaseInstance; end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# typed: true
+# frozen_string_literal: true
+
+module IBM
+  module Cloud
+    module SDK
+      module VPC
+        # A list of subnets
+        class FlowLogCollectors < BaseCollection
+          def initialize(parent)
+            super(parent, 'flow_log_collectors', child_class: FlowLogCollectors)
+          end
+        end
+
+        # A single subnet
+        class FlowLogCollector < BaseInstance; end
+      end
+    end
+  end
+end