softlayer_api 3.0.2 → 3.1.0

data/lib/softlayer/NetworkService.rb

@@ -21,22 +21,24 @@ module SoftLayer
     sl_attr :name
 
     ##
-    # :attr_reader:
+    # :attr_reader: private_ip
     # The backend IP address for this resource
     sl_attr :private_ip,   'backendIpAddress'
 
     ##
-    # :attr_reader:
+    # :attr_reader: public_ip
     # The frontend IP address for this resource
     sl_attr :public_ip,    'frontendIpAddress'
 
     ##
-    # :attr_reader:
+    # :attr_reader: ssh_username
     # The ssh username of for this resource
     sl_attr :ssh_username, 'sshUsername'
 
     ##
-    # Returns the datacenter that this network service resource is available in
+    # Retrieve the datacenter that this network service resource is available in
+    # :call-seq:
+    #   datacenter(force_update=false)
     sl_dynamic_attr :datacenter do |resource|
       resource.should_update? do
         #only retrieved once per instance

data/lib/softlayer/NetworkStorage.rb

@@ -16,13 +16,20 @@ module SoftLayer
     include ::SoftLayer::DynamicAttribute
 
     ##
-    # :attr_reader:
+    # :attr_reader: capacity
     # A Storage account's capacity, measured in gigabytes.
     sl_attr :capacity,   'capacityGb'
 
     ##
-    # :attr_reader:
+    # :attr_reader: created_at
+    # The date a network storage volume was created.
+    sl_attr :created_at, 'createDate'
+
+    ##
+    # :attr_reader: created
     # The date a network storage volume 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'
 
     ##
@@ -38,12 +45,12 @@ module SoftLayer
     sl_attr :password
 
     ##
-    # :attr_reader:
+    # :attr_reader: type
     # A Storage account's type.
     sl_attr :type,       'nasType'
 
     ##
-    # :attr_reader:
+    # :attr_reader: upgradable
     # This flag indicates whether this storage type is upgradable or not.
     sl_attr :upgradable, 'upgradableFlag'
 
@@ -55,7 +62,9 @@ module SoftLayer
     sl_attr :username
 
     ##
-    # Other usernames and passwords associated with a Storage volume.
+    # Retrieve other usernames and passwords associated with a Storage volume.
+    # :call-seq:
+    #   account_password(force_update=false)
     sl_dynamic_attr :account_password do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -70,6 +79,8 @@ module SoftLayer
 
     ##
     # A Storage volume's access credentials.
+    # :call-seq:
+    #   credentials(force_update=false)
     sl_dynamic_attr :credentials do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -83,6 +94,8 @@ module SoftLayer
 
     ##
     # The network resource a Storage service is connected to.
+    # :call-seq:
+    #   service_resource(force_update=false)
     sl_dynamic_attr :service_resource do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -183,13 +196,20 @@ 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 network storage associated with servers matching this datacenter
-    # * <b>+:domain+</b>                      (string) - Include network storage associated with servers matching this domain
-    # * <b>+:hostname+</b>                    (string) - Include network storage associated with servers matching this hostname
-    # * <b>+:network_storage_server_type+</b> (string) - Include network storage associated with this server type
-    # * <b>+:network_storage_type+</b>        (string) - Include network storage from devices of this storage type
-    # * <b>+:service+</b>                     (string) - Include network storage from devices with this service fqdn
-    # * <b>+:tags+</b>                        (Array)  - Include network storage associated with servers matching these tags
+    # * <b>+:datacenter+</b>                  (string/array) - Include network storage associated with servers matching this datacenter
+    # * <b>+:domain+</b>                      (string/array) - Include network storage associated with servers matching this domain
+    # * <b>+:hostname+</b>                    (string/array) - Include network storage associated with servers matching this hostname
+    # * <b>+:network_storage_server_type+</b> (symbol)       - Include network storage associated with this server type
+    # * <b>+:network_storage_type+</b>        (symbol)       - Include network storage from devices of this storage type
+    # * <b>+:service+</b>                     (string/array) - Include network storage from devices with this service fqdn
+    # * <b>+:tags+</b>                        (string/array) - Include network storage associated with servers matching these tags
+    #
+    # Additionally you may provide options related to the request itself:
+    # * <b>*:network_storage_object_mask*</b>   (string)             - The object mask of properties you wish to receive for the items returned.
+    #                                                                  If not provided, the result will use the default object mask
+    # * <b>*:network_storage_object_filter*</b> (ObjectFilter)       - Include network storage credentials from network storage that matches the
+    #                                                                  criteria of this object filter
+    # * <b>+:result_limit+</b>  (hash with :limit, and :offset keys) - Limit the scope of results returned.
     #
     def self.find_network_storage(options_hash  = {})
       softlayer_client = options_hash[:client] || Client.default_client
@@ -218,11 +238,11 @@ module SoftLayer
       }
 
       option_to_filter_path = {
-        :datacenter                 => lambda { |storage_type, server_type| return [ filter_label[storage_type], '.', filter_label[server_type], '.datacenter.name' ].join                  },
-        :domain                     => lambda { |storage_type, server_type| return [ filter_label[storage_type], '.', filter_label[server_type], '.domain' ].join                           },
-        :hostname                   => lambda { |storage_type, server_type| return [ filter_label[storage_type], '.', filter_label[server_type], '.hostname' ].join                         },
-        :service                    => lambda { |storage_type|              return [ filter_label[storage_type],                                 '.serviceResource.backendIpAddress' ].join },
-        :tags                       => lambda { |storage_type, server_type| return [ filter_label[storage_type], '.', filter_label[server_type], '.tagReferences.tag.name' ].join           },
+        :datacenter => lambda { |storage_type, server_type| return [ filter_label[storage_type], '.', filter_label[server_type], '.datacenter.name' ].join                  },
+        :domain     => lambda { |storage_type, server_type| return [ filter_label[storage_type], '.', filter_label[server_type], '.domain' ].join                           },
+        :hostname   => lambda { |storage_type, server_type| return [ filter_label[storage_type], '.', filter_label[server_type], '.hostname' ].join                         },
+        :service    => lambda { |storage_type|              return [ filter_label[storage_type],                                 '.serviceResource.backendIpAddress' ].join },
+        :tags       => lambda { |storage_type, server_type| return [ filter_label[storage_type], '.', filter_label[server_type], '.tagReferences.tag.name' ].join           },
       }
 
       if options_hash[:network_storage_type]
@@ -240,24 +260,13 @@ module SoftLayer
       end
       
       if options_hash[:network_storage_server_type]
-        [ :datacenter, :domain, :hostname ].each do |option|
+        [ :datacenter, :domain, :hostname, :tags ].each do |option|
           if options_hash[option]
             network_storage_object_filter.modify do |filter|
               filter.accept(option_to_filter_path[option].call(network_storage_type, options_hash[:network_storage_server_type])).when_it is(options_hash[option])
             end
           end
         end
-
-        if options_hash[:tags]
-          network_storage_object_filter.set_criteria_for_key_path(option_to_filter_path[:tags].call(network_storage_type, options_hash[:network_storage_server_type]),
-                                                                  {
-                                                                    'operation' => 'in',
-                                                                    'options' => [{
-                                                                                    'name' => 'data',
-                                                                                    'value' => options_hash[:tags].collect{ |tag_value| tag_value.to_s }
-                                                                                  }]
-                                                                  })
-        end
       end
 
       account_service = softlayer_client[:Account]
@@ -265,6 +274,10 @@ module SoftLayer
       account_service = account_service.object_mask(NetworkStorage.default_object_mask)
       account_service = account_service.object_mask(options_hash[:network_storage_object_mask]) if options_hash[:network_storage_object_mask]
 
+      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 options_hash[:network_storage_type]
       when :evault
         network_storage_data = account_service.getEvaultNetworkStorage

data/lib/softlayer/NetworkStorageAllowedHost.rb

@@ -15,7 +15,9 @@ module SoftLayer
     sl_attr :name
 
     ##
-    # The NetworkStorageGroup instances assigned to this host
+    # Retrieve the NetworkStorageGroup instances assigned to this host
+    # :call-seq:
+    #   assigned_groups(force_update=false)
     sl_dynamic_attr :assigned_groups do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -29,7 +31,9 @@ module SoftLayer
     end
 
     ##
-    # The NetworkStorage instances assigned to this host
+    # Retrieve the NetworkStorage instances assigned to this host
+    # :call-seq:
+    #   assigned_volumes(force_update=false)
     sl_dynamic_attr :assigned_volumes do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -43,7 +47,9 @@ module SoftLayer
     end
 
     ##
-    # The NetworkStorageCredential instance used to access NetworkStorage for this host
+    # Retrieve the NetworkStorageCredential instance used to access NetworkStorage for this host
+    # :call-seq:
+    #   credential(force_update=false)
     sl_dynamic_attr :credential do |resource|
       resource.should_update? do
         #only retrieved once per instance

data/lib/softlayer/NetworkStorageCredential.rb

@@ -17,13 +17,27 @@ module SoftLayer
     include ::SoftLayer::DynamicAttribute
 
     ##
-    # :attr_reader:
+    # :attr_reader: created_at
+    # This is the data that the record was created in the table.
+    sl_attr :created_at,  'createDate'
+
+    ##
+    # :attr_reader: created
     # This is the data that the record was created in the table.
+    # DEPRECATION WARNING: This attribute is deprecated in favor of created_at
+    # and will be removed in the next major release.
     sl_attr :created,  'createDate'
 
     ##
-    # :attr_reader:
+    # :attr_reader: modified_at
+    # This is the date that the record was last updated in the table.
+    sl_attr :modified_at, 'modifyDate'
+
+    ##
+    # :attr_reader: modified
     # This is the date that the record was last updated in the table.
+    # DEPRECATION WARNING: This attribute is deprecated in favor of modified_at
+    # and will be removed in the next major release.
     sl_attr :modified, 'modifyDate'
 
     ##
@@ -61,14 +75,22 @@ 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 network storage account passwords associated with servers matching this datacenter
-    # * <b>+:domain+</b>                      (string) - Include network storage account passwords associated with servers matching this domain
-    # * <b>+:hostname+</b>                    (string) - Include network storage account passwords associated with servers matching this hostname
-    # * <b>+:network_storage_server_type+</b> (string) - Include network storage account passwords associated with services of this server type
-    # * <b>+:network_storage_type+</b>        (string) - Include network storage account passwords from devices of this storage type
-    # * <b>+:service+</b>                     (string) - Include network storage account passwords from devices with this service fqdn
-    # * <b>+:tags+</b>                        (Array)  - Include network storage account passwords associated with servers matching these tags
-    # * <b>+:username+</b>                    (string) - Include network storage account passwords with this username only
+    # * <b>+:datacenter+</b>                  (string/array) - Include network storage credentials associated with servers matching this datacenter
+    # * <b>+:domain+</b>                      (string/array) - Include network storage credentials associated with servers matching this domain
+    # * <b>+:hostname+</b>                    (string/array) - Include network storage credentials associated with servers matching this hostname
+    # * <b>+:network_storage_server_type+</b> (symbol)       - Include network storage credentials associated with services of this server type
+    # * <b>+:network_storage_type+</b>        (symbol)       - Include network storage credentials from devices of this storage type
+    # * <b>+:service+</b>                     (string/array) - Include network storage credentials from devices with this service fqdn
+    # * <b>+:tags+</b>                        (string/array) - Include network storage credentials associated with servers matching these tags
+    # * <b>+:username+</b>                    (string/array) - Include network storage credentials with this username only
+    #
+    # Additionally you may provide options related to the request itself:
+    # * <b>*:network_storage_credential_object_filter*</b> (ObjectFilter) - Include network storage credentials that match the
+    #                                                                       criteria of this object filter
+    # * <b>*:network_storage_credential_object_mask*</b>   (string)       - The object mask of properties you wish to receive for the items returned.
+    #                                                                       If not provided, the result will use the default object mask
+    # * <b>*:network_storage_object_filter*</b>            (ObjectFilter) - Include network storage credentials from network storage that matches the
+    #                                                                       criteria of this object filter
     #
     def self.find_network_storage_credentials(options_hash = {})
       softlayer_client = options_hash[:client] || Client.default_client
@@ -104,11 +126,13 @@ module SoftLayer
       }
 
       option_to_filter_path = {
-        :datacenter                 => lambda { |storage_type, server_type| return [ filter_label[storage_type], '.', filter_label[server_type], '.datacenter.name' ].join                  },
-        :domain                     => lambda { |storage_type, server_type| return [ filter_label[storage_type], '.', filter_label[server_type], '.domain' ].join                           },
-        :hostname                   => lambda { |storage_type, server_type| return [ filter_label[storage_type], '.', filter_label[server_type], '.hostname' ].join                         },
-        :service                    => lambda { |storage_type|              return [ filter_label[storage_type],                                 '.serviceResource.backendIpAddress' ].join },
-        :tags                       => lambda { |storage_type, server_type| return [ filter_label[storage_type], '.', filter_label[server_type], '.tagReferences.tag.name' ].join           },
+        :network_storage            => {
+          :datacenter => lambda { |storage_type, server_type| return [ filter_label[storage_type], '.', filter_label[server_type], '.datacenter.name' ].join                  },
+          :domain     => lambda { |storage_type, server_type| return [ filter_label[storage_type], '.', filter_label[server_type], '.domain' ].join                           },
+          :hostname   => lambda { |storage_type, server_type| return [ filter_label[storage_type], '.', filter_label[server_type], '.hostname' ].join                         },
+          :service    => lambda { |storage_type|              return [ filter_label[storage_type],                                 '.serviceResource.backendIpAddress' ].join },
+          :tags       => lambda { |storage_type, server_type| return [ filter_label[storage_type], '.', filter_label[server_type], '.tagReferences.tag.name' ].join           }
+        },
         :network_storage_credential => {
           :username                 => "credentials.username"
         }
@@ -124,29 +148,20 @@ module SoftLayer
 
       if options_hash[:service]
         network_storage_object_filter.modify do |filter|
-          filter.accept(option_to_filter_path[:service].call(network_storage_type)).when_it is(options_hash[:service])
+          filter.accept(option_to_filter_path[:network_storage][:service].call(network_storage_type)).when_it is(options_hash[:service])
         end
       end
 
       if options_hash[:network_storage_server_type]
-        [ :datacenter, :domain, :hostname ].each do |option|
+        option_to_filter_path[:network_storage].keys.each do |option|
+          next if option == :service
+
           if options_hash[option]
             network_storage_object_filter.modify do |filter|
-              filter.accept(option_to_filter_path[option].call(network_storage_type, options_hash[:network_storage_server_type])).when_it is(options_hash[option])
+              filter.accept(option_to_filter_path[:network_storage][option].call(network_storage_type, options_hash[:network_storage_server_type])).when_it is(options_hash[option])
             end
           end
         end
-
-        if options_hash[:tags]
-          network_storage_object_filter.set_criteria_for_key_path(option_to_filter_path[:tags].call(network_storage_type, options_hash[:network_storage_server_type]),
-                                                                  {
-                                                                    'operation' => 'in',
-                                                                    'options' => [{
-                                                                                    'name' => 'data',
-                                                                                    'value' => options_hash[:tags].collect{ |tag_value| tag_value.to_s }
-                                                                                  }]
-                                                                  })
-        end
       end
 
       option_to_filter_path[:network_storage_credential].each do |option, filter_path|

data/lib/softlayer/NetworkStorageGroup.rb

@@ -15,17 +15,33 @@ module SoftLayer
     sl_attr :alias
 
     ##
-    # :attr_reader:
+    # :attr_reader: created_at
+    # The date this group was created.
+    sl_attr :created_at, 'createDate'
+
+    ##
+    # :attr_reader: created
     # The date this group 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'
 
     ##
-    # :attr_reader:
+    # :attr_reader: modified_at
+    # The date this group was modified.
+    sl_attr :modified_at, 'modifyDate'
+
+    ##
+    # :attr_reader: modified
     # The date this group was 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'
 
     ##
-    # The SoftLayer_Account which owns this group.
+    # Retrieve the SoftLayer_Account which owns this group.
+    # :call-seq:
+    #   account(force_update=false)
     sl_dynamic_attr :account do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -39,7 +55,9 @@ module SoftLayer
     end
 
     ##
-    # The allowed hosts list for this group.
+    # Retrieve the allowed hosts list for this group.
+    # :call-seq:
+    #   allowed_hosts(force_update=false)
     sl_dynamic_attr :allowed_hosts do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -53,7 +71,9 @@ module SoftLayer
     end
 
     ##
-    # The network storage volumes this group is attached to.
+    # Retrieve the network storage volumes this group is attached to.
+    # :call-seq:
+    #   attached_volumes(force_update=false)
     sl_dynamic_attr :attached_volumes do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -67,7 +87,9 @@ module SoftLayer
     end
 
     ##
-    # The IP address for for SoftLayer_Network_Storage_Allowed_Host objects within this group.
+    # Retrieve the IP address for for SoftLayer_Network_Storage_Allowed_Host objects within this group.
+    # :call-seq:
+    #   ip_address(force_update=false)
     sl_dynamic_attr :ip_address do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -81,7 +103,10 @@ module SoftLayer
     end
 
     ##
-    # The description of theSoftLayer_Network_Storage_OS_Type Operating System designation that this group was created for.
+    # Retrieve the description of the SoftLayer_Network_Storage_OS_Type 
+    # Operating System designation that this group was created for.
+    # :call-seq:
+    #   os_description(force_update=false)
     sl_dynamic_attr :os_description do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -95,7 +120,10 @@ module SoftLayer
     end
 
     ##
-    # The name of theSoftLayer_Network_Storage_OS_Type Operating System designation that this group was created for.
+    # Retrieve the name of the SoftLayer_Network_Storage_OS_Type 
+    # Operating System designation that this group was created for.
+    # :call-seq:
+    #   os_name(force_update=false)
     sl_dynamic_attr :os_name do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -109,7 +137,9 @@ module SoftLayer
     end
 
     ##
-    # The network resource this group is created on.
+    # Retrieve the network resource this group is created on.
+    # :call-seq:
+    #   service_resource(force_update=false)
     sl_dynamic_attr :service_resource do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -123,7 +153,9 @@ module SoftLayer
     end
 
     ##
-    # The name of the SoftLayer_Network_Storage_Group_Type which describes this group.
+    # Retrieve the name of the SoftLayer_Network_Storage_Group_Type which describes this group.
+    # :call-seq:
+    #   type(force_update=false)
     sl_dynamic_attr :type do |resource|
       resource.should_update? do
         #only retrieved once per instance

data/lib/softlayer/ObjectFilter.rb

@@ -115,7 +115,7 @@ module SoftLayer
   # The ObjectFilterDefinitionContext defines a bunch of methods
   # that allow the property conditions of an object filter to
   # be defined in a "pretty" way. Each method returns a block
-  # (a lambda, a proc) that, when called and pased the tail property
+  # (a lambda, a proc) that, when called and passed the tail property
   # of a property chain will generate a fragment of an object filter
   # asking that that property match the given conditions.
   #
@@ -125,14 +125,16 @@ module SoftLayer
   module ObjectFilterDefinitionContext
     # Matches when the value in the field is exactly equal to the
     # given value. This is a case-sensitive match
+    # If value is Enumerable, it is equivalent to calling is_contained_by
     def self.is(value)
-      { 'operation' => value }
+      value.kind_of?(Enumerable) ? is_contained_by(value) : { 'operation' => value }
     end
 
     # Matches is the value in the field does not exactly equal
     # the value passed in.
+    # If value is Enumerable, it is equivalent to calling is_not_contained_by
     def self.is_not(value)
-      filter_criteria('!=', value)
+      value.kind_of?(Enumerable) ? is_not_contained_by(value) : filter_criteria('!=', value)
     end
 
     # Matches when the value is found within the field
@@ -153,11 +155,59 @@ module SoftLayer
       filter_criteria('$=', value)
     end
 
-    # Maches the given value in a case-insensitive way
+    # Matches the given value in a case-insensitive way
     def self.matches_ignoring_case(value)
       filter_criteria('_=', value)
     end
 
+    # Matches when the key path value is a date between the start and end dates provided
+    # Dates should be strings in '%m/%d/%Y %T' format or Date/DateTime instances
+    def self.is_between_dates(start_date, end_date)
+      {
+        'operation' => 'betweenDate',
+        'options'   => [
+                        {
+                          'name'  => 'startDate',
+                          'value' => [ start_date.kind_of?(Date) ? start_date.strftime('%m/%d/%Y %T') : DateTime.strptime(start_date.to_s, '%m/%d/%Y %T').strftime('%m/%d/%Y %T') ]
+                        },
+                        {
+                          'name'  => 'endDate',
+                          'value' => [ end_date.kind_of?(Date) ? end_date.strftime('%m/%d/%Y %T') : DateTime.strptime(end_date.to_s, '%m/%d/%Y %T').strftime('%m/%d/%Y %T') ]
+                        }
+                       ]
+      }
+    end
+
+    # Matches when key path value is equal to one of the given values in the Enumerable
+    def self.is_contained_by(value)
+      raise "Expected an Enumerable value with a list of acceptable values that can be converted to strings" unless value.kind_of?(Enumerable)
+
+      {
+        'operation' => 'in',
+        'options'   => [
+                        {
+                          'name'  => 'data',
+                          'value' => value.collect { |enum_val| enum_val.to_s }
+                        }
+                       ]
+      }
+    end
+
+    # Matches when key path value is not equal to one of the given values in the Enumerable
+    def self.is_not_contained_by(value)
+      raise "Expected an Enumerable value with a list of acceptable values that can be converted to strings" unless value.kind_of?(Enumerable)
+
+      {
+        'operation' => 'not in',
+        'options'   => [
+                        {
+                          'name'  => 'data',
+                          'value' => value.collect { |enum_val| enum_val.to_s }
+                        }
+                       ]
+      }
+    end
+
     # Matches when the value in the field is greater than the given value
     def self.is_greater_than(value)
       filter_criteria('>', value)