Class: QuestradeApi::REST::Activity

Inherits:

Base

• Object
• Base
• QuestradeApi::REST::Activity

Defined in:

lib/questrade_api/rest/activity.rb

Overview

Author:

• Bruno Meira goesmeira@gmail.com

Constant Summary

Constants inherited from Base

Base::BASE_ENDPOINT

Instance Attribute Summary

• #account_id ⇒ Object

  Returns the value of attribute account_id.

Attributes inherited from Base

#authorization, #connection, #data, #endpoint, #id, #raw_body

Class Method Summary

• .endpoint(account_id) ⇒ Object
• .fetch(authorization, account_number, params) ⇒ Object

  Fetch account activities.

Instance Method Summary

• #initialize(params) ⇒ Activity constructor

  A new instance of Activity.

Methods inherited from Base

#build_attributes, #build_data, connection, #fetch, post, #url

Constructor Details

#initialize(params) ⇒ Activity

Returns a new instance of Activity.

# File 'lib/questrade_api/rest/activity.rb', line 9

def initialize(params)
  @account_id = params[:account_id]

  @raw_body = params[:data]
  build_data(params[:data]) if @raw_body
end

Instance Attribute Details

#account_id ⇒ Object

Returns the value of attribute account_id.

# File 'lib/questrade_api/rest/activity.rb', line 7

def account_id
  @account_id
end

Class Method Details

.endpoint(account_id) ⇒ Object

# File 'lib/questrade_api/rest/activity.rb', line 39

def self.endpoint(account_id)
  "#{BASE_ENDPOINT}/accounts/#{account_id}/activities"
end

.fetch(authorization, account_number, params) ⇒ Object

Fetch account activities

Parameters:

• authorization (QuestradeApi::Authorization) —

  with the authorized #access_token and #url.

• account_number (String) —

  with the account the activities will be fetched

• params (Hash) —

  with the range of dates the activities will be fetched

Options Hash (params):

• :startTime (String) —

  The start time. ex: '2011-02-16T00:00:00.000000-05:00'

• :endTime (String) —

  The end time. ex: '2011-02-16T00:00:00.000000-05:00'

# File 'lib/questrade_api/rest/activity.rb', line 24

def self.fetch(authorization, account_number, params)
  response = super(access_token: authorization.access_token,
                   endpoint: endpoint(account_number),
                   url: authorization.url,
                   params: params)

  result = OpenStruct.new(activities: [])

  if response.status == 200
    result.activities = parse_activities(account_number, response.body)
  end

  result
end