Renamed softlayer_resource to sofltayer_dynamic_attr. This makes it lie very nicely aside softlayer_attr. Added more attributes to the existing classes and 'played with' documentation to see how we could document those beasts.

Author: SLsthompson

examples/order_virtual_server.rb

@@ -29,7 +29,7 @@
 begin
   # This sample walks through the creation of a Virtual Server.
   # It explores techniques for discovering what configuration options
-  # exist, puts together an order, then sends that order to 
+  # exist, puts together an order, then sends that order to
   # SoftLayer for verification.
 
   client = SoftLayer::Client.new(
@@ -42,37 +42,37 @@
   server_order = SoftLayer::VirtualServerOrder.new(client)
   server_order.hostname = "server1"
   server_order.domain = "ruby-api-test.org"
-  
+
   # We must tell the system in which datacenter we want our server created
   # We can ask the class to give us a list of options:
   puts SoftLayer::VirtualServerOrder.datacenter_options(client).inspect
-  
+
   # The list will look something like ["ams01", "dal01", "dal05",...
   # Let's put our server in the 'dal05' (Dallas 5) datacenter
   server_order.datacenter = 'dal05'
-  
+
   # The order must know how many computing cores we want in our virtual
-  # server.  Again we can ask the class for options.  The result will 
+  # server.  Again we can ask the class for options.  The result will
   # be something like [1, 2, 4, 8, 12, 16]
   # 2 sounds like a good number of cores for our simple server
   puts SoftLayer::VirtualServerOrder.core_options(client).inspect
   server_order.cores = 2
-  
+
   # We must indicate how much memory the virtual server should have.
   # Again we can query for options and select a good value
   puts SoftLayer::VirtualServerOrder.memory_options(client).inspect
   server_order.memory = 2 #GB
-  
+
   # Similarly we can choose an operating system for the server:
   puts SoftLayer::VirtualServerOrder.os_reference_code_options(client).inspect
   server_order.os_reference_code = 'CENTOS_6_64'
-  
-  # Finally, in spite of the fact that our server is simple, we want it 
+
+  # Finally, in spite of the fact that our server is simple, we want it
   # to have a blazing fast connection speed.  Let's look at the options and choose
   # the fastest! (it's probably 1 Gbps)
   server_order.max_port_speed = SoftLayer::VirtualServerOrder.max_port_speed_options(client).max
-  
-  # The server order is now complete. This sample will ask it to verify itself with the 
+
+  # The server order is now complete. This sample will ask it to verify itself with the
   # SoftLayer ordering system, but a simple change from verify to place_order! would ask
   # the system to provision the server (and charge it to our account)
   begin

lib/softlayer/Account.rb

@@ -22,24 +22,68 @@
 
 module SoftLayer
   class Account < SoftLayer::ModelBase
-    include ::SoftLayer::ModelResource
-
-    softlayer_attr :companyName
-    softlayer_attr :firstName
-    softlayer_attr :lastName
-    softlayer_attr :address1
-    softlayer_attr :address2
-    softlayer_attr :city
-    softlayer_attr :state
-    softlayer_attr :country
-    softlayer_attr :postalCode
-    softlayer_attr :officePhone
+    include ::SoftLayer::DynamicAttribute
+
+    ##
+    # :attr_reader:
+    # The company name of the primary contact
+    sl_attr :companyName
+
+    ##
+    # :attr_reader:
+    # The given name name of the primary contact
+    sl_attr :firstName
+
+    ##
+    # :attr_reader:
+    # The surname of the primary contact
+    sl_attr :lastName
+
+    ##
+    # :attr_reader:
+    # The first address line for the primary contact's address
+    sl_attr :address1
+
+    ##
+    # :attr_reader:
+    # The second address line (if any, may be nil) for the primary contact's address
+    sl_attr :address2
+
+    ##
+    # :attr_reader:
+    # The city stored as part of the primary contact's address
+    sl_attr :city
+
+    ##
+    # :attr_reader:
+    # The two character abbreviation for the state, province, or other similar national
+    # division that is part of the address of the primary contact.  For addresses
+    # outside of the US and Canada, where there may not be an equivalent to a state,
+    # this may be 'NA' (for not applicable)
+    sl_attr :state
+
+    ##
+    # :attr_reader:
+    # The country stored as part of the primary contact's address
+    sl_attr :country
+
+    ##
+    # :attr_reader:
+    # The postal code (in the US, aka. zip code) of the primary contact's address
+    sl_attr :postalCode
+
+    ##
+    # :attr_reader:
+    # The office phone nubmer listed for the primary contact
+    sl_attr :officePhone
 
     ##
     # The Bare Metal Servers (physical hardware) associated with the
     # account. Unless you force these to update, they will be refreshed every
     # five minutes.
-    softlayer_resource :bare_metal_servers do |bare_metal|
+    # :call-seq:
+    #   bare_metal_servers(force_update=false)
+    sl_dynamic_attr :bare_metal_servers do |bare_metal|
       bare_metal.should_update? do
         @last_bare_metal_update ||= Time.at(0)
         (Time.now - @last_bare_metal_update) > 5 * 60  # update every 5 minutes
@@ -55,7 +99,9 @@ class Account < SoftLayer::ModelBase
     # The virtual servers (aka. CCIs or Virtual_Guests) associated with the
     # account. Unless you force these to update, they will be refreshed every
     # five minutes.
-    softlayer_resource :virtual_servers do |virtual_servers|
+    # :call-seq:
+    #   virtual_servers(force_update=false)
+    sl_dynamic_attr :virtual_servers do |virtual_servers|
       virtual_servers.should_update? do
         @last_virtual_server_update ||= Time.at(0)
         (Time.now - @last_virtual_server_update) > 5 * 60  # update every 5 minutes
@@ -69,8 +115,10 @@ class Account < SoftLayer::ModelBase
 
     ##
     # The tickets resource consists of all open tickets, and tickets closed
-    # "recently". These refresh every 5 minutes
-    softlayer_resource :tickets do |tickets|
+    # "recently". These refresh every 5 minutes.
+    # :call-seq:
+    #   tickets(force_update=false)
+    sl_dynamic_attr :tickets do |tickets|
       tickets.should_update? do
         @last_ticket_update ||= Time.at(0)
         (Time.now - @last_ticket_update) > 5 * 60 #update every 5 minutes

lib/softlayer/BareMetalServer.rb

@@ -23,7 +23,7 @@
 module SoftLayer
   #
   # This class represents a Bare Metal Server, a hardware server in contrast to a virtual machine,
-  # in the SoftLayer Environment. It corresponds rougly to the +SoftLayer_Hardware+ and 
+  # in the SoftLayer Environment. It corresponds rougly to the +SoftLayer_Hardware+ and
   # +SoftLayer_Hardware_Server+ services in the SoftLayer API
   #
   # http://sldn.softlayer.com/reference/datatypes/SoftLayer_Hardware
@@ -68,7 +68,7 @@ def cancel!(reason = :unneeded, comment = '')
     end
 
     ##
-    # Returns the SoftLayer Service used to work with instances of this class. 
+    # Returns the SoftLayer Service used to work with instances of this class.
     # For Bare Metal Servers that is +SoftLayer_Hardware+ though in some special cases
     # you may have to use +SoftLayer_Hardware_Server+ as a type or service.
     #
@@ -103,7 +103,7 @@ def self.default_object_mask
     #
     # When cancelling a server with the cancel! method, the first parameter is the reason and
     # should be one of the keys in the hash returned by this method.  This, in turn
-    # will be translated into a string which is, for all intents and purposes, a 
+    # will be translated into a string which is, for all intents and purposes, a
     # literal string constant with special meaning to the SoftLayer API.
     #
     def self.cancellation_reasons

lib/softlayer/BareMetalServerOrder.rb

@@ -31,7 +31,7 @@ module SoftLayer
   # that go into configuring the server, please see the
   # BareMetalServerOrder_Package class.
   #
-  # This class creates the server with the SoftLayer_Hardware::createObject 
+  # This class creates the server with the SoftLayer_Hardware::createObject
   # method.
   #
   # http://sldn.softlayer.com/reference/services/SoftLayer_Hardware/createObject
@@ -188,13 +188,13 @@ def hardware_instance_template
     def self.create_object_options(client)
       @@create_object_options ||= client["Hardware"].getCreateObjectOptions()
     end
-    
+
     ##
     # Return a list of values that are valid for the :datacenter attribute
     def self.datacenter_options(client)
       create_object_options(client)["datacenters"].collect { |datacenter_spec| datacenter_spec['template']['datacenter']["name"] }.uniq.sort!
     end
-    
+
     def self.core_options(client)
       create_object_options(client)["processors"].collect { |processor_spec| processor_spec['template']['processorCoreAmount'] }.uniq.sort!
     end
@@ -215,7 +215,7 @@ def self.os_reference_code_options(client)
     # Returns a list of the :max_port_speeds
     def self.max_port_speed_options(client)
       create_object_options(client)["networkComponents"].collect { |component_spec| component_spec['template']['networkComponents'][0]['maxSpeed'] }
-    end    
+    end
 
   end # class BareMetalServerOrder
 end # module SoftLayer

lib/softlayer/BareMetalServerOrder_Package.rb

@@ -24,9 +24,9 @@ module SoftLayer
   #
   # This class is used to order a hardware server using a product package.
   #
-  # Ordering a server using a product package is a more complex process than 
-  # ordering with simple attributes (as is done by the BareMetalServerOrder class). 
-  # However with that complexity comes the the ability to specify the configuration 
+  # Ordering a server using a product package is a more complex process than
+  # ordering with simple attributes (as is done by the BareMetalServerOrder class).
+  # However with that complexity comes the the ability to specify the configuration
   # of the server in exacting detail.
   #
   # To use this class, you first select a product package. The product package
@@ -58,8 +58,8 @@ class BareMetalServerOrder_Package < Server
     attr_accessor :domain
 
     # The value of this property should be a hash. The keys of the hash are ProdcutItemCategory
-    # codes (like 'os' and 'ram') while the values may be Integers or Objects. The Integer values 
-    # should be the +id+ of a +SoftLayer_Product_Item_Price+ representing the configuration option 
+    # codes (like 'os' and 'ram') while the values may be Integers or Objects. The Integer values
+    # should be the +id+ of a +SoftLayer_Product_Item_Price+ representing the configuration option
     # chosen for that category. Objects must respond to the +price_id+ message and return an integer
     # that is the +id+ of a +SoftLayer_Product_Item_Price+. Instances of the ProductConfigurationOption
     # class behave this way.
@@ -154,7 +154,7 @@ def hardware_order
 
       product_order
     end
-    
+
   end # BareMetalServerOrder_Package
-  
+
 end # SoftLayer