ibm-cloud-sdk 0.1.6 → 0.1.11

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

@@ -5,16 +5,16 @@ module IBM
   module Cloud
     module SDK
       module VPC
-        module INSTANCES
+        module INSTANCE
           # Get a Floating IP.
-          class FloatingIps < BaseCollection
+          class FloatingIps < VPCCollection
             def initialize(parent)
               super(parent, 'floating_ips', child_class: FloatingIp)
             end
           end
 
           # Get a single floating IP.
-          class FloatingIp < BaseInstance
+          class FloatingIp < VPCInstance
           end
         end
       end

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

@@ -7,16 +7,16 @@ module IBM
   module Cloud
     module SDK
       module VPC
-        module INSTANCES
+        module INSTANCE
           # All netowrk interfaces.
-          class NetworkInterfaces < BaseCollection
+          class NetworkInterfaces < VPCCollection
             def initialize(parent)
               super(parent, 'network_interfaces', child_class: NetworkInterface)
             end
           end
 
           # A single network insterface.
-          class NetworkInterface < BaseInstance
+          class NetworkInterface < VPCInstance
             def floating_ips
               FloatingIps.new(self)
             end

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

@@ -5,16 +5,16 @@ module IBM
   module Cloud
     module SDK
       module VPC
-        module INSTANCES
+        module INSTANCE
           # Get all attached volumes.
-          class VolumeAttachments < BaseCollection
+          class VolumeAttachments < VPCCollection
             def initialize(parent)
               super(parent, 'volume_attachments', child_class: VolumeAttachment)
             end
           end
 
           # A single attached volume.
-          class VolumeAttachment < BaseInstance
+          class VolumeAttachment < VPCInstance
           end
         end
       end

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

@@ -6,14 +6,14 @@ module IBM
     module SDK
       module VPC
         # Work with multiple profiles.
-        class InstanceProfiles < BaseCollection
+        class InstanceProfiles < VPCCollection
           def initialize(parent)
-            super(parent, 'instance/profiles', child_class: Profile, array_key: 'profiles')
+            super(parent, 'instance/profiles', child_class: InstanceProfile, array_key: 'profiles')
           end
         end
 
         # Get a single profile.
-        class Profile < BaseInstance
+        class InstanceProfile < VPCInstance
         end
       end
     end

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

@@ -11,7 +11,7 @@ module IBM
       # Work with VPC instances.
       module VPC
         # Work with multiple VM instances.
-        class Instances < BaseCollection
+        class Instances < VPCCollection
           def initialize(parent)
             super(parent, 'instances', child_class: Instance)
           end
@@ -37,26 +37,119 @@ module IBM
         end
 
         # Work with a single instance.
-        class Instance < BaseInstance
+        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
 
-          def profiles
-            INSTANCE::Profiles.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/ipsec_policies.rb

@@ -6,14 +6,14 @@ module IBM
     module SDK
       module VPC
         # A list of IPSecPolicy
-        class IPSecPolicies < BaseCollection
+        class IPSecPolicies < VPCCollection
           def initialize(parent)
             super(parent, 'ike_policies', child_class: IPSecPolicy)
           end
         end
 
         # A single IPSecPolicy
-        class IPSecPolicy < BaseInstance
+        class IPSecPolicy < VPCInstance
           def connections
             get('connections')
           end

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

@@ -6,36 +6,14 @@ module IBM
     module SDK
       module VPC
         # A collection of SSH keys.
-        class Keys < BaseCollection
+        class Keys < VPCCollection
           def initialize(parent)
             super(parent, 'keys', child_class: Key)
           end
-
-          def fetch(resource_id: nil)
-            params = {}
-            params['resource_group.id'] = resource_id if resource_id
-            get(params: params)
-          end
-
-          def all(resource_id = nil)
-            fetch(resource_id: resource_id).subkey(@array_key)
-          end
-
-          # :reek:FeatureEnvy
-          def create(name, public_key, resource_group: nil, type: nil)
-            payload = { name: name, public_key: public_key }
-            payload[:resource_group] = resource_group if resource_group
-            payload[:type] = type if type
-            post(payload)
-          end
-
-          def key(id)
-            Key.new(self, id)
-          end
         end
 
         # A single key.
-        class Key < BaseInstance
+        class Key < VPCInstance
         end
       end
     end

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

@@ -8,7 +8,7 @@ module IBM
     module SDK
       module VPC
         # A single LoadBalancer
-        class LoadBalancer < BaseInstance
+        class LoadBalancer < VPCInstance
           def statistics
             get('statistics')
           end

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

@@ -9,7 +9,7 @@ module IBM
       module VPC
         module LOADBALANCER
           # A list of Listener
-          class Listeners < BaseCollection
+          class Listeners < VPCCollection
             def initialize(parent)
               @array_key = 'listeners'
               @instance = Listener
@@ -18,7 +18,7 @@ module IBM
           end
 
           # A single Listener
-          class Listener < BaseInstance
+          class Listener < VPCInstance
             def policies
               LOADBALANCER::Policies.new(self)
             end

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

@@ -6,7 +6,7 @@ module IBM
     module SDK
       module VPC
         # A list of Member
-        class Members < BaseCollection
+        class Members < VPCCollection
           def initialize(parent)
             @array_key = 'members'
             @instance = Member
@@ -15,7 +15,7 @@ module IBM
         end
 
         # A single Member
-        class Member < BaseInstance
+        class Member < VPCInstance
         end
       end
     end

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

@@ -9,7 +9,7 @@ module IBM
       module VPC
         module LOADBALANCER
           # A list of Policies
-          class Policies < BaseCollection
+          class Policies < VPCCollection
             def initialize(parent)
               @array_key = 'policies'
               @instance = Policy
@@ -18,7 +18,7 @@ module IBM
           end
 
           # A single Policy
-          class Policy < BaseInstance
+          class Policy < VPCInstance
             def rules
               Rules.new(self)
             end

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

@@ -8,7 +8,7 @@ module IBM
     module SDK
       module VPC
         # A list of Pool
-        class Pools < BaseCollection
+        class Pools < VPCCollection
           def initialize(parent)
             @array_key = 'pools'
             @instance = Pool
@@ -17,7 +17,7 @@ module IBM
         end
 
         # A single Pool
-        class Pool < BaseInstance
+        class Pool < VPCInstance
           def members
             Members.new(self)
           end

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

@@ -7,7 +7,7 @@ module IBM
       module VPC
         module LOADBALANCER
           # A list of Rule
-          class Rules < BaseCollection
+          class Rules < VPCCollection
             def initialize(parent)
               @array_key = 'rules'
               @instance = Rule
@@ -16,7 +16,7 @@ module IBM
           end
 
           # A single Rule
-          class Rule < BaseInstance
+          class Rule < VPCInstance
           end
         end
       end

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

@@ -8,7 +8,7 @@ module IBM
     module SDK
       module VPC
         # A list of LoadBalancer
-        class LoadBalancers < BaseCollection
+        class LoadBalancers < VPCCollection
           def initialize(parent)
             super(parent, 'load_balancers', child_class: LoadBalancer)
           end

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

@@ -6,14 +6,14 @@ module IBM
     module SDK
       module VPC
         # A list of NetworkACL
-        class NetworkACLs < BaseCollection
+        class NetworkACLs < VPCCollection
           def initialize(parent)
             super(parent, 'network_acls', child_class: NetworkACL)
           end
         end
 
         # A single NetworkACL
-        class NetworkACL < BaseInstance
+        class NetworkACL < VPCInstance
           def rules
             NETWORKACL::Rules.new(self)
           end
@@ -21,7 +21,7 @@ module IBM
 
         module NETWORKACL
           # A list of NetworkACL
-          class Rules < BaseCollection
+          class Rules < VPCCollection
             def initialize(parent)
               @array_key = 'network_acls'
               @instance = NetworkACL
@@ -30,7 +30,7 @@ module IBM
           end
 
           # A single NetworkACL
-          class Rule < BaseInstance
+          class Rule < VPCInstance
           end
         end
       end

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

@@ -6,14 +6,14 @@ module IBM
     module SDK
       module VPC
         # A list of OperatingSystem
-        class OperatingSystems < BaseCollection
+        class OperatingSystems < VPCCollection
           def initialize(parent)
             super(parent, 'operating_systems', child_class: OperatingSystem)
           end
         end
 
         # A single OperatingSystem
-        class OperatingSystem < BaseInstance
+        class OperatingSystem < VPCInstance
         end
       end
     end

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

@@ -6,14 +6,14 @@ module IBM
     module SDK
       module VPC
         # A list of PublicGateway
-        class PublicGateways < BaseCollection
+        class PublicGateways < VPCCollection
           def initialize(parent)
             super(parent, 'public_gateways', child_class: PublicGateway)
           end
         end
 
         # A single PublicGateway
-        class PublicGateway < BaseInstance
+        class PublicGateway < VPCInstance
         end
       end
     end