remove_bg 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c58154a3e3edc19ed8562c66f603a4965512814787e6b3d62907f7c931fec111
-  data.tar.gz: b2c773dc3f11983a95b510b7a65ce8060d318d37b30e0fec4aeaf73552cbdfa0
+  metadata.gz: 728a996008009c54dc10d72f0b0db353b1156182a8379c51ed0cf5f9fbe4b27e
+  data.tar.gz: 991a7201af58af739e73af965d082b43a0427d79878e0db2f17d13c3ac575053
 SHA512:
-  metadata.gz: f3ec05a4b3e9f55676d1dd50da5e5f148a532e15c7fce09aa65429df243769e9de47271c31567f1e90f4b16c20bbc653618dbd2b9dffe7bd6b8500dc421eb1ef
-  data.tar.gz: 3c2fbb46e300903114df2b0fcca3b6fecdeb0dd3844aace5d60de88cf88794167531456455c52b935f9626f21b1e8cf2476cf4454f95bf6d56c702cc0f49fdd7
+  metadata.gz: 2800e1a449e12e3168c7e15d9fd85b8424434ff568821600464a05d6448529e22514ab1e80cdd7c76c7a6ab91e45db01f99b7a7e7dab617d00b797f6788aa872
+  data.tar.gz: 556b0ded824694cffb639cab278eb00ffea8df314c5beee20a2565528671d8548fb856a3d14a52af73c5147f54d016b457268101046ce6c75647fb0a6b606c61

data/.circleci/config.yml

@@ -11,7 +11,10 @@ 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
@@ -43,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:
@@ -55,6 +54,10 @@ jobs:
     <<: *base_job
     docker:
       - image: circleci/ruby:2.6
+  ruby-2.7:
+    <<: *base_job
+    docker:
+      - image: circleci/ruby:2.7
 
 ################################################################################
 
@@ -62,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/CHANGELOG.md

@@ -1,5 +1,9 @@
 # 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))

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,7 +1,17 @@
+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.4.0)
+    remove_bg (1.4.1)
       faraday (>= 0.15, < 2)
       image_processing (>= 1.9, < 2)
       rubyzip (>= 2.0, < 3)
@@ -11,10 +21,6 @@ GEM
   specs:
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    appraisal (2.2.0)
-      bundler
-      rake
-      thor (>= 0.14.0)
     coderay (1.1.2)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
@@ -67,8 +73,8 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  appraisal
-  bundler (~> 1.17)
+  appraisal!
+  bundler (~> 2.0)
   dotenv
   pry
   rake
@@ -80,4 +86,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   1.17.3
+   2.1.4

data/README.md

@@ -102,6 +102,22 @@ result.save("result-with-transparency.png")
 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

data/gemfiles/faraday_0_15.gemfile

@@ -4,4 +4,8 @@ source "https://rubygems.org"
 
 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

@@ -4,4 +4,8 @@ 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

@@ -4,4 +4,8 @@ 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

@@ -4,4 +4,8 @@ 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/api.rb

@@ -10,17 +10,5 @@ module RemoveBg
 
     HEADER_API_KEY = "X-Api-Key"
     private_constant :HEADER_API_KEY
-
-    HEADER_TYPE = "X-Type"
-    private_constant :HEADER_TYPE
-
-    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

@@ -6,6 +6,8 @@ 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"
@@ -39,6 +41,8 @@ module RemoveBg
 
     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|
@@ -83,12 +87,15 @@ module RemoveBg
     end
 
     def handle_http_error(response:, body:)
+      error_message = parse_error_message(body)
+
       case response.status
+      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(body)
         raise RemoveBg::ClientHttpError.new(error_message, response, body)
       when 500..599
-        error_message = parse_error_message(body)
         raise RemoveBg::ServerHttpError.new(error_message, response, body)
       else
         raise RemoveBg::HttpError.new("An unknown error occurred", response, body)
@@ -98,10 +105,8 @@ module RemoveBg
     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,
+        metadata: ResultMetadata.new(headers),
+        rate_limit: RateLimitInfo.new(headers)
       )
     end
 

data/lib/remove_bg/composite_result.rb

@@ -18,18 +18,17 @@ module RemoveBg
 
     def composite_file
       @composite_file ||= begin
-        Tempfile.new(["composed", ".png"]).tap do |file|
-          compose_to_file(file)
-        end
+        binary_tempfile(["composed", ".png"])
+          .tap { |file| compose_to_file(file) }
       end
     end
 
     def color_file
-      @color_file ||= Tempfile.new(["color", ".jpg"])
+      @color_file ||= binary_tempfile(["color", ".jpg"])
     end
 
     def alpha_file
-      @alpha_file ||= Tempfile.new(["alpha", ".png"])
+      @alpha_file ||= binary_tempfile(["alpha", ".png"])
     end
 
     def compose_to_file(destination)
@@ -48,5 +47,9 @@ module RemoveBg
         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/error.rb

@@ -14,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/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/result.rb

@@ -1,18 +1,21 @@
 require "fileutils"
+require "forwardable"
 require "zip"
 require_relative "error"
 require_relative "image_composer"
 
 module RemoveBg
   class Result
-    attr_reader :type, :width, :height, :credits_charged
+    extend ::Forwardable
 
-    def initialize(download:, type:, width:, height:, credits_charged:)
+    attr_reader :metadata, :rate_limit
+
+    def_delegators :metadata, :type, :width, :height, :credits_charged
+
+    def initialize(download:, metadata:, rate_limit:)
       @download = download
-      @type = type
-      @width = width
-      @height = height
-      @credits_charged = credits_charged
+      @metadata = metadata
+      @rate_limit = rate_limit
     end
 
     def save(file_path, overwrite: false)

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/version.rb

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

data/remove_bg.gemspec

@@ -27,8 +27,7 @@ Gem::Specification.new do |spec|
   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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: remove_bg
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Oliver Peate
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-20 00:00:00.000000000 Z
+date: 2020-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -70,34 +70,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  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: 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
@@ -244,8 +230,10 @@ files:
 - 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
@@ -272,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