ibm-cloud-sdk 0.1.6 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 160845336c50ab1c67c274cb62fd5e52af7bf0d6e4b5a4a1b57c4ea3c5eb47db
-  data.tar.gz: 7762d522d6754815a4e19a927bdcce0d73a8c5a0d204980d44dfdf006d7254d4
+  metadata.gz: 336ae42302a72e720775cd6d0c6e193e4a6c9c2b2c4e2858b0c02e5d85e96380
+  data.tar.gz: 937ccbcf0d347b0bfaf06f959cf0e96a0aa9ea3816880795da47bfa60d0da3f5
 SHA512:
-  metadata.gz: f42fe440d6a3610c94b7336246eda2dfdf6f794afa501480e633563d3a25f2d27bc337ebf41f82b82dad3a3958c2dbbf094244da77021fbe188fffa5cb73d294
-  data.tar.gz: 7af6df6df99133b619aa62bcc03281dc58f8b1f79c1b26d57b6cbf490dfc85f0dbdd46d41306780d8ead81148d71bf9003b78b787d8d21a64c6974ac0fc546a7
+  metadata.gz: 511b9535c80328b92c3e9645a46058f26fda766444ecaf76fd71f8f64ebeea490aaec3284544df68b0cb84bec69dd50f1298dc20d48af17351db6abb60e858bd
+  data.tar.gz: 3f1ac1719230d2a8c2ed9e2645d8311c61e7b697dfc36960df9019224392facd5aab3e815ad5fd486ef9a863c935a019e41672c83881c0650a8144901334a8ad

data/CHANGELOG.md

@@ -1,6 +1,26 @@
 # Changelog
 All notable changes to the gem ibm-cloud-sdk-ruby will be documented here.
 
+## v0.1.11 - 2020-10-28
+- Add start, stop, and reboot actions on VPC instances
+
+## 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
+
+## 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

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

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/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,8 +19,12 @@ 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
@@ -41,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",
@@ -54,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",
@@ -61,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",
@@ -68,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
@@ -89,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}")
@@ -97,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
@@ -114,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}")
@@ -122,7 +192,7 @@ 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
@@ -135,6 +205,22 @@ module IBM
           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}/pvm-instances/#{pvm_instance_id}/volumes/#{volume_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}/pvm-instances/#{pvm_instance_id}/volumes/#{volume_id}")
+        end
+
         # Get all networks in an IBM Power Cloud instance
         #
         # @return [Array<Hash>] all networks for this IBM Power Cloud instance
@@ -147,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}")
@@ -161,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))[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}")
@@ -219,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

@@ -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'