ibm-cloud-sdk 0.1.6 → 0.1.11

data/lib/ibm/cloud/sdk/tags/http/tag_collection.rb

@@ -0,0 +1,99 @@
+# typed: true
+# frozen_string_literal: true
+
+require_relative '../http'
+
+module IBM
+  module Cloud
+    module SDK
+      module TAG
+        # The Base Collection for the Tags API.
+        class TagCollection < SDKHTTP::BaseCollection
+          # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Layout/LineLength
+
+          # Set params on the next request.
+          # @param account_id [String>] The ID of the billing account to list the tags for. If it is not set, then it is taken from the authorization token. This parameter is required if tag_type is set to service.
+          # @param tag_type [String] The type of the tag you want to list. Supported values are user and service.
+          # @param full_data [Boolean] If set to true, this query returns the provider, ghost, ims or ghost,ims, where the tag exists and the number of attached resources.
+          # @param providers [String] Select a provider. Supported values are ghost and ims.
+          # @param attached_to [String] If you want to return only the list of tags attached to a specified resource, pass the ID of the resource on this parameter. For GhoST onboarded resources, the resource ID is the CRN; for IMS resources, it is the IMS ID. When using this parameter, you must specify the appropriate provider (ims or ghost).
+          # @param offset [Integer] The offset is the index of the item from which you want to start returning data from.
+          # @param limit [Integer] The number of tags to return (1 <> 1000). Default: 100
+          # @param timeout [Integer] The search timeout bounds the search request to be executed within the specified time value. It returns the hits accumulated until time runs out (0 <> 60000).
+          # @param order_by_name [String] Order the output by tag name (asc,desc).
+          # @param attached_only [Boolean] Filter on attached tags. If true, it returns only tags that are attached to one or more resources.
+          def params(
+            account_id: nil,
+            tag_type: nil,
+            full_data: false,
+            providers: nil,
+            attached_to: nil,
+            offset: 0,
+            limit: 100,
+            timeout: nil,
+            order_by_name: 'asc',
+            attached_only: false
+          )
+            @params ||= {}
+            @params[:account_id] = account_id if account_id
+            @params[:tag_type] = tag_type if tag_type && %w[user service].include?(tag_type)
+            @params[:full_data] = full_data if full_data.instance_of?(TrueClass)
+            @params[:providers] = providers if providers && %w[ghost ims].include?(providers)
+            @params[:attached_to] = attached_to if attached_to
+            @params[:offset] = offset if offset.positive?
+            @params[:limit] = limit if limit && (1..1000).include?(limit) && limit != 100
+            @params[:timeout] = timeout if timeout
+            @params[:order_by_name] = order_by_name if order_by_name && %w[desc].include?(order_by_name)
+            @params[:attached_only] = attached_only if attached_only.instance_of?(TrueClass)
+            self
+          end
+          # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Layout/LineLength
+
+          def reset_params
+            @params = {}
+          end
+
+          # Return the total count as retrieved from the API.
+          # @return [Integer] value in total_count
+          def total_count
+            fetch.json.[](:total_count)
+          end
+
+          # Get all tags attached to a CRN.
+          # @param crn [String] The CRN for the instance.
+          def attached_to(crn)
+            return [] if crn.to_s.empty?
+
+            params(attached_to: crn).all
+          end
+
+          private
+
+          # 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, offset = 0, &block)
+            return enum_for(:each_resource, url) unless block_given?
+            return unless url
+
+            response = params(offset: offset).get(path: url).json
+
+            resources = response.fetch(@array_key.to_sym)
+            current_count = response.fetch(:offset) + response.fetch(:limit)
+
+            resources&.each { |value| yield value } # rubocop:disable Style/ExplicitBlockArgument
+
+            if resources.empty?
+              reset_params
+              return
+            end
+
+            each_resource(url, current_count, &block)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
 module IBM
   module Cloud
     module SDK
-      VERSION = "0.1.6"
+      VERSION = "0.1.11"
     end
   end
 end

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

@@ -1,9 +1,8 @@
 # typed: true
 # frozen_string_literal: true
 
-require_relative 'vpc/base_vpc'
-require_relative 'vpc/base_collection'
-require_relative 'vpc/base_instance'
+require 'ibm/cloud/sdk_http'
+require_relative 'vpc/http'
 
 require_relative 'vpc/floatingips'
 require_relative 'vpc/flowlogcollectors'
@@ -29,20 +28,23 @@ module IBM
   module Cloud
     module SDK
       # Container that encapsulates the VPC API.
-      class Vpc < BaseVPC
+      class Vpc
+        include VPC::VpcHTTP
+
         # 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)
+        def initialize(region, connection, token, logger: nil)
           @region = region
+          @token = token
           @connection = connection
 
           @logger = logger || Logger.new($stdout, level: :warn)
         end
 
-        attr_reader :connection, :logger
+        attr_reader :logger, :token, :connection
         attr_accessor :region
 
         # The Region API endpoint.

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

@@ -6,14 +6,14 @@ module IBM
     module SDK
       module VPC
         # Class that deals with groups of floating IPs.
-        class FloatingIPs < BaseCollection
+        class FloatingIPs < VPCCollection
           def initialize(parent)
             super(parent, 'floating_ips', child_class: FloatingIP)
           end
         end
 
         # Class that deals with a single floating IP.
-        class FloatingIP < BaseInstance; end
+        class FloatingIP < VPCInstance; end
       end
     end
   end

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

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

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'ibm/cloud/sdk_http'
+require_relative 'http/vpc_http'
+
+require_relative 'http/vpc_collection'
+require_relative 'http/vpc_instance'

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

@@ -0,0 +1,82 @@
+# typed: true
+# frozen_string_literal: true
+
+require_relative '../http'
+require_relative 'vpc_http'
+
+module IBM
+  module Cloud
+    module SDK
+      module VPC
+        # 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 VPCCollection < SDKHTTP::BaseCollection
+          include VpcHTTP
+
+          # 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[:start] = start if start
+            @params[:limit] = limit if limit
+            @params[:resource_group] = resource_group if resource_group
+            self
+          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&.[](:total_count)
+          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 VPCInstance set.
+          def each_resource(url, &block)
+            return enum_for(:each_resource, url) unless block_given?
+            return unless url
+
+            response = get(path: url).json
+            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)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative '../http'
+
+module IBM
+  module Cloud
+    module SDK
+      # Module holds basic HTTP functionality.
+      module VPC
+        # Generic methods for accessing VPC.
+        module VpcHTTP
+          include SDKHTTP::BaseHTTPMixin
+
+          # Preprocess request parameters, add required version and generation parameters to query.
+          # @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')
+            default_params = { version: '2020-08-01', generation: 2 }
+            default_params.merge!(query) if query
+            super(default_params, payload, payload_type)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'ibm/cloud/sdk/tags'
+
+require_relative 'vpc_http'
+
+module IBM
+  module Cloud
+    module SDK
+      module VPC
+        # Container that encapsulates the VPC API.
+        class VPCInstance < SDKHTTP::BaseInstance
+          include VpcHTTP
+
+          # Get the CRN for the resource.
+          # @return [String]
+          def crn
+            self[:crn]
+          end
+
+          # Get the tags associated with this resource.
+          # @return [Enumerator] An enumerator with the results.
+          def tags
+            IBM::Cloud::SDK::Tags.new(@connection, @token, logger: @logger).attached_to(crn)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -6,14 +6,14 @@ module IBM
     module SDK
       module VPC
         # A list of IKEPolicy
-        class IKEPolicies < BaseCollection
+        class IKEPolicies < VPCCollection
           def initialize(parent)
             super(parent, 'ike_policies', child_class: IKEPolicy)
           end
         end
 
         # A single IKEPolicy
-        class IKEPolicy < BaseInstance
+        class IKEPolicy < VPCInstance
           def connections
             get('connections')
           end

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

@@ -6,14 +6,14 @@ module IBM
     module SDK
       module VPC
         # Work with multiple images.
-        class Images < BaseCollection
+        class Images < VPCCollection
           def initialize(parent)
             super(parent, 'images', child_class: Image)
           end
         end
 
         # Work with a single image.
-        class Image < BaseInstance
+        class Image < VPCInstance
         end
       end
     end

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

@@ -1,16 +1,91 @@
 # typed: true
 # frozen_string_literal: true
 
+require 'date'
+require 'forwardable'
+
 module IBM
   module Cloud
     module SDK
       module VPC
-        module INSTANCES
+        module INSTANCE
           # Actions for an instance.
-          class Actions < BaseCollection
+          class Actions < VPCCollection
             def initialize(parent)
               super(parent, 'actions')
             end
+
+            # Send an action request to start the instance.
+            def start
+              create('start')
+            end
+
+            # Send an action request to stop the instance.
+            # @param force [Boolean] Clear the queue and run this action.
+            def stop(force: false)
+              create('stop', force: force)
+            end
+
+            # Send an action request to reboot the instance.
+            # @param force [Boolean] Clear the queue and run this action.
+            def reboot(force: false)
+              create('reboot', force: force)
+            end
+
+            # Send a custom action request.
+            # @param action [String] The type of action. Allowable values: [reboot, start, stop]
+            # @param force [Boolean] If set to true, the action will be forced immediately, and all queued actions deleted. Ignored for the start action.
+            def create(action, force: false)
+              @logger.info("Sending action request for #{action} with force #{force}.")
+              payload = { type: action }
+              payload[:force] = force if force
+              response = post(payload: payload)
+              Action.new(response)
+            end
+          end
+
+          # A base class that wraps the action response.
+          class Action
+            def initialize(response)
+              @response = response
+              @data = response.json
+              @keys = %i[type force created_at]
+              @deprecated = %i[completed_at started_at status id href]
+
+              clear_deprecated
+              add_inst_vars(@keys)
+            end
+
+            # Return the DateTime the action was created.
+            # @return [DateTime]
+            def created_at
+              return DateTime.parse(@created_at) if @created_at
+
+              @created_at
+            end
+
+            # The HTTP response object.
+            attr_accessor :response, :data
+
+            extend Forwardable
+            def_delegators :@data, :[], :dig, :each_pair, :each, :fetch, :has_key?, :has_value?, :include?, :index, :inspect, :key?, :keys, :length, :merge, :merge!, :clear, :to_h, :value?, :values, :pretty_print
+
+            private
+
+            # Iterate through an array of symbols. Set the instance variable and attr_accessor for each.
+            def add_inst_vars(keys)
+              keys.each do |k|
+                instance_variable_set "@#{k}", @data[k]
+                self.class.attr_accessor k unless respond_to?(k)
+              end
+            end
+
+            # Remove deprecated keys from hash.
+            def clear_deprecated
+              @data.each do |k, _v|
+                @data.delete(k) if @deprecated.include?(k)
+              end
+            end
           end
         end
       end