investec_open_api 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d63aea6ee443ea35ef173be3a2de9f21c36ccf03bf9545249700a443d274360e
-  data.tar.gz: 176d7edd574dcdc1be3a54a7cce109c861d3bdeba7b32f6c3a769e40fdffea93
+  metadata.gz: b63be4cb913b87e7b56c0a1ba3eab66a09b853991d09bec6c42eb9ba6e0a091e
+  data.tar.gz: e61aa2281d0ddf0dfc48e9f3782dab1999ce69b48ae137a833648ce1f5ac350d
 SHA512:
-  metadata.gz: 071f395d389f11333db5b5a36048ad9f0b66ff688fbfb35bccb83296b49491279a1b83f458507dd4e83426ffa39fd96d720ef000d0753595cc849e9901749d53
-  data.tar.gz: 54d8986eccc4461d9b59c4f16b894e0274d660be311b6862cb1734010be7a7e386e496a36a7eb0f07621ab2cbf1785374fed3328a4fecfb210c52e40ec85437c
+  metadata.gz: ef318fa461e96b6fd1bb3f3421f833ad8104e82efc8f457c8c364c99bf14ba0c5409e4dd4d19d77d87ae74da19d50380781259723c669be319ffe5a3670f28dd
+  data.tar.gz: 88f1874026696d1cfc9f2af7f6d37329d3f8a40599fb72ef66109fb3a7bffe5e1ff5f814bf782e920b76194a5da501d4fbcb7ca99580615f17c8d929c5b880fb

data/.gitignore

@@ -11,3 +11,4 @@
 # rspec failure tracking
 .rspec_status
 .env
+investec_open_api*.gem

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    investec_open_api (2.0.0)
+    investec_open_api (2.1.0)
       faraday
       money
 

data/README.md

@@ -86,7 +86,15 @@ my_account = accounts.first
 You can list your transactions by passing the account id into the `transactions` method:
 
 ```ruby
-client.transactions(my_account.id)
+# The dates are optional
+client.transactions(my_account.id, { fromDate: "2024-01-01", toDate: "2024-01-31" })
+```
+
+To list pending transactions use the following:
+
+```ruby
+# The dates are optional
+client.pending_transactions(my_account.id, { fromDate: "2024-01-01", toDate: "2024-01-31" })
 ```
 
 ### Get Balance for an account

data/lib/investec_open_api/client.rb

@@ -20,18 +20,25 @@ class InvestecOpenApi::Client
     end
   end
 
+  ## Get cleared transactions for an account
+  # @param [String] account_id The id of the account to get transactions for
+  # @param [Hash] options
+  # @option options [String] :fromDate Start date from which to get transactions
+  # @option options [String] :toDate End date for transactions
+  # @option options [String] :transactionType Type of transaction to filter by eg: CardPurchases, Deposits
   def transactions(account_id, options = {})
     endpoint_url = "za/pb/v1/accounts/#{account_id}/transactions"
+    perform_transaction_request(endpoint_url, options)
+  end
 
-    unless options.empty?
-      query_string = URI.encode_www_form(options.camelize)
-      endpoint_url += "?#{query_string}"
-    end
-
-    response = connection.get(endpoint_url)
-    response.body["data"]["transactions"].map do |transaction_raw|
-      InvestecOpenApi::Models::Transaction.from_api(transaction_raw)
-    end
+  ## Get pending transactions for an account
+  # @param [String] account_id The id of the account to get pending transactions for
+  # @param [Hash] options
+  # @option options [String] :fromDate Start date from which to get pending transactions
+  # @option options [String] :toDate End date for pending transactions
+  def pending_transactions(account_id, options = {})
+    endpoint_url = "za/pb/v1/accounts/#{account_id}/pending-transactions"
+    perform_transaction_request(endpoint_url, options)
   end
 
   def balance(account_id)
@@ -92,4 +99,16 @@ class InvestecOpenApi::Client
       builder.adapter Faraday.default_adapter
     end
   end
+
+  def perform_transaction_request(endpoint_url, options)
+    unless options.empty?
+      query_string = URI.encode_www_form(options.camelize)
+      endpoint_url += "?#{query_string}"
+    end
+
+    response = connection.get(endpoint_url)
+    response.body["data"]["transactions"].map do |transaction_raw|
+      InvestecOpenApi::Models::Transaction.from_api(transaction_raw)
+    end
+  end
 end

data/lib/investec_open_api/models/transaction.rb

@@ -17,13 +17,20 @@ module InvestecOpenApi::Models
                 :value_date,
                 :action_date
 
+    ## Unique identifier
+    # Composite key generated by Investec using the following formula:
+    # account_id.slice(0, 5) + posting_date.gsub(/-/, "") + posted_order.to_s.rjust(7, "0")
+    # This will only be populated for posted transaction on Private Bank Accounts.
+    # This is not a backend banking generated ID and will change if any of the properties making it up changes.
+    attr_reader :uuid
+
     def initialize(params)
       super
       set_id
     end
 
-    # At this point, there is no unique identifier being returned from Investec's API.
-    # This method serves to create a stable unique identifier based on the transaction details.
+    # Investec exposes a uuid for uniqueness so this is no longer needed (non-pending transactions).
+    # It is kept here for legacy purposes. It is also useful for pending transactions.
     def set_id
       @id = [
         amount.to_i,

data/lib/investec_open_api/version.rb

@@ -1,3 +1,3 @@
 module InvestecOpenApi
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: investec_open_api
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Community Core Team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-12 00:00:00.000000000 Z
+date: 2024-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday