Merge pull request #9 from uc-cdis/feat/get-with-params

feat(get-with-params): add method to IndexClient

Author: rudyardrichter

indexclient/client.py

@@ -48,6 +48,23 @@ def get(self, did):
                 raise e
         return Document(self, did)
 
+    def get_with_params(self, params=None):
+        """
+        Return a document object corresponding to the supplied parameters, such
+        as ``{'hashes': {'md5': '...', 'size': '...'}}``.
+        """
+        try:
+            response = self._get("index", params=params)
+        except requests.HTTPError as e:
+            if e.response.status_code == 404:
+                return None
+            else:
+                raise e
+        if not response.json()['ids']:
+            return None
+        did = response.json()['ids'][0]
+        return Document(self, did)
+
     def list(self, limit=float("inf"), start=None, page_size=100):
         """ Returns a generator of document objects. """
         yielded = 0