[SYNPY-1199] Implement low-level functions for JSON Schema API

[BrunoGrandePhD]

Example usage: https://gist.github.com/BrunoGrandePhD/481249a94196cbdd47e8524dab7ddbbc

Install using:

 pip install --force-reinstall git+https://github.com/Sage-Bionetworks/synapsePythonClient@bgrande/SYNPY-1199/json-schemas-low-level

[pep8speaks]

Hello @BrunoGrandePhD! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

• In the file synapseclient/client.py:

Line 684:20: E221 multiple spaces before operator

• In the file synapseclient/services/__init__.py:

Line 3:1: F401 '.json_schema.JsonSchemaService' imported but unused

• In the file synapseclient/services/json_schema.py:

Line 9:1: F401 'typing.TYPE_CHECKING' imported but unused
Line 192:21: W503 line break before binary operator

Comment last updated at 2022-02-10 17:57:27 UTC

[ychae]

@milen-sage are you still able to review this by EOD today?

[BrunoGrandePhD]

It has come to my attention that the displayName field in the user profile has been deprecated. Hence, new Synapse users won't have it and thus the _loggedIn() function doesn't work as expected; it returns None instead of the display name, which evaluates to True. I've opened a Synapse Platform ticket to see how to perform the same check now that displayName has been deprecated.

Shout-out to @afwillia for finding the bug!

[milen-sage]

@ychae, @afwillia is going through the JSONSchema client features, since that aligns with his work for this sprint.

[thomasyu888]

Some linting issues and comments.

[vpchung]

In Slack, @BrunoGrandePhD and I discussed adding attribute validation to the API so that users are aware of invalid values as soon as possible, e.g. organizationName should be at least 6 characters long. The current behavior does not catch this after a user tries to create:

>>> foo = js.JsonSchemaOrganization("foo")
>>> foo.create()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/Users/vchung/Desktop/synapsePythonClient/synapseclient/services/json_schema.py", line 288, in create
    already_exists = self.get()
  File "/Users/vchung/Desktop/synapsePythonClient/synapseclient/services/json_schema.py", line 257, in get
    raise e
  File "/Users/vchung/Desktop/synapsePythonClient/synapseclient/services/json_schema.py", line 251, in get
    response = self.service.get_organization(self.name)
  File "/Users/vchung/Desktop/synapsePythonClient/synapseclient/services/json_schema.py", line 428, in wrapper
    result = func(self, *args, **kwargs)
  File "/Users/vchung/Desktop/synapsePythonClient/synapseclient/services/json_schema.py", line 446, in get_organization
    response = self.synapse.restGET(
  File "/Users/vchung/Desktop/synapsePythonClient/synapseclient/client.py", line 4091, in restGET
    response = self._rest_call('get', uri, None, endpoint, headers, retryPolicy, requests_session, **kwargs)
  File "/Users/vchung/Desktop/synapsePythonClient/synapseclient/client.py", line 4075, in _rest_call
    self._handle_synapse_http_error(response)
  File "/Users/vchung/Desktop/synapsePythonClient/synapseclient/client.py", line 4045, in _handle_synapse_http_error
    exceptions._raise_for_status(response, verbose=self.debug)
  File "/Users/vchung/Desktop/synapsePythonClient/synapseclient/core/exceptions.py", line 160, in _raise_for_status
    raise SynapseHTTPError(message, response=response)
synapseclient.core.exceptions.SynapseHTTPError: 400 Client Error: 
Organization name must be at least 6 characters

This is currently in my backlog TODOs.