softlayer_api 3.0.2 → 3.1.0

data/lib/softlayer/UserCustomerExternalBinding.rb

@@ -22,8 +22,15 @@ module SoftLayer
     sl_attr :active
 
     ##
-    # :attr_reader:
+    # :attr_reader: created_at
+    # The date that the external authentication binding was created.
+    sl_attr :created_at, 'createDate'
+
+    ##
+    # :attr_reader: created
     # The date that the external authentication binding was created.
+    # DEPRECATION WARNING: This attribute is deprecated in favor of created_at
+    # and will be removed in the next major release.
     sl_attr :created, 'createDate'
 
     ##
@@ -33,7 +40,9 @@ module SoftLayer
     sl_attr :password
 
     ##
-    # An optional note for identifying the external binding.
+    # Retrieve an optional note for identifying the external binding.
+    # :call-seq:
+    #   note(force_update=false)
     sl_dynamic_attr :note do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -46,7 +55,9 @@ module SoftLayer
     end
 
     ##
-    # The user friendly name of a type of external authentication binding.
+    # Retrieve the user friendly name of a type of external authentication binding.
+    # :call-seq:
+    #   type(force_update=false)
     sl_dynamic_attr :type do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -60,7 +71,9 @@ module SoftLayer
     end
 
     ##
-    # The user friendly name of an external binding vendor.
+    # Retrieve the user friendly name of an external binding vendor.
+    # :call-seq:
+    #   vendor(force_update=false)
     sl_dynamic_attr :vendor do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -74,7 +87,7 @@ module SoftLayer
     end
 
     ##
-    # Returns the service for interacting with this user customer extnerla binding
+    # Returns the service for interacting with this user customer external binding
     # through the network API
     #
     def service

data/lib/softlayer/VLANFirewall.rb

@@ -17,20 +17,26 @@ module SoftLayer
   # As a result, instances of this class correspond to certain instances
   # in the SoftLayer_Network_Vlan service.
   #
-	class VLANFirewall < SoftLayer::ModelBase
+  class VLANFirewall < SoftLayer::ModelBase
     include ::SoftLayer::DynamicAttribute
 
     ##
-    #:attr_reader:
+    # :attr_reader: vlan_number
+    #
+    # The number of the VLAN protected by this firewall.
+    sl_attr :vlan_number, 'vlanNumber'
+
+    ##
+    # :attr_reader: VLAN_number
     #
     # The number of the VLAN protected by this firewall.
     #
+    # DEPRECATION WARNING: This attribute is deprecated in favor of vlan_number
+    # and will be removed in the next major release.
     sl_attr :VLAN_number, 'vlanNumber'
 
     ##
-    # :attr_reader:
-    #
-    # The set of rules applied by this firewall to incoming traffic.
+    # Retrieve the set of rules applied by this firewall to incoming traffic.
     # The object will retrieve the rules from the network API every
     # time you ask it for the rules.
     #
@@ -38,6 +44,8 @@ module SoftLayer
     # order that the firewall applies the rules, however please see
     # the important note in change_rules! concerning the "orderValue"
     # property of the rules.
+    # :call-seq:
+    #   rules(force_update=false)
     sl_dynamic_attr :rules do |firewall_rules|
       firewall_rules.should_update? do
         # firewall rules update every time you ask for them.
@@ -54,6 +62,16 @@ module SoftLayer
     ##
     # Returns the name of the primary router the firewall is attached to.
     # This is often a "customer router" in one of the datacenters.
+    def primary_router
+      return self['primaryRouter']['hostname']
+    end
+
+    ##
+    # Returns the name of the primary router the firewall is attached to.
+    # This is often a "customer router" in one of the datacenters.
+    #
+    # DEPRECATION WARNING: This method is deprecated in favor of primary_router
+    # and will be removed in the next major release.
     def primaryRouter
       return self['primaryRouter']['hostname']
     end
@@ -61,6 +79,20 @@ module SoftLayer
     ##
     # The fully qualified domain name of the physical device the
     # firewall is implemented by.
+    def fqdn
+      if self.has_sl_property?('networkVlanFirewall')
+        return self['networkVlanFirewall']['fullyQualifiedDomainName']
+      else
+        return @softlayer_hash
+      end
+    end
+
+    ##
+    # The fully qualified domain name of the physical device the
+    # firewall is implemented by.
+    #
+    # DEPRECATION WARNING: This method is deprecated in favor of fqdn
+    # and will be removed in the next major release.
     def fullyQualifiedDomainName
       if self.has_sl_property?('networkVlanFirewall')
         return self['networkVlanFirewall']['fullyQualifiedDomainName']
@@ -120,7 +152,7 @@ module SoftLayer
     # *NOTE!* The rules themselves have an "orderValue" property.
     # It is this property, and *not* the order that the rules are
     # found in the rules_data array, which will determine in which
-    # order the firewall applies its rules to incomming traffic.
+    # order the firewall applies its rules to incoming traffic.
     #
     # *NOTE!* Changes to the rules are not applied immediately
     # on the server side. Instead, they are enqueued by the
@@ -210,7 +242,7 @@ module SoftLayer
       softlayer_client = client || Client.default_client
       raise "#{__method__} requires a client but none was given and Client::default_client is not set" if !softlayer_client
 
-      # only VLAN firewallas have a networkVlanFirewall component
+      # only VLAN firewalls have a networkVlanFirewall component
       vlan_firewall_filter = SoftLayer::ObjectFilter.new() { |filter|
         filter.accept("networkVlans.networkVlanFirewall").when_it is_not_null
       }
@@ -219,7 +251,6 @@ module SoftLayer
       vlan_firewalls.collect { |firewall_data| SoftLayer::VLANFirewall.new(softlayer_client, firewall_data)}
     end
 
-
     #--
     # Methods for the SoftLayer model
     #++
@@ -277,4 +308,4 @@ module SoftLayer
        'version']
     end
   end # class Firewall
-end # module SoftLayer
+end # module SoftLayer

data/lib/softlayer/VLANFirewallOrder.rb

@@ -14,7 +14,7 @@ module SoftLayer
     attr_reader :vlan_id
 
     ##
-    # Set high_availabilty to true if you want redundant
+    # Set high_availability to true if you want redundant
     # firewall devices (defaults to false, no high_availability)
     attr_accessor :high_availability
 

data/lib/softlayer/VirtualDiskImage.rb

@@ -26,8 +26,15 @@ module SoftLayer
     sl_attr :checksum
 
     ##
-    # :attr_reader:
+    # :attr_reader: created_at
+    # The date a disk image was created.
+    sl_attr :created_at,    'createDate'
+
+    ##
+    # :attr_reader: created
     # The date a disk image was created.
+    # DEPRECATION WARNING: This attribute is deprecated in favor of created_at
+    # and will be removed in the next major release.
     sl_attr :created,    'createDate'
 
     ##
@@ -36,8 +43,15 @@ module SoftLayer
     sl_attr :description
 
     ##
-    # :attr_reader:
+    # :attr_reader: modified_at
+    # The date a disk image was last modified.
+    sl_attr :modified_at,   'modifyDate'
+
+    ##
+    # :attr_reader: modified
     # The date a disk image was last modified.
+    # DEPRECATION WARNING: This attribute is deprecated in favor of modified_at
+    # and will be removed in the next major release.
     sl_attr :modified,   'modifyDate'
 
     ##
@@ -57,7 +71,9 @@ module SoftLayer
     sl_attr :uuid
 
     ##
-    # Returns coalesced disk images associated with this virtual disk image
+    # Retrieve coalesced disk images associated with this virtual disk image
+    # :call-seq:
+    #   coalesced_disk_images(force_update=false)
     sl_dynamic_attr :coalesced_disk_images do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -71,7 +87,9 @@ module SoftLayer
     end
     
     ##
-    # Returns local disk flag associated with virtual disk image
+    # Retrieve local disk flag associated with virtual disk image
+    # :call-seq:
+    #   local_disk(force_update=false)
     sl_dynamic_attr :local_disk do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -84,8 +102,10 @@ module SoftLayer
     end
 
     ##
-    # Whether this disk image is meant for storage of custom user data
-    # supplied with a Cloud Computing Instance order.
+    # Retrieve metadata as to whether this disk image is meant for 
+    # storage of custom user data supplied with a Cloud Computing Instance order.
+    # :call-seq:
+    #   metadata(force_update=false)
     sl_dynamic_attr :metadata do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -98,7 +118,9 @@ module SoftLayer
     end
 
     ##
-    # References to the software that resides on a disk image.
+    # Retrieve the references to the software that resides on a disk image.
+    # :call-seq:
+    #   software(force_update=false)
     sl_dynamic_attr :software do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -112,7 +134,9 @@ module SoftLayer
     end
 
     ##
-    # The original disk image that the current disk image was cloned from.
+    # Retrieve the original disk image that the current disk image was cloned from.
+    # :call-seq:
+    #   source_disk_image(force_update=false)
     sl_dynamic_attr :source_disk_image do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -126,7 +150,9 @@ module SoftLayer
     end
 
     ##
-    # A brief description of a virtual disk image type's function.
+    # Retrieve a brief description of a virtual disk image type's function.
+    # :call-seq:
+    #   type_description(force_update=false)
     sl_dynamic_attr :type_description do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -140,7 +166,9 @@ module SoftLayer
     end
 
     ##
-    # A virtual disk image type's name.
+    # Retrieve a virtual disk image type's name.
+    # :call-seq:
+    #   type_name(force_update=false)
     sl_dynamic_attr :type_name do |resource|
       resource.should_update? do
         #only retrieved once per instance

data/lib/softlayer/VirtualServer.rb

@@ -16,45 +16,87 @@ module SoftLayer
     include ::SoftLayer::DynamicAttribute
 
     ##
-    # :attr_reader:
-    # A count of the nubmer of virtual processing cores allocated
+    # :attr_reader: cores
+    # A count of the number of virtual processing cores allocated
     # to the server.
     sl_attr :cores, 'maxCpu'
 
+    ##
+    # :attr_reader: provisioned_at
+    # The date the Virtual Server was provisioned.  This attribute can be
+    # nil if the SoftLayer system has not yet finished provisioning the
+    # server (consequently this attribute is used by the #wait_until_ready
+    # method to determine when a server has been provisioned)
+    sl_attr :provisioned_at, 'provisionDate'
+
     ##
     # :attr_reader:
     # The date the Virtual Server was provisioned.  This attribute can be
     # nil if the SoftLayer system has not yet finished provisioning the
     # server (consequently this attribute is used by the #wait_until_ready
     # method to determine when a server has been provisioned)
+    #
+    # DEPRECATION WARNING: This attribute is deprecated in favor of provisioned_at
+    # and will be removed in the next major release.
     sl_attr :provisionDate
 
+    ##
+    # :attr_reader: active_transaction
+    # The active transaction (if any) for this virtual server. Transactions
+    # are used to make configuration changes to the server and only one
+    # transaction can be active at a time.
+    sl_attr :active_transaction, 'activeTransaction'
+
     ##
     # :attr_reader:
     # The active transaction (if any) for this virtual server. Transactions
     # are used to make configuration changes to the server and only one
     # transaction can be active at a time.
+    #
+    # DEPRECATION WARNING: This attribute is deprecated in favor of active_transaction
+    # and will be removed in the next major release.
     sl_attr :activeTransaction
 
+    ##
+    # :attr_reader: block_devices
+    # Storage devices attached to the server. Storage may be local
+    # to the host running the Virtual Server, or it may be located
+    # on the SAN
+    sl_attr :block_devices, 'blockDevices'
+
     ##
     # :attr_reader:
     # Storage devices attached to the server. Storage may be local
     # to the host running the Virtual Server, or it may be located
     # on the SAN
+    #
+    # DEPRECATION WARNING: This attribute is deprecated in favor of block_devices
+    # and will be removed in the next major release.
     sl_attr :blockDevices
 
+    ##
+    # :attr_reader: last_operating_system_reload
+    # The last operating system reload transaction that was
+    # run for this server. #wait_until_ready compares the
+    # ID of this transaction to the ID of the active transaction
+    # to determine if an OS reload is in progress.
+    sl_attr :last_operating_system_reload, 'lastOperatingSystemReload'
+
     ##
     # :attr_reader:
     # The last operating system reload transaction that was
     # run for this server. #wait_until_ready compares the
     # ID of this transaction to the ID of the active transaction
     # to determine if an OS reload is in progress.
+    #
+    # DEPRECATION WARNING: This attribute is deprecated in favor of last_operating_system_reload
+    # and will be removed in the next major release.
     sl_attr :lastOperatingSystemReload
 
     ##
-    # A virtual server can find out about items that are
-    # available for upgrades.
-    #
+    # Retrieve information about items that are available for upgrades.
+    # :call-seq:
+    #   upgrade_options(force_update=false)
     sl_dynamic_attr :upgrade_options do |resource|
       resource.should_update? do
         @upgrade_options == nil
@@ -130,7 +172,7 @@ module SoftLayer
         has_os_reload = has_sl_property? :lastOperatingSystemReload
         has_active_transaction = has_sl_property? :activeTransaction
 
-        reloading_os = has_active_transaction && has_os_reload && (self.lastOperatingSystemReload['id'] == self.activeTransaction['id'])
+        reloading_os = has_active_transaction && has_os_reload && (self.last_operating_system_reload['id'] == self.active_transaction['id'])
         provisioned = has_sl_property?(:provisionDate) && ! self['provisionDate'].empty?
 
         # a server is ready when it is provisioned, not reloading the OS
@@ -148,7 +190,7 @@ module SoftLayer
     end
 
     ##
-    # Retrive the virtual server with the given server ID from the API
+    # Retrieve the virtual server with the given server ID from the API
     #
     # The options parameter should contain:
     #
@@ -187,22 +229,23 @@ module SoftLayer
     # If no client can be found the routine will raise an error.
     #
     # You may filter the list returned by adding options:
-    # * <b>+:hourly+</b> (boolean) - Include servers billed hourly in the list
-    # * <b>+:monthly+</b> (boolean) - Include servers billed monthly in the list
-    # * <b>+:tags+</b> (array) - an array of strings representing tags to search for on the instances
-    # * <b>+:cpus+</b> (int) - return virtual servers with the given number of (virtual) CPUs
-    # * <b>+:memory+</b> (int) - return servers with at least the given amount of memory (in MB. e.g. 4096 = 4GB)
-    # * <b>+:hostname+</b> (string) - return servers whose hostnames match the query string given (see ObjectFilter::query_to_filter_operation)
-    # * <b>+:domain+</b> (string) - filter servers to those whose domain matches the query string given (see ObjectFilter::query_to_filter_operation)
-    # * <b>+:local_disk+</b> (boolean) - include servers that do, or do not, have local disk storage
-    # * <b>+:datacenter+</b> (string) - find servers whose short data center name (e.g. dal05, sjc01) matches the query string given (see ObjectFilter::query_to_filter_operation)
-    # * <b>+:nic_speed+</b> (int) - include servers with the given nic speed (in Mbps, usually 10, 100, or 1000)
-    # * <b>+:public_ip+</b> (string) - return servers whose public IP address matches the query string given (see ObjectFilter::query_to_filter_operation)
-    # * <b>+:private_ip+</b> (string) - same as :public_ip, but for private IP addresses
+    # * <b>+:hourly+</b>     (boolean)      - Include servers billed hourly in the list
+    # * <b>+:monthly+</b>    (boolean)      - Include servers billed monthly in the list
+    # * <b>+:tags+</b>       (string/array) - an array of strings representing tags to search for on the instances
+    # * <b>+:cpus+</b>       (int/array)    - return virtual servers with the given number of (virtual) CPUs
+    # * <b>+:memory+</b>     (int/array)    - return servers with at least the given amount of memory (in MB. e.g. 4096 = 4GB)
+    # * <b>+:hostname+</b>   (string/array) - return servers whose hostnames match the query string given (see ObjectFilter::query_to_filter_operation)
+    # * <b>+:domain+</b>     (string/array) - filter servers to those whose domain matches the query string given (see ObjectFilter::query_to_filter_operation)
+    # * <b>+:local_disk+</b> (boolean)      - include servers that do, or do not, have local disk storage
+    # * <b>+:datacenter+</b> (string/array) - find servers whose short data center name (e.g. dal05, sjc01) matches the query string given (see ObjectFilter::query_to_filter_operation)
+    # * <b>+:nic_speed+</b>  (int/array)    - include servers with the given nic speed (in Mbps, usually 10, 100, or 1000)
+    # * <b>+:public_ip+</b>  (string/array) - return servers whose public IP address matches the query string given (see ObjectFilter::query_to_filter_operation)
+    # * <b>+:private_ip+</b> (string/array) - same as :public_ip, but for private IP addresses
     #
     # Additionally you may provide options related to the request itself:
-    # * <b>+:object_mask+</b> (string) - A object mask of properties, in addition to the default properties, that you wish to retrieve for the servers
-    # * <b>+:result_limit+</b> (hash with :limit, and :offset keys) - Limit the scope of results returned.
+    # * <b>*:object_filter*</b>                       (ObjectFilter) - Include servers that match the criteria of this object filter
+    # * <b>+:object_mask+</b>                         (string)       - A object mask of properties, in addition to the default properties, that you wish to retrieve for the servers
+    # * <b>+:result_limit+</b>  (hash with :limit, and :offset keys) - Limit the scope of results returned.
     #
     def self.find_servers(options_hash = {})
       softlayer_client = options_hash[:client] || Client.default_client
@@ -216,15 +259,16 @@ module SoftLayer
       end
 
       option_to_filter_path = {
-        :cores => "virtualGuests.maxCpu",
-        :memory => "virtualGuests.maxMemory",
-        :hostname => "virtualGuests.hostname",
-        :domain => "virtualGuests.domain",
+        :cores      => "virtualGuests.maxCpu",
+        :memory     => "virtualGuests.maxMemory",
+        :hostname   => "virtualGuests.hostname",
+        :domain     => "virtualGuests.domain",
         :local_disk => "virtualGuests.localDiskFlag",
         :datacenter => "virtualGuests.datacenter.name",
-        :nic_speed => "virtualGuests.networkComponents.maxSpeed",
-        :public_ip => "virtualGuests.primaryIpAddress",
-        :private_ip => "virtualGuests.primaryBackendIpAddress"
+        :nic_speed  => "virtualGuests.networkComponents.maxSpeed",
+        :public_ip  => "virtualGuests.primaryIpAddress",
+        :private_ip => "virtualGuests.primaryBackendIpAddress",
+        :tags       => "virtualGuests.tagReferences.tag.name"
       }
 
       if options_hash.has_key?(:local_disk) then
@@ -238,32 +282,15 @@ module SoftLayer
         object_filter.modify { |filter| filter.accept(filter_path).when_it is(options_hash[option])} if options_hash[option]
       end
 
-      # Tags get a much more complex object filter operation so we handle them separately
-      if options_hash.has_key?(:tags)
-        object_filter.set_criteria_for_key_path("virtualGuests.tagReferences.tag.name", {
-          'operation' => 'in',
-          'options' => [{
-            'name' => 'data',
-            'value' => options_hash[:tags].collect{ |tag_value| tag_value.to_s }
-            }]
-          } );
-      end
-
       required_properties_mask = 'mask.id'
 
       account_service = softlayer_client[:Account]
       account_service = account_service.object_filter(object_filter) unless object_filter.empty?
       account_service = account_service.object_mask(default_object_mask.to_sl_object_mask)
+      account_service = account_service.object_mask(options_hash[:object_mask]) if options_hash[:object_mask]
 
-      if options_hash.has_key? :object_mask
-        account_service = account_service.object_mask(options_hash[:object_mask])
-      end
-
-      if options_hash.has_key?(:result_limit)
-        offset = options[:result_limit][:offset]
-        limit = options[:result_limit][:limit]
-
-        account_service = account_service.result_limit(offset, limit)
+      if options_hash[:result_limit] && options_hash[:result_limit][:offset] && options_hash[:result_limit][:limit]
+        account_service = account_service.result_limit(options_hash[:result_limit][:offset], options_hash[:result_limit][:limit])
       end
 
       case