ibm-cloud-sdk 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 181a2894e2d8045bea0d2a33cf81570480eee1f668017b8ade96b1801d0465b2
-  data.tar.gz: 5399f7e3e4f4b483a72e673d351605cb1f8bb09f216e5fd1a9439742f736aedf
+  metadata.gz: 8fe8cad325a98aabb1bd328c04aec7c1c4b7dbda4859d41a85baa51916a40d80
+  data.tar.gz: e40564d9e168b80623282caa7bb1b4efe5519e16a7757f8ac657ddbf57c0976a
 SHA512:
-  metadata.gz: 237fd30c5dd4efa622de5be57a2df9e2285dcabc3d15f415d6efb6bec31b36254cbaf6c3cb32a6d8b7113b7e8709e4eddee64736515030e5e3227694dc464b4e
-  data.tar.gz: ed36bdf032519bc35c1563f62fe279f6744b3f25b97fef4358ebd689958a48a17a5a1eafbf85f72a3c62e372dfb764b35463cc292eede788b3ad127170664ced
+  metadata.gz: 2dabd16a4f84e7c7ade80f0a5d36f0796f15681a53f0f271b01ff6d98b41b00ea249f681c9c402961e53c0a94943c32c18d41e6f1421075be15561ce5c369c7e
+  data.tar.gz: 90bea5c5ae247170955e937be0fef41c8bd43f0d8749b8a3c08786f25759dd669e5f32e9a35bedada529a5936eb9ae0f06a329df4dcbb99a56c60d2f4dbb7659

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 # Changelog
 All notable changes to the gem ibm-cloud-sdk-ruby will be documented here.
 
+## v0.1.5 - 2020-09-21
+- Added Enumerable based pagination support
+- Move instance profiles
+- Improve resource lookup by GUID
+- Add support to create a PowerIaas volume
+
 ## v0.1.4 - 2020-09-17
 - Added support for the IBM Virtual Private Cloud (VPC) service
 

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

@@ -120,6 +120,14 @@ module IBM
           delete("cloud-instances/#{guid}/volumes/#{volume_id}")
         end
 
+        # Create a volume
+        #
+        # @param volume_hash [Hash] New volume attributes
+        # @return [Hash] Volume
+        def create_volume(volume_hash)
+          post("cloud-instances/#{guid}/volumes", volume_hash.to_json)
+        end
+
         # Get all networks in an IBM Power Cloud instance
         #
         # @return [Array<Hash>] all networks for this IBM Power Cloud instance

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

@@ -2,6 +2,7 @@ module IBM
   module Cloud
     module SDK
       class ResourceController < BaseService
+        require "ibm/cloud/sdk/resource_controller/resource"
         def endpoint
           "https://resource-controller.cloud.ibm.com/v2"
         end
@@ -10,15 +11,8 @@ module IBM
           @token = token
         end
 
-        def get_resources
-          resources = get("resource_instances")["resources"] || []
-
-          require "ibm/cloud/sdk/resource_controller/resource"
-          resources.map { |instance| Resource.new(instance) }
-        end
-
         def get_resource(guid)
-          get_resources.detect { |resource| resource.guid == guid }
+          Resource.new(get("resource_instances/#{guid}"))
         end
 
         private

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

@@ -1,7 +1,7 @@
 module IBM
   module Cloud
     module SDK
-      VERSION = "0.1.4"
+      VERSION = "0.1.5"
     end
   end
 end

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

@@ -9,6 +9,7 @@ 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'
@@ -32,17 +33,16 @@ module IBM
         # Create an API Client object for the  VPC IaaS service
         #
         # @param region [String] the IBM Power Cloud instance region
-        # @param token [IAMtoken] the IBM Cloud IAM Token object
-        # @param logger [Logger] an instance of an instanciated logger.
-        def initialize(region, api_key, logger: nil)
+        # @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
-          @api_key = api_key
-          @token = api_key
+          @connection = connection
 
-          @logger = logger || Logger.new($stdout)
+          @logger = logger || Logger.new($stdout, level: :warn)
         end
 
-        attr_reader :token, :logger
+        attr_reader :connection, :logger
         attr_accessor :region
 
         # The Region API endpoint.
@@ -67,6 +67,10 @@ module IBM
           VPC::Images.new(self)
         end
 
+        def instance_profiles
+          VPC::InstanceProfiles.new(self)
+        end
+
         def instances
           VPC::Instances.new(self)
         end

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

@@ -6,9 +6,13 @@ module IBM
     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.
-          @data = nil
           @params = nil
 
           array_key ||= endpoint
@@ -20,47 +24,83 @@ module IBM
           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)
-          @data
         end
 
+        # Get an iterable for the resource collection.
+        # @return [Enumerator] Use standard each, next idioms.
         def all
-          response = fetch.subkey(@array_key)
-          return response if response.is_a?(Array)
+          each_resource(url)
+        end
 
-          raise "#{self.class}.#{__method__} Expecting response to be an Array not a #{response.class}"
+        # Fetch all data and return in an array.
+        # @return [Array] Hashes of the returned data.
+        def data
+          all.to_a
         end
 
-        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
+        # 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.subkey('total_count')
+          fetch.json&.fetch(:total_count)
         end
 
-        def limit
-          fetch.subkey('limit')
+        # 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
 
-        def next
-          fetch.subkey('next')
-        rescue RuntimeError
-          nil
-        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
 
-        def create(payload)
-          post(payload)
+          each_resource(next_url, &block)
         end
       end
     end

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

@@ -7,7 +7,7 @@ module IBM
       # Container that encapsulates the VPC API.
       class BaseInstance < BaseVPC
         def details
-          get.hash
+          get.hash_response
         end
 
         def update(payload)

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

@@ -8,14 +8,14 @@ module IBM
       class BaseVPC
         def initialize(parent, endpoint = nil)
           @endpoint = parent.url(endpoint)
-          @token = parent.token
+          @connection = parent.connection
           @logger = parent.logger
         end
 
-        attr_reader :endpoint, :token, :logger
+        attr_reader :endpoint, :connection, :logger
 
         def adhoc(method: 'get', path: nil, params: {}, payload_type: 'json', payload: {})
-          @token.adhoc(method.to_sym, url(path), metadata(params, payload_type, payload))
+          @connection.adhoc(method.to_sym, url(path), metadata(params, payload_type, payload))
         end
 
         def get(path: nil, params: {})
@@ -23,7 +23,7 @@ module IBM
         end
 
         def post(payload = {}, path: nil, params: {}, type: 'json')
-          adhoc(method: 'post', path: path, params: params, payload: payload)
+          adhoc(method: 'post', path: path, params: params, payload: payload, payload_type: type)
         end
 
         def put(payload = {}, path: nil, params: {})

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

@@ -12,7 +12,7 @@ module IBM
         @logger ||= Logger.new($stdout, level: :warn)
 
         @client = HTTP.use(http_options(options))
-        @token = IBM::Cloud::SDK::VPC::Connection.new(api_key, logger: @logger, client: @client)
+        @connection = IBM::Cloud::SDK::VPC::Connection.new(api_key, logger: @logger, client: @client)
       end
 
       def http_options(options = {})
@@ -24,10 +24,10 @@ module IBM
         )
       end
 
-      attr_reader :logger, :token
+      attr_reader :logger, :connection
 
       def vpc(region = 'us-east')
-        IBM::Cloud::SDK::Vpc.new(region, @token, logger: @logger)
+        IBM::Cloud::SDK::Vpc.new(region, @connection, logger: @logger)
       end
     end
-end
+end

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

@@ -32,6 +32,8 @@ module IBM
             response.code
           end
 
+          alias_method :status, :code
+
           # Return the raw connection object.
           def connection
             response.connection
@@ -73,7 +75,7 @@ module IBM
             sym_key = key.to_sym
             return ret.fetch(sym_key) if ret.key?(sym_key)
 
-            raise "Key not found in #{ret}."
+            raise "Key #{key} not found in #{ret}."
           end
 
           # Check to see if the returned object is the expected object.

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

@@ -4,7 +4,6 @@
 require_relative 'instance/actions'
 require_relative 'instance/network_interfaces'
 require_relative 'instance/volume_attachments'
-require_relative 'instance/profiles'
 
 module IBM
   module Cloud

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ibm-cloud-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - IBM Cloud Developers
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-17 00:00:00.000000000 Z
+date: 2020-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -79,8 +79,8 @@ files:
 - lib/ibm/cloud/sdk/vpc/instance/actions.rb
 - lib/ibm/cloud/sdk/vpc/instance/floating_ips.rb
 - lib/ibm/cloud/sdk/vpc/instance/network_interfaces.rb
-- lib/ibm/cloud/sdk/vpc/instance/profiles.rb
 - lib/ibm/cloud/sdk/vpc/instance/volume_attachments.rb
+- lib/ibm/cloud/sdk/vpc/instance_profiles.rb
 - lib/ibm/cloud/sdk/vpc/instances.rb
 - lib/ibm/cloud/sdk/vpc/ipsec_policies.rb
 - lib/ibm/cloud/sdk/vpc/keys.rb
@@ -109,7 +109,7 @@ licenses:
 - '"Apache-2.0"'
 metadata:
   homepage_uri: https://github.com/IBM-Cloud/ibm-cloud-sdk-ruby
-  changelog_uri: https://github.com/IBM-Cloud/ibm-cloud-sdk-ruby/blob/v0.1.4/CHANGELOG.md
+  changelog_uri: https://github.com/IBM-Cloud/ibm-cloud-sdk-ruby/blob/v0.1.5/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:

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

@@ -1,34 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-module IBM
-  module Cloud
-    module SDK
-      module VPC
-        module INSTANCES
-          # Work with multiple profiles.
-          class Profiles < BaseVPC
-            def initialize(parent)
-              super(parent, 'instance/profiles')
-            end
-
-            def all
-              get
-            end
-
-            def instance(name)
-              Profile.new(self, name)
-            end
-          end
-
-          # Get a single profile.
-          class Profile < BaseVPC
-            def details
-              get
-            end
-          end
-        end
-      end
-    end
-  end
-end