rallytastic 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/Gemfile

@@ -0,0 +1,10 @@
+source 'http://rubygems.org'
+
+gem 'rake'
+gem 'jeweler'
+gem 'mongoid', '2.0.0.beta.15'
+gem 'bson_ext'
+gem 'rest-client'
+gem 'rspec'
+gem 'autotest'
+gem 'thor'

data/Gemfile.lock

@@ -0,0 +1,51 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.0.rc)
+      activesupport (= 3.0.0.rc)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activesupport (3.0.0.rc)
+    autotest (4.3.2)
+    bson (1.0.4)
+    bson_ext (1.0.4)
+    builder (2.1.2)
+    gemcutter (0.6.1)
+    git (1.2.5)
+    i18n (0.4.1)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.3)
+    mime-types (1.16)
+    mongo (1.0.6)
+      bson (>= 1.0.4)
+    mongoid (2.0.0.beta.15)
+      activemodel (= 3.0.0.rc)
+      bson (= 1.0.4)
+      mongo (= 1.0.6)
+      tzinfo (= 0.3.22)
+      will_paginate (~> 3.0.pre)
+    rake (0.8.7)
+    rest-client (1.6.0)
+      mime-types (>= 1.16)
+    rspec (1.3.0)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    thor (0.14.0)
+    tzinfo (0.3.22)
+    will_paginate (3.0.pre2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest
+  bson_ext
+  jeweler
+  mongoid (= 2.0.0.beta.15)
+  rake
+  rest-client
+  rspec
+  thor

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Matt Clark
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,85 @@
+= rallytastic
+== Description
+
+Do you use Rally?  Every day?  Do you use it enough that you've run out of ways to hack the site to get that last ounce of customization from it?  The reports, for example, while very good, aren't quite what you need to run your dev shop, are they?  If you've taken a look at the RallyAPI longingly in the past, but written it off as too much work to do anything meaningful with, then Rallytastic is offering you a helping hand.
+
+Rallytastic is a set of objects built on MongoDB and Mongoid, along with Thor tasks that pull data out of Rally and stuff it into those objects.  Once there, Rallytastic tries to get out of your way and lets the data be your playground.  Have at it with a platic shovel and Tonka Bulldozer if that'll get you up in the morning. You were born to get down with your bad Rally self.  Be Awesome. 
+
+Rallytastic is intended to be the foundation of a web app that reports User Story data back to Rally users.  It augments Rally proper primarily as an extention to the reporting capabilities.  For example, if you are more concerned with the throughput of your dev teams than their velocity, Rallytastic is going to help you build custom fit measuring tools for that.  It has built in helpers to walk through the revision logs of your stories and identify key events in their lifecycle.  You can track work in progress(WIP) levels over time, measure how long stories sit prioritized on your backlog before dev starts,  identify queues and bottlenecks anywhere between story definition time and release, and much more.
+
+== Congiguration
+
+In a file that is required from lib/rallytastic.rb, you can configure Rally authentication.
+  RallyAPI::configure do |config|
+    config.user = "username@AwesomeCompany.com"
+    config.password = "password"
+  end
+
+You also need to have Mongo running, and let your app know what database to use.  Either do it the Rails .yml way, or put something like this in a config file and include it:
+  Mongoid.configure do |config|
+    name = "rallytastic_dev"
+    host = "localhost"
+    config.master = Mongo::Connection.new.db(name)
+    config.persist_in_safe_mode = false
+  end
+
+
+You should also set mongo to use a testing database in spec/spec_helper.rb
+  Mongoid.configure do |config|
+    name = "rallytastic_test"
+    host = "localhost"
+    config.master = Mongo::Connection.new.db(name)
+    config.persist_in_safe_mode = false
+  end
+
+
+==Usage
+
+=== Populating your MongoDB for the first time
+  > bundle exec thor scraper:projects
+  > bundle exec thor scraper:iterations
+  > bundle exec thor scraper:refresh
+
+=== Revisions are pulled on request per iteration
+  > bundle exec thor scraper:revisions "Iteration Name"
+
+=== On an ongoing basis, updating stories is quicker
+  > bundle exec thor scraper:refresh
+  # update the story revisions for the iteration you are interested in
+  > bundle exec thor scraper:revisions "Iteration Name"
+
+=== Thor Tasks
+==== scraper:help [TASK]
+# Describe available tasks or one specific task
+==== scraper:refresh
+# Pulls down Rally stories since the last run, and creates Iterations and Projects as needed. This is the task you want to put in your job scheduler.
+==== scraper:stories
+# Walk Rally stories updated since last run
+==== scraper:update_non_stories
+# The scrape:stroies task creates shell iterations and projects for any that it doesn't know about yet. This task looks for those, and pull their information down from Rally
+==== scraper:revisions iteration_name
+# Get the revisions for stories hanging off an iteration
+==== scraper:projects
+# Bootstrapping method that is primarily useful when you are setting up Rallytastic for the first time. It will walk Rally and pull down all projects. Technically, you don't need to run this because using the scrape:stories; scrape:update_non_stories; will fill this information in for you. It may be a bit quicker though to run this first if you have a lot of projects because it does batch queries
+==== scraper:iterations
+# Bootstrapping method that is primarily useful when you are setting up Rallytastic for the first time. It will walk Rally and pull down all Iterations. Technically, you don't need to run this because using the scrape:stories; scrape:update_non_stories; will fill this information in for you. It may be a bit quicker though to run this first if you have a lot of iterations because it does batch queries
+<End of Thor Tasks>
+
+== TODO
+* Add Releases
+* Taging stories
+* Reporting engine
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Matt Clark. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rallytastic"
+    gem.summary = %Q{Its a Rally story teleporter}
+    gem.description = %Q{longer description of your gem}
+    gem.email = "winescout@gmail.com"
+    gem.homepage = "http://github.com/winescout/rallytastic"
+    gem.authors = ["Matt Clark"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rallytastic #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/iteration.rb

@@ -0,0 +1,52 @@
+class Iteration
+  include Mongoid::Document
+  include Rally::ParsingHelpers
+  extend Rally::ParsingHelperClassMethods
+
+  class << self
+    def rally_uri
+      "/iteration.js"
+    end
+  end
+
+  field :name
+  field :rally_uri
+  field :created_on, :type => Date
+  field :description
+  field :notes
+  field :state
+  field :start_date, :type => Date
+  field :end_date, :type => Date
+  field :resources
+  field :theme
+  
+  referenced_in :project
+  references_many :stories
+
+  def refresh hash_values=nil
+    @rally_hash = hash_values
+    from_rally :rally_uri, :_ref
+    from_rally :name
+    from_rally :theme
+    from_rally :state
+    from_rally :created_on, :_CreatedAt
+    from_rally :start_date, :StartDate
+    from_rally :end_date, :EndDate
+    from_rally :resources
+
+    self.save
+  rescue ArgumentError #getting some bad created_on dates
+    puts "Errored on #{self.name}"
+    self.save # save what you can
+  end
+
+  #has to be called after refresh, or with hash_values passed in
+  def associate hash_values=nil
+    @rally_hash = hash_values if hash_values
+    if @rally_hash.has_key?("Project")
+      project = Project.find_or_create_by(:rally_uri => @rally_hash["Project"]["_ref"])
+      project.iterations << self
+    end
+    self.save
+  end
+end

data/lib/parsers/base.rb

@@ -0,0 +1,23 @@
+module Parser
+  class Base
+    attr_accessor :story
+    def initialize story
+      @story = story
+    end
+
+    def revisions
+      @story.revisions
+    end
+
+    protected
+    def latest_revision_date_matching regexp
+      revision = revisions.desc(:created_on).select{|r| r.description =~ regexp}.first
+      revision.created_on if revision
+    end
+
+    def first_revision_date_matching regexp
+      revision = revisions.asc(:created_on).select{|r| r.description =~ regexp}.first
+      revision.created_on if revision
+    end
+  end
+end

data/lib/parsers/madison.rb

@@ -0,0 +1,23 @@
+module Parser
+  class Madison < Base    
+    def sized_on
+      first_revision_date_matching /TASK ESTIMATE TOTAL changed from \[0.0\]/
+    end
+
+    def prioritized_on
+      last_revision_date_matching /PROJECT changed from \[[^\]]*\] to \[Madison\]/
+    end
+
+    def started_on
+      last_revision_date_matching /ITERATION added/
+    end
+
+    def completed_on
+      last_revision_date_matching /SCHEDULE STATE changed from \[[^\]]*\] to [Complete]/
+    end
+
+    def accepted_on
+      last_revision_date_matching /SCHEDULE STATE changed from \[[^\]]*\] to [Accepted]/
+    end    
+  end
+end

data/lib/project.rb

@@ -0,0 +1,46 @@
+class Project
+  include Mongoid::Document
+  include Rally::ParsingHelpers
+  extend Rally::ParsingHelperClassMethods
+
+  class << self
+    def rally_uri
+      "/project.js"
+    end
+  end
+
+  field :name
+  field :rally_uri
+  field :created_on
+  field :description
+  field :notes
+  field :state
+
+  field :revision_parser
+
+  referenced_in :parent, :class_name => "Project"
+  references_many :children, :class_name => "Project"
+  references_many :iterations  
+
+  def refresh hash_values=nil
+    @rally_hash = hash_values if hash_values
+    from_rally :name
+    from_rally :description
+    from_rally :state
+    from_rally :notes
+
+    self.save
+
+  end
+  
+  #must be called after refresh, or with has_values passed in
+  def associate hash_values=nil
+    @rally_hash = hash_values if hash_values
+    #TODO: associate with user when users are supported
+    if @rally_hash["Parent"]
+      parent = Project.find_or_create_by(:rally_uri => @rally_hash["Parent"]["_ref"])
+      self.parent = parent
+    end
+    self.save
+  end
+end

data/lib/rally/parsing_helpers.rb

@@ -0,0 +1,70 @@
+module Rally
+  module ParsingHelperClassMethods
+    def node_name
+      if self.to_s == "Story"
+        "HierarchicalRequirement"
+      else
+        self.to_s
+      end
+    end
+
+    def from_uri(uri)
+      obj = first(:conditions => {:rally_uri => uri}) || new(:rally_uri => uri)
+      obj.refresh
+    end
+
+    def rally_query options={}
+      RallyAPI.all(self, options)
+    end
+  end
+
+  module ParsingHelpers
+    def raw_json options = {}
+      options[:refresh] = options[:refresh] || false
+
+      unless self.rally_uri
+        raise "Could not fetch resource"
+      end
+      
+      if @rally_hash
+        return @rally_hash 
+      else
+        @rally_hash = get_fields_from_rally
+      end
+  
+      @rally_hash
+  
+    end
+  
+    private
+
+    def get_fields_from_rally
+      rally_hash = RallyAPI.get(self)
+      
+      #special case for heirarchical_requirements
+      if rally_hash.has_key? "HierarchicalRequirement"
+        rally_hash = rally_hash["HierarchicalRequirement"]
+      end
+
+      rally_hash
+    end
+
+    #next 3 are for mapping from rally to mongo
+    def from_rally attr, key=nil
+      key = key || attr.capitalize
+      self.send("#{attr.to_s}=", raw_json[key.to_s])
+    end
+
+    def parse_refs key, rally_objects
+      if self.respond_to?(key) && !rally_objects.nil?
+        self.send("#{key.to_s}=", rally_objects.collect{|i| i["_ref"]})
+      end
+    end
+  
+    def parse_ref key, rally_object  
+      if self.respond_to?(key) && !rally_object.nil?
+        self.send("#{key.to_s}=", rally_object["_ref"])
+      end
+    end
+  end
+end