ibm-cloud-sdk 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc39c6125bcaf6730a73477c76e7e40d2eb131cf6ca34466537d65f615ed8e6a
-  data.tar.gz: ac29b18c76bff0ed290878e12007f1bf639654ed239ce7c27e99431acde25a17
+  metadata.gz: 3846f53417aa653151063dfd91b59ea43b1ba3a9d2d53fdb085c8dc7f28bb2ea
+  data.tar.gz: 903b21299da1b4d57953b4af2a98d27bc99e34298781b7936deae237641d34c6
 SHA512:
-  metadata.gz: 845d945f1e0722745858a2256decc3fd73628fd172ba88a8e49a51a7edbf06418965cc609566288e31c2965ff88f2eff33f7691628bd33ef26da0309827c5058
-  data.tar.gz: ee6c2c63c3472db99d9d773d77e045180594958b0ee4627b964f64365e1ea6a07c7a3159706ef326d9b87702a97218d7648c057737b14e4afc02bf4f40ae6c5f
+  metadata.gz: 9a1284cd63ae075ed1786f5045cb3951e328fb5edfcc95e1d981dd63c72a6ec85ff116102e07fe1317333dcc77305dad3287f312e184a31eb44bc3889303c521
+  data.tar.gz: 507dde2d35874cdee345b14c785d941b0b2a40014251ad8262f684f8f0966b050f57bb03e407332c006204344061c4963f4759895ab040d1ed24e5af73acc65d

data/CHANGELOG.md

@@ -1,8 +1,13 @@
 # Changelog
 All notable changes to the gem ibm-cloud-sdk-ruby will be documented here.
 
+## v0.1.10 - 2020-10-08
+- Change VPC http provider to HTTParty
+- Add Tags API and clean up VPC
+- Log ResourceController and IAM calls
+
 ## v0.1.9 - 2020-10-02
-- Fix PowerVS Volume attach/detach calls
+- Fix PowerVS Volume Attach/Detach calls
 
 ## v0.1.8 - 2020-10-01
 - Add second level instances

data/ibm-cloud-sdk.gemspec

@@ -24,5 +24,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rest-client"
-  spec.add_dependency "http"
+  spec.add_dependency "httparty"
 end

data/lib/ibm/cloud/sdk.rb

@@ -2,12 +2,13 @@
 require "json"
 require "rest-client"
 
+require 'ibm/cloud_sdk'
+
 require "ibm/cloud/sdk/base_service"
 require "ibm/cloud/sdk/iam"
 require "ibm/cloud/sdk/power_iaas"
 require "ibm/cloud/sdk/resource_controller"
 require "ibm/cloud/sdk/version"
-require "ibm/cloud/sdk/vpc/cloud_sdk"
 require "ibm/cloud/sdk/logging"
 
 module IBM

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

@@ -1,13 +1,18 @@
+require_relative 'logging'
+
 module IBM
   module Cloud
     module SDK
       class IAM < BaseService
+        include Logging
+
         def endpoint
           "https://iam.cloud.ibm.com".freeze
         end
 
         def initialize(api_key)
           @api_key = api_key
+          RestClient.log = logger
         end
 
         def get_identity_token

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

@@ -1,7 +1,10 @@
+require_relative 'logging'
+
 module IBM
   module Cloud
     module SDK
       class ResourceController < BaseService
+        include Logging
         require "ibm/cloud/sdk/resource_controller/resource"
         def endpoint
           "https://resource-controller.cloud.ibm.com/v2"
@@ -9,6 +12,7 @@ module IBM
 
         def initialize(token)
           @token = token
+          RestClient.log = logger
         end
 
         def get_resource(guid)

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

@@ -0,0 +1,28 @@
+# typed: true
+# frozen_string_literal: true
+
+require 'ibm/cloud/sdk_http'
+require_relative 'tags/http'
+
+module IBM
+  module Cloud
+    module SDK
+      # A collection interface into the Tags API.
+      class Tags < TAG::TagCollection
+        def initialize(connection, token, logger: nil) # rubocop:disable Lint/MissingSuper
+          @token = token
+          @connection = connection
+
+          @logger = logger || Logger.new($stdout, level: :warn)
+          @array_key = 'items'
+        end
+
+        attr_reader :logger, :token, :connection
+
+        def endpoint
+          'https://tags.global-search-tagging.cloud.ibm.com/v3/tags'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'ibm/cloud/sdk_http'
+
+require_relative 'http/tag_collection'

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.9"
+      VERSION = "0.1.10"
     end
   end
 end

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

@@ -1,10 +1,8 @@
 # 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 'ibm/cloud/sdk_http'
+require_relative 'vpc/http'
 
 require_relative 'vpc/floatingips'
 require_relative 'vpc/flowlogcollectors'
@@ -30,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,29 @@
+# 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
+
+          def metadata(query = nil, payload = nil)
+            @params ||= {}
+            @params.merge!(query) if query
+
+            payload ||= {}
+            {
+              query: { version: '2020-08-01', generation: 2 }.merge(@params),
+              body: payload,
+              headers: { "Authorization": @token.authorization_header }
+            }
+          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