Made it so that all the model objects implement the 'service' attribute. That attribute creates a service object tailored to that specific object and should allow calls through the object to the SoftLayer API. In that it does so this

resolves #21

Author: SLsthompson

examples/account_servers.rb

@@ -0,0 +1,53 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), "../lib" )
+
+#
+# Copyright (c) 2014 SoftLayer Technologies, Inc. All rights reserved.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+
+require 'rubygems'
+require 'softlayer_api'
+require 'pp'
+
+begin
+  client = SoftLayer::Client.new(
+    # :username => "joecustomer"              # enter your username here
+    # :api_key => "feeddeadbeefbadf00d..."   # enter your api key here
+  )
+  
+  account = SoftLayer::Account.account_for_client(client)
+  
+  # grab a list of all the servers on the account.
+  servers = account.servers
+  
+  # measure their fully qualified domain names so we can print a pretty table
+  max_name_len = servers.inject(0) { |max_name, server| [max_name, server.fullyQualifiedDomainName.length].max }
+
+  printf "%#{-max_name_len}s\tPrimary Public IP\n", "Server FQDN"
+  printf "%#{-max_name_len}s\t-----------------\n", "-----------"
+
+  servers.each do |server| 
+    ip_field = server.primary_public_ip ? server.primary_public_ip : "No Public Interface"
+    printf "%#{-max_name_len}s\t#{ip_field}\n", server.fullyQualifiedDomainName
+  end
+
+rescue
+  puts "An unexpected exception occurred!"
+end

lib/softlayer/APIParameterFilter.rb

@@ -129,7 +129,7 @@ def object_filter(filter)
   ##
   # A utility method that returns the server object ID (if any) stored
   # in this parameter set.
-  def server_object_id
+  def server_object_id 
     self.parameters[:server_object_id]
   end
 

lib/softlayer/Account.rb

@@ -137,6 +137,10 @@ class Account < SoftLayer::ModelBase
       end
     end
 
+    def service
+      softlayer_client["Account"].object_with_id(self.id)
+    end
+    
     ##
     # Using the login credentials in the client, retrieve
     # the account associated with those credentials.

lib/softlayer/BareMetalServer.rb

@@ -68,13 +68,11 @@ 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 this Server
     # 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.
-    #
-    # This routine is largely an implementation detail of this object framework
     def service
-      return softlayer_client["Hardware"]
+      return softlayer_client["Hardware"].object_with_id(self.id)
     end
 
     ##
@@ -125,14 +123,14 @@ def self.cancellation_reasons
     # Retrive the bare metal server with the given server ID from the
     # SoftLayer API
     def self.server_with_id(softlayer_client, server_id, options = {})
-      service = softlayer_client["Hardware"]
-      service = service.object_mask(default_object_mask.to_sl_object_mask)
+      hardware_service = softlayer_client["Hardware"]
+      hardware_service = hardware_service.object_mask(default_object_mask.to_sl_object_mask)
 
       if options.has_key?(:object_mask)
-        object_mask = service.object_mask(options[:object_mask])
+        object_mask = hardware_service.object_mask(options[:object_mask])
       end
 
-      server_data = service.object_with_id(server_id).getObject()
+      server_data = hardware_service.object_with_id(server_id).getObject()
 
       return BareMetalServer.new(softlayer_client, server_data)
     end
@@ -193,22 +191,22 @@ def self.find_servers(softlayer_client, options_hash = {})
           } ));
       end
 
-      service = softlayer_client['Account']
-      service = service.object_filter(object_filter) unless object_filter.empty?
-      service = service.object_mask(default_object_mask.to_sl_object_mask)
+      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)
 
       if(options_hash.has_key? :object_mask)
-        service = service.object_mask(options_hash[: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]
 
-        service = service.result_limit(offset, limit)
+        account_service = account_service.result_limit(offset, limit)
       end
 
-      bare_metal_data = service.getHardware()
+      bare_metal_data = account_service.getHardware()
       bare_metal_data.collect { |server_data| BareMetalServer.new(softlayer_client, server_data) }
     end
   end #BareMetalServer

lib/softlayer/Client.rb

@@ -26,9 +26,9 @@ module SoftLayer
   # SoftLayer API.
   #
   # The following symbols can be used as hash arguments to pass options to the constructor:
-  # - +:username+ - a non-empty string providing the username to use for requests to the service
-  # - +:api_key+ - a non-empty string providing the api key to use for requests to the service
-  # - +:endpoint_url+ - a non-empty string providing the endpoint URL to use for requests to the service
+  # - +:username+ - a non-empty string providing the username to use for requests to the client
+  # - +:api_key+ - a non-empty string providing the api key to use for requests to the client
+  # - +:endpoint_url+ - a non-empty string providing the endpoint URL to use for requests to the client
   #
   # If any of the options above are missing then the constructor will try to use the corresponding
   # global variable declared in the SoftLayer Module:

lib/softlayer/ModelBase.rb

@@ -27,8 +27,8 @@ module SoftLayer
   # for objects in that hierarchy
   #
   # The SoftLayer API represents entities as a hash of properties. This class
-  # stores that hash and uses +method_missing+ to allow code to access fields in
-  # that hash through simple method calls.
+  # stores that hash and allows the use of subscripting to access those properties
+  # directly.
   #
   # The class also has a model for making network requests that will refresh
   # the stored hash so that it reflects the most up-to-date information about
@@ -37,8 +37,15 @@ module SoftLayer
   # refresh_details to ask an object to update itself.
   #
   class ModelBase
+    # The client environment that this model object belongs to
     attr_reader :softlayer_client
 
+    ##
+    # :attr_reader: id
+    # The unique identifier of this object within its API service
+
+    # Construct a new model object in the environment of the given client and
+    # with the given hash of network data (presumably returned by the SoftLayer API)
     def initialize(softlayer_client, network_hash)
       raise ArgumentError, "A hash is required" if nil == network_hash
 
@@ -49,8 +56,18 @@ def initialize(softlayer_client, network_hash)
       raise ArgumentError, "id must be non-nil and non-empty" unless self[:id]
     end
 
-    def to_ary
-      return nil
+    ##
+    # The service method of a Model object should return a SoftLayer Service
+    # that best represents the modeled object.  For example, a Ticket models
+    # a particular entity in the SoftLayer_Ticket service.  The particular
+    # entity is identified by its id so the Ticket class would return
+    #
+    #     softlayer_client["Ticket"].object_with_id
+    #
+    # which is a service which would allow calls to the ticket service
+    # through that particular object.
+    def service
+      raise "Abstract method service in ModelBase was called"
     end
 
     ##
@@ -72,7 +89,7 @@ def refresh_details(object_mask = nil)
     # of this routine.
     #
     def softlayer_properties(object_mask = nil)
-      raise RuntimeError.new("Abstract method softlayer_properties in ModelBase was called")
+      raise "Abstract method softlayer_properties in ModelBase was called"
     end
 
     ##
@@ -101,12 +118,17 @@ def self.sl_attr(attribute_symbol, hash_key = nil)
 
       define_method(attribute_symbol.to_sym) { self[hash_key ? hash_key : attribute_symbol.to_s]}
     end
+    
+    sl_attr :id
 
-    ##
-    # :attr_reader: id
-    # The unique identifier of this object within it's API service
-    sl_attr(:id)
-
+    # When printing to the console using puts, ruby will call the
+    # to_ary method trying to convert an object into an array of lines
+    # for stdio. We override to_ary to return nil for model objects
+    # so they may be printed
+    def to_ary()
+      return nil;
+    end
+    
     protected
 
     ##

lib/softlayer/ProductItemCategory.rb

@@ -49,13 +49,13 @@ def free?
   class ProductItemCategory < ModelBase
     include ::SoftLayer::DynamicAttribute
 
-    sl_dynamic_attr :configuration_options do |resource|
-      resource.should_update? do
+    sl_dynamic_attr :configuration_options do |config_opts|
+      config_opts.should_update? do
         # only retrieved once per instance
         @configuration_options == nil
       end
 
-      resource.to_update do
+      config_opts.to_update do
         # This method assumes that the group and price item data was sent in
         # as part of the +network_hash+ used to initialize this object (as is done)
         # by the ProductPackage class. That class, in turn, gets its information
@@ -85,6 +85,10 @@ class ProductItemCategory < ModelBase
       end
     end
 
+    def service
+      softlayer_client["SoftLayer_Product_Item_Category"].object_with_id(self.id)
+    end
+    
     ##
     # If the category has a single option (regardless of fees) this method will return
     # that option.  If the category has more than one option, this method will

lib/softlayer/ProductPackage.rb

@@ -116,11 +116,18 @@ def datacenter_options
       availableLocations.collect { |location_data| location_data["location"]["name"] }
     end
 
+    ##
+    # Given a datacenter name that was returned by datacenter_options, use information
+    # in the package to retrieve a location id.
     def location_id_for_datacenter_name(datacenter_name)
       location_data = availableLocations.find { |location_data| location_data["location"]["name"]  == datacenter_name }
       location_data["locationId"]
     end
 
+    def service
+      softlayer_client['Product_Package'].object_with_id(self.id)
+    end
+
     ##
     # Requests a list (array) of ProductPackages whose key names match the
     # one passed in.

lib/softlayer/Server.rb

@@ -83,16 +83,6 @@ def initialize(softlayer_client, network_hash)
       end
     end
 
-    ##
-    # Returns the service responsible for handling the given
-    # server. In the base class (this one) the server is abstract
-    # but subclasses implement this to return the appropriate service
-    # from their client.
-    #
-    def service
-      raise RuntimeError, "This method is an abstract method in the Server base class"
-    end
-
     ##
     # Make an API request to SoftLayer and return the latest properties hash
     # for this object.
@@ -105,7 +95,7 @@ def softlayer_properties(object_mask = nil)
         my_service = my_service.object_mask(self.class.default_object_mask.to_sl_object_mask)
       end
 
-      my_service.object_with_id(self.id).getObject()
+      my_service.getObject()
     end
 
     ##
@@ -118,7 +108,7 @@ def notes=(new_notes)
         "notes" => new_notes
       }
 
-      service.object_with_id(self.id).editObject(edit_template)
+      self.service.editObject(edit_template)
       self.refresh_details()
     end
 
@@ -127,7 +117,7 @@ def notes=(new_notes)
     #
     def user_metadata=(new_metadata)
       raise ArgumentError.new("Cannot set user metadata to nil") unless new_metadata
-      service.object_with_id(self.id).setUserMetadata([new_metadata])
+      self.service.setUserMetadata([new_metadata])
       self.refresh_details()
     end
 
@@ -143,7 +133,7 @@ def set_hostname!(new_hostname)
         "hostname" => new_hostname
       }
 
-      service.object_with_id(self.id).editObject(edit_template)
+      self.service.editObject(edit_template)
       self.refresh_details()
     end
 
@@ -161,7 +151,7 @@ def set_domain!(new_domain)
         "domain" => new_domain
       }
 
-      service.object_with_id(self.id).editObject(edit_template)
+      self.service.editObject(edit_template)
       self.refresh_details()
     end
 
@@ -177,9 +167,9 @@ def set_domain!(new_domain)
     #
     def change_port_speed(new_speed, public = true)
       if public
-        service.object_with_id(self.id).setPublicNetworkInterfaceSpeed(new_speed)
+        self.service.setPublicNetworkInterfaceSpeed(new_speed)
       else
-        service.object_with_id(self.id).setPrivateNetworkInterfaceSpeed(new_speed)
+        self.service.setPrivateNetworkInterfaceSpeed(new_speed)
       end
 
       self.refresh_details()
@@ -206,7 +196,7 @@ def reload_os!(token = '', provisioning_script_uri = nil, ssh_keys = nil)
       configuration['customProvisionScriptUri'] = provisioning_script_uri if provisioning_script_uri
       configuration['sshKeyIds'] = ssh_keys if ssh_keys
 
-      service.object_with_id(self.id).reloadOperatingSystem(token, configuration)
+      self.service.reloadOperatingSystem(token, configuration)
     end
 
     def to_s

lib/softlayer/Service.rb

@@ -134,6 +134,13 @@ def initialize(service_name, options = {})
     def related_service_named(service_name)
       @client.service_named(service_name)
     end
+    
+    # Added here so that the interface of this class matches that
+    # of APIParameterFilter.  In APIParameterFilter the target is
+    # a service.  In a service, the target is itself.
+    def target
+      return self
+    end
 
     # Use this as part of a method call chain to identify a particular
     # object as the target of the request. The parameter is the SoftLayer