git-pivotal 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+pkg
+*.gem

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2010 Jeff Tucker
+
+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/Rakefile

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'rake'
+require 'spec/rake/spectask'
+
+$LOAD_PATH.unshift('lib')
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "git-pivotal"
+    gemspec.summary = "A collection of git utilities to ease integration with Pivotal Tracker"
+    gemspec.description = "A collection of git utilities to ease integration with Pivotal Tracker"
+    gemspec.email = "jeff@trydionel.com"
+    gemspec.homepage = "http://github.com/trydionel/git-pivotal"
+    gemspec.authors = ["Jeff Tucker"]
+    
+    gemspec.executables = ["git-pick"]
+    
+    gemspec.add_dependency "nokogiri"
+    gemspec.add_dependency "rest-client"
+    
+    gemspec.add_development_dependency "rspec"
+  end
+  
+  Jeweler::GemcutterTasks.new
+rescue
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+Spec::Rake::SpecTask.new do |t|
+  t.warning = true
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/git-pick

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'pivotal'
+require 'commands/pick'
+
+exit Pick.new.run(*ARGV)

data/git-pivotal.gemspec

@@ -0,0 +1,80 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{git-pivotal}
+  s.version = "0.1.0"
+
+  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.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}
+  s.executables = ["git-pick"]
+  s.extra_rdoc_files = [
+    "LICENSE"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "Rakefile",
+     "VERSION",
+     "bin/git-pick",
+     "git-pivotal.gemspec",
+     "lib/commands/pick.rb",
+     "lib/pivotal.rb",
+     "lib/pivotal/api.rb",
+     "lib/pivotal/associations.rb",
+     "lib/pivotal/base.rb",
+     "lib/pivotal/collection.rb",
+     "lib/pivotal/project.rb",
+     "lib/pivotal/story.rb",
+     "readme.markdown",
+     "spec/commands/pick_spec.rb",
+     "spec/pivotal/api_spec.rb",
+     "spec/pivotal/associations_spec.rb",
+     "spec/pivotal/base_spec.rb",
+     "spec/pivotal/collection_spec.rb",
+     "spec/pivotal/project_spec.rb",
+     "spec/pivotal/story_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/trydionel/git-pivotal}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A collection of git utilities to ease integration with Pivotal Tracker}
+  s.test_files = [
+    "spec/commands/pick_spec.rb",
+     "spec/pivotal/api_spec.rb",
+     "spec/pivotal/associations_spec.rb",
+     "spec/pivotal/base_spec.rb",
+     "spec/pivotal/collection_spec.rb",
+     "spec/pivotal/project_spec.rb",
+     "spec/pivotal/story_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+      s.add_runtime_dependency(%q<rest-client>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<rest-client>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<rest-client>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end
+

data/lib/commands/pick.rb

@@ -0,0 +1,116 @@
+require 'optparse'
+
+class Pick
+  
+  attr_accessor :api
+  
+  def initialize(*args)
+    @options = {}
+    parse_gitconfig
+    parse_argv(*args)
+  end
+  
+  def run
+    connect_to_pivotal
+    
+    story = find_story
+    build_feature_branch story
+    start_story story
+  end
+  
+private
+  
+  def sys(cmd)
+    puts cmd if @options[:verbose]
+    system cmd
+  end
+  
+  def get(cmd)
+    puts cmd if @options[:verbose]
+    `#{cmd}`
+  end
+  
+  def parse_gitconfig
+    token = get("git config --get pivotal.api-token").strip
+    id    = get("git config --get pivotal.project-id").strip
+    
+    @options[:api_token] = token if token
+    @options[:project_id] = id if id
+  end
+  
+  def parse_argv(*args)
+    OptionParser.new do |opts|
+      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("-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 }
+    end.parse!(args)
+  end
+  
+  def connect_to_pivotal
+    unless @options[:api_token] && @options[:project_id]
+      puts "Pivotal Tracker API Token and Project ID are required"
+      exit 0
+    end
+    
+    puts "Retrieving latest stories from Pivotal Tracker..."
+    @api = Pivotal::Api.new(:api_token => @options[:api_token])
+  end
+  
+  def agrees?(selection)
+    selection =~ /y/i || selection == ""
+  end
+  
+  def find_story
+    project = @api.projects.find(:id => @options[:project_id])
+    story = project.stories.find(:conditions => { :story_type => :feature, :current_state => :unstarted }, :limit => 1).first
+    
+    unless story
+      puts "No stories available!"
+      exit 0
+    end
+    
+    puts "Story: #{story.name}"
+    puts "URL:   #{story.url}"
+    print "Accept this story? (Yn): "
+    selection = gets.chomp
+        
+    exit 0 if !agrees?(selection)
+    
+    story
+  end
+  
+  def create_branch(branch)
+    unless branch_exists?(branch)
+      puts "Creating #{branch} branch..."
+      sys "git checkout -b #{branch}"
+    end
+  end
+
+  def branch_exists?(branch)
+    !get("git branch").match(branch).nil?
+  end
+
+  def build_feature_branch(story)
+    branch = "feature-#{story.id}"
+
+    puts "Suggested branch name: #{branch}"
+    print "Accept this name? (Yn): "
+    selection = gets.chomp
+
+    unless agrees?(selection)
+      print "Enter new name (will be prepended by #{story.id}): "
+      branch = "#{story.id}-" + gets.chomp
+    end
+    
+    create_branch branch
+  end
+  
+  def start_story(story)
+    puts "Updating story status in Pivotal Tracker..."
+    story.start!
+  end
+
+end

data/lib/pivotal/api.rb

@@ -0,0 +1,17 @@
+module Pivotal
+  class Api < Base
+  
+    attr_accessor :api_token
+    has_collection :projects, :of => Pivotal::Project
+    
+    def initialize(options = {})
+      super(options)
+      @api_url = "https://www.pivotaltracker.com/services/v3"
+    end
+  
+    def resource
+      @resource ||= RestClient::Resource.new @api_url, :headers => { 'X-TrackerToken' => api_token, 'Content-Type' => 'application/xml' }
+    end
+  
+  end
+end

data/lib/pivotal/associations.rb

@@ -0,0 +1,17 @@
+module Pivotal
+  module Associations
+    
+    def self.included(base)
+      base.extend ClassMethods
+    end
+    
+    module ClassMethods
+      def has_collection(name, options = {})
+        define_method name do
+          Pivotal::Collection.new resource[name], options[:of]
+        end
+      end
+    end
+    
+  end
+end

data/lib/pivotal/base.rb

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'rest_client'
+require 'nokogiri'
+
+module Pivotal
+  class Base
+    include Pivotal::Associations
+    
+    attr_accessor :resource, :xml
+    undef id
+    
+    def initialize(params = {})
+      params.each do |key, value|
+        send("#{key}=", value)
+      end
+    end    
+    
+    def xml
+      @xml ||= resource.get
+    end
+
+    def parsed_resource
+      @parsed_resource ||= Nokogiri::XML(xml)
+    end
+    
+    def method_missing(method, *args)
+      parsed_resource.css(method.to_s).text
+    end
+    
+    class << self
+      def xpath
+        '//' + self.name.gsub(/.+\:\:/, '').downcase
+      end
+    end
+    
+  end
+end

data/lib/pivotal/collection.rb

@@ -0,0 +1,63 @@
+require 'cgi'
+
+module Pivotal
+  class Collection
+    
+    attr_accessor :resource, :component_class
+    
+    def initialize(resource, component_class)
+      @resource, @component_class = resource, component_class
+    end
+    
+    # Param queries will break our REST structure,
+    # so if we find an :id parameter, accept it and
+    # ignore all other params.
+    def find(*args)
+      params = args.last.is_a?(Hash) ? args.pop : {}
+      finder = args.first
+      
+      return item(params[:id]) if params[:id]
+      return item(finder) if finder.is_a?(Numeric)
+      
+      all(params)
+    end
+    
+    def first
+      all.first
+    end
+    
+  private
+  
+    def item(id)
+      component_class.new :resource => resource[id]
+    end
+  
+    def filters(params = {})
+      return "" if params.empty?
+
+      param_url = []
+      if params[:conditions]
+        condition_string = params[:conditions].map { |k,v| "#{k}:#{v}" }.join " "
+        param_url << "filter=#{CGI::escape(condition_string)}"
+      end
+      
+      if params[:limit]
+        param_url << "limit=#{params[:limit]}&offset=#{params[:offset]||0}"
+      end
+      
+      "?" + param_url.join("&")
+    end
+    
+    def build_collection_from_xml(xml = "")
+      Nokogiri::XML(xml).xpath(component_class.xpath).map do |item|
+        item_id = item.xpath("//id").text
+        component_class.new :resource => resource[item_id], :xml => item.to_xml
+      end
+    end
+    
+    def all(params = {})
+      build_collection_from_xml resource[filters(params)].get
+    end
+    
+  end
+end

data/lib/pivotal/project.rb

@@ -0,0 +1,7 @@
+module Pivotal
+  class Project < Base
+
+    has_collection :stories, :of => Pivotal::Story
+
+  end
+end

data/lib/pivotal/story.rb

@@ -0,0 +1,9 @@
+module Pivotal
+  class Story < Base
+    
+    def start!
+      resource.put "<story><current_state>started</current_state></story>"
+    end
+  
+  end
+end

data/lib/pivotal.rb

@@ -0,0 +1,7 @@
+require File.join(File.dirname(__FILE__),'pivotal', 'collection')
+require File.join(File.dirname(__FILE__),'pivotal', 'associations')
+
+require File.join(File.dirname(__FILE__),'pivotal','base')
+require File.join(File.dirname(__FILE__),'pivotal','story')
+require File.join(File.dirname(__FILE__),'pivotal','project')
+require File.join(File.dirname(__FILE__),'pivotal','api')

data/readme.markdown

@@ -0,0 +1,33 @@
+#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.
+
+##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.
+
+###Git Pick
+This selects the top-most available feature from your Pivotal Tracker, and offers to create a feature branch.
+
+    1 git-pick:master % git pick
+    Collecting latest stories from Pivotal Tracker...
+    Story: Test git pivotal
+    URL:   http://www.pivotaltracker.com/story/show/1234567
+    Accept this story? (Yn): y
+    Suggested branch: feature-1234567
+    Accept this name? (Yn): y
+    Creating feature-1234567 branch...
+    Updating story status in Pivotal Tracker...
+    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:
+
+    git config --global pivotal.api-token 9a9a9a9a9a9a9a9a9a9a
+
+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.

data/spec/commands/pick_spec.rb

@@ -0,0 +1,7 @@
+require 'commands/pick'
+
+describe Pick do
+  it "should work" do
+    true
+  end
+end

data/spec/pivotal/api_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Pivotal::Api do
+  
+  before(:each) do
+    @api = pivotal_api
+  end
+  
+  it "should connect to Pivotal Tracker's API" do
+    @api.resource.url.should == "https://www.pivotaltracker.com/services/v3"
+  end
+  
+  it "should have a collection of projects" do
+    @api.projects.should be_a(Pivotal::Collection)
+    @api.projects.component_class.should == Pivotal::Project
+  end
+
+end

data/spec/pivotal/associations_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Pivotal::Associations do
+  
+  it "should load the #has_collection method into a class" do
+    @base = Object
+    @base.should_not respond_to(:has_collection)
+    
+    @base.send(:include, Pivotal::Associations)
+    @base.should respond_to(:has_collection)
+  end
+  
+end

data/spec/pivotal/base_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'nokogiri'
+
+describe Pivotal::Base do
+  
+  before(:each) do
+    @base = pivotal_api
+  end
+  
+  it "should expose a REST resource" do
+    @base.resource.should be_a(RestClient::Resource)
+  end
+  
+  it "should expose the resource's XML" do
+    @base.resource.expects(:get).returns("")
+    @base.xml.should be_a(String)
+  end
+  
+  it "should expose the resource's XML parse tree" do
+    @base.parsed_resource.should be_a(Nokogiri::XML::Document)
+  end
+  
+  it "should forward undefined methods to the XML parse tree" do
+    @base.should_not respond_to(:id)
+    @base.id.should == "1"
+  end
+  
+  it "should present the class's item xpath" do
+    @base.class.xpath.should == "//api"
+  end
+  
+  it "should expose association methods" do
+    @base.class.should include(Pivotal::Associations)
+  end
+  
+end

data/spec/pivotal/collection_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Pivotal::Collection do
+  
+  before(:each) do
+    @api = pivotal_api
+  end
+  
+  it "should find a single item given an id" do
+    @api.projects.find(1).should be_a(Pivotal::Project)
+  end
+  
+  it "should find a collection of items giving a set of conditions" do
+    @api.projects.find(:all).should be_a(Array)
+    @api.projects.first.should be_a(Pivotal::Project)
+  end
+  
+  it "should return the first item of a collection" do
+    @api.projects.first.should be_a(Pivotal::Project)
+  end
+  
+end

data/spec/pivotal/project_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Pivotal::Project do
+  
+  before(:each) do
+    @api = pivotal_api
+    @project = Pivotal::Project.new :resource => @api.resource["projects"][1]
+  end
+  
+  it "should be connected to the project resource" do
+    @project.resource.url.should == "https://www.pivotaltracker.com/services/v3/projects/1"
+  end
+  
+  it "should have a collection of stories" do
+    @project.stories.should be_a(Pivotal::Collection)
+    @project.stories.component_class.should == Pivotal::Story
+  end
+  
+end

data/spec/pivotal/story_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Pivotal::Story do
+
+  before(:each) do
+    @api = pivotal_api
+    @project = Pivotal::Project.new :resource => @api.resource["projects"][1]
+    @story = Pivotal::Story.new :resource => @project.resource["stories"][1]
+  end
+  
+  it "should be connected to the story resource" do
+    @story.resource.url.should == "https://www.pivotaltracker.com/services/v3/projects/1/stories/1"
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'mocha'
+require 'builder'
+require 'pivotal'
+require 'commands/pick'
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end
+
+def demo_xml
+  Builder::XmlMarkup.new.project do |project|
+    project.id 1
+  end
+end
+
+def stub_connection_to_pivotal
+  RestClient::Resource.any_instance.stubs(:get).returns(demo_xml)
+end
+
+def pivotal_api
+  stub_connection_to_pivotal
+  Pivotal::Api.new :api_token => 1
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: git-pivotal
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jeff Tucker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-27 00:00:00 -05:00
+default_executable: git-pick
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  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: 
+- git-pick
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+files: 
+- .gitignore
+- LICENSE
+- Rakefile
+- VERSION
+- bin/git-pick
+- git-pivotal.gemspec
+- lib/commands/pick.rb
+- lib/pivotal.rb
+- lib/pivotal/api.rb
+- lib/pivotal/associations.rb
+- lib/pivotal/base.rb
+- lib/pivotal/collection.rb
+- lib/pivotal/project.rb
+- lib/pivotal/story.rb
+- readme.markdown
+- spec/commands/pick_spec.rb
+- spec/pivotal/api_spec.rb
+- spec/pivotal/associations_spec.rb
+- spec/pivotal/base_spec.rb
+- spec/pivotal/collection_spec.rb
+- spec/pivotal/project_spec.rb
+- spec/pivotal/story_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/trydionel/git-pivotal
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A collection of git utilities to ease integration with Pivotal Tracker
+test_files: 
+- spec/commands/pick_spec.rb
+- spec/pivotal/api_spec.rb
+- spec/pivotal/associations_spec.rb
+- spec/pivotal/base_spec.rb
+- spec/pivotal/collection_spec.rb
+- spec/pivotal/project_spec.rb
+- spec/pivotal/story_spec.rb
+- spec/spec_helper.rb