report type (shipment, tracker, payment_log, etc) needs to be passed for create/retrieve/all (#56)

* report type (shipment, tracker, payment_log, etc) needs to be passed for create/retrieve/all

* [squash] use kwargs instead of positional params

* [squash] v3.6.0

Author: k-funk

CHANGELOG.md

@@ -3,6 +3,10 @@
 * Modernize tests; make tests able to run in parallel; etc.
 * Clarify in README and `setup.py` the supported Python versions
 
+### 3.6.0 2017-04-04
+
+* Changed Report CRUD signatures. requires report type to be passed
+
 ### 3.5.2 2017-02-14
 
 * Added `get_rates` method to Order objects

VERSION

@@ -1 +1 @@
-3.5.2
+3.6.0

easypost/__init__.py

@@ -950,19 +950,12 @@ def api_keys(self):
 
 class Report(AllResource, CreateResource):
 
-    REPORT_TYPES = {'shprep': 'shipment', 'plrep': 'payment_log', 'trkrep': 'tracker'}
-
     @classmethod
     def create(cls, api_key=None, **params):
         requestor = Requestor(api_key)
-        url = cls.class_url()
+        url = "%s/%s" % (cls.class_url(), params['type'])
         wrapped_params = {cls.class_name(): params}
 
-        if str(params['type']) in cls.REPORT_TYPES.values():
-            url += "/%s" % params['type']
-        else:
-            raise Exception("Undertermined Report Type")
-
         response, api_key = requestor.request('post', url, wrapped_params, False)
         return convert_to_easypost_object(response, api_key)
 
@@ -973,29 +966,15 @@ def retrieve(cls, easypost_id="", api_key=None, **params):
         except (KeyError, TypeError):
             pass
 
-        url = cls.class_url()
-
-        obj_id = easypost_id.split("_")[0]
-
-        if obj_id in cls.REPORT_TYPES:
-            url += "/%s/%s" % (cls.REPORT_TYPES[obj_id], easypost_id)
-        else:
-            raise Exception("Undetermined Report Type")
-
+        url = "%s/%s/%s" % (cls.class_url(), params['type'], easypost_id)
         requestor = Requestor(api_key)
         response, api_key = requestor.request('get', url)
         return convert_to_easypost_object(response, api_key)
 
     @classmethod
     def all(cls, api_key=None, **params):
         requestor = Requestor(api_key)
-        url = cls.class_url()
-
-        if str(params['type']) in cls.REPORT_TYPES.values():
-            url += "/%s" % params['type']
-        else:
-            raise Exception("Undertemined Report Type")
-
+        url = "%s/%s" % (cls.class_url(), params['type'])
         response, api_key = requestor.request('get', url, params)
         return convert_to_easypost_object(response, api_key)
 

tests/test_report.py

@@ -4,63 +4,22 @@
 
 
 def test_shipment_report():
-    report = easypost.Report.create(
-        start_date="2012-12-01",
-        end_date="2013-01-01",
-        type="shipment"
-    )
+    def test_shipment_report():
+        report = easypost.Report.create(
+            type="shipment",
+            start_date="2012-12-01",
+            end_date="2013-01-01",
+        )
 
-    assert report.object == "ShipmentReport"
-    assert report.status in ("available", "new")
-    assert report.__class__ == easypost.Report
+        assert report.object == "ShipmentReport"
+        assert report.status in ("available", "new")
+        assert report.__class__ == easypost.Report
 
-    report2 = easypost.Report.retrieve(report.id)
+        report2 = easypost.Report.retrieve(report.id, type="shipment")
 
-    assert report2.__class__ == easypost.Report
-    assert report2.id == report.id
+        assert report2.__class__ == easypost.Report
+        assert report2.id == report.id
 
-    reports = easypost.Report.all(type="shipment")
-    assert len(reports["reports"])
-    assert reports["reports"][0].id == report.id == report2.id
-
-
-def test_payment_log_report():
-    report = easypost.Report.create(
-        start_date="2012-12-01",
-        end_date="2013-01-01",
-        type="payment_log"
-    )
-
-    assert report.object == "PaymentLogReport"
-    assert report.status in ("available", "new")
-    assert report.__class__ == easypost.Report
-
-    report2 = easypost.Report.retrieve(report.id)
-
-    assert report2.__class__ == easypost.Report
-    assert report2.id == report.id
-
-    reports = easypost.Report.all(type="payment_log")
-    assert len(reports["reports"])
-    assert reports["reports"][0].id == report.id == report2.id
-
-
-def test_tracker_report():
-    report = easypost.Report.create(
-        start_date="2012-12-01",
-        end_date="2013-01-01",
-        type="tracker"
-    )
-
-    assert report.object == "TrackerReport"
-    # assert report.status == "available" # Not yet implemented for tracker reports
-    assert report.__class__ == easypost.Report
-
-    report2 = easypost.Report.retrieve(report.id)
-
-    assert report2.__class__ == easypost.Report
-    assert report2.id == report.id
-
-    reports = easypost.Report.all(type="tracker")
-    assert len(reports["reports"])
-    assert reports["reports"][0].id == report.id == report2.id
+        reports = easypost.Report.all(type="shipment")
+        assert len(reports["reports"])
+        assert reports["reports"][0].id == report.id == report2.id