-
Notifications
You must be signed in to change notification settings - Fork 926
[LIBCLOUD-747] Add Zonomi DNS provider implementation #582
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| Zonomi DNS Driver Documentation | ||
| =========================== | ||
|
|
||
| `Zonomi`_ name servers are spread around the globe (London, Dallas, New York | ||
| and Auckland). It offers Fully redundant, fault-tolerant, reliable name | ||
| servers, Instant updates, Low TTLs, Wildcard domain names, Any DNS record type, | ||
| Dynamic DNS, DNS API, Round robin DNS, No need to transfer your domain name | ||
| registrar, Integrates with Pingability's DNS fail over, Vanity name servers. | ||
|
|
||
| Read more at: http://zonomi.com/ | ||
|
|
||
| Instantiating the driver | ||
| -------------------------- | ||
|
|
||
| .. literalinclude:: /examples/dns/zonomi/instantiate_driver.py | ||
| :language: python | ||
|
|
||
| API Docs | ||
| -------- | ||
|
|
||
| .. autoclass:: libcloud.dns.drivers.zonomi.ZonomiDNSDriver | ||
| :members: | ||
| :inherited-members: | ||
|
|
||
| .. _`Zonomi`: http://zonomi.com/ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| from libcloud.dns.types import Provider | ||
| from libcloud.dns.providers import get_driver | ||
|
|
||
| cls = get_driver(Provider.ZONOMI) | ||
| driver = cls('apikey') |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,150 @@ | ||
| # Licensed to the Apache Software Foundation (ASF) under one or more | ||
| # contributor license agreements. See the NOTICE file distributed with | ||
| # this work for additional information regarding copyright ownership. | ||
| # The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| # (the "License"); you may not use this file except in compliance with | ||
| # the License.You may obtain a copy of the License at | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| from libcloud.common.base import XmlResponse | ||
| from libcloud.common.base import ConnectionKey | ||
| from libcloud.utils.py3 import b, PY3 | ||
|
|
||
|
|
||
| __all__ = [ | ||
| 'ZonomiException', | ||
| 'ZonomiResponse', | ||
| 'ZonomiConnection' | ||
| ] | ||
|
|
||
| # Endpoint for Zonomi API. | ||
| API_HOST = 'zonomi.com' | ||
|
|
||
| SPECIAL_ERRORS = [ | ||
| 'Not found.', | ||
| 'ERROR: This zone is already in your zone list.', | ||
| 'Record not deleted.' | ||
| ] | ||
|
|
||
|
|
||
| class ZonomiException(Exception): | ||
| def __init__(self, code, message): | ||
| self.code = code | ||
| self.message = message | ||
| self.args = (code, message) | ||
|
|
||
| def __str__(self): | ||
| return "%s %s" % (self.code, self.message) | ||
|
|
||
| def __repr__(self): | ||
| return "ZonomiException %s %s" % (self.code, self.message) | ||
|
|
||
|
|
||
| class ZonomiResponse(XmlResponse): | ||
| errors = None | ||
| objects = None | ||
|
|
||
| def __init__(self, response, connection): | ||
| self.connection = connection | ||
| self.headers = dict(response.getheaders()) | ||
| self.error = response.reason | ||
| self.status = response.status | ||
|
|
||
| # This attribute is used when using LoggingConnection | ||
| original_data = getattr(response, '_original_data', None) | ||
| if original_data: | ||
| self.body = response._original_data | ||
| else: | ||
| self.body = self._decompress_response(body=response.read(), | ||
| headers=self.headers) | ||
| if PY3: | ||
| self.body = b(self.body).decode('utf-8') | ||
| self.objects, self.errors = self.parse_body() | ||
| if self.errors: | ||
| raise self._make_excp(self.errors[0]) | ||
|
|
||
| def parse_body(self): | ||
| error_dict = {} | ||
| actions = None | ||
| result_counts = None | ||
| action_childrens = None | ||
| data = [] | ||
| errors = [] | ||
| xml_body = super(ZonomiResponse, self).parse_body() | ||
| # Error handling | ||
| if xml_body.text is not None and xml_body.tag == 'error': | ||
| error_dict['ERRORCODE'] = self.status | ||
| if xml_body.text.startswith('ERROR: No zone found for'): | ||
| error_dict['ERRORCODE'] = '404' | ||
| error_dict['ERRORMESSAGE'] = 'Not found.' | ||
| else: | ||
| error_dict['ERRORMESSAGE'] = xml_body.text | ||
| errors.append(error_dict) | ||
|
|
||
| # Data handling | ||
| childrens = xml_body.getchildren() | ||
| if len(childrens) == 3: | ||
| result_counts = childrens[1] | ||
| actions = childrens[2] | ||
|
|
||
| if actions is not None: | ||
| actions_childrens = actions.getchildren() | ||
| action = actions_childrens[0] | ||
| action_childrens = action.getchildren() | ||
|
|
||
| if action_childrens is not None: | ||
| for child in action_childrens: | ||
| if child.tag == 'zone' or child.tag == 'record': | ||
| data.append(child.attrib) | ||
|
|
||
| if result_counts is not None and \ | ||
| result_counts.attrib.get('deleted') == '1': | ||
| data.append('DELETED') | ||
|
|
||
| if result_counts is not None and \ | ||
| result_counts.attrib.get('deleted') == '0' and \ | ||
| action.get('action') == 'DELETE': | ||
| error_dict['ERRORCODE'] = self.status | ||
| error_dict['ERRORMESSAGE'] = 'Record not deleted.' | ||
| errors.append(error_dict) | ||
|
|
||
| return (data, errors) | ||
|
|
||
| # def success(self): | ||
| # return (len(self.errors) == 0) | ||
|
|
||
| def _make_excp(self, error): | ||
| """ | ||
| :param error: contains error code and error message | ||
| :type error: dict | ||
| """ | ||
| return ZonomiException(error['ERRORCODE'], error['ERRORMESSAGE']) | ||
|
|
||
|
|
||
| class ZonomiConnection(ConnectionKey): | ||
| host = API_HOST | ||
| responseCls = ZonomiResponse | ||
|
|
||
| def add_default_params(self, params): | ||
| """ | ||
| Adds default parameters to perform a request, | ||
| such as api_key. | ||
| """ | ||
| params['api_key'] = self.key | ||
|
|
||
| return params | ||
|
|
||
| def add_default_headers(self, headers): | ||
| """ | ||
| Adds default headers needed to perform a successful | ||
| request such as Content-Type, User-Agent. | ||
| """ | ||
| headers['Content-Type'] = 'text/xml;charset=UTF-8' | ||
|
|
||
| return headers | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I noticed you duplicated this code from the base class in one other driver as well. I know there is a small difference at the bottom, but duplication like this is problematic (it makes code hard to maintain). On top of the duplication, this also break the implicit signature / contract of the
parse_bodymethod (it should return an object, not a tuple).I will review this and merge this today, but after this is merged can you please open a new PR which reduces the duplication - you should re-use as much functionality from the parent class as possible.
One thing you could do is make
parse_bodya no-op and add a newparse_body_and_errorsmethod and make constructor look something like this:There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure. Sorry for my bads! I'll look at this tomorrow. Thank you so much!