tinify 1.7.1 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af537d83d7cd098489a231282b5e847fa63537aa116d9489897906cccf54d4d3
-  data.tar.gz: 017bd7ce4f73aac4d6042481ef126d3a7fed319ba67da35ff6e7671705f50a03
+  metadata.gz: 8ef479bb3aaa044249d97b2ceef7a20617451d07c66c6ffd7d37de60ccd98c83
+  data.tar.gz: 5b230b0036f3b1c0afa091b07b0e09afc6374fd017310627cc723dc709bb3764
 SHA512:
-  metadata.gz: 9bc3ab091b52286e90bd0af83aed1fadc868642fbbfd1297e477f977ab97f8ffa06dd12bd9c8dd2007efcea2d216500e6fe486693cd2ae6220783b80a99f8256
-  data.tar.gz: c140345d128d4317d4d653af7008e71972a82b2e30c06aab93f10e6662bacfcb4fdf11bddac60ece01e76eac7b4c53aeed1cef9285968bd083917c93f0764784
+  metadata.gz: 9f0ab7bf57e13b1b21e10613d61ffcb46fb89daa0bd0578646afe1bbc3a292ccc6283d81064625221a79b8a0e589f63c4e4d2352565caaee27d06c4c86fe9e0a
+  data.tar.gz: 1a4e19479aa751eecf943bdb4281832d8814234d00918cff3719236594f0cf6efd19beb496db637a3793c4b460e9428ac388e2c67ed957d7f45dc2ef2d2c9da6

data/.github/workflows/ci-cd.yaml

@@ -11,7 +11,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby-version: ['3.1', '3.2', '3.3', '3.4', 'jruby']
+        ruby-version: ['3.2', '3.3', '3.4', '4.0', 'jruby']
         os: [ubuntu-latest, macOS-latest, windows-latest]
         # experimental: [false]
         include:
@@ -27,7 +27,7 @@ jobs:
             os: ubuntu-latest
             experimental: false
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
 
     - name: Set up ruby ${{ matrix.ruby-version }}
       uses: ruby/setup-ruby@v1
@@ -49,9 +49,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby-version: [
-          "3.1", "3.4"
-        ]
+        ruby-version: ['3.2', '3.3', '3.4', '4.0', 'jruby']
         os: [
           ubuntu-latest,
           macOS-latest,
@@ -59,7 +57,7 @@ jobs:
           # windows-latest
         ]
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
     - name: Set up ruby ${{ matrix.ruby-version }}
       uses: ruby/setup-ruby@v1
       with:
@@ -82,11 +80,11 @@ jobs:
     needs: [Unit_tests, Integration_tests]
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - name: Set up Ruby 3.4
+      - uses: actions/checkout@v5
+      - name: Setup Ruby 4.0
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.4
+          ruby-version: 4.0
       - name: Check if properly tagged
         run: |
           PACKAGE_VERSION="$(ruby -e 'puts Gem::Specification::load("tinify.gemspec").version')";

data/.ruby-version

@@ -0,0 +1 @@
+4.0.1

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 1.9.0
+
+* Added `Tinify::Format` constants for the media types `convert` accepts, including JPEG XL (`image/jxl`).
+
+## 1.8.0
+
+* Update development dependencies.
+
+Extend runtime support for:
+
+* Ruby 4.0
+
+Remove runtime support for:
+
+* Ruby 3.1
+
 ## 1.7.1
 * Update `rexml` because of `CVE-2025-58767`.
 * Fix source `:result` to use post when a body is given.

data/Dockerfile

@@ -0,0 +1,18 @@
+FROM "docker.io/ruby:4.0-alpine"
+
+ARG UID=1000
+ARG GID=1000
+
+RUN addgroup -g "$GID" -S 'app' \
+      && adduser -u "$UID" -G 'app' -S 'app'
+
+WORKDIR /home/app
+
+COPY --chown=app:app . .
+
+RUN apk add --no-cache --update alpine-sdk yaml-dev \
+      && bundle install \
+      && chown -R app:app /usr/local/bundle
+
+ENTRYPOINT /bin/sh
+USER app

data/Gemfile.lock

@@ -1,29 +1,33 @@
 PATH
   remote: .
   specs:
-    tinify (1.7.1)
+    tinify (1.9.0)
       httpclient (>= 2.9, < 3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.7)
-      public_suffix (>= 2.0.2, < 7.0)
+    addressable (2.9.0)
+      public_suffix (>= 2.0.2, < 8.0)
     base64 (0.3.0)
-    bigdecimal (3.2.3)
-    bigdecimal (3.2.3-java)
-    crack (1.0.0)
+    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 (5.25.5)
+    minitest (6.0.5)
+      drb (~> 2.0)
+      prism (~> 1.5)
     mutex_m (0.3.0)
-    public_suffix (6.0.2)
-    rake (13.3.0)
+    prism (1.9.0)
+    public_suffix (7.0.5)
+    rake (13.4.2)
     rexml (3.4.4)
-    webmock (3.25.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.7.1"
+  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.7.1
+  version: 1.9.0
 platform: ruby
 authors:
 - Rolf Timmermans
@@ -39,7 +39,9 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/ci-cd.yaml"
 - ".gitignore"
+- ".ruby-version"
 - CHANGELOG.md
+- Dockerfile
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -49,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
@@ -58,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
@@ -82,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Ruby client for the Tinify API.
 test_files:
@@ -91,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