softlayer_api 3.0.b1 → 3.0.b2

data/lib/softlayer/VLANFirewallOrder.rb

@@ -0,0 +1,93 @@
+#--
+# 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 allows you to order a Firewall for a VLAN
+  #
+  class VLANFirewallOrder
+    ##
+    # The VLAN that you are ordering the firewall for.
+    attr_reader :vlan_id
+
+    ##
+    # Set high_availabilty to true if you want redundant
+    # firewall devices (defaults to false, no high_availability)
+    attr_accessor :high_availability
+
+    ##
+    # Create a new order for the given VLAN
+    # Note that the vlan_id is NOT the same as the vlan number.
+    def initialize (vlan_id, 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
+
+      @vlan_id = vlan_id
+      @high_availability = false
+    end
+
+    ##
+    # Calls the SoftLayer API to verify that the template provided by this order is valid
+    # This routine will return the order template generated by the API or will throw an exception
+    #
+    # This routine will not actually create a Bare Metal Instance and will not affect billing.
+    #
+    # If you provide a block, it will receive the order template as a parameter and
+    # the block may make changes to the template before it is submitted.
+    def verify()
+      order_template = firewall_order_template
+      order_template = yield order_template if block_given?
+
+      @softlayer_client[:Product_Order].verifyOrder(order_template)
+    end
+
+    ##
+    # Calls the SoftLayer API to place an order for a new server based on the template in this
+    # order. If this succeeds then you will be billed for the new server.
+    #
+    # If you provide a block, it will receive the order template as a parameter and
+    # the block may make changes to the template before it is submitted.
+    def place_order!()
+      order_template = firewall_order_template
+      order_template = yield order_template if block_given?
+
+      @softlayer_client[:Product_Order].placeOrder(order_template)
+    end
+
+    protected
+
+    ##
+    # Returns a hash of the creation options formatted to be sent to
+    # the SoftLayer API for either verification or completion
+    def firewall_order_template
+      client = @softlayer_client
+      additional_products_package = SoftLayer::ProductPackage.additional_products_package(client)
+
+      template = {
+          'complexType' => 'SoftLayer_Container_Product_Order_Network_Protection_Firewall_Dedicated',
+          'quantity' => 1,
+          'packageId' => additional_products_package.id,
+          'vlanId' => @vlan_id
+        }
+
+      if @high_availability
+        expected_description = "Hardware Firewall (High Availability)"
+      else
+        expected_description = "Hardware Firewall (Dedicated)"
+      end
+
+      firewall_items = additional_products_package.items_with_description(expected_description)
+
+      raise "Could not find a price item matching the description '#{expected_description}'" if firewall_items.empty?
+
+      firewall_item = firewall_items[0]
+
+      template['prices'] = [{ 'id' => firewall_item.price_id }] if firewall_item.respond_to?(:price_id)
+
+      template
+    end
+  end # class VLANFirewallOrder
+end # module SoftLayer

data/lib/softlayer/VirtualServer.rb

@@ -87,13 +87,16 @@ module SoftLayer
     # You may use the wait_until_ready routine of SoftLayer::ImageTemplate to
     # wait on it.
     #
-    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
+      image_name = 'Captured Image' if !image_name
+
       disk_filter = lambda { |disk| disk['device'] == '0' }
       disk_filter = lambda { |disk| disk['device'] != '1' } if include_attached_storage
 
       disks = self.blockDevices.select(&disk_filter)
 
-      self.service.createArchiveTransaction(image_name, disks, notes ? notes : "") if disks && !disks.empty?
+      self.service.createArchiveTransaction(image_name, disks, image_notes) if disks && !disks.empty?
 
       image_templates = SoftLayer::ImageTemplate.find_private_templates(:name => image_name)
       image_templates[0] if !image_templates.empty?
@@ -161,7 +164,7 @@ module SoftLayer
       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
 
-      vg_service = softlayer_client["Virtual_Guest"]
+      vg_service = softlayer_client[:Virtual_Guest]
       vg_service = vg_service.object_mask(default_object_mask.to_sl_object_mask)
 
       if options.has_key?(:object_mask)
@@ -248,7 +251,7 @@ module SoftLayer
 
       required_properties_mask = 'mask.id'
 
-      account_service = softlayer_client['Account']
+      account_service = softlayer_client[:Account]
       account_service = account_service.object_filter(object_filter) unless object_filter.empty?
       account_service = account_service.object_mask(default_object_mask.to_sl_object_mask)
 
@@ -307,7 +310,7 @@ module SoftLayer
     # For VirtualServers the service is +SoftLayer_Virtual_Guest+ and
     # addressing this object is done by id.
     def service
-      return softlayer_client["Virtual_Guest"].object_with_id(self.id)
+      return softlayer_client[:Virtual_Guest].object_with_id(self.id)
     end
   end #class VirtualServer
 end

data/lib/softlayer/VirtualServerOrder.rb

@@ -119,7 +119,7 @@ module SoftLayer
       order_template = virtual_guest_template
       order_template = yield order_template if block_given?
 
-      @softlayer_client["Virtual_Guest"].generateOrderTemplate(order_template)
+      @softlayer_client[:Virtual_Guest].generateOrderTemplate(order_template)
     end
 
     # Calls the SoftLayer API to place an order for a new virtual server based on the template in this
@@ -132,8 +132,8 @@ module SoftLayer
       order_template = virtual_guest_template
       order_template = yield order_template if block_given?
 
-      virtual_server_hash = @softlayer_client["Virtual_Guest"].createObject(order_template)
-      SoftLayer::VirtualServer.server_with_id(virtual_server_hash["id"], :client => @softlayer_client) if virtual_server_hash
+      virtual_server_hash = @softlayer_client[:Virtual_Guest].createObject(order_template)
+      SoftLayer::VirtualServer.server_with_id(virtual_server_hash['id'], :client => @softlayer_client) if virtual_server_hash
     end
 
     protected
@@ -153,21 +153,21 @@ module SoftLayer
         "hourlyBillingFlag" => !!@hourly
       }
 
-      template["dedicatedAccountHostOnlyFlag"] = true if @dedicated_host_only
-      template["privateNetworkOnlyFlag"] = true if @private_network_only
+      template['dedicatedAccountHostOnlyFlag'] = true if @dedicated_host_only
+      template['privateNetworkOnlyFlag'] = true if @private_network_only
 
-      template["datacenter"] = {"name" => @datacenter.name} 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
       template['sshKeys'] = @ssh_key_ids.collect { |ssh_key_id| {'id'=> ssh_key_id.to_i } } if @ssh_key_ids
       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
+      template['primaryBackendNetworkComponent'] = { "networkVlan" => {"id" => @private_vlan_id.to_i } } if @private_vlan_id
 
       if @image_template
-          template["blockDeviceTemplateGroup"] = {"globalIdentifier" => @image_template.global_id}
+          template['blockDeviceTemplateGroup'] = {"globalIdentifier" => @image_template.global_id}
       elsif @os_reference_code
-          template["operatingSystemReferenceCode"] = @os_reference_code
+          template['operatingSystemReferenceCode'] = @os_reference_code
       end
 
       if @disks && !@disks.empty?
@@ -196,7 +196,7 @@ module SoftLayer
       raise "#{__method__} requires a client but none was given and Client::default_client is not set" if !softlayer_client
 
       @@create_object_options ||= nil
-      @@create_object_options = softlayer_client["Virtual_Guest"].getCreateObjectOptions() if !@@create_object_options
+      @@create_object_options = softlayer_client[:Virtual_Guest].getCreateObjectOptions() if !@@create_object_options
       @@create_object_options
     end
 
@@ -210,37 +210,37 @@ 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.datacenter_named(datacenter_spec['template']['datacenter']['name'], client) }.uniq
+      create_object_options(client)['datacenters'].collect { |datacenter_spec| Datacenter.datacenter_named(datacenter_spec['template']['datacenter']['name'], client) }.uniq
     end
 
     ##
     # Return a list of values that are valid for the :cores attribute
     def self.core_options(client = nil)
-      create_object_options(client)["processors"].collect { |processor_spec| processor_spec['template']['startCpus'] }.uniq.sort!
+      create_object_options(client)['processors'].collect { |processor_spec| processor_spec['template']['startCpus'] }.uniq.sort!
     end
 
     ##
     # Return a list of values that are valid for the :memory attribute
     def self.memory_options(client = nil)
-      create_object_options(client)["memory"].collect { |memory_spec| memory_spec['template']['maxMemory'].to_i / 1024}.uniq.sort!
+      create_object_options(client)['memory'].collect { |memory_spec| memory_spec['template']['maxMemory'].to_i / 1024}.uniq.sort!
     end
 
     ##
     # Return a list of values that are valid the array given to the :disks
     def self.disk_options(client = nil)
-      create_object_options(client)["blockDevices"].collect { |block_device_spec| block_device_spec['template']['blockDevices'][0]['diskImage']['capacity']}.uniq.sort!
+      create_object_options(client)['blockDevices'].collect { |block_device_spec| block_device_spec['template']['blockDevices'][0]['diskImage']['capacity']}.uniq.sort!
     end
 
     ##
     # Returns a list of the valid :os_refrence_codes
     def self.os_reference_code_options(client = nil)
-      create_object_options(client)["operatingSystems"].collect { |os_spec| os_spec['template']['operatingSystemReferenceCode'] }.uniq.sort!
+      create_object_options(client)['operatingSystems'].collect { |os_spec| os_spec['template']['operatingSystemReferenceCode'] }.uniq.sort!
     end
 
     ##
     # Returns a list of the :max_port_speeds
     def self.max_port_speed_options(client = nil)
-      create_object_options(client)["networkComponents"].collect { |component_spec| component_spec['template']['networkComponents'][0]['maxSpeed'] }
+      create_object_options(client)['networkComponents'].collect { |component_spec| component_spec['template']['networkComponents'][0]['maxSpeed'] }
     end
   end # class VirtualServerOrder
 end # module SoftLayer

data/lib/softlayer/VirtualServerUpgradeOrder.rb

@@ -15,25 +15,25 @@ module SoftLayer
   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.
     #
@@ -54,12 +54,12 @@ module SoftLayer
         order_object = self.order_object
         order_object = yield order_object if block_given?
 
-        @virtual_server.softlayer_client["Product_Order"].verifyOrder(order_object)
+        @virtual_server.softlayer_client[:Product_Order].verifyOrder(order_object)
       end
     end
 
     ##
-    # Places the order represented by this object.  This is likely to 
+    # 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
@@ -70,26 +70,26 @@ module SoftLayer
         order_object = self.order_object
         order_object = yield order_object if block_given?
 
-        @virtual_server.softlayer_client["Product_Order"].placeOrder(order_object)
+        @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
+      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
+      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
+      self._item_prices_in_category("port_speed").map { |item_price| item_price['item']['capacity'].to_i}.sort.uniq
     end
 
     private
@@ -105,30 +105,30 @@ module SoftLayer
     # 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 } }
+      @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}
+      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
+
+      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 = {

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.b2"  # 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

@@ -27,9 +27,14 @@ require 'softlayer/BareMetalServer'
 require 'softlayer/BareMetalServerOrder'
 require 'softlayer/BareMetalServerOrder_Package'
 require 'softlayer/ImageTemplate'
+require 'softlayer/NetworkComponent'
 require 'softlayer/ProductPackage'
 require 'softlayer/ProductItemCategory'
+require 'softlayer/ServerFirewall'
+require 'softlayer/ServerFirewallOrder'
 require 'softlayer/Ticket'
 require 'softlayer/VirtualServer'
 require 'softlayer/VirtualServerOrder'
 require 'softlayer/VirtualServerUpgradeOrder'
+require 'softlayer/VLANFirewall'
+require 'softlayer/VLANFirewallOrder'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: softlayer_api
 version: !ruby/object:Gem::Version
-  version: 3.0.b1
+  version: 3.0.b2
 platform: ruby
 authors:
 - SoftLayer Development Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-15 00:00:00.000000000 Z
+date: 2014-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: configparser
@@ -113,6 +113,7 @@ files:
 - examples/create_ticket.rb
 - examples/open_tickets.rb
 - examples/order_bare_metal_package.rb
+- examples/order_server_firewall.rb
 - examples/order_virtual_server.rb
 - examples/ticket_info.rb
 - lib/softlayer/APIParameterFilter.rb
@@ -126,6 +127,7 @@ files:
 - lib/softlayer/DynamicAttribute.rb
 - lib/softlayer/ImageTemplate.rb
 - lib/softlayer/ModelBase.rb
+- lib/softlayer/NetworkComponent.rb
 - lib/softlayer/ObjectFilter.rb
 - lib/softlayer/ObjectMaskParser.rb
 - lib/softlayer/ObjectMaskProperty.rb
@@ -134,8 +136,12 @@ files:
 - lib/softlayer/ProductItemCategory.rb
 - lib/softlayer/ProductPackage.rb
 - lib/softlayer/Server.rb
+- lib/softlayer/ServerFirewall.rb
+- lib/softlayer/ServerFirewallOrder.rb
 - lib/softlayer/Service.rb
 - lib/softlayer/Ticket.rb
+- lib/softlayer/VLANFirewall.rb
+- lib/softlayer/VLANFirewallOrder.rb
 - lib/softlayer/VirtualServer.rb
 - lib/softlayer/VirtualServerOrder.rb
 - lib/softlayer/VirtualServerUpgradeOrder.rb