softlayer_api 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 390f9ff4017222664251b8ccf219c01fe051f936
-  data.tar.gz: 7f3bd11e1d5915e3bbe5c1a47602543fa86768a7
+  metadata.gz: 05bc26a020b1873a59356b3f2fd700cf9179e6ee
+  data.tar.gz: b4e61f95ed3f0e01cd9a98e5fddb3a19c6b52ff5
 SHA512:
-  metadata.gz: 204a913bcc8b5f3bb79f3fd591ee32f123b9b9918b9469868b81afee662882af114f88a4fa1774215cfc1e67e1fed08d4a4fcfefecb420bf5b9ba962dab07446
-  data.tar.gz: e425eae9d1a0b3f2fd66434ce014ec67b02234c4451072f9c0f658384d9b8059731b58c95e2e48f2081c29fe68252d069da794a89531a19cfc36efdf43527251
+  metadata.gz: dc7368ecd4e5794452f828071825a957296eb5934856d54d522fa31835234ebf550c9ede65706a534764fdb86396cda7c7eea2a38c1ef991fc0d8ae9561bcfa0
+  data.tar.gz: 992295885ea1fd4f30c064ecf10c5ef53220e373ee4e071ec84f7f0db20ac7582238573761b80168e744aee7d4f72238014898cd3f1fe8e96401201cc17f9502

data/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

data/lib/softlayer/Client.rb

@@ -45,6 +45,11 @@ module SoftLayer
 
     # 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 @@ module SoftLayer
     # * <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 @@ module SoftLayer
       @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?

data/lib/softlayer/Config.rb

@@ -54,6 +54,7 @@ module SoftLayer
   #      [softlayer]
   #      username = joeusername
   #      api_key = DEADBEEFBADF00D
+  #      timeout = 60
   #
   # = Environment Variables
   #
@@ -110,6 +111,7 @@ module SoftLayer
 						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

data/lib/softlayer/ObjectMaskParser.rb

@@ -58,7 +58,7 @@ module SoftLayer
 
       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
 

data/lib/softlayer/Service.rb

@@ -296,9 +296,9 @@ using either client.service_named('<service_name_here>') or client['<service_nam
 
     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",

data/lib/softlayer/VirtualServer.rb

@@ -143,13 +143,15 @@ module SoftLayer
     #
     # 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
 
     ##

data/lib/softlayer/base.rb

@@ -31,7 +31,7 @@ require 'rubygems'
 # - +$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/'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: softlayer_api
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - SoftLayer Development Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-27 00:00:00.000000000 Z
+date: 2014-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: configparser
@@ -86,6 +86,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: The softlayer_api gem offers a convenient mechanism for invoking the
   services of the SoftLayer API from Ruby.
 email: sldn@softlayer.com
@@ -148,5 +162,5 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Library for accessing the SoftLayer portal API
+summary: Library for accessing the SoftLayer API
 test_files: []