remove_bg 1.2.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc4012fc81007849a4d6cbfb9dd839d079991b34e441a987564b69d84887c1c1
-  data.tar.gz: 990aad3bda51bae6df1899df3064f874993e59f3b47e44f9b34f3fd7f875036c
+  metadata.gz: 47f8cd273ddfe8639badf0fd59050342af16e542a508162f77fbec7b7a2a5dd4
+  data.tar.gz: 5adcc396f765f7a4858e7c7c4d82d7610b5d42e2200401be29b5ea543f5fdc88
 SHA512:
-  metadata.gz: 1ae8f6ae4b188346c490887d47c541a155c0bafc650ca90fda42a250db4f05485a061ca63ca4c48ddf4ed09c3ae664cfde1cb49b1a3c5aa7916c35d04fb391f4
-  data.tar.gz: cd9ad405b78632a09053a33cdc2a1b3431f068758299329a64fe236c6d5e53e7790aea453b32a3b3e9bc8d97cc2ce9efe1f3e766c4ca025416a2d7ef6e6a8623
+  metadata.gz: 4ad4065335850911ee8b45604ed0de465742bdf183078d0ae4e9de52fb1f77519d4d9bd5aa7a042d04e9c0960a8af4f3d0e84cfdb49c6ae48e773626c6ad9639
+  data.tar.gz: a265d257a9e77bd9d87b9ef42c2aff4b0d7b8b7b3482a8717a44b4d3192c5064b0e4e67e62b9d513ecbb67e317c8b470db19194b350ade66d73b602b6ec9a7c8

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,12 @@ jobs:
     <<: *base_job
     docker:
       - image: circleci/ruby:2.6
+  ruby-2.7:
+    <<: *base_job
+    environment:
+      UPLOAD_COVERAGE: 1
+    docker:
+      - image: circleci/ruby:2.7
 
 ################################################################################
 
@@ -56,6 +67,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,11 +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
 
-appraise "faraday-1rc1" do
-  gem "faraday", "1.0.0.pre.rc1"
+# Latest in Faraday 1.x series
+appraise "faraday-1-x" do
+  gem "faraday", "~> 1.0"
 end

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+## Unreleased
+
+## 1.5.0
+
+- Auto-detect any available image processing libraries
+- Reduce bandwidth usage by using ZIP format where possible
+
+## 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`)

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,73 +1,107 @@
+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.2.0)
-      faraday (>= 0.14, < 2)
+    remove_bg (1.5.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)
-    appraisal (2.2.0)
-      bundler
-      rake
-      thor (>= 0.14.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    codecov (0.1.16)
+      json
+      simplecov
+      url
     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)
+    docile (1.3.2)
+    dotenv (2.7.5)
+    faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
-    hashdiff (0.3.8)
-    method_source (0.9.2)
+    ffi (1.13.1)
+    hashdiff (1.0.1)
+    image_processing (1.11.0)
+      mini_magick (>= 4.9.5, < 5)
+      ruby-vips (>= 2.0.17, < 3)
+    json (2.3.0)
+    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.2)
       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)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    thor (1.0.1)
+    url (0.3.2)
+    vcr (5.1.0)
+    vcr_better_binary (0.1.0)
+      vcr (~> 5.0)
+    webmock (3.8.3)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
-      hashdiff
+      hashdiff (>= 0.4.0, < 2.0.0)
+    yard (0.9.25)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  appraisal
-  bundler (~> 1.17)
+  appraisal!
+  bundler (~> 2.0)
+  codecov
   dotenv
   pry
-  rake (~> 12.0)
+  rake
   remove_bg!
   rspec (~> 3.8)
   rspec-with_params
   rspec_junit_formatter
+  simplecov
   vcr
+  vcr_better_binary
   webmock
+  yard
 
 BUNDLED WITH
-   1.17.3
+   2.1.4

data/README.md

@@ -2,16 +2,58 @@
 
 # Ruby library
 
-[![CircleCI](https://circleci.com/gh/remove-bg/ruby/tree/master.svg?style=shield)](https://circleci.com/gh/remove-bg/ruby/tree/master) [![Gem Version](https://badge.fury.io/rb/remove_bg.svg)](https://rubygems.org/gems/remove_bg)
+[![CircleCI](https://circleci.com/gh/remove-bg/ruby/tree/master.svg?style=shield)](https://circleci.com/gh/remove-bg/ruby/tree/master) [![Gem Version](https://badge.fury.io/rb/remove_bg.svg)](https://rubygems.org/gems/remove_bg) [![codecov](https://codecov.io/gh/remove-bg/ruby/branch/master/graph/badge.svg)](https://codecov.io/gh/remove-bg/ruby)
 
-## Installation
+## Quickstart installation
 
-- Add `gem "remove_bg"` to your application's Gemfile and then execute `bundle`.
-- Or install it yourself as: `gem install remove_bg`
+Add the gem to your `Gemfile` and run `bundle install`:
 
-## Usage
+```
+gem "remove_bg"
+```
+
+Or run `gem install remove_bg` to install globally.
+
+Please note the base configuration has the following resolution limits:
+
+| Output format | Resolution limit |
+|---------------|------------------|
+| PNG           | 10 megapixels    |
+| JPG           | 25 megapixels    |
+
+## Full installation
 
-### Configuring an API key
+For best performance and quality the gem requires an image processing library.
+Please install one of the following libraries:
+
+- [ImageMagick](https://www.imagemagick.org/)
+- [GraphicsMagick](http://www.graphicsmagick.org/)
+- [libvips](http://libvips.github.io/libvips/)
+
+The gem will auto-detect any image processing libraries present. However you may
+prefer to explicitly configure which library to use:
+
+```ruby
+RemoveBg.configure do |config|
+  config.image_processor = :minimagick # For ImageMagick or GraphicsMagick
+  # or
+  config.image_processor = :vips
+end
+```
+
+The full installation has the following resolution limits:
+
+| Output format | Resolution limit |
+|---------------|------------------|
+| PNG           | 25 megapixels    |
+| JPG           | 25 megapixels    |
+| ZIP           | 25 megapixels    |
+
+# Usage
+
+For more in-depth documentation please see [RubyDoc](https://www.rubydoc.info/gems/remove_bg)
+
+## Configuring an API key
 
 To configure a global API key (used by default unless overridden per request):
 
@@ -25,7 +67,7 @@ It's not recommended to commit your API key to version control. You may want to
 read the API key from an environment variable (e.g.
 `ENV.fetch("REMOVE_BG_API_KEY")`) or find an alternative method.
 
-### Removing the background from an image
+## Removing the background from an image
 
 Currently the gem supports removing the background from a file or a URL:
 
@@ -34,7 +76,7 @@ RemoveBg.from_file("image.png")
 RemoveBg.from_url("http://example.com/image.png")
 ```
 
-#### Request options
+## Request options
 
 The processing options outlined in the [API reference](https://www.remove.bg/api)
 can be specified per request:
@@ -49,7 +91,7 @@ The API key can also be specified per request:
 RemoveBg.from_file("image.png", api_key: "<api-key>")
 ```
 
-#### Handling the result
+## Handling the result
 
 Background removal requests return a result object which includes the processed
 image data and the metadata about the operation.
@@ -69,6 +111,54 @@ result.save("processed/image.png")
 result.save("image.png", overwrite: true) # Careful!
 ```
 
+## Producing transparent images over 10 megapixels
+
+After configuring a full installation (detailed above) you can process images
+over 10 megapixels with a transparent output.
+
+Process images with either the `png` or `zip` format. If you specify the `zip`
+format it's possible to save the archive and handle composition yourself.
+
+```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
@@ -85,11 +175,22 @@ Bug reports and pull requests are welcome on GitHub at [remove-bg/ruby](https://
 
 ## Development
 
+### Setup
+
 After checking out the repo, run `bin/setup` to install dependencies. Then, run
 `rake spec` to run the tests.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To
-release a new version, update the version number in `version.rb`, and then run
+### Releasing a new version
+To release a new version, update the version number in `version.rb`, and then run
 `bundle exec rake release`, which will create a git tag for the version, push
 git commits and tags, and push the `.gem` file to
 [rubygems.org](https://rubygems.org).
+
+### Documentation
+
+To preview the [YARD documentation](https://yardoc.org/) locally run:
+
+```
+bundle exec yard server --reload
+open http://localhost:8808/
+```

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: "../"