Adding 'get segment subscribers' method

Author: 0xbepresent

README.md

@@ -37,3 +37,10 @@ import pushcrew
 project = pushcrew.Api('5374d7dfeffa2eb49965624ba7596a09')
 project.remove_subscriber_from_segment('254256', ["8fcd1d68c82dd39d65ef8ea9a7948bbe"])
 ```
+
+* Get segment subscribers.
+```
+import pushcrew
+project = pushcrew.Api('5374d7dfeffa2eb49965624ba7596a09')
+project.get_subscribers_from_segment(segment_id=25)
+```

pushcrew/schemas/base.py

@@ -34,7 +34,6 @@ def create_object_from_json(object_name, res, many=False):
     schema = schema_class(object_name, many=many)
 
     user_data = res.json(parse_float=Decimal)
-    print user_data
     result = schema.load(user_data)
     return result
 
@@ -45,12 +44,15 @@ def _get_schema_class(object_name):
     based on the object_name.
     '''
     # Key is the name of the object, value is the schema class
-    from .segment import SegmentsSchema, AddSegmentSchema, StatusSchema
+    from .segment import (
+        SegmentsSchema, AddSegmentSchema, StatusSchema,
+        SegmentSubscribersSchema)
 
     schema_dict = {
         'Segments': SegmentsSchema,
         'AddSegment': AddSegmentSchema,
-        'StatusSegment': StatusSchema
+        'StatusSegment': StatusSchema,
+        'SegmentSubscribers': SegmentSubscribersSchema
     }
 
     schema_class = schema_dict.get(object_name)

pushcrew/schemas/segment.py

@@ -1,6 +1,7 @@
 from marshmallow import fields, post_load, Schema
 
 from .base import BaseSchema
+from .subscriber import SubscriberSchema
 
 
 class SegmentSchema(Schema):
@@ -49,3 +50,15 @@ class StatusSchema(Schema):
     @post_load()
     def post_load(self, data):
         return BaseSchema.create_object('SatusSegment', data)
+
+
+class SegmentSubscribersSchema(Schema):
+    status = fields.String(data_key='status')
+    count_active = fields.Integer(data_key='count_active')
+    count_total = fields.Integer(data_key='count_total')
+    next_page = fields.String(data_key='next_page')
+    subscriber_list = fields.Nested(SubscriberSchema, many=True)
+
+    @post_load()
+    def post_load(self, data):
+        return BaseSchema.create_object('SegmentSubscribers', data)

pushcrew/schemas/subscriber.py

@@ -0,0 +1,29 @@
+from marshmallow import fields, post_load, Schema
+
+from .base import BaseSchema
+
+
+class SubscriberSchema(Schema):
+    """
+    Subscriber Schema
+    """
+    subscriber_id = fields.String(data_key="subscriber_id")
+    ip_address = fields.String(data_key="ip_address")
+    user_agent = fields.String(data_key="user_agent")
+    browser = fields.String(data_key="browser")
+    browser_version = fields.String(data_key="browser_version")
+    platform = fields.String(data_key="platform")
+    device_platform = fields.String(data_key="device_platform")
+    operating_system = fields.String(data_key="operating_system")
+    device = fields.String(data_key="device")
+    country = fields.String(data_key="country")
+    region = fields.String(data_key="region")
+    city = fields.String(data_key="city")
+    is_inactive = fields.Boolean(data_key="is_inactive")
+    is_ghost = fields.Boolean(data_key="is_ghost")
+    subscriber_added_timestamp = fields.String(data_key="subscriber_added_timestamp")
+    added_to_segment_timestamp = fields.String(data_key="added_to_segment_timestamp")
+
+    @post_load()
+    def post_load(self, data):
+        return BaseSchema.create_object('Subscriber', data)

pushcrew/services/segments.py

@@ -45,3 +45,22 @@ def remove_subscriber_from_segment(self, segment_id, delete_list):
         response = self.pushcrew.segments(segment_id).subscribers().PUT(
             data=params)
         return create_object_from_json('StatusSegment', response)
+
+    def get_subscribers_from_segment(self, segment_id):
+        """
+        This endpoint is used to get a list of subscribers present in a
+        segment.
+        The request method of this call needs to be "GET".
+        """
+        response = self.pushcrew.segments(segment_id).subscribers().GET(
+            params={'page': 1, 'per_page': 1024})
+        cf = create_object_from_json('SegmentSubscribers', response)
+        pages = int((cf.data.count_total / 1024) + 2)
+        subscribers_list = [] + cf.data.subscriber_list
+        for page in range(2, pages):
+            response = self.pushcrew.segments(
+                segment_id).subscribers().GET(
+                    params={'page': page, 'per_page': 1024})
+            cf = create_object_from_json('SegmentSubscribers', response)
+            subscribers_list = subscribers_list + cf.data.subscriber_list
+        return subscribers_list