Adding documentation and object to 'create' function.

README.rst

@@ -6,7 +6,8 @@
 Pygerduty
 =========
 
-Python Library for PagerDuty's v1 REST API.
+Python Library for PagerDuty's REST API and Events API. This library was originally written to support v1 and
+is currently being updated to be compatible with v2 of the API. See "Migrating from v1 to v2" for more details.
 
 This library is currently evolving and backwards compatibility cannot always be guaranteed at this time.
 
@@ -42,16 +43,40 @@ Top level resources will be accessible via the PagerDuty object and nested
 resources available on containers returned from their parent resource.
 
 
+Migrating from v1 to v2
+=======================
+
+In order to allow for a smooth transition between versions 1 and 2 of the library,
+version 1 library remains in the file called `__init__.py` inside of the pygerduty directory.
+Also in that directory you will see four other files:
+
+- `v2.py` — This file contains all updated logic compatible with v2 of the API.
+- `events.py` — PygerDuty also provides an Events API which is separate from the REST API that has had the recent update. Since the logic is mostly disjoint, we have created a new module for logic related to the Events API.
+- `common.py` — This file contains all common functions used by both `v2.py` and `events.py`.
+- `version.py` — Contains version info.
+
+See the examples below to see how this affects how you will instantiate a client in v2.
+
+
 Examples
 ========
 
 Instantiating a client:
 
+Version 1:
+
 ::
 
     import pygerduty
     pager = pygerduty.PagerDuty("foobar", "SOMEAPIKEY123456")
 
+Version 2:
+
+::
+
+    import pygerduty.v2
+    pager = pygerduty.v2.PagerDuty("SOMEAPIKEY123456")
+
 Listing a resource:
 
 ::

pygerduty/v2.py

@@ -71,11 +71,38 @@ def create(self, **kwargs):
         if "requester_id" in kwargs:
             extra_headers["From"] = kwargs.pop("requester_id")
 
-        data[self.sname] = kwargs
+        new_kwargs = {}
+
+        for kwarg_key, kwarg_value in kwargs.iteritems():
+            if kwarg_key.endswith('_id'):
+                new_kwargs = Collection.id_to_obj(kwarg_key, kwarg_value)
+            elif kwarg_key.endswith('_ids'):
+                new_kwargs = Collection.ids_to_objs(kwarg_key, kwarg_value)
+            else:
+                new_kwargs[kwarg_key] = kwarg_value
+        data[self.sname] = new_kwargs
 
         response = self.pagerduty.request("POST", path, data=_json_dumper(data), extra_headers=extra_headers)
         return self.container(self, **response.get(self.sname, {}))
 
+    @staticmethod
+    def id_to_obj(key, value):
+        new_key = key[:-3]
+        if key.endswith('_ids'):
+            new_key = key[:-4] + "s"
+        return {
+            "id": value,
+            "type": new_key
+        }
+
+    @staticmethod
+    def ids_to_objs(key, value):
+        new_kwargs = []
+        for v in value:
+            new_kwarg = Collection.id_to_obj(key, v)
+            new_kwargs.append(new_kwarg)
+        return new_kwargs
+
     def update(self, entity_id, **kwargs):
         path = "{0}/{1}".format(self.name, entity_id)
         if self.base_container:
@@ -268,6 +295,9 @@ def update(self, entity_id, **kwargs):
 
 
 class ScheduleUsers(Collection):
+    """This class exists because Users returned from a Schedule query are not
+    paginated, whereas responses for Users class are. This causes a pagination
+    bug if removed."""
     name = 'users'
     paginated = False
 

tests/collection_test.py

@@ -0,0 +1,43 @@
+from __future__ import absolute_import
+
+import pygerduty.v2
+
+###################
+# Version 2 Tests #
+###################
+
+def test_id_to_obj():
+
+	kwarg = {
+		"escalation_policy_id": "PIJ90N7",
+	}
+
+	new_kwarg = pygerduty.v2.Collection.id_to_obj("escalation_policy_id", kwarg["escalation_policy_id"])
+
+	assert new_kwarg == {
+		"id": "PIJ90N7",
+		"type": "escalation_policy"
+	}
+
+
+def test_ids_to_objs():
+
+    kwarg = {
+        "service_ids": [
+            "PF9KMXH",
+            "PIJ90N7"
+        ]
+    }
+
+    new_kwargs = pygerduty.v2.Collection.ids_to_objs("service_ids", kwarg["service_ids"])
+
+    assert new_kwargs == [
+        {
+    	    "id": "PF9KMXH",
+    	    "type": "services"
+        },
+        {
+            "id": "PIJ90N7",
+            "type": "services"
+        }
+    ]