ibm-cloud-sdk 0.1.3 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d147792b6e2fd5d7ddb2b243cb2993cb606289352883831c6b805c2489c1267b
-  data.tar.gz: e03cbb041d6aae300f09fa4b6fb1aaaed759b187645deb2e4eeca561307f4520
+  metadata.gz: 3e549ed1f265dba2b7b112602e225a10509451bffd348c7b04e0aefefe11a712
+  data.tar.gz: d342b3a1382bd87a650010b8558a1ce183eb9eb0f52081f8bfdbf4ec1ecf3bec
 SHA512:
-  metadata.gz: 920c4079d316f6d65dd4fb3b4d9bcb97d06d06b1165f43ba19b3b7c3f1e12dfe1063f2666fdaf26c2252e4fb9949363d804e4678c13f2676531993851da615d4
-  data.tar.gz: 125f277b64b64c751b5ae932df6d10203b7bbe01417f361667de8e36b942c574eb744e9432eebd3652ef2a21d0b5c34e05e936e3533a34c9f751d64d79bfeb0b
+  metadata.gz: 689e9dd7cbb37ebea1f48f04fd587560d7b9ed39dd625e860845aee646d02fb0077ea233c2e3d88ed99a4051d22b52c485c5ebc186c190b44875ecef8c1a8862
+  data.tar.gz: 5ee30dca7e7d6e7a141e44094f2de5f181b50cbeecc941b81da8589e639d07bb0f39555e1fd8be1dca2263ad46dcbac7eb4c80b5164ef60b6d5005126aaf1887

data/CHANGELOG.md

@@ -1,6 +1,29 @@
 # Changelog
 All notable changes to the gem ibm-cloud-sdk-ruby will be documented here.
 
+## v0.1.8 - 2020-10-01
+- Add second level instances
+
+## 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

data/Gemfile

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

data/ibm-cloud-sdk.gemspec

@@ -24,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,7 +184,7 @@ 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}")
@@ -115,11 +192,35 @@ module IBM
 
         # Delete a volume
         #
-        # @param volume_id [String] The ID of 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
@@ -132,7 +233,7 @@ 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}")
@@ -146,42 +247,64 @@ module IBM
         end
 
         # Get a storage types list in IBM  Power Cloud.
-        # note: this mehod to be refactored under the common 
+        # note: this method to be refactored under the common
         # IBM::Cloud::SDK::PowerIaas.endpoint when the rest api become available.
         #
-        # @return [Hash] StorageType
+        # @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))
+          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] The ID of 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}")
@@ -204,7 +327,7 @@ module IBM
         # 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
+        # @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)

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.3"
+      VERSION = "0.1.8"
     end
   end
 end

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

@@ -0,0 +1,133 @@
+# 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_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