Some refactoring

4 files changed, 175 insertions, 10 deletions

diff --git a/gsxws.py b/gsxws.py
index 9f77ea7..da917d6 100755
--- a/gsxws.py
+++ b/gsxws.py
@@ -268,9 +268,7 @@ class Content(GsxObject):
 
 
 class CompTIA(object):
-    """
-    Stores and accesses CompTIA codes.
-    """
+    "Stores and accesses CompTIA codes."
 
     MODIFIERS = (
         ("A", "Not Applicable"),
diff --git a/products.py b/products.py
index b0aa911..dc878f8 100644
--- a/products.py
+++ b/products.py
@@ -1,15 +1,16 @@
 import sys
+import suds
 from gsxws import connect, GsxError
 from repairs import GsxObject
 from lookups import Lookup
 
+
 class GsxRequest(object):
     def submit(self, method, data, attr=None):
-        """Submits the SOAP envelope
-        """
+        "Submits the SOAP envelope"
         from gsxws import CLIENT, SESSION
         f = getattr(CLIENT.service, method)
-        
+
         try:
             result = f(data)
             return getattr(result, attr) if attr else result
@@ -18,14 +19,14 @@ class GsxRequest(object):
 
 
 class Product(GsxObject, GsxRequest):
-    """Something serviceable that Apple makes
-    """
+    "Something serviceable that Apple makes"
     serialNumber = ""
     alternateDeviceId = ""
     configDescription = ""
 
     def model(self):
-        """Returns the model description of this Product
+        """
+        Returns the model description of this Product
 
         >>> Product(serialNumber='DGKFL06JDHJP').model().configDescription
         iMac (27-inch, Mid 2011)
@@ -39,7 +40,8 @@ class Product(GsxObject, GsxRequest):
         return result
 
     def warranty(self):
-        """The Warranty Status API retrieves the same warranty details
+        """
+        The Warranty Status API retrieves the same warranty details
         displayed on the GSX Coverage screen.
         If part information is provided, the part warranty information is returned.
         If you do not provide the optional part information in the
diff --git a/repairs.py b/repairs.py
index 94f9d46..2698664 100644
--- a/repairs.py
+++ b/repairs.py
@@ -68,6 +68,15 @@ class Repair(GsxObject):
 
     orderLines = []
 
+    TYPES = (
+        ('CA', "Carry-In/Non-Replinished"),
+        ('NE', "Return Before Replace"),
+        ('NT', "No Trouble Found"),
+        ('ON', "Onsite (Indirect/Direct)"),
+        ('RR', "Repair Or Replace/Whole Unit Mail-In"),
+        ('WH', "Mail-In"),
+    )
+
     def get_data(self):
         return {'repairData': self.data}
 
diff --git a/returns.py b/returns.py
new file mode 100644
index 0000000..4584b3e
--- /dev/null
+++ b/returns.py
@@ -0,0 +1,156 @@
+from gsxws import GsxObject
+
+RETURN_TYPES = (
+    (1, "Dead On Arrival"),
+    (2, "Good Part Return"),
+    (3, "Convert To Stock"),
+    (4, "Transfer to Out of Warranty"),
+)
+
+CARRIERS = (
+    ('XAER',    "Aero 2000"),
+    ('XAIRBEC', "Airborne"),
+    ('XAIRB',   "Airborne"),
+    ('XARM',    "Aramex"),
+    ('XOZP',    "Australia Post"),
+    ('XBAX',    "BAX GLOBAL PTE LTD"),
+    ('XCPW',    "CPW Internal"),
+    ('XCL',     "Citylink"),
+    ('XDHL',    "DHL"),
+    ('XDHLC',   "DHL"),
+    ('XDZNA',   "Danzas-AEI"),
+    ('XEAS',    "EAS"),
+    ('XEGL',    "Eagle ASIA PACIFIC HOLDINGS"),
+    ('XEXXN',   "Exel"),
+    ('XFEDE',   "FedEx"),
+    ('XFDE',    "FedEx Air"),
+    ('XGLS',    "GLS-General Logistics Systems"),
+    ('XHNF',    "H and Friends"),
+    ('XNGLN',   "Nightline"),
+    ('XPL',     "Parceline"),
+    ('XPRLA',   "Purolator"),
+    ('SDS',     "SDS An Post"),
+    ('XSNO',    "Seino Transportation Co. Ltd."),
+    ('XSTE',    "Star Track Express"),
+    ('XTNT',    "TNT"),
+    ('XUPSN',   "UPS"),
+    ('XUTI',    "UTi (Japan) K.K."),
+    ('XYMT',    "YAMATO"),
+)
+
+class Return(GsxObject):
+    def __init__(self, order_number=None, *args, **kwargs):
+        super(Returns, self).__init__(*args, **kwargs)
+
+        if order_number is not None:
+            self.data['returnOrderNumber'] = order_number
+
+    def get_pending(self):
+        """
+        The Parts Pending Return API returns a list of all parts that
+        are pending for return, based on the search criteria.
+
+        >>> Returns(repairType='CA').get_pending()  # doctest: +SKIP
+        """
+        dt = self._make_type('ns1:partsPendingReturnRequestType')
+        dt.repairData = self.data
+
+        return self.submit('PartsPendingReturn', dt, 'partsPendingResponse')
+
+    def get_report(self):
+        """
+        The Return Report API returns a list of all parts that are returned
+        or pending for return, based on the search criteria.
+        """
+        dt = self._make_type('ns1:returnReportRequestType')
+        dt.returnRequestData = self.data
+
+        return self.submit('ReturnReport', dt, 'returnResponseData')
+
+    def get_label(self, part_number):
+        """
+        The Return Label API retrieves the Return Label for a given Return Order Number.
+        (Type not found: 'comptiaCode')
+        so we're parsing the raw SOAP response and creating a "fake" return object from that.
+        """
+        if not validate(part_number, 'partNumber'):
+            raise ValueError('%s is not a valid part number' % part_number)
+
+        class ReturnData(dict):
+            pass
+
+        rd = ReturnData()
+
+        CLIENT.set_options(retxml=True)
+
+        dt = CLIENT.factory.create('ns1:returnLabelRequestType')
+        dt.returnOrderNumber = self.data['returnOrderNumber']
+        dt.partNumber = part_number
+        dt.userSession = SESSION
+
+        try:
+            result = CLIENT.service.ReturnLabel(dt)
+        except suds.WebFault, e:
+            raise GsxError(fault=e)
+
+        el = ET.fromstring(result).findall('*//%s' % 'returnLabelData')[0]
+
+        for r in el.iter():
+            k, v = r.tag, r.text
+            if k in ['packingList', 'proformaFileData', 'returnLabelFileData']:
+                v = base64.b64decode(v)
+                of = tempfile.NamedTemporaryFile(suffix=".pdf", delete=False)
+                of.write(v)
+                v = of.name
+
+            setattr(rd, k, v)
+
+        return rd
+
+    def get_proforma(self):
+        """
+        The View Bulk Return Proforma API allows you to view the proforma label
+        for a given Bulk Return Id. You can create a parts bulk return
+        by using the Register Parts for Bulk Return API.
+        """
+        pass
+
+    def register_parts(self, parts):
+        """
+        The Register Parts for Bulk Return API creates a bulk return for
+        the registered parts.
+        The API returns the Bulk Return Id with the packing list.
+        """
+        dt = self._make_type("ns1:registerPartsForBulkReturnRequestType")
+        self.data['bulkReturnOrder'] = parts
+        dt.bulkPartsRegistrationRequest = self.data
+
+        result = self.submit("RegisterPartsForBulkReturn", dt, "bulkPartsRegistrationData")
+
+        pdf = base64.b64decode(result.packingList)
+        of = tempfile.NamedTemporaryFile(suffix=".pdf", delete=False)
+        of.write(pdf)
+        result.packingList = of.name
+
+        return result
+
+    def update_parts(self, confirmation, parts):
+        """
+        The Parts Return Update API allows you to mark a part
+        with the status GPR(2), DOA(1), CTS(3), or TOW(4).
+        The API can be used only by ASP.
+
+        >>> Returns().update_parts('G135877430',\
+        [{'partNumber': '661-5174',\
+        'comptiaCode': 'Z29',\
+        'comptiaModifier': 'A',\
+        'returnType': 2}])
+        """
+        dt = self._make_type("ns1:partsReturnUpdateRequestType")
+        repairData = {
+            'repairConfirmationNumber': confirmation,
+            'orderLines': parts
+        }
+        dt.repairData = repairData
+        result = self.submit("PartsReturnUpdate", dt)
+        return result