softlayer_api 3.0.2 → 3.1.0

data/lib/softlayer/ObjectMaskParser.rb

@@ -138,4 +138,4 @@ module SoftLayer
     end
 
   end
-end # Module SoftLaye
+end # Module SoftLayer

data/lib/softlayer/ProductItemCategory.rb

@@ -10,9 +10,14 @@ module SoftLayer
   # the product order is the price_id, the rest of the information is provided
   # to make the object friendly to humans who may be searching for the
   # meaning of a given price_id.
-  class ProductConfigurationOption < Struct.new(:capacity, :capacityRestrictionMaximum, :capacityRestrictionMinimum,
-     :capacityRestrictionType, :description, :hourlyRecurringFee, :laborFee, :oneTimeFee, :price_id, :recurringFee,
-     :requiredCoreCount, :setupFee, :units)
+  #
+  # DEPRECATION WARNING: The following configuration option keys have been deprecated and
+  # will be removed with the next major version: capacityRestrictionMaximum, capacityRestrictionMinimum,
+  # capacityRestrictionType, hourlyRecurringFee, laborFee, oneTimeFee, recurringFee, requiredCoreCount, setupFee
+  class ProductConfigurationOption < Struct.new(:capacity, :capacityRestrictionMaximum, :capicity_restriction_maximum,
+     :capacityRestrictionMinimum, :capacity_restriction_minimum, :capacityRestrictionType, :capacity_restriction_type,
+     :description, :hourlyRecurringFee, :hourly_recurring_fee, :laborFee, :labor_fee, :oneTimeFee, :one_time_fee,
+     :price_id, :recurringFee, :recurring_fee, :requiredCoreCount, :required_core_count, :setupFee, :setup_fee, :units)
     # Is it evil, or just incongruous to give methods to a struct?
 
     def initialize(package_item_data, price_item_data)
@@ -20,6 +25,7 @@ module SoftLayer
       self.description = package_item_data['description']
       self.units       = package_item_data['units']
 
+      #DEPRECATION WARNING: All these are deprecated and will be removed with the next major version, pleace use keys below
       self.capacityRestrictionMaximum = price_item_data['capacityRestrictionMaximum'] ? price_item_data['capacityRestrictionMaximum'] : nil
       self.capacityRestrictionMinimum = price_item_data['capacityRestrictionMinimum'] ? price_item_data['capacityRestrictionMinimum'] : nil
       self.capacityRestrictionType    = price_item_data['capacityRestrictionType']    ? price_item_data['capacityRestrictionType']    : nil
@@ -30,9 +36,19 @@ module SoftLayer
       self.recurringFee               = price_item_data['recurringFee']               ? price_item_data['recurringFee'].to_f          : 0.0
       self.requiredCoreCount          = price_item_data['requiredCoreCount']          ? price_item_data['requiredCoreCount']          : nil
       self.setupFee                   = price_item_data['setupFee']                   ? price_item_data['setupFee'].to_f              : 0.0
+
+      self.capacity_restriction_maximum = price_item_data['capacityRestrictionMaximum'] ? price_item_data['capacityRestrictionMaximum'] : nil
+      self.capacity_restriction_minimum = price_item_data['capacityRestrictionMinimum'] ? price_item_data['capacityRestrictionMinimum'] : nil
+      self.capacity_restriction_type    = price_item_data['capacityRestrictionType']    ? price_item_data['capacityRestrictionType']    : nil
+      self.hourly_recurring_fee         = price_item_data['hourlyRecurringFee']         ? price_item_data['hourlyRecurringFee'].to_f    : 0.0
+      self.labor_fee                    = price_item_data['laborFee']                   ? price_item_data['laborFee'].to_f              : 0.0
+      self.one_time_fee                 = price_item_data['oneTimeFee']                 ? price_item_data['oneTimeFee'].to_f            : 0.0
+      self.recurring_fee                = price_item_data['recurringFee']               ? price_item_data['recurringFee'].to_f          : 0.0
+      self.required_core_count          = price_item_data['requiredCoreCount']          ? price_item_data['requiredCoreCount']          : nil
+      self.setup_fee                    = price_item_data['setupFee']                   ? price_item_data['setupFee'].to_f              : 0.0
     end
 
-    # returns true if the configurtion option has no fees associated with it.
+    # returns true if the configuration option has no fees associated with it.
     def free?
       self.setupFee == 0 && self.laborFee == 0 && self.oneTimeFee == 0 && self.recurringFee == 0 && self.hourlyRecurringFee == 0
     end
@@ -46,15 +62,24 @@ module SoftLayer
   # of a ProductPackage object. There should not be a need to create instances
   # of this class directly.
   #
-  # This class rougly represents entities in the +SoftLayer_Product_Item_Category+
+  # This class roughly represents entities in the +SoftLayer_Product_Item_Category+
   # service.
   class ProductItemCategory < ModelBase
     include ::SoftLayer::DynamicAttribute
 
+    ##
+    # :attr_reader: category_code
+    # The categoryCode is a primary identifier for a particular
+    # category.  It is a string like 'os' or 'ram'
+    sl_attr :category_code, 'categoryCode'
+
     ##
     # :attr_reader:
     # The categoryCode is a primary identifier for a particular
     # category.  It is a string like 'os' or 'ram'
+    #
+    # DEPRECATION WARNING: This attribute is deprecated in favor of category_code
+    # and will be removed in the next major release.
     sl_attr :categoryCode
 
     ##
@@ -62,6 +87,10 @@ module SoftLayer
     # The name of a category is a friendly, readable string
     sl_attr :name
 
+    ##
+    # Retrieve the product item configuration information
+    # :call-seq:
+    #   configuration_options(force_update=false)
     sl_dynamic_attr :configuration_options do |config_opts|
       config_opts.should_update? do
         # only retrieved once per instance

data/lib/softlayer/ProductPackage.rb

@@ -38,16 +38,19 @@ module SoftLayer
     include ::SoftLayer::DynamicAttribute
 
     ##
+    # :attr_reader:
     # A friendly, readable name for the package
     sl_attr :name
 
     ##
+    # :attr_reader: available_locations
     # The list of locations where this product package is available.
     sl_attr :available_locations, 'availableLocations'
 
     ##
-    # The set of product categories needed to make an order for this product package.
-    #
+    # Retrieve the set of product categories needed to make an order for this product package.
+    # :call-seq:
+    #   configuration(force_update=false)
     sl_dynamic_attr :configuration do |resource|
       resource.should_update? do
         # only retrieved once per instance
@@ -96,8 +99,9 @@ module SoftLayer
     end # configuration
 
     ##
-    # The full set of product categories contained in the package
-    #
+    # Retrieve the full set of product categories contained in the package
+    # :call-seq:
+    #   categories(force_update=false)
     sl_dynamic_attr :categories do |resource|
       resource.should_update? do
         @categories == nil
@@ -109,7 +113,7 @@ module SoftLayer
         # that are required)
         self.configuration
 
-        # return the value constructed by the configuraiton
+        # return the value constructed by the configuration
         @categories
       end
     end
@@ -123,7 +127,7 @@ module SoftLayer
     ##
     # Returns the product category with the given category code (or nil if one cannot be found)
     def category(category_code)
-      categories.find { |category| category.categoryCode == category_code }
+      categories.find { |category| category.category_code == category_code }
     end
 
     ##
@@ -155,7 +159,7 @@ module SoftLayer
 
     ##
     # Requests a list (array) of ProductPackages whose key names match the
-    # one passed in.
+    # one passed in. key_name may be a string or array.
     #
     def self.packages_with_key_name(key_name, client = nil)
       softlayer_client = client || Client.default_client

data/lib/softlayer/Server.rb

@@ -28,9 +28,17 @@ module SoftLayer
     # The domain name SoftLayer has stored for the server
     sl_attr :domain
 
+    ##
+    # :attr_reader: fqdn
+    # A convenience attribute that combines the hostname and domain name
+    sl_attr :fqdn, 'fullyQualifiedDomainName'
+
     ##
     # :attr_reader:
     # A convenience attribute that combines the hostname and domain name
+    #
+    # DEPRECATION WARNING: This attribute is deprecated in favor of fqdn
+    # and will be removed in the next major release.
     sl_attr :fullyQualifiedDomainName
 
     ##
@@ -39,12 +47,12 @@ module SoftLayer
     sl_attr :datacenter
 
     ##
-    # :attr_reader:
+    # :attr_reader: primary_public_ip
     # The IP address of the primary public interface for the server
     sl_attr :primary_public_ip, "primaryIpAddress"
 
     ##
-    # :attr_reader:
+    # :attr_reader: primary_private_ip
     # The IP address of the primary private interface for the server
     sl_attr :primary_private_ip, "primaryBackendIpAddress"
 
@@ -53,6 +61,69 @@ module SoftLayer
     # Notes about these server (for use by the customer)
     sl_attr :notes
 
+    ##
+    # The maximum network monitor query/response levels currently supported by the server
+    # :call-seq:
+    #   network_monitor_levels(force_update=false)
+    sl_dynamic_attr :network_monitor_levels do |resource|
+      resource.should_update? do
+        @network_monitor_levels == nil
+      end
+
+      resource.to_update do
+        NetworkMonitorLevels.new(self.service.getAvailableMonitoring)
+      end
+    end
+
+    ##
+    # A lsst of configured network monitors.
+    # :call-seq:
+    #   network_monitors(force_update=false)
+    sl_dynamic_attr :network_monitors do |resource|
+      resource.should_update? do
+        @network_monitors == nil
+      end
+
+      resource.to_update do
+        network_monitors_data = self.service.object_mask(NetworkMonitor.default_object_mask).getNetworkMonitors
+
+        network_monitors_data.map! do |network_monitor|
+          NetworkMonitor.new(softlayer_client, network_monitor) unless network_monitor.empty?
+        end
+
+        network_monitors_data.compact
+      end
+    end
+
+    ##
+    # :attr_reader:
+    # The list of user customers notified on monitoring failures
+    # :call-seq:
+    #   notified_network_monitor_users(force_update=false)
+    sl_dynamic_attr :notified_network_monitor_users do |resource|
+      resource.should_update? do
+        #only retrieved once per instance
+        @notified_network_monitor_users == nil
+      end
+
+      resource.to_update do
+        notified_network_monitor_users_data = self.service.object_mask("mask[userId]").getMonitoringUserNotification
+
+        notified_network_monitor_users = notified_network_monitor_users_data.collect do |notified_network_monitor_user|
+          user_customer_service = softlayer_client[:User_Customer].object_with_id(notified_network_monitor_user['userId'])
+          user_customer_data    = user_customer_service.object_mask(UserCustomer.default_object_mask).getObject
+
+          UserCustomer.new(softlayer_client, user_customer_data) unless user_customer_data.empty?
+        end
+
+        notified_network_monitor_users.compact
+      end
+    end
+
+    ##
+    # Retrieve the primary network component
+    # :call-seq:
+    #   primary_network_component(force_update=false)
     sl_dynamic_attr :primary_network_component do |primary_component|
       primary_component.should_update? do
         return @primary_network_component == nil
@@ -65,8 +136,9 @@ module SoftLayer
     end
 
     ##
-    # :attr_reader:
-    # All software installed on current server
+    # Retrieve all software installed on current server
+    # :call-seq:
+    #   software(force_update=false)
     sl_dynamic_attr :software do |software|
       software.should_update? do
         @software == nil
@@ -97,7 +169,7 @@ module SoftLayer
     # Reboot the server.  This action is taken immediately.
     # Servers can be rebooted in three different ways:
     # :default_reboot - (Try soft, then hard) Attempts to reboot a server using the :os_reboot technique then, if that is not successful, tries the :power_cycle method
-    # :os_reboot - (aka. soft rebot) instructs the server's host operating system to reboot
+    # :os_reboot - (aka. soft reboot) instructs the server's host operating system to reboot
     # :power_cycle - (aka. hard reboot) The actual (for hardware) or metaphorical (for virtual servers) equivalent to pulling the plug on the server then plugging it back in.
     def reboot!(reboot_technique = :default_reboot)
       case reboot_technique

data/lib/softlayer/ServerFirewall.rb

@@ -12,10 +12,10 @@ module SoftLayer
   #
   # This is also called a "Shared Firewall" in some documentation.
   #
-  # Instances of this class rougly correspond to instances of the
+  # Instances of this class roughly correspond to instances of the
   # SoftLayer_Network_Component_Firewall service entity.
   #
-	class ServerFirewall < SoftLayer::ModelBase
+  class ServerFirewall < SoftLayer::ModelBase
     include ::SoftLayer::DynamicAttribute
 
     ##
@@ -27,11 +27,12 @@ module SoftLayer
     sl_attr :status
 
     ##
-    # :attr_reader:
-    # The firewall rules assigned to this firewall. These rules will
+    # Retrieve the firewall rules assigned to this firewall. These rules will
     # be read from the network API every time you ask for the value
     # of this property. To change the rules on the server use the
     # asymmetric method change_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.
@@ -56,10 +57,10 @@ module SoftLayer
     end
 
     ##
-    # :attr_reader:
-    # The server that this firewall is attached to. The result may be
+    # Retrieve the server that this firewall is attached to. The result may be
     # either a bare metal or virtual server.
-    #
+    # :call-seq:
+    #   protected_server(force_update=false)
     sl_dynamic_attr :protected_server do |protected_server|
       protected_server.should_update? do
         @protected_server == nil
@@ -129,7 +130,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 it's rules to incomming traffic.
+    # order the firewall applies it's rules to incoming traffic.
     #
     # *NOTE!* Changes to the rules are not applied immediately
     # on the server side. Instead, they are enqueued by the
@@ -215,11 +216,11 @@ module SoftLayer
       end
 
       bare_metal_firewalls = bare_metal_firewalls_data.collect { |bare_metal_firewall_data|
-        self.new(softlayer_client, bare_metal_firewall_data)
+        ServerFirewall.new(softlayer_client, bare_metal_firewall_data)
       }
 
       virtual_server_firewalls = virtual_firewalls_data.collect { |virtual_firewall_data|
-        self.new(softlayer_client, virtual_firewall_data)
+        ServerFirewall.new(softlayer_client, virtual_firewall_data)
       }
 
       return bare_metal_firewalls + virtual_server_firewalls
@@ -260,4 +261,4 @@ module SoftLayer
       ['orderValue','action','destinationIpAddress','destinationIpSubnetMask',"protocol","destinationPortRangeStart","destinationPortRangeEnd",'sourceIpAddress',"sourceIpSubnetMask","version"]
     end
   end # ServerFirewall class
-end # SoftLayer module
+end # SoftLayer module

data/lib/softlayer/Service.rb

@@ -70,7 +70,7 @@ module SoftLayer
   #     => {... lots of information here representing the list of open tickets ...}
   #
   class Service
-    # The name of the service that this object calls. Cannot be emtpy or nil.
+    # The name of the service that this object calls. Cannot be empty or nil.
     attr_reader :service_name
     attr_reader :client
 

data/lib/softlayer/Software.rb

@@ -16,17 +16,19 @@ module SoftLayer
     include ::SoftLayer::DynamicAttribute
 
     ##
-    # :attr_reader:
+    # :attr_reader: manufacturer_activation_code
     # The manufacturer code that is needed to activate a license.
     sl_attr :manufacturer_activation_code, 'manufacturerActivationCode'
 
     ##
-    # :attr_reader:
+    # :attr_reader: manufacturer_license_key
     # A license key for this specific installation of software, if it is needed.
     sl_attr :manufacturer_license_key,     'manufacturerLicenseInstance'
 
     ##
-    # The manufacturer, name and version of a piece of software.
+    # Retrieve the manufacturer, name and version of a piece of software.
+    # :call-seq:
+    #   description(force_update=false)
     sl_dynamic_attr :description do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -40,7 +42,9 @@ module SoftLayer
     end
 
     ##
-    # The name of this specific piece of software. 
+    # Retrieve the name of this specific piece of software. 
+    # :call-seq:
+    #   name(force_update=false)
     sl_dynamic_attr :name do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -54,7 +58,9 @@ module SoftLayer
     end
 
     ##
-    # Username/Password pairs used for access to this Software Installation.
+    # Retrieve the Username/Password pairs used for access to this Software Installation.
+    # :call-seq:
+    #   passwords(force_update=false)
     sl_dynamic_attr :passwords do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -110,7 +116,7 @@ module SoftLayer
     end
 
     ##
-    # Returns whether or not one of the Software Passowrd instances pertains to the specified user
+    # Returns whether or not one of the Software Password instances pertains to the specified user
     #
     def has_user_password?(username)
       self.passwords.map { |sw_pw| sw_pw.username }.include?(username)
@@ -127,14 +133,14 @@ module SoftLayer
     # If no client can be found the routine will raise an error.
     #
     # You may filter the list returned by adding options:
-    # * <b>+:datacenter+</b>    (string) - Include software from hardware matching this datacenter
-    # * <b>+:description+</b>   (string) - Include software that matches this description
-    # * <b>+:domain+</b>        (string) - Include software from hardware matching this domain
-    # * <b>+:hardware_type+</b> (string) - Include software from hardware matching this hardware type
-    # * <b>+:hostname+</b>      (string) - Include software from hardware matching this hostname
-    # * <b>+:manufacturer+</b>  (string) - Include software that matches this manufacturer
-    # * <b>+:name+</b>          (string) - Include software that matches this name
-    # * <b>+:username+</b>      (string) - Include software that has software password matching this username
+    # * <b>+:datacenter+</b>    (string/array) - Include software from hardware matching this datacenter
+    # * <b>+:description+</b>   (string/array) - Include software that matches this description
+    # * <b>+:domain+</b>        (string/array) - Include software from hardware matching this domain
+    # * <b>+:hardware_type+</b> (symbol)       - Include software from hardware matching this hardware type
+    # * <b>+:hostname+</b>      (string/array) - Include software from hardware matching this hostname
+    # * <b>+:manufacturer+</b>  (string/array) - Include software that matches this manufacturer
+    # * <b>+:name+</b>          (string/array) - Include software that matches this name
+    # * <b>+:username+</b>      (string/array) - Include software that has software password matching this username
     #
     # You may use the following properties to provide hardware or software object filter instances:
     # * <b>+:hardware_object_filter+</b> (ObjectFilter) - Include software from hardware that matches the criteria of this object filter
@@ -167,10 +173,12 @@ module SoftLayer
       }
 
       option_to_filter_path = {
-        :datacenter     => lambda { |hardware_type| return [ filter_label[hardware_type], '.datacenter.name' ].join        },
-        :domain         => lambda { |hardware_type| return [ filter_label[hardware_type], '.domain' ].join                 },
-        :hostname       => lambda { |hardware_type| return [ filter_label[hardware_type], '.hostname' ].join               },
-        :tags           => lambda { |hardware_type| return [ filter_label[hardware_type], '.tagReferences.tag.name' ].join },
+        :hardware       => {
+          :datacenter     => lambda { |hardware_type| return [ filter_label[hardware_type], '.datacenter.name' ].join        },
+          :domain         => lambda { |hardware_type| return [ filter_label[hardware_type], '.domain' ].join                 },
+          :hostname       => lambda { |hardware_type| return [ filter_label[hardware_type], '.hostname' ].join               },
+          :tags           => lambda { |hardware_type| return [ filter_label[hardware_type], '.tagReferences.tag.name' ].join }
+        },
         :software       => {
           :description  => "softwareComponents.softwareDescription.longDescription",
           :manufacturer => "softwareComponents.softwareDescription.manufacturer",
@@ -185,23 +193,12 @@ module SoftLayer
         end
       end
 
-      [ :datacenter, :domain, :hostname ].each do |option|
+      option_to_filter_path[:hardware].keys.each do |option|
         if options_hash[option]
-          hardware_object_filter.modify { |filter| filter.accept(option_to_filter_path[option].call(options_hash[:hardware_type] || :hardware)).when_it is(options_hash[option]) }
+          hardware_object_filter.modify { |filter| filter.accept(option_to_filter_path[:hardware][option].call(options_hash[:hardware_type] || :hardware)).when_it is(options_hash[option]) }
         end
       end
 
-      if options_hash[:tags]
-        hardware_object_filter.set_criteria_for_key_path(option_to_filter_path[:tags].call(options_hash[:hardware_type] || :hardware),
-                                                         {
-                                                           'operation' => 'in',
-                                                           'options' => [{
-                                                                           'name' => 'data',
-                                                                           'value' => options_hash[:tags].collect{ |tag_value| tag_value.to_s }
-                                                                         }]
-                                                         })
-      end
-
       option_to_filter_path[:software].each do |option, filter_path|
         software_object_filter.modify { |filter| filter.accept(filter_path).when_it is(options_hash[option]) } if options_hash[option]
       end
@@ -245,13 +242,13 @@ module SoftLayer
     # If no client can be found the routine will raise an error.
     #
     # You may filter the list returned by adding options:
-    # * <b>+:datacenter+</b>    (string) - Include software from virtual servers matching this datacenter
-    # * <b>+:description+</b>   (string) - Include software that matches this description
-    # * <b>+:domain+</b>        (string) - Include software from virtual servers matching this domain
-    # * <b>+:hostname+</b>      (string) - Include software from virtual servers matching this hostname
-    # * <b>+:manufacturer+</b>  (string) - Include software that matches this manufacturer
-    # * <b>+:name+</b>          (string) - Include software that matches this name
-    # * <b>+:username+</b>      (string) - Include software that has software password matching this username
+    # * <b>+:datacenter+</b>    (string/array) - Include software from virtual servers matching this datacenter
+    # * <b>+:description+</b>   (string/array) - Include software that matches this description
+    # * <b>+:domain+</b>        (string/array) - Include software from virtual servers matching this domain
+    # * <b>+:hostname+</b>      (string/array) - Include software from virtual servers matching this hostname
+    # * <b>+:manufacturer+</b>  (string/array) - Include software that matches this manufacturer
+    # * <b>+:name+</b>          (string/array) - Include software that matches this name
+    # * <b>+:username+</b>      (string/array) - Include software that has software password matching this username
     #
     # You may use the following properties to provide virtual server or software object filter instances:
     # * <b>+:virtual_server_object_filter+</b> (ObjectFilter) - Include software from virtual servers that matches the criteria of this object filter
@@ -291,19 +288,7 @@ module SoftLayer
         }
       }
 
-      if options_hash[:tags]
-        virtual_server_object_filter.set_criteria_for_key_path(option_to_filter_path[:virtual_server][:tags],
-                                                               {
-                                                                 'operation' => 'in',
-                                                                 'options' => [{
-                                                                                 'name' => 'data',
-                                                                                 'value' => options_hash[:tags].collect{ |tag_value| tag_value.to_s }
-                                                                               }]
-                                                               })
-      end
-
       option_to_filter_path[:virtual_server].each do |option, filter_path|
-        next if option == :tags
         virtual_server_object_filter.modify { |filter| filter.accept(filter_path).when_it is(options_hash[option]) } if options_hash[option]
       end