softlayer_api 3.2.1 → 3.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04b38f09f536b94748efab61b6883ff8154e6f37
-  data.tar.gz: a85b688249dd6b238e31721a38d079f713ec305a
+  metadata.gz: 7f92616fa3f3d7892a380e75a600df3c4b0e6d1f
+  data.tar.gz: cf11685a6754bc2ac4b1386008ba3953b6bda16f
 SHA512:
-  metadata.gz: 37c5e2e9943594b49abcbf5b83f44f0cd911d07fa25ce2d875743ac16be33f5ca505b59fd7b394cc9d7f1d6571c04c14d00469cab2f657aa118564dfb5e77973
-  data.tar.gz: aa5cde5e62543b5be95987eaddec42ddd16da4f75ad1c3fa8c2cffe75ea1d87fee3e6f2cf99ebaed865a595119c06e833da7f75ad9c413e8c7c1b016166e9501
+  metadata.gz: 70eb92b41aef54b2aa555bff34e071945110d2cd2a0f703f2662fa0546b0ed22cd0e66ae74ece48950e5d843bf4971647d6fb8fc7803174e830ede67644077db
+  data.tar.gz: 5a336a63bdd8504e858e32cc8f6a2512abdc483b82a0c9f580f9820c0978b39f8c8fe73371075ff4ae534a60fc067d531dec6b21fefb5115382bf6edee2f67aa

data/CHANGELOG.textile

@@ -1,5 +1,9 @@
+*3.2.2*
+* Fix NoMethodError when getting the datacenters out of an ImageTemplate and the value was nil.
+* Fix NoMethodError when getting public and private images with a result limit of 1.
+
 *3.2.1*
-Fix a crashing issue where a Bare Metal server order tried to retrieve the hardware ordered before it has been provisioned.
+* Fix a crashing issue where a Bare Metal server order tried to retrieve the hardware ordered before it has been provisioned.
 
 *3.2*
 * Add password-based authentication with `SoftLayer::Client.with_password(username: '...', password: '...', ...)`.

data/examples/order_bare_metal_package.rb

@@ -37,24 +37,26 @@ require 'pp'
 # a server.
 def tl_dr_version
   client = SoftLayer::Client.new(
-    # :username => "joecustomer"              # enter your username here
+    # :username => "joecustomer",            # enter your username here
     # :api_key => "feeddeadbeefbadf00d..."   # enter your api key here
   )
 
   # Select a package
-  quad_intel_package = SoftLayer::ProductPackage.package_with_id(client, 32)
+  product_package = SoftLayer::ProductPackage.package_with_id(251, client)
 
   # Find required Categories and fill config_options with defaults
   config_options = {}
-  required_categories = quad_intel_package.configuration.select { |category| category.required? }
+  required_categories = product_package.configuration.select { |category| category.required? }
   required_categories.each { |required_category| config_options[required_category.categoryCode] = required_category.default_option }
 
-  # Provide a value for missing config categories
-  config_options['server'] = 1417 # price id of Quad Processor Quad Core Intel 7420 - 2.13GHz (Dunnington) - 4 x 6MB / 8MB cache
+  # Provide a value for missing config categories as they don't have defaults
+  config_options['server'] = 50691 # Dual Intel Xeon E5-2620 v3 (12 Cores, 2.40 GHz)
+  config_options['ram'] = 49427 # 64 GB RAM
+  config_options['disk0'] = 49811 # 1.00 TB SATA
 
   # With all the config options in place we can now construct the product order.
-  server_order = SoftLayer::BareMetalServerOrder_Package.new(quad_intel_package, client)
-  server_order.location = 'sng01'
+  server_order = SoftLayer::BareMetalServerOrder_Package.new(product_package, client)
+  server_order.datacenter = SoftLayer::Datacenter.datacenter_named 'sng01', client
   server_order.hostname = 'sample'
   server_order.domain = 'softlayerapi.org'
   server_order.configuration_options = config_options
@@ -69,7 +71,7 @@ end
 
 begin
   client = SoftLayer::Client.new(
-    # :username => "joecustomer"              # enter your username here
+    # :username => "joecustomer",            # enter your username here
     # :api_key => "feeddeadbeefbadf00d..."   # enter your api key here
   )
 
@@ -80,14 +82,14 @@ begin
   packages.each { |package| puts "#{package.id}\t#{package.name}"}
 
   # For this example, we'll assume that we've selected the a package
-  # with an id of 32 representing a "Quad Processor, Quad Core Intel"
-  quad_intel_package = SoftLayer::ProductPackage.package_with_id(32, client)
+  # with an id of 251 representing a "Dual E5-2600 v3 Series (12 Drives)"
+  product_package = SoftLayer::ProductPackage.package_with_id(251, client)
 
   # Now we need to now what ProductItemCategories are required to
   # configure a server in that package. This code prints out a table
   # of the required category codes with a description of each
-  puts "\nRequired Categories for '#{quad_intel_package.name}':"
-  required_categories = quad_intel_package.configuration.select { |category| category.required? }
+  puts "\nRequired Categories for '#{product_package.name}':"
+  required_categories = product_package.configuration.select { |category| category.required? }
   max_code_length = required_categories.inject(0) { |max_code_length, category| [category.categoryCode.length, max_code_length].max }
   printf "%#{max_code_length}s\tCategory Description\n", "Category Code"
   printf "%#{max_code_length}s\t--------------------\n", "-------------"
@@ -96,7 +98,7 @@ begin
   # We will need to provide values for each of the required category codes in our
   # configuration_options. Let's see what configuration options are available for
   # just one of the categories... Say 'os'
-  os_category = quad_intel_package.category('os')
+  os_category = product_package.category('os')
   config_options = os_category.configuration_options
   puts "\nConfiguration options in the 'os' category:"
   config_options.each { |option| printf "%5s\t#{option.description}\n", option.price_id }
@@ -119,20 +121,25 @@ begin
   # Regardless of the default values... we know we want the os selection we discovered above:
   config_options['os'] = os_config_option
 
+  # Provide a value for missing config categories as they don't have defaults
+  config_options['server'] = 50691 # Dual Intel Xeon E5-2620 v3 (12 Cores, 2.40 GHz)
+  config_options['ram'] = 49427 # 64 GB RAM
+  config_options['disk0'] = 49811 # 1.00 TB SATA
+
   # And we can customize the default config by providing selections for any config categories
   # we are interested in
   config_options.merge! ({
-    'server' => 1417, # price id of Quad Processor Quad Core Intel 7420 - 2.13GHz (Dunnington) - 4 x 6MB / 8MB cache
-    'port_speed' => 274 # 1 Gbps Public & Private Network Uplinks
+    'port_speed' => 37220, # 1 Gbps Public & Private Network Uplinks (Unbonded)
+    'bandwidth' => 50233 #  1000 GB Bandwidth
   })
 
   # We have a configuration for the server, we also need a location for the new server.
   # The package can give us a list of locations. Let's print out that list
-  puts "\nData Centers for '#{quad_intel_package.name}':"
-  quad_intel_package.datacenter_options.each { |datacenter| puts "\t#{datacenter.name}"}
+  puts "\nData Centers for '#{product_package.name}':"
+  product_package.datacenter_options.each { |datacenter| puts "\t#{datacenter.name}"}
 
   # With all the config options in place we can now construct the product order.
-  server_order = SoftLayer::BareMetalServerOrder_Package.new(quad_intel_package, client)
+  server_order = SoftLayer::BareMetalServerOrder_Package.new(product_package, client)
   server_order.datacenter = SoftLayer::Datacenter.datacenter_named 'sng01', client
   server_order.hostname = 'sample'
   server_order.domain = 'softlayerapi.org'
@@ -151,4 +158,3 @@ begin
 rescue Exception => exception
   $stderr.puts "An exception occurred while trying to complete the SoftLayer API calls #{exception}"
 end
-

data/lib/softlayer/ImageTemplate.rb

@@ -78,7 +78,9 @@ module SoftLayer
     ##
     # Returns the an array containing the datacenters where this image is available.
     def datacenters
-      self['datacenters'].collect{ |datacenter_data| SoftLayer::Datacenter.datacenter_named(datacenter_data['name'])}
+      Array(self['datacenters']).collect do |datacenter_data|
+        SoftLayer::Datacenter.datacenter_named(datacenter_data['name'])
+      end
     end
 
     ##
@@ -253,7 +255,7 @@ module SoftLayer
         account_service = account_service.result_limit(options_hash[:result_limit][:offset], options_hash[:result_limit][:limit])
       end
 
-      templates_data = account_service.getPrivateBlockDeviceTemplateGroups
+      templates_data = Array(account_service.getPrivateBlockDeviceTemplateGroups)
       templates_data.collect { |template_data| ImageTemplate.new(softlayer_client, template_data) }
     end
 
@@ -312,7 +314,9 @@ module SoftLayer
         template_service = template_service.result_limit(options_hash[:result_limit][:offset], options_hash[:result_limit][:limit])
       end
 
-      templates_data = template_service.getPublicImages
+      # Ensure this is an array with Array(). SL won't return array if the result set is of just one
+      # (like when the user specifies a limit of 1)
+      templates_data = Array(template_service.getPublicImages)
       templates_data.collect { |template_data| ImageTemplate.new(softlayer_client, template_data) }
     end
 

data/lib/softlayer/ProductPackage.rb

@@ -45,7 +45,7 @@ module SoftLayer
     ##
     # :attr_reader: available_locations
     # The list of locations where this product package is available.
-    sl_attr :available_locations, 'availableLocations'
+    sl_attr :available_locations, 'regions'
 
     ##
     # Retrieve the set of product categories needed to make an order for this product package.
@@ -230,7 +230,7 @@ module SoftLayer
                                            "groups.prices.requiredCoreCount" ].join(",") + "]"
 
     def self.default_object_mask(root)
-      "#{root}[id,name,description,availableLocations.location]"
+      "#{root}[id,name,description,regions]"
     end
   end
 end # SoftLayer

data/lib/softlayer/Service.rb

@@ -14,9 +14,11 @@ ensure
   $VERBOSE = old_verbose
 end
 
-# enable parsing of "nil" values in structures returned from the API
 with_warnings(nil) {
+  # enable parsing of "nil" values in structures returned from the API
   XMLRPC::Config.const_set('ENABLE_NIL_PARSER', true)
+  # enable serialization of "nil" values in structures sent to the API
+  XMLRPC::Config.const_set('ENABLE_NIL_CREATE', true)
 }
 
 # The XML-RPC spec calls for the "faultCode" in faults to be an integer

data/lib/softlayer/VirtualDiskImage.rb

@@ -188,6 +188,35 @@ module SoftLayer
       softlayer_client[:Virtual_Disk_Image].object_with_id(self.id)
     end
 
+    ##
+    # Retrieve the virtual disk image with the given image ID from the API
+    #
+    # 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.
+    #
+    # The options may include the following keys
+    # * <b>+:object_mask+</b> (string) - A object mask of properties, in addition to the default properties, that you wish to retrieve for the image
+    #
+    def self.image_with_id(image_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
+
+      vdi_service = softlayer_client[:Virtual_Disk_Image]
+      vdi_service = vdi_service.object_mask(default_object_mask.to_sl_object_mask)
+
+      if options.has_key?(:object_mask)
+        vdi_service = vdi_service.object_mask(options[:object_mask])
+      end
+
+      image_data = vdi_service.object_with_id(image_id).getObject()
+
+      return VirtualDiskImage.new(softlayer_client, image_data)
+    end
+
     protected
 
     def self.default_object_mask

data/lib/softlayer/base.rb

@@ -12,7 +12,7 @@ require 'rubygems'
 module SoftLayer
   # The version number (including major, minor, and bugfix numbers)
   # This should change in accordance with the concept of Semantic Versioning
-  VERSION = "3.2.1"  # version history in the CHANGELOG.textile file at the root of the source
+  VERSION = "3.2.2"  # 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: 3.2.1
+  version: 3.2.2
 platform: ruby
 authors:
 - SoftLayer Development Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-19 00:00:00.000000000 Z
+date: 2017-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: configparser
@@ -86,20 +86,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.99.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.99.3
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.7.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.7.2
 description: The softlayer_api gem offers a convenient mechanism for invoking the
   services of the SoftLayer API from Ruby.
 email: sldn@softlayer.com
@@ -183,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Library for accessing the SoftLayer API