unit_ruby_sdk 0.1.2 → 0.1.4

data/lib/unit/models/transaction/get_transaction_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# Request to get a transaction
+# @see https://docs.unit.co/transactions#get-specific-transaction
+module Unit
+  module Transaction
+    class GetTransactionParams
+      attr_accessor :transaction_id, :account_id, :customer_id, :include
+
+      # @param transaction_id [String]
+      # @param account_id [String]
+      # @param customer_id [String] - optional
+      # @param include [Array<String>] - optional
+      def initialize(transaction_id, account_id, customer_id = nil, include = nil)
+        @transaction_id = transaction_id
+        @account_id = account_id
+        @customer_id = customer_id
+        @include = include
+      end
+
+      def to_hash
+        params = { "filter[customerId]": customer_id,
+                   "include": include&.join(",") }
+        params.compact
+      end
+    end
+  end
+end

data/lib/unit/models/transaction/list_transaction_params.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+# Request to list transactions
+# @see https://docs.unit.co/transactions#list-transactions
+module Unit
+  module Transaction
+    class ListTransactionParams
+      attr_reader :limit, :offset, :account_id, :customer_id, :query, :tags, :since, :_until, :card_id, :type, :from_amount, :to_amount, :direction, :exclude_fees, :sort, :include
+
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param account_id [String] - optional
+      # @param customer_id [String] - optional
+      # @param query [String] - optional
+      # @param tags [String] - optional
+      # @param since [String] - optional
+      # @param _until [String] - optional
+      # @param card_id [String] - optional
+      # @param type [Array<String>] - optional
+      # @param from_amount [Integer] - optional
+      # @param to_amount [Integer] - optional
+      # @param direction [String] - optional
+      # @param exclude_fees [Boolean] - optional
+      # @param sort [String] - optional
+      # @param include [Array<String>] - optional
+      def initialize(limit = TRANSACTION_LIST_LIMIT, offset = TRANSACTION_LIST_OFFSET, account_id = nil, customer_id = nil,
+                     query = nil, tags = nil, since = nil, _until = nil, card_id = nil, type = nil, from_amount = nil, to_amount = nil,
+                     direction = nil, exclude_fees = nil, sort = nil, include = nil)
+        @limit = limit
+        @offset = offset
+        @account_id = account_id
+        @customer_id = customer_id
+        @query = query
+        @tags = tags
+        @since = since
+        @_until = _until
+        @card_id = card_id
+        @type = type
+        @from_amount = from_amount
+        @to_amount = to_amount
+        @direction = direction
+        @exclude_fees = exclude_fees
+        @sort = sort
+        @include = include
+      end
+
+      def to_hash
+        params = { "page[limit]": limit,
+                   "page[offset]": offset,
+                   "filter[accountId]": account_id,
+                   "filter[customerId]": customer_id,
+                   "filter[query]": query,
+                   "filter[tags]": tags,
+                   "filter[since]": since,
+                   "filter[until]": _until,
+                   "filter[cardId]": card_id,
+                   "filter[fromAmount]": from_amount,
+                   "filter[toAmount]": to_amount,
+                   "filter[direction]": direction,
+                   "excludeFees": exclude_fees,
+                   "sort": sort,
+                   "include": include&.join(",") }
+        type&.each_with_index&.map do |val, index|
+          params.merge!({ "filter[type][#{index}]": val })
+        end
+        params.compact
+      end
+    end
+  end
+end

data/lib/unit/models/transaction/patch_tags_request.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# Request to update a transaction's tags
+# @see https://docs.unit.co/transactions#update-transaction-tags
+module Unit
+  module Transaction
+    class PatchTagsRequest
+      attr_accessor :account_id, :transaction_id, :tags
+
+      # @param account_id [String]
+      # @param transaction_id [String]
+      # @param tags [Hash] - optional
+      def initialize(account_id, transaction_id, tags = nil)
+        @account_id = account_id
+        @transaction_id = transaction_id
+        @tags = tags
+      end
+
+      def to_json_api
+        payload = {
+          "data": {
+            "type": "transaction",
+            "attributes": {
+              "tags": tags
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/models/transaction/transaction.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Unit
+  module Transaction
+    TRANSACTION_LIST_LIMIT = 100
+    TRANSACTION_LIST_OFFSET = 0
+    autoload :GetTransactionParams, "unit/models/transaction/get_transaction_params"
+    autoload :ListTransactionParams, "unit/models/transaction/list_transaction_params"
+    autoload :PatchTagsRequest, "unit/models/transaction/patch_tags_request"
+
+    class << self
+      # Get a transaction by id
+      # @see https://docs.unit.co/transactions#get-specific-transaction
+      # @param transaction_id [String]
+      # @param account_id [String]
+      # @param customer_id [String] - optional
+      # @param include [Array<String>] - optional
+      def get_transaction(transaction_id:, account_id:, customer_id: nil, include: nil)
+        params = GetTransactionParams.new(transaction_id, account_id, customer_id, include)
+        Unit::Resource::TransactionResource.get_transaction(params)
+      end
+
+      # List transactions
+      # @see https://docs.unit.co/transactions#list-transactions
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param account_id [String] - optional
+      # @param query [String] - optional
+      # @param tags [String] - optional
+      # @param since [String] - optional
+      # @param _until [String] - optional
+      # @param card_id [String] - optional
+      # @param type [Array<String>] - optional
+      # @param from_amount [Integer] - optional
+      # @param to_amount [Integer] - optional
+      # @param direction [String] - optional
+      # @param exclude_fees [Boolean] - optional
+      # @param sort [String] - optional
+      # @param include [Array<String>] - optional
+      def list_transactions(limit: nil, offset: nil, account_id: nil, customer_id: nil,
+                            query: nil, tags: nil, since: nil, _until: nil, card_id: nil, type: nil, from_amount: nil, to_amount: nil,
+                            direction: nil, exclude_fees: nil, sort: nil, include: nil)
+        params = ListTransactionParams.new(limit, offset, account_id, customer_id, query, tags, since,
+                                           _until, card_id, type, from_amount, to_amount,
+                                           direction, exclude_fees, sort, include)
+        Unit::Resource::TransactionResource.list_transactions(params)
+      end
+
+      # Update transaction tags
+      # @see https://docs.unit.co/transactions#update-transaction-tags
+      # @param account_id [String]
+      # @param transaction_id [String]
+      # @param tags [Hash]
+      def update_transaction(account_id:, transaction_id:, tags: nil)
+        request = PatchTagsRequest.new(account_id, transaction_id, tags)
+        Unit::Resource::TransactionResource.update_tags(request)
+      end
+    end
+  end
+end

data/lib/unit/models/unit_response.rb

@@ -7,11 +7,17 @@ module Unit
 
     # @param data [Hash] The JSON API payload
     # @param included [Array] The JSON API payload
-
     def initialize(data, included, meta)
       @data = data
       @included = included
       @meta = meta
     end
+
+    # Creates a new UnitResponse from given response.
+    # @param [HTTP::Response] response The response returned from Unit's API
+    # @return [UnitResponse] a new UnitResponse populated with values taken from the response
+    def self.from_json_api(response)
+      new(response.body["data"], response.body["included"], response.body["meta"])
+    end
   end
 end

data/lib/unit/types/authorized_user.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Type representing authorized user
-# See: https://docs.unit.co/customers/#authorized-users
+# @see https://docs.unit.co/customers/#authorized-users
 module Unit
   module Types
     class AuthorizedUser

data/lib/unit/types/relationship.rb

@@ -8,14 +8,13 @@ module Unit
 
       # @param id [String] The id of the relationship
       # @param type [String] The type
-      def initialize(id, type)
-        @id = id
+      def initialize(type, id)
         @type = type
+        @id = id
       end
 
-      # @param nested [Boolean] Whether or not the relationship is nested
-      def represent(nested: true)
-        nested ? { "data": { "id": id, "type": type } } : { "id": id, "type": type }
+      def to_hash
+        { "data": { "type": type, "id": id } }
       end
     end
   end

data/lib/unit/types/relationship_array.rb

@@ -6,23 +6,25 @@ module Unit
     class RelationshipArray
       attr_reader :data
 
-      # @param array [Array] The array of relationships
+      # @param array [Array]
       def initialize(array)
-        relationships = []
-        array.map do |item|
-          relationships << if item.is_a?(Relationship)
-                             item
-                           else
-                             Relationship.new(item[:data][:id], item[:data][:type]).represent
-                           end
-          p item
-        end
-        @data = relationships
+        @data = array
       end
 
-      def represent
+      def to_hash
         { "data": data }
       end
+
+      def self.from_params_array(array)
+        @relationships = []
+        array.map do |item|
+          @relationships << if item.is_a?(Relationship)
+                              item.to_hash[:data]
+                            else
+                              Relationship.new(item[:type], item[:id]).to_hash[:data] end
+        end
+        RelationshipArray.new(@relationships).to_hash
+      end
     end
   end
 end

data/lib/unit/types/restricted_resource.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "json"
+module Unit
+  module Types
+    class RestrictedResource
+      attr_reader :ids, :type
+
+      def initialize(ids, type)
+        @ids = ids
+        @type = type
+      end
+
+      def to_json_api
+        result = []
+        @ids.each do |id|
+          result << { type: type, id: id }
+        end
+        result
+      end
+    end
+  end
+end

data/lib/unit/utils/http_helper.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "uri"
+require "net/http"
+require "json"
+
+module HttpHelper
+  def self.get(url, headers:, params: nil)
+    make_request(Net::HTTP::Get, url, headers, params: params)
+  end
+
+  def self.post(url, headers:, body: nil)
+    make_request(Net::HTTP::Post, url, headers, body: body)
+  end
+
+  def self.put(url, body:, headers:)
+    make_request(Net::HTTP::Put, url, headers, body: body)
+  end
+
+  def self.patch(url, body:, headers:)
+    make_request(Net::HTTP::Patch, url, headers, body: body)
+  end
+
+  def self.delete(url, headers:, body: nil)
+    make_request(Net::HTTP::Delete, url, headers, body: body)
+  end
+
+  def self.make_request(net_http, url, headers, body: nil, params: nil)
+    uri = params.nil? ? URI(url) : URI("#{url}?#{encode(params)}")
+    host = uri.host.to_s
+    port = uri.port
+    options = { use_ssl: uri.scheme == "https" }
+
+    Net::HTTP.start(host, port, options) do |http|
+      request = net_http.new uri, headers
+      request.body = body unless body.nil?
+      response = http.request request
+      response.body = JSON.parse(response.body)
+      response
+    end
+  end
+
+  def self.encode(value, key = nil)
+    case value
+    when Hash then value.map { |k, v| encode(v, append_key(key, k)) }.join("&")
+    when Array then value.map { |v| encode(v, "#{key}[]") }.join("&")
+    when nil then ""
+    else
+      "#{key}=#{CGI.escape(value.to_s)}"
+    end
+  end
+
+  def self.append_key(root_key, key)
+    root_key.nil? ? key : "#{root_key}[#{key}]"
+  end
+end

data/lib/unit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Unit
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
 end

data/lib/unit_ruby_sdk.rb

@@ -3,26 +3,20 @@
 require_relative "unit/version"
 
 module Unit
+  autoload :Application, "unit/models/application/application"
+  autoload :Customer, "unit/models/customer/customer"
+  autoload :Account, "unit/models/account/account"
+  autoload :ApiToken, "unit/models/api_token/api_token"
+  autoload :Payment, "unit/models/payment/payment"
+  autoload :Transaction, "unit/models/transaction/transaction"
+
   module Resource
     autoload :ApplicationResource, "unit/api_resources/application_resource"
     autoload :CustomerResource, "unit/api_resources/customer_resource"
-  end
-
-  module Application
-    autoload :CreateBusinessApplicationRequest, "unit/models/application/create_business_application_request"
-    autoload :CreateIndividualApplicationRequest, "unit/models/application/create_individual_application_request"
-    autoload :ListApplicationParams, "unit/models/application/list_application_params"
-    autoload :PatchApplicationRequest, "unit/models/application/patch_application_request"
-    autoload :UploadDocumentRequest, "unit/models/application/upload_document_request"
-  end
-
-  module Customer
-    autoload :AddAuthorizedUsersRequest, "unit/models/customer/add_authorized_users_request"
-    autoload :ArchiveCustomerRequest, "unit/models/customer/archive_customer_request"
-    autoload :ListCustomerParams, "unit/models/customer/list_customer_params"
-    autoload :PatchBusinessCustomerRequest, "unit/models/customer/patch_business_customer_request"
-    autoload :PatchIndividualCustomerRequest, "unit/models/customer/patch_individual_customer_request"
-    autoload :RemoveAuthorizedUsersRequest, "unit/models/customer/remove_authorized_users_request"
+    autoload :AccountResource, "unit/api_resources/account_resource"
+    autoload :ApiTokenResource, "unit/api_resources/api_token_resource"
+    autoload :PaymentResource, "unit/api_resources/payment_resource"
+    autoload :TransactionResource, "unit/api_resources/transaction_resource"
   end
 
   module Types
@@ -38,6 +32,7 @@ module Unit
     autoload :PowerOfAttorneyAgent, "unit/types/power_of_attorney_agent"
     autoload :Relationship, "unit/types/relationship"
     autoload :RelationshipArray, "unit/types/relationship_array"
+    autoload :RestrictedResource, "unit/types/restricted_resource"
   end
 
   autoload :UnitErrorPayload, "unit/errors/unit_error_payload"
@@ -46,9 +41,15 @@ module Unit
   autoload :UnitResource, "unit/models/unit_resource"
 
   # Configure Unit SDK - acts both as a setter and a getter
-  # @param [Hash] new_config If passed, update config
-  # @return [Hash] current config
-  def self.config(new_config = nil)
-    @@config ||= new_config
+  # If params are passed, updates config
+  # @param [String] api_url
+  # @param [String] token
+  # @return [Hash] current (updated) config
+  def self.config(api_url: nil, token: nil)
+    @@config ||= {}
+    @@config[:api_url] = api_url if api_url
+    @@config[:token] = token if token
+
+    @@config
   end
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: unit_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Unit
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-12 00:00:00.000000000 Z
+date: 2022-12-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -25,19 +53,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: ruby-debug-ide
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.20.0
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: '0'
 description: This library provides a Ruby wrapper to http://unit.co API. See https://docs.unit.co/
 email:
 - engineering@unit.co
@@ -49,15 +91,32 @@ files:
 - ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/unit/api_resources/account_resource.rb
+- lib/unit/api_resources/api_token_resource.rb
 - lib/unit/api_resources/application_resource.rb
 - lib/unit/api_resources/base_resource.rb
 - lib/unit/api_resources/customer_resource.rb
+- lib/unit/api_resources/payment_resource.rb
+- lib/unit/api_resources/transaction_resource.rb
 - lib/unit/errors/unit_error.rb
 - lib/unit/errors/unit_error_payload.rb
+- lib/unit/models/account/account.rb
+- lib/unit/models/account/deposit/account_owners_request.rb
+- lib/unit/models/account/deposit/balance_history_request.rb
+- lib/unit/models/account/deposit/close_deposit_account_request.rb
+- lib/unit/models/account/deposit/create_deposit_account_request.rb
+- lib/unit/models/account/deposit/freeze_account_request.rb
+- lib/unit/models/account/deposit/list_account_params.rb
+- lib/unit/models/account/deposit/patch_deposit_account_request.rb
+- lib/unit/models/api_token/api_token.rb
+- lib/unit/models/api_token/customer/create_customer_token_request.rb
+- lib/unit/models/api_token/customer/create_customer_token_verification.rb
+- lib/unit/models/api_token/customer/create_token_using_jwt_request.rb
+- lib/unit/models/api_token/org/create_api_token_request.rb
+- lib/unit/models/application/application.rb
 - lib/unit/models/application/create_business_application_request.rb
 - lib/unit/models/application/create_individual_application_request.rb
 - lib/unit/models/application/list_application_params.rb
@@ -65,10 +124,18 @@ files:
 - lib/unit/models/application/upload_document_request.rb
 - lib/unit/models/customer/add_authorized_users_request.rb
 - lib/unit/models/customer/archive_customer_request.rb
+- lib/unit/models/customer/customer.rb
 - lib/unit/models/customer/list_customer_params.rb
 - lib/unit/models/customer/patch_business_customer_request.rb
 - lib/unit/models/customer/patch_individual_customer_request.rb
 - lib/unit/models/customer/remove_authorized_users_request.rb
+- lib/unit/models/payment/create_book_payment_request.rb
+- lib/unit/models/payment/patch_book_payment_request.rb
+- lib/unit/models/payment/payment.rb
+- lib/unit/models/transaction/get_transaction_params.rb
+- lib/unit/models/transaction/list_transaction_params.rb
+- lib/unit/models/transaction/patch_tags_request.rb
+- lib/unit/models/transaction/transaction.rb
 - lib/unit/models/unit_resource.rb
 - lib/unit/models/unit_response.rb
 - lib/unit/types/address.rb
@@ -83,6 +150,8 @@ files:
 - lib/unit/types/power_of_attorney_agent.rb
 - lib/unit/types/relationship.rb
 - lib/unit/types/relationship_array.rb
+- lib/unit/types/restricted_resource.rb
+- lib/unit/utils/http_helper.rb
 - lib/unit/version.rb
 - lib/unit_ruby_sdk.rb
 homepage: https://github.com/unit-finance/unit-ruby-sdk