Merge pull request #20 from rkoopmans/transcoding

Add convert / transcoding of images

Author: rkoopmans

.gitignore

@@ -2,4 +2,5 @@
 __pycache__/
 build/
 dist/
-*.egg-info/
+*.egg-info/
+.tox

CHANGES.md

@@ -1,3 +1,15 @@
+## 1.6.0
+* Updated runtime support
+    * Dropped 2.6
+    * Added python 3.7
+    * Added python 3.8
+    * Added python 3.9
+    * Added python 3.10
+    * Added python 3.11
+* Fixed tests on windows
+* Add methods for the transcoding and transformation API
+* Add a method for getting the file extension from a Result object
+
 ## 1.5.2
 Remove letsencrypt DST Root from ca bundle for openssl 1.0.0 compatibility
 

test/integration.py

@@ -82,4 +82,13 @@ def test_should_preserve_metadata(self):
 
             # width == 137
             self.assertIn(b'\x00\x00\x00\x89', contents)
-            self.assertIn(b'Copyright Voormedia', contents)
+            self.assertIn(b'Copyright Voormedia', contents)
+
+    def test_should_transcode_image(self):
+        with create_named_tmpfile() as tmp:
+            a = self.optimized.convert(type=["image/webp"]).to_file(tmp)
+            with open(tmp, 'rb') as f:
+                content = f.read()
+
+            self.assertEqual(b'RIFF', content[:4])
+            self.assertEqual(b'WEBP', content[8:12])

test/tinify_result_test.py

@@ -35,6 +35,11 @@ def test_content_type_should_return_mime_type(self):
     def test_to_buffer_should_return_image_data(self):
         self.assertEqual(b'image data', self.result.to_buffer())
 
+    def test_extension(self):
+        self.assertEqual('png', self.result.extension)
+
+
+
 class TinifyResultWithoutMetaAndDataTest(TestHelper):
     def setUp(self):
         self.result = Result({}, None)
@@ -59,3 +64,6 @@ def test_content_type_should_return_none(self):
 
     def test_to_buffer_should_return_none(self):
         self.assertEqual(None, self.result.to_buffer())
+
+    def test_extension(self):
+        self.assertEqual(None, self.result.extension)

test/tinify_source_test.py

@@ -10,6 +10,7 @@
 
 from helper import *
 
+
 class TinifySourceWithInvalidApiKey(TestHelper):
     def setUp(self):
         super(type(self), self).setUp()
@@ -55,6 +56,10 @@ def return_file(request, uri, headers):
             response = b'copyrighted file'
         elif 'resize' in data:
             response = b'small file'
+        elif 'convert' in data:
+            response = b'converted file'
+        elif 'transform' in data:
+            response = b'transformed file'
         else:
             response = b'compressed file'
         return (200, headers, response)
@@ -124,6 +129,22 @@ def test_resize_should_return_source_with_data(self):
         self.assertEqual(b'small file', Source.from_buffer('png file').resize(width=400).to_buffer())
         self.assertJsonEqual('{"resize":{"width":400}}', httpretty.last_request().body.decode('utf-8'))
 
+    def test_transform_should_return_source(self):
+        self.assertIsInstance(Source.from_buffer('png file').transform(background='black'), Source)
+        self.assertEqual(b'png file', httpretty.last_request().body)
+
+    def test_transform_should_return_source_with_data(self):
+        self.assertEqual(b'transformed file', Source.from_buffer('png file').transform(background='black').to_buffer())
+        self.assertJsonEqual('{"transform":{"background":"black"}}', httpretty.last_request().body.decode('utf-8'))
+
+    def test_convert_should_return_source(self):
+        self.assertIsInstance(Source.from_buffer('png file').resize(width=400).convert(type=['image/webp']), Source)
+        self.assertEqual(b'png file', httpretty.last_request().body)
+
+    def test_convert_should_return_source_with_data(self):
+        self.assertEqual(b'converted file', Source.from_buffer('png file').convert(type='image/jpg').to_buffer())
+        self.assertJsonEqual('{"convert": {"type": "image/jpg"}}', httpretty.last_request().body.decode('utf-8'))
+
     def test_store_should_return_result_meta(self):
         self.assertIsInstance(Source.from_buffer('png file').store(service='s3'), ResultMeta)
         self.assertJsonEqual('{"store":{"service":"s3"}}', httpretty.last_request().body.decode('utf-8'))
@@ -150,4 +171,14 @@ def test_to_file_with_file_object_should_store_image_data(self):
         with create_named_tmpfile() as name:
             Source.from_buffer('png file').to_file(name)
             with open(name, 'rb') as f:
-                self.assertEqual(b'compressed file', f.read())
+                self.assertEqual(b'compressed file', f.read())
+
+    def test_all_options_together(self):
+        self.assertEqual('https://bucket.s3-region.amazonaws.com/some/location',
+                         Source.from_buffer('png file').resize(width=400)\
+                                                       .convert(type=['image/webp', 'image/png'])\
+                                                       .transform(background="black")\
+                                                       .preserve("copyright", "location")\
+                                                       .store(service='s3').location)
+        self.assertJsonEqual('{"store":{"service":"s3"},"resize":{"width":400},"preserve": ["copyright", "location"], "transform": {"background": "black"}, "convert": {"type": ["image/webp", "image/png"]}}', httpretty.last_request().body.decode('utf-8'))
+

tinify/result.py

@@ -27,6 +27,12 @@ def size(self):
     def media_type(self):
         return self._meta.get('Content-Type')
 
+    @property
+    def extension(self):
+        media_type = self._meta.get('Content-Type')
+        if media_type:
+            return media_type.split('/')[-1]
+
     @property
     def content_type(self):
         return self.media_type

tinify/source.py

@@ -36,6 +36,12 @@ def preserve(self, *options):
     def resize(self, **options):
         return type(self)(self.url, **self._merge_commands(resize=options))
 
+    def convert(self, **options):
+        return type(self)(self.url, **self._merge_commands(convert=options))
+
+    def transform(self, **options):
+        return type(self)(self.url, **self._merge_commands(transform=options))
+
     def store(self, **options):
         response = tinify.get_client().request('POST', self.url, self._merge_commands(store=options))
         return ResultMeta(response.headers)

tinify/version.py

@@ -1 +1 @@
-__version__ = '1.5.2'
+__version__ = '1.6.0'