Merge pull request #3 from borisvaweber/master

findSubscribers and get_parent_entry changes.

Author: aweber

aweber_api/collection.py

@@ -2,6 +2,7 @@
 from urlparse import parse_qs
 from urllib import urlencode
 from aweber_api.response import AWeberResponse
+from aweber_api.base import API_BASE
 
 class AWeberCollection(AWeberResponse):
     """
@@ -42,7 +43,7 @@ def _load_page_for_offset(self, offset):
         self._key_entries(response)
 
     def _get_page_params(self, offset):
-        next_link = self._data['next_collection_link']
+        next_link = self._data.get('next_collection_link', '')
         url, query = next_link.split('?')
         query_parts = parse_qs(query)
         self.page_size = int(query_parts['ws.size'][0])
@@ -83,10 +84,28 @@ def _get_total_size(self, uri, **kwargs):
         total_size_uri = '{0}&ws.show=total_size'.format(uri)
         return self.adapter.request('GET', total_size_uri)
 
+    # This method gets a collection's parent entry
+    # Or returns None if no parent entry
+    def get_parent_entry(self):
+        from aweber_api.entry import AWeberEntry
+        url_parts = self.url.split('/')
+        #If top of tree - no parent entry
+        if len(url_parts) <= 3:
+            return None
+        size = len(url_parts)
+        #Remove collection id and slash from end of url
+        url = self.url[:-len(url_parts[size-1])-1]
+        data = self.adapter.request('GET', url)
+        try:
+            entry = AWeberEntry(url, data, self.adapter)
+        except TypeError:
+            return False
+        return entry
+
     def _create_entry(self, offset):
         from aweber_api.entry import AWeberEntry
         data = self._entry_data[offset]
-        url = "{0}/{1}".format(self.url, data['id'])
+        url = data['self_link'].replace(API_BASE, '')
         self._entries[offset] = AWeberEntry(url, data, self.adapter)
 
     def __len__(self):

aweber_api/entry.py

@@ -1,5 +1,6 @@
 from aweber_api.response import AWeberResponse
 from aweber_api.data_dict import DataDict
+from urllib import urlencode
 
 class AWeberEntry(AWeberResponse):
     """
@@ -70,12 +71,60 @@ def save(self):
             return True
         return False
 
+    def findSubscribers(self, **kwargs):
+        from aweber_api import AWeberCollection
+        self._method_for('account')
+        params = {'ws.op': 'findSubscribers'}
+        params.update(kwargs)
+        query_string = urlencode(params)
+        url = '{0.url}?{1}'.format(self, query_string)
+        data = self.adapter.request('GET', url)
+        try:
+            collection = AWeberCollection(url, data, self.adapter)
+        except TypeError:
+            print 'meow'
+            return False
+
+        # collections return total_size_link
+        collection._data['total_size'] = self._get_total_size(url)
+        return collection
+
+    def _get_total_size(self, uri, **kwargs):
+        """Get actual total size number from total_size_link."""
+        total_size_uri = '{0}&ws.show=total_size'.format(uri)
+        return self.adapter.request('GET', total_size_uri)
+
+    # This method gets an entry's parent entry
+    # Or returns None if no parent entry
+    def get_parent_entry(self):
+        url_parts = self.url.split('/')
+        size = len(url_parts)
+        #Remove entry id and slash from end of url
+        url = self.url[:-len(url_parts[size-1])-1]
+        #Remove collection name and slash from end of url
+        url = url[:-len(url_parts[size-2])-1]
+        data = self.adapter.request('GET', url)
+        try:
+            entry = AWeberEntry(url, data, self.adapter)
+        #Top of tree
+        except TypeError:
+            return None
+        return entry
+
     def get_web_forms(self):
         self._method_for('account')
         data = self.adapter.request('GET',
                                     "{0}?ws.op=getWebForms".format(self.url))
         return self._parseNamedOperation(data)
 
+    def get_web_form_split_tests(self):
+        self._method_for('account')
+        data = self.adapter.request(
+            'GET',
+            "{0}?ws.op=getWebFormSplitTests".format(self.url),
+        )
+        return self._parseNamedOperation(data)
+
     def _child_collection(self, attr):
         if not attr in self._child_collections:
             url = "{0}/{1}".format(self.url, attr)

tests/data/accounts/findSubscribers.json

@@ -0,0 +1 @@
+{"start": 0, "total_size_link": "https://api.aweber.com/1.0/accounts/1?email=joe%40example.com&ws.op=findSubscribers&ws.show=total_size", "entries": [{"subscription_url": "https://www.aweber.com/users/leads/add", "postal_code": "14450", "id": 52629234, "custom_fields": {"NewCustomField": "really awesome", "YourCustomField": "NewValue"}, "last_followup_sent_link": "https://api.aweber.com/1.0/accounts/1/lists/496562/campaigns/f3548399", "city": "Fairport", "http_etag": "\"223a06015fdd0daaef1b561aee4f10176513e346-075619e34cfd24154382b5a53939132945e96ce3\"", "ad_tracking": "control panel", "dma_code": 538, "last_followup_message_number_sent": 3, "last_followup_sent_at": "2011-03-02 14:47:22.797206-05:00", "misc_notes": "", "self_link": "https://api.aweber.com/1.0/accounts/1/lists/303449/subscribers/1", "is_verified": true, "email": "joe@example.com", "status": "subscribed", "unsubscribed_at": null, "area_code": 585, "latitude": 43.100499999999997, "unsubscribe_method": null, "ip_address": "192.168.10.10", "name": "Joe User", "subscription_method": "signup form", "resource_type_link": "https://api.aweber.com/1.0/#subscriber", "region": "NY", "longitude": -77.426000000000002, "verified_at": "2011-02-15 13:37:23", "subscribed_at": "2011-02-15 13:27:28-05:00", "country": "United States"}]}

tests/data/accounts/findSubscribers_ts.json

@@ -0,0 +1 @@
+1

tests/data/accounts/webFormSplitTests.json

@@ -0,0 +1 @@
+[{"javascript_source_link": "http://forms.aweber.com/form/40/split_1855537940.js", "name": "Split test test", "components_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/1115098/web_form_split_tests/1855537940/components", "is_active": true, "http_etag": "\"b233a000ec4c29e928c514a253a15684a410fa4e-ca5feee2b7fbb6febfca8af5541541ea960aaedb\"", "self_link": "https://api.aweber.com/1.0/accounts/1/lists/1115098/web_form_split_tests/1855537940", "resource_type_link": "https://api.aweber.com/1.0/#web_form_split_test", "id": 1855537940}, {"javascript_source_link": "http://forms.aweber.com/form/13/split_1532806713.js", "name": "boristest", "components_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/1108070/web_form_split_tests/1532806713/components", "is_active": true, "http_etag": "\"84edfbf4844a7a322bc379038974c0ce9871c1cd-ca5feee2b7fbb6febfca8af5541541ea960aaedb\"", "self_link": "https://api.aweber.com/1.0/accounts/1/lists/1108070/web_form_split_tests/1532806713", "resource_type_link": "https://api.aweber.com/1.0/#web_form_split_test", "id": 1532806713}, {"javascript_source_link": "http://forms.aweber.com/form/77/split_534926677.js", "name": "dsdf", "components_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/1108070/web_form_split_tests/534926677/components", "is_active": true, "http_etag": "\"3b72341343ae33364cbb88255b27faa0502eeaa4-ca5feee2b7fbb6febfca8af5541541ea960aaedb\"", "self_link": "https://api.aweber.com/1.0/accounts/1/lists/1108070/web_form_split_tests/534926677", "resource_type_link": "https://api.aweber.com/1.0/#web_form_split_test", "id": 534926677}, {"javascript_source_link": "http://forms.aweber.com/form/75/split_728276575.js", "name": "Split test 1", "components_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/772516/web_form_split_tests/728276575/components", "is_active": true, "http_etag": "\"178f16c2c921b30ea27b1f367005873c6de01c3b-ca5feee2b7fbb6febfca8af5541541ea960aaedb\"", "self_link": "https://api.aweber.com/1.0/accounts/1/lists/772516/web_form_split_tests/728276575", "resource_type_link": "https://api.aweber.com/1.0/#web_form_split_test", "id": 728276575}, {"javascript_source_link": "http://forms.aweber.com/form/48/split_1607797548.js", "name": "Split Test", "components_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/772516/web_form_split_tests/1607797548/components", "is_active": true, "http_etag": "\"67201f06d0d014c17dcde6b0a272535f6e569e79-ca5feee2b7fbb6febfca8af5541541ea960aaedb\"", "self_link": "https://api.aweber.com/1.0/accounts/1/lists/772516/web_form_split_tests/1607797548", "resource_type_link": "https://api.aweber.com/1.0/#web_form_split_test", "id": 1607797548}, {"javascript_source_link": "http://forms.aweber.com/form/26/split_1252500526.js", "name": "Default", "components_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/226186/web_form_split_tests/1252500526/components", "is_active": true, "http_etag": "\"3516cfad8b8d86f837c3c96a80537437fd774423-ca5feee2b7fbb6febfca8af5541541ea960aaedb\"", "self_link": "https://api.aweber.com/1.0/accounts/1/lists/226186/web_form_split_tests/1252500526", "resource_type_link": "https://api.aweber.com/1.0/#web_form_split_test", "id": 1252500526}, {"javascript_source_link": "http://forms.aweber.com/form/35/split_917592535.js", "name": "sdfsdf", "components_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/496562/web_form_split_tests/917592535/components", "is_active": true, "http_etag": "\"aa9292397447f3a0a75a377c258112d8c0533f2f-ca5feee2b7fbb6febfca8af5541541ea960aaedb\"", "self_link": "https://api.aweber.com/1.0/accounts/1/lists/496562/web_form_split_tests/917592535", "resource_type_link": "https://api.aweber.com/1.0/#web_form_split_test", "id": 917592535}, {"javascript_source_link": "http://forms.aweber.com/form/44/split_1012223044.js", "name": "My splittest", "components_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/406860/web_form_split_tests/1012223044/components", "is_active": true, "http_etag": "\"a69aca22c1f557260d2e977974400ded9830d288-ca5feee2b7fbb6febfca8af5541541ea960aaedb\"", "self_link": "https://api.aweber.com/1.0/accounts/1/lists/406860/web_form_split_tests/1012223044", "resource_type_link": "https://api.aweber.com/1.0/#web_form_split_test", "id": 1012223044}, {"javascript_source_link": "http://forms.aweber.com/form/72/split_1470252472.js", "name": "Split Test", "components_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/406860/web_form_split_tests/1470252472/components", "is_active": true, "http_etag": "\"32123e40a437467f56cbc2d937196af63521b106-ca5feee2b7fbb6febfca8af5541541ea960aaedb\"", "self_link": "https://api.aweber.com/1.0/accounts/1/lists/406860/web_form_split_tests/1470252472", "resource_type_link": "https://api.aweber.com/1.0/#web_form_split_test", "id": 1470252472}, {"javascript_source_link": "http://forms.aweber.com/form/63/split_612763163.js", "name": "Popover/Inline Split", "components_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/406860/web_form_split_tests/612763163/components", "is_active": true, "http_etag": "\"527d810ab00669964ab634395cded77c12af7a9c-ca5feee2b7fbb6febfca8af5541541ea960aaedb\"", "self_link": "https://api.aweber.com/1.0/accounts/1/lists/406860/web_form_split_tests/612763163", "resource_type_link": "https://api.aweber.com/1.0/#web_form_split_test", "id": 612763163}]

tests/mock_adapter.py

@@ -13,7 +13,13 @@
     'GET' : {
         '/accounts':                                ({}, 'accounts/page1'),
         '/accounts/1':                              ({}, 'accounts/1'),
+        '/accounts/1?ws.op=findSubscribers&' \
+                         'email=joe%40example.com': ({}, 'accounts/findSubscribers'),
+        '/accounts/1?ws.op=findSubscribers&' \
+                         'email=joe%40example.com&' \
+                         'ws.show=total_size': ({}, 'accounts/findSubscribers_ts'),
         '/accounts/1?ws.op=getWebForms':            ({}, 'accounts/webForms'),
+        '/accounts/1?ws.op=getWebFormSplitTests':   ({}, 'accounts/webFormSplitTests'),
         '/accounts/1/lists':                        ({}, 'lists/page1'),
         '/accounts/1/lists?ws.start=20&ws.size=20': ({}, 'lists/page2'),
         '/accounts/1/lists/303449':                 ({}, 'lists/303449'),

tests/test_aweber_collection.py

@@ -1,5 +1,6 @@
 from unittest import TestCase
 from aweber_api import AWeberAPI, AWeberCollection, AWeberEntry
+from aweber_api.base import API_BASE
 from mock_adapter import MockAdapter
 
 
@@ -63,6 +64,13 @@ def test_find_should_handle_errors(self):
         assert request['url'] == \
             '{0}?ws.op=find&name=joe'.format(base_url)
 
+    def test_should_create_entries_with_correct_url(self):
+        base_url = '/accounts/1'
+        account = self.aweber.load_from_url(base_url)
+        subscribers = account.findSubscribers(email='joe@example.com')
+        for subscriber in subscribers:
+            assert subscriber.url == subscriber.self_link.replace(API_BASE, '')
+
 
 class TestCreatingCustomFields(TestCase):
 
@@ -97,3 +105,30 @@ def test_should_refresh_cf_resource(self):
         self.assertEqual(self.get_req['method'], 'GET')
         self.assertEqual(self.get_req['url'] ,
             '/accounts/1/lists/303449/custom_fields/2')
+
+
+class TestGettingParentEntry(TestCase):
+
+    def setUp(self):
+        self.aweber = AWeberAPI('1', '2')
+        self.aweber.adapter = MockAdapter()
+        self.lists = self.aweber.load_from_url('/accounts/1/lists')
+        self.accounts = self.aweber.load_from_url('/accounts')
+        self.custom_fields = self.aweber.load_from_url('/accounts/1/lists/303449/custom_fields')
+
+    def test_should_be_able_get_parent_entry(self):
+        entry = self.lists.get_parent_entry()
+
+    def test_lists_parent_should_be_account(self):
+        entry = self.lists.get_parent_entry()
+        self.assertEqual(type(entry), AWeberEntry)
+        self.assertEqual(entry.type, 'account')
+
+    def test_custom_fields_parent_should_be_list(self):
+        entry = self.custom_fields.get_parent_entry()
+        self.assertEqual(type(entry), AWeberEntry)
+        self.assertEqual(entry.type, 'list')
+
+    def test_accounts_parent_should_be_none(self):
+        entry = self.accounts.get_parent_entry()
+        self.assertEqual(entry, None)

tests/test_aweber_entry.py

@@ -27,6 +27,17 @@ def test_should_have_child_collections(self):
         campaigns = self.list.campaigns
         self.assertEqual(type(campaigns), AWeberCollection)
 
+    def test_findSubscribers_should_handle_errors(self):
+        base_url = '/accounts/1'
+        account = self.aweber.load_from_url(base_url)
+        self.aweber.adapter.requests = []
+        subscribers = account.findSubscribers(name='bob')
+        request = self.aweber.adapter.requests[0]
+
+        assert subscribers == False
+        assert request['url'] == \
+            '{0}?ws.op=findSubscribers&name=bob'.format(base_url)
+
 class TestAWeberAccountEntry(TestCase):
 
     def setUp(self):
@@ -41,6 +52,9 @@ def test_should_be_an_entry(self):
     def test_should_be_able_get_web_forms(self):
         forms = self.account.get_web_forms()
 
+    def test_should_be_able_get_web_form_split_tests(self):
+        forms = self.account.get_web_form_split_tests()
+
 class TestAccountGetWebForms(TestAWeberAccountEntry):
 
     def setUp(self):
@@ -63,6 +77,43 @@ def test_each_should_have_correct_url(self):
         for entry in self.forms:
             self.assertTrue(re.match(url_regex, entry.url))
 
+class TestAccountGetWebFormSplitTests(TestAWeberAccountEntry):
+
+    def setUp(self):
+        TestAWeberAccountEntry.setUp(self)
+        self.forms = self.account.get_web_form_split_tests()
+
+    def test_should_be_a_list(self):
+        self.assertEqual(type(self.forms), list)
+
+    def test_should_have_10_split_tests(self):
+        self.assertEqual(len(self.forms), 10)
+
+    def test_each_should_be_entry(self):
+        for entry in self.forms:
+            self.assertEqual(type(entry), AWeberEntry)
+            self.assertEqual(entry.type, 'web_form_split_test')
+
+    def test_each_should_have_correct_url(self):
+        url_regex = '/accounts\/1\/lists\/\d*/web_form_split_tests/\d*'
+        for entry in self.forms:
+            self.assertTrue(re.match(url_regex, entry.url))
+
+class TestAccountFindSubscribers(TestAWeberAccountEntry):
+
+    def test_should_support_find_method(self):
+        base_url = '/accounts/1'
+        account = self.aweber.load_from_url(base_url)
+        self.aweber.adapter.requests = []
+        subscribers = account.findSubscribers(email='joe@example.com')
+        request = self.aweber.adapter.requests[0]
+
+        assert subscribers != False
+        assert isinstance(subscribers, AWeberCollection)
+        assert len(subscribers) == 1
+        assert subscribers[0].self_link == \
+                'https://api.aweber.com/1.0/accounts/1/lists/303449/subscribers/1'
+
 class TestSubscriber(TestCase):
 
     def setUp(self):
@@ -210,3 +261,30 @@ def setUp(self):
 
     def test_should_have_failed(self):
         self.assertFalse(self.response)
+
+class TestGettingParentEntry(TestCase):
+
+    def setUp(self):
+        self.aweber = AWeberAPI('1', '2')
+        self.aweber.adapter = MockAdapter()
+        self.list = self.aweber.load_from_url('/accounts/1/lists/303449')
+        self.account = self.aweber.load_from_url('/accounts/1')
+        self.custom_field = self.aweber.load_from_url('/accounts/1/lists/303449/custom_fields/1')
+
+    def test_should_be_able_get_parent_entry(self):
+        entry = self.list.get_parent_entry()
+
+    def test_list_parent_should_be_account(self):
+        entry = self.list.get_parent_entry()
+        self.assertEqual(type(entry), AWeberEntry)
+        self.assertEqual(entry.type, 'account')
+
+    def test_custom_field_parent_should_be_list(self):
+        entry = self.custom_field.get_parent_entry()
+        self.assertEqual(type(entry), AWeberEntry)
+        self.assertEqual(entry.type, 'list')
+
+    def test_account_parent_should_be_none(self):
+        entry = self.account.get_parent_entry()
+        self.assertEqual(entry, None)
+