tracco 0.0.9

data/lib/tracco/tracking/base.rb

@@ -0,0 +1,82 @@
+module Tracking
+  module Base
+    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 to_s
+      "[#{date}] From #{notifier.username.color(:green)}\t on card '#{trello_card.name.color(:yellow)}': #{raw_text}"
+    end
+
+    private
+
+    def tracking_notification
+      @tracking_notification
+    end
+
+    def trello_card
+      @trello_card ||= tracking_notification.card
+    end
+
+    def notification_date
+      Chronic.parse(tracking_notification.date).to_date
+    end
+
+    def raw_tracking
+      raw_text.gsub("@#{tracker_username}", "")
+    end
+
+    def raw_text
+      tracking_notification.data['text']
+    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
+  end
+end

data/lib/tracco/tracking/card_done_tracking.rb

@@ -0,0 +1,10 @@
+module Tracking
+  class CardDoneTracking
+    include Base
+
+    def add_to(card)
+      card.done = true
+    end
+
+  end
+end

data/lib/tracco/tracking/effort_tracking.rb

@@ -0,0 +1,45 @@
+module Tracking
+  class EffortTracking
+    include Base
+
+    #TODO: rename to 'amount' ?
+    #TODO: avoid recomputing effort every time using a lazy instance variable
+    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 add_to(card)
+      card.efforts << effort unless card.contains_effort?(effort)
+    end
+
+    private
+
+    def raw_effort
+      extract_match_from_raw_tracking(/\+#{DURATION_REGEXP}/)
+    end
+
+    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
+
+  end
+end

data/lib/tracco/tracking/estimate_tracking.rb

@@ -0,0 +1,23 @@
+module Tracking
+  class EstimateTracking
+    include Base
+
+    #TODO: rename to 'amount' ?
+    #TODO: avoid recomputing estimate every time using a lazy instance variable
+    def estimate
+      estimate = convert_to_hours(raw_estimate)
+      Estimate.new(amount: estimate, date: date, tracking_notification_id: tracking_notification.id)
+    end
+
+    def add_to(card)
+      card.estimates << estimate unless card.contains_estimate?(estimate)
+    end
+
+    private
+
+    def raw_estimate
+      extract_match_from_raw_tracking(/\[#{DURATION_REGEXP}\]/)
+    end
+
+  end
+end

data/lib/tracco/tracking/invalid_tracking.rb

@@ -0,0 +1,19 @@
+module Tracking
+  class InvalidTracking
+    include Base
+
+    def add_to(card)
+      # do nothing
+      Trello.logger.warn "Ignoring tracking notification: '#{raw_text}'"
+    end
+
+    def estimate
+      nil
+    end
+
+    def effort
+      nil
+    end
+
+  end
+end

data/lib/tracco/tracking_factory.rb

@@ -0,0 +1,22 @@
+class TrackingFactory
+
+  DURATION_REGEXP = '(\d+\.?\d*[phdg])'
+
+  @match_pairs = {}
+
+  def self.match(match_pair)
+    @match_pairs.merge!(match_pair)
+  end
+
+  def self.build_from(tracking_notification)
+    matching_pair = @match_pairs.find { |regexp, tracking_class| tracking_notification.data['text'] =~ regexp }
+
+    tracking_class = matching_pair ? matching_pair.last : Tracking::InvalidTracking
+    tracking_class.new(tracking_notification)
+  end
+
+  match /\[#{DURATION_REGEXP}\]/ => Tracking::EstimateTracking
+  match /\+#{DURATION_REGEXP}/ => Tracking::EffortTracking
+  match /DONE/ => Tracking::CardDoneTracking
+
+end

data/lib/tracco/trello_authorize.rb

@@ -0,0 +1,16 @@
+module TrelloAuthorize
+  include TrelloConfiguration
+  include Trello::Authorization
+
+  def authorize_on_trello(auth_params={})
+    %w{developer_public_key access_token_key}.each do |key|
+      auth_params[key.to_sym] ||= ENV[key] || authorization_params_from_config_file[key]
+    end
+
+    Trello.configure do |config|
+      config.developer_public_key = auth_params[:developer_public_key]
+      config.member_token         = auth_params[:access_token_key]
+    end
+  end
+
+end

data/lib/tracco/trello_configuration.rb

@@ -0,0 +1,39 @@
+module TrelloConfiguration
+
+  def tracker_username(forced_tracker_username=nil)
+    @tracker_username ||= forced_tracker_username || ENV["tracker_username"] || configuration["tracker_username"]
+  end
+
+  def authorization_params_from_config_file
+    begin
+      configuration["trello"]
+    rescue NoMethodError => e
+      Trello.logger.info "Invalid configuration file".color(:red)
+      {}
+    end
+
+  end
+
+  class Database
+    def self.load_env(db_env, mongoid_configuration_path=nil)
+      ENV['MONGOID_ENV'] = db_env
+      Mongoid.load!(mongoid_configuration_path || "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/tracco/trello_tracker.rb

@@ -0,0 +1,44 @@
+class TrelloTracker
+  include TrelloAuthorize
+  include Trello
+
+  trap("SIGINT") { exit! }
+
+  def initialize(custom_config_params = {})
+    authorize_on_trello(custom_config_params)
+    tracker_username(custom_config_params[:tracker_username])
+  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 = TrackingFactory.build_from(notification)
+      begin
+        tracked_card = TrackedCard.update_or_create_with(notification.card)
+        tracked_card.add!(tracking)
+        Trello.logger.info tracking
+
+      rescue StandardError => e
+        Trello.logger.warn "skipping tracking: #{e.message}".color(:magenta)
+        Trello.logger.debug "#{e.backtrace}"
+      end
+    end
+    Trello.logger.info "Done tracking cards!".color(:green)
+  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
+
+end

data/lib/tracco/version.rb

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

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,59 @@
+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
+
+  %w{piero tommaso tom ugo}.each do |username|
+    let(username.to_sym) { Member.new(username: username) }
+  end
+
+  describe "#amount_per_member" do
+    it "counts the amount spent per single member" do
+      effort = Effort.new(amount: 6, members: [piero, tommaso], date: Date.parse("2012-11-09"), )
+      effort.amount_per_member.should == 3
+    end
+  end
+
+  describe "equality" do
+    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