increase 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5ebc261a44d0f2a6df7fc703886dcc18e11a3c54bd2f04742b783e46fedc1f7
-  data.tar.gz: '073485629ad76bc387aa0a51d954a86bb93c9884bd90baccedeaa2cbf483efaa'
+  metadata.gz: a945cde9440a62a76cd7a95c5bc91b7dfea452fada50349e3d749c6fc95fa72e
+  data.tar.gz: b6ce6f53d72e35e027287feff54fc47c7e855fa364fc11040646efd92c8ce028
 SHA512:
-  metadata.gz: c2b625211c3e9ad0a7588caaeda4eaea8e216569e3efd2f83afaf48d0c8fed23794d0f8a0d4bdab6a0024115836cab51979a4731ea2fc0d4400de1967e0d9c93
-  data.tar.gz: ede3ef495349bf6c7cf6acacba84101061aa3740170ca3b7fea1fb4ec8e2c7e8df61b0654e9919e158c1bc033f8ef37ec4171538aeb485eae6f0c1f3cd619da5
+  metadata.gz: 30fb2ded08ba6aa27adfa4f85932e941d4e727ae069ab8df915c2dd001cdd35779b8b58090e29695100270ec66da45cd6d495efdd0b7acc4bf747473b3a5970a
+  data.tar.gz: 5a591e007db71c14a1a4e827650bea8a6eda56d68e248eb2988e02380c6de4ccdc5054963c09bda8f2797c36a7dc148fb5a14de58105ff535cbc56bd137f7698

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.0
 ```
 
 If bundler is not being used to manage dependencies, install the gem by
 executing:
 
 ```sh
-$ gem install increase
+$ gem install increase -v 0.3.0
 ```
 
 ## 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/file_upload.rb

@@ -0,0 +1,50 @@
+# 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
+      Faraday::Multipart::FilePart.new(
+        @file,
+        @content_type,
+        @filename
+      )
+    end
+
+    private
+
+    def default_filename
+      "file upload #{Time.now}"
+    end
+
+  end
+end

data/lib/increase/resource.rb

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Increase
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: increase
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 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
@@ -52,6 +52,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
@@ -158,6 +172,7 @@ files:
 - lib/increase/client.rb
 - lib/increase/configuration.rb
 - lib/increase/errors.rb
+- lib/increase/file_upload.rb
 - lib/increase/resource.rb
 - lib/increase/resources.rb
 - lib/increase/resources/account_numbers.rb