tinify 0.9.0

data/lib/tinify.rb

@@ -0,0 +1,45 @@
+require "tinify/version"
+require "tinify/error"
+
+require "tinify/client"
+require "tinify/result"
+require "tinify/source"
+
+require "thread"
+
+module Tinify
+  class << self
+    attr_accessor :key
+    attr_accessor :app_identifier
+    attr_accessor :compression_count
+
+    def from_file(path)
+      Source.from_file(path)
+    end
+
+    def from_buffer(string)
+      Source.from_buffer(string)
+    end
+
+    def validate!
+      client.request(:post, "/shrink")
+    rescue ClientError
+      true
+    end
+
+    def reset!
+      @key = nil
+      @client = nil
+    end
+
+    @@mutex = Mutex.new
+
+    def client
+      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
+      end
+    end
+  end
+end

data/lib/tinify/client.rb

@@ -0,0 +1,52 @@
+require "httpclient"
+require "json"
+
+module Tinify
+  class Client
+    API_ENDPOINT = "https://api.tinify.com".freeze
+    USER_AGENT = "Tinify/#{VERSION} Ruby/#{RUBY_VERSION}p#{RUBY_PATCHLEVEL}".freeze
+    CA_BUNDLE = File.expand_path("../../data/cacert.pem", __FILE__).freeze
+
+    def initialize(key, app_identifier = nil)
+      @client = HTTPClient.new
+      @client.base_url = API_ENDPOINT
+      @client.default_header = { user_agent: [USER_AGENT, app_identifier].compact.join(" ") }
+
+      @client.force_basic_auth = true
+      @client.set_auth("/", "api", key)
+
+      @client.ssl_config.clear_cert_store
+      @client.ssl_config.add_trust_ca(CA_BUNDLE)
+    end
+
+    def request(method, url, body = nil, header = {})
+      if Hash === body && !body.empty?
+        body = JSON.generate(body)
+        header["Content-Type"] = "application/json"
+      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
+
+      if count = response.headers["Compression-Count"]
+        Tinify.compression_count = count.to_i
+      end
+
+      if response.ok?
+        response
+      else
+        details = begin
+          JSON.parse(response.body)
+        rescue StandardError => err
+          { "message" => "Error while parsing response: #{err.message}", "error" => "ParseError" }
+        end
+        raise Error.create(details["message"], details["error"], response.status)
+      end
+    end
+  end
+end

data/lib/tinify/error.rb

@@ -0,0 +1,35 @@
+module Tinify
+  class Error < StandardError
+    class << self
+      def create(message, type, status)
+        klass = case status
+        when 401, 429 then AccountError
+        when 400..499 then ClientError
+        when 500..599 then ServerError
+        else Error
+        end
+
+        message = "No message was provided" if message.to_s.empty?
+        klass.new(message, type, status)
+      end
+    end
+
+    def initialize(message, type = self.class.name.split("::").last, status = nil)
+      @message, @type, @status = message, type, status
+    end
+
+    def message
+      if @status
+        "#{@message} (HTTP #{@status}/#{@type})"
+      else
+        "#{@message}"
+      end
+    end
+    alias_method :to_s, :message
+  end
+
+  class AccountError < Error; end
+  class ClientError < Error; end
+  class ServerError < Error; end
+  class ConnectionError < Error; end
+end

data/lib/tinify/result.rb

@@ -0,0 +1,32 @@
+module Tinify
+  class Result
+    attr_reader :data
+
+    def initialize(meta, data)
+      @meta, @data = meta.freeze, data.freeze
+    end
+
+    def to_file(path)
+      File.open(path, "wb") { |file| file.write(data) }
+    end
+
+    alias_method :to_buffer, :data
+
+    def width
+      @meta["Image-Width"].to_i
+    end
+
+    def height
+      @meta["Image-Height"].to_i
+    end
+
+    def size
+      @meta["Content-Length"].to_i
+    end
+
+    def media_type
+      @meta["Content-Type"]
+    end
+    alias_method :content_type, :media_type
+  end
+end

data/lib/tinify/source.rb

@@ -0,0 +1,40 @@
+module Tinify
+  class Source
+    class << self
+      def from_file(path)
+        from_buffer(File.open(path, "rb") { |file| file.read })
+      end
+
+      def from_buffer(string)
+        response = Tinify.client.request(:post, "/shrink", string)
+        new(response.headers["Location"]).freeze
+      end
+    end
+
+    def initialize(url, commands = {})
+      @url, @commands = url.freeze, commands.freeze
+    end
+
+    def resize(options)
+      self.class.new(@url, @commands.merge(resize: options))
+    end
+
+    def store(options)
+      response = Tinify.client.request(:post, @url, @commands.merge(store: options))
+      Result.new(response.headers, response.body).freeze
+    end
+
+    def result
+      response = Tinify.client.request(:get, @url, @commands)
+      Result.new(response.headers, response.body).freeze
+    end
+
+    def to_file(path)
+      result.to_file(path)
+    end
+
+    def to_buffer
+      result.to_buffer
+    end
+  end
+end

data/lib/tinify/version.rb

@@ -0,0 +1,3 @@
+module Tinify
+  VERSION = "0.9.0"
+end

data/test/helper.rb

@@ -0,0 +1,28 @@
+require "minitest/autorun"
+require "webmock/minitest"
+
+require "tinify"
+
+module TestHelpers
+  def before_setup
+    Tinify.reset!
+    super
+  end
+
+  def assert_raise_with_message(message)
+     err = nil
+     begin
+       yield
+     rescue => err
+     end
+     if message.is_a?(Regexp)
+       assert_match(message, err.message)
+     else
+       assert_equal(message, err.message)
+     end
+   end
+ end
+
+class MiniTest::Spec
+  include TestHelpers
+end

data/test/tinify_client_test.rb

@@ -0,0 +1,193 @@
+require File.expand_path("../helper", __FILE__)
+
+describe Tinify::Client do
+  subject do
+    Tinify::Client.new("key")
+  end
+
+  describe "request" do
+    describe "when valid" do
+      before do
+        stub_request(:get, "https://api:key@api.tinify.com").to_return(
+          status: 200,
+          headers: { "Compression-Count" => "12" }
+        )
+      end
+
+      it "should issue request" do
+        subject.request(:get, "/")
+        assert_requested :get, "https://api:key@api.tinify.com",
+          headers: { "Authorization" => "Basic " + ["api:key"].pack("m").chomp }
+      end
+
+      it "should issue request with json body" do
+        subject.request(:get, "/", { hello: "world" })
+        assert_requested :get, "https://api:key@api.tinify.com",
+          headers: { "Content-Type" => "application/json" },
+          body: '{"hello":"world"}'
+      end
+
+      it "should issue request with user agent" do
+        subject.request(:get, "/")
+        assert_requested :get, "https://api:key@api.tinify.com",
+          headers: { "User-Agent" => Tinify::Client::USER_AGENT }
+      end
+
+      it "should update compression count" do
+        subject.request(:get, "/")
+        assert_equal 12, Tinify.compression_count
+      end
+
+      describe "with app id" do
+        subject do
+          Tinify::Client.new("key", "TestApp/0.1")
+        end
+
+        it "should issue request with user agent" do
+          subject.request(:get, "/")
+          assert_requested :get, "https://api:key@api.tinify.com",
+            headers: { "User-Agent" => "#{Tinify::Client::USER_AGENT} TestApp/0.1" }
+        end
+      end
+    end
+
+    describe "with timeout" do
+      before do
+        stub_request(:get, "https://api:key@api.tinify.com").to_timeout
+      end
+
+      it "should raise connection error" do
+        assert_raises Tinify::ConnectionError do
+          subject.request(:get, "/")
+        end
+      end
+
+      it "should raise error with message" do
+        assert_raise_with_message "Timeout while connecting" do
+          subject.request(:get, "/")
+        end
+      end
+    end
+
+    describe "with socket error" do
+      before do
+        stub_request(:get, "https://api:key@api.tinify.com").to_raise(SocketError.new("nodename nor servname provided"))
+      end
+
+      it "should raise error" do
+        assert_raises Tinify::ConnectionError do
+          subject.request(:get, "/")
+        end
+      end
+
+      it "should raise error with message" do
+        assert_raise_with_message "Error while connecting: nodename nor servname provided" do
+          subject.request(:get, "/")
+        end
+      end
+    end
+
+    describe "with unexpected error" do
+      before do
+        stub_request(:get, "https://api:key@api.tinify.com").to_raise("some error")
+      end
+
+      it "should raise error" do
+        assert_raises Tinify::ConnectionError do
+          subject.request(:get, "/")
+        end
+      end
+
+      it "should raise error with message" do
+        assert_raise_with_message "Error while connecting: some error" do
+          subject.request(:get, "/")
+        end
+      end
+    end
+
+    describe "with server error" do
+      before do
+        stub_request(:get, "https://api:key@api.tinify.com").to_return(
+          status: 584,
+          body: '{"error":"InternalServerError","message":"Oops!"}'
+        )
+      end
+
+      it "should raise server error" do
+        assert_raises Tinify::ServerError do
+          subject.request(:get, "/")
+        end
+      end
+
+      it "should raise error with message" do
+        assert_raise_with_message "Oops! (HTTP 584/InternalServerError)" do
+          subject.request(:get, "/")
+        end
+      end
+    end
+
+
+    describe "with bad server response" do
+      before do
+        stub_request(:get, "https://api:key@api.tinify.com").to_return(
+          status: 543,
+          body: '<!-- this is not json -->'
+        )
+      end
+
+      it "should raise server error" do
+        assert_raises Tinify::ServerError do
+          subject.request(:get, "/")
+        end
+      end
+
+      it "should raise error with message" do
+        assert_raise_with_message %r{Error while parsing response: .*unexpected token at '<!-- this is not json -->' \(HTTP 543/ParseError\)} do
+          subject.request(:get, "/")
+        end
+      end
+    end
+
+    describe "with client error" do
+      before do
+        stub_request(:get, "https://api:key@api.tinify.com").to_return(
+          status: 492,
+          body: '{"error":"BadRequest","message":"Oops!"}'
+        )
+      end
+
+      it "should raise client error" do
+        assert_raises Tinify::ClientError do
+          subject.request(:get, "/")
+        end
+      end
+
+      it "should raise error with message" do
+        assert_raise_with_message "Oops! (HTTP 492/BadRequest)" do
+          subject.request(:get, "/")
+        end
+      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!"}'
+        )
+      end
+
+      it "should raise account error" do
+        assert_raises Tinify::AccountError do
+          subject.request(:get, "/")
+        end
+      end
+
+      it "should raise error with message" do
+        assert_raise_with_message "Oops! (HTTP 401/Unauthorized)" do
+          subject.request(:get, "/")
+        end
+      end
+    end
+  end
+end

data/test/tinify_result_test.rb

@@ -0,0 +1,44 @@
+require File.expand_path("../helper", __FILE__)
+
+describe Tinify::Result do
+  describe "with meta and data" do
+    subject do
+      Tinify::Result.new({
+        "Image-Width" => "100",
+        "Image-Height" => "60",
+        "Content-Length" => "450",
+        "Content-Type" => "image/png",
+      }, "image data")
+    end
+
+    describe "width" do
+      it "should return image width" do
+        assert_equal 100, subject.width
+      end
+    end
+
+    describe "height" do
+      it "should return image height" do
+        assert_equal 60, subject.height
+      end
+    end
+
+    describe "size" do
+      it "should return content length" do
+        assert_equal 450, subject.size
+      end
+    end
+
+    describe "content_type" do
+      it "should return mime type" do
+        assert_equal "image/png", subject.content_type
+      end
+    end
+
+    describe "data" do
+      it "should return image data" do
+        assert_equal "image data", subject.data
+      end
+    end
+  end
+end