Add hosting parameter support for Orders API

planet/cli/orders.py

@@ -22,6 +22,7 @@
 from planet import OrdersClient  # allow mocking
 from . import types
 from .cmds import coro, translate_exceptions
+from ..order_request import sentinel_hub
 from .io import echo_json
 from .options import limit, pretty
 from .session import CliSession
@@ -206,15 +207,27 @@ async def download(ctx, order_id, overwrite, directory, checksum):
 @coro
 @click.argument("request", type=types.JSON())
 @pretty
-async def create(ctx, request: str, pretty):
+async def create(ctx, request, pretty, **kwargs):
     """Create an order.
 
     This command outputs the created order description, optionally
     pretty-printed.
 
     REQUEST is the full description of the order to be created. It must be JSON
     and can be specified a json string, filename, or '-' for stdin.
+
+    Other flag options are hosting and collection_id. The hosting flag
+    specifies the hosting type, and the collection_id flag specifies the
+    collection ID for Sentinel Hub. If the collection_id is omitted, a new
+    collection will be created.
     """
+
+    hosting = kwargs.get('hosting')
+    collection_id = kwargs.get('collection_id')
+
+    if hosting == "sentinel_hub":
+        request["hosting"] = sentinel_hub(collection_id)
+
     async with orders_client(ctx) as cl:
         order = await cl.create_order(request)
 
@@ -281,6 +294,13 @@ async def create(ctx, request: str, pretty):
     help="""Include or exclude metadata in SpatioTemporal Asset Catalog (STAC)
     format. Not specifying either defaults to including it (--stac), except
     for orders with google_earth_engine delivery""")
+@click.option('--hosting',
+              type=click.Choice(['sentinel_hub']),
+              help='Hosting for data delivery. '
+              'Currently, only "sentinel_hub" is supported.')
+@click.option('--collection_id',
+              help='Collection ID for Sentinel Hub hosting. '
+              'If omitted, a new collection will be created.')
 @pretty
 async def request(ctx,
                   item_type,
@@ -295,6 +315,8 @@ async def request(ctx,
                   single_archive,
                   delivery,
                   stac,
+                  hosting,
+                  collection_id,
                   pretty):
     """Generate an order request.
 
@@ -337,6 +359,8 @@ async def request(ctx,
                                                  delivery=delivery,
                                                  notifications=notifications,
                                                  tools=tools,
-                                                 stac=stac_json)
+                                                 stac=stac_json,
+                                                 hosting=hosting,
+                                                 collection_id=collection_id)
 
     echo_json(request, pretty)

planet/cli/subscriptions.py

@@ -101,7 +101,7 @@ async def list_subscriptions_cmd(ctx, status, limit, pretty):
 )
 @click.option("--collection-id",
               default=None,
-              help='Collection ID for Sentinel Hub.'
+              help='Collection ID for Sentinel Hub hosting. '
               'If omitted, a new collection will be created.')
 @pretty
 @click.pass_context
@@ -302,7 +302,7 @@ async def list_subscription_results_cmd(ctx,
     help="Clip to the source geometry without specifying a clip tool.")
 @click.option("--collection-id",
               default=None,
-              help='Collection ID for Sentinel Hub.'
+              help='Collection ID for Sentinel Hub hosting. '
               'If omitted, a new collection will be created.')
 @pretty
 def request(name,

planet/order_request.py

@@ -30,7 +30,9 @@ def build_request(name: str,
                   notifications: Optional[dict] = None,
                   order_type: Optional[str] = None,
                   tools: Optional[List[dict]] = None,
-                  stac: Optional[dict] = None) -> dict:
+                  stac: Optional[dict] = None,
+                  hosting: Optional[str] = None,
+                  collection_id: Optional[str] = None) -> dict:
     """Prepare an order request.
 
     ```python
@@ -65,6 +67,9 @@ def build_request(name: str,
         order_type: Accept a partial order, indicated by 'partial'.
         tools: Tools to apply to the products. Order defines
             the toolchain order of operatations.
+        stac: Include STAC metadata.
+        hosting: A hosting destination (e.g. Sentinel Hub).
+        collection_id: A Sentinel Hub collection ID.
 
     Raises:
         planet.specs.SpecificationException: If order_type is not a valid
@@ -91,6 +96,9 @@ def build_request(name: str,
     if stac:
         details['metadata'] = stac
 
+    if hosting == 'sentinel_hub':
+        details['hosting'] = sentinel_hub(collection_id)
+
     return details
 
 
@@ -534,3 +542,11 @@ def band_math_tool(b1: str,
     # e.g. {"b1": "b1", "b2":"arctan(b1)"} if b1 and b2 are specified
     parameters = dict((k, v) for k, v in locals().items() if v)
     return _tool('bandmath', parameters)
+
+
+def sentinel_hub(collection_id: Optional[str] = None) -> dict:
+    """Specify a Sentinel Hub hosting destination."""
+    params = {}
+    if collection_id:
+        params['collection_id'] = collection_id
+    return {'sentinel_hub': params}

planet/subscription_request.py

@@ -86,9 +86,8 @@ def build_request(name: str,
         ClientError: when a valid Subscriptions API request can't be
             constructed.
 
-    Examples:
+    Example::
 
-    ```python
         from datetime import datetime
         from planet.subscription_request import build_request, catalog_source, amazon_s3
 
@@ -114,7 +113,6 @@ def build_request(name: str,
         subscription_request = build_request(
             "test_subscription", source=source, delivery=delivery, hosting=hosting
         )
-        ```
     """
     # Because source is a Mapping we must make copies for
     # the function's return value. dict() shallow copies a Mapping

tests/integration/test_orders_cli.py

@@ -768,3 +768,65 @@ def test_cli_orders_request_no_stac(invoke):
         }]
     }
     assert order_request == json.loads(result.output)
+
+
+@respx.mock
+def test_cli_orders_request_hosting_sentinel_hub(invoke, stac_json):
+
+    result = invoke([
+        'request',
+        '--item-type=PSScene',
+        '--bundle=visual',
+        '--name=test',
+        '20220325_131639_20_2402',
+        '--hosting=sentinel_hub',
+    ])
+
+    order_request = {
+        "name":
+        "test",
+        "products": [{
+            "item_ids": ["20220325_131639_20_2402"],
+            "item_type": "PSScene",
+            "product_bundle": "visual",
+        }],
+        "metadata":
+        stac_json,
+        "hosting": {
+            "sentinel_hub": {}
+        }
+    }
+    assert order_request == json.loads(result.output)
+
+
+@respx.mock
+def test_cli_orders_request_hosting_sentinel_hub_collection_id(
+        invoke, stac_json):
+
+    result = invoke([
+        'request',
+        '--item-type=PSScene',
+        '--bundle=visual',
+        '--name=test',
+        '20220325_131639_20_2402',
+        '--hosting=sentinel_hub',
+        '--collection_id=1234'
+    ])
+
+    order_request = {
+        "name":
+        "test",
+        "products": [{
+            "item_ids": ["20220325_131639_20_2402"],
+            "item_type": "PSScene",
+            "product_bundle": "visual",
+        }],
+        "metadata":
+        stac_json,
+        "hosting": {
+            "sentinel_hub": {
+                "collection_id": "1234"
+            }
+        }
+    }
+    assert order_request == json.loads(result.output)

tests/unit/test_order_request.py

@@ -329,3 +329,15 @@ def test_no_archive_items_without_type():
     assert "archive_type" not in delivery_config
     assert "archive_filename" not in delivery_config
     assert "single_archive" not in delivery_config
+
+
+def test_sentinel_hub():
+    sh_config = order_request.sentinel_hub()
+    expected = {'sentinel_hub': {}}
+    assert sh_config == expected
+
+
+def test_sentinel_hub_collection_id():
+    sh_config = order_request.sentinel_hub("1234")
+    expected = {'sentinel_hub': {'collection_id': "1234"}}
+    assert sh_config == expected