Add category query

Author: seignovert

opus/api.py

@@ -13,6 +13,7 @@
 from .mults import Mults
 from .range import Range
 from .fields import Fields, Field
+from .categories import Categories, Category
 
 API_URL = 'https://tools.pds-rings.seti.org/opus/api'
 
@@ -129,3 +130,11 @@ def field(self, field):
     def fields(self):
         '''Get list of all fields'''
         return Fields(self.load('fields'))
+
+    def category(self, name='obs_general'):
+        '''Get all fields in a category'''
+        return Category(self.load('category/'+name))
+
+    def categories(self):
+        '''List category names'''
+        return Categories(self.load('categories'))

opus/categories.py

@@ -0,0 +1,42 @@
+# -*- coding: utf-8 -*-
+
+class Category(object):
+    def __init__(self, json):
+        self.name = json['table_name']
+        self.label = json['label']
+                
+    def __repr__(self):
+        return '`{}` -> {}'.format(self.name, self.label)
+
+
+class Categories(object):
+    def __init__(self, json):
+        self._json = json
+        self._data = {}
+        for category in json:
+            self._data[category['table_name']] = Category(category)
+
+    def __repr__(self):
+        return 'OPUS API list of all categories ({}):\n'.format(len(self)) + \
+            '\n'.join(
+               ' - {} ({})'.format(value.label, key) for key, value in self.items()
+            )
+
+    def __len__(self):
+        return len(self._json)
+
+    def __getitem__(self, attr):
+        return self._data[attr.lower()]
+
+    def __iter__(self):
+        return iter(self._data)
+
+    def keys(self):
+        return self._data.keys()
+
+    def items(self):
+        return self._data.items()
+
+    def values(self):
+        return self._data.values()
+

tests/api/categories.json

@@ -0,0 +1 @@
+[{"table_name": "obs_general", "label": "General Constraints"}, {"table_name": "obs_ring_geometry", "label": "Ring Geometry Constraints"}, {"table_name": "obs_wavelength", "label": "Wavelength Constraints"}]

tests/api/category/obs_general.json

@@ -0,0 +1 @@
+{"table_name": "obs_general", "label": "General Constraints"}

tests/test_api.py

@@ -306,3 +306,35 @@ def test_api_fields(api):
     assert responses.calls[0].response.text == fields
 
     assert len(resp) == 3971
+
+
+@responses.activate
+def test_api_category(api):
+    category = open('tests/api/category/obs_general.json', 'r').read()
+    responses.add(responses.GET,
+                  'http://localhost/category/obs_general.json',
+                  body=category)
+
+    resp = api.category('obs_general')
+
+    assert len(responses.calls) == 1
+    assert responses.calls[0].request.url == 'http://localhost/category/obs_general.json'
+    assert responses.calls[0].response.text == category
+
+    assert resp.name == 'obs_general'
+
+
+@responses.activate
+def test_api_categories(api):
+    categories = open('tests/api/categories.json', 'r').read()
+    responses.add(responses.GET,
+                  'http://localhost/categories.json',
+                  body=categories)
+
+    resp = api.categories()
+
+    assert len(responses.calls) == 1
+    assert responses.calls[0].request.url == 'http://localhost/categories.json'
+    assert responses.calls[0].response.text == categories
+
+    assert len(resp) == 3

tests/test_categories.py

@@ -0,0 +1,50 @@
+# -*- coding: utf-8 -*-
+import json as JSON
+import pytest
+import six
+
+from opus.categories import *
+
+@pytest.fixture
+def category():
+    json = JSON.loads(open('tests/api/category/obs_general.json', 'r').read())
+    return Category(json)
+
+@pytest.fixture
+def categories():
+    json = JSON.loads(open('tests/api/categories.json', 'r').read())
+    return Categories(json)
+
+def test_category_repr(category):
+    assert repr(category) == '`obs_general` -> General Constraints'
+
+
+def test_categories_repr(categories):
+    if six.PY3:
+        assert repr(categories) == \
+            'OPUS API list of all categories (3):\n' + \
+            ' - General Constraints (obs_general)\n' + \
+            ' - Ring Geometry Constraints (obs_ring_geometry)\n' + \
+            ' - Wavelength Constraints (obs_wavelength)'
+    else:
+        r = repr(categories)
+        assert 'OPUS API list of all categories (3):' in r
+        assert 'obs_general' in r
+        assert 'obs_ring_geometry' in r
+        assert 'obs_wavelength' in r
+    
+def test_categories_iter(categories):
+    assert 'obs_general' in categories
+    
+    for key, value in categories.items():
+        assert categories[key] == value
+        break
+
+def test_categories_keys_values(categories):
+    keys = categories.keys()
+    values = categories.values()
+    assert len(keys) == 3
+    assert len(values) == 3
+    assert 'obs_general' in keys
+
+