ibm-cloud-sdk 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7558ad49ddda2ac462adadf72b0e41b4b71ecb76549f977763ca474dbc2cdd9
-  data.tar.gz: ed99310c97b01a7bdbc3b55aba132e9307aceefee82dffb2e74392f74e408f7c
+  metadata.gz: 160845336c50ab1c67c274cb62fd5e52af7bf0d6e4b5a4a1b57c4ea3c5eb47db
+  data.tar.gz: 7762d522d6754815a4e19a927bdcce0d73a8c5a0d204980d44dfdf006d7254d4
 SHA512:
-  metadata.gz: a5975502154c0cbdb3afd8e6010852ae34259ac3d083ded0c1e201d68a12260c1dc01e7d0da74cc40de02e8b612bd26e96fee78f08bac910fc6f058e500a80ab
-  data.tar.gz: fba093a03b5b51df36e7f3f400c2f8dcfa8ad53c04d611f88c8d637f1d0ca0059b31f652ffa3769ea1cc47bbf2556db7f205c31556f62b39e49cb2bf4e9365ae
+  metadata.gz: f42fe440d6a3610c94b7336246eda2dfdf6f794afa501480e633563d3a25f2d27bc337ebf41f82b82dad3a3958c2dbbf094244da77021fbe188fffa5cb73d294
+  data.tar.gz: 7af6df6df99133b619aa62bcc03281dc58f8b1f79c1b26d57b6cbf490dfc85f0dbdd46d41306780d8ead81148d71bf9003b78b787d8d21a64c6974ac0fc546a7

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+All notable changes to the gem ibm-cloud-sdk-ruby will be documented here.
+
+## v0.1.6 - 2020-09-23
+- Add PowerIaaS method to get instance info
+- Return region specific PowerVS storage types
+- Move VPC instance into instances and add initialization method.
+
+## 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
+
+## v0.1.3 - 2020-08-31
+### Added the following rest api calls for Power System Virtual Server service 
+- Add PowerIaas 'delete_volume' method
+- Add PowerVS SAP API calls
+- get list of available system pools within a particular data center
+- get list of all storage type availble in the data center. There may be 
+  update to the call once PowerVS service updates the storage type rest api 
+  for Power System Virtual Server service . 
+

data/README.md

@@ -28,5 +28,5 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ibm-cloud-sdk.
+Bug reports and pull requests are welcome on GitHub at https://github.com/IBM-Cloud/ibm-cloud-sdk-ruby.
 

data/ibm-cloud-sdk.gemspec

@@ -11,7 +11,8 @@ Gem::Specification.new do |spec|
   spec.licenses      = %w["Apache-2.0"]
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
-  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["homepage_uri"]  = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/IBM-Cloud/ibm-cloud-sdk-ruby/blob/v#{spec.version}/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -23,4 +24,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rest-client"
+  spec.add_dependency "http"
 end

data/lib/ibm/cloud/sdk.rb

@@ -1,3 +1,4 @@
+
 require "json"
 require "rest-client"
 
@@ -6,6 +7,7 @@ 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"
 
 module IBM
   module Cloud

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

@@ -18,7 +18,14 @@ module IBM
         end
 
         def endpoint
-          "https://#{region}.power-iaas.cloud.ibm.com/pcloud/v1"
+          "https://#{region.sub(/-\d$/, '')}.power-iaas.cloud.ibm.com/pcloud/v1"
+        end
+
+        # Get Power Cloud Instance information
+        #
+        # @return [Hash] CloudInstance
+        def get_pcloud_instance
+          get("cloud-instances/#{guid}")
         end
 
         # Get all PVM instances in an IBM Power Cloud instance
@@ -113,6 +120,21 @@ module IBM
           get("cloud-instances/#{guid}/volumes/#{volume_id}")
         end
 
+        # Delete a volume
+        #
+        # @param volume_id [String] The ID of a volume
+        def delete_volume(volume_id)
+          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
@@ -131,6 +153,22 @@ module IBM
           get("cloud-instances/#{guid}/networks/#{network_id}")
         end
 
+        # Get a available system pools list for IBM Power Cloud DC
+        #
+        # @return [Hash] SystemPool
+        def get_system_pool
+          get("cloud-instances/#{guid}/system-pools")
+        end
+
+        # Get a storage types list in IBM  Power Cloud.
+        # note: this mehod to be refactored under the common 
+        # IBM::Cloud::SDK::PowerIaas.endpoint when the rest api become available.
+        #
+        # @return [Hash] StorageType
+        def get_storage_types
+          JSON.parse(RestClient.get("https://#{region.sub(/-\d$/, '')}.power-iaas.cloud.ibm.com/broker/v1/storage-types", headers))[region]
+        end
+
         def create_network(network_hash)
           post("cloud-instances/#{guid}/networks", network_hash.to_json)
         end
@@ -156,6 +194,37 @@ module IBM
           delete("tenants/#{tenant}/sshkeys/#{name}")
         end
 
+        # Get an SAP profile
+        #
+        # @param sap_profile_id [String] The ID of an SAP profile
+        # @return [Hash] SAP profile
+        def get_sap_profile(sap_profile_id)
+          get("cloud-instances/#{guid}/sap/#{sap_profile_id}")
+        end
+
+        # Get list of all SAP profiles
+        #
+        # @return [Array<Hash>] all SAP profiles available to this instance
+        def get_sap_profiles
+          sap_profiles = get("cloud-instances/#{guid}/sap")["profiles"] || []
+
+          sap_profiles.map do |sap_profile|
+            get_sap_profile(sap_profile["profileID"])
+          end
+        end
+
+        # Create a new SAP PVM Instance
+        #
+        # Create a new PVM instance using an SAP profile. The resultant PVM
+        # instance is the standard 'PVMInstance' type and can be accessed via
+        # the existing *_pvm_instance methods.
+        #
+        # @param sap_profile_id [String] The ID of an SAP profile
+        # @return [Hash] SAP profile
+        def create_sap_pvm_instance(instance_hash)
+          post("cloud-instances/#{guid}/sap", instance_hash.to_json)
+        end
+
         private
 
         attr_reader :crn, :guid, :region, :tenant, :token

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.1"
+      VERSION = "0.1.6"
     end
   end
 end

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

@@ -0,0 +1,132 @@
+# typed: true
+# frozen_string_literal: true
+
+require_relative 'vpc/base_vpc'
+require_relative 'vpc/base_collection'
+require_relative 'vpc/base_instance'
+
+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