softlayer_api 3.0.2 → 3.1.0

data/lib/softlayer/BareMetalServerOrder.rb

@@ -78,6 +78,14 @@ module SoftLayer
     # Object responding to to_s and providing a valid URI, The URI of a post provisioning script to run on
     # this server once it is created.
     # Corresponds to +postInstallScriptUri+ in the +createObject+ documentation
+    attr_accessor :provision_script_uri
+
+    # Object responding to to_s and providing a valid URI, The URI of a post provisioning script to run on
+    # this server once it is created.
+    # Corresponds to +postInstallScriptUri+ in the +createObject+ documentation
+    #
+    # DEPRECATION WARNING: This attribute is deprecated in favor of provision_script_uri
+    # and will be removed in the next major release.
     attr_accessor :provision_script_URI
 
     # Boolean, If true then the server will only have a private network interface (and no public network interface)
@@ -93,7 +101,7 @@ module SoftLayer
     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
@@ -149,13 +157,14 @@ module SoftLayer
 
       template['privateNetworkOnlyFlag'] = true if @private_network_only
 
-      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['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['postInstallScriptUri']           = @provision_script_uri.to_s       if @provision_script_uri
+      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['sshKeys']                        = @ssh_key_ids.collect { |ssh_key| {'id'=> ssh_key.to_i } } if @ssh_key_ids
 
       if @disks && !@disks.empty?
         template['hardDrives'] = @disks.collect do |disk|
@@ -195,7 +204,7 @@ module SoftLayer
     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

data/lib/softlayer/BareMetalServerOrder_Package.rb

@@ -42,14 +42,14 @@ module SoftLayer
     # The domain of the server being created (i.e. 'softlayer.com' is the domain of sldn.softlayer.com)
     attr_accessor :domain
 
-    # The value of this property should be a hash. The keys of the hash are ProdcutItemCategory
+    # The value of this property should be a hash. The keys of the hash are ProductItemCategory
     # 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.
     #
-    # 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
 
@@ -65,8 +65,23 @@ module SoftLayer
     # be installed on the server.
     attr_accessor :image_template
 
+    # Integer, The id of the public VLAN this server should join
+    # Corresponds to +primaryNetworkComponent.networkVlan.id+ in the +createObject+ documentation
+    attr_accessor :public_vlan_id
+
+    # Integer, The id of the private VLAN this server should join
+    # Corresponds to +primaryBackendNetworkComponent.networkVlan.id+ in the +createObject+ documentation
+    attr_accessor :private_vlan_id
+
+    # The URI of a script to execute on the server after it has been provisioned. This may be
+    # any object which accepts the to_s message. The resulting string will be passed to SoftLayer API.
+    attr_accessor :provision_script_uri
+
     # The URI of a script to execute on the server after it has been provisioned. This may be
     # any object which accepts the to_s message. The resulting string will be passed to SoftLayer API.
+    #
+    # DEPRECATION WARNING: This attribute is deprecated in favor of provision_script_uri
+    # and will be removed in the next major release.
     attr_accessor :provision_script_URI
 
     # An array of the ids of SSH keys to install on the server upon provisioning
@@ -139,11 +154,14 @@ module SoftLayer
 
       #Note that the use of image_template and SoftLayer::ProductPackage os/guest_diskX configuration category
       #item prices is mutually exclusive.
-      product_order['hardware'][0]['userData']       = @user_metadata                    if @user_metadata
-      product_order['imageTemplateGlobalIdentifier'] = @image_template.global_id         if @image_template
-      product_order['location']                      = @datacenter.id                    if @datacenter
-      product_order['provisionScripts']              = [@provision_script_URI.to_s]      if @provision_script_URI
-      product_order['sshKeys']                       = [{ 'sshKeyIds' => @ssh_key_ids }] if @ssh_key_ids
+      product_order['hardware'][0]['userData']        = @user_metadata                    if @user_metadata
+      product_order['imageTemplateGlobalIdentifier']  = @image_template.global_id         if @image_template
+      product_order['location']                       = @datacenter.id                    if @datacenter
+      product_order['provisionScripts']               = [@provision_script_URI.to_s]      if @provision_script_URI
+      product_order['provisionScripts']               = [@provision_script_uri.to_s]      if @provision_script_uri
+      product_order['sshKeys']                        = [{ 'sshKeyIds' => @ssh_key_ids }] if @ssh_key_ids
+      product_order['primaryNetworkComponent']        = { "networkVlan" => { "id" => @public_vlan_id.to_i } } if @public_vlan_id
+      product_order['primaryBackendNetworkComponent'] = { "networkVlan" => {"id" => @private_vlan_id.to_i } } if @private_vlan_id
 
       product_order['prices'] = @configuration_options.collect do |key, value|
         if value.respond_to?(:price_id)

data/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 @@ module SoftLayer
     # 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 @@ module SoftLayer
 
       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

data/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
   #
@@ -36,14 +36,16 @@ module SoftLayer
   # SoftLayer-Python language bindings).  A simple config file looks something like this:
   #
   #      [softlayer]
-  #      username = joeusername
   #      api_key = DEADBEEFBADF00D
+  #      endpoint_url = 'API_PUBLIC_ENDPOINT'
   #      timeout = 60
+  #      user_agent = "softlayer-ruby x.x.x"
+  #      username = joeusername
   #
   # = 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
@@ -52,7 +54,16 @@ module SoftLayer
   #
   # - +$SL_API_USERNAME+
   # - +$SL_API_KEY+
-  # - +$SL_API_BASE_URL+
+  # - +$SL_API_BASE_URL+ (or alias +$SL_API_ENDPOINT_URL+)
+  #
+  # = XML RPC Variables
+  #
+  # The config allows for two variables that are passed on to the underlying XML RPC agent
+  # for interacting with the SoftLayer API (as with other settings these can be loaded from
+  # config file, environment variables, globals or provided values):
+  #
+  # - +SL_API_TIMEOUT+
+  # - +SL_API_USER_AGENT+
   #
   # = Direct parameters
   #
@@ -60,62 +71,107 @@ module SoftLayer
   # of the key information is provided in that hash, that information will override
   # any discovered through the techniques above.
   #
+  class Config
+    ENDPOINT_URL_ALIAS = [ 'API_PRIVATE_ENDPOINT', 'API_PUBLIC_ENDPOINT' ]
+    FILE_LOCATIONS     = [ '/etc/softlayer.conf', '~/.softlayer', './.softlayer' ]
+
+    def Config.client_settings(provided_settings = {})
+      settings = { :endpoint_url => API_PUBLIC_ENDPOINT }
+
+      settings.merge! file_settings
+      settings.merge! environment_settings
+      settings.merge! globals_settings
+      settings.merge! provided_settings
+
+      settings
+    end
 
-	class Config
-		def Config.globals_settings
-			result = {}
-			result[:username] =  $SL_API_USERNAME if $SL_API_USERNAME
-			result[:api_key] = $SL_API_KEY if $SL_API_KEY
-			result[:endpoint_url] = $SL_API_BASE_URL || API_PUBLIC_ENDPOINT
-			result
-		end
+    def Config.environment_settings
+      result = {}
 
-		def Config.environment_settings
-			result = {}
-			result[:username] =  ENV['SL_USERNAME'] if ENV['SL_USERNAME']
-			result[:api_key] = ENV['SL_API_KEY'] if ENV['SL_API_KEY']
-			result
-		end
+      result[:api_key]      = ENV['SL_API_KEY'] if ENV['SL_API_KEY']
+      result[:user_agent]   = ENV['SL_API_USER_AGENT'] || "softlayer_api gem/#{SoftLayer::VERSION} (Ruby #{RUBY_PLATFORM}/#{RUBY_VERSION})"
+      result[:username]     = ENV['SL_USERNAME'] if ENV['SL_USERNAME']
 
-		FILE_LOCATIONS = ['/etc/softlayer.conf', '~/.softlayer', './.softlayer']
+      if ENV['SL_API_BASE_URL'] && ENDPOINT_URL_ALIAS.include?(ENV['SL_API_BASE_URL'])
+        result[:endpoint_url] = (ENV["SL_API_BASE_URL"] == "API_PUBLIC_ENDPOINT" ? API_PUBLIC_ENDPOINT : API_PRIVATE_ENDPOINT)
+      elsif ENV['SL_API_ENDPOINT_URL'] && ENDPOINT_URL_ALIAS.include?(ENV['SL_API_ENDPOINT_URL'])
+        result[:endpoint_url] = (ENV["SL_API_ENDPOINT_URL"] == "API_PUBLIC_ENDPOINT" ? API_PUBLIC_ENDPOINT : API_PRIVATE_ENDPOINT)
+      elsif (ENV['SL_API_BASE_URL']     && ! ENDPOINT_URL_ALIAS.include?(ENV['SL_API_BASE_URL'])) ||
+            (ENV['SL_API_ENDPOINT_URL'] && ! ENDPOINT_URL_ALIAS.include?(ENV['SL_API_ENDPOINT_URL']))
+        result[:endpoint_url] = ENV['SL_API_BASE_URL'] || ENV['SL_API_ENDPOINT_URL']
+      end
 
-		def Config.file_settings(*additional_files)
-			result = {}
+      begin
+        result[:timeout] = Integer(ENV['SL_API_TIMEOUT']) if ENV['SL_API_TIMEOUT']
+      rescue => integer_parse_exception
+        raise "Expected the value of the timeout configuration property, '#{ENV['SL_API_TIMEOUT']}', to be parseable as an integer"
+      end
 
-			search_path = FILE_LOCATIONS
-			search_path = search_path + additional_files if additional_files
-			search_path = search_path.map { |file_path| File.expand_path(file_path) }
+      result
+    end
 
-			search_path.each do |file_path|
-				if File.readable? file_path
-					config = ConfigParser.new file_path
-					softlayer_section = config['softlayer']
+    def Config.file_settings(*additional_files)
+      result = {}
 
-					if softlayer_section
-						result[:username] = softlayer_section['username'] if softlayer_section['username']
-						result[:endpoint_url] = softlayer_section['endpoint_url'] if softlayer_section['endpoint_url']
-						result[:api_key] = softlayer_section['api_key'] if softlayer_section['api_key']
+      search_path = FILE_LOCATIONS
+      search_path = search_path + additional_files if additional_files
+      search_path = search_path.map { |file_path| File.expand_path(file_path) }
+
+      search_path.each do |file_path|
+        if File.readable? file_path
+          config            = ConfigParser.new file_path
+          softlayer_section = config['softlayer']
+
+          if softlayer_section
+            result[:api_key]      = softlayer_section['api_key'] if softlayer_section['api_key']
+            result[:user_agent]   = softlayer_section['user_agent'] || "softlayer_api gem/#{SoftLayer::VERSION} (Ruby #{RUBY_PLATFORM}/#{RUBY_VERSION})"
+            result[:username]     = softlayer_section['username'] if softlayer_section['username']
+
+            if softlayer_section['base_url'] && ENDPOINT_URL_ALIAS.include?(softlayer_section['base_url'])
+              result[:endpoint_url] = (softlayer_section['base_url'] == "API_PUBLIC_ENDPOINT" ? API_PUBLIC_ENDPOINT : API_PRIVATE_ENDPOINT)
+            elsif softlayer_section['endpoint_url'] && ENDPOINT_URL_ALIAS.include?(softlayer_section['endpoint_url'])
+              result[:endpoint_url] = (softlayer_section['endpoint_url'] == "API_PUBLIC_ENDPOINT" ? API_PUBLIC_ENDPOINT : API_PRIVATE_ENDPOINT)
+            elsif (softlayer_section['base_url']     && ! ENDPOINT_URL_ALIAS.include?(softlayer_section['base_url'])) ||
+                  (softlayer_section['endpoint_url'] && ! ENDPOINT_URL_ALIAS.include?(softlayer_section['endpoint_url']))
+              result[:endpoint_url] = softlayer_section['base_url'] || softlayer_section['endpoint_url']
+            end
 
             begin
-						  result[:timeout] = Integer(softlayer_section['timeout']) if softlayer_section['timeout']
+              result[:timeout] = Integer(softlayer_section['timeout']) if softlayer_section['timeout']
             rescue => integer_parse_exception
-              $stderr.puts "Expected the value of the timeout configuration property, '#{result[:timeout]}', to be parseable as an integer"
+              raise "Expected the value of the timeout configuration property, '#{softlayer_section['timeout']}', to be parseable as an integer"
             end
-					end
-				end
-			end
+          end
+        end
+      end
 
-			result
-		end
+      result
+    end
 
-		def Config.client_settings(provided_settings = {})
-      settings = { :endpoint_url => API_PUBLIC_ENDPOINT }
-			settings.merge! file_settings
-			settings.merge! environment_settings
-			settings.merge! globals_settings
-			settings.merge! provided_settings
-
-			settings
-		end
-	end
+    def Config.globals_settings
+      result = {}
+
+      result[:api_key]      = $SL_API_KEY if $SL_API_KEY
+      result[:user_agent]   = $SL_API_USER_AGENT || "softlayer_api gem/#{SoftLayer::VERSION} (Ruby #{RUBY_PLATFORM}/#{RUBY_VERSION})"
+      result[:username]     = $SL_API_USERNAME if $SL_API_USERNAME
+
+      if $SL_API_ENDPOINT_URL && ENDPOINT_URL_ALIAS.include?($SL_API_ENDPOINT_URL)
+        result[:endpoint_url] = ($SL_API_ENDPOINT_URL == "API_PUBLIC_ENDPOINT" ? API_PUBLIC_ENDPOINT : API_PRIVATE_ENDPOINT)
+      elsif $SL_API_BASE_URL && ENDPOINT_URL_ALIAS.include?($SL_API_BASE_URL)
+        result[:endpoint_url] = ($SL_API_BASE_URL == "API_PUBLIC_ENDPOINT" ? API_PUBLIC_ENDPOINT : API_PRIVATE_ENDPOINT)
+      elsif ($SL_API_BASE_URL     && ! ENDPOINT_URL_ALIAS.include?($SL_API_BASE_URL)) ||
+            ($SL_API_ENDPOINT_URL && ! ENDPOINT_URL_ALIAS.include?($SL_API_ENDPOINT_URL))
+        result[:endpoint_url] = $SL_API_ENDPOINT_URL || $SL_API_BASE_URL
+      end
+
+      begin
+        result[:timeout] = Integer($SL_API_TIMEOUT) if $SL_API_TIMEOUT
+      rescue => integer_parse_exception
+        raise "Expected the value of the timeout configuration property, '#{$SL_API_TIMEOUT}', to be parseable as an integer"
+      end
+
+      result
+    end
+  end
 end

data/lib/softlayer/Datacenter.rb

@@ -17,7 +17,15 @@ module SoftLayer
   # represent.
 
   class Datacenter < SoftLayer::ModelBase
+
+    ##
+    # :attr_reader:
+    # A short location description
     sl_attr :name
+
+    ##
+    # :attr_reader: long_name
+    # A longer location description
     sl_attr :long_name, "longName"
 
     ##
@@ -30,7 +38,7 @@ module SoftLayer
     # 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
@@ -50,4 +58,4 @@ module SoftLayer
       @@data_centers
     end
   end
-end
+end

data/lib/softlayer/DynamicAttribute.rb

@@ -7,7 +7,7 @@
 module SoftLayer
 
   ##
-  # This module is inteneded to be used by classes in the SoftLayer
+  # This module is intended to be used by classes in the SoftLayer
   # object model. It creates a small DSL for creating attributes
   # that update themselves dynamically (usually by making requests
   # to the SoftLayer API)

data/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 unwieldily named
   # +SoftLayer_Virtual_Guest_Block_Device_Template_Group+
   # service:
   #
@@ -23,12 +23,12 @@ module SoftLayer
     sl_attr :name
 
     ##
-    # :attr_reader:
+    # :attr_reader: notes
     # The notes, if any, that are attached to the template. Can be nil.
     sl_attr :notes, "note"
 
     ##
-    # :attr_reader:
+    # :attr_reader: global_id
     # The universally unique identifier (if any) for the template. Can be nil.
     sl_attr :global_id, 'globalIdentifier'
 
@@ -91,7 +91,7 @@ module SoftLayer
     # 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 @@ module SoftLayer
     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
@@ -209,8 +209,17 @@ module SoftLayer
     # If no client can be found the routine will raise an error.
     #
     # 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>+:name+</b>      (string/array) - Return templates with the given name
+    # * <b>+:global_id+</b> (string/array) - Return templates with the given global identifier
+    # * <b>+:tags+</b>      (string/array) - Return templates with the tags
+    #
+    # Additionally you may provide options related to the request itself:
+    #
+    # * <b>*:object_filter*</b> (ObjectFilter)                       - Include private image templates for templates that matche the
+    #                                                                  criteria of this object filter
+    # * <b>+:object_mask+</b>   (string, hash, or array)             - The object mask of properties you wish to receive for the items returned.
+    #                                                                  If not provided, the result will use the default object mask
+    # * <b>+:result_limit+</b>  (hash with :limit, and :offset keys) - Limit the scope of results returned.
     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
@@ -223,8 +232,9 @@ module SoftLayer
       end
 
       option_to_filter_path = {
-        :name => "privateBlockDeviceTemplateGroups.name",
+        :name      => "privateBlockDeviceTemplateGroups.name",
         :global_id => "privateBlockDeviceTemplateGroups.globalIdentifier",
+        :tags      => "privateBlockDeviceTemplateGroups.tagReferences.tag.name"
       }
 
       # For each of the options in the option_to_filter_path map, if the options hash includes
@@ -234,34 +244,17 @@ module SoftLayer
         object_filter.modify { |filter| filter.accept(filter_path).when_it is(options_hash[option])} if options_hash[option]
       end
 
-      # Tags get a much more complex object filter operation so we handle them separately
-      if options_hash.has_key?(:tags)
-        object_filter.set_criteria_for_key_path("privateBlockDeviceTemplateGroups.tagReferences.tag.name", {
-          'operation' => 'in',
-          'options' => [{
-            'name' => 'data',
-            'value' => options_hash[:tags].collect{ |tag_value| tag_value.to_s }
-            }]
-          } );
-      end
-
       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)
+      account_service = account_service.object_mask(options_hash[:object_mask]) if options_hash[:object_mask]
 
-      if options_hash.has_key? :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]
-
-        account_service = account_service.result_limit(offset, limit)
+      if options_hash[:result_limit] && options_hash[:result_limit][:offset] && options_hash[:result_limit][:limit]
+        account_service = account_service.result_limit(options_hash[:result_limit][:offset], options_hash[:result_limit][:limit])
       end
 
       templates_data = account_service.getPrivateBlockDeviceTemplateGroups
-      templates_data.collect { |template_data| new(softlayer_client, template_data) }
+      templates_data.collect { |template_data| ImageTemplate.new(softlayer_client, template_data) }
     end
 
     ##
@@ -275,8 +268,17 @@ module SoftLayer
     # If no client can be found the routine will raise an error.
     #
     # 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>+:name+</b>      (string/array) - Return templates with the given name
+    # * <b>+:global_id+</b> (string/array) - Return templates with the given global identifier
+    # * <b>+:tags+</b>      (string/array) - Return templates with the tags
+    #
+    # Additionally you may provide options related to the request itself:
+    #
+    # * <b>*:object_filter*</b> (ObjectFilter)                       - Include public image templates for templates that matche the
+    #                                                                  criteria of this object filter
+    # * <b>+:object_mask+</b>   (string, hash, or array)             - The object mask of properties you wish to receive for the items returned.
+    #                                                                  If not provided, the result will use the default object mask
+    # * <b>+:result_limit+</b>  (hash with :limit, and :offset keys) - Limit the scope of results returned.
     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
@@ -289,8 +291,9 @@ module SoftLayer
       end
 
       option_to_filter_path = {
-        :name => "name",
+        :name      => "name",
         :global_id => "globalIdentifier",
+        :tags      => "tagReferences.tag.name"
       }
 
       # For each of the options in the option_to_filter_path map, if the options hash includes
@@ -299,39 +302,22 @@ module SoftLayer
       option_to_filter_path.each do |option, filter_path|
         object_filter.modify { |filter| filter.accept(filter_path).when_it is(options_hash[option])} if options_hash[option]
       end
-      
-      # Tags get a much more complex object filter operation so we handle them separately
-      if options_hash.has_key?(:tags)
-        object_filter.set_criteria_for_key_path("tagReferences.tag.name", {
-          'operation' => 'in',
-          'options' => [{
-            'name' => 'data',
-            'value' => options_hash[:tags].collect{ |tag_value| tag_value.to_s }
-            }]
-          } );
-      end
 
       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)
+      template_service = template_service.object_mask(options_hash[:object_mask]) if options_hash[:object_mask]
 
-      if options_hash.has_key? :object_mask
-        template_service = template_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]
-
-        template_service = template_service.result_limit(offset, limit)
+      if options_hash[:result_limit] && options_hash[:result_limit][:offset] && options_hash[:result_limit][:limit]
+        template_service = template_service.result_limit(options_hash[:result_limit][:offset], options_hash[:result_limit][:limit])
       end
 
       templates_data = template_service.getPublicImages
-      templates_data.collect { |template_data| new(softlayer_client, template_data) }
+      templates_data.collect { |template_data| ImageTemplate.new(softlayer_client, template_data) }
     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:
@@ -348,14 +334,11 @@ module SoftLayer
       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.object_mask(default_object_mask)
-
-      if options_hash.has_key? :object_mask
-        service = service.object_mask(options_hash[:object_mask])
-      end
+      service = service.object_mask(default_object_mask)
+      service = service.object_mask(options_hash[:object_mask]) if options_hash[:object_mask]
 
       template_data = service.getObject
-      new(softlayer_client, template_data)
+      ImageTemplate.new(softlayer_client, template_data)
     end
 
     ##
@@ -391,4 +374,4 @@ module SoftLayer
       return "mask[id,accountId,name,note,globalIdentifier,datacenters,blockDevices,tagReferences,publicFlag,flexImageFlag,transactionId,children.transactionId]"
     end
   end
-end
+end