A large number of cosmetic changes. Clients are now passed symbols representing the SoftLayer services. This is because they are in essece fixed, well known constants and symbols more properly capture that nature. Also cases were we dereference properties now use single quotes instead of double quotes to capture the fact that they too are largely constants and not 'composeable' arbitrary strings. Finally this change includes the latest round of killing off trailing whitespace

Author: SLsthompson

lib/softlayer/Account.rb

@@ -123,7 +123,7 @@ class Account < SoftLayer::ModelBase
     end
 
     def service
-      softlayer_client["Account"].object_with_id(self.id)
+      softlayer_client[:Account].object_with_id(self.id)
     end
 
     ##
@@ -134,7 +134,7 @@ def self.account_for_client(client = nil)
       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
 
-      account_service = softlayer_client['Account']
+      account_service = softlayer_client[:Account]
       network_hash = account_service.getObject()
       new(softlayer_client, network_hash)
     end

lib/softlayer/BareMetalServer.rb

@@ -27,7 +27,7 @@ class BareMetalServer < Server
     #
     def bare_metal_instance?
       if has_sl_property?(:bareMetalInstanceFlag)
-        self["bareMetalInstanceFlag"] != 0
+        self['bareMetalInstanceFlag'] != 0
       else
         false
       end
@@ -47,10 +47,10 @@ def cancel!(reason = :unneeded, comment = '')
       if !bare_metal_instance? then
         cancellation_reasons = self.class.cancellation_reasons()
         cancel_reason = cancellation_reasons[reason] || cancellation_reasons[:unneeded]
-        softlayer_client["Ticket"].createCancelServerTicket(self.id, cancel_reason, comment, true, 'HARDWARE')
+        softlayer_client[:Ticket].createCancelServerTicket(self.id, cancel_reason, comment, true, 'HARDWARE')
       else
         # Note that reason and comment are ignored in this case, unfortunately
-        softlayer_client['Billing_Item'].object_with_id(self.billingItem['id'].to_i).cancelService()
+        softlayer_client[:Billing_Item].object_with_id(self.billingItem['id'].to_i).cancelService()
       end
     end
 
@@ -59,7 +59,7 @@ def cancel!(reason = :unneeded, comment = '')
     # 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.
     def service
-      return softlayer_client["Hardware"].object_with_id(self.id)
+      return softlayer_client[:Hardware].object_with_id(self.id)
     end
 
     ##
@@ -120,7 +120,7 @@ def self.server_with_id(server_id, options = {})
       softlayer_client = options[:client] || Client.default_client
       raise "#{__method__} requires a client but none was given and Client::default_client is not set" if !softlayer_client
 
-      hardware_service = softlayer_client["Hardware"]
+      hardware_service = softlayer_client[:Hardware]
       hardware_service = hardware_service.object_mask(default_object_mask.to_sl_object_mask)
 
       if options.has_key?(:object_mask)
@@ -199,7 +199,7 @@ def self.find_servers(options_hash = {})
           } );
       end
 
-      account_service = softlayer_client['Account']
+      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)
 

lib/softlayer/BareMetalServerOrder.rb

@@ -111,7 +111,7 @@ def verify()
       order_template = hardware_instance_template
       order_template = yield order_template if block_given?
 
-      @softlayer_client["Hardware"].generateOrderTemplate(order_template)
+      @softlayer_client[:Hardware].generateOrderTemplate(order_template)
     end
 
     ##
@@ -124,8 +124,8 @@ def place_order!()
       order_template = hardware_instance_template
       order_template = yield order_template if block_given?
 
-      server_hash = @softlayer_client["Hardware"].createObject(order_template)
-      SoftLayer::BareMetalServer.server_with_id(server_hash["id"], :client => @softlayer_client) if server_hash
+      server_hash = @softlayer_client[:Hardware].createObject(order_template)
+      SoftLayer::BareMetalServer.server_with_id(server_hash['id'], :client => @softlayer_client) if server_hash
     end
 
     protected
@@ -147,15 +147,15 @@ def hardware_instance_template
         "hourlyBillingFlag" => !!@hourly
       }
 
-      template["privateNetworkOnlyFlag"] = true if @private_network_only
+      template['privateNetworkOnlyFlag'] = true if @private_network_only
 
-      template["datacenter"] = {"name" => @datacenter.name} if @datacenter
+      template['datacenter'] = {"name" => @datacenter.name} if @datacenter
       template['userData'] = [{'value' => @user_metadata}] if @user_metadata
       template['networkComponents'] = [{'maxSpeed'=> @max_port_speed}] if @max_port_speed
       template['postInstallScriptUri'] = @provision_script_URI.to_s if @provision_script_URI
       template['sshKeys'] = @ssh_key_ids.collect { |ssh_key| {'id'=> ssh_key.to_i } } if @ssh_key_ids
       template['primaryNetworkComponent'] = { "networkVlan" => { "id" => @public_vlan_id.to_i } } if @public_vlan_id
-      template["primaryBackendNetworkComponent"] = { "networkVlan" => {"id" => @private_vlan_id.to_i } } if @private_vlan_id
+      template['primaryBackendNetworkComponent'] = { "networkVlan" => {"id" => @private_vlan_id.to_i } } if @private_vlan_id
 
       if @disks && !@disks.empty?
         template['hardDrives'] = @disks.collect do |disk|
@@ -174,36 +174,36 @@ def self.create_object_options(client = nil)
       raise "#{__method__} requires a client but none was given and Client::default_client is not set" if !softlayer_client
 
       @@create_object_options ||= nil
-      @@create_object_options = softlayer_client["Hardware"].getCreateObjectOptions() if !@@create_object_options
+      @@create_object_options = softlayer_client[:Hardware].getCreateObjectOptions() if !@@create_object_options
       @@create_object_options
     end
 
     ##
     # Return a list of values that are valid for the :datacenter attribute
     def self.datacenter_options(client = nil)
-      create_object_options(client)["datacenters"].collect { |datacenter_spec| Datacenter.datacenter_named(datacenter_spec['template']['datacenter']['name'], client) }.uniq
+      create_object_options(client)['datacenters'].collect { |datacenter_spec| Datacenter.datacenter_named(datacenter_spec['template']['datacenter']['name'], client) }.uniq
     end
 
     def self.core_options(client = nil)
-      create_object_options(client)["processors"].collect { |processor_spec| processor_spec['template']['processorCoreAmount'] }.uniq.sort!
+      create_object_options(client)['processors'].collect { |processor_spec| processor_spec['template']['processorCoreAmount'] }.uniq.sort!
     end
 
     ##
     # Return a list of values that are valid the array given to the :disks
     def self.disk_options(client = nil)
-      create_object_options(client)["hardDrives"].collect { |disk_spec| disk_spec['template']['hardDrives'][0]['capacity'].to_i}.uniq.sort!
+      create_object_options(client)['hardDrives'].collect { |disk_spec| disk_spec['template']['hardDrives'][0]['capacity'].to_i}.uniq.sort!
     end
 
     ##
     # Returns a list of the valid :os_refrence_codes
     def self.os_reference_code_options(client = nil)
-      create_object_options(client)["operatingSystems"].collect { |os_spec| os_spec['template']['operatingSystemReferenceCode'] }.uniq.sort!
+      create_object_options(client)['operatingSystems'].collect { |os_spec| os_spec['template']['operatingSystemReferenceCode'] }.uniq.sort!
     end
 
     ##
     # Returns a list of the :max_port_speeds
     def self.max_port_speed_options(client = nil)
-      create_object_options(client)["networkComponents"].collect { |component_spec| component_spec['template']['networkComponents'][0]['maxSpeed'] }
+      create_object_options(client)['networkComponents'].collect { |component_spec| component_spec['template']['networkComponents'][0]['maxSpeed'] }
     end
 
   end # class BareMetalServerOrder

lib/softlayer/BareMetalServerOrder_Package.rb

@@ -58,7 +58,7 @@ class BareMetalServerOrder_Package < Server
 
     # An array of the ids of SSH keys to install on the server upon provisioning
     # To obtain a list of existing SSH keys, call getSshKeys on the SoftLayer_Account service:
-    #     client['Account'].getSshKeys()
+    #     client[:Account].getSshKeys()
     attr_accessor :ssh_key_ids
 
     # The URI of a script to execute on the server after it has been provisioned. This may be
@@ -88,7 +88,7 @@ def initialize(package, client = nil)
     def verify
       product_order = hardware_order
       product_order = yield product_order if block_given?
-      softlayer_client["Product_Order"].verifyOrder(product_order)
+      softlayer_client[:Product_Order].verifyOrder(product_order)
     end
 
     ##
@@ -106,7 +106,7 @@ def verify
     def place_order!
       product_order = hardware_order
       product_order = yield product_order if block_given?
-      softlayer_client["Product_Order"].placeOrder(product_order)
+      softlayer_client[:Product_Order].placeOrder(product_order)
     end
 
     protected

lib/softlayer/Config.rb

@@ -89,7 +89,7 @@ def Config.file_settings(*additional_files)
 			search_path.each do |file_path|
 				if File.readable? file_path
 					config = ConfigParser.new file_path
-					softlayer_section = config["softlayer"]
+					softlayer_section = config['softlayer']
 
 					if softlayer_section
 						result[:username] = softlayer_section['username'] if softlayer_section['username']

lib/softlayer/ImageTemplate.rb

@@ -41,14 +41,14 @@ def rename!(new_name)
     # true if the image template is a flex image
     # Note that the publicFlag property comes back as an integer (0 or 1)
     def public?
-      self["publicFlag"] != 0
+      self['publicFlag'] != 0
     end
 
     ##
     # true if the image template is a flex image
     # Note that the flexImageFlag property comes back as a boolean
     def flex_image?
-      !!self["flexImageFlag"]
+      !!self['flexImageFlag']
     end
 
     ##
@@ -63,7 +63,7 @@ def notes=(new_notes)
     ##
     # Returns an array of the tags set on the image
     def tags
-      return self["tagReferences"].collect{ |tag_reference| tag_reference["tag"]["name"] }
+      return self['tagReferences'].collect{ |tag_reference| tag_reference['tag']['name'] }
     end
 
     ##
@@ -78,7 +78,7 @@ def tags=(tags_array)
     ##
     # Returns the an array containing the datacenters where this image is available.
     def datacenters
-      self["datacenters"].collect{ |datacenter_data| SoftLayer::Datacenter.datacenter_named(datacenter_data["name"])}
+      self['datacenters'].collect{ |datacenter_data| SoftLayer::Datacenter.datacenter_named(datacenter_data['name'])}
     end
 
     ##
@@ -107,7 +107,7 @@ def datacenters=(datacenters_array)
     #
     def available_datacenters
       datacenters_data = self.service.getStorageLocations()
-      datacenters_data.collect { |datacenter_data| SoftLayer::Datacenter.datacenter_named(datacenter_data["name"]) }
+      datacenters_data.collect { |datacenter_data| SoftLayer::Datacenter.datacenter_named(datacenter_data['name']) }
     end
 
 
@@ -116,7 +116,7 @@ def available_datacenters
     # that this image is shared with
     def shared_with_accounts
       accounts_data = self.service.getAccountReferences
-      accounts_data.collect { |account_data| account_data["accountId"] }
+      accounts_data.collect { |account_data| account_data['accountId'] }
     end
 
     ##
@@ -177,7 +177,7 @@ def wait_until_ready(max_trials, seconds_between_tries = 2)
         self.refresh_details()
 
         parent_ready = !(has_sl_property? :transactionId) || (self[:transactionId] == "")
-        children_ready = (nil == self["children"].find { |child| child["transactionId"] != "" })
+        children_ready = (nil == self['children'].find { |child| child['transactionId'] != "" })
 
         ready = parent_ready && children_ready
         yield ready if block_given?
@@ -191,7 +191,7 @@ def wait_until_ready(max_trials, seconds_between_tries = 2)
 
     # ModelBase protocol methods
     def service
-      softlayer_client['Virtual_Guest_Block_Device_Template_Group'].object_with_id(self.id)
+      softlayer_client[:Virtual_Guest_Block_Device_Template_Group].object_with_id(self.id)
     end
 
     def softlayer_properties(object_mask = nil)
@@ -245,7 +245,7 @@ def self.find_private_templates(options_hash = {})
           } );
       end
 
-      account_service = softlayer_client['Account']
+      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)
 
@@ -311,7 +311,7 @@ def self.find_public_templates(options_hash = {})
           } );
       end
 
-      template_service = softlayer_client['Virtual_Guest_Block_Device_Template_Group']
+      template_service = softlayer_client[:Virtual_Guest_Block_Device_Template_Group]
       template_service = template_service.object_filter(object_filter) unless object_filter.empty?
       template_service = template_service.object_mask(default_object_mask)
 
@@ -347,7 +347,7 @@ def self.template_with_id(id, options_hash = {})
       softlayer_client = options_hash[:client] || Client.default_client
       raise "#{__method__} requires a client but none was given and Client::default_client is not set" if !softlayer_client
 
-      service = softlayer_client['Virtual_Guest_Block_Device_Template_Group'].object_with_id(id)
+      service = softlayer_client[:Virtual_Guest_Block_Device_Template_Group].object_with_id(id)
       service.object_mask(default_object_mask)
 
       if options_hash.has_key? :object_mask

lib/softlayer/ModelBase.rb

@@ -47,7 +47,7 @@ def initialize(softlayer_client, network_hash)
     # 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
+    #     softlayer_client[:Ticket].object_with_id
     #
     # which is a service which would allow calls to the ticket service
     # through that particular object.

lib/softlayer/ProductItemCategory.rb

@@ -84,7 +84,7 @@ class ProductItemCategory < ModelBase
     end
 
     def service
-      softlayer_client["SoftLayer_Product_Item_Category"].object_with_id(self.id)
+      softlayer_client[:SoftLayer_Product_Item_Category].object_with_id(self.id)
     end
 
     ##

lib/softlayer/ProductPackage.rb

@@ -65,7 +65,7 @@ class ProductPackage < ModelBase
         # filtering mechanism on the server side to give us a list of the categories, groups, and prices that are valid for the current
         # account at the current time. We construct the ProductItemCategory objects from the results we get back.
         #
-        configuration_data = softlayer_client['Product_Package'].object_with_id(self.id).object_mask("mask[isRequired,itemCategory.categoryCode]").getConfiguration()
+        configuration_data = softlayer_client[:Product_Package].object_with_id(self.id).object_mask("mask[isRequired,itemCategory.categoryCode]").getConfiguration()
 
         # We sort of invert the information and create a map from category codes to a boolean representing
         # whether or not they are required.
@@ -75,7 +75,7 @@ class ProductPackage < ModelBase
         end
 
         # This call to getCategories is the one that does lots of fancy back-end filtering for us
-        categories_data = softlayer_client['Product_Package'].object_with_id(self.id).getCategories()
+        categories_data = softlayer_client[:Product_Package].object_with_id(self.id).getCategories()
 
         # Run though the categories and for each one that's in our config, create a SoftLayer::ProductItemCategory object.
         # Conveniently the +keys+ of the required_by_category_code gives us a list of the category codes in the configuration
@@ -129,7 +129,7 @@ def category(category_code)
     ##
     # Returns a list of the datacenters that this package is available in
     def datacenter_options
-      available_locations.collect { |location_data| Datacenter::datacenter_named(location_data["location"]["name"], self.softlayer_client) }.compact
+      available_locations.collect { |location_data| Datacenter::datacenter_named(location_data['location']['name'], self.softlayer_client) }.compact
     end
 
     ##
@@ -150,7 +150,7 @@ def items_with_description(expected_description)
     # Returns the service for interacting with this package through the network API
     #
     def service
-      softlayer_client['Product_Package'].object_with_id(self.id)
+      softlayer_client[:Product_Package].object_with_id(self.id)
     end
 
     ##
@@ -165,7 +165,7 @@ def self.packages_with_key_name(key_name, client = nil)
         filter.accept('type.keyName').when_it is(key_name)
       end
 
-      filtered_service = softlayer_client['Product_Package'].object_filter(filter).object_mask(self.default_object_mask('mask'))
+      filtered_service = softlayer_client[:Product_Package].object_filter(filter).object_mask(self.default_object_mask('mask'))
       packages_data = filtered_service.getAllObjects
       packages_data.collect { |package_data| ProductPackage.new(softlayer_client, package_data) }
     end
@@ -178,7 +178,7 @@ def self.package_with_id(package_id, client = nil)
       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
 
-      package_data = softlayer_client['Product_Package'].object_with_id(package_id).object_mask(self.default_object_mask('mask')).getObject
+      package_data = softlayer_client[:Product_Package].object_with_id(package_id).object_mask(self.default_object_mask('mask')).getObject
       ProductPackage.new(softlayer_client, package_data)
     end