remove_bg 1.2.0 → 1.5.0

data/lib/remove_bg/http_connection.rb

@@ -8,6 +8,8 @@ module RemoveBg
     HTTP_BASE_TIMEOUT = 10
     HTTP_WRITE_TIMEOUT = 120
 
+    # @return [Faraday::Connection]
+    #
     def self.build(api_url = RemoveBg::Api::URL)
       retry_options = {
         max: 2,

data/lib/remove_bg/image_composer.rb

@@ -0,0 +1,60 @@
+require_relative "error"
+
+module RemoveBg
+  # Combines alpha.png and color.jpg files to produce a full-sized transparent PNG.
+  # An image processing library (ImageMagick, GraphicsMagick, or libvips) must
+  # be available on the system.
+  # @see RemoveBg::CompositeResult
+  #
+  class ImageComposer
+    DEFAULT_BINARY_DETECTOR = lambda do |binary_name|
+      system("which", binary_name, out: File::NULL)
+    end
+
+    def self.detect_image_processor(detector: DEFAULT_BINARY_DETECTOR)
+      case
+      when detector.call("magick"), detector.call("convert"), detector.call("gm")
+        :minimagick
+      when detector.call("vips")
+        :vips
+      end
+    end
+
+    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/rate_limit_info.rb

@@ -0,0 +1,34 @@
+require "time"
+
+module RemoveBg
+  class RateLimitInfo
+    attr_reader :total, :remaining, :retry_after_seconds
+
+    def initialize(headers)
+      @total = headers["X-RateLimit-Limit"]&.to_i
+      @remaining = headers["X-RateLimit-Remaining"]&.to_i
+      @reset_timestamp = headers["X-RateLimit-Reset"]&.to_i
+
+      # Only present if rate limit exceeded
+      @retry_after_seconds = headers["Retry-After"]&.to_i
+    end
+
+    def reset_at
+      return if reset_timestamp.nil?
+      Time.at(reset_timestamp).utc
+    end
+
+    def to_s
+      "<RateLimit"\
+      " reset_at='#{reset_at.iso8601}'"\
+      " retry_after_seconds=#{retry_after_seconds}"\
+      " total=#{total}"\
+      " remaining=#{remaining}"\
+      ">"
+    end
+
+    private
+
+    attr_reader :reset_timestamp
+  end
+end

data/lib/remove_bg/request_options.rb

@@ -1,7 +1,9 @@
-require_relative "error"
+require_relative "base_request_options"
 
 module RemoveBg
-  class RequestOptions
+  # Options for image processing requests. Arbitary options are passed directly to the API.
+  #
+  class RequestOptions < BaseRequestOptions
     SIZE_REGULAR = "regular"
     SIZE_MEDIUM = "medium"
     SIZE_HD = "hd"
@@ -15,32 +17,40 @@ module RemoveBg
     CHANNELS_RGBA = "rgba"
     CHANNELS_ALPHA = "alpha"
 
-    attr_reader :api_key, :data
+    FORMAT_PNG = "png"
+    FORMAT_ZIP = "zip"
+    FORMAT_JPG = "jpg"
 
     def initialize(raw_options = {})
       options = raw_options.dup
       options[:size] ||= SIZE_AUTO
-      @api_key = resolve_api_key(options.delete(:api_key))
-      @data = options
+
+      if options.key?(:format)
+        options[:format] = optimize_format(options[:format])
+      end
+
+      super(options)
     end
 
     private
 
-    def resolve_api_key(request_api_key)
-      api_key = request_api_key || global_api_key
+    # Save bandwidth where possible
+    def optimize_format(requested_format)
+      requested_png = requested_format.to_s.casecmp?(FORMAT_PNG)
 
-      if api_key.nil? || api_key.empty?
-        raise RemoveBg::Error, <<~MSG
-          Please configure an API key or specify one per request. API key was:
-          #{api_key.inspect}
-        MSG
+      if requested_png && optimization_enabled? && can_process_images?
+        FORMAT_ZIP
+      else
+        requested_format
       end
+    end
 
-      api_key
+    def can_process_images?
+      RemoveBg::Configuration.configuration.can_process_images?
     end
 
-    def global_api_key
-      RemoveBg::Configuration.configuration.api_key
+    def optimization_enabled?
+      RemoveBg::Configuration.configuration.auto_upgrade_png_to_zip
     end
   end
 end

data/lib/remove_bg/result.rb

@@ -1,22 +1,57 @@
+require "fileutils"
+require "forwardable"
+require "zip"
 require_relative "error"
+require_relative "image_composer"
 
 module RemoveBg
+  # Provides convenience methods to save the processed image, read the image data,
+  # and access metadata such as the image height/width and credits charged.
+  #
   class Result
-    attr_reader :data, :width, :height, :credits_charged
+    extend ::Forwardable
 
-    def initialize(data:, width:, height:, credits_charged:)
-      @data = data
-      @width = width
-      @height = height
-      @credits_charged = credits_charged
+    # @return [RemoveBg::ResultMetadata]
+    attr_reader :metadata
+
+    # @return [RemoveBg::RateLimitInfo]
+    attr_reader :rate_limit
+
+    def_delegators :metadata, :type, :width, :height, :credits_charged
+
+    def initialize(download:, metadata:, rate_limit:)
+      @download = download
+      @metadata = metadata
+      @rate_limit = rate_limit
     end
 
+    # Saves the processed image to the path specified
+    # @param file_path [string]
+    # @param overwrite [boolean] Overwrite any existing file at the specified path
+    # @return [nil]
+    #
     def save(file_path, overwrite: false)
       if File.exist?(file_path) && !overwrite
         raise FileOverwriteError.new(file_path)
       end
 
-      File.write(file_path, data)
+      FileUtils.cp(image_file, file_path)
+    end
+
+    # Returns the binary data of the processed image
+    # @return [String]
+    #
+    def data
+      image_file.rewind
+      image_file.read
+    end
+
+    private
+
+    attr_reader :download
+
+    def image_file
+      download
     end
   end
 end

data/lib/remove_bg/result_metadata.rb

@@ -0,0 +1,14 @@
+require_relative "api"
+
+module RemoveBg
+  class ResultMetadata
+    attr_reader :type, :width, :height, :credits_charged
+
+    def initialize(headers)
+      @type = headers["X-Type"]
+      @width =  headers["X-Width"]&.to_i
+      @height = headers["X-Height"]&.to_i
+      @credits_charged = headers["X-Credits-Charged"]&.to_f
+    end
+  end
+end

data/lib/remove_bg/upload.rb

@@ -1,4 +1,4 @@
-require "faraday/upload_io"
+require "faraday"
 require_relative "error"
 
 module RemoveBg
@@ -9,7 +9,7 @@ module RemoveBg
       end
 
       content_type = determine_content_type(file_path)
-      Faraday::UploadIO.new(file_path, content_type)
+      FARADAY_FILE.new(file_path, content_type)
     end
 
     def self.determine_content_type(file_path)
@@ -22,5 +22,9 @@ module RemoveBg
     end
 
     private_class_method :determine_content_type
+
+    # UploadIO for Faraday < 0.16.0
+    FARADAY_FILE = defined?(Faraday::FilePart) ? Faraday::FilePart : Faraday::UploadIO
+    private_constant :FARADAY_FILE
   end
 end

data/lib/remove_bg/version.rb

@@ -1,3 +1,3 @@
 module RemoveBg
-  VERSION = "1.2.0"
+  VERSION = "1.5.0"
 end

data/remove_bg.gemspec

@@ -23,16 +23,21 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "faraday", ">= 0.14", "< 2"
+  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 "bundler", "~> 2.0"
+  spec.add_development_dependency "codecov"
   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"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "vcr_better_binary"
   spec.add_development_dependency "vcr"
   spec.add_development_dependency "webmock"
+  spec.add_development_dependency "yard"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: remove_bg
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Oliver Peate
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-12 00:00:00.000000000 Z
+date: 2020-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.15'
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
@@ -26,38 +26,78 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.15'
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
 - !ruby/object:Gem::Dependency
-  name: appraisal
+  name: image_processing
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        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: '0'
+        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: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: dotenv
   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
@@ -142,6 +182,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr_better_binary
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -170,6 +238,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - team@remove.bg
@@ -190,17 +272,24 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- gemfiles/faraday_0_14.gemfile
 - gemfiles/faraday_0_15.gemfile
-- gemfiles/faraday_1rc1.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/rate_limit_info.rb
 - lib/remove_bg/request_options.rb
 - lib/remove_bg/result.rb
+- lib/remove_bg/result_metadata.rb
 - lib/remove_bg/upload.rb
 - lib/remove_bg/url_validator.rb
 - lib/remove_bg/version.rb
@@ -227,7 +316,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Remove image background - 100% automatically