Merge branch 'dev'

Author: agrandiere

README.MD

@@ -30,19 +30,28 @@ Several moderation engines are available for you to choose from (nudity detectio
 
 ```python
 # Detect nudity in an image
-output = client.check('nudity').image('http://img09.deviantart.net/2bd0/i/2009/276/c/9/magic_forrest_wallpaper_by_goergen.jpg')
+output = client.check('nudity').set_url('http://img09.deviantart.net/2bd0/i/2009/276/c/9/magic_forrest_wallpaper_by_goergen.jpg')
 
 # Detect nudity, weapons, alcohol, drugs and faces in an image, along with image properties and type
-output = client.check('nudity', 'type', 'properties', 'wad', 'face').image('http://img09.deviantart.net/2bd0/i/2009/276/c/9/magic_forrest_wallpaper_by_goergen.jpg')
+output = client.check('nudity', 'type', 'properties', 'wad', 'face').set_url('http://img09.deviantart.net/2bd0/i/2009/276/c/9/magic_forrest_wallpaper_by_goergen.jpg')
 ```
 
 ## Moderate a local image:
 ```python
 # Detect nudity in an image
-output = client.check('nudity').image('/full/path/to/image.jpg')
+output = client.check('nudity').set_file('/full/path/to/image.jpg')
 
 # Detect nudity, weapons, alcohol, drugs and faces in an image, along with image properties and type
-output = client.check('nudity', 'type', 'properties', 'wad', 'face').image('/full/path/to/image.jpg')
+output = client.check('nudity', 'type', 'properties', 'wad', 'face').set_file('/full/path/to/image.jpg')
+```
+
+## Moderate a binary image:
+```python
+# Detect nudity in an image
+output = client.check('nudity').set_bytes(binary_image)
+
+# Detect nudity, weapons, alcohol, drugs and faces in an image, along with image properties and type
+output = client.check('nudity', 'type', 'properties', 'wad', 'face').set_bytes(binary_image)
 ```
 
 # Video and Stream Moderation
@@ -93,4 +102,3 @@ Example of feedback through a public URL::
 client.feedback("nudity","safe", "http://img09.deviantart.net/2bd0/i/2009/276/c/9/magic_forrest_wallpaper_by_goergen.jpg")
 client.feedback("type","illustration", "http://img09.deviantart.net/2bd0/i/2009/276/c/9/magic_forrest_wallpaper_by_goergen.jpg")
 client.feedback("nudity","raw", "http://img09.deviantart.net/2bd0/i/2009/276/c/9/magic_forrest_wallpaper_by_goergen.jpg")
-```

examples/all.py

@@ -6,8 +6,12 @@
 
 checkAll = client.check('nudity', 'wad', 'properties', 'face', 'type')
 
-output = checkAll.image('/path/to/local/file.jpg')
-output2 = checkAll.image('https://d3m9459r9kwism.cloudfront.net/img/examples/example7.jpg')
+output = checkAll.set_file('/path/to/local/file.jpg')
+output2 = checkAll.set_url('https://d3m9459r9kwism.cloudfront.net/img/examples/example7.jpg')
+
+# assign binary_image
+output3 = checkAll.set_bytes(binary_image)
 
 print(output)
 print(output2)
+print(output3)

examples/nudity.py

@@ -14,11 +14,15 @@
 
 checkNudity = client.check('nudity')
 
-output = checkNudity.image('/path/to/local/file.jpg')
-output2 = checkNudity.image('https://d3m9459r9kwism.cloudfront.net/img/examples/example5.jpg')
+output = checkNudity.set_file('/path/to/local/file.jpg')
+output2 = checkNudity.set_url('https://d3m9459r9kwism.cloudfront.net/img/examples/example5.jpg')
+
+# assign binary_image
+output3 = checkNudity.set_bytes(binary_image)
 
 print(output)
 print(output2)
+print(output3)
 
 ####### check video
 

sightengine/check.py

@@ -37,7 +37,7 @@ class Check(object):
     def __init__(self, api_user, api_secret, *args):
         self.api_user = api_user
         self.api_secret = api_secret
-        self.endpoint = 'https://api.sightengine.com/'
+        self.endpoint = 'https://api.sightengine.com/1.0/'
         self.modelsType = ''
 
         if len(args) > 1:
@@ -47,36 +47,26 @@ def __init__(self, api_user, api_secret, *args):
         else:
             self.modelsType = args[0]
 
-    def image(self, image):
-        numberOfModels = self.modelsType.count(",")
+    def set_url(self, imageUrl):
+        r = requests.get(self.endpoint + 'check.json', params={'models': self.modelsType, 'url': imageUrl, 'api_user': self.api_user, 'api_secret': self.api_secret}, headers=headers)
 
-        if numberOfModels > 0:
-            url = self.endpoint + '1.0/check.json'
+        output = json.loads(r.text)
+        return output
 
-            if isinstance(image, bytes):
-                r = requests.post(url, files={'media': BytesIO(image)}, data={'models': self.modelsType,'api_user': self.api_user, 'api_secret': self.api_secret},  headers=headers)
-            elif image.lower().startswith(('http://', 'https://')):
-                r = requests.get(url, params={'models': self.modelsType, 'url': image, 'api_user': self.api_user, 'api_secret': self.api_secret},  headers=headers)
-            else:
-                r = requests.post(url, files={'media': open(image, 'rb')}, data={'models': self.modelsType,'api_user': self.api_user, 'api_secret': self.api_secret},  headers=headers)
+    def set_file(self, file):
+        r = requests.post(self.endpoint + 'check.json', files={'media': open(file, 'rb')}, data={'models': self.modelsType, 'api_user': self.api_user,'api_secret': self.api_secret}, headers=headers)
 
-            output = json.loads(r.text)
-            return output
-        else:
-            url = self.endpoint + '1.0' + '/' + self.modelsType + '.json'
+        output = json.loads(r.text)
+        return output
 
-            if isinstance(image, bytes):
-                r = requests.post(url, files={'media': BytesIO(image)}, data={'api_user': self.api_user,'api_secret': self.api_secret},  headers=headers)
-            elif image.lower().startswith(('http://', 'https://')):
-                r = requests.get(url, params={'url': image, 'api_user': self.api_user, 'api_secret': self.api_secret},  headers=headers)
-            else:
-                r = requests.post(url, files={'media': open(image, 'rb')}, data={'api_user': self.api_user,'api_secret': self.api_secret},  headers=headers)
+    def set_bytes(self, binaryImage):
+        r = requests.post(self.endpoint + 'check.json', files={'media': BytesIO(binaryImage)}, data={'models': self.modelsType, 'api_user': self.api_user, 'api_secret': self.api_secret}, headers=headers)
 
-            output = json.loads(r.text)
-            return output
+        output = json.loads(r.text)
+        return output
 
     def video(self, videoUrl, callbackUrl):
-        url =  self.endpoint + '1.0/video/moderation.json?stream_url=' + videoUrl + '&callback_url=' + callbackUrl + '&api_user=' + self.api_user + '&api_secret=' + self.api_secret
+        url =  self.endpoint + 'video/moderation.json?stream_url=' + videoUrl + '&callback_url=' + callbackUrl + '&api_user=' + self.api_user + '&api_secret=' + self.api_secret
         r = requests.get(url,  headers=headers)
 
         output = json.loads(r.text)

tests.py

@@ -6,36 +6,36 @@ def test_nudityModel(self):
         client = SightengineClient('1234', 'test')
         checkNudity = client.check('nudity')
 
-        output = checkNudity.image('https://sightengine.com/assets/img/examples/example5.jpg')
-        self.assertEqual('success', output['status'])
-
         image = os.path.join(os.path.dirname(__file__), 'assets', 'image.jpg')
 
-        output2 = checkNudity.image(image)
+        output = checkNudity.set_url('https://sightengine.com/assets/img/examples/example5.jpg')
+        self.assertEqual('success', output['status'])
+
+        output2 = checkNudity.set_file(image)
         self.assertEqual('success', output2['status'])
 
         with open(image, mode='rb') as img:
-            imageContent = img.read()
+            binary_image = img.read()
 
-        output3 = checkNudity.image(imageContent)
+        output3 = checkNudity.set_bytes(binary_image)
         self.assertEqual('success', output3['status'])
 
     def test_allModel(self):
         client = SightengineClient('1234', 'test')
         checkAll = client.check('nudity','wad','properties','type','face','celebrities')
 
-        output = checkAll.image('https://sightengine.com/assets/img/examples/example5.jpg')
-        self.assertEqual('success', output['status'])
-
         image = os.path.join(os.path.dirname(__file__), 'assets', 'image.jpg')
 
-        output2 = checkAll.image(image)
+        output = checkAll.set_url('https://sightengine.com/assets/img/examples/example5.jpg')
+        self.assertEqual('success', output['status'])
+
+        output2 = checkAll.set_file(image)
         self.assertEqual('success', output2['status'])
 
         with open(image, mode='rb') as img:
-            imageContent = img.read()
+            binary_image = img.read()
 
-        output3 = checkAll.image(imageContent)
+        output3 = checkAll.set_bytes(binary_image)
         self.assertEqual('success', output3['status'])
 
     def test_feedback(self):