Class: SoftLayer::ProductPackage
- Includes:
- DynamicAttribute
- Defined in:
- lib/softlayer/ProductPackage.rb
Overview
Each SoftLayer ProductPackage provides information about ordering a product or service from SoftLayer.
Product Item Categories
A important companion to Product Packages are ProductItemCategories. Each ProductItemCategory represents a set of options that you may choose from when configuring an attribute of the product or service you are ordering.
ProductItemCategories are identified by categoryCode
. Examples of category codes include ‘os’, ‘ram’, and ‘port_speed’.
For example, in a package for ordering a server, the ‘os’ ProductItemCategory contains the available choices for operating systems that may be provisioned on the server.
When you construct an order based on that package, you will make one selection from the ‘os’ category and put it into the order.
Package Configuration
A package also has a Configuration. A Configuration specifies which Categories are valid in an order and, more importantly, which Categories are required in any order that uses the ProductPackage.
When constructing an order, you must provide an option for each of the Categories that the Configuration marks as required (and you must supply a value even if the Category only has one choice)
Instance Attribute Summary
Attributes inherited from ModelBase
Class Method Summary collapse
-
.additional_products_package(client = nil) ⇒ Object
The “Additional Products” package is a grab-bag of products and services.
-
.bare_metal_instance_package(client = nil) ⇒ Object
Returns the ProductPackage of the package used to order Bare Metal Servers with simplified configuration options.
-
.bare_metal_server_packages(client = nil) ⇒ Object
Returns an array of ProductPackages, each of which can be used as the foundation to order a bare metal server.
-
.package_with_id(package_id, client = nil) ⇒ Object
Requests a list (array) of ProductPackages whose key names match the one passed in.
-
.packages_with_key_name(key_name, client = nil) ⇒ Object
Requests a list (array) of ProductPackages whose key names match the one passed in.
-
.virtual_server_package(client = nil) ⇒ Object
Returns the ProductPackage of the package used to order virtual servers At the time of this writing, the code assumes this package is unique.
Instance Method Summary collapse
-
#available_locations ⇒ Object
The list of locations where this product package is available.
-
#categories ⇒ Object
The full set of product categories contained in the package.
-
#category(category_code) ⇒ Object
Returns the product category with the given category code (or nil if one cannot be found).
-
#configuration ⇒ Object
The set of product categories needed to make an order for this product package.
-
#datacenter_options ⇒ Object
Returns a list of the datacenters that this package is available in.
-
#items_with_description(expected_description) ⇒ Object
Returns the package items with the given description Currently this is returning the low-level hash representation directly from the Network API.
-
#name ⇒ Object
A friendly, readable name for the package.
-
#required_categories ⇒ Object
Returns an array of the required categories in this package.
-
#service ⇒ Object
Returns the service for interacting with this package through the network API.
Methods included from DynamicAttribute
Methods inherited from ModelBase
#[], #has_sl_property?, #initialize, #refresh_details, sl_attr, #to_ary
Constructor Details
This class inherits a constructor from SoftLayer::ModelBase
Class Method Details
.additional_products_package(client = nil) ⇒ Object
The “Additional Products” package is a grab-bag of products and services. It has a “well known” id of 0
217 218 219 |
# File 'lib/softlayer/ProductPackage.rb', line 217 def self.additional_products_package(client = nil) return package_with_id(0, client) end |
.bare_metal_instance_package(client = nil) ⇒ Object
Returns the ProductPackage of the package used to order Bare Metal Servers with simplified configuration options.
At the time of this writing, the code assumes this package is unique
‘BARE_METAL_CORE’ is a “well known” constant for this purpose
201 202 203 |
# File 'lib/softlayer/ProductPackage.rb', line 201 def self.(client = nil) packages_with_key_name('BARE_METAL_CORE', client).first end |
.bare_metal_server_packages(client = nil) ⇒ Object
Returns an array of ProductPackages, each of which can be used as the foundation to order a bare metal server.
‘BARE_METAL_CPU’ is a “well known” constant for this purpose
210 211 212 |
# File 'lib/softlayer/ProductPackage.rb', line 210 def self.(client = nil) packages_with_key_name('BARE_METAL_CPU', client) end |
.package_with_id(package_id, client = nil) ⇒ Object
Requests a list (array) of ProductPackages whose key names match the one passed in.
177 178 179 180 181 182 183 |
# File 'lib/softlayer/ProductPackage.rb', line 177 def self.package_with_id(package_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 package_data = softlayer_client[:Product_Package].object_with_id(package_id).object_mask(self.default_object_mask('mask')).getObject ProductPackage.new(softlayer_client, package_data) end |
.packages_with_key_name(key_name, client = nil) ⇒ Object
Requests a list (array) of ProductPackages whose key names match the one passed in.
160 161 162 163 164 165 166 167 168 169 170 171 |
# File 'lib/softlayer/ProductPackage.rb', line 160 def self.packages_with_key_name(key_name, 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 filter = SoftLayer::ObjectFilter.new do |filter| filter.accept('type.keyName').when_it is(key_name) end filtered_service = softlayer_client[:Product_Package].object_filter(filter).object_mask(self.default_object_mask('mask')) packages_data = filtered_service.getAllObjects packages_data.collect { |package_data| ProductPackage.new(softlayer_client, package_data) } end |
.virtual_server_package(client = nil) ⇒ Object
Returns the ProductPackage of the package used to order virtual servers At the time of this writing, the code assumes this package is unique
‘VIRTUAL_SERVER_INSTANCE’ is a “well known” constant for this purpose
190 191 192 |
# File 'lib/softlayer/ProductPackage.rb', line 190 def self.virtual_server_package(client = nil) packages_with_key_name('VIRTUAL_SERVER_INSTANCE', client).first end |
Instance Method Details
#available_locations ⇒ Object
The list of locations where this product package is available.
46 |
# File 'lib/softlayer/ProductPackage.rb', line 46 sl_attr :available_locations, 'availableLocations' |
#categories ⇒ Object
The full set of product categories contained in the package
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 |
# File 'lib/softlayer/ProductPackage.rb', line 101 sl_dynamic_attr :categories do |resource| resource.should_update? do @categories == nil end resource.to_update do # This is a bit ugly, but what we do is ask for the configuration # which updates all the categories for the package (and marks those # that are required) self.configuration # return the value constructed by the configuraiton @categories end end |
#category(category_code) ⇒ Object
Returns the product category with the given category code (or nil if one cannot be found)
125 126 127 |
# File 'lib/softlayer/ProductPackage.rb', line 125 def category(category_code) categories.find { |category| category.categoryCode == category_code } end |
#configuration ⇒ Object
The set of product categories needed to make an order for this product package.
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 |
# File 'lib/softlayer/ProductPackage.rb', line 51 sl_dynamic_attr :configuration do |resource| resource.should_update? do # only retrieved once per instance @configuration == nil end resource.to_update do # # We call +SoftLayer_Product_Package+ to get the configuration for this package. # # Unfortunately, even though this call includes +SoftLayer_Product_Item_Category+ entities, it does not have the context # needed to find the active price items for that category. # # Instead, we make a second call, this time to +SoftLayer_Product_Package::getCategories+. That method incorporates a complex # filtering mechanism on the server side to give us a list of the categories, groups, and prices that are valid for the current # account at the current time. We construct the ProductItemCategory objects from the results we get back. # configuration_data = softlayer_client[:Product_Package].object_with_id(self.id).object_mask("mask[isRequired,itemCategory.categoryCode]").getConfiguration() # We sort of invert the information and create a map from category codes to a boolean representing # whether or not they are required. required_by_category_code = configuration_data.inject({}) do |required_by_category_code, config_category| required_by_category_code[config_category['itemCategory']['categoryCode']] = (config_category['isRequired'] != 0) required_by_category_code end # This call to getCategories is the one that does lots of fancy back-end filtering for us categories_data = softlayer_client[:Product_Package].object_with_id(self.id).object_mask(@@categories_object_mask).getCategories() # Run though the categories and for each one that's in our config, create a SoftLayer::ProductItemCategory object. # Conveniently the +keys+ of the required_by_category_code gives us a list of the category codes in the configuration config_categories = required_by_category_code.keys # collect all the categories into an array @categories = categories_data.collect do |category_data| if config_categories.include? category_data['categoryCode'] SoftLayer::ProductItemCategory.new(softlayer_client, category_data, required_by_category_code[category_data['categoryCode']]) else SoftLayer::ProductItemCategory.new(softlayer_client, category_data, false) end end.compact # The configuration consists of only those categories that are required. @categories.select { |category| category.required? } end # to_update end |
#datacenter_options ⇒ Object
Returns a list of the datacenters that this package is available in
131 132 133 |
# File 'lib/softlayer/ProductPackage.rb', line 131 def available_locations.collect { |location_data| Datacenter::datacenter_named(location_data['location']['name'], self.softlayer_client) }.compact end |
#items_with_description(expected_description) ⇒ Object
Returns the package items with the given description Currently this is returning the low-level hash representation directly from the Network API
139 140 141 142 143 144 145 146 147 |
# File 'lib/softlayer/ProductPackage.rb', line 139 def items_with_description(expected_description) filter = ObjectFilter.new { |filter| filter.accept("items.description").when_it is(expected_description) } items_data = self.service.object_filter(filter).getItems() items_data.collect do |item_data| first_price = item_data['prices'][0] ProductConfigurationOption.new(item_data, first_price) end end |
#name ⇒ Object
A friendly, readable name for the package
42 |
# File 'lib/softlayer/ProductPackage.rb', line 42 sl_attr :name |
#required_categories ⇒ Object
Returns an array of the required categories in this package
119 120 121 |
# File 'lib/softlayer/ProductPackage.rb', line 119 def required_categories configuration end |
#service ⇒ Object
Returns the service for interacting with this package through the network API
152 153 154 |
# File 'lib/softlayer/ProductPackage.rb', line 152 def service softlayer_client[:Product_Package].object_with_id(self.id) end |