softlayer_api 2.2.2 → 3.0.b1

data/lib/softlayer/VirtualServerOrder.rb

@@ -1,24 +1,8 @@
-#
+#--
 # Copyright (c) 2014 SoftLayer Technologies, Inc. All rights reserved.
 #
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-#
+# For licensing information see the LICENSE.md file in the project root.
+#++
 
 module SoftLayer
   #
@@ -38,9 +22,7 @@ module SoftLayer
     # a virtual server
     #++
 
-    # String, short name of the data center that will house the new virtual server (e.g. "dal05" or "sea01")
-    # Corresponds to +datacenter.name+ in the documentation for createObject.  If not provided, the server will
-    # be provisioned in the first available data center.
+    # An instance of SoftLayer::Datacenter.  The server will be provisioned in that Datacenter.
     attr_accessor :datacenter
 
     # String, The hostname to assign to the new server
@@ -58,17 +40,18 @@ module SoftLayer
     attr_accessor :memory
 
     #--
-    # These two options are mutually exclusive, but one or the other must be provided.
-    # If you provide both, the image_global_id will be added to the order and the os_reference_code will be ignored
+    # These two options are mutually exclusive, but one of them must be provided.
+    # If you provide both, the image_template will be added to the order and the
+    # os_reference_code will be ignored
     #++
 
     # String, An OS reference code for the operating system to install on the virtual server
     # Corresponds to +operatingSystemReferenceCode+ in the +createObject+ documentation
     attr_accessor :os_reference_code
 
-    # String, The globalIdentifier of a disk image to put on the newly created server
-    # Corresponds to +blockDeviceTemplateGroup.globalIdentifier+ in the +createObject+ documentation
-    attr_accessor :image_global_id
+    # An instance of the SoftLayer::ImageTemplate class.  Represents the image template that should
+    # be installed on the server.
+    attr_accessor :image_template
 
     #--
     # Optional attributes
@@ -173,7 +156,7 @@ module SoftLayer
       template["dedicatedAccountHostOnlyFlag"] = true if @dedicated_host_only
       template["privateNetworkOnlyFlag"] = true if @private_network_only
 
-      template["datacenter"] = {"name" => @datacenter} if @datacenter
+      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
@@ -181,8 +164,8 @@ module SoftLayer
       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
 
-      if @image_global_id
-          template["blockDeviceTemplateGroup"] = {"globalIdentifier" => @image_global_id}
+      if @image_template
+          template["blockDeviceTemplateGroup"] = {"globalIdentifier" => @image_template.global_id}
       elsif @os_reference_code
           template["operatingSystemReferenceCode"] = @os_reference_code
       end
@@ -227,7 +210,7 @@ module SoftLayer
     ##
     # Return a list of values that are valid for the :datacenter attribute
     def self.datacenter_options(client = nil)
-      create_object_options(client)["datacenters"].collect { |datacenter_spec| datacenter_spec['template']['datacenter']["name"] }.uniq.sort!
+      create_object_options(client)["datacenters"].collect { |datacenter_spec| Datacenter.datacenter_named(datacenter_spec['template']['datacenter']['name'], client) }.uniq
     end
 
     ##

data/lib/softlayer/VirtualServerUpgradeOrder.rb

@@ -0,0 +1,142 @@
+#--
+# Copyright (c) 2014 SoftLayer Technologies, Inc. All rights reserved.
+#
+# For licensing information see the LICENSE.md file in the project root.
+#++
+
+module SoftLayer
+  # This class is used to order changes to a virtual server.  Although
+  # the class is named "upgrade" this class can also be used for "downgrades"
+  # (i.e. changing attributes to a smaller, or slower, value)
+  #
+  # The class can also be used to discover what upgrades are available
+  # for a given virtual server.
+  #
+  class VirtualServerUpgradeOrder
+    # The virtual server that this order is designed to upgrade.
+    attr_reader :virtual_server
+    
+    # The number of cores the server should have after the upgrade.
+    # If this is nil, the the number of cores will not change
+    attr_accessor :cores
+    
+    # The amount of RAM (in GB) that the server should have after the upgrade
+    # If this is nil, the ram will not change
+    attr_accessor :ram
+    
+    # The port speed (in Mega bits per second) that the server should have
+    # after the upgrade.  This is typically a value like 100, or 1000
+    # If this is nil, the port speeds will not change
+    attr_accessor :max_port_speed
+    
+    # The date and time when you would like the upgrade to be processed.
+    # This should simply be a Time object.  If nil then the upgrade
+    # will be performed immediately
+    attr_accessor :upgrade_at
+    
+    ##
+    # Create an upgrade order for the virtual server provided.
+    #
+    def initialize(virtual_server)
+      raise "A virtual server must be provided at the time a virtual server order is created" if !virtual_server || !virtual_server.kind_of?(SoftLayer::VirtualServer)
+      @virtual_server = virtual_server
+    end
+
+    ##
+    # Sends the order represented by this object to SoftLayer for validation.
+    #
+    # If a block is passed to verify, the code will send the order template
+    # being constructed to the block before the order is actually sent for
+    # validation.
+    #
+    def verify()
+      if has_order_items?
+        order_object = self.order_object
+        order_object = yield order_object if block_given?
+
+        @virtual_server.softlayer_client["Product_Order"].verifyOrder(order_object)
+      end
+    end
+
+    ##
+    # Places the order represented by this object.  This is likely to 
+    # involve a change to the charges on an account.
+    #
+    # If a block is passed to this routine, the code will send the order template
+    # being constructed to that block before the order is sent
+    #
+    def place_order!()
+      if has_order_items?
+        order_object = self.order_object
+        order_object = yield order_object if block_given?
+
+        @virtual_server.softlayer_client["Product_Order"].placeOrder(order_object)
+      end
+    end
+
+    ##
+    # Return a list of values that are valid for the :cores attribute
+    def core_options()
+      self._item_prices_in_category("guest_core").map { |item_price| item_price["item"]["capacity"].to_i}.sort.uniq
+    end
+
+    ##
+    # Return a list of values that are valid for the :memory attribute
+    def memory_options()
+      self._item_prices_in_category("ram").map { |item_price| item_price["item"]["capacity"].to_i}.sort.uniq
+    end
+
+    ##
+    # Returns a list of valid values for max_port_speed
+    def max_port_speed_options(client = nil)
+      self._item_prices_in_category("port_speed").map { |item_price| item_price["item"]["capacity"].to_i}.sort.uniq
+    end
+
+    private
+
+    ##
+    # Returns true if this order object has any upgrades specified
+    #
+    def has_order_items?
+      @cores != nil || @ram != nil || @max_port_speed != nil
+    end
+
+    ##
+    # Returns a list of the update item prices, in the given category, for the server
+    #
+    def _item_prices_in_category(which_category)
+      @virtual_server.upgrade_options.select { |item_price| item_price["categories"].find { |category| category["categoryCode"] == which_category } }
+    end
+    
+    ##
+    # Searches through the upgrade items pricess known to this server for the one that is in a particular category
+    # and whose capacity matches the value given. Returns the item_price or nil
+    #
+    def _item_price_with_capacity(which_category, capacity)
+      self._item_prices_in_category(which_category).find { |item_price| item_price["item"]["capacity"].to_i == capacity}
+    end
+    
+    ## 
+    # construct an order object
+    #
+    def order_object
+      prices = []
+      
+      cores_price_item = @cores ? _item_price_with_capacity("guest_core", @cores) : nil
+      ram_price_item = @ram ? _item_price_with_capacity("ram", @ram) : nil
+      max_port_speed_price_item = @max_port_speed ? _item_price_with_capacity("port_speed", @max_port_speed) : nil
+      
+      prices << { "id" => cores_price_item["id"] } if cores_price_item
+      prices << { "id" => ram_price_item["id"] } if ram_price_item
+      prices << { "id" => max_port_speed_price_item["id"] } if max_port_speed_price_item
+
+      # put together an order
+      upgrade_order = {
+        'complexType' => 'SoftLayer_Container_Product_Order_Virtual_Guest_Upgrade',
+        'virtualGuests' => [{'id' => @virtual_server.id }],
+        'properties' => [{'name' => 'MAINTENANCE_WINDOW', 'value' => @upgrade_at ? @upgrade_at.iso8601 : Time.now.iso8601}],
+        'prices' => prices
+      }
+    end
+  end # VirtualServerUpgradeOrder
+end # SoftLayer Module

data/lib/softlayer/base.rb

@@ -1,37 +1,18 @@
-#
+#--
 # Copyright (c) 2014 SoftLayer Technologies, Inc. All rights reserved.
 #
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-#
+# For licensing information see the LICENSE.md file in the project root.
+#++
 
 require 'rubygems'
 
-# This module is used to provide a namespace for SoftLayer code. It also declares a number of
-# global variables:
-# - +$SL_API_USERNAME+ - The default username passed by clients to the server for authentication.
-#   Set this if you want to use the same username for all clients and don't want to have to specify it when the client is created
-# - +$SL_API_KEY+ - The default API key passed by clients to the server for authentication.
-#   Set this if you want to use the same api for all clients and don't want to have to specify it when the client is created
-# - +$SL_API_BASE_URL+- The default URL used to access the SoftLayer API. This defaults to the value of +SoftLayer::API_PUBLIC_ENDPOINT+
+##
+# The SoftLayer module provides a namespace for SoftLayer code.
 #
 module SoftLayer
-  VERSION = "2.2.2"  # version history in the CHANGELOG.textile file at the root of the source
+  # The version number (including major, minor, and bugfix numbers)
+  # This should change in accordance with the concept of Semantic Versioning
+  VERSION = "3.0.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/'
@@ -39,9 +20,9 @@ module SoftLayer
   # The base URL of the SoftLayer API available through SoftLayer's private network
   API_PRIVATE_ENDPOINT = 'https://api.service.softlayer.com/xmlrpc/v3/'
 
-  #
+  #--
   # These globals can be used to simplify client creation
-  #
+  #++
 
   # Set this if you want to provide a default username for each client as it is created.
   # usernames provided to the client initializer will override the global
@@ -59,4 +40,4 @@ end # module SoftLayer
 #
 # History:
 #
-# The history has been moved to the CHANGELOG.textile file in the source directory
+# The history can be found in the CHANGELOG.textile file in the project root directory

data/lib/softlayer/object_mask_helpers.rb

@@ -1,24 +1,8 @@
-#
+#--
 # Copyright (c) 2014 SoftLayer Technologies, Inc. All rights reserved.
 #
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-#
+# For licensing information see the LICENSE.md file in the project root.
+#++
 
 ##
 # This extension to the Hash class to allows object masks to be constructed

data/lib/softlayer_api.rb

@@ -1,45 +1,35 @@
-#
+#--
 # Copyright (c) 2014 SoftLayer Technologies, Inc. All rights reserved.
 #
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-#
+# For licensing information see the LICENSE.md file in the project root.
+#++
 
+# requirements from the core libraries
+require 'time'
+
+# Requirements for the Foundation Layer
 require 'softlayer/base'
 require 'softlayer/object_mask_helpers'
 require 'softlayer/APIParameterFilter'
 require 'softlayer/ObjectFilter'
 require 'softlayer/ObjectMaskParser'
 require 'softlayer/Config'
-
 require 'softlayer/Client'
 require 'softlayer/Service'
 
-# model classes
+# Requirements for the Model Layer
 require 'softlayer/ModelBase'
+require 'softlayer/Datacenter'
 require 'softlayer/DynamicAttribute'
 require 'softlayer/Account'
-require 'softlayer/Ticket'
 require 'softlayer/Server'
 require 'softlayer/BareMetalServer'
 require 'softlayer/BareMetalServerOrder'
 require 'softlayer/BareMetalServerOrder_Package'
+require 'softlayer/ImageTemplate'
 require 'softlayer/ProductPackage'
 require 'softlayer/ProductItemCategory'
+require 'softlayer/Ticket'
 require 'softlayer/VirtualServer'
 require 'softlayer/VirtualServerOrder'
+require 'softlayer/VirtualServerUpgradeOrder'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: softlayer_api
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 3.0.b1
 platform: ruby
 authors:
 - SoftLayer Development Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-18 00:00:00.000000000 Z
+date: 2014-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: configparser
@@ -122,7 +122,9 @@ files:
 - lib/softlayer/BareMetalServerOrder_Package.rb
 - lib/softlayer/Client.rb
 - lib/softlayer/Config.rb
+- lib/softlayer/Datacenter.rb
 - lib/softlayer/DynamicAttribute.rb
+- lib/softlayer/ImageTemplate.rb
 - lib/softlayer/ModelBase.rb
 - lib/softlayer/ObjectFilter.rb
 - lib/softlayer/ObjectMaskParser.rb
@@ -136,6 +138,7 @@ files:
 - lib/softlayer/Ticket.rb
 - lib/softlayer/VirtualServer.rb
 - lib/softlayer/VirtualServerOrder.rb
+- lib/softlayer/VirtualServerUpgradeOrder.rb
 - lib/softlayer/base.rb
 - lib/softlayer/object_mask_helpers.rb
 - lib/softlayer_api.rb
@@ -154,9 +157,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2