Merge pull request #20 from asfadmin/feature-core-search

Core search features

CHANGELOG.md

@@ -2,8 +2,29 @@
 
 ## [0.3.0](https://github.com/asfadmin/Discovery-asf_search/compare/v0.2.4...v0.3.0)
 
+### Added
+- Layed out framework for INSTRUMENT constants (needs to be populated)
+- Support for baseline stacking of pre-calculated datasets
+- Download support for single products or entire search result sets, token-based auth only
+- ASFSearchResults and ASFProduct classes
+- Lower-level ASFError exception class
+- ASFDownloadError exception class
+- ASFBaselineError exception class
+- Better path/frame/platform/product example
+
 ### Changed
 - No longer uses range type for parameters that accept lists of values and/or ranges. Now expects a 2-value tuple.
+- Removed DATASET constants (not searchable, use platform+instrument to identify a dataset)
+- Updated hello_world.py baseline example
+- Removed output options across the board, geojson only until we no longer rely on SearchAPI calls
+- insarStackID now a search option (needed for baseline stacking of pre-calculated datasets)
+- Flatter structure for constants
+- baseline functionality moved into search group (file restructuring)
+
+### Fixed
+- Corrected handling of version number in user agent string
+- unused import cleanup
+- better type hinting on centroid() function
 
 ## [0.2.4](https://github.com/asfadmin/Discovery-asf_search/compare/v0.0.0...v0.2.4)
 

asf_search/__init__.py

@@ -4,7 +4,6 @@
 from .constants import *
 from .health import *
 from .search import *
-from .baseline import *
 
 try:
     __version__ = version(__name__)

asf_search/constants/__init__.py

@@ -1,11 +1,11 @@
 """Various constants to be used in search and related functions, provided as a convenience to help ensure sensible values."""
 
-from .DATASET import DATASET
-from .PLATFORM import PLATFORM
-from .POLARIZATION import POLARIZATION
-from .BEAMMODE import BEAMMODE
-from .FLIGHT_DIRECTION import FLIGHT_DIRECTION
-from .PRODUCT_TYPE import PRODUCT_TYPE
-from .INTERNAL import INTERNAL
+from .BEAMMODE import *
+from .FLIGHT_DIRECTION import *
+from .INSTRUMENT import *
+from .PLATFORM import *
+from .POLARIZATION import *
+from .PRODUCT_TYPE import *
+from .INTERNAL import *
 
 #TODO: add INSTRUMENT constants

asf_search/download/__init__.py

@@ -0,0 +1 @@
+from .download import download_url

asf_search/download/download.py

@@ -0,0 +1,45 @@
+import os.path
+import urllib.parse
+import requests
+from importlib.metadata import PackageNotFoundError, version
+from ..exceptions import ASFDownloadError
+
+
+def download_url(url: str, dir: str, filename: str = None, token: str = None) -> None:
+    """
+    Downloads a product from the specified URL to the specified location and (optional) filename.
+
+    :param url: URL from which to download
+    :param dir: Directory in which to save the product
+    :param filename: Optional filename to be used, extracted from the URL by default
+    :param token: EDL Auth Token for authenticating downloads, see https://urs.earthdata.nasa.gov/user_tokens
+    :return:
+    """
+    if filename is None:
+        filename = os.path.split(urllib.parse.urlparse(url).path)[1]
+
+    if not os.path.isdir(dir):
+        raise ASFDownloadError(f'Error downloading {url}: directory not found: {dir}')
+
+    if os.path.isfile(os.path.join(dir, filename)):
+        raise ASFDownloadError(f'File already exists: {os.path.join(dir, filename)}')
+
+    try:
+        pkg_version = version(__name__)
+    except PackageNotFoundError:
+        pkg_version = '0.0.0'
+    headers = {'User-Agent': f'{__name__}.{pkg_version}'}
+    if token is not None:
+        headers['Authorization'] = f'Bearer {token}'
+
+    response = requests.get(url, stream=True, allow_redirects=False)
+    while 300 <= response.status_code <= 399:
+        new_url = response.headers['location']
+        if 'aws.amazon.com' in urllib.parse.urlparse(new_url).netloc:
+            response = requests.get(new_url, stream=True, allow_redirects=False)  # S3 detests auth headers
+        else:
+            response = requests.get(new_url, stream=True, headers=headers, allow_redirects=False)
+    response.raise_for_status()
+    with open(os.path.join(dir, filename), 'wb') as f:
+        for chunk in response.iter_content(chunk_size=8192):
+            f.write(chunk)

asf_search/exceptions.py

@@ -1,11 +1,20 @@
-class ASFSearchError(Exception):
-    """Base Exception for asf_search"""
+class ASFError(Exception):
+    """Base ASF Exception, not intended for direct use"""
+
+class ASFSearchError(ASFError):
+    """Base search-related Exception"""
 
 class ASFSearch4xxError(ASFSearchError):
     """Raise when SearchAPI returns a 4xx error"""
 
 class ASFSearch5xxError(ASFSearchError):
     """Raise when SearchAPI returns a 5xx error"""
 
-class ServerError(ASFSearchError):
-    """Raise when SearchAPI returns an unknown error"""
+class ASFServerError(ASFSearchError):
+    """Raise when SearchAPI returns an unknown error"""
+
+class ASFBaselineError(ASFSearchError):
+    """Raise when baseline related errors occur"""
+
+class ASFDownloadError(ASFError):
+    """Base download-related Exception"""

asf_search/search/__init__.py

@@ -2,3 +2,6 @@
 from .granule_search import granule_search
 from .product_search import product_search
 from .geo_search import geo_search
+from .baseline_search import stack_from_id
+from .product import ASFProduct
+from .results import ASFSearchResults