Added models for customs items and intl options.

* Added `ShipStationInternationalOptions` class.
* Added `ShipStationCustomsItem` class.
* Included method for adding customs item to intl options.
* Included method for adding intl options to an order.
* Added basic tests for functionality via tox.

references natecox#2

Author: natecox

setup.py

@@ -23,5 +23,5 @@
     install_requires=['requests>=2.6.0'],
     license='MIT',
     packages=['shipstation'],
-    url='https://github.com/natecox/pyshipstation',
+    url='https://github.com/natecox/pyshipstation'
 )

shipstation/api.py

@@ -1,5 +1,6 @@
 import json
 import requests
+from decimal import Decimal
 
 
 class ShipStationBase(object):
@@ -22,6 +23,86 @@ def as_dict(self):
         return d
 
 
+class ShipStationCustomsItem(ShipStationBase):
+    def __init__(self,
+                 description=None,
+                 quantity=1,
+                 value=Decimal('0'),
+                 harmonized_tariff_code=None,
+                 country_of_origin=None):
+        self.description = description
+        self.quantity = quantity
+        self.value = value
+        self.harmonized_tariff_code = harmonized_tariff_code
+        self.country_of_origin = country_of_origin
+
+        if not self.description:
+            raise AttributeError('description may not be empty')
+        if not self.harmonized_tariff_code:
+            raise AttributeError('harmonized_tariff_code may not be empty')
+        if not self.country_of_origin:
+            raise AttributeError('country_of_origin may not be empty')
+        if len(self.country_of_origin) is not 2:
+            raise AttributeError('country_of_origin must be two characters')
+        if not isinstance(value, Decimal):
+            raise AttributeError('value must be decimal')
+
+
+class ShipStationInternationalOptions(ShipStationBase):
+    CONTENTS_VALUES = (
+        'merchandise',
+        'documents',
+        'gift',
+        'returned_goods',
+        'sample'
+    )
+
+    NON_DELIVERY_OPTIONS = (
+        'return_to_sender',
+        'treat_as_abandoned'
+    )
+
+    def __init__(self, contents=None, non_delivery=None):
+        self.customs_items = []
+        self.set_contents(contents)
+        self.set_non_delivery(non_delivery)
+
+    def set_contents(self, contents):
+        if contents:
+            if contents not in self.CONTENTS_VALUES:
+                raise AttributeError('contents value not valid')
+            self.contents = contents
+        else:
+            self.contents = None
+
+    def add_customs_item(self, customs_item):
+        if customs_item:
+            if not isinstance(customs_item, ShipStationCustomsItem):
+                raise AttributeError('must be of type ShipStationCustomsItem')
+            self.customs_items.append(customs_item)
+
+    def get_items(self):
+        return self.customs_items
+
+    def get_items_as_dicts(self):
+        return [x.as_dict() for x in self.customs_items]
+
+    def set_non_delivery(self, non_delivery):
+        if non_delivery:
+            if non_delivery not in self.NON_DELIVERY_OPTIONS:
+                raise AttributeError('non_delivery value is not valid')
+            self.non_delivery = non_delivery
+        else:
+            self.non_delivery = None
+
+    def as_dict(self):
+        d = super(ShipStationInternationalOptions, self).as_dict()
+
+        d['customsItems'] = self.get_items_as_dicts()
+
+        return d
+
+
 class ShipStationWeight(ShipStationBase):
     def __init__(self, units=None, value=None):
         self.units = units
@@ -226,6 +307,20 @@ def get_items(self):
     def get_items_as_dicts(self):
         return [x.as_dict() for x in self.items]
 
+    def set_international_options(self, options):
+        if not isinstance(options, ShipStationInternationalOptions):
+            raise AttributeError(
+                'options should be an instance of ' +
+                'ShipStationInternationalOptions'
+            )
+        self.international_options = options
+
+    def get_international_options_as_dict(self):
+        if self.international_options:
+            return self.international_options.as_dict()
+        else:
+            return None
+
     def as_dict(self):
         d = super(ShipStationOrder, self).as_dict()
 
@@ -234,6 +329,7 @@ def as_dict(self):
         d['billTo'] = self.get_billing_address_as_dict()
         d['shipTo'] = self.get_shipping_address_as_dict()
         d['weight'] = self.get_weight()
+        d['internationalOptions'] = self.get_international_options_as_dict()
 
         return d
 

tests.py

@@ -0,0 +1,73 @@
+import unittest
+from nose.tools import raises
+from shipstation.api import *
+from decimal import Decimal
+
+
+class ShipStationTests(unittest.TestCase):
+
+    def setUp(self):
+        self.ss = ShipStation('123', '456')
+        self.ss_order = ShipStationOrder()
+        self.ss_intl = ShipStationInternationalOptions()
+
+        self.ss_customs_item1 = ShipStationCustomsItem(
+            description='customs item',
+            quantity=1,
+            value=Decimal('10.00'),
+            harmonized_tariff_code='code',
+            country_of_origin='US'
+        )
+        self.ss_customs_item2 = ShipStationCustomsItem(
+            description='customs item two',
+            quantity=2,
+            value=Decimal('20.00'),
+            harmonized_tariff_code='code',
+            country_of_origin='US'
+        )
+
+    def tearDown(self):
+        self.ss = None
+        self.ss_order = None
+        self.ss_intl = None
+        self.ss_customs_item = None
+
+    def test_intl_options_accepts_customs_item(self):
+        self.ss_intl.add_customs_item(self.ss_customs_item1)
+        self.ss_intl.add_customs_item(self.ss_customs_item2)
+
+        expected = 2
+        actual = len(self.ss_intl.as_dict()['customsItems'])
+
+        self.assertEqual(expected, actual)
+
+    @raises(AttributeError)
+    def test_customs_item_must_have_description(self):
+        ShipStationCustomsItem(
+            description='',
+            harmonized_tariff_code='test',
+            country_of_origin='us'
+        )
+
+    @raises(AttributeError)
+    def test_customs_item_must_have_tariff_code(self):
+        ShipStationCustomsItem(
+            description='test',
+            harmonized_tariff_code='',
+            country_of_origin='us'
+        )
+
+    @raises(AttributeError)
+    def test_customs_item_must_have_country_code(self):
+        ShipStationCustomsItem(
+            description='test',
+            harmonized_tariff_code='test',
+        )
+
+    @raises(AttributeError)
+    def test_customs_item_must_have_two_character_country_code(self):
+        ShipStationCustomsItem(
+            description='test',
+            harmonized_tariff_code='test',
+            country_of_origin='something_else'
+        )

tests/test_customs_item.py

@@ -0,0 +1,47 @@
+import unittest
+from nose.tools import raises
+from shipstation.api import *
+from decimal import Decimal
+
+
+class ShipStationTests(unittest.TestCase):
+
+    def setUp(self):
+        self.ss = ShipStation('123', '456')
+        self.ss_order = ShipStationOrder()
+        self.ss_intl = ShipStationInternationalOptions()
+
+        self.ss_customs_item = ShipStationCustomsItem(
+            description='customs item',
+            quantity=1,
+            value=Decimal('10.00'),
+            harmonized_tariff_code='code',
+            country_of_origin='US'
+        )
+
+    def tearDown(self):
+        self.ss = None
+        self.ss_order = None
+        self.ss_intl = None
+        self.ss_customs_item = None
+
+    def test_order_accepts_international_options(self):
+        self.ss_intl.add_customs_item(self.ss_customs_item)
+        self.ss_intl.set_contents('documents')
+        self.ss_intl.set_non_delivery('return_to_sender')
+
+        self.ss_order.set_international_options(self.ss_intl)
+
+        expected = self.ss_intl.as_dict()
+        actual = self.ss_order.as_dict()['internationalOptions']
+
+        self.assertDictEqual(expected, actual)
+
+    @raises(AttributeError)
+    def test_international_options_contents_must_be_valid(self):
+        self.ss_intl.set_contents('something_else')
+
+    @raises(AttributeError)
+    def test_international_options_non_delivery_must_be_valid(self):
+        self.ss_intl.set_non_delivery('something_else')
+