Correct various minor spelling errors.

cmarkle · cmarkle · commit 5166c2b942db · 2015-04-29T14:50:38.000-07:00
diff --git a/lib/softlayer/Account.rb b/lib/softlayer/Account.rb
@@ -58,7 +58,7 @@ class Account < SoftLayer::ModelBase
 
     ##
     # :attr_reader:
-    # The office phone nubmer listed for the primary contact
+    # The office phone number listed for the primary contact
     sl_attr :officePhone
 
     ##
@@ -108,7 +108,7 @@ class Account < SoftLayer::ModelBase
     end
 
     ##
-    # Retrieve an account's network message delivery acounts.
+    # Retrieve an account's network message delivery accounts.
     sl_dynamic_attr :network_message_delivery_accounts do |net_msg_deliv_accts|
       net_msg_deliv_accts.should_update? do
         @network_message_delivery_accounts == nil
diff --git a/lib/softlayer/BareMetalServer.rb b/lib/softlayer/BareMetalServer.rb
@@ -9,7 +9,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 roughly to the +SoftLayer_Hardware+ and
   # +SoftLayer_Hardware_Server+ services in the SoftLayer API
   #
   # http://sldn.softlayer.com/reference/datatypes/SoftLayer_Hardware
@@ -23,7 +23,7 @@ class BareMetalServer < Server
     # a Bare Metal Instance is physical, hardware server that is is provisioned to
     # match a profile with characteristics similar to a Virtual Server
     #
-    # This is an important distincition in rare cases, like cancelling the server.
+    # This is an important distinction in rare cases, like cancelling the server.
     #
     def bare_metal_instance?
       if has_sl_property?(:bareMetalInstanceFlag)
@@ -65,7 +65,7 @@ def remote_management_accounts
     # Returns the typical 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.  That
-    # service object is available thorugh the hardware_server_service method
+    # service object is available through the hardware_server_service method
     def service
       return softlayer_client[:Hardware_Server].object_with_id(self.id)
     end
@@ -146,7 +146,7 @@ def firewall_port_speed
     end
 
     ##
-    # Retrive the bare metal server with the given server ID from the
+    # Retrieve the bare metal server with the given server ID from the
     # SoftLayer API
     #
     # The options parameter should contain:
diff --git a/lib/softlayer/BareMetalServerOrder.rb b/lib/softlayer/BareMetalServerOrder.rb
@@ -93,7 +93,7 @@ class BareMetalServerOrder
     attr_accessor :max_port_speed
 
     ##
-    # Create a new order that works thorugh the given client connection
+    # Create a new order that works through the given client connection
     def initialize (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
@@ -195,7 +195,7 @@ def self.disk_options(client = nil)
     end
 
     ##
-    # Returns a list of the valid :os_refrence_codes
+    # Returns a list of the valid :os_reference_codes
     def self.os_reference_code_options(client = nil)
       create_object_options(client)['operatingSystems'].collect { |os_spec| os_spec['template']['operatingSystemReferenceCode'] }.uniq.sort!
     end
diff --git a/lib/softlayer/BareMetalServerOrder_Package.rb b/lib/softlayer/BareMetalServerOrder_Package.rb
@@ -49,7 +49,7 @@ class BareMetalServerOrder_Package < Server
     # that is the +id+ of a +SoftLayer_Product_Item_Price+. Instances of the ProductConfigurationOption
     # class behave this way.
     #
-    # At a minimum, the configuation_options should include entries for each of the categories
+    # At a minimum, the configuration_options should include entries for each of the categories
     # required by the package (i.e. those returned from ProductPackage#required_categories)
     attr_accessor :configuration_options
 
diff --git a/lib/softlayer/Client.rb b/lib/softlayer/Client.rb
@@ -6,7 +6,7 @@
 
 module SoftLayer
   # A client is responsible for storing authentication information for API calls and
-  # it serves as a centeral repository for the Service instances that call into the
+  # it serves as a central repository for the Service instances that call into the
   # network API.
   #
   # When you create a client, you pass in hash arguments specifying how the client
@@ -21,16 +21,16 @@ module SoftLayer
   # class to provide the missing information.  Please see that class for details.
   #
   class Client
-    # A username passed as authentication for each request. Cannot be emtpy or nil.
+    # A username passed as authentication for each request. Cannot be empty or nil.
     attr_reader :username
 
-    # An API key passed as part of the authentication of each request. Cannot be emtpy or nil.
+    # An API key passed as part of the authentication of each request. Cannot be empty or nil.
     attr_reader :api_key
 
-    # The base URL for requests that are passed to the server. Cannot be emtpy or nil.
+    # The base URL for requests that are passed to the server. Cannot be empty or nil.
     attr_reader :endpoint_url
 
-    # A string passsed as the value for the User-Agent header when requests are sent to SoftLayer API.
+    # A string passed as the value for the User-Agent header when requests are sent to SoftLayer API.
     attr_accessor :user_agent
 
     # An integer value (in seconds). The number of seconds to wait for HTTP requests to the network API
@@ -63,7 +63,7 @@ def self.default_client=(new_default)
     # Clients are built with a number of settings:
     # * <b>+:username+</b> - The username of the account you wish to access through the API
     # * <b>+:api_key+</b> - The API key used to authenticate the user with the API
-    # * <b>+:enpoint_url+</b> - The API endpoint the client should connect to.  This defaults to API_PUBLIC_ENDPOINT
+    # * <b>+:endpoint_url+</b> - The API endpoint the client should connect to.  This defaults to API_PUBLIC_ENDPOINT
     # * <b>+:user_agent+</b> - A string that is passed along as the user agent when the client sends requests to the server
     # * <b>+:timeout+</b> - An integer number of seconds to wait until network requests time out.  Corresponds to the network_timeout property of the client
     #
@@ -92,7 +92,7 @@ def initialize(options = {})
 
       raise "A SoftLayer Client requires a username" if !@username || @username.empty?
       raise "A SoftLayer Client requires an api_key" if !@api_key || @api_key.empty?
-      raise "A SoftLayer Clietn requires an enpoint URL" if !@endpoint_url || @endpoint_url.empty?
+      raise "A SoftLayer Client requires an endpoint URL" if !@endpoint_url || @endpoint_url.empty?
     end
 
     # return a hash of the authentication headers for the client
diff --git a/lib/softlayer/Config.rb b/lib/softlayer/Config.rb
@@ -11,7 +11,7 @@ module SoftLayer
   # The SoftLayer Config class is responsible for providing the key information
   # the library needs to communicate with the network SoftLayer API. Those three crucial
   # pieces of information are the Username, the API Key, and the endpoint_url. This information
-  # is collected in a hash with the keys `:username`, `:api_key`, and `:endpoint_url` repsectively.
+  # is collected in a hash with the keys `:username`, `:api_key`, and `:endpoint_url` respectively.
   #
   # The routine used to retrieve this information from a Config object is Config.client_settings
   #
@@ -43,7 +43,7 @@ module SoftLayer
   # = Environment Variables
   #
   # The config class will search the environment variables SL_USERNAME and SL_API_KEY for
-  # the username and API key respectively. The endpoint_url may not be set thorugh
+  # the username and API key respectively. The endpoint_url may not be set through
   # environment variables.
   #
   # = Global Variables
diff --git a/lib/softlayer/Datacenter.rb b/lib/softlayer/Datacenter.rb
@@ -38,7 +38,7 @@ def self.datacenter_named(name, client = nil)
     # Return a list of all the datacenters
     #
     # If the client parameter is not provided, the routine
-    # will try to use Client::defult_client.  If no client
+    # will try to use Client::default_client.  If no client
     # can be found, the routine will raise an exception
     #
     # This routine will only retrieve the list of datacenters from
diff --git a/lib/softlayer/ImageTemplate.rb b/lib/softlayer/ImageTemplate.rb
@@ -9,7 +9,7 @@ module SoftLayer
   ##
   # A Virtual Server Image Template.
   #
-  # This class rougly corresponds to the unwieldily named
+  # This class roughly corresponds to the unwieldy named
   # +SoftLayer_Virtual_Guest_Block_Device_Template_Group+
   # service:
   #
@@ -91,7 +91,7 @@ def datacenters
     # appear in this array! The list given must be comprehensive.
     #
     # The available_datacenters call returns a list of the values that are valid
-    # whithin this array.
+    # within this array.
     def datacenters=(datacenters_array)
       datacenter_data = datacenters_array.collect do |datacenter|
         { "id" => datacenter.id }
@@ -160,7 +160,7 @@ def delete!
     end
 
     ##
-    # Repeatedly poll the netwokr API until transactions related to this image
+    # Repeatedly poll the network API until transactions related to this image
     # template are finished
     #
     # A template is not 'ready' until all the transactions on the template
@@ -210,7 +210,7 @@ def softlayer_properties(object_mask = nil)
     #
     # Additional options that may be provided:
     # * <b>+:name+</b> (string) - Return templates with the given name
-    # * <b>+:global_id+</b> (string) - Return templates with the given global identfier
+    # * <b>+:global_id+</b> (string) - Return templates with the given global identifier
     def self.find_private_templates(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
@@ -276,7 +276,7 @@ def self.find_private_templates(options_hash = {})
     #
     # Additional options that may be provided:
     # * <b>+:name+</b> (string) - Return templates with the given name
-    # * <b>+:global_id+</b> (string) - Return templates with the given global identfier
+    # * <b>+:global_id+</b> (string) - Return templates with the given global identifier
     def self.find_public_templates(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
@@ -331,7 +331,7 @@ def self.find_public_templates(options_hash = {})
     end
 
     ##
-    # Retrive the Image Template with the given ID
+    # Retrieve the Image Template with the given ID
     # (Note! This is the service ID, not the globalIdentifier!)
     #
     # The options parameter should contain:
diff --git a/lib/softlayer/ModelBase.rb b/lib/softlayer/ModelBase.rb
@@ -69,7 +69,7 @@ def refresh_details(object_mask = nil)
     ##
     # Returns the value of of the given property as stored in the
     # softlayer_hash. This gives you access to the low-level, raw
-    # properties that underly this model object.  The need for this
+    # properties that underlie this model object.  The need for this
     # is not uncommon, but using this method should still be done
     # with deliberation.
     def [](softlayer_property)
@@ -107,7 +107,7 @@ def to_ary()
 
     ##
     # Subclasses should implement this method as part of enabling the
-    # refresh_details fuctionality The implementation should make a request
+    # refresh_details functionality The implementation should make a request
     # to the SoftLayer API and retrieve an up-to-date SoftLayer hash
     # representation of this object. That hash should be the return value
     # of this routine.
diff --git a/lib/softlayer/NetworkStorageGroup.rb b/lib/softlayer/NetworkStorageGroup.rb
@@ -81,7 +81,7 @@ class NetworkStorageGroup < ModelBase
     end
 
     ##
-    # The description of theSoftLayer_Network_Storage_OS_Type Operating System designation that this group was created for.
+    # The description of the SoftLayer_Network_Storage_OS_Type Operating System designation that this group was created for.
     sl_dynamic_attr :os_description do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -95,7 +95,7 @@ class NetworkStorageGroup < ModelBase
     end
 
     ##
-    # The name of theSoftLayer_Network_Storage_OS_Type Operating System designation that this group was created for.
+    # The name of the SoftLayer_Network_Storage_OS_Type Operating System designation that this group was created for.
     sl_dynamic_attr :os_name do |resource|
       resource.should_update? do
         #only retrieved once per instance
diff --git a/lib/softlayer/ObjectFilter.rb b/lib/softlayer/ObjectFilter.rb
@@ -115,7 +115,7 @@ def when_it(criteria)
   # 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.
   #
@@ -153,7 +153,7 @@ def self.ends_with(value)
       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
diff --git a/lib/softlayer/ObjectMaskParser.rb b/lib/softlayer/ObjectMaskParser.rb
@@ -138,4 +138,4 @@ def recognize_token(tokenizer, expected_type, error_string, &predicate)
     end
 
   end
-end # Module SoftLaye
+end # Module SoftLayer
diff --git a/lib/softlayer/ProductItemCategory.rb b/lib/softlayer/ProductItemCategory.rb
@@ -32,7 +32,7 @@ def initialize(package_item_data, price_item_data)
       self.setupFee                   = price_item_data['setupFee']                   ? price_item_data['setupFee'].to_f              : 0.0
     end
 
-    # returns true if the configurtion option has no fees associated with it.
+    # returns true if the configuration option has no fees associated with it.
     def free?
       self.setupFee == 0 && self.laborFee == 0 && self.oneTimeFee == 0 && self.recurringFee == 0 && self.hourlyRecurringFee == 0
     end
@@ -46,7 +46,7 @@ def free?
   # of a ProductPackage object. There should not be a need to create instances
   # of this class directly.
   #
-  # This class rougly represents entities in the +SoftLayer_Product_Item_Category+
+  # This class roughly represents entities in the +SoftLayer_Product_Item_Category+
   # service.
   class ProductItemCategory < ModelBase
     include ::SoftLayer::DynamicAttribute
diff --git a/lib/softlayer/ProductPackage.rb b/lib/softlayer/ProductPackage.rb
@@ -111,7 +111,7 @@ class ProductPackage < ModelBase
         # that are required)
         self.configuration
 
-        # return the value constructed by the configuraiton
+        # return the value constructed by the configuration
         @categories
       end
     end
diff --git a/lib/softlayer/Server.rb b/lib/softlayer/Server.rb
@@ -97,7 +97,7 @@ def initialize(softlayer_client, network_hash)
     # Reboot the server.  This action is taken immediately.
     # Servers can be rebooted in three different ways:
     # :default_reboot - (Try soft, then hard) Attempts to reboot a server using the :os_reboot technique then, if that is not successful, tries the :power_cycle method
-    # :os_reboot - (aka. soft rebot) instructs the server's host operating system to reboot
+    # :os_reboot - (aka. soft reboot) instructs the server's host operating system to reboot
     # :power_cycle - (aka. hard reboot) The actual (for hardware) or metaphorical (for virtual servers) equivalent to pulling the plug on the server then plugging it back in.
     def reboot!(reboot_technique = :default_reboot)
       case reboot_technique
diff --git a/lib/softlayer/ServerFirewall.rb b/lib/softlayer/ServerFirewall.rb
@@ -12,7 +12,7 @@ module SoftLayer
   #
   # This is also called a "Shared Firewall" in some documentation.
   #
-  # Instances of this class rougly correspond to instances of the
+  # Instances of this class roughly correspond to instances of the
   # SoftLayer_Network_Component_Firewall service entity.
   #
 	class ServerFirewall < SoftLayer::ModelBase
diff --git a/lib/softlayer/Service.rb b/lib/softlayer/Service.rb
@@ -70,7 +70,7 @@ module SoftLayer
   #     => {... lots of information here representing the list of open tickets ...}
   #
   class Service
-    # The name of the service that this object calls. Cannot be emtpy or nil.
+    # The name of the service that this object calls. Cannot be empty or nil.
     attr_reader :service_name
     attr_reader :client
 
diff --git a/lib/softlayer/Software.rb b/lib/softlayer/Software.rb
@@ -110,7 +110,7 @@ def delete_user_password!(username)
     end
 
     ##
-    # Returns whether or not one of the Software Passowrd instances pertains to the specified user
+    # Returns whether or not one of the Software Password instances pertains to the specified user
     #
     def has_user_password?(username)
       self.passwords.map { |sw_pw| sw_pw.username }.include?(username)
diff --git a/lib/softlayer/UserCustomerExternalBinding.rb b/lib/softlayer/UserCustomerExternalBinding.rb
@@ -74,7 +74,7 @@ class UserCustomerExternalBinding < ModelBase
     end
 
     ##
-    # Returns the service for interacting with this user customer extnerla binding
+    # Returns the service for interacting with this user customer external binding
     # through the network API
     #
     def service
diff --git a/lib/softlayer/VLANFirewall.rb b/lib/softlayer/VLANFirewall.rb
@@ -210,7 +210,7 @@ def self.find_firewalls(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
 
-      # only VLAN firewallas have a networkVlanFirewall component
+      # only VLAN firewalls have a networkVlanFirewall component
       vlan_firewall_filter = SoftLayer::ObjectFilter.new() { |filter|
         filter.accept("networkVlans.networkVlanFirewall").when_it is_not_null
       }
diff --git a/lib/softlayer/VLANFirewallOrder.rb b/lib/softlayer/VLANFirewallOrder.rb
@@ -14,7 +14,7 @@ class VLANFirewallOrder
     attr_reader :vlan_id
 
     ##
-    # Set high_availabilty to true if you want redundant
+    # Set high_availability to true if you want redundant
     # firewall devices (defaults to false, no high_availability)
     attr_accessor :high_availability
 
diff --git a/lib/softlayer/VirtualServer.rb b/lib/softlayer/VirtualServer.rb
@@ -17,7 +17,7 @@ class VirtualServer < Server
 
     ##
     # :attr_reader: cores
-    # A count of the nubmer of virtual processing cores allocated
+    # A count of the number of virtual processing cores allocated
     # to the server.
     sl_attr :cores, 'maxCpu'
 
@@ -148,7 +148,7 @@ def wait_until_ready(max_trials, wait_for_transactions = false, seconds_between_
     end
 
     ##
-    # Retrive the virtual server with the given server ID from the API
+    # Retrieve the virtual server with the given server ID from the API
     #
     # The options parameter should contain:
     #
diff --git a/lib/softlayer/VirtualServerOrder.rb b/lib/softlayer/VirtualServerOrder.rb
@@ -102,7 +102,7 @@ class VirtualServerOrder
     # Corresponds to +primaryBackendNetworkComponent.networkVlan.id+ in the +createObject+ documentation
     attr_accessor :user_metadata
 
-    # Create a new order that works thorugh the given client connection
+    # Create a new order that works through the given client connection
     def initialize (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
@@ -232,7 +232,7 @@ def self.disk_options(client = nil)
     end
 
     ##
-    # Returns a list of the valid :os_refrence_codes
+    # Returns a list of the valid :os_reference_codes
     def self.os_reference_code_options(client = nil)
       create_object_options(client)['operatingSystems'].collect { |os_spec| os_spec['template']['operatingSystemReferenceCode'] }.uniq.sort!
     end
diff --git a/lib/softlayer/VirtualServerOrder_Package.rb b/lib/softlayer/VirtualServerOrder_Package.rb
diff --git a/lib/softlayer/VirtualServerUpgradeOrder.rb b/lib/softlayer/VirtualServerUpgradeOrder.rb
diff --git a/lib/softlayer/object_mask_helpers.rb b/lib/softlayer/object_mask_helpers.rb

Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ class BareMetalServerOrder_Package < Server`
`49`	`49`	`# that is the +id+ of a +SoftLayer_Product_Item_Price+. Instances of the ProductConfigurationOption`
`50`	`50`	`# class behave this way.`
`51`	`51`	`#`
`52`		`- # At a minimum, the configuation_options should include entries for each of the categories`
	`52`	`+ # At a minimum, the configuration_options should include entries for each of the categories`
`53`	`53`	`# required by the package (i.e. those returned from ProductPackage#required_categories)`
`54`	`54`	`attr_accessor :configuration_options`
`55`	`55`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ module SoftLayer`
`11`	`11`	`# The SoftLayer Config class is responsible for providing the key information`
`12`	`12`	`# the library needs to communicate with the network SoftLayer API. Those three crucial`
`13`	`13`	`# pieces of information are the Username, the API Key, and the endpoint_url. This information`
`14`		- # is collected in a hash with the keys `:username`, `:api_key`, and `:endpoint_url` repsectively.
	`14`	+ # is collected in a hash with the keys `:username`, `:api_key`, and `:endpoint_url` respectively.
`15`	`15`	`#`
`16`	`16`	`# The routine used to retrieve this information from a Config object is Config.client_settings`
`17`	`17`	`#`
`@@ -43,7 +43,7 @@ module SoftLayer`
`43`	`43`	`# = Environment Variables`
`44`	`44`	`#`
`45`	`45`	`# The config class will search the environment variables SL_USERNAME and SL_API_KEY for`
`46`		`- # the username and API key respectively. The endpoint_url may not be set thorugh`
	`46`	`+ # the username and API key respectively. The endpoint_url may not be set through`
`47`	`47`	`# environment variables.`
`48`	`48`	`#`
`49`	`49`	`# = Global Variables`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ def self.datacenter_named(name, client = nil)`
`38`	`38`	`# Return a list of all the datacenters`
`39`	`39`	`#`
`40`	`40`	`# If the client parameter is not provided, the routine`
`41`		`- # will try to use Client::defult_client. If no client`
	`41`	`+ # will try to use Client::default_client. If no client`
`42`	`42`	`# can be found, the routine will raise an exception`
`43`	`43`	`#`
`44`	`44`	`# This routine will only retrieve the list of datacenters from`