figo 1.2.5 → 1.3.3

data/lib/standing_order/api_call.rb

@@ -0,0 +1,24 @@
+require_relative "model.rb"
+module Figo
+  # Retreive a specific standing order.
+  # @param standing_order_id [String] - ID of standing order to retreive
+  # @param cents [Boolean] - whether to show the balance in cents (optional)
+  # @return [StandingOrder] - a single `standing_order` hash.
+  def get_standing_order(standing_order_id)
+    query_api_object StandingOrder, "/rest/standing_orders/" + standing_order_id, nil, "GET", nil
+  end
+
+  # Get all standing orders.
+  # @param cents [Boolean] - whether to show the balance in cents (optional)
+  # @return [StandingOrder] a list of `standing_order` objects.
+  def get_standing_orders()
+    query_api_object StandingOrder, "/rest/standing_orders", nil, "GET", "standing_orders"
+  end
+
+  # Get all standing orders.
+  # @param account_id [Boolean] - ID of account to standing order
+  # @return [StandingOrder] a list of `standing_order` objects.
+  def get_account_standing_orders(account_id)
+    query_api_object StandingOrder, "/rest/accounts/#{account_id}/standing_orders", nil, "GET", "standing_orders"
+  end
+end

data/lib/standing_order/model.rb

@@ -0,0 +1,75 @@
+require_relative "../base.rb"
+module Figo
+# Object representing a Payment
+  class StandingOrder < Base
+    @dump_attributes = []
+
+    def initialize(session, json)
+      super(session, json)
+    end
+
+    # Name of creditor or debtor
+    # @return [String]
+    attr_accessor :name
+
+    # Internal figo Connect standing order ID
+    # @return [String]
+    attr_accessor :standing_order_id
+
+    # Internal figo Connect account ID
+    # @return [String]
+    attr_accessor :account_id
+
+    # First execution date of the standing order
+    # @return [Date]
+    attr_accessor :first_execution_date
+
+    # Last execution date of the standing order (this field might be emtpy, if no last execution date is set)
+    # @return [Date]
+    attr_accessor :last_execution_date
+
+    # The day the standing order gets executed
+    # @return [Number]
+    attr_accessor :execution_day
+
+    # The interval the standing order gets executed (possible values are weekly, monthly, two monthly, quarterly, half yearly and yearly)
+    # @return [String]
+    attr_accessor :interval
+
+    # Name of recipient
+    # @return [String]
+    attr_accessor :name
+
+    # Account number recipient
+    # @return [String]
+    attr_accessor :account_number
+
+    # Bank code of recipient
+    # @return [String]
+    attr_accessor :bank_code
+
+    # Bank name of recipient
+    # @return [String]
+    attr_accessor :bank_name
+
+    # Standing order amount
+    # @return [Number]
+    attr_accessor :amount
+
+    # Three-character currency code
+    # @return [String]
+    attr_accessor :currency
+
+    # Purpose text (this field might be empty if the standing order has no purpose)
+    # @return [String]
+    attr_accessor :purpose
+
+    # Internal creation timestamp on the figo Connect server
+    # @return [Date]
+    attr_accessor :creation_timestamp
+
+    # Internal modification timestamp on the figo
+    # @return [Date]
+    attr_accessor :modification_timestamp
+  end
+end

data/lib/synchronization_status/api_call.rb

@@ -0,0 +1,27 @@
+require_relative "model.rb"
+module Figo
+  # Retrieve the URL a user should open in the web browser to start the synchronization process.
+  #
+  # @param redirect_uri [String] The user will be redirected to this URL after the sync process completes.
+  # @param state [String] This string will be passed on through the complete synchronization process
+  # @return [String] The result parameter is the URL to be opened by the user.
+  def get_sync_url(redirect_uri, state)
+    res = query_api "/rest/sync", {redirect_uri: redirect_uri, state: state}.to_query, "POST"
+
+    "https://" + Config.api_endpoint + "/task/start?id=" + res["task_token"]
+  end
+
+  # Retrieve the URL a user should open in the web browser to start the synchronization process.
+  #
+  # @param redirect_uri [String] the user will be redirected to this URL after the process completes
+  # @param state [String] this string will be passed on through the complete synchronization 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 if_not_synced_since [Integer] if this parameter is set, only those accounts will be
+  #        synchronized, which have not been synchronized within the specified number of minutes.
+  # @return [String] the URL to be opened by the user.
+  def sync_url(redirect_uri, state, if_not_synced_since = 0)
+    response = query_api "/rest/sync", {"redirect_uri" => redirect_uri, "state" => state, "if_not_synced_since" => if_not_synced_since}, "POST"
+    return "https://#{$api_endpoint}/task/start?id=#{response["task_token"]}"
+  end
+end

data/lib/synchronization_status/model.rb

@@ -0,0 +1,23 @@
+require_relative "../base.rb"
+module Figo
+# Object representing the bank server synchronization status
+  class SynchronizationStatus < Base
+    @dump_attributes = []
+
+    # Internal figo Connect status code
+    # @return [Integer]
+    attr_accessor :code
+
+    # Human-readable error message
+    # @return [String]
+    attr_accessor :message
+
+    # Timestamp of last synchronization
+    # @return [DateTime]
+    attr_accessor :sync_timestamp
+
+    # Timestamp of last successful synchronization
+    # @return [DateTime]
+  attr_accessor :success_timestamp
+  end
+end

data/lib/task/api_call.rb

@@ -0,0 +1,37 @@
+require_relative "model.rb"
+module Figo
+  # Start communication with bank server.
+  #
+  # @param task_token [Object] Task token object from the initial request
+  def start_task(task_token)
+    query_api("/task/start?id=" + task_token.task_token, nil, "GET");
+  end
+
+  # Poll the task progress.
+  #
+  # @param task [Object] - Task object
+  # @param options [Object] - further options (optional)
+  #    @param options.pin [Boolean] - submit PIN
+  #    @param options.continue [Boolean] - this flag signals to continue after an error condition or to skip a PIN or challenge-response entry
+  #    @param options.save_pin [Boolean] - this flag indicates whether the user has chosen to save the PIN on the figo Connect server
+  #    @param options.response [Boolean] - submit response to challenge
+  # @return [TaskState] The result parameter is a TaskState object which represents the current status of the task.
+  def get_task_state(task, options)
+    options ||= {}
+    options["id"] = task["task_token"]
+    if (options.pin)
+      options.save_pin ||= 0
+    end
+    options.continue ||= 0
+
+    query_api_object TaskState, "/task/progress?id=" + task.task_token, options.to_query, "POST", nil
+  end
+
+  # Cancel a task.
+  #
+  # @param task_token [Object] Task token object
+  def cancel_task(task_token)
+    options["id"] = task_token["task_token"]
+    query_api_object TaskToken, "/task/cancel?id=" + task_token["task_token"], options.to_query, "POST", nil
+  end
+end

data/lib/task/model.rb

@@ -0,0 +1,43 @@
+require_relative "../base.rb"
+module Figo
+
+  class TaskToken < Base
+    @dump_attributes = [:task_token]
+
+    def initialize(session, json)
+      super(session, json)
+    end
+    # Name of creditor or debtor
+    # @param task_token [Hash] - Task ID
+    attr_accessor :task_token
+  end
+
+  class TaskState < Base
+    @dump_attributes = [:account_id, :message, :is_waiting_for_pin, :is_waiting_for_response, :is_erroneous, :is_ended, :challenge]
+
+    def initialize(session, json)
+      super(session, json)
+    end
+
+    # @param account_id [String] - Account ID of currently processed accoount
+    attr_accessor :account_id
+
+    # @param message [String] - Status message or error message for currently processed amount
+    attr_accessor :message
+
+    # @param is_waiting_for_pin [Boolean] - The figo Connect server is waiting for PIN
+    attr_accessor :is_waiting_for_pin
+
+    # @param is_waiting_for_response [Boolean] - The figo Connect server is waiting for a response to the parameter challenge
+    attr_accessor :is_waiting_for_response
+
+    # @param is_erroneous [Boolean] - An error occured and the figo Connect server is waiting for continuation
+    attr_accessor :is_erroneous
+
+    # @param is_ended [Boolean] - The communication with a bank server has been completed
+    attr_accessor :is_ended
+
+    # @param challenge [Object] - A challenge object
+    attr_accessor :challenge
+  end
+end

data/lib/transaction/api_call.rb

@@ -0,0 +1,57 @@
+require_relative "model.rb"
+module Figo
+  # Retrieve list of transactions (on all or a specific account)
+  #
+  # @param account_id [String] ID of the account for which to list the transactions
+  # @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 the user
+  def transactions(account_id = nil, since = nil, count = 1000, offset = 0, include_pending = false)
+    data = {"count" => count.to_s, "offset" => offset.to_s, "include_pending" => include_pending ? "1" : "0"}
+    data["since"] = ((since.is_a?(Date) ? since.to_s : since) unless since.nil?)
+
+    query_api_object Transaction, (account_id.nil? ? "/rest/transactions?" : "/rest/accounts/#{account_id}/transactions?") + URI.encode_www_form(data), nil, "GET", "transactions"
+  end
+
+  # Retrieve a specific transaction
+  #
+  # @param account_id [String] ID of the account on which the transaction occured
+  # @param transaction_id [String] ID of the transaction to be retrieved
+  # @return [Transaction] transaction object
+  def get_transaction(account_id, transaction_id)
+    query_api_object Transaction, "/rest/accounts/#{account_id}/transactions/#{transaction_id}"
+  end
+
+  # Modify trasnaction
+  #
+  # @param account_id [String] ID of an account the transaction belongs to
+  # @param transaction_id [String] ID of the transaction
+  # @param visited [Boolean]  a bit showing whether the user has already seen this transaction or not
+  def modify_transaction(account_id, transaction_id, visited)
+    query_api_object Transaction, "/rest/accounts/" + account_id + "/transactions/" + transaction_id, {"visited" => visited}, "PUT"
+  end
+
+  # Modify transactions
+  #
+  # @param visited [Boolean] a bit showing whether the user has already seen this transaction or not
+  # @param account_id [String] ID of the account transactions belongs to (optional)
+  def modify_transactions(visited, account_id = nil)
+    if account_id
+      query_api "/rest/accounts/" + account_id + "/transactions", {"visited" => visited}, "PUT"
+    else
+      query_api "/rest/transactions", {"visited" => visited}, "PUT"
+    end
+  end
+
+  # Delete transaction
+  #
+  # @param account_id [String] ID of an account the transaction belongs to
+  # @param transaction_id [String] ID of transaction to be deleted
+  def delete_transaction(account_id, transaction_id)
+    query_api "/rest/accounts/" + account_id + "/transactions/" + transaction_id, nil, "DELETE"
+  end
+end

data/lib/transaction/model.rb

@@ -0,0 +1,75 @@
+require_relative "../base.rb"
+module Figo
+  # Object representing one bank transaction on a certain bank account of the User
+  class Transaction < Base
+    @dump_attributes = []
+
+    def initialize(session, json)
+      super(session, json)
+    end
+
+    # Internal figo Connect transaction ID
+    # @return [String]
+    attr_accessor :transaction_id
+
+    # Internal figo Connect account ID
+    # @return [String]
+    attr_accessor :account_id
+
+    # Name of originator or recipient
+    # @return [String]
+    attr_accessor :name
+
+    # Account number of originator or recipient
+    # @return [String]
+    attr_accessor :account_number
+
+    # Bank code of originator or recipient
+    # @return [String]
+    attr_accessor :bank_code
+
+    # Bank name of originator or recipient
+    # @return [String]
+    attr_accessor :bank_name
+
+    # Transaction amount
+    # @return [DecNum]
+    attr_accessor :amount
+
+    # Three-character currency code
+    # @return [String]
+    attr_accessor :currency
+
+    # Booking date
+    # @return [Date]
+    attr_accessor :booking_date
+
+    # Value date
+    # @return [Date]
+    attr_accessor :value_date
+
+    # Purpose text
+    # @return [String]
+    attr_accessor :purpose
+
+    # Transaction type
+    # @return [String]
+    attr_accessor :type
+
+    # Booking text
+    # @return [String]
+    attr_accessor :booking_text
+
+    # This flag indicates whether the transaction is booked or pending
+    # @return [Boolean]
+    attr_accessor :booked
+
+    # Internal creation timestamp on the figo Connect server
+    # @return [DateTime]
+    attr_accessor :creation_timestamp
+
+    # Internal modification timestamp on the figo Connect server
+    # @return [DateTime]
+    attr_accessor :modification_timestamp
+  end
+end

data/lib/user/api_call.rb

@@ -0,0 +1,46 @@
+require_relative "model.rb"
+module Figo
+  # Retrieve current User
+  #
+  # @return [User] the current user
+  def user
+    query_api_object User, "/rest/user"
+  end
+
+  # Modify the current user
+  #
+  # @param user [User] the modified user object to be saved
+  # @return [User] the modified user returned
+  def modify_user(user)
+    query_api_object User, "/rest/user", user.dump(), "PUT"
+  end
+
+  # Remove the current user
+  # Note: this has immidiate effect and you wont be able to interact with the user after this call
+  #
+  def remove_user
+    query_api "/rest/user", nil, "DELETE"
+  end
+
+  # Re-send verification email
+  #
+  def resend_verification
+    query_api "/rest/user/resend_verification", nil, "POST"
+  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
+  # @return [Hash]  an object with the key `recovery_password` as documented in the figo Connect API specification.
+  def create_user(name, email, password, language, send_newsletter=nil)
+    options = { name: name, email: email, password: password, send_newsletter: send_newsletter }
+    options["language"] = language if (language)
+    options["send_newsletter"] = !!send_newsletter == send_newsletter ? send_newsletter : nil
+
+    query_api "/auth/user", options
+  end
+
+end

data/lib/user/model.rb

@@ -0,0 +1,55 @@
+require_relative "../base.rb"
+module Figo
+  # Object representing an User
+  class User < Base
+    @dump_attributes = [:name, :address, :send_newsletter, :language]
+
+    def initialize(session, json)
+      super(session, json)
+    end
+
+    # Internal figo Connect User ID
+    # @return [String]
+    attr_accessor :User_id
+
+    # First and last name
+    # @return [String]
+    attr_accessor :name
+
+    # Email address
+    # @return [String]
+    attr_accessor :email
+
+    #Postal address for bills, etc.
+    # @return [Dict]
+    attr_accessor :address
+
+    # This flag indicates whether the email address has been verified
+    # @return [Boolean]
+    attr_accessor :verified_email
+
+    # This flag indicates whether the User has agreed to be contacted by email
+    # @return [Boolean]
+    attr_accessor :send_newsletter
+
+    # Two-letter code of preferred language
+    # @return [String]
+    attr_accessor :language
+
+    # This flag indicates whether the figo Account plan is free or premium
+    # @return [Boolean]
+    attr_accessor :premium
+
+    # Timestamp of premium figo Account expiry
+    # @return [DateTime]
+    attr_accessor :premium_expires_on
+
+    # Provider for premium subscription or nil of no subscription is active
+    # @return [String]
+    attr_accessor :premium_subscription
+
+    # Timestamp of figo Account registration
+    # @return [DateTime]
+    attr_accessor :join_date
+  end
+end