ibm-cloud-sdk 0.1.10 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3846f53417aa653151063dfd91b59ea43b1ba3a9d2d53fdb085c8dc7f28bb2ea
-  data.tar.gz: 903b21299da1b4d57953b4af2a98d27bc99e34298781b7936deae237641d34c6
+  metadata.gz: 336ae42302a72e720775cd6d0c6e193e4a6c9c2b2c4e2858b0c02e5d85e96380
+  data.tar.gz: 937ccbcf0d347b0bfaf06f959cf0e96a0aa9ea3816880795da47bfa60d0da3f5
 SHA512:
-  metadata.gz: 9a1284cd63ae075ed1786f5045cb3951e328fb5edfcc95e1d981dd63c72a6ec85ff116102e07fe1317333dcc77305dad3287f312e184a31eb44bc3889303c521
-  data.tar.gz: 507dde2d35874cdee345b14c785d941b0b2a40014251ad8262f684f8f0966b050f57bb03e407332c006204344061c4963f4759895ab040d1ed24e5af73acc65d
+  metadata.gz: 511b9535c80328b92c3e9645a46058f26fda766444ecaf76fd71f8f64ebeea490aaec3284544df68b0cb84bec69dd50f1298dc20d48af17351db6abb60e858bd
+  data.tar.gz: 3f1ac1719230d2a8c2ed9e2645d8311c61e7b697dfc36960df9019224392facd5aab3e815ad5fd486ef9a863c935a019e41672c83881c0650a8144901334a8ad

data/CHANGELOG.md

@@ -1,6 +1,9 @@
 # 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

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

@@ -1,7 +1,7 @@
 module IBM
   module Cloud
     module SDK
-      VERSION = "0.1.10"
+      VERSION = "0.1.11"
     end
   end
 end

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

@@ -11,16 +11,15 @@ module IBM
         module VpcHTTP
           include SDKHTTP::BaseHTTPMixin
 
-          def metadata(query = nil, payload = nil)
-            @params ||= {}
-            @params.merge!(query) if query
-
-            payload ||= {}
-            {
-              query: { version: '2020-08-01', generation: 2 }.merge(@params),
-              body: payload,
-              headers: { "Authorization": @token.authorization_header }
-            }
+          # Preprocess request parameters, add required version and generation parameters to query.
+          # @param query [Hash] A hash of query parameters.
+          # @param payload [Hash] A hash to send as the body.
+          # @param payload_type [Hash] If json then convert to json string, else send as form data.
+          # @return [Hash]
+          def metadata(query = nil, payload = nil, payload_type = 'json')
+            default_params = { version: '2020-08-01', generation: 2 }
+            default_params.merge!(query) if query
+            super(default_params, payload, payload_type)
           end
         end
       end

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

@@ -1,6 +1,9 @@
 # typed: true
 # frozen_string_literal: true
 
+require 'date'
+require 'forwardable'
+
 module IBM
   module Cloud
     module SDK
@@ -11,6 +14,78 @@ module IBM
             def initialize(parent)
               super(parent, 'actions')
             end
+
+            # Send an action request to start the instance.
+            def start
+              create('start')
+            end
+
+            # Send an action request to stop the instance.
+            # @param force [Boolean] Clear the queue and run this action.
+            def stop(force: false)
+              create('stop', force: force)
+            end
+
+            # Send an action request to reboot the instance.
+            # @param force [Boolean] Clear the queue and run this action.
+            def reboot(force: false)
+              create('reboot', force: force)
+            end
+
+            # Send a custom action request.
+            # @param action [String] The type of action. Allowable values: [reboot, start, stop]
+            # @param force [Boolean] If set to true, the action will be forced immediately, and all queued actions deleted. Ignored for the start action.
+            def create(action, force: false)
+              @logger.info("Sending action request for #{action} with force #{force}.")
+              payload = { type: action }
+              payload[:force] = force if force
+              response = post(payload: payload)
+              Action.new(response)
+            end
+          end
+
+          # A base class that wraps the action response.
+          class Action
+            def initialize(response)
+              @response = response
+              @data = response.json
+              @keys = %i[type force created_at]
+              @deprecated = %i[completed_at started_at status id href]
+
+              clear_deprecated
+              add_inst_vars(@keys)
+            end
+
+            # Return the DateTime the action was created.
+            # @return [DateTime]
+            def created_at
+              return DateTime.parse(@created_at) if @created_at
+
+              @created_at
+            end
+
+            # The HTTP response object.
+            attr_accessor :response, :data
+
+            extend Forwardable
+            def_delegators :@data, :[], :dig, :each_pair, :each, :fetch, :has_key?, :has_value?, :include?, :index, :inspect, :key?, :keys, :length, :merge, :merge!, :clear, :to_h, :value?, :values, :pretty_print
+
+            private
+
+            # Iterate through an array of symbols. Set the instance variable and attr_accessor for each.
+            def add_inst_vars(keys)
+              keys.each do |k|
+                instance_variable_set "@#{k}", @data[k]
+                self.class.attr_accessor k unless respond_to?(k)
+              end
+            end
+
+            # Remove deprecated keys from hash.
+            def clear_deprecated
+              @data.each do |k, _v|
+                @data.delete(k) if @deprecated.include?(k)
+              end
+            end
           end
         end
       end

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

@@ -38,21 +38,118 @@ module IBM
 
         # Work with a single instance.
         class Instance < VPCInstance
+          TRANSITIONAL_STATES = %w[pausing pending restarting resuming starting stopping].freeze
+          ERROR_STATE = 'failed'
+          RUNNING_STATE = 'running'
+          STOPPED_STATES = %w[stopped paused].freeze
+
+          # The id of this VM.
+          def id
+            @data[:id]
+          end
+
+          # The name of this VM.
+          def name
+            @data[:name]
+          end
+
+          # The status of the virtual server instance. Possible values: [failed,paused,pausing,pending,restarting,resuming,running,starting,stopped,stopping]
+          def status
+            @data[:status]
+          end
+
+          # Whether the state of the VM is in failed state.
+          # @return [Boolean]
+          def failed?
+            status == ERROR_STATE
+          end
+
+          # Whether the state of the VM is in the started state.
+          # @return [Boolean]
+          def started?
+            status == RUNNING_STATE
+          end
+
+          # Whether the state of the VM is in a stopped or paused state.
+          # @return [Boolean]
+          def stopped?
+            STOPPED_STATES.include?(status)
+          end
+
+          # Whether the state of the VM is in a transitional state.
+          # @return [Boolean]
+          def transitional?
+            TRANSITIONAL_STATES.include?(status)
+          end
+
+          # Interact with instance actions.
+          # @return [INSTANCE::Actions]
           def actions
             INSTANCE::Actions.new(self)
           end
 
+          # Interact with instance network interfaces.
+          # @return [INSTANCE::NetworkInterfaces]
           def network_interfaces
             INSTANCE::NetworkInterfaces.new(self)
           end
 
+          # Interact with instance volume attachements.
+          # @return [INSTANCE::VolumeAttachments]
           def volume_attachments
             INSTANCE::VolumeAttachments.new(self)
           end
 
+          # Return the data used for initializing this VM.
           def initialization
             adhoc(method: 'get', path: 'initialization').json
           end
+
+          # Wait for the VM instance to be in a stable state.
+          # @param sleep_time [Integer] The time to sleep between refreshes.
+          # @param timeout [Integer] The number of seconds before raising an error.
+          # @param block [Proc] A block to test against. Must return a boolean.
+          # @raise [RuntimeError] Instance goes into failed state.
+          # @raise [RuntimeError] Timeout has been reached.
+          def wait_for!(sleep_time: 5, timeout: 600, &block)
+            @logger.info("Starting wait for instance #{id}. Starts in state #{status}.")
+            loop do
+              refresh
+              raise "VM #{id} is in a failed state." if failed?
+              break if block.call(self)
+
+              timeout = sleep_counter(sleep_time, timeout)
+              raise "Time out while waiting #{id} to be stable." if timeout <= 0
+            end
+            @logger.info("Finished wait for instance #{id}. Ends in state #{status}.")
+          end
+
+          # Wait for the VM instance to be have a started status.
+          # @param sleep_time [Integer] The time to sleep between refreshes.
+          # @param timeout [Integer] The number of seconds before raising an error.
+          # @raise [RuntimeError] Instance goes into failed state.
+          # @raise [RuntimeError] Timeout has been reached.
+          def wait_for_started!(sleep_time: 5, timeout: 600)
+            wait_for!(sleep_time: sleep_time, timeout: timeout, &:started?)
+          end
+
+          # Wait for the VM instance to be have a stopped status.
+          # @param sleep_time [Integer] The time to sleep between refreshes.
+          # @param timeout [Integer] The number of seconds before raising an error.
+          # @raise [RuntimeError] Instance goes into failed state.
+          # @raise [RuntimeError] Timeout has been reached.
+          def wait_for_stopped!(sleep_time: 5, timeout: 600)
+            wait_for!(sleep_time: sleep_time, timeout: timeout, &:stopped?)
+          end
+
+          private
+
+          # Sleep for the specificed time and decrement timout by that number.
+          # @return [Integer] The current timeout.
+          def sleep_counter(sleep_time, timeout)
+            sleep sleep_time
+            timeout - sleep_time
+          end
         end
       end
     end

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

@@ -22,7 +22,7 @@ module IBM
           # A single Connection
           class LocalCIDR < VPCInstance
             def update(payload)
-              put(payload)
+              put(payload: payload)
             end
           end
         end

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

@@ -22,7 +22,7 @@ module IBM
           # A single Connection
           class PeerCIDR < VPCInstance
             def update(payload)
-              put(payload)
+              put(payload: payload)
             end
           end
         end

data/lib/ibm/cloud/sdk_http/base_http_mixin.rb

@@ -10,47 +10,104 @@ module IBM
       module BaseHTTPMixin
         @connection = nil
 
-        def adhoc(method: 'get', path: nil, params: {}, payload: {})
-          unchecked_response(method: method, path: path, params: params, payload: payload).raise_for_status!
+        # Run a custom query and verify response is 2xx or 404.
+        # @param method [String] The HTTP method to use.
+        # @param path [String] The relative path from the current object location.
+        # @param params [Hash] A hash of query parameters.
+        # @param payload [Hash] A hash to send as the body.
+        # @param payload_type [Hash] If json then convert to json string, else send as form data.
+        # @return [SDKResponse]
+        # @raise [Exceptions::HttpStatusError] Raise if status checks failed.
+        def adhoc(method: 'get', path: nil, params: nil, payload: nil, payload_type: 'json')
+          unchecked_response(method: method, path: path, params: params, payload: payload, payload_type: payload_type).raise_for_status!
         end
 
-        def unchecked_response(method: 'get', path: nil, params: {}, payload: {})
-          @connection.request(method.to_sym, url(path), metadata(params, payload))
+        # Run a custom query do not verify the response.
+        # @param method [String] The HTTP method to use.
+        # @param path [String] The relative path from the current object location.
+        # @param params [Hash] A hash of query parameters.
+        # @param payload [Hash] A hash to send as the body.
+        # @param payload_type [Hash] If json then convert to json string, else send as form data.
+        def unchecked_response(method: 'get', path: nil, params: nil, payload: nil, payload_type: 'json')
+          @connection.request(method.to_sym, url(path), metadata(params, payload, payload_type))
         end
 
-        def get(path: nil, params: {})
+        attr_reader :endpoint
+
+        # Perform a GET request and verify response is 2xx or 404.
+        # @param path [String] The relative path from the current object location.
+        # @param params [Hash] A hash of query parameters.
+        # @return [SDKResponse]
+        # @raise [Exceptions::HttpStatusError] Raise if status checks failed.
+        def get(path: nil, params: nil)
           adhoc(method: 'get', path: path, params: params)
         end
 
-        attr_reader :endpoint
-
-        def post(payload = {}, path: nil, params: {})
-          adhoc(method: 'post', path: path, params: params, payload: payload)
+        # Send a POST request and verify response is 2xx or 404.
+        # @param path [String] The relative path from the current object location.
+        # @param params [Hash] A hash of query parameters.
+        # @param payload [Hash] A hash to send as the body.
+        # @param payload_type [Hash] If json then convert to json string, else send as form data.
+        # @raise [Exceptions::HttpStatusError] Raise if status checks failed.
+        # @return [SDKResponse]
+        def post(payload: nil, path: nil, params: nil, payload_type: 'json')
+          adhoc(method: 'post', path: path, params: params, payload: payload, payload_type: payload_type)
         end
 
-        def put(payload = {}, path: nil, params: {})
-          adhoc(method: 'put', path: path, params: params, payload: payload)
+        # Send a PUT request and verify response is 2xx or 404.
+        # @param path [String] The relative path from the current object location.
+        # @param params [Hash] A hash of query parameters.
+        # @param payload [Hash] A hash to send as the body.
+        # @param payload_type [Hash] If json then convert to json string, else send as form data.
+        # @raise [Exceptions::HttpStatusError] Raise if status checks failed.
+        # @return [SDKResponse]
+        def put(payload: nil, path: nil, params: nil, payload_type: 'json')
+          adhoc(method: 'put', path: path, params: params, payload: payload, payload_type: payload_type)
         end
 
-        def patch(payload = {},  path: nil, params: {})
-          adhoc(method: 'patch', path: path, params: params, payload: payload)
+        # Send a PATCH request and verify response is 2xx or 404.
+        # @param path [String] The relative path from the current object location.
+        # @param params [Hash] A hash of query parameters.
+        # @param payload [Hash] A hash to send as the body.
+        # @param payload_type [Hash] If json then convert to json string, else send as form data.
+        # @raise [Exceptions::HttpStatusError] Raise if status checks failed.
+        # @return [SDKResponse]
+        def patch(payload: nil, path: nil, params: nil, payload_type: 'json')
+          adhoc(method: 'patch', path: path, params: params, payload: payload, payload_type: payload_type)
         end
 
-        def delete(path: nil, params: {})
+        # Send a DELETE request and verify response is 2xx or 404.
+        # @param path [String] The relative path from the current object location.
+        # @param params [Hash] A hash of query parameters.
+        # @raise [Exceptions::HttpStatusError] Raise if status checks failed.
+        # @return [SDKResponse]
+        def delete(path: nil, params: nil)
           adhoc(method: 'delete', path: path, params: params)
         end
 
-        def metadata(query = nil, payload = nil)
+        # Preprocess request parameters with any additional data.
+        # @param query [Hash] A hash of query parameters.
+        # @param payload [Hash] A hash to send as the body.
+        # @param payload_type [Hash] If json then convert to json string, else send as form data.
+        # @return [Hash]
+        def metadata(query = nil, payload = nil, payload_type = 'json')
           @params ||= {}
-          query ||= {}
-          payload ||= {}
-          {
-            query: @params.merge(query),
-            body: payload,
+          @params.merge!(query) if query
+
+          send_parameters = {
+            query: @params,
             headers: { "Authorization": @token.authorization_header }
           }
+
+          # Add payload if it is not nil.
+          if payload && payload.empty? == false
+            payload = payload.to_json if payload_type == 'json'
+            send_parameters[:body] = payload
+          end
+          send_parameters
         end
 
+        # Merge path with current class's endpoint.
         def url(path = nil)
           return endpoint unless path
           return path if URI.parse(path).relative? == false

data/lib/ibm/cloud/sdk_http/base_instance.rb

@@ -39,7 +39,7 @@ module IBM
 
         # Send an update to the server for this resource.
         def update(payload)
-          patch(payload)
+          patch(payload: payload)
         end
 
         # Send a delete request to the server for this resource.

data/lib/ibm/cloud/sdk_http/connection.rb

@@ -11,7 +11,13 @@ module IBM
         include HTTParty
 
         def initialize(logger)
-          self.class.logger(logger, :debug, :curl)
+          @logger = logger
+          self.class.logger(logger, :debug, :apache)
+        end
+
+        # Set the logger type to curl which has more information.
+        def verbose_logger=(verbosity)
+          default_options[:log_format] = verbosity ? :curl : :apache
         end
 
         def default_options

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ibm-cloud-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.11
 platform: ruby
 authors:
 - IBM Cloud Developers
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-08 00:00:00.000000000 Z
+date: 2020-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -121,7 +121,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.10/CHANGELOG.md
+  changelog_uri: https://github.com/IBM-Cloud/ibm-cloud-sdk-ruby/blob/v0.1.11/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: