tinify 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b620618c58618a929492dfc67176be15e5aa9aac7b9f751ac242595559918f1
-  data.tar.gz: 51e65f1a4bdd85333466f8cc45eb59a6bbbe376722fef3d0381e82958ce84333
+  metadata.gz: 8ef479bb3aaa044249d97b2ceef7a20617451d07c66c6ffd7d37de60ccd98c83
+  data.tar.gz: 5b230b0036f3b1c0afa091b07b0e09afc6374fd017310627cc723dc709bb3764
 SHA512:
-  metadata.gz: fa09aa50924772c6fe5c01e354270be10d4e1812ed4ab31d7c8db83d05a267f952d701d1c7321f9f70ce194e53be72c1a3495f4ff874810e5c754bfc6a8e78de
-  data.tar.gz: c77d6ab6fd5202f92432cc45d1dd6adb0cc683775a65280fd18ed463eb28d1f30111d3909ff6ce6cc533d2fcde4e3ad461f0b9dac3db2d164aa307b897e975f7
+  metadata.gz: 9f0ab7bf57e13b1b21e10613d61ffcb46fb89daa0bd0578646afe1bbc3a292ccc6283d81064625221a79b8a0e589f63c4e4d2352565caaee27d06c4c86fe9e0a
+  data.tar.gz: 1a4e19479aa751eecf943bdb4281832d8814234d00918cff3719236594f0cf6efd19beb496db637a3793c4b460e9428ac388e2c67ed957d7f45dc2ef2d2c9da6

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.9.0
+
+* Added `Tinify::Format` constants for the media types `convert` accepts, including JPEG XL (`image/jxl`).
+
 ## 1.8.0
 
 * Update development dependencies.

data/Gemfile.lock

@@ -1,31 +1,33 @@
 PATH
   remote: .
   specs:
-    tinify (1.8.0)
+    tinify (1.9.0)
       httpclient (>= 2.9, < 3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.8)
+    addressable (2.9.0)
       public_suffix (>= 2.0.2, < 8.0)
     base64 (0.3.0)
-    bigdecimal (4.0.1)
-    bigdecimal (4.0.1-java)
+    bigdecimal (4.1.2)
+    bigdecimal (4.1.2-java)
     crack (1.0.1)
       bigdecimal
       rexml
+    drb (2.2.3)
     hashdiff (1.2.1)
     httpclient (2.9.0)
       mutex_m
-    minitest (6.0.1)
+    minitest (6.0.5)
+      drb (~> 2.0)
       prism (~> 1.5)
     mutex_m (0.3.0)
-    prism (1.8.0)
-    public_suffix (7.0.2)
-    rake (13.3.1)
+    prism (1.9.0)
+    public_suffix (7.0.5)
+    rake (13.4.2)
     rexml (3.4.4)
-    webmock (3.26.1)
+    webmock (3.26.2)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)

data/README.md

@@ -33,6 +33,27 @@ Tinify.key = "YOUR_API_KEY"
 Tinify.from_file("unoptimized.png").to_file("optimized.png")
 ```
 
+Convert to another format with the `Tinify::Format` constants (`WEBP`, `PNG`,
+`JPEG`, `JPG`, `AVIF`, `JXL` and `ANY`):
+
+```ruby
+Tinify.from_file("unoptimized.png")
+  .convert(type: Tinify::Format::JXL)
+  .to_file("optimized.jxl")
+```
+
+Pass several and the API returns the smallest result:
+
+```ruby
+result = Tinify.from_file("unoptimized.png")
+  .convert(type: [Tinify::Format::JXL, Tinify::Format::WEBP])
+  .result
+
+result.to_file("optimized.#{result.extension}")
+```
+
+The constants are plain strings, so `type: "image/jxl"` keeps working.
+
 ## Running tests
 
 ```

data/lib/tinify/format.rb

@@ -0,0 +1,39 @@
+module Tinify
+  # Media types that images can be converted to.
+  #
+  # Use these constants with Source#convert:
+  #
+  #   Tinify.from_file("input.png")
+  #     .convert(type: Tinify::Format::JXL)
+  #     .to_file("output.jxl")
+  #
+  # Multiple types may be supplied, in which case the API returns the smallest
+  # result:
+  #
+  #   convert(type: [Tinify::Format::JXL, Tinify::Format::WEBP])
+  module Format
+    # WebP.
+    WEBP = "image/webp".freeze
+
+    # PNG.
+    PNG = "image/png".freeze
+
+    # JPEG.
+    JPEG = "image/jpeg".freeze
+
+    # JPEG, under the alternative image/jpg media type the API also accepts.
+    # The API normalises this to image/jpeg, so the result is identical to
+    # JPEG. The two constants hold different strings but select the same
+    # format.
+    JPG = "image/jpg".freeze
+
+    # AVIF.
+    AVIF = "image/avif".freeze
+
+    # JPEG XL.
+    JXL = "image/jxl".freeze
+
+    # Wildcard, returns the smallest of the supported types.
+    ANY = "*/*".freeze
+  end
+end

data/lib/tinify/version.rb

@@ -1,3 +1,3 @@
 module Tinify
-  VERSION = "1.8.0"
+  VERSION = "1.9.0"
 end

data/lib/tinify.rb

@@ -1,5 +1,6 @@
 require "tinify/version"
 require "tinify/error"
+require "tinify/format"
 
 require "tinify/client"
 require "tinify/result_meta"

data/test/tinify_format_test.rb

@@ -0,0 +1,56 @@
+require File.expand_path("../helper", __FILE__)
+
+describe Tinify::Format do
+  describe "constants" do
+    it "should expose the supported media types" do
+      assert_equal "image/webp", Tinify::Format::WEBP
+      assert_equal "image/png", Tinify::Format::PNG
+      assert_equal "image/jpeg", Tinify::Format::JPEG
+      assert_equal "image/jpg", Tinify::Format::JPG
+      assert_equal "image/avif", Tinify::Format::AVIF
+      assert_equal "image/jxl", Tinify::Format::JXL
+      assert_equal "*/*", Tinify::Format::ANY
+    end
+  end
+
+  describe "convert" do
+    before do
+      Tinify.key = "valid"
+
+      stub_request(:post, "https://api.tinify.com/shrink")
+        .with(basic_auth: ['api', 'valid'])
+        .to_return(
+          status: 201,
+          headers: { Location: "https://api.tinify.com/some/location" },
+          body: '{}')
+    end
+
+    it "should serialize a single format" do
+      stub_request(:post, "https://api.tinify.com/some/location")
+        .with(
+          basic_auth: ['api', 'valid'],
+          body: '{"convert":{"type":"image/jxl"}}')
+        .to_return(
+          status: 200,
+          body: "converted file")
+
+      source = Tinify::Source.from_buffer("png file")
+        .convert(type: Tinify::Format::JXL)
+      assert_equal "converted file", source.to_buffer
+    end
+
+    it "should serialize multiple formats" do
+      stub_request(:post, "https://api.tinify.com/some/location")
+        .with(
+          basic_auth: ['api', 'valid'],
+          body: '{"convert":{"type":["image/jxl","image/webp"]}}')
+        .to_return(
+          status: 200,
+          body: "converted file")
+
+      source = Tinify::Source.from_buffer("png file")
+        .convert(type: [Tinify::Format::JXL, Tinify::Format::WEBP])
+      assert_equal "converted file", source.to_buffer
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tinify
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Rolf Timmermans
@@ -51,6 +51,7 @@ files:
 - lib/tinify.rb
 - lib/tinify/client.rb
 - lib/tinify/error.rb
+- lib/tinify/format.rb
 - lib/tinify/result.rb
 - lib/tinify/result_meta.rb
 - lib/tinify/source.rb
@@ -60,6 +61,7 @@ files:
 - test/helper.rb
 - test/integration.rb
 - test/tinify_client_test.rb
+- test/tinify_format_test.rb
 - test/tinify_result_meta_test.rb
 - test/tinify_result_test.rb
 - test/tinify_source_test.rb
@@ -84,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Ruby client for the Tinify API.
 test_files:
@@ -93,6 +95,7 @@ test_files:
 - test/helper.rb
 - test/integration.rb
 - test/tinify_client_test.rb
+- test/tinify_format_test.rb
 - test/tinify_result_meta_test.rb
 - test/tinify_result_test.rb
 - test/tinify_source_test.rb