Merge pull request #46 from softlayer/Version_2.2.0

Version 2.2.0 - This build includes the ability to set a network timeout and contains a bug fix for the existing Object Mask parser.

Author: SLsthompson

.gitignore

@@ -5,4 +5,5 @@
 log/
 internal_examples/
 doc/
+coverage/
 Gemfile.lock

CHANGELOG.textile

@@ -1,5 +1,6 @@
 *2.2*
-* Added a method to reboot servers.
+* Added the ability to set a timout for network requests. The timeout is given when a client is created by passing the :timeout hash parameter when creating a client. The value of the parameter is an integer number of seconds.
+* Fixed a bug in VirtualServer#capture_image
 
 *2.1.1*
 * Virtual server upgrades no longer raise exceptions

lib/softlayer/Client.rb

@@ -45,6 +45,11 @@ class Client
 
     # A string passsed 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
+    # until they timeout. This value can be nil in which case the timeout will be the default value for
+    # the library handling network communication (often 30 seconds)
+    attr_reader :network_timeout
 
     ##
     # The client class maintains an (optional) default client. The default client
@@ -66,6 +71,7 @@ def self.default_client=(new_default)
     # * <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>+: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
     #
     # If these arguments are not provided then the client will try to locate them using other
     # sources including global variables, and the SoftLayer config file (if one exists)
@@ -85,6 +91,8 @@ def initialize(options = {})
       @endpoint_url = settings[:endpoint_url] || API_PUBLIC_ENDPOINT
 
       @user_agent = settings[:user_agent] || "softlayer_api gem/#{SoftLayer::VERSION} (Ruby #{RUBY_PLATFORM}/#{RUBY_VERSION})"
+      
+      @network_timeout = settings[:timeout] if settings.has_key?(:timeout)
 
       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?

lib/softlayer/Config.rb

@@ -54,6 +54,7 @@ module SoftLayer
   #      [softlayer]
   #      username = joeusername
   #      api_key = DEADBEEFBADF00D
+  #      timeout = 60
   #
   # = Environment Variables
   #
@@ -110,6 +111,7 @@ def Config.file_settings(*additional_files)
 						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']
+						result[:timeout] = softlayer_section['timeout'] if softlayer_section['timeout']
 					end
 				end
 			end

lib/softlayer/ObjectMaskParser.rb

@@ -58,7 +58,7 @@ def parse(mask_string)
 
       recognize_token(@tokenizer, :eos, "Extraneous text after object mask: ")
 
-      if property && (property.name != "mask" && propertyName != "filterMask")
+      if property && (property.name != "mask" && property.name != "filterMask")
         raise ObjectMaskParserError, "Object Mask must begin with a 'mask' or 'filterMask' root property"
       end
 

lib/softlayer/Service.rb

@@ -296,9 +296,9 @@ def to_ary
 
     def xmlrpc_client()
       if !@xmlrpc_client
-        @xmlrpc_client = XMLRPC::Client.new2(URI.join(@client.endpoint_url,@service_name).to_s)
+        @xmlrpc_client = XMLRPC::Client.new2(URI.join(@client.endpoint_url,@service_name).to_s, nil, @client.network_timeout)
 
-        # this is a workaround for a bug in later versions of the XML-RPC client in Ruby Core.
+        # This is a workaround for a bug in later versions of the XML-RPC client in Ruby Core.
         # see https://bugs.ruby-lang.org/issues/8182
         @xmlrpc_client.http_header_extra = {
           "Accept-Encoding" => "identity",

lib/softlayer/VirtualServer.rb

@@ -143,13 +143,15 @@ def upgrade_max_port_speed!(network_speed_in_Mbps)
     #
     # The image_notes should be a string and will be added to the image as notes.
     #
-    def capture_image(image_name, include_attached_storage = false, image_notes = nil)
+    def capture_image(image_name, include_attached_storage = false, image_notes = '')
+      image_notes = '' if !image_notes
+
       disk_filter = lambda { |disk| disk['device'] == '0' }
-      disk_filter = lambda { |disk| disk['device'] == '1' } if include_attached_storage
+      disk_filter = lambda { |disk| disk['device'] != '1' } if include_attached_storage
 
       disks = self.blockDevices.select(&disk_filter)
 
-      self.service.createArchiveTransaction(image_name, disks, notes) if disks && !disks.empty?
+      self.service.createArchiveTransaction(image_name, disks, image_notes) if disks && !disks.empty?
     end
 
     ##

lib/softlayer/base.rb

@@ -31,7 +31,7 @@
 # - +$SL_API_BASE_URL+- The default URL used to access the SoftLayer API. This defaults to the value of +SoftLayer::API_PUBLIC_ENDPOINT+
 #
 module SoftLayer
-  VERSION = "2.1.1"  # version history in the CHANGELOG.textile file at the root of the source
+  VERSION = "2.2.0"  # version history in the CHANGELOG.textile file at the root of the source
 
   # The base URL of the SoftLayer API available to the public internet.
   API_PUBLIC_ENDPOINT = 'https://api.softlayer.com/xmlrpc/v3/'

spec/Client_spec.rb

@@ -95,6 +95,16 @@
     end.to raise_error
   end
 
+  it 'initializes by default with nil as the timeout' do
+    client = SoftLayer::Client.new(:username => 'fake_user', :api_key => 'fake_key', :endpoint_url => 'http://fakeurl.org/')
+    expect(client.network_timeout).to be_nil
+  end
+
+  it 'Accepts a timeout given as a config parameter' do
+    client = SoftLayer::Client.new(:username => 'fake_user', :api_key => 'fake_key', :endpoint_url => 'http://fakeurl.org/', :timeout => 60)
+    expect(client.network_timeout).to eq 60
+  end
+  
   it 'gets the default endpoint even if none is provided' do
     $SL_API_BASE_URL = nil
     client = SoftLayer::Client.new(:username => 'fake_user', :api_key => 'fake_key')

spec/ObjectMaskParser_spec.rb

@@ -54,6 +54,27 @@
     expect { result = subject.parse("mask[two,children], bob") }.to raise_error
   end
 
+  it "should parse a mask with fiterMask" do
+    result = nil
+    expect { result = subject.parse("filterMask.simple1") }.to_not raise_error
+
+    expect(result.name).to eq 'filterMask'
+    expect(result.children[0].name).to eq 'simple1'
+  end
+  
+  it "should parse a mask set with fiterMask" do
+    result = nil
+    expect { result = subject.parse("[filterMask.simple1, filterMask.simple2]") }.to_not raise_error
+
+    expect(result.count).to eq 2
+    expect(result[0].name).to eq 'filterMask'
+    expect(result[0].children.count).to eq 1
+    expect(result[0].children[0].name).to eq "simple1"
+
+    expect(result[1].name).to eq 'filterMask'
+    expect(result[1].children.count).to eq 1
+    expect(result[1].children[0].name).to eq "simple2"
+  end  
 end
 
 describe SoftLayer::ObjectMaskParser, "#parse_property_set" do