remove_bg 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ef796828448e7ea7be4a637c714439ee0cc13a3fcd018a6789fbf36761b3b8d
-  data.tar.gz: c0ce6e0782c56318c92f83263c5c99ee13923248b680af9db3bb9d5e18650da4
+  metadata.gz: 85d740935b627c71987091c6b9476d49a17fa2a63cea2844f53a3bb0e7d9621b
+  data.tar.gz: d9ff54349e69003ecea536d4b669ca4479d4a7cd1c0e2a8577e0b8467cbbcdb2
 SHA512:
-  metadata.gz: 8df9c7d09a27bf7a8ad83cddaebebb497cc13970db2779a578bc815b7637c94c61a49229efd3eae0e009c2f25171327f83890dff4a8cad6d34bf47677f1850a2
-  data.tar.gz: fb007096bffd1f48d65ffa8db7a38ff6c6b60d2c3804d6b8ec4e941b607cabc40d900ef9fd275976369e924ef14421fac46b32228007a4b0b1b191d72283765f
+  metadata.gz: 18b21fbf48e49447b44eb950b5846e3de1e3ebf52c49aae4ae207870a8367aad61d7eded97709e371c06538830c9a73e86f4af7d7106c62c66d938a86a525bae
+  data.tar.gz: '079fb2498670102258b88d47d93a665ee47b318b8b307316b8c093f3e47572ec975c814c9d4f237d48dc38e5a196ade29eaa4452db976ed7a238487a3ec6878c'

data/Appraisals

@@ -1,11 +1,14 @@
-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"
+# Latest in Faraday 0.x series
+appraise "faraday-0-x" do
+  gem "faraday", ">= 0.15", "<= 1.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,11 @@
 # Changelog
 
+## 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)

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    remove_bg (1.2.1)
-      faraday (>= 0.14, < 2)
+    remove_bg (1.3.0)
+      faraday (>= 0.15, < 2)
 
 GEM
   remote: https://rubygems.org/
@@ -18,7 +18,7 @@ GEM
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
     dotenv (2.7.1)
-    faraday (0.17.0)
+    faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
     hashdiff (0.3.8)
     method_source (0.9.2)

data/README.md

@@ -69,6 +69,22 @@ result.save("processed/image.png")
 result.save("image.png", overwrite: true) # Careful!
 ```
 
+### 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,6 @@
 
 source "https://rubygems.org"
 
-gem "faraday", "~> 0.15"
+gem "faraday", "~> 0.15.0"
 
 gemspec path: "../"

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

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

data/gemfiles/{faraday_0_14.gemfile → faraday_1_x.gemfile}

@@ -2,6 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "faraday", "~> 0.14"
+gem "faraday", "~> 1.0"
 
 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,6 +2,9 @@ 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
 

data/lib/remove_bg/api_client.rb

@@ -1,4 +1,5 @@
 require "json"
+require_relative "account_info"
 require_relative "api"
 require_relative "error"
 require_relative "http_connection"
@@ -25,6 +26,10 @@ 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
@@ -34,9 +39,27 @@ module RemoveBg
         req.headers[HEADER_API_KEY] = api_key
       end
 
+      if response.status == 200
+        parse_image_result(response)
+      else
+        handle_http_error(response)
+      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)
+      end
+    end
+
+    def handle_http_error(response)
       case response.status
-      when 200
-        parse_result(response)
       when 400..499
         error_message = parse_error_message(response)
         raise RemoveBg::ClientHttpError.new(error_message, response)
@@ -48,7 +71,7 @@ module RemoveBg
       end
     end
 
-    def parse_result(response)
+    def parse_image_result(response)
       RemoveBg::Result.new(
         data: response.body,
         type: response.headers[HEADER_TYPE],
@@ -58,6 +81,14 @@ module RemoveBg
       )
     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)
       parse_errors(response).first["title"]
     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/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/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.1"
+  VERSION = "1.3.0"
 end

data/remove_bg.gemspec

@@ -23,7 +23,7 @@ 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_development_dependency "appraisal"
   spec.add_development_dependency "bundler", "~> 1.17"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: remove_bg
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Oliver Peate
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-08 00:00:00.000000000 Z
+date: 2020-05-07 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,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.15'
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
@@ -190,12 +190,14 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- gemfiles/faraday_0_14.gemfile
 - gemfiles/faraday_0_15.gemfile
-- gemfiles/faraday_1rc1.gemfile
+- gemfiles/faraday_0_x.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/configuration.rb
 - lib/remove_bg/error.rb
 - lib/remove_bg/http_connection.rb
@@ -227,7 +229,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Remove image background - 100% automatically