remove_bg 1.1.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53e08a36b9ec04edb670f7b74247d833adad68018814827a8d245f9999f1703e
-  data.tar.gz: b75d1b644f844171f96bff2b4c3aaa03d9b8a142f23be296b5a5c26d7049d2b8
+  metadata.gz: 728a996008009c54dc10d72f0b0db353b1156182a8379c51ed0cf5f9fbe4b27e
+  data.tar.gz: 991a7201af58af739e73af965d082b43a0427d79878e0db2f17d13c3ac575053
 SHA512:
-  metadata.gz: f071a1349b53f58f0938299e3302ba07f52aadbf9bb0063f0432e8096a164a35a51a4773a315da4728c58861b9b8224cd56ef1b0d996b90b086d907a923f7c05
-  data.tar.gz: 85f00a91ac0bdea9b4080213a3bfbd221a66379a8377fc0cad2ed993cf8127dd18ee480f5c1b8bd24ff19503d63a7e9dd7e0b8102d871fe0716ea91378da5eb6
+  metadata.gz: 2800e1a449e12e3168c7e15d9fd85b8424434ff568821600464a05d6448529e22514ab1e80cdd7c76c7a6ab91e45db01f99b7a7e7dab617d00b797f6788aa872
+  data.tar.gz: 556b0ded824694cffb639cab278eb00ffea8df314c5beee20a2565528671d8548fb856a3d14a52af73c5147f54d016b457268101046ce6c75647fb0a6b606c61

data/.circleci/config.yml

@@ -11,7 +11,16 @@ base_job: &base_job
 
     - run:
         name: install dependencies
-        command: bundle install --jobs=4 --retry=3 --path vendor/bundle
+        command: |
+          gem install bundler --version '~> 2.0'
+          bundle config set path vendor/bundle
+          bundle install --jobs=4 --retry=3
+
+    - run:
+        name: install image processsing dependencies
+        command: |
+          sudo apt-get update
+          sudo apt install imagemagick libvips
 
     - save_cache:
         paths:
@@ -37,10 +46,6 @@ base_job: &base_job
 ################################################################################
 
 jobs:
-  ruby-2.4:
-    <<: *base_job
-    docker:
-      - image: circleci/ruby:2.4
   ruby-2.5:
     <<: *base_job
     docker:
@@ -49,6 +54,10 @@ jobs:
     <<: *base_job
     docker:
       - image: circleci/ruby:2.6
+  ruby-2.7:
+    <<: *base_job
+    docker:
+      - image: circleci/ruby:2.7
 
 ################################################################################
 
@@ -56,6 +65,6 @@ workflows:
   version: 2
   multiple-rubies:
     jobs:
-      - ruby-2.4
       - ruby-2.5
       - ruby-2.6
+      - ruby-2.7

data/.gitignore

@@ -18,3 +18,5 @@ test-results
 gemfiles/*.gemfile.lock
 
 examples/output
+
+.ruby-version

data/Appraisals

@@ -1,7 +1,17 @@
-appraise "faraday-0-14" do
-  gem "faraday", "~> 0.14"
+# Oldest supported Faraday version
+appraise "faraday-0-15" do
+  gem "faraday", "~> 0.15.0"
 end
 
-appraise "faraday-0-15" do
-  gem "faraday", "~> 0.15"
+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
+appraise "faraday-1-x" do
+  gem "faraday", "~> 1.0"
 end

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## 1.4.1
+
+- Fixes binary encoding issue - via [#15](https://github.com/remove-bg/ruby/pull/15)
+
+## 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)
+- Fix support for Faraday `1.0` - via [#7](https://github.com/remove-bg/ruby/pull/7)
+- Raise minimum Faraday version to `0.15.0`
+
+## 1.2.1
+
+- Add `type` attribute to result object (`X-Type` header from API) - via [#2](https://github.com/remove-bg/ruby/pull/2)
+
+## 1.2.0
+
+- Support uppercase file extensions (e.g. `.JPG`)
+- Add Faraday 1.0 support (currently RC1)
+
 ## 1.1.0
 
 - Support 'credits charged' as a float (API change)

data/Gemfile

@@ -1,3 +1,7 @@
 source "https://rubygems.org"
 
 gemspec
+
+group :development do
+  gem "appraisal", git: "https://github.com/thoughtbot/appraisal.git", ref: "5868643"
+end

data/Gemfile.lock

@@ -1,70 +1,89 @@
+GIT
+  remote: https://github.com/thoughtbot/appraisal.git
+  revision: 586864393e405a67b1457b563a4d5adc99e50e2d
+  ref: 5868643
+  specs:
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+
 PATH
   remote: .
   specs:
-    remove_bg (1.1.0)
-      faraday (~> 0.14)
+    remove_bg (1.4.1)
+      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)
-    appraisal (2.2.0)
-      bundler
-      rake
-      thor (>= 0.14.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     coderay (1.1.2)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
-    dotenv (2.7.1)
-    faraday (0.15.4)
+    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
 
 DEPENDENCIES
-  appraisal
-  bundler (~> 1.17)
+  appraisal!
+  bundler (~> 2.0)
   dotenv
   pry
-  rake (~> 12.0)
+  rake
   remove_bg!
   rspec (~> 3.8)
+  rspec-with_params
   rspec_junit_formatter
   vcr
   webmock
 
 BUNDLED WITH
-   1.17.3
+   2.1.4

data/README.md

@@ -69,6 +69,71 @@ 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
+```
+
+#### Rate limits
+
+The [API has rate limits][rate-limits]. Image processing results include the
+rate limit information:
+
+```ruby
+result = RemoveBg.from_file("image.jpg")
+result.rate_limit.to_s
+# => <RateLimit reset_at='2020-05-20T12:00:00Z' total=500 remaining=499 retry_after_seconds=nil>
+```
+
+If you exceed the rate limit a `RemoveBg::RateLimitError` exception will be
+raised. This also contains further information via the `#rate_limit` method.
+
+[rate-limits]: https://www.remove.bg/api#rate-limit
+
+### Fetching account information
+
+To display the [account information][account-info] for the currently configured
+API key:
+
+[account-info]: https://www.remove.bg/api#operations-tag-Fetch_account_info
+
+```ruby
+account = RemoveBg.account_info # If an API key is set via RemoveBg.configuration
+# or
+account = RemoveBg.account_info(api_key: "<api_key>")
+
+account.api.free_calls # => 50
+account.credits.total  # => 200
+```
+
 ## Examples
 
 - [Bulk processing][bulk-processing] a directory of JPG and PNG files

data/gemfiles/faraday_0_15.gemfile

@@ -2,6 +2,10 @@
 
 source "https://rubygems.org"
 
-gem "faraday", "~> 0.15"
+gem "faraday", "~> 0.15.0"
+
+group :development do
+  gem "appraisal", git: "https://github.com/thoughtbot/appraisal.git", ref: "5868643"
+end
 
 gemspec path: "../"

data/gemfiles/faraday_0_16.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "faraday", "~> 0.16.0"
+
+group :development do
+  gem "appraisal", git: "https://github.com/thoughtbot/appraisal.git", ref: "5868643"
+end
+
+gemspec path: "../"

data/gemfiles/faraday_0_17.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "faraday", "~> 0.17.0"
+
+group :development do
+  gem "appraisal", git: "https://github.com/thoughtbot/appraisal.git", ref: "5868643"
+end
+
+gemspec path: "../"

data/gemfiles/faraday_1_x.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "faraday", "~> 1.0"
+
+group :development do
+  gem "appraisal", git: "https://github.com/thoughtbot/appraisal.git", ref: "5868643"
+end
+
+gemspec path: "../"

data/lib/remove_bg.rb

@@ -14,6 +14,11 @@ module RemoveBg
     ApiClient.new.remove_from_url(image_url, options)
   end
 
+  def self.account_info(raw_options = {})
+    options = RemoveBg::BaseRequestOptions.new(raw_options)
+    ApiClient.new.account_info(options)
+  end
+
   def self.configure
     yield RemoveBg::Configuration.configuration
   end

data/lib/remove_bg/account_info.rb

@@ -0,0 +1,30 @@
+module RemoveBg
+  class AccountInfo
+    attr_reader :api, :credits
+
+    def initialize(attributes)
+      @api = ApiInfo.new(**attributes.fetch(:api))
+      @credits = CreditsInfo.new(**attributes.fetch(:credits))
+    end
+
+    class ApiInfo
+      attr_reader :free_calls, :sizes
+
+      def initialize(free_calls:, sizes:)
+        @free_calls = free_calls
+        @sizes = sizes
+      end
+    end
+
+    class CreditsInfo
+      attr_reader :total, :subscription, :payg, :enterprise
+
+      def initialize(total:, subscription:, payg:, enterprise:)
+        @total = total
+        @subscription = subscription
+        @payg = payg
+        @enterprise = enterprise
+      end
+    end
+  end
+end

data/lib/remove_bg/api.rb

@@ -2,19 +2,13 @@ module RemoveBg
   module Api
     URL = "https://api.remove.bg"
 
+    V1_ACCOUNT = "/v1.0/account"
+    private_constant :V1_ACCOUNT
+
     V1_REMOVE_BG = "/v1.0/removebg"
     private_constant :V1_REMOVE_BG
 
     HEADER_API_KEY = "X-Api-Key"
     private_constant :HEADER_API_KEY
-
-    HEADER_WIDTH = "X-Width"
-    private_constant :HEADER_WIDTH
-
-    HEADER_HEIGHT = "X-Height"
-    private_constant :HEADER_HEIGHT
-
-    HEADER_CREDITS_CHARGED = "X-Credits-Charged"
-    private_constant :HEADER_CREDITS_CHARGED
   end
 end

data/lib/remove_bg/api_client.rb

@@ -1,7 +1,13 @@
 require "json"
+require "tempfile"
+
+require_relative "account_info"
 require_relative "api"
+require_relative "composite_result"
 require_relative "error"
 require_relative "http_connection"
+require_relative "rate_limit_info"
+require_relative "result_metadata"
 require_relative "result"
 require_relative "upload"
 require_relative "url_validator"
@@ -25,44 +31,107 @@ module RemoveBg
       request_remove_bg(data, options.api_key)
     end
 
+    def account_info(options)
+      request_account_info(options.api_key)
+    end
+
     private
 
     attr_reader :connection
 
     def request_remove_bg(data, api_key)
+      download = Tempfile.new("remove-bg-download")
+      download.binmode
+
+      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(headers: response.headers, download: download)
+      else
+        response_body = download.read
+        download.close
+        download.unlink
+        handle_http_error(response: response, body: response_body)
+      end
+    end
+
+    def request_account_info(api_key)
+      response = connection.get(V1_ACCOUNT) do |req|
+        req.headers[HEADER_API_KEY] = api_key
       end
 
+      if response.status == 200
+        parse_account_result(response)
+      else
+        handle_http_error(response: response, body: response.body)
+      end
+    end
+
+    def handle_http_error(response:, body:)
+      error_message = parse_error_message(body)
+
       case response.status
-      when 200
-        parse_result(response)
+      when 429
+        rate_limit = RateLimitInfo.new(response.headers)
+        raise RemoveBg::RateLimitError.new(error_message, response, body, rate_limit)
       when 400..499
-        error_message = parse_error_message(response)
-        raise RemoveBg::ClientHttpError.new(error_message, response)
+        raise RemoveBg::ClientHttpError.new(error_message, response, body)
       when 500..599
-        error_message = parse_error_message(response)
-        raise RemoveBg::ServerHttpError.new(error_message, response)
+        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_result(response)
-      RemoveBg::Result.new(
-        data: response.body,
-        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,
+        metadata: ResultMetadata.new(headers),
+        rate_limit: RateLimitInfo.new(headers)
       )
     end
 
-    def parse_error_message(response)
-      parse_errors(response).first["title"]
+    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)
+        .fetch(:attributes)
+
+      RemoveBg::AccountInfo.new(attributes)
+    end
+
+    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/base_request_options.rb

@@ -0,0 +1,32 @@
+require_relative "error"
+
+module RemoveBg
+  class BaseRequestOptions
+    attr_reader :api_key, :data
+
+    def initialize(raw_options = {})
+      options = raw_options.dup
+      @api_key = resolve_api_key(options.delete(:api_key))
+      @data = options
+    end
+
+    private
+
+    def resolve_api_key(request_api_key)
+      api_key = request_api_key || global_api_key
+
+      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
+      end
+
+      api_key
+    end
+
+    def global_api_key
+      RemoveBg::Configuration.configuration.api_key
+    end
+  end
+end

data/lib/remove_bg/composite_result.rb

@@ -0,0 +1,55 @@
+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
+        binary_tempfile(["composed", ".png"])
+          .tap { |file| compose_to_file(file) }
+      end
+    end
+
+    def color_file
+      @color_file ||= binary_tempfile(["color", ".jpg"])
+    end
+
+    def alpha_file
+      @alpha_file ||= binary_tempfile(["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
+
+    def binary_tempfile(basename)
+      Tempfile.new(basename).tap { |file| file.binmode }
+    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
@@ -13,6 +14,15 @@ module RemoveBg
   class ClientHttpError < HttpError; end
   class ServerHttpError < HttpError; end
 
+  class RateLimitError < ClientHttpError
+    attr_reader :rate_limit
+
+    def initialize(message, http_response, http_response_body, rate_limit)
+      @rate_limit = rate_limit
+      super(message, http_response, http_response_body)
+    end
+  end
+
   class FileError < Error
     attr_reader :file_path
 

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/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,7 @@
-require_relative "error"
+require_relative "base_request_options"
 
 module RemoveBg
-  class RequestOptions
+  class RequestOptions < BaseRequestOptions
     SIZE_REGULAR = "regular"
     SIZE_MEDIUM = "medium"
     SIZE_HD = "hd"
@@ -15,32 +15,10 @@ module RemoveBg
     CHANNELS_RGBA = "rgba"
     CHANNELS_ALPHA = "alpha"
 
-    attr_reader :api_key, :data
-
     def initialize(raw_options = {})
       options = raw_options.dup
       options[:size] ||= SIZE_AUTO
-      @api_key = resolve_api_key(options.delete(:api_key))
-      @data = options
-    end
-
-    private
-
-    def resolve_api_key(request_api_key)
-      api_key = request_api_key || global_api_key
-
-      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
-      end
-
-      api_key
-    end
-
-    def global_api_key
-      RemoveBg::Configuration.configuration.api_key
+      super(options)
     end
   end
 end

data/lib/remove_bg/result.rb

@@ -1,14 +1,21 @@
+require "fileutils"
+require "forwardable"
+require "zip"
 require_relative "error"
+require_relative "image_composer"
 
 module RemoveBg
   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
+    attr_reader :metadata, :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
 
     def save(file_path, overwrite: false)
@@ -16,7 +23,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/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,11 +9,11 @@ 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)
-      case File.extname(file_path)
+      case File.extname(file_path).downcase
       when ".jpg", ".jpeg" then "image/jpeg"
       when ".png" then "image/png"
       else
@@ -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.1.0"
+  VERSION = "1.4.1"
 end

data/remove_bg.gemspec

@@ -23,14 +23,16 @@ 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"
+  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 "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 "vcr"
   spec.add_development_dependency "webmock"

metadata

@@ -1,57 +1,89 @@
 --- !ruby/object:Gem::Specification
 name: remove_bg
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Oliver Peate
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-29 00:00:00.000000000 Z
+date: 2020-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.15'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.15'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        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: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +116,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
@@ -108,6 +140,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-with_params
+  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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -170,16 +216,24 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- gemfiles/faraday_0_14.gemfile
 - gemfiles/faraday_0_15.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
@@ -206,7 +260,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Remove image background - 100% automatically

data/gemfiles/faraday_0_14.gemfile

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