increase 0.1.2 → 0.2.0

data/lib/increase/resource.rb

@@ -1,7 +1,10 @@
 require "increase/response_hash"
+require "increase/response_array"
 
 module Increase
   class Resource
+    PAGINATION_MAX_LIMIT = 100
+
     def initialize(client: nil)
       if instance_of?(Resource)
         raise NotImplementedError, "Resource is an abstract class. You should perform actions on its subclasses (Accounts, Transactions, Card, etc.)"
@@ -18,51 +21,41 @@ module Increase
     end
 
     def self.resource_url
-      "/#{resource_name.downcase.tr(" ", "_")}"
+      "/#{self::API_NAME}"
     end
 
-    def self.resource_name
-      if self == Resource
-        raise NotImplementedError, "Resource is an abstract class. You should perform actions on its subclasses (Accounts, Transactions, Card, etc.)"
-      end
-
-      name.split("::").last.gsub(/[A-Z]/, ' \0').strip
-    end
-
-    def self.endpoint(name, http_method, to: :same_as_name, with: nil)
-      to = nil if to == :root
-      to = name.to_s if to == :same_as_name
-      to = [to].flatten.compact
+    def self.endpoint(name, http_method, path: nil, with: nil)
+      path = [path].flatten.compact
       with = [with].flatten.compact
 
-      raise Error, "Invalid `to`. Max of 2 elements allowed" if to.size > 2
-      raise Error, "Only one `to` allowed when not `with` an `id`" if to.size > 1 && !with.include?(:id)
+      # TODO: This doesn't support multiple path params
+      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
       request_method = :paginated_request if with.include?(:pagination)
 
       method =
-        if with.include?(:id)
+        if has_id
           # Method signature with a required `id` param
           ->(id, params = nil, headers = nil, &block) do
-            url = self.class.resource_url
-            url +=
-              if to.size == 2
-                "/#{to[0]}/#{id}/#{to[1]}"
-              elsif to.size == 1
-                # Default to id first
-                "/#{id}/#{to[0]}"
-              else
-                "/#{id}"
-              end
+            segments = path.map { |segment| is_id.call(segment) ? id : segment }
+            url = ([self.class.resource_url] + segments).join("/")
+
+            if with.include?(:file_upload)
+              headers = {"Content-Type" => "multipart/form-data"}.merge(headers || {})
+            end
 
             send(request_method, http_method, url, params, headers, &block)
           end
         else
           # Method signature without a required `id` param
           ->(params = nil, headers = nil, &block) do
-            url = self.class.resource_url
-            url += "/#{to[0]}" if to.size == 1
+            url = ([self.class.resource_url] + path).join("/")
+
+            if with.include?(:file_upload)
+              headers = {"Content-Type" => "multipart/form-data"}.merge(headers || {})
+            end
 
             send(request_method, http_method, url, params, headers, &block)
           end
@@ -87,98 +80,27 @@ module Increase
       # endpoint which is a `GET` request to the resource's root URL.
 
       def create
-        endpoint :create, :post, to: :root
+        endpoint :create, :post
       end
 
       def list
-        endpoint :list, :get, to: :root, with: :pagination
+        endpoint :list, :get, with: :pagination
       end
 
       def update
-        endpoint :update, :patch, to: :root, with: :id
+        endpoint :update, :patch, path: [:id]
       end
 
       def retrieve
-        endpoint :retrieve, :get, to: :root, with: :id
+        endpoint :retrieve, :get, path: [:id]
       end
     end
 
-    # def self.endpoint_action(method, http_method)
-    #   define_singleton_method(method) do |*args, &block|
-    #     new.send(:action, method, http_method, *args, &block)
-    #   end
-    #
-    #   define_method(method) do |*args, &block|
-    #     new.send(:action, method, http_method, *args, &block)
-    #   end
-    # end
-    #
-    # private_class_method :endpoint_action
-    #
-    # private
-    #
-    # def create(params = nil, headers = nil)
-    #   request(:post, self.class.resource_url, params, headers)
-    # end
-    #
-    # def list(params = nil, headers = nil, &block)
-    #   results = []
-    #   count = 0
-    #   limit = params&.[](:limit) || params&.[]("limit")
-    #   if limit == :all || limit&.>(100)
-    #     params&.delete(:limit)
-    #     params&.delete("limit")
-    #   end
-    #
-    #   loop do
-    #     res = request(:get, self.class.resource_url, params, headers)
-    #     data = res["data"]
-    #     count += data.size
-    #     if ![nil, :all].include?(limit) && count >= limit
-    #       data = data[0..(limit - (count - data.size) - 1)]
-    #     end
-    #
-    #     if block
-    #       block.call(data)
-    #     else
-    #       results += data
-    #     end
-    #
-    #     if limit.nil? || (limit != :all && count >= limit) || res["next_cursor"].nil?
-    #       if block
-    #         break
-    #       else
-    #         return results
-    #       end
-    #     end
-    #
-    #     params = (params || {}).merge({ cursor: res["next_cursor"] })
-    #   end
-    # end
-    #
-    # def update(id, params = nil, headers = nil)
-    #   raise Error, "id must be a string" unless id.is_a?(String)
-    #   path = "#{self.class.resource_url}/#{id}"
-    #   request(:patch, path, params, headers)
-    # end
-    #
-    # def retrieve(id, params = nil, headers = nil)
-    #   raise Error, "id must be a string" unless id.is_a?(String)
-    #   path = "#{self.class.resource_url}/#{id}"
-    #   request(:get, path, params, headers)
-    # end
-    #
-    # # Such as for "/accounts/{account_id}/close"
-    # # "close" is the action.
-    # def action(action, http_method, id, params = nil, headers = nil)
-    #   raise Error, "id must be a string" unless id.is_a?(String)
-    #   path = "#{self.class.resource_url}/#{id}/#{action}"
-    #   request(http_method, path, params, headers)
-    # end
-
     private
 
     def request(method, path, params = nil, headers = nil, &block)
+      headers ||= {}
+
       if block
         # Assume the caller wants to automatically paginate
         return paginated_request(method, path, params, headers, &block)
@@ -188,51 +110,95 @@ module Increase
         headers = {"Content-Type" => "application/json"}.merge!(headers || {})
       end
 
+      # 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."
+        end
+      end
+
       response = @client.connection.send(method, path, params, headers)
       ResponseHash.new(response.body, response: response)
     end
 
     def paginated_request(method, path, params = nil, headers = nil, &block)
+      params ||= {}
+      limit = params[:limit] || params["limit"]
+      if limit == :all || limit&.>(PAGINATION_MAX_LIMIT)
+        # Request `limit` can not be greater than `PAGINATION_MAX_LIMIT`
+        params.delete("limit")
+        params[:limit] = PAGINATION_MAX_LIMIT
+      end
+
       results = []
       count = 0
-      limit = params&.[](:limit) || params&.[]("limit")
-      if limit == :all || limit&.>(100)
-        params&.delete(:limit)
-        params&.delete("limit")
-      end
 
       loop do
         res = request(method, path, params, headers)
         data = res["data"]
 
-        # Handle case where endpoint doesn't actually support pagination.
-        # For example, someone passes a block to `Account.create`
+        # Handle case where endpoint doesn't support pagination.
+        # For example, someone passes a block to `Accounts.create`
         if data.nil?
-          # In this case, we'll both yield and return the response
-          yield res if block
+          # In this case, we'll both yield and return the response.
+          # `res` here is already a `ResponseHash` since it comes from `request`
+          if block
+            yield res and return
+          end
           return res
         end
 
+        # From here on, the endpoint definitely supports pagination
+
         count += data.size
+        # Restrict number of results to the limit
         if ![nil, :all].include?(limit) && count >= limit
           data = data[0..(limit - (count - data.size) - 1)]
         end
 
+        # Either yield or collect the results
         if block
-          block.call(data)
+          block.call(ResponseArray.new(data, full_response: res, response: res.response))
         else
           results += data
         end
 
-        if limit.nil? || (limit != :all && count >= limit) || res["next_cursor"].nil?
+        # Handle case where user doesn't want to paginate
+        if limit.nil?
           if block
-            break
+            # Block has already been called above
+            return
           else
-            return results
+            return ResponseArray.new(results, full_response: res, response: res.response)
           end
         end
 
-        params = (params || {}).merge({cursor: res["next_cursor"]})
+        # From here on, this is for sure a paginated request
+
+        # Handle case where we've hit the last page
+        if (limit != :all && count >= limit) || res["next_cursor"].nil?
+          if block
+            # We've already yielded all the data above
+            return
+          else
+            # Wrap with a `ResponseArray`. However, there are multiple
+            # requests/responses associated with this array. The `full_response`
+            # and `response` only store the last response.
+            return ResponseArray.new(results, full_response: res, response: res.response)
+          end
+        end
+
+        # Update the cursor and loop again!
+        params[:cursor] = res["next_cursor"]
+        if limit != :all
+          params[:limit] = [limit - count, PAGINATION_MAX_LIMIT].min
+        end
       end
     end
   end

data/lib/increase/resources/account_numbers.rb

@@ -4,9 +4,16 @@ require "increase/resource"
 
 module Increase
   class AccountNumbers < Resource
+    NAME = "Account Numbers"
+    API_NAME = "account_numbers"
+
+    # Create an Account Number
     create
+    # List Account Numbers
     list
+    # Update an Account Number
     update
+    # Retrieve an Account Number
     retrieve
   end
 end

data/lib/increase/resources/account_statements.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "increase/resource"
+
+module Increase
+  class AccountStatements < Resource
+    NAME = "Account Statements"
+    API_NAME = "account_statements"
+
+    # List Account Statements
+    list
+    # Retrieve an Account Statement
+    retrieve
+  end
+end

data/lib/increase/resources/account_transfers.rb

@@ -4,10 +4,18 @@ require "increase/resource"
 
 module Increase
   class AccountTransfers < Resource
+    NAME = "Account Transfers"
+    API_NAME = "account_transfers"
+
+    # Create an Account Transfer
     create
+    # List Account Transfers
     list
+    # Retrieve an Account Transfer
     retrieve
-    endpoint :approve, :post, with: :id
-    endpoint :cancel, :post, with: :id
+    # Approve an Account Transfer
+    endpoint :approve, :post, path: [:account_transfer_id, "approve"]
+    # Cancel an Account Transfer
+    endpoint :cancel, :post, path: [:account_transfer_id, "cancel"]
   end
 end

data/lib/increase/resources/accounts.rb

@@ -4,10 +4,18 @@ require "increase/resource"
 
 module Increase
   class Accounts < Resource
+    NAME = "Accounts"
+    API_NAME = "accounts"
+
+    # Create an Account
     create
+    # List Accounts
     list
+    # Update an Account
     update
+    # Retrieve an Account
     retrieve
-    endpoint :close, :post, with: :id
+    # Close an Account
+    endpoint :close, :post, path: [:account_id, "close"]
   end
 end

data/lib/increase/resources/ach_prenotifications.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "increase/resource"
+
+module Increase
+  class AchPrenotifications < Resource
+    NAME = "ACH Prenotifications"
+    API_NAME = "ach_prenotifications"
+
+    # Create an ACH Prenotification
+    create
+    # List ACH Prenotifications
+    list
+    # Retrieve an ACH Prenotification
+    retrieve
+  end
+end

data/lib/increase/resources/ach_transfers.rb

@@ -4,10 +4,18 @@ require "increase/resource"
 
 module Increase
   class AchTransfers < Resource
+    NAME = "ACH Transfers"
+    API_NAME = "ach_transfers"
+
+    # Create an ACH Transfer
     create
+    # List ACH Transfers
     list
+    # Retrieve an ACH Transfer
     retrieve
-    endpoint :approve, :post, with: :id
-    endpoint :cancel, :post, with: :id
+    # Approve an ACH Transfer
+    endpoint :approve, :post, path: [:ach_transfer_id, "approve"]
+    # Cancel a pending ACH Transfer
+    endpoint :cancel, :post, path: [:ach_transfer_id, "cancel"]
   end
 end

data/lib/increase/resources/card_disputes.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "increase/resource"
+
+module Increase
+  class CardDisputes < Resource
+    NAME = "Card Disputes"
+    API_NAME = "card_disputes"
+
+    # Create a Card Dispute
+    create
+    # List Card Disputes
+    list
+    # Retrieve a Card Dispute
+    retrieve
+  end
+end

data/lib/increase/resources/card_profiles.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "increase/resource"
+
+module Increase
+  class CardProfiles < Resource
+    NAME = "Card Profiles"
+    API_NAME = "card_profiles"
+
+    # Create a Card Profile
+    create
+    # List Card Profiles
+    list
+    # Retrieve a Card Profile
+    retrieve
+  end
+end

data/lib/increase/resources/cards.rb

@@ -4,10 +4,18 @@ require "increase/resource"
 
 module Increase
   class Cards < Resource
+    NAME = "Cards"
+    API_NAME = "cards"
+
+    # Create a Card
     create
+    # List Cards
     list
-    endpoint :details, :get, with: :id
+    # Retrieve sensitive details for a Card
+    endpoint :details, :get, path: [:card_id, "details"]
+    # Update a Card
     update
+    # Retrieve a Card
     retrieve
   end
 end

data/lib/increase/resources/check_deposits.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "increase/resource"
+
+module Increase
+  class CheckDeposits < Resource
+    NAME = "Check Deposits"
+    API_NAME = "check_deposits"
+
+    # Create a Check Deposit
+    create
+    # List Check Deposits
+    list
+    # Retrieve a Check Deposit
+    retrieve
+  end
+end

data/lib/increase/resources/check_transfers.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "increase/resource"
+
+module Increase
+  class CheckTransfers < Resource
+    NAME = "Check Transfers"
+    API_NAME = "check_transfers"
+
+    # Create a Check Transfer
+    create
+    # List Check Transfers
+    list
+    # Retrieve a Check Transfer
+    retrieve
+    # Approve a Check Transfer
+    endpoint :approve, :post, path: [:check_transfer_id, "approve"]
+    # Cancel a pending Check Transfer
+    endpoint :cancel, :post, path: [:check_transfer_id, "cancel"]
+    # Request a stop payment on a Check Transfer
+    endpoint :stop_payment, :post, path: [:check_transfer_id, "stop_payment"]
+  end
+end

data/lib/increase/resources/declined_transactions.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "increase/resource"
+
+module Increase
+  class DeclinedTransactions < Resource
+    NAME = "Declined Transactions"
+    API_NAME = "declined_transactions"
+
+    # List Declined Transactions
+    list
+    # Retrieve a Declined Transaction
+    retrieve
+  end
+end

data/lib/increase/resources/digital_wallet_tokens.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "increase/resource"
+
+module Increase
+  class DigitalWalletTokens < Resource
+    NAME = "Digital Wallet Tokens"
+    API_NAME = "digital_wallet_tokens"
+
+    # List Digital Wallet Tokens
+    list
+    # Retrieve a Digital Wallet Token
+    retrieve
+  end
+end

data/lib/increase/resources/documents.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "increase/resource"
+
+module Increase
+  class Documents < Resource
+    NAME = "Documents"
+    API_NAME = "documents"
+
+    # List Documents
+    list
+    # Retrieve a Document
+    retrieve
+  end
+end

data/lib/increase/resources/entities.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "increase/resource"
+
+module Increase
+  class Entities < Resource
+    NAME = "Entities"
+    API_NAME = "entities"
+
+    # Create an Entity
+    create
+    # List Entities
+    list
+    # Retrieve an Entity
+    retrieve
+    # Create a supplemental document for an Entity
+    endpoint :supplemental_documents, :post, path: [:entity_id, "supplemental_documents"]
+  end
+end

data/lib/increase/resources/event_subscriptions.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "increase/resource"
+
+module Increase
+  class EventSubscriptions < Resource
+    NAME = "Event Subscriptions"
+    API_NAME = "event_subscriptions"
+
+    # Create an Event Subscription
+    create
+    # List Event Subscriptions
+    list
+    # Update an Event Subscription
+    update
+    # Retrieve an Event Subscription
+    retrieve
+  end
+end

data/lib/increase/resources/events.rb

@@ -4,7 +4,12 @@ require "increase/resource"
 
 module Increase
   class Events < Resource
+    NAME = "Events"
+    API_NAME = "events"
+
+    # List Events
     list
+    # Retrieve an Event
     retrieve
   end
 end

data/lib/increase/resources/external_accounts.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "increase/resource"
+
+module Increase
+  class ExternalAccounts < Resource
+    NAME = "External Accounts"
+    API_NAME = "external_accounts"
+
+    # Create an External Account
+    create
+    # List External Accounts
+    list
+    # Update an External Account
+    update
+    # Retrieve an External Account
+    retrieve
+  end
+end

data/lib/increase/resources/files.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "increase/resource"
+
+module Increase
+  class Files < Resource
+    NAME = "Files"
+    API_NAME = "files"
+
+    # Create a File
+    endpoint :create, :post, with: :file_upload
+    # List Files
+    list
+    # Retrieve a File
+    retrieve
+  end
+end

data/lib/increase/resources/groups.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "increase/resource"
+
+module Increase
+  class Groups < Resource
+    NAME = "Groups"
+    API_NAME = "groups"
+
+    # Retrieve Group details
+    endpoint :current, :get, path: "current"
+  end
+end