tinify 1.2.0 → 1.5.1

data/lib/tinify/client.rb

@@ -4,11 +4,21 @@ require "json"
 module Tinify
   class Client
     API_ENDPOINT = "https://api.tinify.com".freeze
+
+    RETRY_COUNT = 1
+    RETRY_DELAY = 500
+
     USER_AGENT = "Tinify/#{VERSION} Ruby/#{RUBY_VERSION}p#{RUBY_PATCHLEVEL} (#{defined?(RUBY_ENGINE) ? RUBY_ENGINE : "unknown"})".freeze
+
     CA_BUNDLE = File.expand_path("../../data/cacert.pem", __FILE__).freeze
 
-    def initialize(key, app_identifier = nil)
-      @client = HTTPClient.new
+    def initialize(key, app_identifier = nil, proxy = nil)
+      begin
+        @client = HTTPClient.new(proxy)
+      rescue ArgumentError => err
+        raise ConnectionError.new("Invalid proxy: #{err.message}")
+      end
+
       @client.base_url = API_ENDPOINT
       @client.default_header = { "User-Agent" => [USER_AGENT, app_identifier].compact.join(" ") }
 
@@ -19,7 +29,8 @@ module Tinify
       @client.ssl_config.add_trust_ca(CA_BUNDLE)
     end
 
-    def request(method, url, body = nil, header = {})
+    def request(method, url, body = nil)
+      header = {}
       if Hash === body
         if body.empty?
           body = nil
@@ -29,26 +40,31 @@ module Tinify
         end
       end
 
-      begin
-        response = @client.request(method, url, body: body, header: header)
-      rescue HTTPClient::TimeoutError => err
-        raise ConnectionError.new("Timeout while connecting")
-      rescue StandardError => err
-        raise ConnectionError.new("Error while connecting: #{err.message}")
-      end
+      RETRY_COUNT.downto(0) do |retries|
+        sleep RETRY_DELAY / 1000.0 if retries < RETRY_COUNT
 
-      if count = response.headers["Compression-Count"]
-        Tinify.compression_count = count.to_i
-      end
+        begin
+          response = @client.request(method, url, body: body, header: header)
+        rescue HTTPClient::TimeoutError => err
+          next if retries > 0
+          raise ConnectionError.new("Timeout while connecting")
+        rescue StandardError => err
+          next if retries > 0
+          raise ConnectionError.new("Error while connecting: #{err.message}")
+        end
+
+        if count = response.headers["Compression-Count"]
+          Tinify.compression_count = count.to_i
+        end
+
+        return response if response.ok?
 
-      if response.ok?
-        response
-      else
         details = begin
           JSON.parse(response.body)
         rescue StandardError => err
-          { "message" => "Error while parsing response: #{err.message}", "error" => "ParseError" }
+          {"message" => "Error while parsing response: #{err.message}", "error" => "ParseError"}
         end
+        next if retries > 0 and response.status >= 500
         raise Error.create(details["message"], details["error"], response.status)
       end
     end

data/lib/tinify/error.rb

@@ -14,12 +14,14 @@ module Tinify
       end
     end
 
+    attr_reader :status
+
     def initialize(message, type = self.class.name.split("::").last, status = nil)
       @message, @type, @status = message, type, status
     end
 
     def message
-      if @status
+      if status
         "#{@message} (HTTP #{@status}/#{@type})"
       else
         "#{@message}"

data/lib/tinify/source.rb

@@ -20,6 +20,11 @@ module Tinify
       @url, @commands = url.freeze, commands.freeze
     end
 
+    def preserve(*options)
+      options = Array(options).flatten
+      self.class.new(@url, @commands.merge(preserve: options))
+    end
+
     def resize(options)
       self.class.new(@url, @commands.merge(resize: options))
     end

data/lib/tinify/version.rb

@@ -1,3 +1,3 @@
 module Tinify
-  VERSION = "1.2.0"
+  VERSION = "1.5.1"
 end

data/lib/tinify.rb

@@ -10,8 +10,9 @@ require "thread"
 
 module Tinify
   class << self
-    attr_accessor :key
-    attr_accessor :app_identifier
+    attr_reader :key
+    attr_reader :app_identifier
+    attr_reader :proxy
     attr_accessor :compression_count
 
     def key=(key)
@@ -24,6 +25,11 @@ module Tinify
       @client = nil
     end
 
+    def proxy=(proxy)
+      @proxy = proxy
+      @client = nil
+    end
+
     def from_file(path)
       Source.from_file(path)
     end
@@ -38,6 +44,9 @@ module Tinify
 
     def validate!
       client.request(:post, "/shrink")
+    rescue AccountError => err
+      return true if err.status == 429
+      raise err
     rescue ClientError
       true
     end
@@ -45,10 +54,10 @@ module Tinify
     @@mutex = Mutex.new
 
     def client
-      raise AccountError.new("Provide an API key with Tinify.key = ...") unless @key
+      raise AccountError.new("Provide an API key with Tinify.key = ...") unless key
       return @client if @client
       @@mutex.synchronize do
-        @client ||= Client.new(@key, @app_identifier).freeze
+        @client ||= Client.new(key, app_identifier, proxy).freeze
       end
     end
   end

data/test/helper.rb

@@ -6,6 +6,7 @@ require "tinify"
 module TestHelpers
   def before_setup
     Tinify.key = nil
+    Tinify.proxy = nil
     super
   end
 

data/test/integration.rb

@@ -7,32 +7,73 @@ require "minitest/autorun"
 
 describe "client integration" do
   Tinify.key = ENV["TINIFY_KEY"]
+  Tinify.proxy = ENV["TINIFY_PROXY"]
 
   unoptimized_path = File.expand_path("../examples/voormedia.png", __FILE__)
   optimized = Tinify.from_file(unoptimized_path)
 
   it "should compress from file" do
-    Tempfile.open("optimized.png") do |file|
+    Tempfile.open("optimized.png", encoding: "binary") do |file|
       optimized.to_file(file.path)
-      assert_operator file.size, :>, 0
-      assert_operator file.size, :<, 1500
+
+      size = file.size
+      contents = file.read
+
+      assert_operator size, :>, 1000
+      assert_operator size, :<, 1500
+
+      # width == 137
+      assert_includes contents, "\0\0\0\x89".force_encoding("binary")
+      refute_includes contents, "Copyright Voormedia".force_encoding("binary")
     end
   end
 
   it "should compress from url" do
     source = Tinify.from_url("https://raw.githubusercontent.com/tinify/tinify-ruby/master/test/examples/voormedia.png")
-    Tempfile.open("optimized.png") do |file|
+    Tempfile.open("optimized.png", encoding: "binary") do |file|
       source.to_file(file.path)
-      assert_operator file.size, :>, 0
-      assert_operator file.size, :<, 1500
+
+      size = file.size
+      contents = file.read
+
+      assert_operator size, :>, 1000
+      assert_operator size, :<, 1500
+
+      # width == 137
+      assert_includes contents, "\0\0\0\x89".force_encoding("binary")
+      refute_includes contents, "Copyright Voormedia".force_encoding("binary")
     end
   end
 
   it "should resize" do
-    Tempfile.open("resized.png") do |file|
+    Tempfile.open("optimized.png", encoding: "binary") do |file|
       optimized.resize(method: "fit", width: 50, height: 20).to_file(file.path)
-      assert_operator file.size, :>, 0
-      assert_operator file.size, :<, 800
+
+      size = file.size
+      contents = file.read
+
+      assert_operator size, :>, 500
+      assert_operator size, :<, 1000
+
+      # width == 50
+      assert_includes contents, "\0\0\0\x32".force_encoding("binary")
+      refute_includes contents, "Copyright Voormedia".force_encoding("binary")
+    end
+  end
+
+  it "should preserve metadata" do
+    Tempfile.open("optimized.png", encoding: "binary") do |file|
+      optimized.preserve(:copyright, :creation).to_file(file.path)
+
+      size = file.size
+      contents = file.read
+
+      assert_operator size, :>, 1000
+      assert_operator size, :<, 2000
+
+      # width == 137
+      assert_includes contents, "\0\0\0\x89".force_encoding("binary")
+      assert_includes contents, "Copyright Voormedia".force_encoding("binary")
     end
   end
 end

data/test/tinify_client_test.rb

@@ -1,6 +1,9 @@
 require File.expand_path("../helper", __FILE__)
 
 describe Tinify::Client do
+  Tinify::Client.send(:remove_const, :RETRY_DELAY)
+  Tinify::Client.const_set(:RETRY_DELAY, 10)
+
   subject do
     Tinify::Client.new("key")
   end
@@ -82,9 +85,33 @@ describe Tinify::Client do
             headers: { "User-Agent" => "#{Tinify::Client::USER_AGENT} TestApp/0.1" }
         end
       end
+
+      describe "with proxy" do
+        subject do
+          Tinify::Client.new("key", nil, "http://user:pass@localhost:8080")
+        end
+
+        it "should issue request with proxy authorization" do
+          subject.request(:get, "/")
+          assert_requested :get, "https://api:key@api.tinify.com",
+            headers: { "Proxy-Authorization" => "Basic dXNlcjpwYXNz" }
+        end
+      end
     end
 
-    describe "with timeout" do
+    describe "with timeout once" do
+      before do
+        stub_request(:get, "https://api:key@api.tinify.com").to_timeout
+          .then.to_return(status: 201)
+      end
+
+      it "should return response" do
+        response = subject.request(:get, "/")
+        assert_equal "", response.body
+      end
+    end
+
+    describe "with timeout repeatedly" do
       before do
         stub_request(:get, "https://api:key@api.tinify.com").to_timeout
       end
@@ -102,7 +129,20 @@ describe Tinify::Client do
       end
     end
 
-    describe "with socket error" do
+    describe "with socket error once" do
+      before do
+        stub_request(:get, "https://api:key@api.tinify.com")
+          .to_raise(SocketError.new("nodename nor servname provided"))
+          .then.to_return(status: 201)
+      end
+
+      it "should return response" do
+        response = subject.request(:get, "/")
+        assert_equal "", response.body
+      end
+    end
+
+    describe "with socket error repeatedly" do
       before do
         stub_request(:get, "https://api:key@api.tinify.com").to_raise(SocketError.new("nodename nor servname provided"))
       end
@@ -120,7 +160,20 @@ describe Tinify::Client do
       end
     end
 
-    describe "with unexpected error" do
+    describe "with unexpected error once" do
+      before do
+        stub_request(:get, "https://api:key@api.tinify.com")
+          .to_raise("some error")
+          .then.to_return(status: 201)
+      end
+
+      it "should return response" do
+        response = subject.request(:get, "/")
+        assert_equal "", response.body
+      end
+    end
+
+    describe "with unexpected error repeatedly" do
       before do
         stub_request(:get, "https://api:key@api.tinify.com").to_raise("some error")
       end
@@ -138,7 +191,21 @@ describe Tinify::Client do
       end
     end
 
-    describe "with server error" do
+    describe "with server error once" do
+      before do
+        stub_request(:get, "https://api:key@api.tinify.com").to_return(
+          status: 584,
+          body: '{"error":"InternalServerError","message":"Oops!"}'
+        ).then.to_return(status: 201)
+      end
+
+      it "should return response" do
+        response = subject.request(:get, "/")
+        assert_equal "", response.body
+      end
+    end
+
+    describe "with server error repeatedly" do
       before do
         stub_request(:get, "https://api:key@api.tinify.com").to_return(
           status: 584,
@@ -159,8 +226,21 @@ describe Tinify::Client do
       end
     end
 
+    describe "with bad server response once" do
+      before do
+        stub_request(:get, "https://api:key@api.tinify.com").to_return(
+          status: 543,
+          body: '<!-- this is not json -->'
+        ).then.to_return(status: 201)
+      end
 
-    describe "with bad server response" do
+      it "should return response" do
+        response = subject.request(:get, "/")
+        assert_equal "", response.body
+      end
+    end
+
+    describe "with bad server response repeatedly" do
       before do
         stub_request(:get, "https://api:key@api.tinify.com").to_return(
           status: 543,
@@ -186,7 +266,7 @@ describe Tinify::Client do
         stub_request(:get, "https://api:key@api.tinify.com").to_return(
           status: 492,
           body: '{"error":"BadRequest","message":"Oops!"}'
-        )
+        ).then.to_return(status: 201)
       end
 
       it "should raise client error" do
@@ -202,12 +282,13 @@ describe Tinify::Client do
       end
     end
 
+
     describe "with bad credentials" do
       before do
         stub_request(:get, "https://api:key@api.tinify.com").to_return(
           status: 401,
           body: '{"error":"Unauthorized","message":"Oops!"}'
-        )
+        ).then.to_return(status: 201)
       end
 
       it "should raise account error" do

data/test/tinify_source_test.rb

@@ -7,10 +7,10 @@ describe Tinify::Source do
     before do
       Tinify.key = "invalid"
 
-      stub_request(:post, "https://api:invalid@api.tinify.com/shrink").to_return(
-        status: 401,
-        body: '{"error":"Unauthorized","message":"Credentials are invalid"}'
-      )
+      stub_request(:post, "https://api:invalid@api.tinify.com/shrink")
+        .to_return(
+          status: 401,
+          body: '{"error":"Unauthorized","message":"Credentials are invalid"}')
     end
 
     describe "from_file" do
@@ -41,42 +41,22 @@ describe Tinify::Source do
   describe "with valid api key" do
     before do
       Tinify.key = "valid"
-
-      stub_request(:post, "https://api:valid@api.tinify.com/shrink")
-        .to_return(
-          status: 201,
-          headers: { Location: "https://api.tinify.com/some/location" },
-          body: '{}'
-        )
-
-      stub_request(:get, "https://api:valid@api.tinify.com/some/location").to_return(
-        status: 200,
-        body: "compressed file"
-      )
-
-      stub_request(:get, "https://api:valid@api.tinify.com/some/location").with(
-        body: '{"resize":{"width":400}}'
-      ).to_return(
-        status: 200,
-        body: "small file"
-      )
-
-      stub_request(:post, "https://api:valid@api.tinify.com/some/location").with(
-        body: '{"store":{"service":"s3"}}'
-      ).to_return(
-        status: 200,
-        headers: { Location: "https://bucket.s3.amazonaws.com/example" }
-      )
-
-      stub_request(:post, "https://api:valid@api.tinify.com/some/location").with(
-        body: '{"resize":{"width":400},"store":{"service":"s3"}}'
-      ).to_return(
-        status: 200,
-        headers: { Location: "https://bucket.s3.amazonaws.com/example" }
-      )
     end
 
     describe "from_file" do
+      before do
+        stub_request(:post, "https://api:valid@api.tinify.com/shrink")
+          .to_return(
+            status: 201,
+            headers: { Location: "https://api.tinify.com/some/location" },
+            body: '{}')
+
+        stub_request(:get, "https://api:valid@api.tinify.com/some/location")
+          .to_return(
+            status: 200,
+            body: "compressed file")
+      end
+
       it "should return source" do
         assert_kind_of Tinify::Source, Tinify::Source.from_file(dummy_file)
       end
@@ -87,6 +67,19 @@ describe Tinify::Source do
     end
 
     describe "from_buffer" do
+      before do
+        stub_request(:post, "https://api:valid@api.tinify.com/shrink")
+          .to_return(
+            status: 201,
+            headers: { Location: "https://api.tinify.com/some/location" },
+            body: '{}')
+
+        stub_request(:get, "https://api:valid@api.tinify.com/some/location")
+          .to_return(
+            status: 200,
+            body: "compressed file")
+      end
+
       it "should return source" do
         assert_kind_of Tinify::Source, Tinify::Source.from_buffer("png file")
       end
@@ -103,20 +96,18 @@ describe Tinify::Source do
           .to_return(
             status: 201,
             headers: { Location: "https://api.tinify.com/some/location" },
-            body: '{}'
-        )
+            body: '{}')
 
         stub_request(:post, "https://api:valid@api.tinify.com/shrink")
           .with(body: '{"source":{"url":"file://wrong"}}')
           .to_return(
             status: 400,
-            body: '{"error":"Source not found","message":"Cannot parse URL"}'
-          )
+            body: '{"error":"Source not found","message":"Cannot parse URL"}')
 
-        stub_request(:get, "https://api:valid@api.tinify.com/some/location").to_return(
-          status: 200,
-          body: "compressed file"
-        )
+        stub_request(:get, "https://api:valid@api.tinify.com/some/location")
+          .to_return(
+            status: 200,
+            body: "compressed file")
       end
 
       it "should return source" do
@@ -135,12 +126,84 @@ describe Tinify::Source do
     end
 
     describe "result" do
+      before do
+        stub_request(:post, "https://api:valid@api.tinify.com/shrink")
+          .to_return(
+            status: 201,
+            headers: { Location: "https://api.tinify.com/some/location" },
+            body: '{}')
+
+        stub_request(:get, "https://api:valid@api.tinify.com/some/location")
+          .to_return(
+            status: 200,
+            body: "compressed file")
+      end
+
       it "should return result" do
         assert_kind_of Tinify::Result, Tinify::Source.from_buffer("png file").result
       end
     end
 
+    describe "preserve" do
+      before do
+        stub_request(:post, "https://api:valid@api.tinify.com/shrink")
+          .to_return(
+            status: 201,
+            headers: { Location: "https://api.tinify.com/some/location" },
+            body: '{}')
+
+        stub_request(:get, "https://api:valid@api.tinify.com/some/location")
+          .with(
+            body: '{"preserve":["copyright","location"]}')
+          .to_return(
+            status: 200,
+            body: "copyrighted file")
+      end
+
+      it "should return source" do
+        source = Tinify::Source.from_buffer("png file").preserve(:copyright, :location)
+        assert_kind_of Tinify::Source, source
+      end
+
+      it "should return source with data" do
+        source = Tinify::Source.from_buffer("png file").preserve(:copyright, :location)
+        assert_equal "copyrighted file", source.to_buffer
+      end
+
+      it "should return source with data for array" do
+        source = Tinify::Source.from_buffer("png file").preserve([:copyright, :location])
+        assert_equal "copyrighted file", source.to_buffer
+      end
+
+      it "should include other options if set" do
+        stub_request(:get, "https://api:valid@api.tinify.com/some/location")
+          .with(
+            body: '{"resize":{"width":400},"preserve":["copyright","location"]}')
+          .to_return(
+            status: 200,
+            body: "copyrighted resized file")
+
+        source = Tinify::Source.from_buffer("png file").resize(width: 400).preserve(:copyright, :location)
+        assert_equal "copyrighted resized file", source.to_buffer
+      end
+    end
+
     describe "resize" do
+      before do
+        stub_request(:post, "https://api:valid@api.tinify.com/shrink")
+          .to_return(
+            status: 201,
+            headers: { Location: "https://api.tinify.com/some/location" },
+            body: '{}')
+
+        stub_request(:get, "https://api:valid@api.tinify.com/some/location")
+          .with(
+            body: '{"resize":{"width":400}}')
+          .to_return(
+            status: 200,
+            body: "small file")
+      end
+
       it "should return source" do
         assert_kind_of Tinify::Source, Tinify::Source.from_buffer("png file").resize(width: 400)
       end
@@ -151,6 +214,22 @@ describe Tinify::Source do
     end
 
     describe "store" do
+      before do
+        stub_request(:post, "https://api:valid@api.tinify.com/shrink")
+          .to_return(
+            status: 201,
+            headers: { Location: "https://api.tinify.com/some/location" },
+            body: '{}'
+          )
+
+        stub_request(:post, "https://api:valid@api.tinify.com/some/location")
+        .with(
+          body: '{"store":{"service":"s3"}}')
+        .to_return(
+          status: 200,
+          headers: { Location: "https://bucket.s3.amazonaws.com/example" })
+      end
+
       it "should return result meta" do
         assert_kind_of Tinify::ResultMeta, Tinify::Source.from_buffer("png file").store(service: "s3")
       end
@@ -160,19 +239,52 @@ describe Tinify::Source do
         assert_equal "https://bucket.s3.amazonaws.com/example", result.location
       end
 
-      it "should include resize options if set" do
+      it "should include other options if set" do
+        stub_request(:post, "https://api:valid@api.tinify.com/some/location")
+        .with(
+          body: '{"resize":{"width":400},"store":{"service":"s3"}}')
+        .to_return(
+          status: 200,
+          headers: { Location: "https://bucket.s3.amazonaws.com/example" })
+
         result = Tinify::Source.from_buffer("png file").resize(width: 400).store(service: "s3")
         assert_equal "https://bucket.s3.amazonaws.com/example", result.location
       end
     end
 
     describe "to_buffer" do
+      before do
+        stub_request(:post, "https://api:valid@api.tinify.com/shrink")
+          .to_return(
+            status: 201,
+            headers: { Location: "https://api.tinify.com/some/location" },
+            body: '{}')
+
+        stub_request(:get, "https://api:valid@api.tinify.com/some/location").to_return(
+          status: 200,
+          body: "compressed file"
+        )
+      end
+
       it "should return image data" do
         assert_equal "compressed file", Tinify::Source.from_buffer("png file").to_buffer
       end
     end
 
     describe "to_file" do
+      before do
+        stub_request(:post, "https://api:valid@api.tinify.com/shrink")
+          .to_return(
+            status: 201,
+            headers: { Location: "https://api.tinify.com/some/location" },
+            body: '{}')
+
+        stub_request(:get, "https://api:valid@api.tinify.com/some/location").to_return(
+          status: 200,
+          body: "compressed file"
+        )
+      end
+
       it "should store image data" do
         begin
           tmp = Tempfile.open("foo")