hdpws 0.6.8__tar.gz → 0.6.19__tar.gz

{hdpws-0.6.8 → hdpws-0.6.19}/PKG-INFO

@@ -1,13 +1,12 @@
 Metadata-Version: 2.1
 Name: hdpws
-Version: 0.6.8
+Version: 0.6.19
 Summary: NASA's Heliophysics Data Portal Web Service Client Library
 Home-page: https://heliophysicsdata.gsfc.nasa.gov/WebServices
 Author: Bernie Harris
 Author-email: NASA-SPDF-Support@nasa.onmicrosoft.com
 License: NOSA
 Keywords: heliophysics,spase,space physics,spdf,hdp
-Platform: UNKNOWN
 Classifier: Development Status :: 3 - Alpha
 Classifier: Environment :: Console
 Classifier: Environment :: Web Environment
@@ -98,5 +97,3 @@ Bernie Harris.
 
 This code is licensed under the 
 [NASA Open Source Agreement](https://cdaweb.gsfc.nasa.gov/WebServices/NASA_Open_Source_Agreement_1.3.txt) (NOSA).
-
-

{hdpws-0.6.8 → hdpws-0.6.19}/hdpws/__init__.py

@@ -41,7 +41,7 @@ the United States under Title 17, U.S.Code. All Other Rights Reserved.
 """
 
 
-__version__ = "0.6.8"
+__version__ = "0.6.19"
 
 
 #

{hdpws-0.6.8 → hdpws-0.6.19}/hdpws/__main__.py

@@ -147,6 +147,23 @@ def example(
                 disable_ssl_certificate_validation, user_agent='Example')
 
 
+    result = hdp.get_application_interfaces()
+    if result['HttpStatus'] == 200:
+        print('HDP ApplicationInterfaces:')
+        for value in result['ApplicationInterface']:
+            print(f'    {value}')
+    else:
+        print_error('hdp.get_application_interfaces', result)
+
+    result = hdp.get_keywords()
+    if result['HttpStatus'] == 200:
+        print('HDP Keywords:')
+        for value in result['Keyword'][0:5]:
+            print(f'    {value}')
+        print('    ...')
+    else:
+        print_error('hdp.get_keywords', result)
+
     result = hdp.get_instrument_ids()
     if result['HttpStatus'] == 200:
         print('HDP InstrumentIDs:')
@@ -325,6 +342,7 @@ def example(
         'InstrumentID': 'spase://SMWG/Instrument/ACE/MAG',
         'PhenomenonType': 'MagneticCloud',
         'Description': 'ICME'
+#        'Keyword': 'current sheet'
     }
     time_range = ['1999-01-01', '1999-01-02']
 
@@ -385,6 +403,27 @@ def example(
         print_error('hdp.get_spase_document', result)
 
 
+    query = {
+        'ResourceID': 'spase://CCMC/Software/Kamodo',
+        'CodeLanguage': 'Python',
+        'Description': '"space weather models and data"'
+    }
+
+
+    if result['HttpStatus'] == 200:
+        #print('HDP Spase:')
+        #print(ET.tostring(result['Result']))
+        print('Result Software:')
+        for software in result['Result'].findall('.//Software', namespaces=NS):
+            print(software.findall('.//ResourceID', namespaces=NS)[0].text)
+            print('    ', software.findall('.//ResourceName', namespaces=NS)[0].text)
+            #ET.indent(software)
+            #print(ET.tostring(software, encoding='unicode',
+            #                  default_namespace=SPASE_NS))
+    else:
+        print_error('hdp.get_spase_software', result)
+
+
 def print_error(
         label: str,
         result: Dict

{hdpws-0.6.8 → hdpws-0.6.19}/hdpws/hdpws.py

@@ -197,6 +197,61 @@ class HdpWs:
         return self._endpoint
 
 
+    def get_application_interfaces(
+            self
+        ) -> Dict:
+        """
+        Gets all /Spase/Software/ApplicationInterface values available at HDP.
+
+        Returns
+        -------
+        Dict
+            Dictionary containing a 'ApplicationInterface' key with a value
+            of a List containing all /Spase/Software/ApplicationInterface values
+            with the addition of the following key/values:<br>
+            - HttpStatus: with the value of the HTTP status code.
+              Successful == 200.<br>
+            When HttpStatus != 200:<br>
+            - HttpText: containing a string representation of the HTTP
+              entity body.<br>
+            When HttpText is a standard HDP WS error entity body the
+            following key/values (convenience to avoid parsing
+            HttpStatus):<br>
+            - ErrorMessage: value from HttpText.<br>
+            - ErrorDescription: value from HttpText.<br>
+        """
+        return self.__get_simple_resource('Spase/ApplicationInterface',
+                                          'ApplicationInterface', 
+                                          'ApplicationInterface')
+
+    def get_keywords(
+            self
+        ) -> Dict:
+        """
+        Gets all //Keyword values available at HDP.
+
+        Returns
+        -------
+        Dict
+            Dictionary containing a 'Keyword' key with a value
+            of a List containing all /Keyword values
+            with the addition of the following key/values:<br>
+            - HttpStatus: with the value of the HTTP status code.
+              Successful == 200.<br>
+            When HttpStatus != 200:<br>
+            - HttpText: containing a string representation of the HTTP
+              entity body.<br>
+            When HttpText is a standard HDP WS error entity body the
+            following key/values (convenience to avoid parsing
+            HttpStatus):<br>
+            - ErrorMessage: value from HttpText.<br>
+            - ErrorDescription: value from HttpText.<br>
+        """
+        return self.__get_simple_resource('Spase/Keyword',
+                                          'Keyword', 
+                                          'Keyword')
+
+
     def get_instrument_ids(
             self
         ) -> Dict:
@@ -790,6 +845,45 @@ class HdpWs:
         return self.__get_complex_resource([ResourceType.DOCUMENT], query)
 
 
+    def get_spase_software(
+            self,
+            query: Dict
+        ) -> Dict:
+        """
+        Gets the specified SPASE Software documents from HDP.
+
+        Parameters
+        ----------
+        query
+            Dictionary containing query parameters and values.  For
+            example,<pre>
+            query = { 
+                'ResourceID': 'spase://CCMC/Software/Kamodo',
+                'CodeLanguage': 'Python',
+                'Description': '"space weather models and data"'
+            }</pre>
+
+        Returns
+        -------
+        Dict
+            Dictionary containing a 'Result' key with a value of an
+            ElementTree representation of the results as described by
+            <https://heliophysicsdata.gsfc.nasa.gov/WebServices/hdpspase.xsd>
+            with the addition of the following key/values:<br>
+            - HttpStatus: with the value of the HTTP status code.
+              Successful == 200.<br>
+            When HttpStatus != 200:<br>
+            - HttpText: containing a string representation of the HTTP
+              entity body.<br>
+            When HttpText is a standard HDP WS error entity body the
+            following key/values (convenience to avoid parsing
+            HttpStatus):<br>
+            - ErrorMessage: value from HttpText.<br>
+            - ErrorDescription: value from HttpText.<br>
+        """
+        return self.__get_complex_resource([ResourceType.SOFTWARE], query)
+
+
     def __get_simple_resource(
             self,
             resource: str,

{hdpws-0.6.8 → hdpws-0.6.19}/hdpws/resourcetype.py

@@ -52,3 +52,4 @@ class ResourceType(Enum):
     DISPLAY_DATA = 'DisplayData'
     OBSERVATORY = 'Observatory'
     SERVICE = 'Service'
+    SOFTWARE = 'Software'

{hdpws-0.6.8 → hdpws-0.6.19}/hdpws.egg-info/PKG-INFO

@@ -1,13 +1,12 @@
 Metadata-Version: 2.1
 Name: hdpws
-Version: 0.6.8
+Version: 0.6.19
 Summary: NASA's Heliophysics Data Portal Web Service Client Library
 Home-page: https://heliophysicsdata.gsfc.nasa.gov/WebServices
 Author: Bernie Harris
 Author-email: NASA-SPDF-Support@nasa.onmicrosoft.com
 License: NOSA
 Keywords: heliophysics,spase,space physics,spdf,hdp
-Platform: UNKNOWN
 Classifier: Development Status :: 3 - Alpha
 Classifier: Environment :: Console
 Classifier: Environment :: Web Environment
@@ -98,5 +97,3 @@ Bernie Harris.
 
 This code is licensed under the 
 [NASA Open Source Agreement](https://cdaweb.gsfc.nasa.gov/WebServices/NASA_Open_Source_Agreement_1.3.txt) (NOSA).
-
-

{hdpws-0.6.8 → hdpws-0.6.19}/hdpws.egg-info/SOURCES.txt

@@ -11,4 +11,8 @@ hdpws.egg-info/PKG-INFO
 hdpws.egg-info/SOURCES.txt
 hdpws.egg-info/dependency_links.txt
 hdpws.egg-info/requires.txt
-hdpws.egg-info/top_level.txt
+hdpws.egg-info/top_level.txt
+tests/test_access_information.py
+tests/test_access_url.py
+tests/test_dateinterval.py
+tests/test_hdpws.py

{hdpws-0.6.8 → hdpws-0.6.19}/setup.py

@@ -10,7 +10,7 @@ README = (HERE / "README.md").read_text()
 # This call to setup() does all the work
 setup(
     name="hdpws",
-    version="0.6.8",
+    version="0.6.19",
     description="NASA's Heliophysics Data Portal Web Service Client Library",
     long_description=README,
     long_description_content_type="text/markdown",

hdpws-0.6.19/tests/test_access_information.py

@@ -0,0 +1,117 @@
+#!/usr/bin/env python3
+
+#
+# NOSA HEADER START
+#
+# The contents of this file are subject to the terms of the NASA Open
+# Source Agreement (NOSA), Version 1.3 only (the "Agreement").  You may
+# not use this file except in compliance with the Agreement.
+#
+# You can obtain a copy of the agreement at
+#   docs/NASA_Open_Source_Agreement_1.3.txt
+# or
+#   https://cdaweb.gsfc.nasa.gov/WebServices/NASA_Open_Source_Agreement_1.3.txt.
+#
+# See the Agreement for the specific language governing permissions
+# and limitations under the Agreement.
+#
+# When distributing Covered Code, include this NOSA HEADER in each
+# file and include the Agreement file at
+# docs/NASA_Open_Source_Agreement_1.3.txt.  If applicable, add the
+# following below this NOSA HEADER, with the fields enclosed by
+# brackets "[]" replaced with your own identifying information:
+# Portions Copyright [yyyy] [name of copyright owner]
+#
+# NOSA HEADER END
+#
+# Copyright (c) 2023 United States Government as represented by
+# the National Aeronautics and Space Administration. No copyright is
+# claimed in the United States under Title 17, U.S.Code. All Other
+# Rights Reserved.
+#
+
+"""
+Module for unittest of the AccessURL class.<br>
+
+Copyright &copy; 2023 United States Government as represented by the
+National Aeronautics and Space Administration. No copyright is claimed in
+the United States under Title 17, U.S.Code. All Other Rights Reserved.
+"""
+
+import unittest
+import xml.etree.ElementTree as ET
+import copy
+
+from context import hdpws  # pylint: disable=unused-import
+
+from hdpws import NAMESPACES as NS
+from hdpws.spase import AccessInformation  # pylint: disable=import-error
+
+
+BAD_ACCESS_INFO = ET.fromstring('<BadAccessInformation/>')
+
+TEST_REPOSITORY_ID = 'spase://SMWG/Repository/NASA/GSFC/SPDF'
+TEST_AVAILABILITY = 'Online'
+TEST_ACCESS_RIGHTS = 'Open'
+TEST_NAME = 'CDAWeb HAPI Server'
+TEST_URL = 'https://cdaweb.gsfc.nasa.gov/hapi'
+TEST_STYLE = 'HAPI'
+TEST_PRODUCT_KEYS = ['WI_H0_MFI@0', 'WI_H0_MFI@1', 'WI_H0_MFI@2']
+TEST_DESCRIPTION = 'Web Service to this product using the HAPI interface.'
+TEST_LANGUAGE = 'en'
+TEST_FORMAT = 'CSV'
+
+TEST_ACCESS_INFO = ET.fromstring(
+'<AccessInformation xmlns="http://www.spase-group.org/data/schema">\
+<RepositoryID>' + TEST_REPOSITORY_ID + '</RepositoryID>\
+<Availability>' + TEST_AVAILABILITY + '</Availability>\
+<AccessRights>' + TEST_ACCESS_RIGHTS + '</AccessRights>\
+<AccessURL>\
+<Name>' + TEST_NAME + '</Name>\
+<URL>' + TEST_URL + '</URL>\
+<Style>' + TEST_STYLE + '</Style>\
+<ProductKey>' + TEST_PRODUCT_KEYS[0] + '</ProductKey>\
+<ProductKey>' + TEST_PRODUCT_KEYS[1] + '</ProductKey>\
+<ProductKey>' + TEST_PRODUCT_KEYS[2] + '</ProductKey>\
+<Description>' + TEST_DESCRIPTION + '</Description>\
+<Language>' + TEST_LANGUAGE + '</Language>\
+</AccessURL>\
+<Format>' + TEST_FORMAT + '</Format>\
+</AccessInformation>')
+
+
+class TestAccessInformation(unittest.TestCase):
+    """
+    Class for unittest of AccessInformation class.
+    """
+
+    def __init__(self, *args, **kwargs):
+        super(TestAccessInformation, self).__init__(*args, **kwargs)
+
+
+    def test_access_information_exception(self):
+        """
+        Test for constructor exception.
+        """
+
+        with self.assertRaises(ValueError):
+            AccessInformation(BAD_ACCESS_INFO)
+
+
+
+    def test_access_information_properties(self):
+        """
+        Test for AccessInformation properties.
+        """
+
+        access_info = AccessInformation(TEST_ACCESS_INFO)
+
+        self.assertEqual(access_info.repository_id, TEST_REPOSITORY_ID)
+        self.assertEqual(access_info.availability, TEST_AVAILABILITY)
+        self.assertEqual(access_info.access_rights, TEST_ACCESS_RIGHTS)
+        self.assertListEqual(access_info.format, [TEST_FORMAT])
+
+
+
+if __name__ == '__main__':
+    unittest.main()

hdpws-0.6.19/tests/test_access_url.py

@@ -0,0 +1,145 @@
+#!/usr/bin/env python3
+
+#
+# NOSA HEADER START
+#
+# The contents of this file are subject to the terms of the NASA Open
+# Source Agreement (NOSA), Version 1.3 only (the "Agreement").  You may
+# not use this file except in compliance with the Agreement.
+#
+# You can obtain a copy of the agreement at
+#   docs/NASA_Open_Source_Agreement_1.3.txt
+# or
+#   https://cdaweb.gsfc.nasa.gov/WebServices/NASA_Open_Source_Agreement_1.3.txt.
+#
+# See the Agreement for the specific language governing permissions
+# and limitations under the Agreement.
+#
+# When distributing Covered Code, include this NOSA HEADER in each
+# file and include the Agreement file at
+# docs/NASA_Open_Source_Agreement_1.3.txt.  If applicable, add the
+# following below this NOSA HEADER, with the fields enclosed by
+# brackets "[]" replaced with your own identifying information:
+# Portions Copyright [yyyy] [name of copyright owner]
+#
+# NOSA HEADER END
+#
+# Copyright (c) 2023 United States Government as represented by
+# the National Aeronautics and Space Administration. No copyright is
+# claimed in the United States under Title 17, U.S.Code. All Other
+# Rights Reserved.
+#
+
+"""
+Module for unittest of the AccessURL class.<br>
+
+Copyright &copy; 2023 United States Government as represented by the
+National Aeronautics and Space Administration. No copyright is claimed in
+the United States under Title 17, U.S.Code. All Other Rights Reserved.
+"""
+
+import unittest
+import xml.etree.ElementTree as ET
+import copy
+
+from context import hdpws  # pylint: disable=unused-import
+
+from hdpws import NAMESPACES as NS
+from hdpws.spase import AccessURL, HapiAccessURL, HAPI_DISPLAY_URL  # pylint: disable=import-error
+
+
+BAD_ACCESS_URL = ET.fromstring('<BadAccessUrl/>')
+
+TEST_NAME = 'CDAWeb HAPI Server'
+TEST_URL = 'https://cdaweb.gsfc.nasa.gov/hapi'
+TEST_STYLE = 'HAPI'
+TEST_PRODUCT_KEYS = ['WI_H0_MFI@0', 'WI_H0_MFI@1', 'WI_H0_MFI@2']
+TEST_DESCRIPTION = 'Web Service to this product using the HAPI interface.'
+TEST_LANGUAGE = 'en'
+
+TEST_ACCESS_URL = ET.fromstring(
+'<AccessURL xmlns="http://www.spase-group.org/data/schema">\
+<Name>' + TEST_NAME + '</Name>\
+<URL>' + TEST_URL + '</URL>\
+<Style>' + TEST_STYLE + '</Style>\
+<ProductKey>' + TEST_PRODUCT_KEYS[0] + '</ProductKey>\
+<ProductKey>' + TEST_PRODUCT_KEYS[1] + '</ProductKey>\
+<ProductKey>' + TEST_PRODUCT_KEYS[2] + '</ProductKey>\
+<Description>' + TEST_DESCRIPTION + '</Description>\
+<Language>' + TEST_LANGUAGE + '</Language>\
+</AccessURL>')
+
+
+class TestAccessURL(unittest.TestCase):
+    """
+    Class for unittest of AccessURL class.
+    """
+
+    def __init__(self, *args, **kwargs):
+        super(TestAccessURL, self).__init__(*args, **kwargs)
+
+
+    def test_access_url_exception(self):
+        """
+        Test for constructor exception.
+        """
+
+        with self.assertRaises(ValueError):
+            AccessURL(BAD_ACCESS_URL)
+
+
+
+    def test_access_url_properties(self):
+        """
+        Test for AccessURL properties.
+        """
+
+        access_url = AccessURL(TEST_ACCESS_URL)
+
+        self.assertEqual(access_url.name, TEST_NAME)
+        self.assertEqual(access_url.url, TEST_URL)
+        self.assertEqual(access_url.style, TEST_STYLE)
+        for idx, product_key in enumerate(access_url.product_key):
+            self.assertEqual(product_key, TEST_PRODUCT_KEYS[idx])
+        self.assertEqual(access_url.description, TEST_DESCRIPTION)
+        self.assertEqual(access_url.language, TEST_LANGUAGE)
+
+
+class TestHapiAccessURL(unittest.TestCase):
+    """
+    Class for unittest of HapiAccessURL class.
+    """
+
+    def __init__(self, *args, **kwargs):
+        super(TestHapiAccessURL, self).__init__(*args, **kwargs)
+
+
+    def test_hapi_access_url_exception(self):
+        """
+        Test for constructor exception.
+        """
+
+        hapi_access_url = copy.deepcopy(TEST_ACCESS_URL)
+        style = hapi_access_url.find('Style', namespaces=NS)
+        self.assertIsNotNone(style)
+        style.text = 'WebService'
+
+        with self.assertRaises(ValueError):
+            HapiAccessURL(hapi_access_url)
+
+    def test_get_html_url(self):
+        """
+        Test for get_html_url method.
+        """
+
+        hapi_access_url = HapiAccessURL(TEST_ACCESS_URL)
+
+        self.assertEqual(hapi_access_url.get_html_url(),
+                         HAPI_DISPLAY_URL + '#url=' + hapi_access_url.url + \
+                         '&id=' + TEST_PRODUCT_KEYS[0] + ',' + \
+                         TEST_PRODUCT_KEYS[1] + ',' + \
+                         TEST_PRODUCT_KEYS[2])
+
+
+if __name__ == '__main__':
+    unittest.main()

hdpws-0.6.19/tests/test_dateinterval.py

@@ -0,0 +1,132 @@
+#!/usr/bin/env python3
+
+#
+# NOSA HEADER START
+#
+# The contents of this file are subject to the terms of the NASA Open
+# Source Agreement (NOSA), Version 1.3 only (the "Agreement").  You may
+# not use this file except in compliance with the Agreement.
+#
+# You can obtain a copy of the agreement at
+#   docs/NASA_Open_Source_Agreement_1.3.txt
+# or
+#   https://cdaweb.gsfc.nasa.gov/WebServices/NASA_Open_Source_Agreement_1.3.txt.
+#
+# See the Agreement for the specific language governing permissions
+# and limitations under the Agreement.
+#
+# When distributing Covered Code, include this NOSA HEADER in each
+# file and include the Agreement file at
+# docs/NASA_Open_Source_Agreement_1.3.txt.  If applicable, add the
+# following below this NOSA HEADER, with the fields enclosed by
+# brackets "[]" replaced with your own identifying information:
+# Portions Copyright [yyyy] [name of copyright owner]
+#
+# NOSA HEADER END
+#
+# Copyright (c) 2023 United States Government as represented by
+# the National Aeronautics and Space Administration. No copyright is
+# claimed in the United States under Title 17, U.S.Code. All Other
+# Rights Reserved.
+#
+
+"""
+Module for unittest of the DateInterval class.<br>
+
+Copyright &copy; 2023 United States Government as represented by the
+National Aeronautics and Space Administration. No copyright is claimed in
+the United States under Title 17, U.S.Code. All Other Rights Reserved.
+"""
+
+import unittest
+from datetime import date
+
+from context import hdpws  # pylint: disable=unused-import
+
+from hdpws.dateinterval import DateInterval  # pylint: disable=import-error
+
+
+
+class TestDateInterval(unittest.TestCase):
+    """
+    Class for unittest of DateInterval class.
+    """
+
+    def __init__(self, *args, **kwargs):
+        super(TestDateInterval, self).__init__(*args, **kwargs)
+
+
+    def test_get_date_exceptions(self):
+        """
+        Test for get_date function exceptions.
+        """
+
+        with self.assertRaises(ValueError):
+            DateInterval.get_date(123)
+
+        with self.assertRaises(ValueError):
+            DateInterval.get_date('bad_date')
+
+
+    def test_get_dates_exceptions(self):
+        """
+        Test for get_date function.
+        """
+
+        with self.assertRaises(ValueError):
+            DateInterval.get_dates('2020-01-01', 123)
+
+        with self.assertRaises(ValueError):
+            DateInterval.get_dates('2020-01-01', 'bad_date')
+
+
+    def test_date_interval_init(self):
+        """
+        Test for DateInterval constructor.
+        """
+
+        self.assertEqual(DateInterval.get_date('2023-01-01'),
+                         date(2023, 1, 1))
+
+
+    def test_date_interval_eq(self):
+        """
+        Test for DateInterval equality operator.
+        """
+
+        t_1 = DateInterval('2023-01-01', '2023-01-02')
+        t_2 = DateInterval(date(2023, 1, 1),
+                           date(2023, 1, 2))
+
+        self.assertEqual(t_1, t_2)
+
+
+    def test_date_interval_str(self):
+        """
+        Test DateInterval.str().
+        """
+
+        t_1 = DateInterval(date(2023, 1, 1),
+                           date(2023, 1, 2))
+
+        self.assertEqual(str(t_1),
+                         '2023-01-01,2023-01-02')
+
+
+    def test_date_interval_properties(self):
+        """
+        Test DateInterval properties.
+        """
+
+        t_1 = DateInterval(date(2023, 1, 1),
+                           date(2023, 1, 2))
+
+        t_1.start = date(2020, 1, 1)
+        t_1.end = date(2020, 1, 2)
+
+        self.assertEqual(t_1.start, date(2020, 1, 1))
+        self.assertEqual(t_1.end, date(2020, 1, 2))
+
+
+if __name__ == '__main__':
+    unittest.main()

hdpws-0.6.19/tests/test_hdpws.py

@@ -0,0 +1,438 @@
+#!/usr/bin/env python3
+
+#
+# NOSA HEADER START
+#
+# The contents of this file are subject to the terms of the NASA Open
+# Source Agreement (NOSA), Version 1.3 only (the "Agreement").  You may
+# not use this file except in compliance with the Agreement.
+#
+# You can obtain a copy of the agreement at
+#   docs/NASA_Open_Source_Agreement_1.3.txt
+# or
+#   https://cdaweb.gsfc.nasa.gov/WebServices/NASA_Open_Source_Agreement_1.3.txt.
+#
+# See the Agreement for the specific language governing permissions
+# and limitations under the Agreement.
+#
+# When distributing Covered Code, include this NOSA HEADER in each
+# file and include the Agreement file at
+# docs/NASA_Open_Source_Agreement_1.3.txt.  If applicable, add the
+# following below this NOSA HEADER, with the fields enclosed by
+# brackets "[]" replaced with your own identifying information:
+# Portions Copyright [yyyy] [name of copyright owner]
+#
+# NOSA HEADER END
+#
+# Copyright (c) 2023 United States Government as represented by
+# the National Aeronautics and Space Administration. No copyright is
+# claimed in the United States under Title 17, U.S.Code. All Other
+# Rights Reserved.
+#
+
+"""
+Module for unittest of the HdpWs class.<br>
+
+Copyright &copy; 2023 United States Government as represented by the
+National Aeronautics and Space Administration. No copyright is claimed in
+the United States under Title 17, U.S.Code. All Other Rights Reserved.
+"""
+
+import unittest
+import datetime
+import xml.etree.ElementTree as ET
+
+from context import hdpws  # pylint: disable=unused-import
+
+from hdpws.hdpws import HdpWs   # pylint: disable=import-error
+from hdpws import XHTML_NS, NAMESPACES as NS
+from hdpws.resourcetype import ResourceType as rt
+
+
+# More checks of the following result should probably be added
+# but more checks risk failing when the contents of the database
+# changes.
+
+class TestHdpWs(unittest.TestCase):
+    """
+    Class for unittest of HdpWs class.
+    """
+
+    def __init__(self, *args, **kwargs):
+        super(TestHdpWs, self).__init__(*args, **kwargs)
+        self._hdp = HdpWs(endpoint='http://localhost:8080/exist/restxq/')
+
+
+    def test_get_application_interfaces(self):
+        """
+        Test for get_application_interfaces function.
+        """
+
+        result = self._hdp.get_application_interfaces()
+
+        self.assertEqual(result['HttpStatus'], 200)
+        application_interfaces = result['ApplicationInterface']
+        self.assertTrue(len(application_interfaces) > 0)
+        self.assertTrue(application_interfaces[0] == 'CLI')
+
+
+    def test_get_keywords(self):
+        """
+        Test for get_keywords function.
+        """
+
+        result = self._hdp.get_keywords()
+
+        self.assertEqual(result['HttpStatus'], 200)
+        keywords = result['Keyword']
+        self.assertTrue(len(keywords) > 0)
+
+
+    def test_get_instrument_ids(self):
+        """
+        Test for get_instrument_ids function.
+        """
+
+        result = self._hdp.get_instrument_ids()
+
+        self.assertEqual(result['HttpStatus'], 200)
+        instr_ids = result['InstrumentID']
+        self.assertTrue(len(instr_ids) > 0)
+
+
+    def test_get_repository_ids(self):
+        """
+        Test for get_repository_ids function.
+        """
+
+        result = self._hdp.get_repository_ids()
+
+        self.assertEqual(result['HttpStatus'], 200)
+        repo_ids = result['RepositoryID']
+        self.assertTrue(len(repo_ids) > 0)
+
+
+    def test_get_styles(self):
+        """
+        Test for get_style function.
+        """
+
+        result = self._hdp.get_styles()
+
+        self.assertEqual(result['HttpStatus'], 200)
+        styles = result['Style']
+        self.assertTrue(len(styles) > 0)
+        self.assertTrue(styles[0] == 'EPNTAP')
+
+
+    def test_get_measurement_types(self):
+        """
+        Test for get_measurement_types function.
+        """
+
+        result = self._hdp.get_measurement_types()
+
+        self.assertEqual(result['HttpStatus'], 200)
+        measurement_types = result['MeasurementType']
+        self.assertTrue(len(measurement_types) > 0)
+        self.assertTrue(measurement_types[0] == 'ActivityIndex')
+
+
+    def test_get_spectral_ranges(self):
+        """
+        Test for get_spectral_ranges function.
+        """
+
+        result = self._hdp.get_spectral_ranges()
+
+        self.assertEqual(result['HttpStatus'], 200)
+        s_range = result['SpectralRange']
+        self.assertTrue(len(s_range) > 0)
+        self.assertTrue(s_range[0] == 'CaK')
+
+
+    def test_get_observatory_group_ids(self):
+        """
+        Test for get_observatory_group_ids function.
+        """
+
+        result = self._hdp.get_observatory_group_ids()
+
+        self.assertEqual(result['HttpStatus'], 200)
+        obs_grp_ids = result['ObservatoryGroupID']
+        self.assertTrue(len(obs_grp_ids) > 0)
+
+
+    def test_get_observatory_ids(self):
+        """
+        Test for get_observatory_ids function.
+        """
+
+        result = self._hdp.get_observatory_ids()
+
+        self.assertEqual(result['HttpStatus'], 200)
+        obs_ids = result['ObservatoryID']
+        self.assertTrue(len(obs_ids) > 0)
+
+
+    def test_get_observed_regions(self):
+        """
+        Test for get_observed_regions function.
+        """
+
+        result = self._hdp.get_observed_regions()
+
+        self.assertEqual(result['HttpStatus'], 200)
+        obs_regions = result['ObservedRegion']
+        self.assertTrue(len(obs_regions) > 0)
+        self.assertTrue(obs_regions[0] == 'Asteroid')
+
+
+    def test_get_spase(self):
+        """
+        Test for get_spase function.
+        """
+
+        resource_ids = [ 
+            'spase://NASA/Collection/IRIS_AIA',
+            'spase://SMWG/Service/CCMC/Models'
+        ]   
+        result = self._hdp.get_spase(resource_ids)
+
+        self.assertEqual(result['HttpStatus'], 200)
+        result = result['Result']
+        result_id_elements = result.findall('.//ResourceID', namespaces=NS)
+        result_ids = list(map(lambda e: e.text, result_id_elements))
+        self.assertTrue(len(result_ids) == 3) 
+        # above should be == 2 when duplicate is removed from hdp and
+        # then the following will work
+        #self.assertTrue(sorted(result_ids) == sorted(resource_ids))
+
+
+    def test_get_spase_if_modified_since(self):
+        """
+        Test for get_spase function's if_modified_since option.
+        """
+
+        resource_ids = [ 
+            'spase://NASA/NumericalData/Wind/MFI/PT03S'
+        ]   
+        result = self._hdp.get_spase(resource_ids)
+
+        self.assertEqual(result['HttpStatus'], 200)
+
+        last_modified = result['Last-Modified']
+        self.assertIsNotNone(last_modified)
+
+        result = self._hdp.get_spase(resource_ids, 
+                                     if_modified_since=last_modified)
+
+        self.assertEqual(result['HttpStatus'], 304)
+
+        last_modified -= datetime.timedelta(seconds=5)
+        result = self._hdp.get_spase(resource_ids, 
+                                     if_modified_since=last_modified)
+
+        self.assertEqual(result['HttpStatus'], 200)
+
+
+    def test_get_spase_url(self):
+        """
+        Test for get_spase_url function.
+        """
+
+        resource_id = 'spase://NASA/NumericalData/Wind/MFI/PT03S'
+
+        result = self._hdp.get_spase_url(resource_id)
+
+        self.assertIsNotNone(result)
+        self.assertEqual(result, 
+                         self._hdp.endpoint + 'Spase?ResourceID=' + \
+                         resource_id)
+
+
+    def test_get_spase_html(self):
+        """
+        Test for get_spase_html function.
+        """
+
+        resource_id = 'spase://NASA/NumericalData/Wind/MFI/PT03S'
+
+        result = self._hdp.get_spase_html(resource_id)
+
+        self.assertEqual(result['HttpStatus'], 200)
+
+        last_modified = result['Last-Modified']
+        self.assertIsNotNone(last_modified)
+
+        result = self._hdp.get_spase_html(resource_id, 
+                                          if_modified_since=last_modified)
+
+        self.assertEqual(result['HttpStatus'], 304)
+
+        last_modified -= datetime.timedelta(seconds=5)
+        result = self._hdp.get_spase_html(resource_id, 
+                                          if_modified_since=last_modified)
+
+        self.assertEqual(result['HttpStatus'], 200)
+        result_element = ET.fromstring(result['Result'])
+        self.assertEqual(result_element.tag, 
+                         '{' + XHTML_NS + '}html')
+
+
+    def test_get_spase_data(self):
+        """
+        Test for get_spase_data function.
+        """
+
+        query = { 
+            'ResourceID': ['spase://NASA/NumericalData/ACE/CRIS/L2/P1D',
+                'spase://NASA/NumericalData/ACE/CRIS/L2/PT1H'
+            ],  
+#            'DOI': ['10.48322/e0dc-0h53'],
+#            'InstrumentID': 'spase://SMWG/Instrument/ACE/CRIS',
+#            'ObservatoryID': 'spase://SMWG/Observatory/ACE',
+#            'Cadence': '=PT1H',
+#            'ObservedRegion': 'Heliosphere.NearEarth',
+#            'MeasurementType': 'EnergeticParticles',
+#            'AccessRights': 'Open',
+#            'Format': 'CDF'
+        }
+
+        types = [rt.NUMERICAL_DATA, rt.DISPLAY_DATA]
+        time_range = ['2022-01-01', '2022-01-02']
+
+        result = self._hdp.get_spase_data(types, query, time_range)
+
+        self.assertEqual(result['HttpStatus'], 200)
+        result = result['Result']
+        result_id_elements = result.findall('.//ResourceID',
+                                            namespaces=NS)
+        result_ids = list(map(lambda e: e.text, result_id_elements))
+        self.assertTrue(len(result_ids) == 2)
+        self.assertTrue(sorted(result_ids) == sorted(query['ResourceID']))
+
+
+    def test_get_spase_data_if_modified_since(self):
+        """
+        Test for get_spase_data function's if_modified_since option.
+        """
+
+        query = { 
+            'ResourceID': ['spase://NASA/NumericalData/ACE/CRIS/L2/P1D'],  
+        }
+
+        types = [rt.NUMERICAL_DATA, rt.DISPLAY_DATA]
+        time_range = ['2022-01-01', '2022-01-02']
+
+        result = self._hdp.get_spase_data(types, query, time_range)
+
+        self.assertEqual(result['HttpStatus'], 200)
+
+        last_modified = result['Last-Modified']
+        last_modified += datetime.timedelta(seconds=1)
+        self.assertIsNotNone(last_modified)
+
+        result = self._hdp.get_spase_data(types, query, time_range,
+                                          if_modified_since=last_modified)
+
+        self.assertEqual(result['HttpStatus'], 304)
+
+        last_modified -= datetime.timedelta(seconds=5)
+        result = self._hdp.get_spase_data(types, query, time_range,
+                                          if_modified_since=last_modified)
+
+        self.assertEqual(result['HttpStatus'], 200)
+
+
+    def test_get_spase_catalog(self):
+        """
+        Test for get_spase_catalog function.
+        """
+
+        query = { 
+            'InstrumentID': 'spase://SMWG/Instrument/ACE/MAG',
+            'PhenomenonType': 'MagneticCloud',
+            'Description': 'ICME'
+        } 
+        time_range = ['1999-01-01', '1999-01-02']
+
+        result = self._hdp.get_spase_catalog(query, time_range)
+
+        self.assertEqual(result['HttpStatus'], 200)
+        result = result['Result']
+        result_id_elements = result.findall('.//ResourceID',
+                                            namespaces=NS)
+        result_ids = list(map(lambda e: e.text, result_id_elements))
+        self.assertTrue(len(result_ids) == 1)
+        self.assertTrue(result_ids[0] == 'spase://NASA/Catalog/CME-ICME_Cho2003')
+
+
+    def test_get_spase_collection(self):
+        """
+        Test for get_spase_collection function.
+        """
+
+        query = { 
+            'ResourceID': 'spase://NASA/Collection/IRIS_AIA',
+            'MemberID': 'spase://NASA/NumericalData/SDO/AIA/PT10S',
+            'Description': 'IRIS AND SDO and AIA'
+        } 
+
+        result = self._hdp.get_spase_collection(query)
+
+        self.assertEqual(result['HttpStatus'], 200)
+        result = result['Result']
+        result_id_elements = result.findall('.//ResourceID',
+                                            namespaces=NS)
+        result_ids = list(map(lambda e: e.text, result_id_elements))
+        self.assertTrue(len(result_ids) == 1)
+        self.assertTrue(result_ids[0] == 'spase://NASA/Collection/IRIS_AIA')
+
+
+    def test_get_spase_document(self):
+        """
+        Test for get_spase_document function.
+        """
+
+        query = { 
+            'ResourceID': 'spase://SMWG/Document/HPDE/Policy/HP_DataPolicy_v1.2',
+            'DOI': '10.21978/P83P78',
+            'Description': '"Program Data Management Plan"'
+        } 
+
+        result = self._hdp.get_spase_document(query)
+
+        self.assertEqual(result['HttpStatus'], 200)
+        result = result['Result']
+        result_id_elements = result.findall('.//ResourceID',
+                                            namespaces=NS)
+        result_ids = list(map(lambda e: e.text, result_id_elements))
+        self.assertTrue(len(result_ids) == 1)
+        self.assertTrue(result_ids[0] == 'spase://SMWG/Document/HPDE/Policy/HP_DataPolicy_v1.2')
+
+
+    def test_get_spase_software(self):
+        """
+        Test for get_spase_software function.
+        """
+
+        query = {
+            'ResourceID': 'spase://CCMC/Software/Kamodo',
+            'CodeLanguage': 'Python',
+            'Description': '"space weather models and data"'
+        }  
+
+        result = self._hdp.get_spase_software(query)
+
+        self.assertEqual(result['HttpStatus'], 200)
+        result = result['Result']
+        result_id_elements = result.findall('.//ResourceID',
+                                            namespaces=NS)
+        result_ids = list(map(lambda e: e.text, result_id_elements))
+        self.assertTrue(len(result_ids) == 1)
+        self.assertTrue(result_ids[0] == 'spase://CCMC/Software/Kamodo')
+
+
+if __name__ == '__main__':
+    unittest.main()