field_doc_component param for get_manifestation, fixing #2

Author: csae8092

README.md

@@ -50,3 +50,6 @@ https://www.freud-edition.net/jsonapi/node/werk?filter[field_titel.value]=Über
 this ID can be taken from edit-url, e.g. https://www.freud-edition.net/node/51190/edit
 
 https://www.freud-edition.net/jsonapi/node/manifestation?filter[drupal_internal__nid]=51190
+
+https://www.freud-edition.net/jsonapi/node/manifestation?filter[drupal_internal__nid]=38946
+https://www.freud-edition.net/node/38946/edit

freud_api_crawler/__init__.py

@@ -2,4 +2,4 @@
 
 __author__ = """Peter Andorfer"""
 __email__ = '[email protected]'
-__version__ = '1.1.1'
+__version__ = '1.2.0'

freud_api_crawler/freud_api_crawler.py

@@ -14,6 +14,7 @@
 FRD_WORK_LIST = "https://www.freud-edition.net/jsonapi/node/werk?filter[field_status_umschrift]=2"
 FRD_USER = os.environ.get('FRD_USER', False)
 FRD_PW = os.environ.get('FRD_PW', False)
+FULL_MANIFEST = "228361d0-4cda-4805-a2f8-a05ee58119b6"
 
 
 def get_auth_items(username, password):
@@ -145,7 +146,7 @@ def get_werk(self):
         """ returns the werk json as python dict
 
         :return: a Werk representation
-        :rtrype: dict
+        :rtype: dict
         """
         r = requests.get(
             self.ep,
@@ -155,9 +156,20 @@ def get_werk(self):
         result = r.json()
         return result
 
-    def get_manifestations(self):
+    def get_manifestations(self, field_doc_component=None):
+        """ retuns a list of dicts of related manifestation
+        :param field_doc_component: Either `None` or the id of the taxanomy-term id
+        :type werk_id: str/bool
+
+        :return: A list of dicts with ids and titles of the related manifestations
+        :rtype: list
+        """
         man_col = []
-        url = f"{self.manifestation_ep}{self.filtered_url}&fields[node--manifestation]=id,title"
+        fields_param = "fields[node--manifestation]=id,title"
+        if field_doc_component is not None:
+            url = f"{self.manifestation_ep}{self.filtered_url}&{fields_param}&filter[field_doc_component.id]={field_doc_component}"  # noqa: E501
+        else:
+            url = f"{self.manifestation_ep}{self.filtered_url}&{fields_param}"
         next_page = True
         while next_page:
             print(url)

setup.py

@@ -62,6 +62,6 @@
     test_suite='tests',
     tests_require=test_requirements,
     url='https://github.com/acdh-oeaw/freud_api_crawler',
-    version='1.1.1',
+    version='1.2.0',
     zip_safe=False,
 )

tests/test_freud_api_crawler.py

@@ -141,10 +141,16 @@ def test_014_check_tei_serialiazer(self):
         print(type(xml), type(xml_str))
         self.assertTrue(frd_obj.manifestation_id in xml_str)
 
-    def test_015_yiel_works(self):
+    def test_015_yield_works(self):
         yielder = frd.yield_works(frd.FRD_WORK_LIST)
         self.assertIsInstance(yielder, types.GeneratorType)
 
+    def test_016_filter_man_by_type(self):
+        werk = FRD_WERK
+        all_man = werk.get_manifestations()
+        full_man = werk.get_manifestations(field_doc_component=frd.FULL_MANIFEST)
+        self.assertTrue(len(all_man) > len(full_man))
+
     def test_command_line_interface(self):
         """Test the CLI."""
         runner = CliRunner()