Added the ability to set a default client so that you can make calls without having to provide it repeatedly

resolves #22

Author: easco

examples/account_info.rb

@@ -1,5 +1,3 @@
-$LOAD_PATH << File.join(File.dirname(__FILE__), "../lib" )
-
 #
 # Copyright (c) 2014 SoftLayer Technologies, Inc. All rights reserved.
 #

examples/account_servers.rb

@@ -1,5 +1,3 @@
-$LOAD_PATH << File.join(File.dirname(__FILE__), "../lib" )
-
 #
 # Copyright (c) 2014 SoftLayer Technologies, Inc. All rights reserved.
 #
@@ -25,29 +23,26 @@
 require 'rubygems'
 require 'softlayer_api'
 require 'pp'
-
-begin
-  client = SoftLayer::Client.new(
+  
+  # We can set the default client to be our client and that way 
+  # we can avoid supplying it later
+  SoftLayer::Client.default_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)
-  
+
+  account = SoftLayer::Account.account_for_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| 
+  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
+  end

examples/order_bare_metal_package.rb

@@ -53,7 +53,7 @@ def tl_dr_version
   config_options['server'] = 1417 # price id of Quad Processor Quad Core Intel 7420 - 2.13GHz (Dunnington) - 4 x 6MB / 8MB cache
 
   # With all the config options in place we can now construct the product order.
-  server_order = SoftLayer::BareMetalServerOrder_Package.new(client, quad_intel_package)
+  server_order = SoftLayer::BareMetalServerOrder_Package.new(quad_intel_package, client)
   server_order.location = 'sng01'
   server_order.hostname = 'sample'
   server_order.domain = 'softlayerapi.org'
@@ -132,7 +132,7 @@ def tl_dr_version
   quad_intel_package.datacenter_options.each { |location| puts "\t#{location}"}
 
   # With all the config options in place we can now construct the product order.
-  server_order = SoftLayer::BareMetalServerOrder_Package.new(client, quad_intel_package)
+  server_order = SoftLayer::BareMetalServerOrder_Package.new(quad_intel_package, client)
   server_order.datacenter = 'sng01'
   server_order.hostname = 'sample'
   server_order.domain = 'softlayerapi.org'

examples/order_bare_metal_server.rb

@@ -1,5 +1,3 @@
-$LOAD_PATH << File.join(File.dirname(__FILE__), "../lib")
-
 #
 # Copyright (c) 2014 SoftLayer Technologies, Inc. All rights reserved.
 #
@@ -55,7 +53,7 @@ def tl_dr_version
   config_options['server'] = 1417 # price id of Quad Processor Quad Core Intel 7420 - 2.13GHz (Dunnington) - 4 x 6MB / 8MB cache
 
   # With all the config options in place we can now construct the product order.
-  server_order = SoftLayer::BareMetalServerOrder_Package.new(client, quad_intel_package)
+  server_order = SoftLayer::BareMetalServerOrder_Package.new(quad_intel_package, client)
   server_order.location = 'FIRST_AVAILABLE'
   server_order.hostname = 'sample'
   server_order.domain = 'softlayer_api.org'
@@ -136,7 +134,7 @@ def tl_dr_version
   quad_intel_package.locations.each { |location| printf "%#{max_key_length}s\t\t#{location[:description]}\n",location[:keyname]}
 
   # With all the config options in place we can now construct the product order.
-  server_order = SoftLayer::BareMetalServerOrder_Package.new(client, quad_intel_package)
+  server_order = SoftLayer::BareMetalServerOrder_Package.new(quad_intel_package, client)
   server_order.location = 'FIRST_AVAILABLE'
   server_order.hostname = 'sample'
   server_order.domain = 'softlayer_api.org'

examples/order_virtual_server.rb

@@ -1,5 +1,3 @@
-$LOAD_PATH << File.join(File.dirname(__FILE__), "../lib")
-
 #
 # Copyright (c) 2014 SoftLayer Technologies, Inc. All rights reserved.
 #

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

@@ -91,7 +91,7 @@ class Account < SoftLayer::ModelBase
 
       bare_metal.to_update do
         @last_bare_metal_update = Time.now
-        BareMetalServer.find_servers(self.softlayer_client)
+        BareMetalServer.find_servers(:client => self.softlayer_client)
       end
     end
 
@@ -109,7 +109,7 @@ class Account < SoftLayer::ModelBase
 
       virtual_servers.to_update do
         @last_virtual_server_update = Time.now
-        VirtualServer.find_servers(self.softlayer_client)
+        VirtualServer.find_servers(:client => self.softlayer_client)
       end
     end
 
@@ -140,12 +140,15 @@ class Account < SoftLayer::ModelBase
     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.
     #
-    def self.account_for_client(softlayer_client)
+    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']
       network_hash = account_service.getObject()
       new(softlayer_client, network_hash)

lib/softlayer/BareMetalServer.rb

@@ -122,7 +122,17 @@ 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 = {})
+    #
+    # The options parameter should contain:
+    #
+    # <b>+:client+</b> - The client used to connect to the API
+    #
+    # If no client is given, then the routine will try to use Client.default_client
+    # If no client can be found the routine will raise an error.
+    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 = hardware_service.object_mask(default_object_mask.to_sl_object_mask)
 
@@ -138,6 +148,13 @@ def self.server_with_id(softlayer_client, server_id, options = {})
     ##
     # Retrieve a list of Bare Metal servers from the account
     #
+    # The options parameter should contain:
+    #
+    # <b>+:client+</b> - The client used to connect to the API
+    #
+    # If no client is given, then the routine will try to use Client.default_client
+    # If no client can be found the routine will raise an error.
+    #
     # You may filter the list returned by adding options:
     #
     # * <b>+:tags+</b> (array) - an array of strings representing tags to search for on the instances
@@ -155,7 +172,10 @@ def self.server_with_id(softlayer_client, server_id, options = {})
     # * <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_servers(softlayer_client, options_hash = {})
+    def self.find_servers(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
+
       if(options_hash.has_key? :object_filter)
         object_filter = options_hash[:object_filter]
       else

lib/softlayer/BareMetalServerOrder.rb

@@ -111,8 +111,9 @@ class BareMetalServerOrder
 
     ##
     # Create a new order that works thorugh the given client connection
-    def initialize (client)
-      @softlayer_client = client
+    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
     end
 
     ##
@@ -141,7 +142,7 @@ def place_order!()
       order_template = yield order_template if block_given?
 
       server_hash = @softlayer_client["Hardware"].createObject(order_template)
-      SoftLayer::BareMetalServer.server_with_id(@softlayer_client, server_hash["id"]) if server_hash
+      SoftLayer::BareMetalServer.server_with_id(server_hash["id"], :client => @softlayer_client) if server_hash
     end
 
     protected
@@ -185,35 +186,40 @@ def hardware_instance_template
     ##
     # The first time this is called it requests SoftLayer_Hardware::getCreateObjectOptions
     # from the API and remembers the result. On subsequent calls it returns the remembered result.
-    def self.create_object_options(client)
-      @@create_object_options ||= client["Hardware"].getCreateObjectOptions()
+    def self.create_object_options(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
+
+      @@create_object_options ||= nil
+      @@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)
+    def self.datacenter_options(client = nil)
       create_object_options(client)["datacenters"].collect { |datacenter_spec| datacenter_spec['template']['datacenter']["name"] }.uniq.sort!
     end
 
-    def self.core_options(client)
+    def self.core_options(client = nil)
       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)
+    def self.disk_options(client = nil)
       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)
+    def self.os_reference_code_options(client = nil)
       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)
+    def self.max_port_speed_options(client = nil)
       create_object_options(client)["networkComponents"].collect { |component_spec| component_spec['template']['networkComponents'][0]['maxSpeed'] }
     end
 

lib/softlayer/BareMetalServerOrder_Package.rb

@@ -83,8 +83,10 @@ class BareMetalServerOrder_Package < Server
     ##
     # You initialize a BareMetalServerOrder_Package by passing in the package that you
     # are ordering from.
-    def initialize(client, package)
-      @softlayer_client = client
+    def initialize(package, 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 = package
       @configuration_options = []
     end