add platform support for user resources

Author: mikesea

fixtures/create_user.yaml

@@ -0,0 +1,17 @@
+- request: !!python/object:vcr.request.Request
+    body: ''
+    headers: !!python/object/apply:__builtin__.frozenset
+    - - !!python/tuple [User-Agent, Swiftype-Python/1.0.0]
+      - !!python/tuple [Content-Type, application/json]
+    host: localhost
+    method: POST
+    path: /api/v1/users.json?client_secret=a62962938bbe76194bbdc4e3cbfcb6708283b47614594610c71240f81c17af6f&auth_token=a-test-api-key&client_id=bd779af52ce7c26330a2c8a9216caf3f84906db6893788bdb4bd27549ca7bbbf
+    port: 3000
+    protocol: http
+  response:
+    body: {string: '{"id":"123456","access_token":"ab169f3343724916d2ccba5e748bdedd6cbf7c06e7d8952530dfa82e1b1052f3"}'}
+    headers: {cache-control: 'max-age=0, private, must-revalidate', connection: close,
+      content-type: application/json; charset=utf-8, etag: '"04764ec2f724ddb8cea4bce79acd93e0"',
+      server: thin 1.5.0 codename Knife, x-request-id: 2237f34063dc0d5802919b5472bcf798,
+      x-runtime: '0.069650', x-ua-compatible: IE=Edge}
+    status: {code: 200, message: OK}

fixtures/user.yaml

@@ -0,0 +1,17 @@
+- request: !!python/object:vcr.request.Request
+    body: ''
+    headers: !!python/object/apply:__builtin__.frozenset
+    - - !!python/tuple [User-Agent, Swiftype-Python/1.0.0]
+      - !!python/tuple [Content-Type, application/json]
+    host: localhost
+    method: GET
+    path: /api/v1/users/12345.json?client_secret=a62962938bbe76194bbdc4e3cbfcb6708283b47614594610c71240f81c17af6f&auth_token=a-test-api-key&client_id=bd779af52ce7c26330a2c8a9216caf3f84906db6893788bdb4bd27549ca7bbbf
+    port: 3000
+    protocol: http
+  response:
+    body: {string: '{"id":"12345","access_token":"ab37d7821853d6be1d7c451b449064ccf55300fdd5157baed48af53fd52b61f5"}'}
+    headers: {cache-control: 'max-age=0, private, must-revalidate', connection: close,
+      content-type: application/json; charset=utf-8, etag: '"28378b63dc4393c429edb345597939d5"',
+      server: thin 1.5.0 codename Knife, x-request-id: 2247f7e72009526040223e8b105c174a,
+      x-runtime: '0.024827', x-ua-compatible: IE=Edge}
+    status: {code: 200, message: OK}

fixtures/users.yaml

@@ -0,0 +1,17 @@
+- request: !!python/object:vcr.request.Request
+    body: ''
+    headers: !!python/object/apply:__builtin__.frozenset
+    - - !!python/tuple [User-Agent, Swiftype-Python/1.0.0]
+      - !!python/tuple [Content-Type, application/json]
+    host: localhost
+    method: GET
+    path: /api/v1/users.json?client_secret=a62962938bbe76194bbdc4e3cbfcb6708283b47614594610c71240f81c17af6f&auth_token=a-test-api-key&client_id=bd779af52ce7c26330a2c8a9216caf3f84906db6893788bdb4bd27549ca7bbbf
+    port: 3000
+    protocol: http
+  response:
+    body: {string: '[{"id":"12345","access_token":"6cf7fbd297f00a8e3863a0595f55ff7d141cbef2fcbe00159d0f7403649b384e"},{"id":"12346","access_token":"9937d7821853d6be1d7c451b449064ccf55300fdd5157baed48af53fd52b613c"}]'}
+    headers: {cache-control: 'max-age=0, private, must-revalidate', connection: close,
+      content-type: application/json; charset=utf-8, etag: '"8539c75e37dd05f0b7073aa733d859b4"',
+      server: thin 1.5.0 codename Knife, x-request-id: 542ac89c231fc6e166c6e47e0c47e702,
+      x-runtime: '0.022923', x-ua-compatible: IE=Edge}
+    status: {code: 200, message: OK}

fixtures/users_pagination.yaml

@@ -0,0 +1,17 @@
+- request: !!python/object:vcr.request.Request
+    body: ''
+    headers: !!python/object/apply:__builtin__.frozenset
+    - - !!python/tuple [User-Agent, Swiftype-Python/1.0.0]
+      - !!python/tuple [Content-Type, application/json]
+    host: localhost
+    method: GET
+    path: /api/v1/users.json?client_secret=a62962938bbe76194bbdc4e3cbfcb6708283b47614594610c71240f81c17af6f&auth_token=a-test-api-key&page=2&client_id=bd779af52ce7c26330a2c8a9216caf3f84906db6893788bdb4bd27549ca7bbbf
+    port: 3000
+    protocol: http
+  response:
+    body: {string: '[]'}
+    headers: {cache-control: 'max-age=0, private, must-revalidate', connection: close,
+      content-type: application/json; charset=utf-8, etag: '"d751713988987e9331980363e24189ce"',
+      server: thin 1.5.0 codename Knife, x-request-id: b1aad6d4e74543f75fc44ac778bbadd3,
+      x-runtime: '0.023024', x-ua-compatible: IE=Edge}
+    status: {code: 200, message: OK}

swiftype/swiftype.py

@@ -13,7 +13,9 @@
 
 class Client(object):
 
-  def __init__(self, username=None, password=None, api_key=None, host=DEFAULT_API_HOST):
+  def __init__(self, username=None, password=None, api_key=None, client_id=None, client_secret=None, host=DEFAULT_API_HOST):
+      self.client_id = client_id
+      self.client_secret = client_secret
       self.conn = Connection(username=username, password=password, api_key=api_key, host=host, base_path=DEFAULT_API_BASE_PATH)
 
   def engines(self, page=None, per_page=None):
@@ -129,6 +131,18 @@ def recrawl_domain(self, engine_id, domain_id):
   def crawl_url(self, engine_id, domain_id, url):
     return self.conn._put(self.__domain_path(engine_id, domain_id) + '/crawl_url', data={'url': url})
 
+  def users(self, page=None, per_page=None):
+    params = {'client_id': self.client_id, 'client_secret': self.client_secret}
+    return self.conn._get(self.__users_path(), dict(params.items() + self.__pagination_params(page, per_page).items()))
+
+  def user(self, user_id):
+    params = {'client_id': self.client_id, 'client_secret': self.client_secret}
+    return self.conn._get(self.__user_path(user_id), params)
+
+  def create_user(self):
+    params = {'client_id': self.client_id, 'client_secret': self.client_secret}
+    return self.conn._post(self.__users_path(), params)
+
   def __search_path(self, engine_id): return 'engines/%s/search' % (engine_id)
   def __suggest_path(self, engine_id): return 'engines/%s/suggest' % (engine_id)
   def __engines_path(self): return 'engines'
@@ -142,6 +156,8 @@ def __documents_path(self, engine_id, document_type_id): return '%s/documents' %
   def __analytics_path(self, engine_id): return '%s/analytics' % (self.__engine_path(engine_id))
   def __domain_path(self, engine_id, domain_id): return '%s/domains/%s' % (self.__engine_path(engine_id), domain_id)
   def __domains_path(self, engine_id): return '%s/domains' % (self.__engine_path(engine_id))
+  def __users_path(self): return 'users'
+  def __user_path(self, user_id): return 'users/%s' % (user_id)
 
   def __pagination_params(self, page, per_page):
     return dict((k,v) for k,v in {'page': page, 'per_page': per_page}.iteritems() if v is not None)

tests/test_swiftype.py

@@ -267,5 +267,40 @@ def __create_temporary_engine(self, name = None):
         name = name if name else self.__time_name()
         return
 
+class TestPlatformUsers(unittest.TestCase):
+
+    def setUp(self):
+        try:
+            api_key = os.environ['API_KEY']
+        except:
+            api_key = "a-test-api-key"
+
+        client_id = 'bd779af52ce7c26330a2c8a9216caf3f84906db6893788bdb4bd27549ca7bbbf'
+        client_secret = 'a62962938bbe76194bbdc4e3cbfcb6708283b47614594610c71240f81c17af6f'
+        self.client = swiftype.Client(api_key=api_key, client_id=client_id, client_secret=client_secret, host='localhost:3000')
+
+    def test_users(self):
+        with vcr.use_cassette('fixtures/users.yaml'):
+            response = self.client.users()
+            self.assertEqual(response['status'], 200)
+            self.assertEqual(len(response['body']), 2)
+
+    def test_users_pagination(self):
+        with vcr.use_cassette('fixtures/users_pagination.yaml'):
+            response = self.client.users(page=2)
+            self.assertEqual(response['status'], 200)
+            self.assertEqual(len(response['body']), 0)
+
+    def test_user(self):
+        with vcr.use_cassette('fixtures/user.yaml'):
+            user_id = '12345'
+            response = self.client.user(user_id)
+            self.assertEqual(response['body']['id'], user_id)
+
+    def test_create_user(self):
+        with vcr.use_cassette('fixtures/create_user.yaml'):
+            response = self.client.create_user()
+            self.assertEqual(response['status'], 200)
+
 if __name__ == '__main__':
     unittest.main()