ibm-cloud-sdk 0.1.2 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68e0c97762894e63e4db55f70706d6b983b3f3260f148fbca1c9b0a5feae1ee7
-  data.tar.gz: b1ad978d42046dfbeb0d3f5466a9c1d73de597ba3c1663d6f470f60dc842acd9
+  metadata.gz: 49b6c34b47c964d6025eb8ca01efc3221fe33603c1c56b3e86167925f6132f60
+  data.tar.gz: df5e08b1f01c0e05fbec5e8f5887139dde7210be53b2cf538b0357b7efe5f0a1
 SHA512:
-  metadata.gz: cc621c2428dcf979379ff89acf278b56083837c51d964d99677782855e02c7556eb681b413df992ccb4b7e52bf941f1a302d76657337eee3a737a4a58fcdbba7
-  data.tar.gz: b247412ced34770e9e0efa7b9c6639aad56d69a2698f5659b0ad38367f41d452be02809ea2ed59319ed5031af0f56cf1d8b6d7703b08542c770669f1f2377a0b
+  metadata.gz: afe2bfaae5cb2a853cd7ba2523a2aed7f0da6f6c319d1c2d730993ab5dc93613e928a423a0a7e0310023e96ad71aaa2f8129b5908d0c767e3679fdae8fa063ec
+  data.tar.gz: 91d9e41682d13a1671d63c57fb2a4620b8b5f4d001c055036b7942b60a1e57b9e8a348a4615866851ff09389f6ed868ce7a62eff15b85c7bc8d564559f1180c2

data/CHANGELOG.md

@@ -0,0 +1,32 @@
+# Changelog
+All notable changes to the gem ibm-cloud-sdk-ruby will be documented here.
+
+## v0.1.7 - 2020-09-28
+- Added Logging in IBM Cloud
+- Add VCR to vpc spec
+- Add exception when status of response is not in 200 range or 404
+- Power IaaS Update docstrings, VM actions volumes
+
+## 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/Gemfile

@@ -5,3 +5,5 @@ gemspec
 
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
+gem 'vcr'
+gem 'webmock'

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,8 @@ 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
   module Cloud

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

@@ -0,0 +1,21 @@
+require_relative 'null_logger'
+
+module IBM
+  module Cloud
+    module SDK
+      class << self
+        attr_writer :logger
+      end
+
+      def self.logger
+        @logger ||= NullLogger.new
+      end
+
+      module Logging
+        def logger
+          IBM::Cloud::SDK.logger
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require "logger"
+
+module IBM
+  module Cloud
+    module SDK
+      class NullLogger < Logger
+        def initialize(*_args)
+        end 
+
+        def add(*_args, &_block)
+        end 
+
+        def debug?
+          false
+        end
+      end
+    end
+  end
+end

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

@@ -1,7 +1,11 @@
+require_relative 'logging'
+
 module IBM
   module Cloud
     module SDK
       class PowerIaas < BaseService
+        include Logging
+
         # Create an API Client object for the Power IaaS service
         #
         # @param region [String] the IBM Power Cloud instance region
@@ -15,12 +19,23 @@ module IBM
           @region = region
           @token  = token
           @tenant = tenant
+          RestClient.log = logger
         end
 
+        # Get the API service Endpoint URL
+        #
+        # @return [String] Endpoint URL
         def endpoint
           "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
         #
         # @return [Array<Hash>] all PVM Instances for this instance
@@ -34,12 +49,15 @@ module IBM
 
         # Get an IBM Power Cloud PVM instance
         #
-        # @param pvm_instance_id [String] the PVM instance ID
+        # @param pvm_instance_id [String] PVM instance ID
         # @return [Hash] PVM Instances
         def get_pvm_instance(instance_id)
           get("cloud-instances/#{guid}/pvm-instances/#{instance_id}")
         end
 
+        # Perform 'start' action on a PVMInstance
+        #
+        # @param pvm_instance_id [String] PVM instance ID
         def start_pvm_instance(instance_id)
           post(
             "cloud-instances/#{guid}/pvm-instances/#{instance_id}/action",
@@ -47,6 +65,9 @@ module IBM
           )
         end
 
+        # Perform 'stop' action on a PVMInstance
+        #
+        # @param pvm_instance_id [String] PVM instance ID
         def stop_pvm_instance(instance_id)
           post(
             "cloud-instances/#{guid}/pvm-instances/#{instance_id}/action",
@@ -54,6 +75,22 @@ module IBM
           )
         end
 
+        # Perform 'immediate-shutdown' action on a PVMInstance
+        #
+        # @param pvm_instance_id [String] PVM instance ID
+        def immediate_shutdown_pvm_instance(instance_id)
+          post(
+            "cloud-instances/#{guid}/pvm-instances/#{instance_id}/action",
+            {"action" => "immediate-shutdown"}.to_json
+          )
+        end
+
+        # Perform 'reboot' action on a PVMInstance
+        #
+        # This action has been deprecated and replaced by 'soft-reboot'
+        # and 'hard-reboot'
+        #
+        # @param pvm_instance_id [String] PVM instance ID
         def reboot_pvm_instance(instance_id)
           post(
             "cloud-instances/#{guid}/pvm-instances/#{instance_id}/action",
@@ -61,10 +98,47 @@ module IBM
           )
         end
 
+        # Perform 'soft-reboot' action on a PVMInstance
+        #
+        # @param pvm_instance_id [String] PVM instance ID
+        def soft_reboot_pvm_instance(instance_id)
+          post(
+            "cloud-instances/#{guid}/pvm-instances/#{instance_id}/action",
+            {"action" => "soft-reboot"}.to_json
+          )
+        end
+
+        # Perform 'hard-reboot' action on a PVMInstance
+        #
+        # @param pvm_instance_id [String] PVM instance ID
+        def hard_reboot_pvm_instance(instance_id)
+          post(
+            "cloud-instances/#{guid}/pvm-instances/#{instance_id}/action",
+            {"action" => "hard-reboot"}.to_json
+          )
+        end
+
+        # Perform 'reset-state' action on a PVMInstance
+        #
+        # @param pvm_instance_id [String] PVM instance ID
+        def reset_state_pvm_instance(instance_id)
+          post(
+            "cloud-instances/#{guid}/pvm-instances/#{instance_id}/action",
+            {"action" => "reset-state"}.to_json
+          )
+        end
+
+        # Create a new PVM instance
+        #
+        # @param instance_hash [Hash] New instance attributes
+        # @return [Hash] PVMInstance
         def create_pvm_instance(instance_hash)
           post("cloud-instances/#{guid}/pvm-instances", instance_hash.to_json)
         end
 
+        # Delete a PVM instance
+        #
+        # @param pvm_instance_id [String] PVM instance ID
         def delete_pvm_instance(instance_id)
           delete("cloud-instances/#{guid}/pvm-instances/#{instance_id}")
         end
@@ -82,7 +156,7 @@ module IBM
 
         # Get an IBM Power Cloud image
         #
-        # @param image_id [String] The ID of an Image
+        # @param image_id [String] Image ID
         # @return [Hash] Image
         def get_image(image_id)
           get("cloud-instances/#{guid}/images/#{image_id}")
@@ -90,6 +164,9 @@ module IBM
           nil
         end
 
+        # Delete an image from a cloud instance
+        #
+        # @param image_id [String] Image ID
         def delete_image(image_id)
           delete("cloud-instances/#{guid}/images/#{image_id}")
         end
@@ -107,12 +184,43 @@ module IBM
 
         # Get a specific volume
         #
-        # @param volume_id [String] The ID of a volume
+        # @param volume_id [String] Image ID
         # @return [Hash] Volume
         def get_volume(volume_id)
           get("cloud-instances/#{guid}/volumes/#{volume_id}")
         end
 
+        # Delete a volume
+        #
+        # @param volume_id [String] Volume ID
+        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
+
+        # Attach a volume
+        #
+        # @param pvm_instance_id [String] PVM Instance ID
+        # @param  volume_id [String] Volume ID
+        def attach_volume(pvm_instance_id, volume_id)
+          post("cloud-instances/#{guid}/volumes/#{volumd_id}")
+        end
+
+        # Detach a volume
+        #
+        # @param pvm_instance_id [String] PVM Instance ID
+        # @param  volume_id [String] Volume ID
+        def detach_volume(pvm_instance_id, volume_id)
+          delete("cloud-instances/#{guid}/volumes/#{volumd_id}")
+        end
+
         # Get all networks in an IBM Power Cloud instance
         #
         # @return [Array<Hash>] all networks for this IBM Power Cloud instance
@@ -125,37 +233,106 @@ module IBM
 
         # Get an IBM Power Cloud network
         #
-        # @param network_id [String] the network ID
+        # @param network_id [String] Network ID
         # @return [Hash] Network
         def get_network(network_id)
           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 method to be refactored under the common
+        # IBM::Cloud::SDK::PowerIaas.endpoint when the rest api become available.
+        #
+        # @return [Array<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
+
+        # Create a new network
+        #
+        # @param network_hash [Hash] New network attributes
+        # @return [Hash] Network
         def create_network(network_hash)
           post("cloud-instances/#{guid}/networks", network_hash.to_json)
         end
 
+        # Delete a network
+        #
+        # @param network_id [String] Network ID
         def delete_network(network_id)
           delete("cloud-instances/#{guid}/networks/#{network_id}")
         end
 
+        # Get all ports for a network
+        #
+        # @param network_id [String] Network ID
+        # @return [Array<Hash>] NetworkPort
         def get_network_ports(network_id)
           get("cloud-instances/#{guid}/networks/#{network_id}/ports")["ports"]
         end
 
+        # List the tenant's SSH Keys
+        #
+        # @return [Array<Hash>] SSHKey
         def get_ssh_keys
           get("tenants/#{tenant}")["sshKeys"]
         end
 
+        # Add a new SSH key to the tenant
+        #
+        # @param name [String] User defined name for the SSH key
+        # @param sshkey [String] SSH RSA key
+        # @return [Hash] SSHKey
         def create_key_pair(name, sshkey)
           payload = {"name" => name, "sshkey" => sshkey}
           post("tenants/#{tenant}/sshkeys", payload.to_json)
         end
 
+        # Delete SSH key from the tenant
+        #
+        # @param sshkey_name [String] SSH Key name
         def delete_key_pair(name)
           delete("tenants/#{tenant}/sshkeys/#{name}")
         end
 
+        # Get an SAP profile
+        #
+        # @param sap_profile_id [String] SAP Profile ID
+        # @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] SAP Profile ID
+        # @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