increase 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5ebc261a44d0f2a6df7fc703886dcc18e11a3c54bd2f04742b783e46fedc1f7
-  data.tar.gz: '073485629ad76bc387aa0a51d954a86bb93c9884bd90baccedeaa2cbf483efaa'
+  metadata.gz: 9520a7eb024d05477e162e1158a07f54167a6a89297f44d3a71caa01a40599cf
+  data.tar.gz: 273bb964f85fb97660212f6a2046a58caf4e7302d07859fe3d562afe8269922d
 SHA512:
-  metadata.gz: c2b625211c3e9ad0a7588caaeda4eaea8e216569e3efd2f83afaf48d0c8fed23794d0f8a0d4bdab6a0024115836cab51979a4731ea2fc0d4400de1967e0d9c93
-  data.tar.gz: ede3ef495349bf6c7cf6acacba84101061aa3740170ca3b7fea1fb4ec8e2c7e8df61b0654e9919e158c1bc033f8ef37ec4171538aeb485eae6f0c1f3cd619da5
+  metadata.gz: d4b399cda4f620ca00549831546a4992069eb17cb84f08ce9aa0039744e7d3ea4868dd3498ee593c001678633bf708a6e8257ee093f75922996c0f1012f9aa6d
+  data.tar.gz: bfd03c310aaf256d89228e6bcd0da10e3505004ab958c10c30baa51dd6df1c22d09ca974bcd61def524888dc9203a00fef78a51082991d2dd3aa8701f6060294

data/CHANGELOG.md

@@ -0,0 +1,90 @@
+# Changelog
+
+## [0.3.1] - 2023-03-23
+
+### Enhancements
+
+- Support Faraday >= 1.0.1 (https://github.com/garyhtou/increase-ruby/pull/8)
+
+
+## [0.3.0] - 2023-03-23
+
+### Enhancements
+
+- Better developer experience for file uploads (9fc40df62a537ed3402a0c0deb5bee908d84b671)
+
+### Documentation
+
+- Pin gem version in install command (2127f5a04be8832ba5c5c42476e2844fb6ca9c24)
+- Update README to reflect new file upload DX (9fc40df62a537ed3402a0c0deb5bee908d84b671)
+
+
+## [0.2.0] - 2023-03-21
+
+### Enhancements
+
+- Made webhook verification `verify` raise an error, but `verify?` return a bool (58d462fc648cafdcfdb7b8d2c0e0ec1f45362984)
+- Wrote a generator to generate API resource classes from the OpenAPI spec (8eedc2d4a5daecd97c156546c649f27376eb9762)
+- Added all API resources (2a04096dea06a34ba8ff1d5061475ed1a2354ac2)
+- Supported getting response from `list` operation (a2141f034a4f29cfee0222a4fac32949581adbc6)
+
+### Fixes
+
+- Use `ArgumentError` when unknown config passed to `Configuration` (cdd0703febd6f9dec0ecd4ac34fe465697edbf08)
+- File uploads! Increase::Files.create now works (236cad5011b996b40793abe85698ba47fa1ba3f8)
+
+### Documentation
+
+- Updated error handling example to be more clear (85d8d6ff102a8ef502040322537b79085f89779d)
+- Fixed idempotency example (343ae6d4cb1b8216192e2f820836ca87cc3a9a36)
+- Added example for passing hash to `with_config` (b82fac134c813d03a31466e83341acc891c1deb6)
+- Updated Rails config example to use Rails credentials (2b4fec9c1d52d04e42760a9889ba1cb313b5bd18)
+- Added list filtering example (6333f982062b2527f676a6aade4e5abf01a7816b)
+- Added table of contents (88e9b6ae05aaa62974514a6c318f35e708e49fb5)
+- Added full example for Idempotency keys (6d5ce8bdd3d4baf13c4d0800a159c784bc1bdc78)
+- Added manual pagination example using `next_cursor` (57157e2965904c9150676696e8567b5518892945)
+
+
+## [0.1.3] - 2023-03-20
+
+### Enhancements
+
+- Added `Limits` resource (98654433812b202ecfd31ba35d520981529f2e2b)
+- Added `CheckTransfers` resource (a899c9ca6206af78df23ba8b62c8dfc88b7fc22d)
+- Added `RoutingNumbers` resource (209e7f279a1ff648142ac6aca6cfe946fc653845)
+
+### Documentation
+
+- Added section about webhook signature verification (650aed416ab820ed55f0ed8936f201274964fc37)
+- Added section about Rails configuration (650aed416ab820ed55f0ed8936f201274964fc37)
+
+## [0.1.2] - 2023-03-20
+
+### Enhancements
+
+- Added webhook verification support (ce193fb8888d497817ab5551bf8e9096c5bf7e26)
+- Added user agent to requests (ce44249ead32ba4055b13ba576f0b91f20493cfc)
+- Update supported Ruby version to >= 2.7.4 (c404f8ddc4762615bac660edabf0385716b4bd74)
+
+### Fixes
+
+- Always apply default configuration options (079f0ca603a80dd2c9523df23244b64e2e0a5772)
+
+### Documentation
+
+- Wrote the README! (aa7c778834cd268ab1318e44fceea0b062a5c5df)
+
+
+## [0.1.1] - 2023-03-19
+
+### Enhancements
+- Added client-wide configuration options (c47e32c93371b43f2e0a3ac49525e46fbe9ef326)
+- Load `INCREASE_API_KEY` and `INCREASE_BASE_URL` from environment variables (2e6cbe21a2b37c230dc3f2382613b98ffc3ea4d8, 24cea582c03b64018ed2f0997f99f4bae581a1fa, 4a80e4263c7917bbfa1371c70752476d7f7f0695)
+- Added the following API resources:
+  - `AccountNumbers` (209b155c0fa3977c2c19602a2239c8b27001935e)
+  - `AccountTransfers` (6065a932522bd582aa4f177037a5eca8e5d1647d)
+  - `AchTransfers` (caef61c36bfffc780016880959f067b59bfa288e)
+  - `Cards` (b58bccc8aab00fd2ee69f2973898e6a13c1b2544)
+  - `Events` (dd3312638227be47f04c8bd740c3dd25104959e7)
+  - `PendingTransactions` (b6f4b2c02a9108603b4d1feee9a39c1a7f1086ef)
+  - `Transaction` (b6f4b2c02a9108603b4d1feee9a39c1a7f1086ef)

data/README.md

@@ -19,14 +19,14 @@ Bare-Metal Banking APIs!
 Install the gem and add to the application's Gemfile by executing:
 
 ```sh
-$ bundle add increase
+$ bundle add increase -v 0.3.1
 ```
 
 If bundler is not being used to manage dependencies, install the gem by
 executing:
 
 ```sh
-$ gem install increase
+$ gem install increase -v 0.3.1
 ```
 
 ## Usage
@@ -204,21 +204,43 @@ end
 
 ### File Uploads
 
+It's as simple as passing in a file path!
+
+```ruby
+Increase::Files.create(
+  purpose: 'identity_document',
+  file: '/path/to/file.jpg'
+) 
+```
+
+Alternatively, you can pass in a `File` object.
+
+```ruby
+file = File.open('/path/to/file.jpg')
+
+Increase::Files.create(
+  purpose: 'identity_document',
+  file: file
+) 
+```
+
+Or, get even fancier and use `Increase::FileUpload` to specify the content type
+and filename.
+
 ```ruby
-# Creating a file of an image of a government-issued ID
-file_to_upload = Faraday::Multipart::FilePart.new(
-  '/path/to/file.jpg', # File path
-  'image/jpeg' # File name
+file = Increase::FileUpload.new(
+  '/path/to/file.jpg',
+  content_type: 'image/jpeg',
+  filename: 'my_file.jpg'
 )
 
 Increase::Files.create(
   purpose: 'identity_document',
-  file: file_to_upload
+  file: file
 ) 
 ```
 
-See [`faraday-multipart`](https://github.com/lostisland/faraday-multipart)'s
-documentation for more file upload options.
+If no content type or filename is provided, the client will try to guess it.
 
 ### Webhooks
 

data/lib/increase/client.rb

@@ -1,13 +1,18 @@
 # frozen_string_literal: true
 
 require "increase/configuration"
+require "increase/middleware/raise_api_error"
 
 require "faraday"
-require "faraday/follow_redirects"
-require "faraday/multipart"
-
-# Custom Faraday Middleware to handle raising errors
-require "faraday/raise_increase_api_error"
+require "faraday/follow_redirects" # Supports both Faraday 1.0 and 2.0
+if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new("2.0")
+  # In Faraday 2.0, multipart support is no longer included by default
+  require "faraday/multipart"
+else
+  # In Faraday 1.0, the JSON middleware is not included by default
+  require "increase/middleware/encode_json"
+  require "increase/middleware/parse_json"
+end
 
 module Increase
   class Client
@@ -38,7 +43,7 @@ module Increase
         if @configuration.raise_api_errors
           # This custom middleware for raising Increase API errors must be
           # located before the JSON response middleware.
-          f.use FaradayMiddleware::RaiseIncreaseApiError
+          f.use Increase::Middleware::RaiseApiError
         end
 
         f.response :json

data/lib/increase/file_upload.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "tempfile"
+require "marcel"
+require "faraday"
+require "pathname"
+
+module Increase
+  class FileUpload
+    attr_reader :file, :filename, :content_type
+
+    def initialize(file_or_path, filename: nil, content_type: nil)
+      @filename = filename
+      @content_type = content_type
+
+      if file_or_path.is_a?(File) || file_or_path.is_a?(Tempfile)
+        @file = file_or_path
+        @filename ||= File.basename(file_or_path.path)
+      elsif file_or_path.is_a?(String)
+        # Treat string as a filepath
+        @file = File.open(file_or_path)
+        @filename ||= File.basename(file_or_path)
+      elsif file_or_path.respond_to?(:read)
+        @file = Tempfile.new(default_filename)
+        @file.write(file_or_path.read)
+      else
+        raise ArgumentError, "File or path required"
+      end
+
+      # Try to guess content type
+      @content_type ||= Marcel::MimeType.for(@file, name: @filename)
+      @filename ||= default_filename
+    end
+
+    def file_part
+      if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new("2.0")
+        Faraday::Multipart::FilePart.new(
+          @file,
+          @content_type,
+          @filename
+        )
+      else
+        Faraday::FilePart.new(
+          @file,
+          @content_type,
+          @filename
+        )
+      end
+    end
+
+    private
+
+    def default_filename
+      "file upload #{Time.now}"
+    end
+  end
+end

data/lib/increase/middleware/encode_json.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "faraday"
+
+module Increase
+  module Middleware
+    # JSON request middleware for Faraday 1.0
+    # In Faraday 2.0, the JSON middleware is bundled with the Faraday gem itself
+    #
+    # This middleware is from
+    # https://github.com/lostisland/faraday_middleware/blob/main/lib/faraday_middleware/request/encode_json.rb
+    class EncodeJson < Faraday::Middleware
+      CONTENT_TYPE = "Content-Type"
+      MIME_TYPE = "application/json"
+      MIME_TYPE_REGEX = %r{^application/(vnd\..+\+)?json$}.freeze
+
+      dependency do
+        require "json" unless defined?(::JSON)
+      end
+
+      def call(env)
+        match_content_type(env) do |data|
+          env[:body] = encode data
+        end
+        @app.call env
+      end
+
+      def encode(data)
+        ::JSON.generate data
+      end
+
+      def match_content_type(env)
+        return unless process_request?(env)
+
+        env[:request_headers][CONTENT_TYPE] ||= MIME_TYPE
+        yield env[:body] unless env[:body].respond_to?(:to_str)
+      end
+
+      def process_request?(env)
+        type = request_type(env)
+        has_body?(env) && (type.empty? || MIME_TYPE_REGEX =~ type)
+      end
+
+      def has_body?(env)
+        (body = env[:body]) && !(body.respond_to?(:to_str) && body.empty?)
+      end
+
+      def request_type(env)
+        type = env[:request_headers][CONTENT_TYPE].to_s
+        type = type.split(";", 2).first if type.index(";")
+        type
+      end
+    end
+  end
+end
+
+Faraday::Request.register_middleware(json: Increase::Middleware::EncodeJson)

data/lib/increase/middleware/parse_json.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "json"
+
+module Increase
+  module Middleware
+    # JSON response middleware for Faraday 1.0
+    # In Faraday 2.0, the JSON middleware is bundled with the Faraday gem itself
+    #
+    # This middleware is from
+    # https://github.com/jsmestad/jsonapi-consumer/blob/7d9721ea7feb888ea1e43edb9f1c0c38334762ed/lib/jsonapi/consumer/middleware/parse_json.rb
+    class ParseJson < Faraday::Middleware
+      def call(environment)
+        @app.call(environment).on_complete do |env|
+          if process_response_type?(response_type(env))
+            env[:raw_body] = env[:body]
+            env[:body] = parse(env[:body])
+          end
+        end
+      end
+
+      private
+
+      def parse(body)
+        ::JSON.parse(body) unless body.strip.empty?
+      end
+
+      def response_type(env)
+        type = env[:response_headers]["Content-Type"].to_s
+        type = type.split(";", 2).first if type.index(";")
+        type
+      end
+
+      def process_response_type?(type)
+        !!type.match(/\bjson$/)
+      end
+    end
+  end
+end
+
+Faraday::Response.register_middleware(json: Increase::Middleware::ParseJson)

data/lib/increase/middleware/raise_api_error.rb

@@ -0,0 +1,13 @@
+require "faraday"
+
+module Increase
+  module Middleware
+    class RaiseApiError < Faraday::Middleware
+      def on_complete(env)
+        return if env[:status] < 400
+
+        raise Increase::ApiError.from_response(env)
+      end
+    end
+  end
+end

data/lib/increase/resource.rb

@@ -29,7 +29,7 @@ module Increase
       with = [with].flatten.compact
 
       # TODO: This doesn't support multiple path params
-      is_id = ->(path_segment) { path_segment.is_a?(Symbol) && path_segment.to_s.end_with?('id') }
+      is_id = ->(path_segment) { path_segment.is_a?(Symbol) && path_segment.to_s.end_with?("id") }
       has_id = path.any? is_id
 
       request_method = :request
@@ -99,6 +99,7 @@ module Increase
     private
 
     def request(method, path, params = nil, headers = nil, &block)
+      params ||= {}
       headers ||= {}
 
       if block
@@ -113,13 +114,12 @@ module Increase
       # Hack to check for correct file upload params
       if headers["Content-Type"] == "multipart/form-data"
         attr = :file # TODO: Make this configurable
-        if params.nil? || params[attr].nil?
-          # No file to upload
-        elsif params[attr].is_a?(Faraday::Multipart::FilePart) || params[attr].is_a?(Faraday::Multipart::ParamPart)
-          # All is good!
-        else
-          # Soft fail
-          warn "File upload requires a `#{attr}` param with a Faraday::Multipart::FilePart or Faraday::MultiPart::ParamPart object. See docs."
+        if params[attr]
+          unless params[attr].is_a?(FileUpload)
+            params[attr] = FileUpload.new(params[attr])
+          end
+
+          params[attr] = params[attr].file_part
         end
       end
 

data/lib/increase/response_array.rb

@@ -13,7 +13,7 @@ module Increase
     end
 
     def next_cursor
-      wrapped&.dig('next_cursor')
+      wrapped&.dig("next_cursor")
     end
   end
 end

data/lib/increase/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Increase
-  VERSION = "0.2.0"
+  VERSION = "0.3.1"
 end

data/lib/increase.rb

@@ -4,8 +4,9 @@ require "increase/version"
 require "increase/client"
 require "increase/configuration"
 require "increase/errors"
-require "increase/resources"
 require "increase/webhook/signature"
+require "increase/file_upload"
+require "increase/resources"
 
 module Increase
   PRODUCTION_URL = "https://api.increase.com"

metadata

@@ -1,43 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: increase
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Gary Tou
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-21 00:00:00.000000000 Z
+date: 2023-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: faraday-follow_redirects
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: faraday-multipart
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +58,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: marcel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -145,6 +165,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".standard.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - OPENAPI_VERSION
@@ -153,11 +174,14 @@ files:
 - bin/generate
 - bin/setup
 - generate/resource.rb.erb
-- lib/faraday/raise_increase_api_error.rb
 - lib/increase.rb
 - lib/increase/client.rb
 - lib/increase/configuration.rb
 - lib/increase/errors.rb
+- lib/increase/file_upload.rb
+- lib/increase/middleware/encode_json.rb
+- lib/increase/middleware/parse_json.rb
+- lib/increase/middleware/raise_api_error.rb
 - lib/increase/resource.rb
 - lib/increase/resources.rb
 - lib/increase/resources/account_numbers.rb

data/lib/faraday/raise_increase_api_error.rb

@@ -1,11 +0,0 @@
-require "faraday"
-
-module FaradayMiddleware
-  class RaiseIncreaseApiError < Faraday::Middleware
-    def on_complete(env)
-      return if env[:status] < 400
-
-      raise Increase::ApiError.from_response(env)
-    end
-  end
-end