octodns-cloudns 0.0.7__tar.gz → 0.0.9__tar.gz

{octodns_cloudns-0.0.7 → octodns_cloudns-0.0.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: octodns-cloudns
-Version: 0.0.7
+Version: 0.0.9
 Summary:  ClouDNS API provider for octoDNS
 Home-page: https://github.com/octodns/octodns-cloudns
 Author: ClouDNS
@@ -40,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

{octodns_cloudns-0.0.7 → octodns_cloudns-0.0.9}/README.md

@@ -10,28 +10,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

{octodns_cloudns-0.0.7 → octodns_cloudns-0.0.9}/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.7'
+__version__ = __VERSION__ = '0.0.9'
 
 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):
@@ -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 = {}
 
@@ -371,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"]
             
@@ -412,7 +396,7 @@ class ClouDNSProvider(BaseProvider):
                 )
                 zone.add_record(record, lenient=lenient)
         exists = zone.name in self._zone_records
-        print(
+        self.log.debug(
             "populate:   found %s records, exists=%s",
             len(zone.records) - before,
             exists,
@@ -679,27 +663,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.7 → octodns_cloudns-0.0.9}/octodns_cloudns.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: octodns-cloudns
-Version: 0.0.7
+Version: 0.0.9
 Summary:  ClouDNS API provider for octoDNS
 Home-page: https://github.com/octodns/octodns-cloudns
 Author: ClouDNS
@@ -40,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