stories_sync 0.0.1

data/README.markdown

@@ -0,0 +1,37 @@
+Stories Sync
+============
+
+The idea behind this gem is to have a tool to help you manage your user stories.
+
+It'a a great combo to use [stories](github.com/citrusbyte/storires) + [Pivotal Tracker](http://www.pivotaltracker.com) for your integration testing, and it works pretty fine out of the box. However, one can't avoid thinking that there's something missing. For example there's no obvious way to run your user stories or generate reports easily; one would have to create a rake task or something like that.
+
+And what about the ability to have pending stories? seems like a cool idea, but for that to make any sense, one would have to copy/past every story (one by one) on your backlog at the beginning of each sprint to your local stories file, mark them as pending stories and start them one at a time. Seems like a lot of work. It is.
+
+Finally, if you discover that a story actually needs to be splitted in two, or you just want to add a new story and start implementing it, it's kind of a drag to have to log in to pivotal, create the story, move it to the backlog, mark it as "started", then go back to your local file, copy it there and finally start coding.
+
+What we wanted is the following workflow:
+
+    $ stories sync
+
+That's it. That simple command will fetch the pivotal stories and add them as pending stories in your file and also upload any new local story to pivotal.
+
+If you want to run your stories with the standard stories output:
+
+    $ stories run
+
+To generate a pdf report:
+
+    $ stories report
+
+
+Setup and usage
+---------------
+
+This gem requires you to have a pivotal.yml in your config directory, but this can be generated automatically. Just execute the following:
+
+    $ stories setup
+
+This will ask you for your pivotal username and password, then it will fetch your api token and finally it will create a config file for you.
+After that you are all set. You just need to have a stories file in /test/stories/stories.rb.
+
+_Right now this gem supports a single stories file only. This is the first version though, we are working for multiple file support._

data/bin/stories

@@ -0,0 +1,9 @@
+#! /usr/bin/env ruby -rubygems
+
+require File.join(File.dirname(__FILE__), "..", "lib", "stories_sync.rb")
+
+if File.exists?("Thorfile")
+  load("Thorfile")
+end
+
+Stories.start

data/lib/pivotal.rb

@@ -0,0 +1,17 @@
+CONFIG_FILE = File.join("#{Dir.pwd}", "config", "pivotal.yml")
+
+# Failsafe in case there's no config file
+raise "You don't have a configuration file yet, try running 'stories setup'" unless File.exists?(CONFIG_FILE)
+
+PIVOTAL_CONFIG = YAML.load_file(CONFIG_FILE)
+
+# Interaction with Pivotal
+class Iteration < ActiveResource::Base
+  self.site = "http://www.pivotaltracker.com/services/v2/projects/#{PIVOTAL_CONFIG[:project][:id]}"
+  headers['X-TrackerToken'] = PIVOTAL_CONFIG[:user][:token]
+end
+
+class Story < ActiveResource::Base
+  self.site = "http://www.pivotaltracker.com/services/v2/projects/#{PIVOTAL_CONFIG[:project][:id]}"
+  headers['X-TrackerToken'] = PIVOTAL_CONFIG[:user][:token]
+end

data/lib/stories_sync.rb

@@ -0,0 +1,177 @@
+#! /usr/bin/env ruby
+
+require "rubygems"
+require 'restclient'
+require "activeresource"
+require "thor"
+require "yaml"
+require File.join("#{File.dirname(__FILE__)}", "pivotal.rb")
+
+# FIXME We are using both restclient and ARes at the moment.
+# We should migrate everything to restclient, since it's way smaller.
+
+class Stories < Thor
+  include Thor::Actions
+
+  desc "add_pending_stories", "Fetch stories and add them to the stories file"
+  def add_pending_stories
+    say_status(:fetch, "Fetching stories from Pivotal.")
+    new_external_stories = difference(fetch_stories, local_stories)
+
+    if new_external_stories.empty?
+      say_status(:complete, "Pivotal stories up to date.")
+    else
+      new_external_stories.each_pair do |label, stories|
+        say_status(:compare, "There are #{stories.size} new stories in Pivotal with the label '#{label}'.")
+      end
+      add_new_stories(new_external_stories)
+    end
+  end
+
+  desc "upload_new_stories", "Upload new stories to pivotal"
+  def upload_new_stories
+    new_local_stories = difference(local_stories, fetch_stories)
+
+    new_local_stories.each_pair do |label, stories|
+      say_status(:compare, "You have #{stories.size} new local stories in #{label}_test.rb.")
+    end
+
+    if new_local_stories.empty?
+      say_status(:completed, "Your stories up to date.")
+    else
+      new_local_stories.each_pair do |label, stories|
+        stories.each do |story|
+          upload_new_story(story, label)
+          say_status(:append, "Added story: '#{story}'")
+        end
+      end
+      say_status(:completed, "Stories added to Pivotal successfully.")
+    end
+  end
+
+  desc "sync", "Synchronize your local stories with your Pivotal stories"
+  def sync
+    add_pending_stories
+    upload_new_stories
+  end
+
+  desc "setup", "Fetch your Pivotal token and creates or updates your config file"
+  def setup
+    unless user_config
+      say "You need to create a configuration file"
+      create_config_file
+    else
+      say "This is your pivotal configuration"
+      say user_config
+      create_config_file if yes? "Do you want to change your configuration? (Y/N)"
+    end
+  end
+
+private
+  def difference(hash_a ,hash_b)
+    new_stories = {}
+    hash_a.each_pair do |label, stories|
+      new_stories[label] = stories - hash_b[label].to_a
+    end
+    new_stories
+  end
+
+  # Returns {"label_1" => [story_1, story_2, ..], "label_2" => [story_1, story_2, ..]}
+  def fetch_stories
+    Iteration.find(:last).stories.inject({}) do |result, story|
+      result[story.labels] ||= []
+      result[story.labels] << story.name
+      result
+    end
+    rescue NoMethodError; []
+  end
+
+  def fetch_token(user = PIVOTAL_CONFIG[:user][:name], pass = PIVOTAL_CONFIG[:user][:pass])
+    token = RestClient::Resource.new("https://www.pivotaltracker.com/services/tokens/active/guid",
+                                     :user => user,
+                                     :password => pass).get
+    token.match(/<guid>(.*)<.guid>/)[1]
+  rescue RestClient::Unauthorized
+    say_status :unauthorized, "Your credentials are invalid, You'll have to try again", :red
+  end
+
+  def create_config_file
+    say_status :setup, "Gathering your Pivotal information"
+    user = ask "What is your user name?"
+    pass = ask "What is your password?"
+    say_status :fetch, "Fetching your Pivotal token"
+    token = fetch_token(user, pass)
+    return if token.nil?
+    project_id = ask "What is your pivotal project id?"
+    create_yaml(user, pass, token, project_id)
+    say_status :create, "./config/pivotal.yml"
+  end
+
+  def user_config
+    File.read(CONFIG_FILE) if File.exists?(CONFIG_FILE)
+  end
+
+  # TODO we should consider making this a public method
+  # and merging the extra options if given.
+  def upload_new_story(name, key)
+    # Other options are: requested_by, description, owned_by, labels
+    story = Story.create(:name => name, :estimate => 1, :labels => key)
+    story.current_state = "unstarted"
+    story.save
+  end
+
+  def story_file(label)
+    File.join("#{Dir.pwd}", "test", "stories", "#{label}_test.rb")
+  end
+
+  def files
+    Dir.entries(File.join("#{Dir.pwd}", "test", "stories")).delete_if do |name|
+      name.match(/_test.rb/).nil?
+    end
+  end
+
+  def labels
+    files.inject([]) do |labels, name|
+      labels << name.scan(/(.*)_test.rb/).to_s
+      labels
+    end
+  end
+
+  def local_stories
+    labels.inject({}) do |result, label|
+      result[label] ||= []
+      result[label] = File.read(story_file(label)).scan(/\n\s*story[\s\n]*(?:"([^"]*)"|'([^']*)')/m).map(&:compact).flatten
+      result
+    end
+  end
+
+  def add_new_stories(new_stories)
+    new_stories.each_pair do |label, stories|
+      file = story_file(label)
+      if File.exists?(file)
+        original_file = File.read(file).scan(/(.*)end/m)
+        original_file << "\n  # Pending stories\n"
+
+        File.open(story_file(label), "w") do |f|
+          f.puts original_file
+          f.puts stories.map {|story| "  story \"#{story}\""}.join("\n")
+          f.puts "end"
+        end
+      else
+        say_status(:warning, "The file '#{file}' doesn't exist", :yellow)
+      end
+    end
+    say_status(:append, "Pending stories added successfully.")
+  end
+
+  def create_yaml(user, pass, token, project_id)
+    config = { :user => { :name => user,
+                          :pass => pass,
+                          :token => token.to_s },
+               :project => { :id => project_id } }
+
+    File.open(CONFIG_FILE, "w+") do |f|
+      f.puts config.to_yaml
+    end
+  end
+end

data/stories_sync.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name              = "stories_sync"
+  s.version           = "0.0.1"
+  s.summary           = "Stories Sync"
+  s.description       = "Manage and syncrhonize your UATs with Pivotal Tracker."
+  s.authors           = ["Evelin Garcia", "Lucas Nasif"]
+  s.email             = ["ehqhvm@gmail.com"]
+
+  s.rubyforge_project = "stories_sync"
+
+  s.files = ["README.markdown", "lib/pivotal.rb", "lib/stories_sync.rb", "bin/stories", "stories_sync.gemspec"]
+end
+

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: stories_sync
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Evelin Garcia
+- Lucas Nasif
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-12 00:00:00 -03:00
+default_executable: 
+dependencies: []
+
+description: Manage and syncrhonize your UATs with Pivotal Tracker.
+email: 
+- ehqhvm@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- lib/pivotal.rb
+- lib/stories_sync.rb
+- bin/stories
+- stories_sync.gemspec
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: stories_sync
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Stories Sync
+test_files: []
+