Cleanup syntax case across classes to better follow Ruby style guide.

This addresses issues raised in #99.

We fix most of the case issues and mark the old ones as deprecated and for removal with v4.

v4-cleanup-required

Author: ju2wheels

lib/softlayer/Account.rb

@@ -8,19 +8,43 @@ module SoftLayer
   class Account < SoftLayer::ModelBase
     include ::SoftLayer::DynamicAttribute
 
+    ##
+    # :attr_reader: company_name
+    # The company name of the primary contact
+    sl_attr :company_name, 'companyName'
+
     ##
     # :attr_reader:
     # The company name of the primary contact
+    #
+    # DEPRECATION WARNING: This attribute is deprecated in favor of company_name
+    # and will be removed in the next major release.
     sl_attr :companyName
 
+    ##
+    # :attr_reader: first_name
+    # The given name name of the primary contact
+    sl_attr :first_name, 'firstName'
+
     ##
     # :attr_reader:
     # The given name name of the primary contact
+    #
+    # DEPRECATION WARNING: This attribute is deprecated in favor of first_name
+    # and will be removed in the next major release.
     sl_attr :firstName
 
+    ##
+    # :attr_reader: last_name
+    # The surname of the primary contact
+    sl_attr :last_name, 'lastName'
+
     ##
     # :attr_reader:
     # The surname of the primary contact
+    #
+    # DEPRECATION WARNING: This attribute is deprecated in favor of last_name
+    # and will be removed in the next major release.
     sl_attr :lastName
 
     ##
@@ -51,14 +75,30 @@ class Account < SoftLayer::ModelBase
     # The country stored as part of the primary contact's address
     sl_attr :country
 
+    ##
+    # :attr_reader: postal_code
+    # The postal code (in the US, aka. zip code) of the primary contact's address
+    sl_attr :postal_code, 'postalCode'
+
     ##
     # :attr_reader:
     # The postal code (in the US, aka. zip code) of the primary contact's address
+    #
+    # DEPRECATION WARNING: This attribute is deprecated in favor of postal_code
+    # and will be removed in the next major release.
     sl_attr :postalCode
 
+    ##
+    # :attr_reader: office_phone
+    # The office phone number listed for the primary contact
+    sl_attr :office_phone, 'officePhone'
+
     ##
     # :attr_reader:
     # The office phone number listed for the primary contact
+    #
+    # DEPRECATION WARNING: This attribute is deprecated in favor of office_phone
+    # and will be removed in the next major release.
     sl_attr :officePhone
 
     ##

lib/softlayer/NetworkComponent.rb

@@ -6,9 +6,31 @@
 
 module SoftLayer
   class NetworkComponent < SoftLayer::ModelBase
+    ##
+    # :attr_reader: max_speed
+    # A network component's maximum allowed speed,
+    sl_attr :max_speed, 'maxSpeed'
+
+    ##
+    # :attr_reader:
+    # A network component's maximum allowed speed,
+    #
+    # DEPRECATION WARNING: This attribute is deprecated in favor of max_speed
+    # and will be removed in the next major release.
+    sl_attr :maxSpeed
+
+    ##
+    # :attr_reader:
+    # A network component's short name.
     sl_attr :name
+
+    # :attr_reader:
+    # A network component's port number.
     sl_attr :port
+
+    ##
+    # :attr_reader: 
+    # A network component's speed, measured in Mbit per second.
     sl_attr :speed
-    sl_attr :maxSpeed
   end
 end

lib/softlayer/ProductItemCategory.rb

@@ -10,16 +10,22 @@ 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)
       self.capacity    = package_item_data['capacity']
       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,6 +36,16 @@ def initialize(package_item_data, price_item_data)
       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 configuration option has no fees associated with it.
@@ -51,10 +67,19 @@ def free?
   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
 
     ##

lib/softlayer/ProductPackage.rb

@@ -127,7 +127,7 @@ def required_categories
     ##
     # 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
 
     ##

lib/softlayer/Server.rb

@@ -28,9 +28,17 @@ class Server  < SoftLayer::ModelBase
     # The domain name SoftLayer has stored for the server
     sl_attr :domain
 
+    ##
+    # :attr_reader: fully_qualified_domain_name
+    # A convenience attribute that combines the hostname and domain name
+    sl_attr :fully_qualified_domain_name, 'fullyQualifiedDomainName'
+
     ##
     # :attr_reader:
     # A convenience attribute that combines the hostname and domain name
+    #
+    # DEPRECATION WARNING: This attribute is deprecated in favor of fully_qualified_domain_name
+    # and will be removed in the next major release.
     sl_attr :fullyQualifiedDomainName
 
     ##

lib/softlayer/Ticket.rb

@@ -17,9 +17,17 @@ class Ticket < SoftLayer::ModelBase
     # The ticket system maintains a fixed set of subjects for tickets that are used to ensure tickets make it to the right folks quickly
     sl_attr :subject
 
+    ##
+    # :attr_reader: last_edited
+    # The date the ticket was last updated.
+    sl_attr :last_edited, 'lastEditDate'
+
     ##
     # :attr_reader:
     # The date the ticket was last updated.
+    #
+    # DEPRECATION WARNING: This attribute is deprecated in favor of last_edited
+    # and will be removed in the next major release.
     sl_attr :lastEditDate
 
     ##

lib/softlayer/VLANFirewall.rb

@@ -20,11 +20,19 @@ module SoftLayer
   class VLANFirewall < SoftLayer::ModelBase
     include ::SoftLayer::DynamicAttribute
 
+    ##
+    # :attr_reader: vlan_number
+    #
+    # The number of the VLAN protected by this firewall.
+    sl_attr :vlan_number, 'vlanNumber'
+
     ##
     # :attr_reader: VLAN_number
     #
     # The number of the VLAN protected by this firewall.
     #
+    # DEPRECATION WARNING: This attribute is deprecated in favor of vlan_number
+    # and will be removed in the next major release.
     sl_attr :VLAN_number, 'vlanNumber'
 
     ##
@@ -54,13 +62,37 @@ class VLANFirewall < SoftLayer::ModelBase
     ##
     # Returns the name of the primary router the firewall is attached to.
     # This is often a "customer router" in one of the datacenters.
+    def primary_router
+      return self['primaryRouter']['hostname']
+    end
+
+    ##
+    # Returns the name of the primary router the firewall is attached to.
+    # This is often a "customer router" in one of the datacenters.
+    #
+    # DEPRECATION WARNING: This method is deprecated in favor of primary_router
+    # and will be removed in the next major release.
     def primaryRouter
       return self['primaryRouter']['hostname']
     end
 
     ##
     # The fully qualified domain name of the physical device the
     # firewall is implemented by.
+    def fully_qualified_domain_name
+      if self.has_sl_property?('networkVlanFirewall')
+        return self['networkVlanFirewall']['fullyQualifiedDomainName']
+      else
+        return @softlayer_hash
+      end
+    end
+
+    ##
+    # The fully qualified domain name of the physical device the
+    # firewall is implemented by.
+    #
+    # DEPRECATION WARNING: This method is deprecated in favor of fully_qualified_domain_name
+    # and will be removed in the next major release.
     def fullyQualifiedDomainName
       if self.has_sl_property?('networkVlanFirewall')
         return self['networkVlanFirewall']['fullyQualifiedDomainName']

lib/softlayer/VirtualServer.rb

@@ -21,34 +21,76 @@ class VirtualServer < Server
     # to the server.
     sl_attr :cores, 'maxCpu'
 
+    ##
+    # :attr_reader: provision_date
+    # The date the Virtual Server was provisioned.  This attribute can be
+    # nil if the SoftLayer system has not yet finished provisioning the
+    # server (consequently this attribute is used by the #wait_until_ready
+    # method to determine when a server has been provisioned)
+    sl_attr :provision_date, 'provisionDate'
+
     ##
     # :attr_reader:
     # The date the Virtual Server was provisioned.  This attribute can be
     # nil if the SoftLayer system has not yet finished provisioning the
     # server (consequently this attribute is used by the #wait_until_ready
     # method to determine when a server has been provisioned)
+    #
+    # DEPRECATION WARNING: This attribute is deprecated in favor of provision_date
+    # and will be removed in the next major release.
     sl_attr :provisionDate
 
+    ##
+    # :attr_reader: active_transaction
+    # The active transaction (if any) for this virtual server. Transactions
+    # are used to make configuration changes to the server and only one
+    # transaction can be active at a time.
+    sl_attr :active_transaction, 'activeTransaction'
+
     ##
     # :attr_reader:
     # The active transaction (if any) for this virtual server. Transactions
     # are used to make configuration changes to the server and only one
     # transaction can be active at a time.
+    #
+    # DEPRECATION WARNING: This attribute is deprecated in favor of active_transaction
+    # and will be removed in the next major release.
     sl_attr :activeTransaction
 
+    ##
+    # :attr_reader: block_devices
+    # Storage devices attached to the server. Storage may be local
+    # to the host running the Virtual Server, or it may be located
+    # on the SAN
+    sl_attr :block_devices, 'blockDevices'
+
     ##
     # :attr_reader:
     # Storage devices attached to the server. Storage may be local
     # to the host running the Virtual Server, or it may be located
     # on the SAN
+    #
+    # DEPRECATION WARNING: This attribute is deprecated in favor of block_devices
+    # and will be removed in the next major release.
     sl_attr :blockDevices
 
+    ##
+    # :attr_reader: last_operating_system_reload
+    # The last operating system reload transaction that was
+    # run for this server. #wait_until_ready compares the
+    # ID of this transaction to the ID of the active transaction
+    # to determine if an OS reload is in progress.
+    sl_attr :last_operating_system_reload, 'lastOperatingSystemReload'
+
     ##
     # :attr_reader:
     # The last operating system reload transaction that was
     # run for this server. #wait_until_ready compares the
     # ID of this transaction to the ID of the active transaction
     # to determine if an OS reload is in progress.
+    #
+    # DEPRECATION WARNING: This attribute is deprecated in favor of last_operating_system_reload
+    # and will be removed in the next major release.
     sl_attr :lastOperatingSystemReload
 
     ##
@@ -130,7 +172,7 @@ def wait_until_ready(max_trials, wait_for_transactions = false, seconds_between_
         has_os_reload = has_sl_property? :lastOperatingSystemReload
         has_active_transaction = has_sl_property? :activeTransaction
 
-        reloading_os = has_active_transaction && has_os_reload && (self.lastOperatingSystemReload['id'] == self.activeTransaction['id'])
+        reloading_os = has_active_transaction && has_os_reload && (self.last_operating_system_reload['id'] == self.active_transaction['id'])
         provisioned = has_sl_property?(:provisionDate) && ! self['provisionDate'].empty?
 
         # a server is ready when it is provisioned, not reloading the OS