Class: ActiveShipping::PackageItem

Inherits:
Object
  • Object
show all
Includes:
Quantified
Defined in:
lib/active_shipping/package_item.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, grams_or_ounces, value, quantity, options = {}) ⇒ PackageItem

Returns a new instance of PackageItem.



7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/active_shipping/package_item.rb', line 7

def initialize(name, grams_or_ounces, value, quantity, options = {})
  @name = name

  imperial = (options[:units] == :imperial) ||
             (grams_or_ounces.respond_to?(:unit) && m.unit.to_sym == :imperial)

  @unit_system = imperial ? :imperial : :metric

  @weight = attribute_from_metric_or_imperial(grams_or_ounces, Mass, :grams, :ounces)

  @value = Package.cents_from(value)
  @quantity = quantity > 0 ? quantity : 1

  @sku = options[:sku]
  @hs_code = options[:hs_code]
  @options = options
end

Instance Attribute Details

#hs_code ⇒ Object (readonly)

Returns the value of attribute hs_code.



5
6
7
 
# File 'lib/active_shipping/package_item.rb', line 5

def hs_code
  @hs_code
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



5
6
7
 
# File 'lib/active_shipping/package_item.rb', line 5

def name
  @name
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



5
6
7
 
# File 'lib/active_shipping/package_item.rb', line 5

def options
  @options
end

#quantity ⇒ Object (readonly)

Returns the value of attribute quantity.



5
6
7
 
# File 'lib/active_shipping/package_item.rb', line 5

def quantity
  @quantity
end

#sku ⇒ Object (readonly)

Returns the value of attribute sku.



5
6
7
 
# File 'lib/active_shipping/package_item.rb', line 5

def sku
  @sku
end

#value ⇒ Object (readonly)

Returns the value of attribute value.



5
6
7
 
# File 'lib/active_shipping/package_item.rb', line 5

def value
  @value
end

#weight(options = {}) ⇒ Object (readonly) Also known as: mass

Returns the value of attribute weight.



5
6
7
 
# File 'lib/active_shipping/package_item.rb', line 5

def weight
  @weight
end

Instance Method Details

#grams(options = {}) ⇒ Object Also known as: g 



45
46
47
 
# File 'lib/active_shipping/package_item.rb', line 45

def grams(options = {})
  weight(options).in_grams.amount
end

#kilograms(options = {}) ⇒ Object Also known as: kg, kgs 



56
57
58
 
# File 'lib/active_shipping/package_item.rb', line 56

def kilograms(options = {})
  weight(options).in_kilograms.amount
end

#ounces(options = {}) ⇒ Object Also known as: oz 



40
41
42
 
# File 'lib/active_shipping/package_item.rb', line 40

def ounces(options = {})
  weight(options).in_ounces.amount
end

#pounds(options = {}) ⇒ Object Also known as: lb, lbs 



50
51
52
 
# File 'lib/active_shipping/package_item.rb', line 50

def pounds(options = {})
  weight(options).in_pounds.amount
end