trello_effort_tracker 0.0.3

data/lib/trello_effort_tracker/tracked_card.rb

@@ -0,0 +1,103 @@
+class TrackedCard
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  extend MongoidHelper
+
+  field :name
+  field :description
+  field :short_id,    type: Integer
+  field :trello_id
+  field :due,         type: Date
+  field :closed,      type: Boolean
+  field :url
+  field :pos
+
+  embeds_many :estimates
+  embeds_many :efforts
+
+  validates_presence_of :name, :short_id, :trello_id
+  validates_numericality_of :short_id
+
+  def self.find_by_trello_id(trello_id)
+    without_mongo_raising_errors do
+      find_by(trello_id: trello_id)
+    end
+  end
+
+  def self.update_or_create_with(trello_card)
+    card = TrackedCard.find_or_create_by(trello_id: trello_card.id)
+    trello_card.attributes.delete(:id)
+    success = card.update_attributes(trello_card.attributes)
+    return card if success
+  end
+
+  def self.build_from(trello_card)
+    trello_card_id = trello_card.id
+    trello_card.attributes.delete(:id)
+    new(trello_card.attributes.merge(trello_id: trello_card_id))
+  end
+
+  def add(tracking)
+    if tracking.estimate? && estimates.none? {|e| e.tracking_notification_id == tracking.estimate.tracking_notification_id}
+      estimates << tracking.estimate
+    elsif tracking.effort? && efforts.none? {|e| e.tracking_notification_id == tracking.effort.tracking_notification_id}
+      efforts << tracking.effort
+    else
+      Trello.logger.warn "Ignoring tracking notification: #{tracking}" if tracking.unknown_format?
+    end
+  end
+
+  def no_tracking?
+    first_activity_date.nil?
+  end
+
+  def first_activity_date
+    [working_start_date, first_estimate_date].compact.min
+  end
+
+  def working_start_date
+    efforts.sort_by(&:date).first.date if efforts.present?
+  end
+
+  def first_estimate_date
+    estimates.sort_by(&:date).first.date if estimates.present?
+  end
+
+  def last_estimate_date
+    estimates.sort_by(&:date).last.date if estimates.present?
+  end
+
+  def total_effort
+    efforts.map(&:amount).inject(0, &:+)
+  end
+
+  def members
+    efforts.map(&:members).flatten.uniq
+  end
+
+  def last_estimate_error
+    estimate_errors.last
+  end
+
+  def estimate_errors
+    return [] if estimates.empty? || efforts.empty?
+
+    estimate_errors = []
+    estimates.each do |each|
+      estimate_errors << (100 * ((total_effort - each.amount) / each.amount * 1.0)).round(2)
+    end
+
+    estimate_errors
+  end
+
+  def to_s
+    "[#{name}]. Total effort: #{total_effort}h. Estimates #{estimates.map(&:to_s)}. Efforts: #{efforts.map(&:to_s)}"
+  end
+
+  def ==(other)
+    return true if other.equal?(self)
+    return false unless other.kind_of?(self.class)
+    trello_id == other.trello_id
+  end
+
+end

data/lib/trello_effort_tracker/tracking.rb

@@ -0,0 +1,130 @@
+class Tracking
+  extend Forwardable
+  include TrelloConfiguration
+
+  TIME_CONVERTERS = {
+    'h' => lambda { |estimate| estimate },
+    'd' => lambda { |estimate| estimate * 8 },
+    'g' => lambda { |estimate| estimate * 8 },
+    'p' => lambda { |estimate| estimate / 2  }
+  }
+
+  DURATION_REGEXP = '(\d+\.?\d*[phdg])'
+  DATE_REGEXP = /(\d{2})\.(\d{2})\.(\d{4})/
+
+  # delegate to the trello notification the member_creator method aliased as 'notifier'
+  def_delegator :@tracking_notification, :member_creator, :notifier
+
+  def initialize(tracking_notification)
+    @tracking_notification = tracking_notification
+  end
+
+  def date
+    Chronic.parse(date_as_string).to_date
+  end
+
+  def estimate?
+    !raw_estimate.nil?
+  end
+
+  def estimate
+    estimate = convert_to_hours(raw_estimate)
+    Estimate.new(amount: estimate, date: date, tracking_notification_id: @tracking_notification.id) if estimate
+  end
+
+  def effort?
+    !raw_effort.nil?
+  end
+
+  def effort
+    effort_amount = convert_to_hours(raw_effort)
+    if effort_amount
+      total_effort = effort_amount * effort_members.size
+      Effort.new(amount: total_effort, date: date, members: effort_members, tracking_notification_id: @tracking_notification.id)
+    end
+  end
+
+  def unknown_format?
+    !estimate? && !effort?
+  end
+
+  def to_s
+    "[#{date}] From #{notifier.username.color(:green)}\t on card '#{trello_card.name.color(:yellow)}': #{raw_text}"
+  end
+
+  private
+
+  def effort_members
+    @effort_members ||= users_involved_in_the_effort.map do |username|
+      Member.build_from(Trello::Member.find(username))
+    end
+
+    @effort_members
+  end
+
+  def users_involved_in_the_effort
+    users_involved_in_the_effort = raw_tracking.scan(/@(\w+)/).flatten
+    users_involved_in_the_effort << notifier.username unless should_count_only_listed_members?
+
+    users_involved_in_the_effort
+  end
+
+  def should_count_only_listed_members?
+    raw_tracking =~ /\((@\w+\W*\s*)+\)/
+  end
+
+  def raw_tracking
+    raw_text.gsub("@#{tracker_username}", "")
+  end
+
+  def raw_text
+    @tracking_notification.data['text']
+  end
+
+  def raw_estimate
+    extract_match_from_raw_tracking(/\[#{DURATION_REGEXP}\]/)
+  end
+
+  def raw_effort
+    extract_match_from_raw_tracking(/\+#{DURATION_REGEXP}/)
+  end
+
+  def convert_to_hours(duration_as_string)
+    return if duration_as_string.nil?
+
+    time_scale = duration_as_string.slice!(-1)
+    converter = TIME_CONVERTERS[time_scale]
+    converter.call(Float(duration_as_string))
+  end
+
+  def date_as_string
+    case raw_tracking
+    when DATE_REGEXP
+      day, month, year = raw_tracking.scan(DATE_REGEXP).flatten
+      "#{year}-#{month}-#{day}"
+    when /yesterday\s+\+#{DURATION_REGEXP}/, /\+#{DURATION_REGEXP}\s+yesterday/
+      (notification_date - 1).to_s
+    else
+      @tracking_notification.date
+    end
+  end
+
+  def extract_match_from_raw_tracking(regexp)
+    extracted = nil
+    raw_tracking.scan(regexp) do |match|
+      extracted = match.first
+    end
+
+    extracted
+  end
+
+  def trello_card
+    @trello_card ||= @tracking_notification.card
+  end
+
+  def notification_date
+    Chronic.parse(@tracking_notification.date).to_date
+  end
+
+end
+

data/lib/trello_effort_tracker/trello_authorize.rb

@@ -0,0 +1,32 @@
+module TrelloAuthorize
+  include TrelloConfiguration
+  include Trello::Authorization
+
+  def authorize_on_trello(auth_params={})
+    %w{developer_public_key access_token_key developer_secret}.each do |key|
+      auth_params[key] ||= ENV[key] || authorization_params_from_config_file[key]
+    end
+
+    init_trello(auth_params)
+  end
+
+  private
+
+  def init_trello(auth_params)
+    ignoring_warnings do
+      Trello::Authorization.const_set(:AuthPolicy, OAuthPolicy)
+    end
+
+    OAuthPolicy.consumer_credential = OAuthCredential.new(auth_params["developer_public_key"], auth_params["developer_secret"])
+    OAuthPolicy.token = OAuthCredential.new(auth_params["access_token_key"], nil)
+  end
+
+  def ignoring_warnings(&block)
+    begin
+      v, $VERBOSE = $VERBOSE, nil
+      block.call if block
+    ensure
+      $VERBOSE = v
+    end
+  end
+end

data/lib/trello_effort_tracker/trello_configuration.rb

@@ -0,0 +1,33 @@
+module TrelloConfiguration
+
+  def tracker_username
+    @tracker_username ||= ENV["tracker_username"] || configuration["tracker_username"]
+  end
+
+  def authorization_params_from_config_file
+    configuration["trello"]
+  end
+
+  class Database
+    def self.load_env(db_env)
+      ENV['MONGOID_ENV'] = db_env
+      Mongoid.load!("config/mongoid.yml", db_env)
+      Trello.logger.info "Mongo db env: #{db_env.color(:green)}."
+    end
+  end
+
+  private
+
+  def db_environment
+    ENV['MONGOID_ENV']
+  end
+
+  def configuration
+    @configuration ||= load_configuration
+  end
+
+  def load_configuration
+    YAML.load_file("config/config.yml")
+  end
+
+end

data/lib/trello_effort_tracker/trello_tracker.rb

@@ -0,0 +1,48 @@
+class TrelloTracker
+  include TrelloAuthorize
+  include Trello
+
+  trap("SIGINT") { exit! }
+
+  def initialize(custom_auth_params = {})
+    authorize_on_trello(custom_auth_params)
+  end
+
+  def track(starting_date=Date.today)
+    notifications = tracker.notifications_from(starting_date)
+
+    oldest, latest = boundary_dates_in(notifications)
+    Trello.logger.info "Processing #{notifications.size} tracking notifications (from #{oldest} to #{latest}) starting from #{starting_date}..."
+
+    notifications.each do |notification|
+      tracking = Tracking.new(notification)
+      begin
+        card = TrackedCard.update_or_create_with(notification.card)
+        card.add(tracking)
+        Trello.logger.info tracking
+
+      rescue StandardError => e
+        Trello.logger.error "skipping tracking: #{e.message}".color(:magenta)
+        Trello.logger.error "#{e.backtrace}"
+      end
+    end
+    Trello.logger.info "Done tracking cards!".color(:green)
+    print_all_cards
+  end
+
+  private
+
+  def tracker
+    @tracker ||= Member.find(tracker_username)
+  end
+
+  def boundary_dates_in(notifications)
+    dates = notifications.map { |each_notification| Chronic.parse(each_notification.date) }
+    [dates.min, dates.max]
+  end
+
+  def print_all_cards
+    TrackedCard.all.each { |tracked_card| Trello.logger.info(tracked_card.to_s.color(:yellow)) }
+  end
+
+end

data/lib/trello_effort_tracker/version.rb

@@ -0,0 +1,3 @@
+class TrelloEffortTracker
+  VERSION = '0.0.3'
+end

data/lib/trello_effort_tracker.rb

@@ -0,0 +1,23 @@
+require 'trello'
+require 'rainbow'
+require 'set'
+require 'yaml'
+require 'chronic'
+require 'mongoid'
+
+require 'trello_effort_tracker/mongoid_helper'
+require 'trello_effort_tracker/trello_configuration'
+require 'trello_effort_tracker/trello_authorize'
+require 'trello_effort_tracker/tracked_card'
+require 'trello_effort_tracker/member'
+require 'trello_effort_tracker/estimate'
+require 'trello_effort_tracker/effort'
+require 'trello_effort_tracker/tracking'
+require 'trello_effort_tracker/trello_tracker'
+require 'trello_effort_tracker/google_docs_exporter'
+
+require 'patches/trello/member'
+
+TrelloConfiguration::Database.load_env(ENV['MONGOID_ENV'] || "development")
+
+Trello.logger.level = Logger::DEBUG

data/script/ci/before_script.sh

@@ -0,0 +1 @@
+cp -f config/mongoid.template.yml config/mongoid.yml

data/script/ci/run_build.sh

@@ -0,0 +1,2 @@
+#!/usr/bin/env sh
+bundle exec rake spec:fast

data/script/crontab.template

@@ -0,0 +1,8 @@
+SHELL=/Users/pierodibello/.rvm/bin/rvm-shell
+
+GEMSET="ruby-1.9.3-p194@spikes"
+PROJECT_PATH="/Users/$USER/Documents/workspace/trello_effort_tracker"
+LC_ALL=en_US.UTF-8
+
+# m h  dom mon dow   command
+*/10 * * * *  rvm-shell $GEMSET -c "cd $PROJECT_PATH;  bundle exec rake run:today[production]" >> /tmp/crontab.out 2>&1

data/script/mate.sh

@@ -0,0 +1 @@
+mate $(ls -a | grep -v '\.\.$' | grep -v '\.$' | grep -v '\.git$'| grep -v '\.DS_Store'| grep -v '\.tmtags' | grep -v '\tags')

data/spec/effort_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+require 'mongoid-rspec'
+
+describe Effort do
+
+  it { should have_fields(:amount, :date) }
+  it { should be_embedded_in(:tracked_card) }
+  it { should embed_many(:members) }
+
+  describe "validation" do
+    it { should validate_presence_of(:amount) }
+    it { should validate_presence_of(:date) }
+    it { should validate_presence_of(:members) }
+  end
+
+  describe "equality" do
+    %w{piero tommaso tom ugo}.each do |username|
+      let(username.to_sym) { Member.new(username: username) }
+    end
+
+    it "is equal to another effort with same amount, date and members" do
+      effort          = Effort.new(amount: 3, date: Date.parse("2012-11-09"), members: [piero, tommaso])
+      same_effort     = Effort.new(amount: 3, date: Date.parse("2012-11-09"), members: [piero, tommaso])
+      yet_same_effort = Effort.new(amount: 3, date: Date.parse("2012-11-09"), members: [tommaso, piero])
+
+      effort.should == same_effort
+      effort.should == yet_same_effort
+    end
+
+    it "is not equal when amount differs" do
+      effort          = Effort.new(amount: 3, date: Date.today, members: [tom, ugo])
+      another_effort  = Effort.new(amount: 1, date: Date.today, members: [tom, ugo])
+
+      effort.should_not == another_effort
+    end
+
+    it "is not equal when date differs" do
+      effort          = Effort.new(amount: 3, date: Date.parse("2012-11-09"), members: [tom, ugo])
+      another_effort  = Effort.new(amount: 3, date: Date.parse("2011-10-08"), members: [tom, ugo])
+
+      effort.should_not == another_effort
+    end
+
+    it "is not equal when members differ" do
+      effort         = Effort.new(amount: 3, date: Date.today, members: [tom, ugo])
+      another_effort = Effort.new(amount: 3, date: Date.today, members: [piero, ugo])
+
+      effort.should_not == another_effort
+    end
+
+  end
+end

data/spec/estimate_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'mongoid-rspec'
+
+describe Estimate do
+
+  it { should have_fields(:amount, :date) }
+  it { should be_embedded_in(:tracked_card) }
+
+  describe "validation" do
+    it { should validate_presence_of(:amount) }
+    it { should validate_presence_of(:date) }
+  end
+
+  describe "equality" do
+
+    it "is equal to another estimate with same amount and date" do
+      estimate          = Estimate.new(amount: 3, date: Date.parse("2012-11-09"))
+      same_estimate     = Estimate.new(amount: 3, date: Date.parse("2012-11-09"))
+
+      estimate.should == same_estimate
+    end
+
+    it "is not equal when amount differs" do
+      estimate          = Estimate.new(amount: 3, date: Date.today)
+      another_estimate  = Estimate.new(amount: 1, date: Date.today)
+
+      estimate.should_not == another_estimate
+    end
+
+    it "is not equal when date differs" do
+      estimate          = Estimate.new(amount: 3, date: Date.parse("2012-11-09"))
+      another_estimate  = Estimate.new(amount: 3, date: Date.parse("2011-10-08"))
+
+      estimate.should_not == another_estimate
+    end
+
+  end
+end

data/spec/integration/trello_authorization_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+require 'trello'
+
+describe "TrelloAuthorization" do
+  include TrelloAuthorize
+
+  it "authorizes connection to Trello", :needs_valid_configuration => true do
+    authorize_on_trello
+    
+    Trello::Member.find("me").should_not be_nil
+  end
+end

data/spec/member_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+require 'mongoid-rspec'
+
+describe Member do
+
+  it { should have_fields(:trello_id, :username, :full_name, :avatar_id, :bio, :url) }
+  it { should be_embedded_in(:effort) }
+
+  describe "validation" do
+    it { should validate_presence_of(:username) }
+  end
+
+  describe "equality" do
+    it "is equal to another member with the same username" do
+      member            = Member.new(username: "piero")
+      same_member       = Member.new(username: "piero")
+      different_member  = Member.new(username: "tommaso")
+
+      member.should == same_member
+      member.should_not == different_member
+    end
+  end
+
+  describe ".build_from" do
+    it "builds a Member from a Trello Member" do
+      member = Member.build_from(Trello::Member.new("username" => "piero"))
+
+      member.username.should == "piero"
+    end
+
+    it "takes the Trello Member id and set it as trello_id" do
+      member = Member.build_from(Trello::Member.new("username" => "piero", "id" => "1234567abc"))
+
+      member.id.should_not    == "1234567abc"
+      member.trello_id.should == "1234567abc"
+    end
+  end
+
+  describe "#avatar_url" do
+    it "points to the avatar thumbnail image" do
+      member = Member.new(avatar_id: "123xyz")
+      member.avatar_url.should == "https://trello-avatars.s3.amazonaws.com/123xyz/30.png"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+
+# Set up gems listed in the Gemfile.
+begin
+  ENV['BUNDLE_GEMFILE'] = File.expand_path('../Gemfile', File.dirname(__FILE__))
+  require 'bundler'
+  Bundler.setup
+rescue Bundler::GemNotFound => e
+  STDERR.puts e.message
+  STDERR.puts "Try running `bundle install`."
+  exit!
+end
+
+Bundler.require
+
+RSpec.configure do |configuration|
+  configuration.include Mongoid::Matchers
+end
+
+# force test env for the mongodb configuration
+TrelloConfiguration::Database.load_env("test")