remove_bg 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85d740935b627c71987091c6b9476d49a17fa2a63cea2844f53a3bb0e7d9621b
-  data.tar.gz: d9ff54349e69003ecea536d4b669ca4479d4a7cd1c0e2a8577e0b8467cbbcdb2
+  metadata.gz: c58154a3e3edc19ed8562c66f603a4965512814787e6b3d62907f7c931fec111
+  data.tar.gz: b2c773dc3f11983a95b510b7a65ce8060d318d37b30e0fec4aeaf73552cbdfa0
 SHA512:
-  metadata.gz: 18b21fbf48e49447b44eb950b5846e3de1e3ebf52c49aae4ae207870a8367aad61d7eded97709e371c06538830c9a73e86f4af7d7106c62c66d938a86a525bae
-  data.tar.gz: '079fb2498670102258b88d47d93a665ee47b318b8b307316b8c093f3e47572ec975c814c9d4f237d48dc38e5a196ade29eaa4452db976ed7a238487a3ec6878c'
+  metadata.gz: f3ec05a4b3e9f55676d1dd50da5e5f148a532e15c7fce09aa65429df243769e9de47271c31567f1e90f4b16c20bbc653618dbd2b9dffe7bd6b8500dc421eb1ef
+  data.tar.gz: 3c2fbb46e300903114df2b0fcca3b6fecdeb0dd3844aace5d60de88cf88794167531456455c52b935f9626f21b1e8cf2476cf4454f95bf6d56c702cc0f49fdd7

data/.circleci/config.yml

@@ -13,6 +13,12 @@ base_job: &base_job
         name: install dependencies
         command: bundle install --jobs=4 --retry=3 --path vendor/bundle
 
+    - run:
+        name: install image processsing dependencies
+        command: |
+          sudo apt-get update
+          sudo apt install imagemagick libvips
+
     - save_cache:
         paths:
           - ./vendor/bundle

data/Appraisals

@@ -3,9 +3,12 @@ appraise "faraday-0-15" do
   gem "faraday", "~> 0.15.0"
 end
 
-# Latest in Faraday 0.x series
-appraise "faraday-0-x" do
-  gem "faraday", ">= 0.15", "<= 1.0"
+appraise "faraday-0-16" do
+  gem "faraday", "~> 0.16.0"
+end
+
+appraise "faraday-0-17" do
+  gem "faraday", "~> 0.17.0"
 end
 
 # Latest in Faraday 1.x series

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 1.4.0
+
+- Adds support for images up to 25 megapixels ([documentation](https://github.com/remove-bg/ruby#processing-images-over-10-megapixels))
+  - Requires an image processing library to be configured (ImageMagick, GraphicsMagick or libvips)
+
 ## 1.3.0
 
 - Add `RemoveBg.account_info` which includes available credits - via [#9](https://github.com/remove-bg/ruby/pull/9)

data/Gemfile.lock

@@ -1,14 +1,16 @@
 PATH
   remote: .
   specs:
-    remove_bg (1.3.0)
+    remove_bg (1.4.0)
       faraday (>= 0.15, < 2)
+      image_processing (>= 1.9, < 2)
+      rubyzip (>= 2.0, < 3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     appraisal (2.2.0)
       bundler
       rake
@@ -17,41 +19,49 @@ GEM
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
-    dotenv (2.7.1)
+    dotenv (2.7.5)
     faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
-    hashdiff (0.3.8)
-    method_source (0.9.2)
+    ffi (1.12.2)
+    hashdiff (1.0.1)
+    image_processing (1.11.0)
+      mini_magick (>= 4.9.5, < 5)
+      ruby-vips (>= 2.0.17, < 3)
+    method_source (1.0.0)
+    mini_magick (4.10.1)
     multipart-post (2.1.1)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    public_suffix (3.0.3)
-    rake (12.3.2)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.4)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
     rspec-with_params (0.2.0)
       rspec (~> 3.0)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
+    ruby-vips (2.0.17)
+      ffi (~> 1.9)
+    rubyzip (2.3.0)
     safe_yaml (1.0.5)
-    thor (0.20.3)
-    vcr (4.0.0)
-    webmock (3.5.1)
+    thor (1.0.1)
+    vcr (5.1.0)
+    webmock (3.8.3)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
-      hashdiff
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
@@ -61,7 +71,7 @@ DEPENDENCIES
   bundler (~> 1.17)
   dotenv
   pry
-  rake (~> 12.0)
+  rake
   remove_bg!
   rspec (~> 3.8)
   rspec-with_params

data/README.md

@@ -69,6 +69,39 @@ result.save("processed/image.png")
 result.save("image.png", overwrite: true) # Careful!
 ```
 
+#### Processing images over 10 megapixels
+
+The Remove.bg API provides a [ZIP format](https://www.remove.bg/api#zip-format)
+which includes all the information required to efficiently composite a large
+image with transparency.
+
+The gem can handle this composition for you, but you'll need
+[ImageMagick]/[GraphicsMagick] or [libvips] available on your computer.
+
+[ImageMagick]: https://www.imagemagick.org
+[GraphicsMagick]: http://www.graphicsmagick.org
+[libvips]: http://libvips.github.io/libvips/
+
+Please configure the image processing library you'd like to use:
+
+```ruby
+RemoveBg.configure do |config|
+  config.image_processor = :minimagick # For ImageMagick or GraphicsMagick
+  # or
+  config.image_processor = :vips
+end
+```
+
+Then process images specifying the `zip` format:
+
+```ruby
+result = RemoveBg.from_file("large-image.jpg", format: "zip")
+
+result.save("result-with-transparency.png")
+# or
+result.save_zip("result.zip") # If you want to handle composition yourself
+```
+
 ### Fetching account information
 
 To display the [account information][account-info] for the currently configured

data/gemfiles/{faraday_0_x.gemfile → faraday_0_16.gemfile}

@@ -2,6 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "faraday", ">= 0.15", "<= 1.0"
+gem "faraday", "~> 0.16.0"
 
 gemspec path: "../"

data/gemfiles/faraday_0_17.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "faraday", "~> 0.17.0"
+
+gemspec path: "../"

data/lib/remove_bg/api_client.rb

@@ -1,6 +1,9 @@
 require "json"
+require "tempfile"
+
 require_relative "account_info"
 require_relative "api"
+require_relative "composite_result"
 require_relative "error"
 require_relative "http_connection"
 require_relative "result"
@@ -35,14 +38,35 @@ module RemoveBg
     attr_reader :connection
 
     def request_remove_bg(data, api_key)
+      download = Tempfile.new("remove-bg-download")
+      streaming = false
+
       response = connection.post(V1_REMOVE_BG, data) do |req|
         req.headers[HEADER_API_KEY] = api_key
+
+        # Faraday v0.16 & v1.0+ support streaming, v0.17 did not (rollback release)
+        if req.options.respond_to?(:on_data)
+          streaming = true
+          req.options.on_data = Proc.new do |chunk, _|
+            download.write(chunk)
+          end
+        end
+      end
+
+      # Faraday v0.15 / v0.17
+      if !streaming
+        download.write(response.body)
       end
 
+      download.rewind
+
       if response.status == 200
-        parse_image_result(response)
+        parse_image_result(headers: response.headers, download: download)
       else
-        handle_http_error(response)
+        response_body = download.read
+        download.close
+        download.unlink
+        handle_http_error(response: response, body: response_body)
       end
     end
 
@@ -54,33 +78,41 @@ module RemoveBg
       if response.status == 200
         parse_account_result(response)
       else
-        handle_http_error(response)
+        handle_http_error(response: response, body: response.body)
       end
     end
 
-    def handle_http_error(response)
+    def handle_http_error(response:, body:)
       case response.status
       when 400..499
-        error_message = parse_error_message(response)
-        raise RemoveBg::ClientHttpError.new(error_message, response)
+        error_message = parse_error_message(body)
+        raise RemoveBg::ClientHttpError.new(error_message, response, body)
       when 500..599
-        error_message = parse_error_message(response)
-        raise RemoveBg::ServerHttpError.new(error_message, response)
+        error_message = parse_error_message(body)
+        raise RemoveBg::ServerHttpError.new(error_message, response, body)
       else
-        raise RemoveBg::HttpError.new("An unknown error occurred", response)
+        raise RemoveBg::HttpError.new("An unknown error occurred", response, body)
       end
     end
 
-    def parse_image_result(response)
-      RemoveBg::Result.new(
-        data: response.body,
-        type: response.headers[HEADER_TYPE],
-        width: response.headers[HEADER_WIDTH]&.to_i,
-        height: response.headers[HEADER_HEIGHT]&.to_i,
-        credits_charged: response.headers[HEADER_CREDITS_CHARGED]&.to_f,
+    def parse_image_result(headers:, download:)
+      result_for_content_type(headers["Content-Type"]).new(
+        download: download,
+        type: headers[HEADER_TYPE],
+        width: headers[HEADER_WIDTH]&.to_i,
+        height: headers[HEADER_HEIGHT]&.to_i,
+        credits_charged: headers[HEADER_CREDITS_CHARGED]&.to_f,
       )
     end
 
+    def result_for_content_type(content_type)
+      if content_type&.include?("application/zip")
+        CompositeResult
+      else
+        Result
+      end
+    end
+
     def parse_account_result(response)
       attributes = JSON.parse(response.body, symbolize_names: true)
         .fetch(:data)
@@ -89,12 +121,12 @@ module RemoveBg
       RemoveBg::AccountInfo.new(attributes)
     end
 
-    def parse_error_message(response)
-      parse_errors(response).first["title"]
+    def parse_error_message(response_body)
+      parse_errors(response_body).first["title"]
     end
 
-    def parse_errors(response)
-      JSON.parse(response.body)["errors"] || []
+    def parse_errors(response_body)
+      JSON.parse(response_body)["errors"] || []
     rescue JSON::ParserError
       [{ "title" => "Unable to parse response" }]
     end

data/lib/remove_bg/composite_result.rb

@@ -0,0 +1,52 @@
+require_relative "result"
+
+module RemoveBg
+  class CompositeResult < Result
+    def save_zip(file_path, overwrite: false)
+      if File.exist?(file_path) && !overwrite
+        raise FileOverwriteError.new(file_path)
+      end
+
+      FileUtils.cp(download, file_path)
+    end
+
+    private
+
+    def image_file
+      composite_file
+    end
+
+    def composite_file
+      @composite_file ||= begin
+        Tempfile.new(["composed", ".png"]).tap do |file|
+          compose_to_file(file)
+        end
+      end
+    end
+
+    def color_file
+      @color_file ||= Tempfile.new(["color", ".jpg"])
+    end
+
+    def alpha_file
+      @alpha_file ||= Tempfile.new(["alpha", ".png"])
+    end
+
+    def compose_to_file(destination)
+      extract_parts
+
+      ImageComposer.new.compose(
+        color_file: color_file,
+        alpha_file: alpha_file,
+        destination_path: destination.path
+      )
+    end
+
+    def extract_parts
+      Zip::File.open(download) do |zf|
+        zf.find_entry("color.jpg").extract(color_file.path) { true }
+        zf.find_entry("alpha.png").extract(alpha_file.path) { true }
+      end
+    end
+  end
+end

data/lib/remove_bg/configuration.rb

@@ -1,6 +1,6 @@
 module RemoveBg
   class Configuration
-    attr_accessor :api_key
+    attr_accessor :api_key, :image_processor
 
     def self.configuration
       @configuration ||= Configuration.new

data/lib/remove_bg/error.rb

@@ -2,10 +2,11 @@ module RemoveBg
   class Error < StandardError; end
 
   class HttpError < Error
-    attr_reader :http_response
+    attr_reader :http_response, :http_response_body
 
-    def initialize(message, http_response)
+    def initialize(message, http_response, http_response_body)
       @http_response = http_response
+      @http_response_body = http_response_body
       super(message)
     end
   end

data/lib/remove_bg/image_composer.rb

@@ -0,0 +1,42 @@
+require_relative "error"
+
+module RemoveBg
+  class ImageComposer
+    def compose(color_file:, alpha_file:, destination_path:)
+      image = case configured_image_processor
+        when :vips
+          then vips_compose(color_file: color_file, alpha_file: alpha_file)
+        when :minimagick
+          then minimagick_compose(color_file: color_file, alpha_file: alpha_file)
+        when nil
+          raise RemoveBg::Error, "Please configure an image processor to use image composition"
+        else
+          raise RemoveBg::Error, "Unsupported image processor: #{configured_image_processor.inspect}"
+        end
+
+      image.call(destination: destination_path)
+    end
+
+    private
+
+    def configured_image_processor
+      RemoveBg::Configuration.configuration.image_processor
+    end
+
+    def minimagick_compose(color_file:, alpha_file:)
+      require "image_processing/mini_magick"
+
+      ImageProcessing::MiniMagick
+        .source(color_file)
+        .composite(alpha_file, mode: "copy-opacity")
+    end
+
+    def vips_compose(color_file:, alpha_file:)
+      require "image_processing/vips"
+
+      ImageProcessing::Vips
+        .source(color_file)
+        .custom { |image| image.bandjoin(Vips::Image.new_from_file(alpha_file.path)) }
+    end
+  end
+end

data/lib/remove_bg/result.rb

@@ -1,11 +1,14 @@
+require "fileutils"
+require "zip"
 require_relative "error"
+require_relative "image_composer"
 
 module RemoveBg
   class Result
-    attr_reader :data, :type, :width, :height, :credits_charged
+    attr_reader :type, :width, :height, :credits_charged
 
-    def initialize(data:, type:, width:, height:, credits_charged:)
-      @data = data
+    def initialize(download:, type:, width:, height:, credits_charged:)
+      @download = download
       @type = type
       @width = width
       @height = height
@@ -17,7 +20,20 @@ module RemoveBg
         raise FileOverwriteError.new(file_path)
       end
 
-      File.write(file_path, data)
+      FileUtils.cp(image_file, file_path)
+    end
+
+    def data
+      image_file.rewind
+      image_file.read
+    end
+
+    private
+
+    attr_reader :download
+
+    def image_file
+      download
     end
   end
 end

data/lib/remove_bg/version.rb

@@ -1,3 +1,3 @@
 module RemoveBg
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

data/remove_bg.gemspec

@@ -24,12 +24,14 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "faraday", ">= 0.15", "< 2"
+  spec.add_dependency "image_processing", ">= 1.9", "< 2"
+  spec.add_dependency "rubyzip", ">= 2.0", "< 3"
 
   spec.add_development_dependency "appraisal"
   spec.add_development_dependency "bundler", "~> 1.17"
   spec.add_development_dependency "dotenv"
   spec.add_development_dependency "pry"
-  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec_junit_formatter"
   spec.add_development_dependency "rspec-with_params"
   spec.add_development_dependency "rspec", "~> 3.8"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: remove_bg
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Oliver Peate
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-07 00:00:00.000000000 Z
+date: 2020-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -30,6 +30,46 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: image_processing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -90,16 +130,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
@@ -191,16 +231,19 @@ files:
 - bin/console
 - bin/setup
 - gemfiles/faraday_0_15.gemfile
-- gemfiles/faraday_0_x.gemfile
+- gemfiles/faraday_0_16.gemfile
+- gemfiles/faraday_0_17.gemfile
 - gemfiles/faraday_1_x.gemfile
 - lib/remove_bg.rb
 - lib/remove_bg/account_info.rb
 - lib/remove_bg/api.rb
 - lib/remove_bg/api_client.rb
 - lib/remove_bg/base_request_options.rb
+- lib/remove_bg/composite_result.rb
 - lib/remove_bg/configuration.rb
 - lib/remove_bg/error.rb
 - lib/remove_bg/http_connection.rb
+- lib/remove_bg/image_composer.rb
 - lib/remove_bg/request_options.rb
 - lib/remove_bg/result.rb
 - lib/remove_bg/upload.rb