Merge pull request #207 from descarteslabs/update

Remove Deprecated Endpoints

Author: jpoehnelt

README.md

@@ -36,7 +36,12 @@ Changelog
 =========
 
 ## [Unreleased]
-## [0.7.0] - 2018-01-2
+## [0.8.0] - 2018-02-08
+### Changed
+- Removed deprecated searching by const_id
+- Removed deprecated raster band methods
+
+## [0.7.0] - 2018-01-24
 ### Changed
 - Reorganization into a client submodule
 
@@ -188,7 +193,8 @@ metadata.features for iterating over large search results
 ### Added
 - Initial release of client library
 
-[Unreleased]: https://github.com/descarteslabs/descarteslabs-python/compare/v0.7.0...HEAD
+[Unreleased]: https://github.com/descarteslabs/descarteslabs-python/compare/v0.8.0...HEAD
+[0.8.0]: https://github.com/descarteslabs/descarteslabs-python/compare/v0.7.0...v0.8.0
 [0.7.0]: https://github.com/descarteslabs/descarteslabs-python/compare/v0.6.2...v0.7.0
 [0.6.2]: https://github.com/descarteslabs/descarteslabs-python/compare/v0.6.1...v0.6.2
 [0.6.1]: https://github.com/descarteslabs/descarteslabs-python/compare/v0.6.0...v0.6.1

descarteslabs/client/auth/auth.py

@@ -74,23 +74,26 @@ def __init__(self, domain="https://iam.descarteslabs.com",
         self.token_info_path = token_info_path
 
         token_info = {}
-        try:
-            if self.token_info_path:
+        if self.token_info_path:
+            try:
                 with open(self.token_info_path) as fp:
                     token_info = json.load(fp)
-        except (IOError, ValueError):
-            pass
+            except (IOError, ValueError):
+                pass
 
         self.client_id = client_id if client_id else os.environ.get('CLIENT_ID', token_info.get('client_id', None))
         self.client_secret = client_secret if client_secret else os.environ.get('CLIENT_SECRET', token_info.get(
             'client_secret', None))
         self._token = jwt_token if jwt_token else os.environ.get('JWT_TOKEN', token_info.get('jwt_token', None))
 
-        client_id_changed = token_info.get('client_id', None) != self.client_id
-        client_secret_changed = token_info.get('client_secret', None) != self.client_secret
+        if token_info:
+            # If the token was read from a path but environment variables were set, we may need
+            # to reset the token.
+            client_id_changed = token_info.get('client_id', None) != self.client_id
+            client_secret_changed = token_info.get('client_secret', None) != self.client_secret
 
-        if client_id_changed or client_secret_changed:
-            self._token = None
+            if client_id_changed or client_secret_changed:
+                self._token = None
 
         self._namespace = None
 

descarteslabs/client/auth/tests/test_auth.py

@@ -18,6 +18,10 @@
 import json
 
 
+# flake8: noqa
+anon_token = "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJncm91cHMiOlsicHVibGljIl0sImlzcyI6Imh0dHBzOi8vZGVzY2FydGVzbGFicy5hdXRoMC5jb20vIiwic3ViIjoiZGVzY2FydGVzfGFub24tdG9rZW4iLCJhdWQiOiJaT0JBaTRVUk9sNWdLWklweHhsd09FZng4S3BxWGYyYyIsImV4cCI6OTk5OTk5OTk5OSwiaWF0IjoxNDc4MjAxNDE5fQ.QL9zq5SkpO7skIy0niIxI0B92uOzZT5t1abuiJaspRI"
+
+
 class TestAuth(unittest.TestCase):
     def test_get_token(self):
         # get a jwt
@@ -35,6 +39,10 @@ def test_get_namespace(self):
         auth = Auth.from_environment_or_token_json()
         self.assertIsNotNone(auth.namespace)
 
+    def test_init_token_no_path(self):
+        auth = Auth(jwt_token=anon_token, token_info_path=None, client_id="foo")
+        self.assertEquals(anon_token, auth._token)
+
 
 if __name__ == '__main__':
     unittest.main()

descarteslabs/client/scripts/cli.py

@@ -40,7 +40,6 @@
 metadata_parser.add_argument('argument', nargs='?')
 metadata_parser.add_argument('-url', help='The url of the service')
 metadata_parser.add_argument('-place', help='A slug for a named place')
-metadata_parser.add_argument('-const_id', default=None, help='Constellation ID', nargs='+')
 metadata_parser.add_argument('-start_time', help='Start of valid date/time range (inclusive)')
 metadata_parser.add_argument('-end_time', help='End of valid date/time range (inclusive)')
 metadata_parser.add_argument('-geom', help='Region of interest as GeoJSON or WKT')

descarteslabs/client/services/metadata/cli.py

@@ -35,8 +35,6 @@ def metadata_handler(args):
     if args.command == 'summary':
         if args.place:
             kwargs['place'] = args.place
-        if args.const_id:
-            kwargs['const_id'] = args.const_id
         if args.start_time:
             kwargs['start_time'] = args.start_time
         if args.end_time:
@@ -53,8 +51,6 @@ def metadata_handler(args):
     if args.command == 'search':
         if args.place:
             kwargs['place'] = args.place
-        if args.const_id:
-            kwargs['const_id'] = args.const_id
         if args.start_time:
             kwargs['start_time'] = args.start_time
         if args.end_time:
@@ -75,8 +71,6 @@ def metadata_handler(args):
     if args.command == 'keys':
         if args.place:
             kwargs['place'] = args.place
-        if args.const_id:
-            kwargs['const_id'] = args.const_id
         if args.start_time:
             kwargs['start_time'] = args.start_time
         if args.end_time:

descarteslabs/client/services/metadata/metadata.py

@@ -22,12 +22,6 @@
 from descarteslabs.client.services.raster import Raster
 from descarteslabs.client.services.metadata.metadata_filtering import AndExpression
 
-CONST_ID_DEPRECATION_MESSAGE = (
-    "Keyword arg `const_id' has been deprecated and will be removed in "
-    "future versions of the library. Use the `products` "
-    "argument instead. Product identifiers can be found with the "
-    " products() method."
-)
 
 OFFSET_DEPRECATION_MESSAGE = (
     "Keyword arg `offset` has been deprecated and will be removed in "
@@ -145,28 +139,18 @@ def get_bands_by_key(self, key):
 
         return r.json()
 
-    def get_bands_by_constellation(self, const):
-        """
-        For a given constellation id, return the available bands.
-
-        :param str const: A constellation name/abbreviation.
-
-        :return: A dictionary of band entries and their metadata.
-        """
-        r = self.session.get('/bands/constellation/%s' % const)
-        return r.json()
-
-    def products(self, bands=None, limit=None, offset=None, owner=None, **kwargs):
+    def products(self, bands=None, limit=None, offset=None, owner=None, text=None, **kwargs):
         """Search products that are available on the platform.
 
         :param list(str) bands: Band name(s) e.g ["red", "nir"] to filter products by.
                                 Note that products must match all bands that are passed.
         :param int limit: Number of results to return.
         :param int offset: Index to start at when returning results.
         :param str owner: Filter products by the owner's uuid.
+        :param str text: Filter products by string match.
 
         """
-        params = ['limit', 'offset', 'bands', 'owner']
+        params = ['limit', 'offset', 'bands', 'owner', 'text']
 
         args = locals()
         kwargs = dict(kwargs, **{
@@ -194,25 +178,13 @@ def available_products(self):
 
         return r.json()
 
-    def translate(self, const_id):
-        """Translate a deprecated constellation identifier
-        into a new-style product identifier.
-
-        :param string const_id: The constellation identifier to translate.
-        """
-
-        r = self.session.get('/products/translate/{}'.format(const_id))
-
-        return r.json()
-
-    def summary(self, products=None, const_id=None, sat_id=None, date='acquired', part=None,
+    def summary(self, products=None, sat_id=None, date='acquired', part=None,
                 place=None, geom=None, start_time=None, end_time=None, cloud_fraction=None,
                 cloud_fraction_0=None, fill_fraction=None, q=None, pixels=None,
                 dltile=None):
         """Get a summary of the results for the specified spatio-temporal query.
 
         :param list(str) products: Product identifier(s).
-        :param list(str) const_id: Constellation identifier(s).
         :param list(str) sat_id: Satellite identifier(s).
         :param str date: The date field to use for search (e.g. `acquired`).
         :param str part: Part of the date to aggregate over (e.g. `day`).
@@ -273,13 +245,6 @@ def summary(self, products=None, const_id=None, sat_id=None, date='acquired', pa
 
             kwargs['products'] = products
 
-        if const_id:
-            warn(CONST_ID_DEPRECATION_MESSAGE, DeprecationWarning)
-            if isinstance(const_id, string_types):
-                const_id = [const_id]
-
-            kwargs['const_id'] = const_id
-
         if date:
             kwargs['date'] = date
 
@@ -315,7 +280,7 @@ def summary(self, products=None, const_id=None, sat_id=None, date='acquired', pa
         r = self.session.post('/summary', json=kwargs)
         return r.json()
 
-    def search(self, products=None, const_id=None, sat_id=None, date='acquired', place=None,
+    def search(self, products=None, sat_id=None, date='acquired', place=None,
                geom=None, start_time=None, end_time=None, cloud_fraction=None,
                cloud_fraction_0=None, fill_fraction=None, q=None, limit=100, offset=0,
                fields=None, dltile=None, sort_field=None, sort_order="asc", randomize=None,
@@ -324,7 +289,6 @@ def search(self, products=None, const_id=None, sat_id=None, date='acquired', pla
         optional. For accessing more than 10000 results, see :py:func:`features`.
 
         :param list(str) products: Product Identifier(s).
-        :param list(str) const_id: Constellation Identifier(s).
         :param list(str) sat_id: Satellite identifier(s).
         :param str date: The date field to use for search (e.g. `acquired`).
         :param str place: A slug identifier to be used as a region of interest.
@@ -388,14 +352,6 @@ def search(self, products=None, const_id=None, sat_id=None, date='acquired', pla
 
             kwargs['products'] = products
 
-        if const_id:
-            warn(CONST_ID_DEPRECATION_MESSAGE, DeprecationWarning)
-
-            if isinstance(const_id, string_types):
-                const_id = [const_id]
-
-            kwargs['const_id'] = const_id
-
         if geom:
             kwargs['geom'] = geom
 
@@ -444,15 +400,14 @@ def search(self, products=None, const_id=None, sat_id=None, date='acquired', pla
 
         return fc
 
-    def ids(self, products=None, const_id=None, sat_id=None, date='acquired', place=None,
+    def ids(self, products=None, sat_id=None, date='acquired', place=None,
             geom=None, start_time=None, end_time=None, cloud_fraction=None,
             cloud_fraction_0=None, fill_fraction=None, q=None, limit=100, offset=None,
             dltile=None, sort_field=None, sort_order=None, randomize=None):
         """Search metadata given a spatio-temporal query. All parameters are
         optional.
 
         :param list(str) products: Products identifier(s).
-        :param list(str) const_id: Constellation identifier(s).
         :param list(str) sat_id: Satellite identifier(s).
         :param str date: The date field to use for search (e.g. `acquired`).
         :param str place: A slug identifier to be used as a region of interest.
@@ -486,7 +441,7 @@ def ids(self, products=None, const_id=None, sat_id=None, date='acquired', place=
             ['landsat:LC08:PRE:TOAR:meta_LC80270312016188_v1']
 
         """
-        result = self.search(sat_id=sat_id, products=products, const_id=const_id, date=date,
+        result = self.search(sat_id=sat_id, products=products, date=date,
                              place=place, geom=geom, start_time=start_time,
                              end_time=end_time, cloud_fraction=cloud_fraction,
                              cloud_fraction_0=cloud_fraction_0, fill_fraction=fill_fraction,
@@ -495,15 +450,14 @@ def ids(self, products=None, const_id=None, sat_id=None, date='acquired', place=
 
         return [feature['id'] for feature in result['features']]
 
-    def keys(self, products=None, const_id=None, sat_id=None, date='acquired', place=None,
+    def keys(self, products=None, sat_id=None, date='acquired', place=None,
              geom=None, start_time=None, end_time=None, cloud_fraction=None,
              cloud_fraction_0=None, fill_fraction=None, q=None, limit=100, offset=0,
              dltile=None, sort_field=None, sort_order='asc', randomize=None):
         """Search metadata given a spatio-temporal query. All parameters are
         optional. Results are paged using limit/offset.
 
         :param list(str) products: Products identifier(s).
-        :param list(str) const_id: Constellation identifier(s).
         :param list(str) sat_id: Satellite identifier(s).
         :param str date: The date field to use for search (e.g. `acquired`).
         :param str place: A slug identifier to be used as a region of interest.
@@ -537,7 +491,7 @@ def keys(self, products=None, const_id=None, sat_id=None, date='acquired', place
             ['meta_LC80270312016188_v1']
 
         """
-        result = self.search(sat_id=sat_id, products=products, const_id=const_id, date=date,
+        result = self.search(sat_id=sat_id, products=products, date=date,
                              place=place, geom=geom, start_time=start_time,
                              end_time=end_time, cloud_fraction=cloud_fraction,
                              cloud_fraction_0=cloud_fraction_0, fill_fraction=fill_fraction,
@@ -547,7 +501,7 @@ def keys(self, products=None, const_id=None, sat_id=None, date='acquired', place
 
         return [feature['key'] for feature in result['features']]
 
-    def features(self, products=None, const_id=None, sat_id=None, date='acquired', place=None,
+    def features(self, products=None, sat_id=None, date='acquired', place=None,
                  geom=None, start_time=None, end_time=None, cloud_fraction=None,
                  cloud_fraction_0=None, fill_fraction=None, q=None, fields=None,
                  batch_size=1000, dltile=None, sort_field=None, sort_order='asc',
@@ -575,7 +529,7 @@ def features(self, products=None, const_id=None, sat_id=None, date='acquired', p
         continuation_token = None
 
         while True:
-            result = self.search(sat_id=sat_id, products=products, const_id=None,
+            result = self.search(sat_id=sat_id, products=products,
                                  date=date, place=place, geom=geom,
                                  start_time=start_time, end_time=end_time,
                                  cloud_fraction=cloud_fraction,

descarteslabs/client/services/metadata/tests/test_metadata.py

@@ -14,7 +14,6 @@
 
 import itertools
 import unittest
-from warnings import catch_warnings
 
 from descarteslabs.client.services.metadata import Metadata, properties as p
 from descarteslabs.client.exceptions import NotFoundError
@@ -61,10 +60,6 @@ def test_cloud_fraction(self):
         for feature in r['features']:
             self.assertEqual(feature['properties']['cloud_fraction'], 0.0)
 
-    def test_translate_to_product(self):
-        r = self.instance.translate('l8')
-        self.assertEqual(r['product'], 'landsat:LC08:PRE:TOAR')
-
     def test_search_by_product(self):
         r = self.instance.search(start_time='2016-07-06', end_time='2016-07-07', products=['landsat:LC08:PRE:TOAR'])
         self.assertGreater(len(r['features']), 0)
@@ -102,13 +97,6 @@ def test_fields(self):
         for feature in r['features']:
             self.assertEqual(sorted(feature['properties'].keys()), sorted(fields))
 
-    def test_const_id_search_deprecation(self):
-        with catch_warnings(record=True) as w:
-            r = self.instance.search(start_time='2016-07-06', end_time='2016-07-07', const_id=['l8'])
-            self.assertGreater(len(r['features']), 0)
-            self.assertEqual(len(w), 1)
-            self.assertIn('deprecated', str(w[0].message))
-
     def test_multiple_products_search(self):
         r = self.instance.search(
             start_time='2016-07-06',
@@ -134,23 +122,6 @@ def test_summary(self):
         self.assertIn('bytes', r)
         self.assertGreater(r['count'], 0)
 
-    def test_const_id_summary_deprecation(self):
-        with catch_warnings(record=True) as w:
-            r = self.instance.summary(
-                start_time='2016-07-06',
-                end_time='2016-07-07',
-                const_id=['l8'],
-                pixels=True
-            )
-            self.assertEqual(len(w), 1)
-            self.assertIn('deprecated', str(w[0].message))
-
-            self.assertIn('products', r)
-            self.assertIn('count', r)
-            self.assertIn('pixels', r)
-            self.assertIn('bytes', r)
-            self.assertGreater(r['count'], 0)
-
     def test_summary_part(self):
         r = self.instance.summary(
             start_time='2016-07-06',
@@ -216,9 +187,6 @@ def test_derived_bands_search(self):
     def test_get_bands_by_key(self):
         self.instance.get_bands_by_key('meta_LC80270312016188_v1')
 
-    def test_get_bands_by_const(self):
-        self.instance.get_bands_by_constellation('L8')
-
     def test_expr_serialization(self):
         q = ((0.1 < p.cloud_fraction <= 0.2) & (p.sat_id == "f00b")) | (p.sat_id == "usa-245")
         expected_q = {"or": [