Renaming Watchlist to Watchlists, watchlist to watchlists.

Author: Tom Longson

blockscore/api/__init__.py

@@ -2,4 +2,4 @@
 from blockscore.api import people
 from blockscore.api import question_sets
 from blockscore.api import companies
-from blockscore.api import watchlist
+from blockscore.api import watchlists

blockscore/api/watchlist.py blockscore/api/watchlists.pyblockscore/api/watchlist.py renamed to blockscore/api/watchlists.py

@@ -1,8 +1,8 @@
-WATCHLIST_CANDIDATE_URI = '/candidates'
-WATCHLIST_SEARCH_URI = '/watchlists'
+WATCHLISTS_CANDIDATE_URI = '/candidates'
+WATCHLISTS_SEARCH_URI = '/watchlists'
 
 
-class Watchlist():
+class Watchlists():
   def __init__(self, client):
     self.client = client
 
@@ -31,31 +31,31 @@ def _create_body(date_of_birth=None, identification=None,
 
   def create(self, **kwargs):
     body = self._create_body(**kwargs)
-    return self.client.post(WATCHLIST_CANDIDATE_URI, body)
+    return self.client.post(WATCHLISTS_CANDIDATE_URI, body)
 
-  def edit(self, watchlist_candidate_id, **kwargs):
+  def edit(self, watchlists_candidate_id, **kwargs):
     body = self._create_body(**kwargs)
-    return self.client.patch("%s/%s" % (WATCHLIST_CANDIDATE_URI,
-                      watchlist_candidate_id), body)
+    return self.client.patch("%s/%s" % (WATCHLISTS_CANDIDATE_URI,
+                      watchlists_candidate_id), body)
 
-  def retrieve(self, watchlist_candidate_id):
-    return self.client.get("%s/%s" % (WATCHLIST_CANDIDATE_URI,
-                      watchlist_candidate_id))
+  def retrieve(self, watchlists_candidate_id):
+    return self.client.get("%s/%s" % (WATCHLISTS_CANDIDATE_URI,
+                      watchlists_candidate_id))
 
-  def delete(self, watchlist_candidate_id):
-    return self.client.delete("%s/%s" % (WATCHLIST_CANDIDATE_URI,
-                       watchlist_candidate_id))
+  def delete(self, watchlists_candidate_id):
+    return self.client.delete("%s/%s" % (WATCHLISTS_CANDIDATE_URI,
+                       watchlists_candidate_id))
 
   def list(self, count=None, offset=None):
     body = {
       'count': count,
       'offset': offset
     }
-    return self.client.get(WATCHLIST_CANDIDATE_URI, body)
+    return self.client.get(WATCHLISTS_CANDIDATE_URI, body)
 
-  def search(self, watchlist_candidate_id, match_type=None):
+  def search(self, watchlists_candidate_id, match_type=None):
     body = {
-      'candidate_id': watchlist_candidate_id,
+      'candidate_id': watchlists_candidate_id,
       'match_type': match_type
     }
-    return self.client.post(WATCHLIST_SEARCH_URI, body)
+    return self.client.post(WATCHLISTS_SEARCH_URI, body)

blockscore/client.py

@@ -5,7 +5,7 @@
 from blockscore.api.question_sets import QuestionSets
 from blockscore.api.companies import Companies
 #from .api.verification import Verification
-from blockscore.api.watchlist import Watchlist
+from blockscore.api.watchlists import Watchlists
 
 class Client():
 
@@ -15,5 +15,5 @@ def __init__(self, auth = {}, options = {}):
     self.question_sets = QuestionSets(self.http_client)
     self.companies = Companies(self.http_client)
     #self.verification = Verification(self.http_client)
-    self.watchlist = Watchlist(self.http_client)
+    self.watchlists = Watchlists(self.http_client)
 

test/watchlist.py test/watchlists.pytest/watchlist.py renamed to test/watchlists.py

@@ -8,7 +8,7 @@
 from unittest import skip
 import time
 
-class TestWatchlistAPI(unittest.TestCase):
+class TestWatchlistsAPI(unittest.TestCase):
   def setUp(self):
     try:
       self.client = blockscore.Client({'api_key': os.environ['BLOCKSCORE_API']})
@@ -39,7 +39,7 @@ def setUp(self):
     }
 
   def test_create_body(self):
-    body = self.client.watchlist._create_body(**self.test_identity)
+    body = self.client.watchlists._create_body(**self.test_identity)
     self.assertDictEqual({
       'ssn': self.test_identity['identification']['ssn'],
       'date_of_birth': self.test_identity['date_of_birth'],
@@ -57,57 +57,57 @@ def test_create_body(self):
     }, body)
 
   def test_create_candidate(self):
-    candidate = self.client.watchlist.create(**self.test_identity)
-    expected_body = self.client.watchlist._create_body(**self.test_identity)
+    candidate = self.client.watchlists.create(**self.test_identity)
+    expected_body = self.client.watchlists._create_body(**self.test_identity)
     self.assertDictContainsSubset(expected_body, candidate.body)
 
   def test_edit_candidate(self):
-    candidate_id = self.client.watchlist.create(**self.test_identity).body['id']
-    candidate = self.client.watchlist.edit(candidate_id, date_of_birth='1980-01-02')
+    candidate_id = self.client.watchlists.create(**self.test_identity).body['id']
+    candidate = self.client.watchlists.edit(candidate_id, date_of_birth='1980-01-02')
     self.test_identity['date_of_birth'] = '1980-01-02'
-    expected_body = self.client.watchlist._create_body(**self.test_identity)
+    expected_body = self.client.watchlists._create_body(**self.test_identity)
     expected_body['id'] = candidate_id
     self.assertDictContainsSubset(expected_body, candidate.body)
 
   def test_retrieve_candidate(self):
-    candidate_id = self.client.watchlist.create(**self.test_identity).body['id']
-    candidate = self.client.watchlist.retrieve(candidate_id)
-    expected_body = self.client.watchlist._create_body(**self.test_identity)
+    candidate_id = self.client.watchlists.create(**self.test_identity).body['id']
+    candidate = self.client.watchlists.retrieve(candidate_id)
+    expected_body = self.client.watchlists._create_body(**self.test_identity)
     expected_body['id'] = candidate_id
     self.assertDictContainsSubset(expected_body, candidate.body)
 
   def test_delete_candidate(self):
-    candidate_id = self.client.watchlist.create(**self.test_identity).body['id']
-    candidate = self.client.watchlist.delete(candidate_id)
-    expected_body = self.client.watchlist._create_body(**self.test_identity)
+    candidate_id = self.client.watchlists.create(**self.test_identity).body['id']
+    candidate = self.client.watchlists.delete(candidate_id)
+    expected_body = self.client.watchlists._create_body(**self.test_identity)
     expected_body['id'] = candidate_id
     expected_body['deleted'] = True
     self.assertDictContainsSubset(expected_body, candidate.body)
 
   @skip('These tests do not pass consistently because of eventual consistency of candidate list')
   def test_list_candidates_with_params(self):
-    candidate = self.client.watchlist.create()
-    candidate_list = self.client.watchlist.list(count=1)
+    candidate = self.client.watchlists.create()
+    candidate_list = self.client.watchlists.list(count=1)
     self.assertListEqual([candidate.body], candidate_list.body)
-    self.client.watchlist.create()
-    candidate_list = self.client.watchlist.list(count=1, offset=1)
+    self.client.watchlists.create()
+    candidate_list = self.client.watchlists.list(count=1, offset=1)
     self.assertListEqual([candidate.body], candidate_list.body)
 
   #@skip('These tests do not pass consistently because of eventual consistency of candidate list')
   def test_list_candidates_all(self):
-    candidate = self.client.watchlist.create(**self.test_identity)
-    expected_body = self.client.watchlist._create_body(**self.test_identity)
+    candidate = self.client.watchlists.create(**self.test_identity)
+    expected_body = self.client.watchlists._create_body(**self.test_identity)
     candidate_id = candidate.body['id']
     time.sleep(5)
-    candidate_list = self.client.watchlist.list()
+    candidate_list = self.client.watchlists.list()
     match = {}
     for c in candidate_list.body['data']:
       if c[u'id'] == candidate_id:
         match = c
     self.assertDictContainsSubset(expected_body, match)
 
   def test_search(self):
-    candidate_id = self.client.watchlist.create().body['id']
-    response = self.client.watchlist.search(candidate_id)
+    candidate_id = self.client.watchlists.create().body['id']
+    response = self.client.watchlists.search(candidate_id)
     self.assertIn('searched_lists', response.body)
     self.assertIn('matches', response.body)