git-pivotal 0.1.0 → 0.1.1

data/.gitignore

@@ -1,2 +1,3 @@
 pkg
+coverage
 *.gem

data/Rakefile

@@ -20,6 +20,7 @@ begin
     gemspec.add_dependency "rest-client"
     
     gemspec.add_development_dependency "rspec"
+    gemspec.add_development_dependency "mocha"
   end
   
   Jeweler::GemcutterTasks.new
@@ -29,4 +30,6 @@ end
 
 Spec::Rake::SpecTask.new do |t|
   t.warning = true
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'gems']
 end

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/git-pivotal.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{git-pivotal}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeff Tucker"]
-  s.date = %q{2010-01-27}
+  s.date = %q{2010-01-29}
   s.default_executable = %q{git-pick}
   s.description = %q{A collection of git utilities to ease integration with Pivotal Tracker}
   s.email = %q{jeff@trydionel.com}
@@ -66,15 +66,18 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
       s.add_runtime_dependency(%q<rest-client>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
     else
       s.add_dependency(%q<nokogiri>, [">= 0"])
       s.add_dependency(%q<rest-client>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
     end
   else
     s.add_dependency(%q<nokogiri>, [">= 0"])
     s.add_dependency(%q<rest-client>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
   end
 end
 

data/lib/commands/pick.rb

@@ -33,9 +33,11 @@ private
   def parse_gitconfig
     token = get("git config --get pivotal.api-token").strip
     id    = get("git config --get pivotal.project-id").strip
+    name  = get("git config --get pivotal.full-name").strip
     
     @options[:api_token] = token if token
     @options[:project_id] = id if id
+    @options[:full_name] = name if name
   end
   
   def parse_argv(*args)
@@ -43,6 +45,7 @@ private
       opts.banner = "Usage: git pick [options]"
       opts.on("-k", "--api-key=", "Pivotal Tracker API key") { |k| @options[:api_token] = k }
       opts.on("-p", "--project-id=", "Pivotal Trakcer project id") { |p| @options[:project_id] = p }
+      opts.on("-n", "--full-name=", "Pivotal Trakcer full name") { |n| @options[:full_name] = n }
       opts.on("-q", "--quiet", "Quiet, no-interaction mode") { |q| @options[:quiet] = q }
       opts.on("-v", "--[no-]verbose", "Run verbosely") { |v| @options[:verbose] = v }
       opts.on_tail("-h", "--help", "This usage guide") { puts opts; exit 0 }
@@ -110,7 +113,7 @@ private
   
   def start_story(story)
     puts "Updating story status in Pivotal Tracker..."
-    story.start!
+    story.start!(:owned_by => @options[:full_name])
   end
 
 end

data/lib/pivotal/base.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'rest_client'
 require 'nokogiri'
+require 'builder'
 
 module Pivotal
   class Base
@@ -27,9 +28,36 @@ module Pivotal
       parsed_resource.css(method.to_s).text
     end
     
+    def update_attributes(options = {})
+      @xml = resource.put generate_xml(options)
+    end
+    
     class << self
+      def name_as_xml_attribute
+        self.name.gsub(/.+\:\:/, '').downcase
+      end
+      
       def xpath
-        '//' + self.name.gsub(/.+\:\:/, '').downcase
+        '//' + self.name_as_xml_attribute
+      end
+    end
+    
+  private
+  
+    def generate_xml(options = {})
+      builder = Builder::XmlMarkup.new
+      allowed_keys(options).each do |key, value|
+        builder.key(value.to_s)
+      end
+      
+      builder
+    end
+    
+    def allowed_keys(options = {})
+      options.reject do |key, _|
+        !%w[id story_type url estimate current_state
+           description name requested_by owned_by
+           created_at accepted_at labels].include? key.to_s
       end
     end
     

data/lib/pivotal/story.rb

@@ -1,8 +1,8 @@
 module Pivotal
   class Story < Base
     
-    def start!
-      resource.put "<story><current_state>started</current_state></story>"
+    def start!(options = {})
+      update_attributes(options.merge(:current_state => :started))
     end
   
   end

data/readme.markdown

@@ -1,10 +1,10 @@
 #Git Pivotal
 
 ##Prelude
-You might want to have [this song]("http://www.dailymotion.com/video/x9vzh0_olivia-newton-john-lets-get-physica_music") running in the background while you read this.
+You might want to have [this song](http://www.dailymotion.com/video/x9vzh0_olivia-newton-john-lets-get-physica_music) running in the background while you read this.
 
 ##Let's Git Pivotal
-Inspired by [Hashrocket's blend of git and Pivotal Tracker]("http://reinh.com/blog/2009/03/02/a-git-workflow-for-agile-teams.html"), I set off to create a set of utilities to simplify the workflow between the two.
+Inspired by [Hashrocket's blend of git and Pivotal Tracker](http://reinh.com/blog/2009/03/02/a-git-workflow-for-agile-teams.html) and [a popular article on effective git workflows](http://nvie.com/archives/323), I set off to create a set of utilities to simplify the workflow between the two.
 
 ###Git Pick
 This selects the top-most available feature from your Pivotal Tracker, and offers to create a feature branch.
@@ -21,13 +21,27 @@ This selects the top-most available feature from your Pivotal Tracker, and offer
     2 git-pick:feature-1234567 %
     
 ##Installation
-Some long process to actually install it.  Working on that.
-Once installed, git pivotal needs two bits of info: your Pivotal Tracker API Token and your Pivotal Tracker project id.  The former is best set as a global git config option:
+To install git-pivotal, simply run
+
+    [sudo] gem install git-pivotal
+
+<h2 id="config">Configuration</h2>
+Once installed, git pivotal needs three bits of info: your Pivotal Tracker API Token, your name as it appears in Pivotal Tracker and your Pivotal Tracker project id.  The former two are best set as a global git config options:
 
     git config --global pivotal.api-token 9a9a9a9a9a9a9a9a9a9a
+    git config --global pivotal.full-name "Jeff Tucker"
 
 The project id is best placed within your project's git config:
 
     git config -f .git/config pivotal.project-id 88888
 
-If you're not interested in storing these options in git, you can pass them into git pivotal as command line arguments.  See the usage guides for more details.
+If you're not interested in storing these options in git, you can pass them into git pivotal as command line arguments.  See the usage guides for more details.
+
+##TODO
+This is <del>some seriously</del> alpha software.  Several things on the ol' todo list:
+
+* <del>Create a general Pivotal::Base#update_attributes method</del>
+* <del>`git pick` doesn't update the story to indicate who claimed it</del>
+* Add command to close/finish currently 'picked' feature
+* Reduce verbosity of `git pick`
+* More that I can't recall at the moment

data/spec/pivotal/base_spec.rb

@@ -33,4 +33,31 @@ describe Pivotal::Base do
     @base.class.should include(Pivotal::Associations)
   end
   
+  describe "updating the remote resource" do
+    
+    before(:each) do
+      @xml = "<story><current_state>started</current_state></story>"
+      @base.resource.expects(:put).with(@xml).returns(@xml)
+    end
+
+    it "should be able to update the remote resource with a hash of string values" do
+      @base.update_attributes(:current_state => "started")
+    end
+  
+    it "should be able to update the remote resource with a hash of symbol values" do
+      @base.update_attributes(:current_state => :started)
+    end
+    
+    it "should not update attributes which don't exist on the remote model" do
+      @base.update_attributes(:unknown_attribute => true)
+    end
+    
+    it "should update the stored xml with the new remote model" do
+      lambda {
+        @base.update_attributes(:current_state => "started")
+      }.should change(@base, :xml).to(@xml)
+    end
+    
+  end
+  
 end

data/spec/pivotal/story_spec.rb

@@ -12,4 +12,18 @@ describe Pivotal::Story do
     @story.resource.url.should == "https://www.pivotaltracker.com/services/v3/projects/1/stories/1"
   end
   
+  it "should be able to mark the story as started" do
+    @xml = "<story><current_state>started</current_state></story>"
+    @story.resource.expects(:put).with(@xml)
+
+    @story.start!
+  end
+  
+  it "should be able to update other attributes when marking the story as started" do
+    @xml = "<story><current_state>started</current_state><owned_by>Jeff Tucker</owned_by></story>"
+    @story.resource.expects(:put).with(@xml)
+
+    @story.start!(:owned_by => "Jeff Tucker")
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: git-pivotal
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Jeff Tucker
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-27 00:00:00 -05:00
+date: 2010-01-29 00:00:00 -05:00
 default_executable: git-pick
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,6 +42,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: A collection of git utilities to ease integration with Pivotal Tracker
 email: jeff@trydionel.com
 executables: