tracco 0.0.9

data/.gitignore

@@ -0,0 +1,28 @@
+config.yml
+mongoid.yml
+.rvmrc
+tracco.sublime-workspace
+
+.tmtags
+.tags
+.tags_sorted_by_file
+
+.DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--format doc
+--order rand

data/.rvmrc.template

@@ -0,0 +1,2 @@
+rvm 1.9.3-p385@spikes --create
+rvm wrapper 1.9.3-p385@spikes textmate

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+rvm:
+  - 1.9.3
+
+env:
+  global:
+    - developer_public_key: e/zPNGKOwapoxFWZs/CBTAhaoqrDTkqqz+InOmCUvGBcZBpUxH398nPLv8Hi\nNQSvWuspzqanyNbbQrTA/2XhsWF1gIFX+gNexYM7S+MxtRwUD3cpVT8DzVOS\nMuckdMTEAADVsm92vIX/bUs5igxD4+zfXlhzXUNDrzRlZnsUF2M=
+    - access_token_key: GG1Q8oq7GkaXjP0lbMgvQLLEi+LXOZlwmELqjPk39Exfy8114QUs2ki8nr9n\ndGO+tgOSZsCd/bt9IHxS3WWWU0INSYOTgp/prfsDDgosg7/Elk/b6w1OW0At\nX3VAjMeI0yAGloT6XB58LCFyrj6S2b4vCQqyaHR3tlTHai/5bMQ=
+    - tracker_username=trackinguser
+    - MONGOID_ENV=test
+
+services:
+  - mongodb
+
+script: ./script/ci/run_build.sh
+
+before_script:
+  - mongo tracco_test --eval 'db.addUser("travis", "test");'
+  - "./script/ci/before_script.sh"
+

data/CHANGELOG

@@ -0,0 +1,32 @@
+0.0.8 - 0.0.9
+  - Gem rename :)
+
+0.0.7
+  - Minor refactorings on the rake tasks
+
+0.0.6
+  - Added TrackedCard#status to track card status: :todo if no effort has been spent, :done if the card is in a DONE column, :in_progress otherwise
+  - Added a Members#effort_spent and #effort_spent_since to extract the overall effort tracked by a member since a given date
+  - Re-merged in the trello_effort_app branch to bring on the Rails app
+
+0.0.5
+  - Improved docs
+  - Improved use of this tool as a gem
+
+0.0.4
+  - A card moved into a DONE column is closed
+
+0.0.3
+  - When I send a tracking with "DONE" then the card is "closed" (aka "finished")
+  - Export all cards in a Google Docs spreadsheet
+  - When I card change its name, the tracked card should be updated too
+  - A card should tells its estimate error (3)
+
+0.0.2
+  - Very simple Rails app on a separate branch, still experimenting
+  - Should be able to open a Trello console with a rake task
+  - Avoid running the script if already run for that period
+  - Tracking data is now persisted in a mongo database
+
+0.0.1
+  - Initial Release.

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+# gem 'ruby-trello', :require => 'trello', :path => '../ruby-trello' # to hack on the ruby-trello gem itself
+
+group :test do
+  gem 'simplecov', :require => false, :platforms => [:mri, :mri_19]
+end

data/Gemfile.lock

@@ -0,0 +1,110 @@
+PATH
+  remote: .
+  specs:
+    tracco (0.0.9)
+      bson_ext
+      chronic
+      google_drive
+      highline
+      mongoid
+      rainbow
+      ruby-trello
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.12)
+      activesupport (= 3.2.12)
+      builder (~> 3.0.0)
+    activesupport (3.2.12)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    addressable (2.3.2)
+    bson (1.8.2)
+    bson_ext (1.8.2)
+      bson (~> 1.8.2)
+    builder (3.0.4)
+    chronic (0.9.0)
+    columnize (0.3.6)
+    database_cleaner (0.9.1)
+    debugger (1.3.1)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.1.1)
+      debugger-ruby_core_source (~> 1.1.8)
+    debugger-linecache (1.1.2)
+      debugger-ruby_core_source (>= 1.1.1)
+    debugger-ruby_core_source (1.1.8)
+    diff-lcs (1.1.3)
+    faraday (0.8.5)
+      multipart-post (~> 1.1)
+    google_drive (0.3.3)
+      nokogiri (>= 1.4.4, != 1.5.2, != 1.5.1)
+      oauth (>= 0.3.6)
+      oauth2 (>= 0.5.0)
+    highline (1.6.15)
+    httpauth (0.2.0)
+    i18n (0.6.1)
+    json (1.7.7)
+    jwt (0.1.5)
+      multi_json (>= 1.0)
+    mime-types (1.21)
+    mongoid (3.1.0)
+      activemodel (~> 3.2)
+      moped (~> 1.4.2)
+      origin (~> 1.0)
+      tzinfo (~> 0.3.22)
+    mongoid-rspec (1.6.0)
+      mongoid (>= 3.0.1)
+      rake
+      rspec (>= 2.9)
+    moped (1.4.2)
+    multi_json (1.6.0)
+    multi_xml (0.5.3)
+    multipart-post (1.1.5)
+    nokogiri (1.5.6)
+    oauth (0.4.7)
+    oauth2 (0.9.0)
+      faraday (~> 0.8)
+      httpauth (~> 0.1)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    origin (1.0.11)
+    rack (1.5.2)
+    rainbow (1.1.4)
+    rake (10.0.3)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.2)
+    ruby-trello (0.5.1)
+      activemodel
+      addressable (~> 2.3)
+      json
+      oauth (~> 0.4.5)
+      rest-client (~> 1.6.7)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    tzinfo (0.3.35)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  database_cleaner
+  debugger
+  mongoid-rspec
+  rake
+  rspec
+  rspec-mocks
+  simplecov
+  tracco!

data/LICENSE.txt

@@ -0,0 +1,15 @@
+Pietro Di Bello
+2012
+
+In the original BSD license, both occurrences of the phrase "COPYRIGHT HOLDERS AND CONTRIBUTORS" in the disclaimer read "REGENTS AND CONTRIBUTORS".
+
+Here is the license template:
+
+Copyright (c) 2012, Pietro Di Bello
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,292 @@
+[![Build Status](https://secure.travis-ci.org/xpepper/tracco.png)](http://travis-ci.org/xpepper/tracco)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/xpepper/tracco)
+
+# Tracco
+
+## What is Tracco?
+Tracco is a Trello effort tracker: the purpose of Tracco is to extract and track estimates and actual efforts out of the cards on your Trello boards.
+You simply notify all of your estimates and efforts tracked on your Trello cards using a conventional format.
+Tracco will extract and store these estimates and actual efforts to let you mine useful key metrics (e.g. estimate errors, remaining efforts, pair programming frequencies, and so on).
+
+## Why Tracco?
+Trello is a very good surrogate for a physical team board: it's simple and effective, and it can really help when you have a distributed team.
+That said, Trello does not (still) offer a way to track time estimated and actually spent on cards, though many people [ask for that feature](https://trello.com/card/time-tracking/4d5ea62fd76aa1136000000c/1054) on Trello's development board.
+
+Having that precise need, we defined a simple convention to track estimates and efforts on cards: we use a predefined board member (let's call him 'tracking user') which we sent special notifications to (we call them 'tracking notifications').
+This 'tracking user' will then receives estimates and efforts notifications, and Tracco will collect and store them.
+Moreover, a web app will be soon available to properly present card estimates and efforts (we're working on it).
+
+## More details
+All you need to have to start using Tracco is a Trello account, a Trello board and a board member to use as 'tracking user'.
+You'll also need to know your Trello developer key and generate a proper auth token to have access to the trackinguser's notifications.
+To see how to have these two keys, see [the following section](#api_key).
+
+The Trello API is used behind the scenes to read data from the team board. Tracco uses the awesome [Trello API Ruby wrapper](https://github.com/jeremytregunna/ruby-trello) for this purpose.
+
+## Usage
+This tool can be used as a standalone gem or cloning this git repo.
+
+### Installation as a ruby gem
+
+```shell
+gem install tracco
+```
+
+### Installation cloning the repo
+
+```shell
+git clone git://github.com/xpepper/tracco.git
+```
+
+Then cd in the cloned repo and copy the config template
+
+```shell
+cd tracco
+cp config/config.template.yaml config/config.yml
+```
+
+and then fill the correct values in the placeholders in config.yml (see _"Where do I get an API key and API secret?"_ section).
+
+Then copy the mongoid config template
+
+```shell
+cp config/mongoid.template.yaml config/mongoid.yml
+```
+
+and fill the correct values for the mongodb environments ([see here](http://mongoid.org/en/mongoid/docs/installation.html#configuration) to have more details).
+
+Then run bundle to get all the required gems:
+
+```shell
+bundle install
+```
+
+
+Full Disclosure: this library is still work-in-progress, so if you find anything missing or not functioning as you expect it to, please [open an issue on github](https://github.com/xpepper/tracco/issues).
+
+## Requirements
+* [mongoDB](http://www.mongodb.org/) - macosx users with homebrew will just run 'brew install mongodb' to have mongoDB installed on their machine.
+* (optional) [rvm](https://rvm.io/rvm/install/) is useful (but optional) for development
+
+
+
+### <a id="api_key"></a>Where do I get an API key?
+Log in to Trello with your account and visit [https://trello.com/1/appKey/generate](https://trello.com/1/appKey/generate) to get your developer\_public\_key.
+
+### Where do I get an API Access Token Key?
+To generate a proper access token key, log in to Trello with the 'tracking user' account. Then go to this URL:
+
+    https://trello.com/1/connect?key=<YOUR_DEVELOPER_PUBLIC_KEY>&name=Trello+Effort+Tracker&response_type=token&scope=read,write&expiration=never
+
+At the end of this process, you'll receive a valid access\_token\_key, which is needed by Tracco to fetch all the tracking notifications sent to the 'tracking user'.
+
+## Usage
+The best way is to use one of the rake task defined, e.g.
+
+```ruby
+rake 'run:today[test]' # will extract today's tracked data and store on the test db
+
+rake run:today  # will extract today's tracked data and store on the default (that is development) db
+
+rake 'run:from_day[2012-11-1, production]'  # will extract tracked data starting from November the 1st, 2012 and store them into the production db
+```
+
+Or you may just create a TrelloTracker instance and execute its track method.
+
+```ruby
+require 'tracco'
+
+tracker = TrelloTracker.new
+tracker.track
+```
+
+## Configuration params
+### Mongo storage configuration
+Tracking data collected from Trello are stored in a MongoDB database.
+
+There are two env variables you can set to configure mongodb
+
+- `MONGOID_ENV` defines which mongodb env is actually used (development, test, production). Development is the default mongo environment.
+- `MONGOID_CONFIG_PATH` defines the path to the mongoid configuration file (default is `config/mongoid.yml`)
+
+A standard mongoid.yml is the following:
+
+```yml
+development:
+  sessions:
+    default:
+      database: tracco_dev
+      hosts:
+        - localhost:27017
+test:
+  sessions:
+    default:
+      database: tracco_test
+      hosts:
+        - localhost:27017
+production:
+  autocreate_indexes: true
+  persist_in_safe_mode: true
+
+  sessions:
+    default:
+      database: tracco_production
+      hosts:
+        - localhost:27017
+```
+
+#### Trello configuration params
+You can set the Trello's configuration params in three ways.
+Through the following environment variables (ENV object):
+
+```
+  access_token_key
+  developer_public_key
+  tracker_username
+```
+
+Passing into the constructor a hash containing the auth values:
+
+```ruby
+tracker = TrelloTracker.new(
+ developer_public_key: "487635b55e6fe9021902fa763b4d101a",
+ access_token_key: "33bed56f2a12a49c9ba1c2d6ad3e2002e11a34358c3f3fe260d7fba746a06203",
+ tracker_username: "my_personal_tracker")
+
+tracker.track
+```
+
+Or using the config.yml (which is the actual fallback mode, useful in development mode).
+
+### Console
+You can open a irb console with the ruby-trello gem and this gem loaded, so that you can query the db or the Trello API and play with them
+
+```ruby
+rake console
+```
+
+The default env is development. To load a console in the (e.g.) production db env, execute:
+
+```ruby
+rake "console[production]"
+```
+
+### Estimate format convention
+To set an estimate on a card, a Trello user should send a notification from that card to the tracker username, e.g.
+
+    @trackinguser [15p]
+    @trackinguser [1.5d]
+    @trackinguser [12h]
+
+estimates can be given in hours (h), days (d/g) or pomodori (p).
+
+    @trackinguser 22.11.2012 [4h]
+
+will add the estimate (4 hours) in date 22.11.2012.
+
+### Effort format convention
+To set an effort in the current day on a card, a Trello user should send a notification from that card to the tracker username, e.g.
+
+    @trackinguser +6p
+    @trackinguser +4h
+    @trackinguser +0.5g
+
+efforts can be given in hours (h), days (d/g) or pomodori (p).
+
+### Tracking an effort in a specific date
+To set an effort in a date different from the notification date, just add a date in the message
+
+    @trackinguser 23.10.2012 +6p
+
+There's even a shortcut for efforts spent yesterday:
+
+    @trackinguser yesterday +6p
+    @trackinguser +6p yesterday
+
+### Tracking an effort on more members
+By default, the effort is tracked on the member which sends the tracking notification.
+
+To set an effort for more than a Trello user (e.g. pair programming), just add the other user in the message, e.g.
+
+    @trackinguser +3p @alessandrodescovi
+
+To set an effort just for other Trello users (excluding the current user), just include the users in round brackets, e.g.
+
+    @trackinguser +3p (@alessandrodescovi @michelevincenzi)
+
+### Tracking a card as finished (aka DONE)
+Sending a tracking notification with the word DONE
+
+    @trackinguser DONE
+
+will mark the card as closed.
+
+Moreover, a card moved into a DONE column (the name of the Trello list contains the word "Done") is automatically marked as done.
+
+## Database import/export
+To export the db you can execute something like:
+
+```shell
+mongoexport --db tracco_production --collection tracked_cards --out tracco_production.json
+```
+
+To reimport that db:
+
+```shell
+mongoimport  --db tracco_production --collection tracked_cards --file tracco_production.json
+```
+
+## Google Docs exporter
+To export all your tracked cards on a google docs named 'my_sheet' in the 'tracking' worksheet, run
+
+```ruby
+rake "export:google_docs[my_sheet, tracking, production]"
+```
+The default env is development.
+
+If you provide no name for the spreadsheet, a default name will be used.
+If the spreadsheet name you provide does not exists, it will be created in you google drive account.
+
+So, running simply
+
+```ruby
+rake export:google_docs
+```
+will create (or update) a spreadsheet named "trello effort tracking" using the development db env.
+
+## Keeping your tracking database up to date
+You may install a crontab entry to run the trello tracker periodically, for example
+
+```shell
+SHELL=/Users/futur3/.rvm/bin/rvm-shell
+GEMSET="ruby-1.9.3-p385@spikes"
+PROJECT_PATH="/Users/$USER/Documents/workspace/tracco"
+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
+```
+
+## Roadmap and improvements
+We develop Tracco using [Trello itself](https://trello.com/board/trello-effort-tracker-roadmap/509c3228dcb1ac3f1c018791).
+
+## Contributing
+To get started, [sign the Contributor License Agreement](http://www.clahub.com/agreements/xpepper/tracco).
+
+If you'd like to hack on Tracco, start by forking the repo on GitHub:
+
+https://github.com/xpepper/tracco
+
+The best way to get your changes merged back into core is as follows:
+
+1. Clone down your fork
+1. Create a thoughtfully named topic branch to contain your change
+1. Hack away
+1. Add tests and make sure everything still passes by running `rake spec`
+1. If you are adding new functionality, document it in the README
+1. Do not change the version number, we will do that on our end
+1. If necessary, rebase your commits into logical chunks, without errors
+1. Push the branch up to GitHub
+1. Send a pull request for your branch
+
+[@pierodibello](http://twitter.com/pierodibello)