Improve JSON-less 404 error readability and prevention with client library

[ianballou]

This code aims to stop the Unexpected error: No JSON object could be decoded error mentioned in #910:

• The error is caused by 404 pages without JSON hitting json.loads().
• If json.loads() fails, print out the response content rather than throwing the error above.
• Since this isn't pretty, the following target 404's:
  • Characters that get passed to the API will be limited to numbers, letters, and $ - _ . + ! * ' ( ) ,
  • The client library checks object names per-call for characters that don't match this.

• If the client library detects bad characters, it will print something like: Error: Projects may not contain: ['/', '&'] to alert the user of the illegal characters that they entered.

  I anticipate that the tests will take a while to write since I am introducing changes to the majority of the client library calls. Thus, I'm introducing this code now so I can get feedback before writing the tests.

Note: some commands, such as switch_register, have not been implemented in the client library yet. These will get checks for reserved characters when they are implemented.

[ianballou]

Just wanted to note that I'm back working for the new semester so I'll have activity on here soon.

[ianballou]

My latest commit cleans up the methods for checking for reserved characters.

[ianballou]

The tests for this are in progress now.

[ianballou]

I've setup decorators/wrappers to check the illegal characters now, so the client functions should remain otherwise unedited.

[ianballou]

I've addressed the requests and added a first pass at the tests. Did I address your requests correctly @zenhack and @naved001 ?

[naved001]

I don't have any other comments to make on this at this point, @zenhack has already made some good points.

[naved001]

actually, don't worry about it.

On Tue, Feb 6, 2018 at 3:28 PM, Ian Ballou notifications@github.com wrote:

@Izhmash commented on this pull request.

In hil/client/base.py https://github.com/CCI-MOC/hil/pull/926#discussion_r166432879:

         e = json.loads(response.content)

raise FailedAPICallException( error_type=e['type'], message=e['msg'], )

• Catching responses that do not return JSON

• except ValueError:
• return response.content

• +def _find_reserved(string, slashes_ok=False):

• """Returns a list of illegal characters in a string"""
• if slashes_ok:
• p = r"[^A-Za-z0-9 /$_.+!*'(),-]+"
• else:
• p = r"[^A-Za-z0-9 $_.+!*'(),-]+"
• return list(x for l in re.findall(p, string) for x in l)

I might be wrong, but I think this is one of those cases where the list comprehension is actually less complex than if I didn't use a one-liner. I can add a comment for clarification if that helps.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/CCI-MOC/hil/pull/926#discussion_r166432879, or mute the thread https://github.com/notifications/unsubscribe-auth/ATLmqB-yO1cFIPjvQmgM3ubT6papKBBCks5tSLXugaJpZM4RD9GS .

[ianballou]

@zenhack I believe I've addressed all of your requests in these two commits

[zenhack]

LGTM