Uh oh!
There was an error while loading. Please reload this page.
Support APS API - #2
Conversation
| try: | ||
| import json | ||
| except ImportError: | ||
| import simplejson as json |
There was a problem hiding this comment.
We realy need support python < 2.6?
| return content | ||
| def GET(self, path, headers=None, data=None, cert=None): |
There was a problem hiding this comment.
Don't use upper in method name
| return self.do_open(self.getConnection, req, context=self._context) | ||
| return self.do_open(self.getConnection, req) | ||
| def getConnection(self, host, context=None, timeout=300): |
There was a problem hiding this comment.
Don't use camelcase in method name
| class HTTPSClientAuthHandler(urllib2.HTTPSHandler): | ||
| def __init__(self, key, cert): | ||
There was a problem hiding this comment.
Don't use blank lines between method declaration and logic
| class HTTPSClientAuthHandler(urllib2.HTTPSHandler): | ||
There was a problem hiding this comment.
Don't use blank lines between class declaration and methods
| class API: | ||
| verbose = False |
| return httplib.HTTPSConnection(host, key_file=self.key, cert_file=self.cert) | ||
| class API: |
| def getConnection(self, host, context=None, timeout=300): | ||
| if context is not None: | ||
| return httplib.HTTPSConnection(host, key_file=self.key, cert_file=self.cert, context=context) |
There was a problem hiding this comment.
Don't copy code
If you have context create some like extra and use it
extra = {}
if context:
extra['context'] = context
httplib.HTTPSConnection(host, key_file=self.key, cert_file=self.cert, **extra)
| elif (isinstance(data, (dict, list))): | ||
| data = json.dumps(data) | ||
| url = self.url + path |
| url = self.url + path | ||
| if not(headers): |
| # ('something' in error.aps.message) we convert this exception | ||
| # to JSON directly here. | ||
| error.aps = API.APSExcStruct() | ||
| if len(contents): |
| @@ -0,0 +1,122 @@ | |||
| #!/usr/bin/python | |||
| context = None | ||
| if _PYTHON_2_7_9_COMPAT: | ||
| context = ssl._create_unverified_context() | ||
| urllib2.HTTPSHandler.__init__(self, context=context) |
There was a problem hiding this comment.
use super
add blank line before/after super
| return self.do_open(self.get_connection, req, context=self._context) | ||
| def get_connection(self, host, context=None): | ||
| return httplib.HTTPSConnection(host, key_file=self.key, cert_file=self.cert, context=context) |
There was a problem hiding this comment.
why we can't use self._context as in https_open method?
| class API(object): | ||
| class APSExcStruct: |
| def call(self, verb, path, headers=None, data=None, cert=None, rheaders=None): | ||
| data = json.dumps(data) | ||
| # url = self.url + path |
| opener = urllib2.build_opener(HTTPSClientAuthHandler(cert, cert)) | ||
| resp = opener.open(req) | ||
| else: | ||
| if _PYTHON_2_7_9_COMPAT: |
There was a problem hiding this comment.
use logic like in HTTPSClientAuthHandler.__init__ with context as None by default
| resp = urllib2.urlopen(req, context=context) | ||
| else: | ||
| resp = urllib2.urlopen(req) | ||
| # "type": "APS::Hosting::Exception", | ||
| # "message": "Limit for resource ..." | ||
| # } | ||
| # In order to allow simple processing of this exception like |
There was a problem hiding this comment.
It's need here? Maybe move it in APSExcStruct?
| return self.call('DELETE', path, headers, data, cert) | ||
| # | ||
| # Usage Example: |
There was a problem hiding this comment.
Move example from code in README
| class API(object): | ||
| def __init__(self, url, use_unverified_context): |
There was a problem hiding this comment.
Set default for use_unverified_context
| # "message": "Limit for resource ..." | ||
| # } | ||
| # In order to allow simple processing of this exception like | ||
| # ('something' in error.aps.message) we convert this exception |
There was a problem hiding this comment.
If you remove APSExcStruct you need remove this comment too
| from urlparse import urljoin | ||
| class HTTPSClientAuthHandler(urllib2.HTTPSHandler, object): |
There was a problem hiding this comment.
use only urllib2.HTTPSHandler
There was a problem hiding this comment.
HTTPSHandler is old-style class with out object I cannot use super() in init()
| self.use_unverified_context = use_unverified_context | ||
| def call(self, verb, path, headers=None, data=None, cert=None): | ||
| data = json.dumps(data) |
There was a problem hiding this comment.
if data is None then the resulting json would be null which is a weird body for REST. Use smth like
ifnotdata:
data= {}| url = urljoin(self.url, path) | ||
| if not headers: | ||
| headers = dict() |
There was a problem hiding this comment.
headers= {}is a more common practice, with better performance
| data = json.dumps(data) | ||
| if not data: | ||
| data = {} | ||
| else: |
There was a problem hiding this comment.
This else is a typo, isn't it? json.dumps should be called unconditionally.
There was a problem hiding this comment.
@ikrasner Looks like you implemented basic and generic REST-like API wrapper over urllib2 without significant APS specificity like:
- Native collections in binding code eg. resources, types, application
- RQL filtering support
- Pagination
- Native APS headers
Looks "so-so", Ok for first version and just usage generalisation.
But its possible to use Slumber or any other More advanced REST interface binding for resolve this simple task.
| --------------------------------------- | ||
| ```{.sourceCode .python} | ||
| import apsapi | ||
| aapi = apsapi.API(url = 'https://hostname:6308') |
| ```{.sourceCode .python} | ||
| import apsapi | ||
| aapi = apsapi.API(url = 'https://hostname:6308') | ||
| resp = aapi.GET( '/aps/2/resources/' + safilter, {'APS-Token': token} ) |
There was a problem hiding this comment.
safilter what is it? I can't find in README.md any information about it.
| ```{.sourceCode .python} | ||
| import apsapi | ||
| aapi = apsapi.API(url = 'https://hostname:6308') | ||
| resp = aapi.GET( '/aps/2/resources/' + safilter, {'APS-Token': token} ) |
There was a problem hiding this comment.
aapi.GET( '/aps/2/resources/' )
Extra spaces in doc code, please check and fix
| def __init__(self, url, use_unverified_context=False): | ||
| """ | ||
| Takes something like the following argument as input: | ||
| url = 'https://a.bvt.aps.sw.ru:6308' |
There was a problem hiding this comment.
Try to use depersonalized example instead eg. hostname or example.com
| packages=['osaapi', 'apsapi'], | ||
| url='https://aps.odin.com', | ||
| license='Apache License', | ||
| description='A python client for the Odin Service Automation (OSA) and billing APIs.', |
There was a problem hiding this comment.
A python binding for Odin Automation and APS controller https://doc.apsstandard.org/7.1/api/rest/
CLAassistant
commented
Apr 25, 2022
ikrasner seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
Add basic support of APS controller interface http://doc.apsstandard.org/7.1/api/