octodns-cloudns 0.0.2__py3-none-any.whl → 0.0.10__py3-none-any.whl

octodns_cloudns/__init__.py

@@ -8,7 +8,7 @@ from octodns.record import Record
 logging.basicConfig(level=logging.DEBUG)
 logger = logging.getLogger(__name__)
 
-__version__ = __VERSION__ = '0.0.2'
+__version__ = __VERSION__ = '0.0.10'
 
 class ClouDNSClientException(ProviderException):
     pass
@@ -44,7 +44,8 @@ class ClouDNSClientGeoDNSNotSupported(ClouDNSClientException):
 
 
 class ClouDNSClient(object):
-    def __init__(self, auth_id, auth_password, sub_auth=False):
+    def __init__(self, auth_id, auth_password, id, sub_auth=False):
+        self.log = getLogger(f"ClouDNSProvider[{id}]")
         session = Session()
         session.headers.update(
             {
@@ -75,9 +76,9 @@ class ClouDNSClient(object):
         
     def _raw_request(self, function, params=''):
         url = self._urlbase.format(function, params)
-        logger.debug(f"Request URL: {url}")
+        self.log.debug(f"Request URL: {url}")
         response = self._session.get(url)
-        logger.debug(f"Request Response: {response.text}")
+        self.log.debug(f"Request Response: {response.text}")
         return response
         
     def _handle_response(self, response):
@@ -117,7 +118,7 @@ class ClouDNSClient(object):
 
         single_types = ['CNAME', 'A', 'AAAA', 'DNAME', 'ALIAS', 'NS', 'PTR', 'SPF', 'TXT']
         if rrset_type in single_types:
-            params += '&record={}'.format(rrset_values[0].replace('\;', ';'))
+            params += '&record={}'.format(rrset_values[0].replace(r'\;', ';').replace('+', '%2B'))
             
         if(geodns is True):
             for location in rrset_locations:
@@ -241,11 +242,11 @@ class ClouDNSProvider(BaseProvider):
         ]
     )
 
-    def __init__(self, id, auth_id, auth_password, *args, **kwargs):
+    def __init__(self, id, auth_id, auth_password, sub_auth=False, *args, **kwargs):
         self.log = getLogger(f"ClouDNSProvider[{id}]")
-        self.log.debug("__init__: id=%s, auth_id=***", id)
+        self.log.debug("__init__: id=%s, auth_id=***, auth_password=***, sub_auth=%s", id, sub_auth)
         super().__init__(id, *args, **kwargs)
-        self._client = ClouDNSClient(auth_id, auth_password)
+        self._client = ClouDNSClient(auth_id, auth_password, id, sub_auth)
 
         self._zone_records = {}
 
@@ -260,10 +261,14 @@ class ClouDNSProvider(BaseProvider):
         return {
             "ttl": records[0]["ttl"],
             "type": _type,
-            "value": records[0]["record"].replace(';', '\\;') + ".",
+            "values": [
+                (record["record"].replace(';', '\\;').rstrip('.'))
+                for record in records
+            ]
         }
 
 
+
     _data_for_A = _data_for_multiple
     _data_for_AAAA = _data_for_multiple
     _data_for_SPF = _data_for_multiple
@@ -367,27 +372,10 @@ class ClouDNSProvider(BaseProvider):
 
         values = defaultdict(lambda: defaultdict(list))
         records_data = self.zone_records(zone)
-        
+
         if 'status' in records_data and records_data['status'] == 'Failed':
-            self.log.info("populate: no existing zone, trying to create it")
-            response = self._client.zone_create(zone.name[:-1], 'master')
-            if 'id' in response and response['id'] == 'not_found':
-                e = ClouDNSClientUnknownDomainName(
-                    'Missing domain name'
-                )
-                e.__cause__ = None
-                raise e
-            
-            if (self.isGeoDNS(response['statusDescription'])):
-                response = self._client.zone_create(zone.name[:-1], 'geodns')
-            
-            if(response['status'] == 'Failed'):
-                e = ClouDNSClientUnknownDomainName(f"{response['status']} : {response['statusDescription']}")
-                e.__cause__ = None
-                raise e
-            self.log.info("populate: zone has been successfully created")
-            records_data = self._client.zone_records(zone.name[:-1])
-            
+            return []
+
         for record_id, record in records_data.items():
             _type = record["type"]
             
@@ -408,7 +396,7 @@ class ClouDNSProvider(BaseProvider):
                 )
                 zone.add_record(record, lenient=lenient)
         exists = zone.name in self._zone_records
-        self.log.info(
+        self.log.debug(
             "populate:   found %s records, exists=%s",
             len(zone.records) - before,
             exists,
@@ -576,74 +564,96 @@ class ClouDNSProvider(BaseProvider):
         zone = existing.zone
         record_ids = []
         for record_id, record in self.zone_records(zone).items():
-            for value in existing.values:
-                if existing._type == 'NAPTR' and record['type'] == 'NAPTR':                    
-                    if (
-                        existing.name == record['host']
-                        and value.order == int(record['order'])
-                        and value.preference == int(record['pref'])
-                        and value.flags == record['flag']
-                    ):
-                        record_ids.append(record_id)
+                if existing._type == 'NAPTR' and record['type'] == 'NAPTR':
+                    for value in existing.values:
+                        if (
+                            existing.name == record['host']
+                            and value.order == int(record['order'])
+                            and value.preference == int(record['pref'])
+                            and value.flags == record['flag']
+                        ):
+                            record_ids.append(record_id)
                 elif existing._type == 'SSHFP' and record['type'] == 'SSHFP':
-                    if (
-                        existing.name == record['host']
-                        and value.fingerprint_type == int(record['fp_type'])
-                        and value.algorithm == int(record['algorithm'])
-                        and value.fingerprint == record['record']
-                    ):
-                        record_ids.append(record_id)
+                    for value in existing.values:
+                        if (
+                            existing.name == record['host']
+                            and value.fingerprint_type == int(record['fp_type'])
+                            and value.algorithm == int(record['algorithm'])
+                            and value.fingerprint == record['record']
+                        ):
+                            record_ids.append(record_id)
                 elif existing._type == 'SRV' and record['type'] == 'SRV':
-                    if (
-                        existing.name == record['host']
-                        and value.priority == int(record['priority'])
-                        and value.weight == int(record['weight'])
-                        and value.port == record['port']
-                        and value.target == record['record']
-                    ):
-                        record_ids.append(record_id)
+                    for value in existing.values:
+                        if (
+                            existing.name == record['host']
+                            and value.priority == int(record['priority'])
+                            and value.weight == int(record['weight'])
+                            and value.port == record['port']
+                            and value.target == record['record']
+                        ):
+                            record_ids.append(record_id)
                 elif existing._type == 'CAA' and record['type'] == 'CAA':
-                    if (
-                        existing.name == record['host']
-                        and value.flags == record['caa_flag']
-                        and value.tag == record['caa_type']
-                        and value.value == record['caa_value']
-                    ):
-                        record_ids.append(record_id)
+                    for value in existing.values:
+                        if (
+                            existing.name == record['host']
+                            and value.flags == record['caa_flag']
+                            and value.tag == record['caa_type']
+                            and value.value == record['caa_value']
+                        ):
+                            record_ids.append(record_id)
                 elif existing._type == 'MX' and record['type'] == 'MX':
-                    if (
-                        existing.name == record['host']
-                        and value.preference == int(record['priority'])
-                        and value.exchange == record['record']
-                    ):
-                        record_ids.append(record_id)
+                    for value in existing.values:
+                        if (
+                            existing.name == record['host']
+                            and value.preference == int(record['priority'])
+                            and value.exchange == record['record']
+                        ):
+                            record_ids.append(record_id)
                         
                 elif existing._type == 'LOC' and record['type'] == 'LOC':
+                    for value in existing.values:
+                        if (
+                            existing.name == record['host']
+                            and value.lat_degrees == record['lat_deg']
+                            and value.lat_minutes == record['lat_min']
+                            and value.lat_seconds == record['lat_sec']
+                            and value.lat_direction == record['lat_dir']
+                            and value.long_degrees == record['long_deg']
+                            and value.long_minutes == record['long_min']
+                            and value.long_seconds == record['long_sec']
+                            and value.long_direction == record['long_dir']
+                            and value.altitude == record['altitude']
+                            and value.size == record['size']
+                            and value.precision_horz == record['h_precision']
+                            and value.precision_vert == record['v_precision']
+                        ):
+                            record_ids.append(record_id)
+                elif existing._type == 'CNAME' and record['type'] == 'CNAME':
                     if (
-                        existing.name == record['host']
-                        and value.lat_degrees == record['lat_deg']
-                        and value.lat_minutes == record['lat_min']
-                        and value.lat_seconds == record['lat_sec']
-                        and value.lat_direction == record['lat_dir']
-                        and value.long_degrees == record['long_deg']
-                        and value.long_minutes == record['long_min']
-                        and value.long_seconds == record['long_sec']
-                        and value.long_direction == record['long_dir']
-                        and value.altitude == record['altitude']
-                        and value.size == record['size']
-                        and value.precision_horz == record['h_precision']
-                        and value.precision_vert == record['v_precision']
+                            existing.name == record['host']
+                            and existing._type == record['type']
+                            and existing.value == record['record']+'.'
                     ):
                         record_ids.append(record_id)
                 else:
                     if (record == 'Failed' or record == 'Missing domain-name'):
                         continue
-                    if (
-                        existing.name == record['host']
-                        and existing._type == record['type']
-                        and value == record['record']
-                    ):
-                        record_ids.append(record_id)
+                    
+                    if hasattr(existing, 'value'):
+                        if (
+                            existing.name == record['host']
+                            and existing._type == record['type']
+                            and existing.value == record['record']
+                        ):
+                            record_ids.append(record_id)
+                    elif hasattr(existing, 'values'):
+                        for value in existing.values:
+                            if (
+                                existing.name == record['host']
+                                and existing._type == record['type']
+                                and value == record['record']
+                            ):
+                                record_ids.append(record_id)
         return record_ids
 
 
@@ -660,27 +670,24 @@ class ClouDNSProvider(BaseProvider):
         desired = plan.desired
         
         changes = plan.changes
-        zone = desired.name[:-1]
+        zone_name = desired.name[:-1]
         self.log.debug("_apply: zone=%s, len(changes)=%d", desired.name, len(changes))
 
-        try:
-            self._client.zone(zone)
-        except ClouDNSClientNotFound:
-            self.log.info("_apply: no existing zone, trying to create it")
-            try:
-                self._client.zone_create(zone, 'master')
-                self.log.info("_apply: zone has been successfully created")
-            except ClouDNSClientNotFound:
-                e = ClouDNSClientUnknownDomainName(
-                    "Domain " + zone + " is not "
-                    "registered at ClouDNS. "
-                    "Please register or "
-                    "transfer it here "
-                    "to be able to manage its "
-                    "DNS zone."
-                )
-                e.__cause__ = None
-                raise e
+        # Does the zone actually exist?
+        zone = self._client.zone(zone_name)
+        if zone['status'] == 'Failed':
+            # All errors other than nonexistent zone.
+            if not zone['statusDescription'] == 'Missing domain-name':
+                raise ClouDNSClientException(zone)
+
+            # Check if subscription only allows GeoDNS zones.
+            geodns_only = self.isGeoDNS(zone['statusDescription'])
+
+            # Trying to create the zone.
+            zone = self._client.zone_create(zone_name, 'geodns' if geodns_only else 'master')
+            if zone['status'] == 'Failed':
+                raise ClouDNSClientException(zone)
+            self.log.info("_apply: zone has been successfully created")
 
         for change in changes:
             class_name = change.__class__.__name__

{octodns_cloudns-0.0.2.dist-info → octodns_cloudns-0.0.10.dist-info}/METADATA

@@ -1,28 +1,27 @@
 Metadata-Version: 2.1
 Name: octodns-cloudns
-Version: 0.0.2
+Version: 0.0.10
 Summary: ClouDNS API provider for octoDNS
 Home-page: https://github.com/octodns/octodns-cloudns
 Author: ClouDNS
 Author-email: support@cloudns.net
 License: MIT
-Platform: UNKNOWN
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: octodns (>=0.9.17)
-Requires-Dist: requests (>=2.27.0)
+Requires-Dist: octodns >=0.9.17
+Requires-Dist: requests >=2.27.0
 Provides-Extra: dev
-Requires-Dist: black (<24.0.0,>=23.1.0) ; extra == 'dev'
-Requires-Dist: build (>=0.7.0) ; extra == 'dev'
-Requires-Dist: isort (>=5.11.5) ; extra == 'dev'
-Requires-Dist: pyflakes (>=2.2.0) ; extra == 'dev'
 Requires-Dist: pytest ; extra == 'dev'
 Requires-Dist: pytest-cov ; extra == 'dev'
 Requires-Dist: pytest-network ; extra == 'dev'
-Requires-Dist: readme-renderer[md] (>=26.0) ; extra == 'dev'
 Requires-Dist: requests-mock ; extra == 'dev'
-Requires-Dist: twine (>=3.4.2) ; extra == 'dev'
+Requires-Dist: black <24.0.0,>=23.1.0 ; extra == 'dev'
+Requires-Dist: build >=0.7.0 ; extra == 'dev'
+Requires-Dist: isort >=5.11.5 ; extra == 'dev'
+Requires-Dist: pyflakes >=2.2.0 ; extra == 'dev'
+Requires-Dist: readme-renderer[md] >=26.0 ; extra == 'dev'
+Requires-Dist: twine >=3.4.2 ; extra == 'dev'
 Provides-Extra: test
 Requires-Dist: pytest ; extra == 'test'
 Requires-Dist: pytest-cov ; extra == 'test'
@@ -41,28 +40,30 @@ An [octoDNS](https://github.com/octodns/octodns/) provider that targets ClouDNS.
 pip install octodns-cloudns
 ```
 
-#### requirements.txt/setup.py
-
-Pinning specific versions or SHAs is recommended to avoid unplanned upgrades.
+### Configuration
 
-##### Versions
+For more safety, we recommend you to use an API sub-user with limited permissions.
+You can create it from [your ClouDNS account](https://www.cloudns.net/api-settings/)
+and store your credentials in environment variables:
 
-```
-# Start with the latest versions and don't just copy what's here
-octodns==0.9.14
-octodns-cloudns==0.0.1
+```bash
+export CLOUDNS_API_AUTH_ID=XXXXX
+export CLOUDNS_API_AUTH_PASSWORD=XXXXX
 ```
 
-### Configuration
+Then add your ClouDNS account to your octoDNS configuration file:
 
 ```yaml
 providers:
   cloudns_account:
-    class: octodns.provider.cloudns.ClouDNSProvider
-    auth_id: <api_auth_id>
-    auth_password: <api_auth_password>
+    class: octodns_cloudns.ClouDNSProvider
+    auth_id: env/CLOUDNS_API_AUTH_ID
+    auth_password: env/CLOUDNS_API_AUTH_PASSWORD
+    # "sub_auth" must be enabled if *only* you log in using a sub-user.
+    sub_auth: true
 ```
 
+
 ### Support Information
 
 #### GeoDNS records
@@ -80,5 +81,3 @@ ClouDNSProvider does not support dynamic records.
 ### Development
 
 See the [/script/](/script/) directory for some tools to help with the development process. They generally follow the [Script to rule them all](https://github.com/github/scripts-to-rule-them-all) pattern. Most useful is `./script/bootstrap` which will create a venv and install both the runtime and development related requirements. It will also hook up a pre-commit hook that covers most of what's run by CI.
-
-

octodns_cloudns-0.0.10.dist-info/RECORD

@@ -0,0 +1,6 @@
+octodns_cloudns/__init__.py,sha256=_cwQcvNvTYpMeqa13wQUE2xC95y1tdLKH1AAX_l1dRU,27446
+octodns_cloudns-0.0.10.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+octodns_cloudns-0.0.10.dist-info/METADATA,sha256=smGjGw4WnOxQPlfLFL8WcRbB21iU3qhPAS5d2YgQHOs,2625
+octodns_cloudns-0.0.10.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
+octodns_cloudns-0.0.10.dist-info/top_level.txt,sha256=t-gGz4zcl1yUE6hyw-aaR6KggpKY25v5xwsSJw-zBdY,16
+octodns_cloudns-0.0.10.dist-info/RECORD,,

{octodns_cloudns-0.0.2.dist-info → octodns_cloudns-0.0.10.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.37.1)
+Generator: setuptools (75.3.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

octodns_cloudns-0.0.2.dist-info/RECORD

@@ -1,6 +0,0 @@
-octodns_cloudns/__init__.py,sha256=9QvUJe860IqvMCsXRtGlc2QpNzWbSoOJRDzA3XbVIw4,26782
-octodns_cloudns-0.0.2.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-octodns_cloudns-0.0.2.dist-info/METADATA,sha256=tN1H4_8QZfF_r-gosJiibDCTq5LNmZQE-X_584aVZT0,2423
-octodns_cloudns-0.0.2.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
-octodns_cloudns-0.0.2.dist-info/top_level.txt,sha256=t-gGz4zcl1yUE6hyw-aaR6KggpKY25v5xwsSJw-zBdY,16
-octodns_cloudns-0.0.2.dist-info/RECORD,,