Release v1.5.0

XolphinIvo · XolphinIvo · commit a18563099bee · 2017-03-09T14:29:14.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,5 @@
-.idea
-xolphin-api-python.iml
-test.py
-*.pyc
-dist
-xolphin_api.egg-info
+build/
+dist/
+xolphin_api.egg-info/
+.idea/
+*.py~
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,13 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+## [1.5.0] - 2017-03-09
+### Added
+- Compatability with Xolphin REST Api v1.5.0
+- Request Notes: You are able to get all and send your own request notes
+- Certificate Requests: If there are open request notes for the customer, a new field 'requiresAction' will be set in the CertificateRequest object
+- Certificate Requests: You can now send a language parameter with the request, which will be used for (eg) the Subscriber Agreement
+- Certificate Requests: A new field 'brandValidation' is added, which is used to indicate if the request is being held for review due to specific brand names
+
+### Fixed
+- Ability to upload files
diff --git a/README.rst b/README.rst
@@ -81,6 +81,32 @@ Request certificate
     request = client.request().send(ccr)
     print(request.id)
 
+Create a note
+~~~~~~~~~~~~~
+
+.. code:: python
+
+    result = client.request().send_note(1234, 'My message')
+    print(result.message);
+
+Get list of notes
+~~~~~~~~~~~~~~~~~
+
+.. code:: python
+
+    result = client.request().get_notes(1234)
+    for note in result:
+        print(note.messageBody);
+
+Send a "Comodo Subscriber Agreement" email
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code:: python
+
+    //currently available languages: en, de, fr, nl
+    result = client.request().send_ComodoSA(124, 'test@example.com')
+    print(result.message);
+
 Certificate
 ~~~~~~~~~~~
 
diff --git a/readme.md b/readme.md
@@ -47,14 +47,14 @@ for request in requests:
     print(request.id, request.product.id)
 ```
 
-### Getting request by ID
+#### Getting request by ID
 
 ```python
 request = client.request().get(961992637)
 print(request.product.brand)
 ```
 
-### Request certificate
+#### Request certificate
 
 ```python
 ccr = client.request().create(24, 1, 'csr string', 'EMAIL')
@@ -66,6 +66,8 @@ ccr.approver_email = 'email@domain.com'
 ccr.zipcode = '123456'
 ccr.city = 'City'
 ccr.company = 'Company'
+# currently available languages: en, de, fr, nl
+ccr.language = 'en'
 ccr.subject_alternative_names.append('test1.domain.com')
 ccr.subject_alternative_names.append('test2.domain.com')
 ccr.dcv.append({
@@ -78,6 +80,31 @@ request = client.request().send(ccr)
 print(request.id)
 ```
 
+#### Create a note
+
+```python
+result = client.request().send_note(1234, 'My message')
+print(result.message);
+```
+
+#### Get list of notes
+
+```python
+result = client.request().get_notes(1234)
+
+for note in result:
+    print(note.messageBody);
+```
+
+#### Send a "Comodo Subscriber Agreement" email
+
+```python
+//currently available languages: en, de, fr, nl
+result = client.request().send_ComodoSA(124, 'test@example.com')
+print(result.message);
+```
+
+
 ### Certificate
 
 #### Certificates list and expirations
diff --git a/setup.py b/setup.py
@@ -12,7 +12,7 @@ def read(*paths):
 
 setup(
         name='xolphin-api',
-        version='1.1.0',
+        version='1.5.0',
         author='Xolphin',
         author_email='info@xolphin.com',
         license='MIT',
diff --git a/xolphin/__init__.py b/xolphin/__init__.py
@@ -4,7 +4,7 @@
 from __future__ import absolute_import
 
 __author__ = 'Xolphin'
-__version__ = '1.0.0'
+__version__ = '1.5.0'
 
 from .client import Client
 #from .errors import TwinglyException
@@ -14,4 +14,4 @@
 #from .parser import Parser
 #from .post import Post
 #from .query import Query
-#from .result import Result
+#from .result import Result
diff --git a/xolphin/certificate_requests/create_certificate_request.py b/xolphin/certificate_requests/create_certificate_request.py
@@ -20,6 +20,7 @@ def __init__(self, product, years, csr, dcv_type):
         self.approver_phone = ''
         self.kvk = ''
         self.reference = ''
+        self.language = ''
 
     def toDict(self):
         result = {
@@ -43,5 +44,6 @@ def toDict(self):
         if self.approver_phone != '': result['approverPhone'] = self.approver_phone
         if self.kvk != '': result['kvk'] = self.kvk
         if self.reference != '': result['reference'] = self.reference
+        if self.language != '': result['language'] = self.language
         
         return result
diff --git a/xolphin/certificate_requests/reissue_certificate_request.py b/xolphin/certificate_requests/reissue_certificate_request.py
@@ -18,6 +18,7 @@ def __init__(self, csr, dcv_type):
         self.approver_phone = ''
         self.kvk = ''
         self.reference = ''
+        self.language = ''
 
     def toDict(self):
         result = {
@@ -39,5 +40,6 @@ def toDict(self):
         if self.approver_phone != '': result['approverPhone'] = self.approver_phone
         if self.kvk != '': result['kvk'] = self.kvk
         if self.reference != '': result['reference'] = self.reference
+        if self.language != '': result['language'] = self.language
         
         return result
diff --git a/xolphin/certificate_requests/renew_certificate_request.py b/xolphin/certificate_requests/renew_certificate_request.py
@@ -20,6 +20,7 @@ def __init__(self, product, years, csr, dcv_type):
         self.approver_phone = ''
         self.kvk = ''
         self.reference = ''
+        self.language = ''
 
     def toDict(self):
         result = {
@@ -43,5 +44,6 @@ def toDict(self):
         if self.approver_phone != '': result['approverPhone'] = self.approver_phone
         if self.kvk != '': result['kvk'] = self.kvk
         if self.reference != '': result['reference'] = self.reference
+        if self.language != '': result['language'] = self.language
         
         return result
diff --git a/xolphin/client.py b/xolphin/client.py
@@ -18,9 +18,16 @@
 
 class Client(object):
     BASE_URL = 'https://api.xolphin.com/v1/'
-    VERSION = '1.1'
+    BASE_URL_TEST = 'https://test-api.xolphin.com/v1/'
+    VERSION = '1.5.0'
+
+    def __init__(self, username, password, test = False):
+        
+        if(test):
+            self.url = self.BASE_URL_TEST
+        else:
+            self.url = self.BASE_URL
 
-    def __init__(self, username, password):
         self.username = username
         self.password = password
 
@@ -34,14 +41,14 @@ def __init__(self, username, password):
         #self._session.verify = False
 
     def get(self, method, data={}):
-        response = self._session.get("%s%s" % (Client.BASE_URL, method), params=data)
+        response = self._session.get("%s%s" % (self.url, method), params=data)
         if 200 <= response.status_code < 300:
             return json.loads(response.content.decode('utf-8'))
         else:
             raise Exception(response.content)
 
     def download(self, method, data={}):
-        response = self._session.get("%s%s" % (Client.BASE_URL, method), params=data)
+        response = self._session.get("%s%s" % (self.url, method), params=data)
         if 200 <= response.status_code < 300:
             return response
         else:
@@ -51,10 +58,10 @@ def post(self, method, data={}):
         payload = {}
         for k in data:
             if k == 'document':
-                payload[k] = ('document.pdf', str(data[k]), 'application/pdf')
+                payload[k] = (data['description'], data[k], 'application/pdf')
             else:
                 payload[k] = (None, str(data[k]))
-        response = self._session.post("%s%s" % (Client.BASE_URL, method), files=payload)
+        response = self._session.post("%s%s" % (self.url, method), files=payload)
         if 200 <= response.status_code < 300:
             return json.loads(response.content.decode('utf-8'))
         else:
diff --git a/xolphin/endpoint/request.py b/xolphin/endpoint/request.py
@@ -2,6 +2,7 @@
 from xolphin.responses.base import Base
 from xolphin.responses.requests import Requests
 from xolphin.responses.request import Request as Req
+from xolphin.responses.notes import Notes
 
 
 class Request(object):
@@ -44,7 +45,7 @@ def retry_dcv(self, id, domain, dcv_type, email=''):
             'email': email
         }))
 
-    def send_subscriber_agreement(self, id, email, language='nl'):
+    def send_subscriber_agreement(self, id, email, language = ""):
         return Base(self.client.post('requests/%d/sa' % id, {
             'email': email,
             'language': language
@@ -55,3 +56,23 @@ def schedule_validation_call(self, id, date_time):
             'date': date_time.strftime('%Y-%m-%d'),
             'time': date_time.strftime('%H:%M')
         }))
+
+    def send_note(self, id, message):
+        return Base(self.client.post('requests/%d/notes' % id, {
+            'message': message
+        }))
+
+    def get_notes(self, id):
+        notes = []
+
+        result = Notes(self.client.get('requests/%d/notes' % id))
+        if not result.is_error():
+            notes = result.notes
+        
+        return notes
+
+    def send_ComodoSA(self, id, to, language = ""):
+        return Base(self.client.post('requests/%d/sa' % id, {
+            'sa_email': to,
+            'language': language,
+        }))
diff --git a/xolphin/responses/note.py b/xolphin/responses/note.py
@@ -0,0 +1,13 @@
+from xolphin.responses.base import Base
+
+class Note(Base):
+    def __init__(self, data):
+        super(Note, self).__init__(data)
+
+        if not self.is_error():
+            if 'contact' in data: self.contact = data['contact']
+            if 'staff' in data: self.staff = data['staff']
+            if 'date' in data: self.date = data['date']
+            if 'time' in data: self.time = data['time']
+            if 'message' in data: self.messageBody = data['message']
+            if 'createdAt' in data: self.createdAt = data['createdAt']
diff --git a/xolphin/responses/notes.py b/xolphin/responses/notes.py
@@ -0,0 +1,12 @@
+from xolphin.responses.base import Base
+from xolphin.responses.note import Note
+
+
+class Notes(Base):
+    def __init__(self, data):
+        super(Notes, self).__init__(data)
+
+        if not self.is_error():
+            self.notes = []
+            for note in self._embedded['notes']:
+                self.notes.append(Note(note))
diff --git a/xolphin/responses/request.py b/xolphin/responses/request.py
@@ -25,6 +25,8 @@ def __init__(self, data):
             if 'approverLastName' in data: self.approver_last_name = data['approverLastName']
             if 'approverEmail' in data: self.approver_email = data['approverEmail']
             if 'approverPhone' in data: self.approver_phone = data['approverPhone']
+            if 'requiresAction' in data: self.requiresAction = data['requiresAction']
+            if 'brandValidation' in data: self.brandValidation = data['brandValidation']
             if 'kvk' in data: self.kvk = data['kvk']
 
             if 'validations' in data:
@@ -34,4 +36,4 @@ def __init__(self, data):
                     self.validations[k] = RequestValidation(data['validations'][k])
 
             if ('_embedded' in data) and ('product' in data['_embedded']):
-                self.product = Product(data['_embedded']['product'])
+                self.product = Product(data['_embedded']['product'])
diff --git a/xolphin/responses/request_validation_domain.py b/xolphin/responses/request_validation_domain.py
@@ -5,4 +5,6 @@ def __init__(self, data):
         if 'dcvEmail' in data: self.dcv_email = data['dcvEmail']
         if 'status' in data: self.status = data['status']
         if 'statusDetail' in data: self.status_detail = data['statusDetail']
-        if 'statusMessage' in data: self.status_message = data['statusMessage']
+        if 'statusMessage' in data: self.status_message = data['statusMessage']
+        if 'md5' in data: self.md5 = data['md5']
+        if 'sha1' in data: self.sha1 = data['sha1']
