module TimeTrello

Author: Ronaldo Faria Lima
Created: 2016-03-21

Describes a duration in hours and minutes and proper operations using those.

Constants

VERSION

Attributes

prefix[RW]

Private: Prefix for comment detection/parsing

Public Class Methods

find_all(start_date, end_date, board_id, &filter) click to toggle source

Public: Generates the report based on the provided parameters.

start_date - The start date to limit the results. end_date - The end date to limit the results. board_id - Identification of the board that should be parsed in order to

return results.

filter - A block containing a filter for the results. The block must receive

a parameter which is an instance of ActivityRecord.

# File lib/time_trello.rb, line 41
def self.find_all(start_date, end_date, board_id, &filter)
  self.report(start_date, end_date, board_id).find_all(&filter)
end

initialize(public_key, member_token, prefix = ':clock12:') click to toggle source

Public: Initializes this module with the proper trello client configuration.

public_key - Trello public key used for authentication. member_token - Trello member token, used for authentication.

# File lib/time_trello.rb, line 25
def self.initialize(public_key, member_token, prefix = ':clock12:')
  @prefix = prefix
  Trello.configure do |config|
    config.developer_public_key = public_key
    config.member_token = member_token
  end
end

report(start_date, end_date, board_id) click to toggle source

Private: Getter for a report instance. Guarantees only one single instance available for caching optimization.

# File lib/time_trello.rb, line 47
def self.report(start_date, end_date, board_id)
  if @report.nil?
    @report = Report.new(start_date, end_date, board_id, @prefix)
  else
    # Updates report parameters
    @report.start_date = start_date
    @report.end_date = end_date
    @report.board_id = board_id
  end
  
  @report
end