softlayer_api 2.2.2 → 3.0.b1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4936c19f8a711d7babe49535dca28e149bd7ad43
-  data.tar.gz: 667178b6fc03102b85bb25275308720b50712af5
+  metadata.gz: 6f8d78ff1302ba4ee3970aa9b35ae5ad58de334a
+  data.tar.gz: 3a26cf514cefcf910e4edbadf810d63a1eea96fd
 SHA512:
-  metadata.gz: 47cc499fad6bc36db67a9f1380f74119cfa9ade88f02025df3886c80d08c045c6ebf1a69944f4e63a3f6c981487b201ca8a08c217ef6273cc077805e1bb35d24
-  data.tar.gz: 1636e72268665d211546f1e78ead56082950662d2abea19bb9de0920029da4133fd598f06984a13f842ad8d9ab3c6b3d6c44de428a70f3f8c1c182e170a0e590
+  metadata.gz: 8c15a6526a4447e70fcf63433c443236666bebd15dfd8f96d18ace34ae00259e55633b0c38b2938c00e066265793617b276eae6c369a36f3db1ab666e89c66d1
+  data.tar.gz: 75f70052f5946914de71194f7db38ee2d3b6f7ee189c2b33e1bd944d5215c6ce6890e8cb6a653a2a074ef5be76528eb5c82bfe75bd57e58841b48b4076154eed

data/CHANGELOG.textile

@@ -1,13 +1,17 @@
-*2.2.2*
-* Fixed a bug in BareMetalServerOrder_Package.rb where the order template did not use an array for the "hardware" key.  This lead to an order template that would be accepted by verifyOrder, but rejected by placeOrder.  An internal issue to review verifyOrder has also been generated. (reported by Rohit Singh)
+*3.0*
+* Substantially rewrote the ObjectFilter class. ObjectFilters used to be hashes which made it easy to manipulate their content incorrectly. The new implementation has a strict interface that makes it harder to manipulate filters incorrectly.
+* Added a model for Virtual Server Image Templates (SoftLayer::ImageTemplate) - VirtualServerOrder now requires an instance of this class rather than allowing you to provide just the global_id of an image
+* Added a model for data centers (SoftLayer::Datacenter). Bare Metal, Bare Metal Package, and Virtual server orders now use an instance of Datacenter to identify where their servers will be provisioned. The routines in those classes which used to provide lists of valid data center names now return data center objects.
+* Virtual Server Upgrades are now handled by the VirtualServerUpgradeOrder class and not the VirtualServer class. This change was made for several reasons. Firt and foremost, it allows multiple aspects of a virtual server to be upgraded at once without having to wait on separate transactions to complete between upgrades. Secondly it opens the door for additional upgrades (for example, to disk configuration) to be added in the future.
+* Added a method to reboot servers.
+* The routine to retreive the open tickets on an account has been moved from the Ticket class. The set of open tickets is now a dynamic property of an account object.
 
 *2.2*
-* 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
+* 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.
 
 *2.1.1*
 * Virtual server upgrades no longer raise exceptions
-* Formalized the RDoc documentation process.  Added overview and welcome documentation and changed the README so it directs folks to the new documentation.
+* Formalized the RDoc documentation process. Added overview and welcome documentation and changed the README so it directs folks to the new documentation.
 
 *2.1.0*
 * Began implementing a model framework that allows Ruby developers to work with elements in the SoftLayer API in a more object-oriented fashion. The first release of this framework includes the Ticket, VirtualServer, and BareMetalServer classes.

data/examples/account_servers.rb

@@ -23,8 +23,8 @@
 require 'rubygems'
 require 'softlayer_api'
 require 'pp'
-  
-  # We can set the default client to be our client and that way 
+
+  # We can set the default client to be our client and that way
   # we can avoid supplying it later
   SoftLayer::Client.default_client = SoftLayer::Client.new(
     # :username => "joecustomer"              # enter your username here

data/examples/create_ticket.rb

@@ -35,7 +35,7 @@ begin
   account = SoftLayer::Account.account_for_client(softlayer_client)
   account_user = account.service.getCurrentUser
   my_user_id = account_user["id"]
-  
+
   # We also need a subject for the ticket. Subjects are specified by id
   # This code prints out a table of all the ticket subjects with their
   # ids:
@@ -43,7 +43,7 @@ begin
   ticket_subjects.each do |subject|
     puts "#{subject['id']}\t#{subject['name']}"
   end
-  
+
   # For this example we'll use 'Public Network Question' as the subject.  That's id 1022
   public_network_question_id = 1022
 
@@ -58,7 +58,7 @@ begin
   )
 
   puts "Created a new ticket : #{new_ticket.id} - #{new_ticket.title}"
-  
+
   # we can also add an update to the ticket:
   new_ticket.update("This is a ticket update sent from the Ruby library")
 

data/examples/open_tickets.rb

@@ -30,14 +30,14 @@ require 'pp'
 # $SL_API_KEY = "feeddeadbeefbadf00d..."   # enter your api key here
 
 # The client constructed here must get it's credentials from somewhere
-# In this script you might uncomment the globals above and assign your 
+# In this script you might uncomment the globals above and assign your
 # credentials there
 SoftLayer::Client.default_client = SoftLayer::Client.new()
 
 # The openTickets routine will pick up the default client established above.
 open_tickets = SoftLayer::Ticket.open_tickets()
 
-open_tickets.sort!{ |lhs, rhs| -(lhs.lastEditDate <=> rhs.lastEditDate) } 
+open_tickets.sort!{ |lhs, rhs| -(lhs.lastEditDate <=> rhs.lastEditDate) }
 open_tickets.each do |ticket|
   printf "#{ticket.id} - #{ticket.title}"
 

data/examples/ticket_info.rb

@@ -34,13 +34,13 @@ begin
   # at information.  In this case we are talking directly to the ticket
   # service
   ticket_service = softlayer_client.service_named("Ticket");
-  
+
   # Retrive a particular ticket by ID (you will have to substitute an existing ticket's ID here)
   ticket_ref = ticket_service.object_with_id(12345)
 
   # Retrive very specific information about the ticket
   ticket = ticket_ref.object_mask("mask[updates[entry,createDate],assignedUserId,attachedHardware.datacenter]").getObject
-  
+
   pp ticket
 rescue Exception => exception
   puts "Unable to retrieve the ticket #{exception}"

data/lib/softlayer/APIParameterFilter.rb

@@ -1,24 +1,10 @@
-#
+#--
 # 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
 # An +APIParameterFilter+ is an intermediary object that understands how
@@ -119,7 +105,7 @@ class APIParameterFilter
   # to specify criteria which are used to filter the results returned
   # by the server.
   def object_filter(filter)
-    raise ArgumentError, "Object mask expects mask properties" if filter.nil?
+    raise ArgumentError, "object_filter expects an instance of SoftLayer::ObjectFilter" if filter.nil? || !filter.kind_of?(SoftLayer::ObjectFilter)
 
     # we create a new object in case the user wants to store off the
     # filter chain and reuse it later
@@ -187,7 +173,7 @@ class APIParameterFilter
   ##
   # A utility method that returns the object filter (if any) stored with this filter.
   def server_object_filter
-    self.parameters[:object_filter]
+    self.parameters[:object_filter].to_h
   end
 
   ##

data/lib/softlayer/Account.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
   class Account < SoftLayer::ModelBase
@@ -113,6 +97,31 @@ module SoftLayer
       end
     end
 
+    sl_dynamic_attr :image_templates do |image_templates|
+      image_templates.should_update? do
+        @last_image_template_update ||= Time.at(0)
+        (Time.now - @last_image_template_update) > 5 * 60  # update every 5 minutes
+      end
+
+      image_templates.to_update do
+        @last_image_template_update ||= Time.now
+        ImageTemplate.find_private_templates(:client => self.softlayer_client)
+      end
+    end
+
+    sl_dynamic_attr :open_tickets do |open_tickets|
+      open_tickets.should_update? do
+        @last_open_tickets_update ||= Time.at(0)
+        (Time.now - @last_open_tickets_update) > 5 * 60  # update every 5 minutes
+      end
+
+      open_tickets.to_update do
+        @last_open_tickets_update ||= Time.now
+        open_tickets_data = self.service.object_mask(SoftLayer::Ticket.default_object_mask).getOpenTickets
+        open_tickets_data.collect { |ticket_data| SoftLayer::Ticket.new(self.softlayer_client, ticket_data) }
+      end
+    end
+
     def service
       softlayer_client["Account"].object_with_id(self.id)
     end

data/lib/softlayer/BareMetalServer.rb

@@ -1,24 +1,10 @@
-#
+#--
 # 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
   #
@@ -27,6 +13,7 @@ module SoftLayer
   # +SoftLayer_Hardware_Server+ services in the SoftLayer API
   #
   # http://sldn.softlayer.com/reference/datatypes/SoftLayer_Hardware
+  #
   # http://sldn.softlayer.com/reference/datatypes/SoftLayer_Hardware_Server
   #
   class BareMetalServer < Server
@@ -51,7 +38,7 @@ module SoftLayer
     # removed from the account).
     #
     # The +cancellation_reason+ parameter should be a key from the hash returned
-    # by +BareMetalServer::cancellation_reasons+.
+    # by BareMetalServer::cancellation_reasons.
     #
     # You may add your own, more specific reasons for cancelling a server in the
     # +comments+ parameter.
@@ -178,8 +165,9 @@ module SoftLayer
 
       if(options_hash.has_key? :object_filter)
         object_filter = options_hash[:object_filter]
+        raise "Expected an instance of SoftLayer::ObjectFilter" unless object_filter.kind_of?(SoftLayer::ObjectFilter)
       else
-        object_filter = {}
+        object_filter = ObjectFilter.new()
       end
 
       option_to_filter_path = {
@@ -197,18 +185,18 @@ module SoftLayer
       # that particular option, add a clause to the object filter that filters for the matching
       # value
       option_to_filter_path.each do |option, filter_path|
-        object_filter.merge!(SoftLayer::ObjectFilter.build(filter_path, options_hash[option])) if options_hash.has_key?(option)
+        object_filter.modify { |filter| filter.accept(filter_path).when_it is(options_hash[option])} if options_hash[option]
       end
 
       # Tags get a much more complex object filter operation so we handle them separately
       if options_hash.has_key?(:tags)
-        object_filter.merge!(SoftLayer::ObjectFilter.build("hardware.tagReferences.tag.name", {
+        object_filter.set_criteria_for_key_path("hardware.tagReferences.tag.name", {
           'operation' => 'in',
           'options' => [{
             'name' => 'data',
-            'value' => options_hash[:tags]
+            'value' => options_hash[:tags].collect{ |tag_value| tag_value.to_s }
             }]
-          } ));
+          } );
       end
 
       account_service = softlayer_client['Account']

data/lib/softlayer/BareMetalServerOrder.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
   #
@@ -46,8 +30,7 @@ module SoftLayer
     # a Bare Metal Instance
     #++
 
-    # String, short name of the data center that will house the new Bare Metal Instance (e.g. "dal05" or "sea01")
-    # Corresponds to +datacenter.name+ in the documentation for +createObject+.
+    # An instance of SoftLayer::Datacenter. The server will be provisioned in this data center
     attr_accessor :datacenter
 
     # String, The hostname to assign to the new server
@@ -166,7 +149,7 @@ module SoftLayer
 
       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
@@ -198,7 +181,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
 
     def self.core_options(client = nil)

data/lib/softlayer/BareMetalServerOrder_Package.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
   #
@@ -42,13 +26,14 @@ module SoftLayer
   class BareMetalServerOrder_Package < Server
     # The following properties are required in a server order.
 
-    # The product package identifying the base configuration for the server.
-    # a list of Bare Metal Server product packages is returned by
+    # The product package object (an instance of SoftLayer::ProductPackage) identifying the base
+    # configuration for the server. A list of Bare Metal Server product packages is returned by
     # SoftLayer::ProductPackage.bare_metal_server_packages
     attr_reader :package
 
-    # String, short name of the data center that will house the new virtual server (e.g. "dal05" or "sea01")
-    # A list of valid data centers can be found in ProductPackage#datacenter_options
+    # 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).
@@ -133,14 +118,13 @@ module SoftLayer
       product_order = {
         'packageId' => @package.id,
         'useHourlyPricing' => false,
-        'hardware' => [{
+        'hardware' => {
           'hostname' => @hostname,
           'domain' => @domain
-          }]
+        }
       }
 
-      product_order['location'] = @package.location_id_for_datacenter_name(@datacenter.downcase) if @datacenter
-
+      product_order['location'] = @datacenter.id if @datacenter
       product_order['sshKeys'] = [{ 'sshKeyIds' => @ssh_key_ids }] if @ssh_key_ids
       product_order['provisionScripts'] = [@provision_script_URI.to_s] if @provision_script_URI
 
@@ -156,7 +140,5 @@ module SoftLayer
 
       product_order
     end
-
   end # BareMetalServerOrder_Package
-
 end # SoftLayer

data/lib/softlayer/Client.rb

@@ -1,31 +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.
+#++
 
 module SoftLayer
-  # Initialize an instance of the Client class. You pass in the service name
-  # and optionally hash arguments specifying how the client should access the
-  # SoftLayer API.
+  # A client is responsible for storing authentication information for API calls and
+  # it serves as a centeral repository for the Service instances that call into the
+  # network API.
   #
-  # The following symbols can be used as hash arguments to pass options to the constructor:
+  # When you create a client, you pass in hash arguments specifying how the client
+  # should access the SoftLayer API.
+  #
+  # The following symbols are the keys for options you pass to the constructor:
   # - +:username+ - a non-empty string providing the username to use for requests to the client
   # - +:api_key+ - a non-empty string providing the api key to use for requests to the client
   # - +:endpoint_url+ - a non-empty string providing the endpoint URL to use for requests to the client
@@ -56,6 +43,13 @@ module SoftLayer
     # will be used by many methods if you do not provide an explicit client.
     @@default_client = nil
 
+    ##
+    # :attr_accessor:
+    # The client class can maintain a single instance of Client as the "default client"
+    # Other parts of the library that accept a client as part of their calling sequence
+    # will look for the default client if one is not provided in the call
+    #
+    # This routine returns the client set as the default client.  It can be nil
     def self.default_client
       return @@default_client
     end