softlayer_api 3.0.0 → 3.0.1

data/lib/softlayer/UserCustomer.rb

@@ -0,0 +1,144 @@
+#--
+# Copyright (c) 2014 SoftLayer Technologies, Inc. All rights reserved.
+#
+# For licensing information see the LICENSE.md file in the project root.
+#++
+
+module SoftLayer
+  ##
+  # Each SoftLayer UserCustomer instance provides information
+  # relating to a single SoftLayer customer portal user
+  #
+  # This class roughly corresponds to the entity SoftLayer_User_Customer
+  # in the API.
+  #
+  class UserCustomer < ModelBase
+    include ::SoftLayer::DynamicAttribute
+
+    ##
+    # :attr_reader:
+    # A portal user's secondary phone number.
+    sl_attr :alternate_phone,  'alternatePhone'
+
+    ##
+    # :attr_reader:
+    # The date a portal user's record was created.
+    sl_attr :created,          'createDate'
+
+    ##
+    # :attr_reader:
+    # The portal user's display name.
+    sl_attr :display_name,     'displayName'
+
+    ##
+    # :attr_reader:
+    # A portal user's email address.
+    sl_attr :email
+
+    ##
+    # :attr_reader:
+    # A portal user's first name.
+    sl_attr :first_name,       'firstName'
+
+    ##
+    # :attr_reader:
+    # A portal user's last name.
+    sl_attr :last_name,        'lastName'
+
+    ##
+    # :attr_reader:
+    # The date a portal user's record was last modified.
+    sl_attr :modified,         'modifyDate'
+
+    ##
+    # :attr_reader:
+    # A portal user's office phone number.
+    sl_attr :office_phone,     'officePhone'
+
+    ##
+    # :attr_reader:
+    # The expiration date for the user's password.
+    sl_attr :password_expires, 'passwordExpireDate'
+
+    ##
+    # :attr_reader:
+    # The date a portal users record's last status change.
+    sl_attr :status_changed,   'statusDate'
+
+    ##
+    # :attr_reader:
+    # A portal user's username.
+    sl_attr :username
+
+    ##
+    # A portal user's additional email addresses.
+    # These email addresses are contacted when updates are made to support tickets.
+    sl_dynamic_attr :additional_emails do |resource|
+      resource.should_update? do
+        #only retrieved once per instance
+        @additional_emails == nil
+      end
+
+      resource.to_update do
+        additional_emails = self.service.getAdditionalEmails
+        additional_emails.collect { |additional_email| additional_email['email'] }
+      end
+    end
+
+    ##
+    # A portal user's API Authentication keys.
+    # There is a max limit of two API keys per user.
+    sl_dynamic_attr :api_authentication_keys do |resource|
+      resource.should_update? do
+        #only retrieved once per instance
+        @api_authentication_keys == nil
+      end
+
+      resource.to_update do
+        self.service.object_mask("mask[authenticationKey,ipAddressRestriction]").getApiAuthenticationKeys
+      end
+    end
+    
+    ##
+    # The external authentication bindings that link an external identifier to a SoftLayer user.
+    sl_dynamic_attr :external_bindings do |resource|
+      resource.should_update? do
+        #only retrieved once per instance
+        @external_bindings == nil
+      end
+
+      resource.to_update do
+        external_bindings = self.service.object_mask(UserCustomerExternalBinding.default_object_mask).getExternalBindings
+        external_bindings.collect { |external_binding| UserCustomerExternalBinding.new(soflayer_client, external_binding) }
+      end
+    end
+
+    ##
+    # Returns the service for interacting with this user customer through the network API
+    #
+    def service
+      softlayer_client[:User_Customer].object_with_id(self.id)
+    end
+
+    protected
+
+    def self.default_object_mask
+      {
+        "mask(SoftLayer_User_Customer)" => [
+                                            'alternatePhone',
+                                            'createDate',
+                                            'displayName',
+                                            'email',
+                                            'firstName',
+                                            'id',
+                                            'lastName',
+                                            'modifyDate',
+                                            'officePhone',
+                                            'passwordExpireDate',
+                                            'statusDate',
+                                            'username'
+                                           ]
+      }.to_sl_object_mask
+    end
+  end
+end #SoftLayer

data/lib/softlayer/UserCustomerExternalBinding.rb

@@ -0,0 +1,97 @@
+#--
+# Copyright (c) 2014 SoftLayer Technologies, Inc. All rights reserved.
+#
+# For licensing information see the LICENSE.md file in the project root.
+#++
+
+module SoftLayer
+  ##
+  # Each SoftLayer UserCustomerExternalBinding instance provides information
+  # for a single user customer's external binding.
+  #
+  # This class roughly corresponds to the entity SoftLayer_User_Customer_External_Binding
+  # in the API.
+  #
+  class UserCustomerExternalBinding < ModelBase
+    include ::SoftLayer::DynamicAttribute
+
+    ##
+    # :attr_reader:
+    # The flag that determines whether the external binding is active will be
+    # used for authentication or not.
+    sl_attr :active
+
+    ##
+    # :attr_reader:
+    # The date that the external authentication binding was created.
+    sl_attr :created, 'createDate'
+
+    ##
+    # :attr_reader:
+    # The password used to authenticate the external id at an external
+    # authentication source.
+    sl_attr :password
+
+    ##
+    # An optional note for identifying the external binding.
+    sl_dynamic_attr :note do |resource|
+      resource.should_update? do
+        #only retrieved once per instance
+        @note == nil
+      end
+
+      resource.to_update do
+        self.service.getNote
+      end
+    end
+
+    ##
+    # The user friendly name of a type of external authentication binding.
+    sl_dynamic_attr :type do |resource|
+      resource.should_update? do
+        #only retrieved once per instance
+        @type == nil
+      end
+
+      resource.to_update do
+        type = self.service.getType
+        type['name']
+      end
+    end
+
+    ##
+    # The user friendly name of an external binding vendor.
+    sl_dynamic_attr :vendor do |resource|
+      resource.should_update? do
+        #only retrieved once per instance
+        @vendor == nil
+      end
+
+      resource.to_update do
+        vendor = self.service.getVendor
+        vendor['name']
+      end
+    end
+
+    ##
+    # Returns the service for interacting with this user customer extnerla binding
+    # through the network API
+    #
+    def service
+      softlayer_client[:User_Customer_External_Binding].object_with_id(self.id)
+    end
+
+    protected
+
+    def self.default_object_mask
+      {
+        "mask(SoftLayer_User_Customer_External_Binding)" => [
+                                                             'active',
+                                                             'createDate',
+                                                             'id',
+                                                             'password'
+                                                            ]
+      }.to_sl_object_mask
+    end
+  end
+end #SoftLayer

data/lib/softlayer/VirtualDiskImage.rb

@@ -0,0 +1,181 @@
+#--
+# Copyright (c) 2014 SoftLayer Technologies, Inc. All rights reserved.
+#
+# For licensing information see the LICENSE.md file in the project root.
+#++
+
+module SoftLayer
+  ##
+  # Each SoftLayer VirtualDiskImage instance provides information about software
+  # installed on a specific piece of hardware.
+  #
+  # This class roughly corresponds to the entity SoftLayer_Virtual_Disk_Image
+  # in the API.
+  #
+  class VirtualDiskImage < ModelBase
+    include ::SoftLayer::DynamicAttribute
+
+    ##
+    # :attr_reader:
+    # A disk image's size measured in gigabytes.
+    sl_attr :capacity
+
+    ##
+    # :attr_reader:
+    # A disk image's unique md5 checksum.
+    sl_attr :checksum
+
+    ##
+    # :attr_reader:
+    # The date a disk image was created.
+    sl_attr :created,    'createDate'
+
+    ##
+    # :attr_reader:
+    # A brief description of a virtual disk image.
+    sl_attr :description
+
+    ##
+    # :attr_reader:
+    # The date a disk image was last modified.
+    sl_attr :modified,   'modifyDate'
+
+    ##
+    # :attr_reader:
+    # A descriptive name used to identify a disk image to a user.
+    sl_attr :name
+
+    ##
+    # :attr_reader:
+    # The unit of storage in which the size of the image is measured.
+    # Defaults to "GB" for gigabytes.
+    sl_attr :units
+
+    ##
+    # :attr_reader:
+    # A disk image's unique ID on a virtualization platform.
+    sl_attr :uuid
+
+    ##
+    # Returns coalesced disk images associated with this virtual disk image
+    sl_dynamic_attr :coalesced_disk_images do |resource|
+      resource.should_update? do
+        #only retrieved once per instance
+        @coalesced_disk_images == nil
+      end
+
+      resource.to_update do
+        coalesced_disk_images = self.service.getCoalescedDiskImages
+        coalesced_disk_images.collect { |coalesced_disk_image| VirtualDiskImage.new(softlayer_client, coalesced_disk_image) }
+      end
+    end
+    
+    ##
+    # Returns local disk flag associated with virtual disk image
+    sl_dynamic_attr :local_disk do |resource|
+      resource.should_update? do
+        #only retrieved once per instance
+        @local_disk == nil
+      end
+
+      resource.to_update do
+        self.service.getLocalDiskFlag
+      end
+    end
+
+    ##
+    # Whether this disk image is meant for storage of custom user data
+    # supplied with a Cloud Computing Instance order.
+    sl_dynamic_attr :metadata do |resource|
+      resource.should_update? do
+        #only retrieved once per instance
+        @metadata == nil
+      end
+
+      resource.to_update do
+        self.service.getMetadataFlag
+      end
+    end
+
+    ##
+    # References to the software that resides on a disk image.
+    sl_dynamic_attr :software do |resource|
+      resource.should_update? do
+        #only retrieved once per instance
+        @software == nil
+      end
+
+      resource.to_update do
+        software_references = self.service.object_mask(VirtualDiskImageSoftware.default_object_mask).getSoftwareReferences
+        software_references.collect { |software| VirtualDiskImageSoftware.new(softlayer_client, software) unless software.empty? }.compact
+      end
+    end
+
+    ##
+    # The original disk image that the current disk image was cloned from.
+    sl_dynamic_attr :source_disk_image do |resource|
+      resource.should_update? do
+        #only retrieved once per instance
+        @source_disk_image == nil
+      end
+
+      resource.to_update do
+        source_disk_image = self.service.object_mask(VirtualDiskImage.default_object_mask).getSourceDiskImage
+        VirtualDiskImage.new(softlayer_client, source_disk_image) unless source_disk_image.empty?
+      end
+    end
+
+    ##
+    # A brief description of a virtual disk image type's function.
+    sl_dynamic_attr :type_description do |resource|
+      resource.should_update? do
+        #only retrieved once per instance
+        @type_description == nil
+      end
+
+      resource.to_update do
+        type = self.service.getType
+        type['description']
+      end
+    end
+
+    ##
+    # A virtual disk image type's name.
+    sl_dynamic_attr :type_name do |resource|
+      resource.should_update? do
+        #only retrieved once per instance
+        @type_name == nil
+      end
+
+      resource.to_update do
+        type = self.service.getType
+        type['name']
+      end
+    end
+
+    ##
+    # Returns the service for interacting with this virtual disk image through the network API
+    #
+    def service
+      softlayer_client[:Virtual_Disk_Image].object_with_id(self.id)
+    end
+
+    protected
+
+    def self.default_object_mask
+      {
+        "mask(SoftLayer_Virtual_Disk_Image)" => [
+                                                 'capacity',
+                                                 'checksum',
+                                                 'createDate',
+                                                 'description',
+                                                 'id',
+                                                 'modifyDate',
+                                                 'name',
+                                                 'units',
+                                                 'uuid'
+                                                ]
+      }.to_sl_object_mask
+    end
+  end
+end #SoftLayer

data/lib/softlayer/VirtualDiskImageSoftware.rb

@@ -0,0 +1,51 @@
+#--
+# Copyright (c) 2014 SoftLayer Technologies, Inc. All rights reserved.
+#
+# For licensing information see the LICENSE.md file in the project root.
+#++
+
+module SoftLayer
+  ##
+  # Each SoftLayer VirtualDiskImageSoftware is a record that connects 
+  # a computing instance's virtual disk images with software records. 
+  #
+  # This class roughly corresponds to the entity SoftLayer_Virtual_Disk_Image_Software
+  # in the API.
+  #
+  class VirtualDiskImageSoftware < ModelBase
+    include ::SoftLayer::DynamicAttribute
+
+    ##
+    # The manufacturer, name and version of a piece of software.
+    #
+    def description
+      self['softwareDescription']['longDescription']
+    end
+
+    ##
+    # The name of this specific piece of software.
+    #
+    def name
+      self['softwareDescription']['name']
+    end
+
+    ##
+    # The password for this specific virtual disk image software instance.
+    #
+    def passwords
+      self['passwords']
+    end
+    
+    protected
+
+    def self.default_object_mask
+      {
+        "mask(SoftLayer_Virtual_Disk_Image_Software)" => [
+                                                          'id',
+                                                          'passwords[password,username]',
+                                                          'softwareDescription[longDescription,name]'
+                                                         ]
+      }.to_sl_object_mask
+    end
+  end
+end #SoftLayer