Subscriptions API client (#607)

* First steps towards a real subscriptions client.

Mocking the service in the tests is the hard part. There are
several different approaches we can take and none of them are
obviously the best.

* Subscriptions API client using httpx

Tests use respx to mock server routing.

Subscriptions results is not covered in this batch of work.

* Implement subscription get_results

And subclass Session with custom x-planet-app header

* Switch CLI commands over to CliSession

* Add cli/session.py

* Delete redundant code, exclude some lines from coverage

* Linting

* Restore exception translation for list_subscriptions_cmd

Author: sgillies

planet/cli/data.py

@@ -19,10 +19,10 @@
 
 import click
 
-from planet import data_filter, exceptions, io, DataClient, Session
-
+from planet import data_filter, exceptions, io, DataClient
 from .cmds import coro, translate_exceptions
 from .io import echo_json
+from .session import CliSession
 
 pretty = click.option('--pretty', is_flag=True, help='Pretty-print output.')
 
@@ -31,7 +31,7 @@
 async def data_client(ctx):
     auth = ctx.obj['AUTH']
     base_url = ctx.obj['BASE_URL']
-    async with Session(auth=auth) as sess:
+    async with CliSession(auth=auth) as sess:
         cl = DataClient(sess, base_url=base_url)
         yield cl
 

planet/cli/orders.py

@@ -20,10 +20,11 @@
 import click
 
 import planet
-from planet import OrdersClient, Session  # allow mocking
+from planet import OrdersClient  # allow mocking
 from .cmds import coro, translate_exceptions
 from .io import echo_json
 from .options import pretty
+from .session import CliSession
 
 LOGGER = logging.getLogger(__name__)
 
@@ -32,7 +33,7 @@
 async def orders_client(ctx):
     auth = ctx.obj['AUTH']
     base_url = ctx.obj['BASE_URL']
-    async with Session(auth=auth) as sess:
+    async with CliSession(auth=auth) as sess:
         cl = OrdersClient(sess, base_url=base_url)
         yield cl
 

planet/cli/session.py

@@ -0,0 +1,11 @@
+"""CLI HTTP/auth sessions."""
+
+from planet.auth import AuthType
+from planet.http import Session
+
+
+class CliSession(Session):
+
+    def __init__(self, auth: AuthType = None):
+        super().__init__(auth)
+        self._client.headers.update({'X-Planet-App': 'python-cli'})

planet/cli/subscriptions.py

@@ -4,9 +4,9 @@
 
 import click
 
-from planet import Session
-from planet.cli.cmds import coro, translate_exceptions
-from planet.cli.io import echo_json
+from .cmds import coro, translate_exceptions
+from .io import echo_json
+from .session import CliSession
 from planet.clients.subscriptions import SubscriptionsClient
 
 
@@ -39,7 +39,7 @@ def subscriptions(ctx):
 @coro
 async def list_subscriptions_cmd(ctx, status, limit, pretty):
     """Prints a sequence of JSON-encoded Subscription descriptions."""
-    async with Session(auth=ctx.obj['AUTH']) as session:
+    async with CliSession(auth=ctx.obj['AUTH']) as session:
         client = SubscriptionsClient(session)
         filtered_subs = client.list_subscriptions(status=status, limit=limit)
         async for sub in filtered_subs:
@@ -75,7 +75,7 @@ def parse_request(ctx, param, value: str) -> dict:
 @coro
 async def create_subscription_cmd(ctx, request, pretty):
     """Submits a subscription request and prints the API response."""
-    async with Session(auth=ctx.obj['AUTH']) as session:
+    async with CliSession(auth=ctx.obj['AUTH']) as session:
         client = SubscriptionsClient(session)
         sub = await client.create_subscription(request)
         echo_json(sub, pretty)
@@ -89,7 +89,7 @@ async def create_subscription_cmd(ctx, request, pretty):
 @coro
 async def cancel_subscription_cmd(ctx, subscription_id, pretty):
     """Cancels a subscription and prints the API response."""
-    async with Session(auth=ctx.obj['AUTH']) as session:
+    async with CliSession(auth=ctx.obj['AUTH']) as session:
         client = SubscriptionsClient(session)
         sub = await client.cancel_subscription(subscription_id)
         echo_json(sub, pretty)
@@ -104,7 +104,7 @@ async def cancel_subscription_cmd(ctx, subscription_id, pretty):
 @coro
 async def update_subscription_cmd(ctx, subscription_id, request, pretty):
     """Cancels a subscription and prints the API response."""
-    async with Session(auth=ctx.obj['AUTH']) as session:
+    async with CliSession(auth=ctx.obj['AUTH']) as session:
         client = SubscriptionsClient(session)
         sub = await client.update_subscription(subscription_id, request)
         echo_json(sub, pretty)
@@ -125,7 +125,7 @@ async def describe_subscription_cmd(ctx, subscription_id, pretty):
     After we refactor we will change to mocking the API.
 
     """
-    async with Session(auth=ctx.obj['AUTH']) as session:
+    async with CliSession(auth=ctx.obj['AUTH']) as session:
         client = SubscriptionsClient(session)
         sub = await client.get_subscription(subscription_id)
         echo_json(sub, pretty)
@@ -161,7 +161,7 @@ async def list_subscription_results_cmd(ctx,
                                         status,
                                         limit):
     """Gets results of a subscription and prints the API response."""
-    async with Session(auth=ctx.obj['AUTH']) as session:
+    async with CliSession(auth=ctx.obj['AUTH']) as session:
         client = SubscriptionsClient(session)
         filtered_results = client.get_results(subscription_id,
                                               status=status,