Changed resource URI format in hydra-python-core and fixed tests. (#81)

* changed uri format
* updated doc_writer_sample
* fixed doc writer tests
* fixed tests
* fix pep8

Author: farazkhanfk7

docs/source/conf.py

@@ -54,4 +54,4 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ['_static']

hydra_python_core/doc_maker.py

@@ -6,7 +6,8 @@
 from pyld import jsonld
 import requests
 from hydra_python_core.doc_writer import (HydraDoc, HydraClass, HydraClassProp,
-                                          HydraClassOp, HydraStatus, HydraLink, HydraCollection, DocUrl)
+                                          HydraClassOp, HydraStatus, HydraLink,
+                                          HydraCollection, DocUrl)
 from typing import Any, Dict, Match, Optional, Tuple, Union, List
 from hydra_python_core.namespace import hydra, rdfs
 from urllib.parse import urlparse
@@ -30,7 +31,6 @@ def create_doc(doc: Dict[str, Any], HYDRUS_SERVER_URL: str = None,
     if not all(key in doc for key in ('@context', '@id', '@type')):
         raise SyntaxError("Please make sure doc contains @context, @id and @type")
 
-
     _context = doc['@context']
     base_url = ''
     entrypoint = ''
@@ -115,7 +115,8 @@ def create_doc(doc: Dict[str, Any], HYDRUS_SERVER_URL: str = None,
 
     # make endpoint classes
     for endpoint_classes in _endpoint_class:
-        if endpoint_classes['@id'] == hydra['Resource'] or endpoint_classes['@id'] == hydra['Collection'] or \
+        if endpoint_classes['@id'] == hydra['Resource'] or \
+            endpoint_classes['@id'] == hydra['Collection'] or \
                 endpoint_classes['@id'].find("EntryPoint") != -1:
             continue
         class_ = create_class(endpoint_classes, endpoint=True)
@@ -145,6 +146,7 @@ def create_doc(doc: Dict[str, Any], HYDRUS_SERVER_URL: str = None,
     apidoc.gen_EntryPoint()
     return apidoc
 
+
 def create_collection(endpoint_collection: Dict[str, Any]) -> HydraCollection:
     """
      Creates the instance of HydraCollection from expanded APIDOC
@@ -164,11 +166,14 @@ def create_collection(endpoint_collection: Dict[str, Any]) -> HydraCollection:
 
     manages = {}
     if hydra['object'] in endpoint_collection[hydra['manages']][0]:
-        manages['object'] = check_namespace(endpoint_collection[hydra['manages']][0][hydra['object']][0]['@id'])
+        object_id = endpoint_collection[hydra['manages']][0][hydra['object']][0]['@id']
+        manages['object'] = check_namespace(object_id)
     if hydra['subject'] in endpoint_collection[hydra['manages']][0]:
-        manages['subject'] = check_namespace(endpoint_collection[hydra['manages']][0][hydra['subject']][0]['@id'])
+        subject_id = endpoint_collection[hydra['manages']][0][hydra['subject']][0]['@id']
+        manages['subject'] = check_namespace(subject_id)
     if hydra['property'] in endpoint_collection[hydra['manages']][0]:
-        manages['property'] = check_namespace(endpoint_collection[hydra['manages']][0][hydra['property']][0]['@id'])
+        property_id = endpoint_collection[hydra['manages']][0][hydra['property']][0]['@id']
+        manages['property'] = check_namespace(property_id)
     is_get = False
     is_post = False
     is_put = False
@@ -364,13 +369,11 @@ def create_link(supported_property: Dict[str, Any]) -> HydraLink:
 
 def check_namespace(id_: str = None) -> str:
     """
-    A helper method to check if the classes and properties are in the same namespace and if not bring them
-    into the right namespace
+    A helper method to check if the classes and properties are in the same
+    namespace and if not bring them into the right namespace
     :param id_ The id to check
     :return: correct url
     """
-    if id_.find(DocUrl.doc_url) == -1 and id_ != "null" and id_.find('#') != -1:
-        id_ = "{}{}".format(DocUrl.doc_url, id_.split('#')[-1])
+    if id_.find(DocUrl.doc_url) == -1 and id_ != "null" and id_.find('?resource=') != -1:
+        id_ = "{}{}".format(DocUrl.doc_url, id_.split('?resource=')[-1])
     return id_
-
-

hydra_python_core/doc_writer.py

@@ -109,7 +109,9 @@ def generate(self) -> Dict[str, Any]:
             "description": self.desc,
             "entrypoint": urljoin(self.base_url, self.entrypoint_endpoint),
             "supportedClass": [
-                x.generate() for x in parsed_classes + self.other_classes + collections + [self.entrypoint]],
+                x.generate()
+                for x in parsed_classes + self.other_classes + collections + [self.entrypoint]
+            ],
             "possibleStatus": [status.generate() for status in self.possible_status]
         }
         return doc
@@ -214,15 +216,16 @@ def generate(self) -> Dict[str, Any]:
 class HydraClassOp():
     """Template for a new supportedOperation."""
 
-    def __init__(self,
-                 title: str,
-                 method: str,
-                 expects: Optional[str],
-                 returns: Optional[str],
-                 expects_header: List[str] = [],
-                 returns_header: List[str] = [],
-                 possible_status: List[Union['HydraStatus', 'HydraError']] = [],
-                 ) -> None:
+    def __init__(
+        self,
+        title: str,
+        method: str,
+        expects: Optional[str],
+        returns: Optional[str],
+        expects_header: List[str] = [],
+        returns_header: List[str] = [],
+        possible_status: List[Union['HydraStatus', 'HydraError']]=[],
+    ) -> None:
         """Initialize the Hydra_Prop."""
         self.title = title
         self.method = method
@@ -267,52 +270,59 @@ def __init__(
             collection_name: str = None,
             collection_path: str = None,
             collection_description: str = None,
-            manages: Union[Dict[str, Any], List] = None,
+            manages: Union[Dict[str, Any], List]=None,
             get: bool = True, post: bool = True, put: bool = True, delete: bool = True) -> None:
         """Generate Collection for related resources."""
         self.collection_id = "{}{}".format(DocUrl.doc_url, quote(collection_name, safe=''))
         self.name = collection_name
         self.collection_description = collection_description
         self.path = collection_path if collection_path else self.name
         self.supportedOperation = list()  # type: List
-        self.supportedProperty = [HydraClassProp("http://www.w3.org/ns/hydra/core#member",
-                                                 "members",
-                                                  True, True, False,
-                                                 "The members of {}".format(collection_name))]
+        self.supportedProperty = [HydraClassProp(
+            "http://www.w3.org/ns/hydra/core#member",
+            "members",
+            True,
+            True,
+            False,
+            "The members of {}".format(collection_name))]
         self.manages = manages
 
         if get:
-            get_op = HydraCollectionOp("_:{}_retrieve".format(self.name),
-                                       "http://schema.org/FindAction",
-                                       "GET", "Retrieves all the members of {}".format(self.name),
-                                       None, self.manages['object'], [], [], [])
+            get_op = HydraCollectionOp(
+                "_:{}_retrieve".format(self.name),
+                "http://schema.org/FindAction",
+                "GET", "Retrieves all the members of {}".format(self.name),
+                None, self.manages['object'], [], [], [])
             self.supportedOperation.append(get_op)
 
         if put:
-            put_op = HydraCollectionOp("_:{}_create".format(self.name), "http://schema.org/AddAction",
-                                       "PUT", "Create new member in {}".format(self.name),
-                                       self.manages['object'], self.manages['object'], [], [],
-                                       [HydraStatus(code=201, desc="A new member in {} created".format(self.name))]
-                                       )
+            put_op = HydraCollectionOp(
+                "_:{}_create".format(self.name), "http://schema.org/AddAction",
+                "PUT", "Create new member in {}".format(self.name),
+                self.manages['object'], self.manages['object'], [], [],
+                [HydraStatus(code=201, desc="A new member in {} created".format(self.name))]
+                )
             self.supportedOperation.append(put_op)
         if post:
-            post_op = HydraCollectionOp("_:{}_update".format(self.name),
-                                        "http://schema.org/UpdateAction",
-                                        "POST", "Update member of  {} ".format(self.name),
-                                        self.manages['object'], self.manages['object'], [], [],
-                                        [HydraStatus(code=200, desc="If the entity was updated"
-                                                                    "from {}.".format(self.name))]
-                                        )
+            post_op = HydraCollectionOp(
+                "_:{}_update".format(self.name),
+                "http://schema.org/UpdateAction",
+                "POST", "Update member of  {} ".format(self.name),
+                self.manages['object'], self.manages['object'], [], [],
+                [HydraStatus(code=200, desc="If the entity was updated"
+                                            "from {}.".format(self.name))]
+                )
             self.supportedOperation.append(post_op)
 
         if delete:
-            delete_op = HydraCollectionOp("_:{}_delete".format(self.name),
-                                          "http://schema.org/DeleteAction",
-                                          "DELETE", "Delete member of {} ".format(self.name),
-                                          self.manages['object'], self.manages['object'], [], [],
-                                          [HydraStatus(code=200, desc="If entity was deleted"
-                                                                      "successfully from {}.".format(self.name))]
-                                          )
+            delete_op = HydraCollectionOp(
+                "_:{}_delete".format(self.name),
+                "http://schema.org/DeleteAction",
+                "DELETE", "Delete member of {} ".format(self.name),
+                self.manages['object'], self.manages['object'], [], [],
+                [HydraStatus(code=200, desc="If entity was deleted"
+                                            "successfully from {}.".format(self.name))]
+                )
             self.supportedOperation.append(delete_op)
 
     def generate(self) -> Dict[str, Any]:
@@ -343,7 +353,7 @@ def __init__(self,
                  returns: Optional[str],
                  expects_header: List[str] = [],
                  returns_header: List[str] = [],
-                 possible_status: List[Union['HydraStatus', 'HydraError']] = [],
+                 possible_status: List[Union['HydraStatus', 'HydraError']]=[],
                  ) -> None:
         """Create method."""
         self.id_ = id_
@@ -379,18 +389,19 @@ def __init__(self, base_url: str, entrypoint: str) -> None:
         """Initialize the Entrypoint."""
         self.url = base_url
         self.api = entrypoint
+        class_id = "{}?resource=EntryPoint".format(urljoin(self.url, self.api))
         self.entrypoint = HydraClass("EntryPoint", "The main entry point or homepage of the API.",
-                                     _id="{}#EntryPoint".format(urljoin(self.url, self.api)))
+                                     _id=class_id)
         self.entrypoint.add_supported_op(EntryPointOp(
             "_:entry_point".format(base_url), "GET", "The APIs main entry point.", None, None,
-            type_="{}/{}#EntryPoint".format(base_url, entrypoint)))
+            type_="{}/{}?resource=EntryPoint".format(base_url, entrypoint)))
         self.context = Context(
             "{}{}".format(
                 base_url,
                 entrypoint),
             entrypoint=self)
 
-        self.collections: List[EntryPointCollection] = []
+        self.collections = list()
 
     def add_Class(self, class_: HydraClass) -> None:
         """Add supportedProperty to the EntryPoint.
@@ -428,8 +439,8 @@ def generate(self) -> Dict[str, Any]:
     def get(self) -> Dict[str, str]:
         """Create the EntryPoint object to be returnd for the get function."""
         object_ = {
-            "@context": "{}{}/contexts/EntryPoint.jsonld".format(self.url,self.api),
-            "@id": "{}{}".format(self.url,self.api),
+            "@context": "{}{}/contexts/EntryPoint.jsonld".format(self.url, self.api),
+            "@id": "{}{}".format(self.url, self.api),
             "@type": "EntryPoint",
 
         }
@@ -438,7 +449,7 @@ def get(self) -> Dict[str, str]:
             if item.generate() in self.collections:
                 collection_returned = item.generate()
                 collection_id = uri.replace(
-                    "{}EntryPoint".format(DocUrl.doc_url), "{}{}".format(self.url,self.api))
+                    "{}EntryPoint".format(DocUrl.doc_url), "{}{}".format(self.url, self.api))
                 collection_to_append = {
                     "@id": collection_id,
                     'title': collection_returned['hydra:title'],
@@ -454,7 +465,7 @@ def get(self) -> Dict[str, str]:
 
             else:
                 object_[item.name] = uri.replace(
-                    "{}EntryPoint".format(DocUrl.doc_url), "{}{}".format(self.url,self.api))
+                    "{}EntryPoint".format(DocUrl.doc_url), "{}{}".format(self.url, self.api))
 
         return object_
 
@@ -554,7 +565,7 @@ def __init__(self,
                  returns: Optional[str],
                  expects_header: List[str] = [],
                  returns_header: List[str] = [],
-                 possible_status: List[Union['HydraStatus', 'HydraError']] = [],
+                 possible_status: List[Union['HydraStatus', 'HydraError']]=[],
                  type_: Optional[str] = None,
                  label: str = "",
                  ) -> None:
@@ -639,10 +650,10 @@ def __init__(self,
 
     def generate(self) -> Dict[str, Any]:
         """Get IriTemplate as a python dict"""
-        base_url = DocUrl.doc_url.rsplit('/',2)[0]
+        base_url = DocUrl.doc_url.rsplit('/', 2)[0]
         iri_template = {
             "@type": "hydra:IriTemplate",
-            "hydra:template": "{}{}".format(base_url,self.template),
+            "hydra:template": "{}{}".format(base_url, self.template),
             "hydra:variableRepresentation": self.variable_rep,
             "hydra:mapping": [x.generate() for x in self.mapping]
         }
@@ -739,7 +750,8 @@ def __init__(self,
         # context elements to the base Hydra context
         if class_ is not None:
             self.context = {"hydra": "http://www.w3.org/ns/hydra/core#",
-                            "members": "http://www.w3.org/ns/hydra/core#member", "object": "http://schema.org/object",
+                            "members": "http://www.w3.org/ns/hydra/core#member",
+                            "object": "http://schema.org/object",
                             class_.title: class_.id_}  # type: Dict[str, Any]
             for prop in class_.supportedProperty:
                 if isinstance(prop.prop, HydraLink):
@@ -840,4 +852,4 @@ class DocUrl:
     doc_url = ''
 
     def __init__(self, base_url: str, api_name: str, doc_name: str) -> None:
-        DocUrl.doc_url = "{}/{}#".format(urljoin(base_url, api_name), doc_name)
+        DocUrl.doc_url = "{}/{}?resource=".format(urljoin(base_url, api_name), doc_name)

hydra_python_core/namespace.py

@@ -86,4 +86,4 @@
     "domain": rdfsNamespace + "domain",
     "label": rdfsNamespace + "label",
     "range": rdfsNamespace + "range"
-}
+}