eslurper 1.0.0

data/lib/slurper.rb

@@ -0,0 +1,66 @@
+require 'yaml'
+require 'story'
+
+YAML::ENGINE.yamler='syck' if RUBY_VERSION > '1.9'
+
+
+class Slurper
+
+  attr_accessor :story_file, :stories
+
+  def self.slurp(story_file, reverse)
+    slurper = new(story_file)
+    slurper.load_stories
+    slurper.prepare_stories
+    slurper.sort_stories(reverse)
+    slurper.create_stories
+  end
+
+  def initialize(story_file)
+    self.story_file = story_file
+  end
+
+  def load_stories
+    self.stories = YAML.load(yamlize_story_file)
+  end
+
+  def prepare_stories
+    stories.each { |story| story.prepare }
+  end
+
+  def sort_stories(reverse)
+    stories.sort!
+    stories.reverse! unless reverse
+  end
+
+  def create_stories
+    puts "Preparing to slurp #{stories.size} stories into Tracker..."
+    stories.each_with_index do |story, index|
+      begin
+        if story.save
+          puts "#{index+1}. #{story.name}"
+        else
+          puts "Slurp failed. #{story.errors.full_messages}"
+        end
+      rescue ActiveResource::ConnectionError => e
+        msg = "Slurp failed on story "
+        if story.attributes["name"]
+          msg << story.attributes["name"]
+        else
+          msg << "##{options[:reverse] ? index + 1 : stories.size - index }"
+        end
+        puts msg + ".  Error: #{e}"
+      end
+    end
+  end
+
+  protected
+
+  def yamlize_story_file
+    IO.read(story_file).
+      gsub(/^/, "    ").
+      gsub(/    ==.*/, "- !ruby/object:Story\n  attributes:").
+      gsub(/    description:$/, "    description: |")
+  end
+
+end

data/lib/story.rb

@@ -0,0 +1,98 @@
+require 'active_resource'
+
+class Story < ActiveResource::Base
+  include Comparable
+
+  def self.yaml
+    YAML.load_file('slurper_config.yml')
+  end
+
+  def self.config(project_id='project_id')
+    @@config = yaml
+    scheme =  if !!@@config['ssl']
+                self.ssl_options = {  :verify_mode => OpenSSL::SSL::VERIFY_PEER,
+                                      :ca_file => File.join(File.dirname(__FILE__), "cacert.pem") }
+                "https"
+              else
+                "http"
+              end
+    self.site = "#{scheme}://www.pivotaltracker.com/services/v3/projects/:project_id"
+    # self.site = "#{scheme}://www.pivotaltracker.com/services/v3/projects/#{@@config[project_id]}"
+    @@config
+  end
+
+  headers['X-TrackerToken'] = config.delete("token")
+  headers['Accept-Encoding'] = '*/*'
+  self.format = ActiveResource::Formats::XmlFormat
+
+  def prepare
+    scrub_description
+    scrub_labels
+    default_requested_by
+    self.description += "\n" + "Label Search\n" + label_search_url + "\n\n" + story_links.join("\n") if epic_story?
+  end
+
+  def epic_story?
+    respond_to?(:labels) ? self.labels.split(',').include?("epic") : false
+  end
+
+  def feature_labels
+    self.labels.split(',').find { |label| label != "epic" }
+  end
+
+  def save
+    @config ||= Story.yaml
+    self.prefix_options = {:project_id => @config['project_id']}
+    super
+  end
+
+  def <=>(another_story)
+    if self.epic_story? && another_story.epic_story?
+      0
+    elsif self.epic_story? && !another_story.epic_story?
+      -1
+    elsif !self.epic_story? && !another_story.epic_story?
+      0
+    else
+      1
+    end
+  end
+
+  protected
+
+  def label_search_url
+    @config ||= Story.yaml
+    "https://www.pivotaltracker.com/projects/#{@config['epic_features_project_id']}?label=" + feature_labels
+  end
+
+  def story_links
+    retrieve_user_stories.map { |story| story.url }
+  end
+
+  def retrieve_user_stories
+    @config ||= Story.yaml
+    stories = Story.find(:all, :params => {:filter => 'label:' + feature_labels, :project_id => @config['epic_features_project_id']})
+  end
+
+  def scrub_description
+    if respond_to?(:description)
+      self.description = description.gsub("  ", "").gsub(" \n", "\n")
+    end
+    if respond_to?(:description) && description == ""
+      self.attributes["description"] = nil
+    end
+  end
+
+  def scrub_labels
+    if respond_to?(:labels)
+      self.labels = labels.gsub(" ", "").gsub(" \n", "\n")
+    end
+  end
+
+  def default_requested_by
+    if (!respond_to?(:requested_by) || requested_by == "") && Story.config["requested_by"]
+      self.attributes["requested_by"] = Story.config["requested_by"]
+    end
+  end
+
+end

data/spec/slurper_spec.rb

@@ -0,0 +1,79 @@
+require 'rubygems'
+require 'slurper'
+
+describe Slurper do
+
+  context "deals with leading/trailing whitespace" do
+    before do
+      slurper = Slurper.new(File.join(File.dirname(__FILE__), "fixtures", "whitespacey_story.slurper"))
+      slurper.load_stories
+      @story = slurper.stories.first
+    end
+
+    it "strips whitespace from the name" do
+      @story.name.should == "Profit"
+    end
+  end
+
+  context "given an epic feature" do
+    before do
+      slurper = Slurper.new(File.join(File.dirname(__FILE__), "fixtures", "epic_story.slurper"))
+      slurper.load_stories
+      @story = slurper.stories.first
+    end
+
+    it "knows it's an epic story" do
+      @story.epic_story? == true
+    end
+  end
+
+  context "given values for all attributes" do
+    before do
+      slurper = Slurper.new(File.join(File.dirname(__FILE__), "fixtures", "full_story.slurper"))
+      slurper.load_stories
+      @story = slurper.stories.first
+    end
+
+    it "parses the name correctly" do
+      @story.name.should == "Profit"
+    end
+
+    it "parses the label correctly" do
+      @story.labels.should == "money,power,fame"
+    end
+
+    it "parses the story type correctly" do
+      @story.story_type.should == "feature"
+    end
+  end
+
+  context "given only a name" do
+    before do
+      slurper = Slurper.new(File.join(File.dirname(__FILE__), "fixtures", "name_only.slurper"))
+      slurper.load_stories
+      @story = slurper.stories.first
+    end
+
+    it "should parse the name correctly" do
+      @story.name.should == "Profit"
+    end
+
+  end
+
+  context "given empty attributes" do
+    before do
+      slurper = Slurper.new(File.join(File.dirname(__FILE__), "fixtures", "empty_attributes.slurper"))
+      slurper.load_stories
+      @story = slurper.stories.first
+    end
+
+    it "should not set any name" do
+      @story.name.should be_nil
+    end
+
+    it "should not set any labels" do
+      @story.labels.should be_nil
+    end
+  end
+
+end

data/spec/story_spec.rb

@@ -0,0 +1,110 @@
+require 'rubygems'
+require 'slurper'
+
+describe Story do
+
+  context "#prepare" do
+    it "scrubs the description" do
+      story = Story.new
+      story.stub!(:default_requested_by)
+      story.should_receive(:scrub_description)
+      story.prepare
+    end
+
+    it "scrubs the defaults the requested_by attribute" do
+      story = Story.new
+      story.stub!(:scrub_description)
+      story.should_receive(:default_requested_by)
+      story.prepare
+    end
+
+    it "uses http by default" do
+      Story.site.scheme.should == "http"
+      Story.yaml['ssl'].should be_nil
+    end
+
+    it "uses https if set in the config" do
+      Story.stub(:yaml => {"ssl" => true})
+      Story.config['ssl'].should be_true
+      Story.site.scheme.should == "https"
+      Story.ssl_options[:verify_mode].should == 1
+
+      # Not sure what this next line is testing
+      File.open(File.expand_path('lib/cacert.pem')).readlines.find_all{ |l| l.starts_with?("Equifax") }.count.should == 4
+    end
+  end
+
+  context "requested_by attribute" do
+    it "uses the default if not given one" do
+      Story.stub!(:config).and_return({"requested_by" => "Mr. Client"})
+      story = Story.new
+      story.send(:default_requested_by)
+      story.requested_by.should == "Mr. Client"
+    end
+
+    it "uses the default if given a blank requested_by" do
+      Story.stub!(:config).and_return({"requested_by" => "Mr. Client"})
+      story = Story.new(:requested_by => "")
+      story.send(:default_requested_by)
+      story.requested_by.should == "Mr. Client"
+    end
+
+    it "uses the name given in the story file if there is one" do
+      Story.stub!(:config).and_return({"requested_by" => "Mr. Client"})
+      story = Story.new(:requested_by => "Mr. Stakeholder")
+      story.send(:default_requested_by)
+      story.requested_by.should == "Mr. Stakeholder"
+    end
+  end
+
+  context "scrubs the descriptions correctly" do
+    it "when the description is blank" do
+      story = Story.new(:description => "")
+      story.send(:scrub_description)
+      story.description.should be_nil
+    end
+
+    it "when there is no description given" do
+      story = Story.new
+      lambda {
+        story.send(:scrub_description)
+      }.should_not raise_error
+    end
+
+    it "when it contains quotes" do
+      desc = <<-STRING
+        I have a "quote"
+      STRING
+      story = Story.new(:description => desc)
+      story.send(:scrub_description)
+      story.description.should == "I have a \"quote\"\n"
+    end
+
+    it "when it is full of whitespace" do
+      desc = <<-STRING
+        In order to do something   
+        As a role     
+        I want to click a thingy  
+      STRING
+      story = Story.new(:description => desc)
+      story.send(:scrub_description)
+      story.description.should == "In order to do something\nAs a role\nI want to click a thingy\n"
+    end
+
+    it "when it contains acceptance criteria" do
+      desc = <<-STRING
+        In order to do something
+        As a role
+        I want to click a thingy
+
+        Acceptance:
+        - do the thing
+        - don't forget the other thing
+      STRING
+      story = Story.new(:description => desc)
+      story.send(:scrub_description)
+      story.description.should == "In order to do something\nAs a role\nI want to click a thingy\n\nAcceptance:\n- do the thing\n- don't forget the other thing\n"
+    end
+  end
+
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: eslurper
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Wes Gibbs
+- Adam Lowe
+- Stephen Caudill
+- Tim Pope
+- Jeffrey Walter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-21 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: &70340789669980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70340789669980
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70340789669360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *70340789669360
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: &70340789668760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.6
+  type: :development
+  prerelease: false
+  version_requirements: *70340789668760
+- !ruby/object:Gem::Dependency
+  name: configuration
+  requirement: &70340789668160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: *70340789668160
+description: ! "\n      Slurps stories from the given file (stories.slurper by default)
+  and creates Pivotal Tracker stories from them. Useful during story carding sessions
+  when you want to capture a number of stories quickly without clicking your way through
+  the Tracker UI.\n    "
+email: jeffrey.walter@ericsson.com
+executables:
+- eslurp
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- bin/eslurp
+- lib/slurper.rb
+- lib/story.rb
+- lib/cacert.pem
+- README.rdoc
+- spec/slurper_spec.rb
+- spec/story_spec.rb
+homepage: http://github.com/jeffreywalter/slurper
+licenses: []
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: takes a formatted story file and puts it on Pivotal Tracker
+test_files:
+- spec/slurper_spec.rb
+- spec/story_spec.rb