figo 1.2.5 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d33b8e8414b4a922aa26cc3cd8cbb5d6d7bdff30
-  data.tar.gz: e091d3ae3a764120fb5e2e2a0d9f6098a4e4f85b
+  metadata.gz: 522d66983f2ecf3c65e75386ef0749f3bbcb2919
+  data.tar.gz: 1db05284c5e87715a096355f07d61704312d194d
 SHA512:
-  metadata.gz: 5c9dc3f1706a858ae802ce40d76dbcdb9d3f3e5b6e6dcf5337c09379fc3f5279283ed75d4a33164fbc437552e494c7f045609545ac1eba3cb8b33fc65c97c1a6
-  data.tar.gz: 837a9922915b002ce70de7c2c2813970a51b03992289d721340ea8b22befee10ea21214dd9db1f0d928af016d7d77f6701db4c395d1ffa44a5ef1086510013d4
+  metadata.gz: 73d0b043a1b5eb4337bc51a0e8f5c740da13954fe1063135b65791f2b8b2532d2d2f5314c339c81a6455dda7ef89d01a9dd8fe5b413ebcfe4d8e81153a56ca4c
+  data.tar.gz: 7cd01b360f8cfad374e8558fa5ddfb9ea41a939b73fb6d36f8cc10b9ff59dbb717d2b2b2f206074271107aea54e76274bedccd60ce216598e4ef3b11fa46dfd2

data/Gemfile

@@ -4,3 +4,4 @@ gemspec
 
 gem "rake"
 gem "minitest"
+gem "net-http-persistent", ">= 3.0.0"

data/config.yml

@@ -0,0 +1,4 @@
+API_ENDPOINT: api.figo.me
+FINGER_PRINTS:
+  - "38:AE:4A:32:6F:16:EA:15:81:33:8B:B0:D8:E4:A6:35:E7:27:F1:07"
+  - "DB:E2:E9:15:8F:C9:90:30:84:FE:36:CA:A6:11:38:D8:5A:20:5D:93"

data/console_demo.rb

@@ -10,5 +10,5 @@ end
 
 # Print out the list of all transaction originators/recipients of a specific account.
 session.get_account("A1.1").transactions.each do |transaction|
-  puts transaction.name
+ puts transaction.name
 end

data/figo.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |s|
   s.name        = "figo"
-  s.version     = "1.2.5"
-  s.authors     = ["Stefan Richter"]
-  s.email       = ["stefan.richter@figo.me"]
+  s.version     = "1.3.3"
+  s.authors     = ["Denys Zaliskyi"]
+  s.email       = ["dz@figo.me"]
   s.homepage    = "https://github.com/figo-connect/ruby-figo"
   s.license     = "MIT"
   s.summary     = %q{API wrapper for figo Connect.}

data/lib/account/api_call.rb

@@ -0,0 +1,55 @@
+require_relative "model.rb"
+module Figo
+  # Retrieve all accounts
+  #
+  # @return [Array] an array of `Account` objects, one for each account the user has granted the app access
+  def accounts
+    query_api_object Account, "/rest/accounts", nil, "GET", "accounts"
+  end
+
+  # Retrieve specific account.
+  #
+  # @param account_id [String] ID of the account to be retrieved.
+  # @return [Account] account object
+  def get_account(account_id)
+    query_api_object Account, "/rest/accounts/#{account_id}"
+  end
+
+  # Modify specific account
+  #
+  # @param account [Account] modified account to be saved
+  # @return [Account] modified account returned by the server
+  def modify_account(account)
+    query_api_object Account, "/rest/accounts/#{account.account_id}", account.dump(), "PUT"
+  end
+
+  # Remove specific account
+  #
+  # @param account [Account, String] the account to be removed or its ID
+  def remove_account(account)
+    query_api account.is_a?(String) ? "/rest/accounts/#{account}" : "/rest/accounts/#{account.account_id}", nil, "DELETE"
+  end
+
+  # Set bank account sort order
+  #
+  # @param accounts [Array] List of JSON objects with the field account_id set to the internal figo Connect account ID (the accounts will be sorted in the list order)
+  def account_sort_order (accounts)
+    query_api "/rest/accounts", accounts, "PUT"
+  end
+
+  # Add new bank account_sort_order
+  #
+  # @param country_code [String] Two-letter country code
+  # @param credentials [Array] List of login credential strings
+  # @param bank_code [String] Bank code (will be overriden if IBAN is present)
+  # @param iban [String] IBAN
+  # @param save_pon [Boolean] This flag indicates whether the user has chosen to save the PIN on the figo Connect server
+  def add_account(country, credentials, bank_code, iban, save_pin)
+    data = {"country" => country, "credentials" => credentials}
+    data["iban"] = iban if (iban)
+    data["bank_code"] = bank_code if(bank_code)
+    data["save_pin"] = !!save_pin == save_pin ? save_pin : false
+
+    query_api_object TaskToken, "/rest/accounts", data, "POST"
+  end
+end

data/lib/account/model.rb

@@ -0,0 +1,122 @@
+require_relative "../base.rb"
+module Figo
+# Object representing one bank account of the User
+  class Account < Base
+    @dump_attributes = [:name, :owner, :auto_sync]
+
+    def initialize(session, json)
+      super(session, json)
+    end
+
+    # Internal figo Connect account ID
+    # @return [String]
+    attr_accessor :account_id
+
+    # Internal figo Connect bank ID
+    # @return [String]
+    attr_accessor :bank_id
+
+    # Account name
+    # @return [String]
+    attr_accessor :name
+
+    # Account owner
+    # @return [String]
+    attr_accessor :owner
+
+    # This flag indicates whether the account will be automatically synchronized
+    # @return [Boolean]
+    attr_accessor :auto_sync
+
+    # Account number
+    # @return [String]
+    attr_accessor :account_number
+
+    # Bank code
+    # @return [String]
+    attr_accessor :bank_code
+
+    # Bank name
+    # @return [String]
+    attr_accessor :bank_name
+
+    # Three-character currency code
+    # @return [String]
+    attr_accessor :currency
+
+    # IBAN
+    # @return [String]
+    attr_accessor :iban
+
+    # BIC
+    # @return [String]
+    attr_accessor :bic
+
+    # Account type
+    # @return [String]
+    attr_accessor :type
+
+    # Account icon URL
+    # @return [String]
+    attr_accessor :icon
+
+    # Account icon URLs for other resolutions
+    # @return [Hash]
+    attr_accessor :additional_icons
+
+    # This flag indicates whether the balance of this account is added to the total balance of accounts
+    # @return [Boolean]
+    attr_accessor :in_total_balance
+
+    # Synchronization status object
+    # @return [SynchronizationStatus]
+    attr_accessor :status
+
+    # AccountBalance object
+    # @return [AccountBalance]
+    attr_accessor :balance
+
+    # Request list of transactions of this account
+    #
+    # @param since [String, Date] this parameter can either be a transaction ID or a date
+    # @param count [Integer] limit the number of returned transactions
+    # @param offset [Integer] which offset into the result set should be used to determin the first transaction to return (useful in combination with count)
+    # @param include_pending [Boolean] this flag indicates whether pending transactions should be included
+    #        in the response; pending transactions are always included as a complete set, regardless of
+    #        the `since` parameter
+    # @return [Array] an array of `Transaction` objects, one for each transaction of this account
+    def transactions(since = nil, count = 1000, offset = 0, include_pending = false)
+      @session.transactions @account_id, since, count, offset, include_pending
+    end
+
+    # Request specific transaction.
+    #
+    # @param transaction_id [String] ID of the transaction to be retrieved
+    # @return [Transaction] transaction object
+    def get_transaction(transaction_id)
+      @session.get_transaction @acount_id, transaction_id
+    end
+
+    # Retrieve list of payments on this account
+    #
+    # @return [Payment] an array of `Payment` objects, one for each payment
+    def payments
+      @session.payments @account_id
+    end
+
+    # Retrieve specific payment on this account
+    #
+    # @param payment_id [String] ID of the notification to be retrieved
+    # @return [Payment] `Payment` object for the respective payment
+    def get_payment(payment_id)
+      @session.get_payment @account_id, payment_id
+    end
+
+    # Retrieve bank of this account
+    #
+    # @return [Bank] `Bank` object for the respective bank
+    def bank
+      @session.get_bank @bank_id
+    end
+  end
+end

data/lib/account_balance/api_call.rb

@@ -0,0 +1,18 @@
+require_relative "model.rb"
+module Figo
+  # Retrieve balance of an account.
+  #
+  # @return [AccountBalance] account balance object
+  def get_account_balance(account_id)
+    query_api_object AccountBalance, "/rest/accounts/#{account_id}/balance"
+  end
+
+  # Modify balance or account limits
+  #
+  # @param account_id [String] ID of the account which balance should be modified
+  # @param account_balance [AccountBalance] modified AccountBalance to be saved
+  # @return [AccountBalance] modified AccountBalance returned by server
+  def modify_account_balance(account_id, account_balance)
+    query_api_object AccountBalance, "/rest/accounts/#{account_id}/balance", account_balance.dump(), "PUT"
+  end
+end

data/lib/account_balance/model.rb

@@ -0,0 +1,31 @@
+require_relative "../base.rb"
+module Figo
+  # Object representing the balance of a certain bank account of the User
+  class AccountBalance < Base
+    @dump_attributes = [:credit_line, :monthly_spending_limit]
+
+    def initialize(session, json)
+      super(session, json)
+    end
+
+    # Account balance or `nil` if the balance is not yet known
+    # @return [DecNum]
+    attr_accessor :balance
+
+    # Bank server timestamp of balance or `nil` if the balance is not yet known
+    # @return [Date]
+    attr_accessor :balance_date
+
+    # Credit line.
+    # @return [DecNum]
+    attr_accessor :credit_line
+
+    # User-defined spending limit
+    # @return [DecNum]
+    attr_accessor :monthly_spending_limit
+
+    # Synchronization status object
+    # @return [SynchronizationStatus]
+    attr_accessor :status
+  end
+end

data/lib/authentification/api_call.rb

@@ -0,0 +1,88 @@
+module Figo
+  # Get the URL a user should open in the web browser to start the login process.
+  #
+  # When the process is completed, the user is redirected to the URL provided to
+  # the constructor and passes on an authentication code. This code can be converted
+  # into an access token for data access.
+  #
+  # @param state [String] this string will be passed on through the complete login
+  #        process and to the redirect target at the end. It should be used to
+  #        validated the authenticity of the call to the redirect URL
+  # @param scope [String] optional scope of data access to ask the user for,
+  #        e.g. `accounts=ro`
+  # @return [String] the URL to be opened by the user.
+  def login_url(state, scope = nil)
+    data = { "response_type" => "code", "client_id" => @client_id, "state" => state }
+    data["redirect_uri"] = @redirect_uri unless @redirect_uri.nil?
+    data["scope"] = scope unless scope.nil?
+    return "https://#{$api_endpoint}/auth/code?" + URI.encode_www_form(data)
+  end
+
+
+  # Exchange authorization code or refresh token for access token.
+  #
+  # @param authorization_code_or_refresh_token [String] either the authorization
+  #        code received as part of the call to the redirect URL at the end of the
+  #        logon process, or a refresh token
+  # @param scope [String] optional scope of data access to ask the user for,
+  #        e.g. `accounts=ro`
+  # @return [Hash] object with the keys `access_token`, `refresh_token` and `expires`, as documented in the figo Connect API specification.
+  def obtain_access_token(authorization_code_or_refresh_token, scope = nil)
+    # Authorization codes always start with "O" and refresh tokens always start with "R".
+    if authorization_code_or_refresh_token[0] == "O"
+      data = { "grant_type" => "authorization_code", "code" => authorization_code_or_refresh_token }
+      data["redirect_uri"] = @redirect_uri unless @redirect_uri.nil?
+    elsif authorization_code_or_refresh_token[0] == "R"
+      data = { "grant_type" => "refresh_token", "refresh_token" => authorization_code_or_refresh_token }
+      data["scope"] = scope unless scope.nil?
+    end
+    query_api "/auth/token", data
+  end
+
+  # Revoke refresh token or access token.
+  #
+  # @note this action has immediate effect, i.e. you will not be able use that token anymore after this call.
+  #
+  # @param refresh_token_or_access_token [String] access or refresh token to be revoked
+  # @return [nil]
+  def revoke_token(refresh_token_or_access_token)
+    data = { "token" => refresh_token_or_access_token }
+    query_api "/auth/revoke", data
+  end
+
+  # Create a new figo Account
+  #
+  # @param name [String] First and last name
+  # @param email [String] Email address; It must obey the figo username & password policy
+  # @param password [String] New figo Account password; It must obey the figo username & password policy
+  # @param language [String] Two-letter code of preferred language
+  # @param send_newsletter [Boolean] This flag indicates whether the user has agreed to be contacted by email -- Not accepted by backend at the moment
+  # @return [Hash] object with the key `recovery_password` as documented in the figo Connect API specification
+  def create_user(name, email, password, language='de', send_newsletter=true)
+      data = { 'name' => name, 'email' => email, 'password' => password, 'language' => language, 'affiliate_client_id' => @client_id} #'send_newsletter' => send_newsletter,
+    query_api "/auth/user", data
+  end
+
+  # Re-send verification email
+  #
+  def resend_verification()
+    query_api "/rest/user/resend_verification", nil, "POST"
+  end
+
+  # Return a Token dictionary which tokens are used for further API calls.
+  #
+  # @param username [String] figo username
+  # @param password [String] figo password
+  # @return The result parameter is an object with the keys `access_token`, `token_type`, `expires_in`, `refresh_token` and `scope` as documented in the figo Connect API specification.
+  def credential_login(username, password, device_name = nil, device_type = nil, device_udid = nil, scope = nil)
+    options = { grant_type: "password", username: username, password: password }
+
+    options[:device_name] = device_name if (device_name)
+    options[:device_type] = device_type if (device_type)
+    options[:device_udid] = device_udid if (device_udid)
+    options[:scope] = scope if (scope)
+
+    query_api "/auth/token", options
+  end
+
+end

data/lib/bank/api_call.rb

@@ -0,0 +1,49 @@
+require_relative "model.rb"
+module Figo
+  # Retrieve specific bank
+  #
+  # @return [Bank] bank object
+  def get_bank(bank_id)
+    query_api_object Bank, "/rest/banks/#{bank_id}"
+  end
+
+  # Modify bank
+  #
+  # @param bank [Bank] modified bank object
+  # @return [Bank] modified bank object returned by server
+  def modify_bank(bank)
+    query_api_object Bank, "/rest/banks/#{bank.bank_id}", bank.dump(), "PUT"
+  end
+
+  # Remove stored PIN from bank
+  #
+  # @param bank [Bank, String] the bank whose stored PIN should be removed or its ID
+  # @return [nil]
+  def remove_bank_pin(bank)
+    query_api bank.is_a?(String) ? "/rest/banks/#{bank}/remove_pin" : "/rest/banks/#{bank.bank_id}/remove_pin", nil, "POST"
+  end
+
+  # Get bank information from standard bank code
+  #
+  # @param country_code [String]
+  # @param bank_code [String] bank sort code (Bankleitzahl)
+  # @return [Hash] JSON response
+  def find_bank(bank_code, country_code = "DE")
+    query_api "/rest/catalog/banks/#{country_code}/#{bank_code}"
+  end
+
+  # Get supported services
+  #
+  # @param country_code [String] the country code the service comes from
+  # @param service [String] filter the type of service to request (optional): `banks`, `services` or everything (default)
+  def get_supported_payment_services(country_code="DE", service)
+    case service
+    when "banks"
+      query_api("/rest/catalog/banks/" + country_code, nil)
+    when "service"
+      query_api("/rest/catalog/services/" + country_code, nil)
+    else
+      query_api("/rest/catalog/" + country_code, nil)
+    end
+  end
+end

data/lib/bank/model.rb

@@ -0,0 +1,23 @@
+require_relative "../base.rb"
+module Figo
+  # Object representing a bank, i.e. an connection to a bank
+  class Bank < Base
+    @dump_attributes = [:sepa_creditor_id]
+
+    def initialize(session, json)
+      super(session, json)
+    end
+
+    # Internal figo Connect bank ID
+    # @return [String]
+    attr_accessor :bank_id
+
+    # SEPA direct debit creditor ID
+    # @return [String]
+    attr_accessor :sepa_creditor_id
+
+    # This flag indicates whether the user has chosen to save the PIN on the figo Connect server
+    # @return [Boolean]
+    attr_accessor :save_pin
+  end
+end

data/lib/base.rb

@@ -0,0 +1,56 @@
+require "date"
+require "flt"
+
+module Figo
+  # Set decimal precision to two digits.
+  Flt::DecNum.context.precision = 2
+
+  # Abstract base class for model objects.
+  class Base
+    # Attributes to be dumped (called by modify and create)
+    @dump_attributes = []
+    def self.dump_attributes
+      @dump_attributes
+    end
+
+    # Instantiate model object from hash.
+    #
+    # @param session [Session] figo `Session` object
+    # @param hash [Hash] use keys of this hash for model object creation
+    def initialize(session, hash)
+      @session = session
+
+      hash.each do |key, value|
+        key = key.to_s if key.is_a? Symbol
+        next unless respond_to? "#{key}="
+        next if value.nil?
+
+        if key == "status" and value.is_a? Hash
+          value = SynchronizationStatus.new(session, value)
+        elsif key == "balance" and value.is_a? Hash
+          value = AccountBalance.new(session, value)
+        elsif key == "amount" or key == "balance" or key == "credit_line" or key == "monthly_spending_limit"
+          value = Flt::DecNum(value.to_s)
+        elsif key.end_with?("_date")
+          value = DateTime.iso8601(value)
+        elsif key.end_with?("_timestamp")
+          value = DateTime.iso8601(value)
+        end
+        send("#{key}=", value)
+      end
+    end
+
+    # Dump committable attributes to a hash
+    def dump
+      result = {}
+      self.class.dump_attributes.each do |attribute|
+        value = send attribute
+        next if value.nil?
+        value = value.to_f if value.is_a? Flt::DecNum
+
+        result[attribute] = value
+      end
+      return result
+    end
+  end
+end