class SoftLayer::ProductPackage

# File lib/softlayer/ProductPackage.rb, line 221
def self.additional_products_package(client = nil)
  return package_with_id(0, client)
end

# File lib/softlayer/ProductPackage.rb, line 205
def self.bare_metal_instance_package(client = nil)
  packages_with_key_name('BARE_METAL_CORE', client).first
end

# File lib/softlayer/ProductPackage.rb, line 214
def self.bare_metal_server_packages(client = nil)
  packages_with_key_name('BARE_METAL_CPU', client)
end

# File lib/softlayer/ProductPackage.rb, line 181
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

# File lib/softlayer/ProductPackage.rb, line 164
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

# File lib/softlayer/ProductPackage.rb, line 194
def self.virtual_server_package(client = nil)
  packages_with_key_name('VIRTUAL_SERVER_INSTANCE', client).first
end

# File lib/softlayer/ProductPackage.rb, line 232
def self.default_object_mask(root)
  "#{root}[id,name,description,regions]"
end

# File lib/softlayer/ProductPackage.rb, line 105
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 configuration
    @categories
  end
end

# File lib/softlayer/ProductPackage.rb, line 129
def category(category_code)
  categories.find { |category| category.category_code == category_code }
end

# File lib/softlayer/ProductPackage.rb, line 54
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

# File lib/softlayer/ProductPackage.rb, line 135
def datacenter_options
  available_locations.collect { |location_data| Datacenter::datacenter_named(location_data['location']['name'], self.softlayer_client) }.compact
end

# File lib/softlayer/ProductPackage.rb, line 143
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

# File lib/softlayer/ProductPackage.rb, line 123
def required_categories
  configuration
end

# File lib/softlayer/ProductPackage.rb, line 156
def service
  softlayer_client[:Product_Package].object_with_id(self.id)
end