softlayer_api 3.0.0 → 3.0.1

data/lib/softlayer/VirtualServer.rb

@@ -131,7 +131,7 @@ module SoftLayer
         has_active_transaction = has_sl_property? :activeTransaction
 
         reloading_os = has_active_transaction && has_os_reload && (self.lastOperatingSystemReload['id'] == self.activeTransaction['id'])
-        provisioned = has_sl_property? :provisionDate
+        provisioned = has_sl_property?(:provisionDate) && ! self['provisionDate'].empty?
 
         # a server is ready when it is provisioned, not reloading the OS
         # (and if wait_for_transactions is true, when there are no active transactions).
@@ -313,4 +313,4 @@ module SoftLayer
       return softlayer_client[:Virtual_Guest].object_with_id(self.id)
     end
   end #class VirtualServer
-end
+end

data/lib/softlayer/VirtualServerOrder_Package.rb

@@ -0,0 +1,161 @@
+#--
+# 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 a virtual server using a product package.
+  #
+  # Ordering a server using a product package is a more complex process than
+  # ordering with simple attributes (as is done by the VirtualServerServerOrder class).
+  # However with that complexity comes the the ability to specify the configuration
+  # of the server in exacting detail.
+  #
+  # To use this class, you first select a product package. The product package
+  # defines the base configuration of the server as well as the set of configuration
+  # options available for that server. To fully configure the server you must select
+  # the value for each configuration option.
+  #
+  # This class roughly Corresponds to the SoftLayer_Container_Product_Order_Virtual_Guest
+  # data type in the SoftLayer API
+  #
+  # http://sldn.softlayer.com/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Guest
+  #
+  class VirtualServerOrder_Package < Server
+    # The following properties are required in a server order.
+
+    # The product package object (an instance of SoftLayer::ProductPackage) identifying the base
+    # configuration for the server. A Virtual Server product package is returned by
+    # SoftLayer::ProductPackage.virtual_server_package
+    attr_reader :package
+
+    # An instance of SoftLayer::Datacenter. The server will be provisioned in this data center.
+    # The set of datacenters available is determined by the package and may be obtained from
+    # the SoftLayer::ProductPackage object using the #datacenter_options method.
+    attr_accessor :datacenter
+
+    # The hostname of the server being created (i.e. 'sldn' is the hostname of sldn.softlayer.com).
+    attr_accessor :hostname
+
+    # The domain of the server being created (i.e. 'softlayer.com' is the domain of sldn.softlayer.com)
+    attr_accessor :domain
+
+    # The value of this property should be a hash. The keys of the hash are ProdcutItemCategory
+    # codes (like 'os' and 'ram') while the values may be Integers or Objects. The Integer values
+    # should be the +id+ of a +SoftLayer_Product_Item_Price+ representing the configuration option
+    # chosen for that category. Objects must respond to the +price_id+ message and return an integer
+    # that is the +id+ of a +SoftLayer_Product_Item_Price+. Instances of the ProductConfigurationOption
+    # class behave this way.
+    #
+    # At a minimum, the configuation_options should include entries for each of the categories
+    # required by the package (i.e. those returned from ProductPackage#required_categories)
+    attr_accessor :configuration_options
+
+    # The following properties are optional, but allow further fine tuning of
+    # the server
+
+    # Boolean, If true, an hourly server will be ordered, otherwise a monthly server will be ordered
+    # Corresponds to +useHourlyPricing+ in the SoftLayer_Container_Product_Order_Virtual_Guest container
+    # documentation
+    attr_accessor :hourly
+
+    # An instance of the SoftLayer::ImageTemplate class.  Represents the image template that should
+    # be installed on the server.
+    attr_accessor :image_template
+
+    # The URI of a script to execute on the server after it has been provisioned. This may be
+    # any object which accepts the to_s message. The resulting string will be passed to SoftLayer API.
+    attr_accessor :provision_script_URI
+
+    # An array of the ids of SSH keys to install on the server upon provisioning
+    # To obtain a list of existing SSH keys, call getSshKeys on the SoftLayer_Account service:
+    #     client[:Account].getSshKeys()
+    attr_accessor :ssh_key_ids
+
+    # String, User metadata associated with the instance
+    # Corresponds to +userData+ in the +SoftLayer_Virtual_Guest+ documentation
+    attr_accessor :user_metadata
+
+    ##
+    # You initialize a VirtualServerOrder_Package by passing in the package that you
+    # are ordering from.
+    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
+
+      @configuration_options = []
+      @package               = SoftLayer::ProductPackage.virtual_server_package(@softlayer_client)
+    end
+
+    ##
+    # Present the order for verification by the SoftLayer ordering system.
+    # The order is verified, but not executed. This should not
+    # change the billing of your account.
+    #
+    # If you add a block to the method call, it will receive the product
+    # order template before it is sent to the API. You may **carefully** make
+    # changes to the template to provide specialized configuration.
+    #
+    def verify
+      product_order = virtual_server_order
+      product_order = yield product_order if block_given?
+      softlayer_client[:Product_Order].verifyOrder(product_order)
+    end
+
+    ##
+    # Submit the order to be executed by the SoftLayer ordering system.
+    # If successful this will probably result in additional billing items
+    # applied to your account!
+    #
+    # If you add a block to the method call, it will receive the product
+    # order template before it is sent to the API. You may **carefully** make
+    # changes to the template to provide specialized configuration.
+    #
+    # The return value of this call is a product order receipt. After
+    # submitting the order, it will proceed to Sales for authorization.
+    #
+    def place_order!
+      product_order = virtual_server_order
+      product_order = yield product_order if block_given?
+      softlayer_client[:Product_Order].placeOrder(product_order)
+    end
+
+    protected
+
+    ##
+    # Construct and return a hash representing a +SoftLayer_Container_Product_Order_Virtual_Guest+
+    # based on the configuration options given.
+    def virtual_server_order
+      product_order = {
+        'packageId'        => @package.id,
+        'useHourlyPricing' => !!@hourly,
+        'virtualGuests'    => [{
+                                 'domain'   => @domain,
+                                 'hostname' => @hostname
+                               }]
+      }
+
+      #Note that the use of image_template and SoftLayer::ProductPackage os/guest_diskX configuration category
+      #item prices is mutually exclusive.
+      product_order['imageTemplateGlobalIdentifier'] = @image_template.global_id         if @image_template
+      product_order['location']                      = @datacenter.id                    if @datacenter
+      product_order['provisionScripts']              = [@provision_script_URI.to_s]      if @provision_script_URI
+      product_order['sshKeys']                       = [{ 'sshKeyIds' => @ssh_key_ids }] if @ssh_key_ids
+      product_order['virtualGuests'][0]['userData']  = @user_metadata                    if @user_metadata
+
+      product_order['prices'] = @configuration_options.collect do |key, value|
+        if value.respond_to?(:price_id)
+          price_id = value.price_id
+        else
+          price_id = value.to_i
+        end
+
+        { 'id' => price_id }
+      end
+
+      product_order
+    end
+  end # VirtualServerOrder_Package
+end # SoftLayer

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.0.0"  # version history in the CHANGELOG.textile file at the root of the source
+  VERSION = "3.0.1"  # 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/'

data/lib/softlayer_api.rb

@@ -22,19 +22,33 @@ require 'softlayer/ModelBase'
 require 'softlayer/Datacenter'
 require 'softlayer/DynamicAttribute'
 require 'softlayer/Account'
+require 'softlayer/AccountPassword'
 require 'softlayer/Server'
 require 'softlayer/BareMetalServer'
 require 'softlayer/BareMetalServerOrder'
 require 'softlayer/BareMetalServerOrder_Package'
 require 'softlayer/ImageTemplate'
 require 'softlayer/NetworkComponent'
+require 'softlayer/NetworkMessageDelivery'
+require 'softlayer/NetworkService'
+require 'softlayer/NetworkStorageAllowedHost'
+require 'softlayer/NetworkStorageCredential'
+require 'softlayer/NetworkStorageGroup'
+require 'softlayer/NetworkStorage'
 require 'softlayer/ProductPackage'
 require 'softlayer/ProductItemCategory'
 require 'softlayer/ServerFirewall'
 require 'softlayer/ServerFirewallOrder'
+require 'softlayer/SoftwarePassword'
+require 'softlayer/Software'
 require 'softlayer/Ticket'
+require 'softlayer/UserCustomerExternalBinding'
+require 'softlayer/UserCustomer'
+require 'softlayer/VirtualDiskImage'
+require 'softlayer/VirtualDiskImageSoftware'
 require 'softlayer/VirtualServer'
 require 'softlayer/VirtualServerOrder'
+require 'softlayer/VirtualServerOrder_Package'
 require 'softlayer/VirtualServerUpgradeOrder'
 require 'softlayer/VLANFirewall'
 require 'softlayer/VLANFirewallOrder'

metadata

@@ -1,103 +1,103 @@
 --- !ruby/object:Gem::Specification
 name: softlayer_api
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - SoftLayer Development Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-30 00:00:00.000000000 Z
+date: 2015-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: configparser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: rake
   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'
 - !ruby/object:Gem::Dependency
   name: rspec
   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'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.4.2
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
-    - - ! '>='
+    - - ">="
       - !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
@@ -118,6 +118,7 @@ files:
 - examples/ticket_info.rb
 - lib/softlayer/APIParameterFilter.rb
 - lib/softlayer/Account.rb
+- lib/softlayer/AccountPassword.rb
 - lib/softlayer/BareMetalServer.rb
 - lib/softlayer/BareMetalServerOrder.rb
 - lib/softlayer/BareMetalServerOrder_Package.rb
@@ -128,6 +129,12 @@ files:
 - lib/softlayer/ImageTemplate.rb
 - lib/softlayer/ModelBase.rb
 - lib/softlayer/NetworkComponent.rb
+- lib/softlayer/NetworkMessageDelivery.rb
+- lib/softlayer/NetworkService.rb
+- lib/softlayer/NetworkStorage.rb
+- lib/softlayer/NetworkStorageAllowedHost.rb
+- lib/softlayer/NetworkStorageCredential.rb
+- lib/softlayer/NetworkStorageGroup.rb
 - lib/softlayer/ObjectFilter.rb
 - lib/softlayer/ObjectMaskParser.rb
 - lib/softlayer/ObjectMaskProperty.rb
@@ -139,11 +146,18 @@ files:
 - lib/softlayer/ServerFirewall.rb
 - lib/softlayer/ServerFirewallOrder.rb
 - lib/softlayer/Service.rb
+- lib/softlayer/Software.rb
+- lib/softlayer/SoftwarePassword.rb
 - lib/softlayer/Ticket.rb
+- lib/softlayer/UserCustomer.rb
+- lib/softlayer/UserCustomerExternalBinding.rb
 - lib/softlayer/VLANFirewall.rb
 - lib/softlayer/VLANFirewallOrder.rb
+- lib/softlayer/VirtualDiskImage.rb
+- lib/softlayer/VirtualDiskImageSoftware.rb
 - lib/softlayer/VirtualServer.rb
 - lib/softlayer/VirtualServerOrder.rb
+- lib/softlayer/VirtualServerOrder_Package.rb
 - lib/softlayer/VirtualServerUpgradeOrder.rb
 - lib/softlayer/base.rb
 - lib/softlayer/object_mask_helpers.rb
@@ -158,17 +172,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Library for accessing the SoftLayer API