pivotal-github 0.9.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2cf1d7330fa22931ced51a6ce0baee166398bb85
-  data.tar.gz: 84637ffaa50fb94a614f009e7574751009dcfb4a
+  metadata.gz: 3b1327c6aeb3947b802849284a92b1f8f613454f
+  data.tar.gz: d149aee10919ff595cec2185b42981cd022fec2b
 SHA512:
-  metadata.gz: 84860bbddad7a50082bbe3e1033705ce6106639f3a2eafe326d71e6aabebec630e4edee4b06cd91e6f34d43ece0f5b6b57df4928d9f9f8bcef7dbb4eda0bdfb8
-  data.tar.gz: 126f27130bf770caf84c099a644dd098b4aff6c1f5e4e60795e414d3ada2b314c7ebeacb048b071f12cd6b22deaf1959cc5f467eda8055f3e3932b28624634e9
+  metadata.gz: ec6de0af73b760f7db2cf8f966df795cc69af8564cac7c637a3e23803603c98a25c8e7be8a08fb7f836389364d6207343ce0a93e0de0afa11bffc4ac1a120977
+  data.tar.gz: 43737ee77614a033099f5097694f70ac78da05b41b32a37d79e75650dadbfdc63f70d552f27a9afee529be5e02fc337668dea0532f8c640f3d2274c7248b8062

data/.api_token

@@ -0,0 +1 @@
+faed06d1e5f6dfd030e451c34b24ab68

data/.project_id

@@ -0,0 +1 @@
+745955

data/Gemfile

@@ -3,6 +3,8 @@ ruby '2.0.0'
 
 gem 'rspec', '~> 2.13.0'
 gem 'httparty', '~> 0.10.0'
+gem 'git'
+gem 'nokogiri'
 
 # Specify your gem's dependencies in pivotal-github.gemspec
 gemspec

data/README.md

@@ -125,6 +125,23 @@ As with `git story-merge`, by default `git story-pull-request` exits with a warn
         -o, --override                   override unfinished story warning
         -h, --help                       this usage guide
 
+### git story-accept
+
+`git story-accept` examines the repository log and changes every **Delivered** story to **Accepted**. This makes it possible to accept a pull request by merging into master and then mark all the associated stories **Accepted**  by running `git story-accept`. This saves having to manually keep track of the correspondences.
+
+The purpose of `git story-accept` is to accept stories that have been merged into `master`, so by default it works only on the master branch. This requirement can be overridden by the `--override` option.
+
+In order to avoid reading the entire Git log every time it's run, by default `git story-accept` stops immediately after finding a story that has already been accepted. The assumption is that `git story-accept` is run immediately after merging a pull request into a master branch that is always up-to-date, so that there are no delivered but unaccepted stories further down in the log.
+
+`git story-accept` requires the existence of `.api_token` and `.project_id` files containing the Pivotal Tracker API token and project id, respectively. The user is prompted to create them if they are not present. (They aren't read from the command line using `gets` due to an incompatibility with options passing.)
+
+#### Options
+
+    Usage: git story-accept
+        -o, --override                   override master branch requirement
+        -a, --all                        process all stories (entire log)
+        -h, --help                       this usage guide
+
 ### story-open
 
 The `story-open` command (no `git`) opens the current story in the default browser (OS X–only):
@@ -134,13 +151,14 @@ The `story-open` command (no `git`) opens the current story in the default brows
 
 ## Configuration
 
-In order to use the `pivotal-github` gem, you need to configure a post-receive hook for your repository. At GitHub, navigate to `Settings > Service Hooks > Pivotal Tracker` and paste in your Pivotal Tracker API token. (To find your Pivotal Tracker API token, go to your user profile and scroll to the bottom.) Be sure to check the **Active** box to activate the post-receive hook. At Bitbucket, click on the gear icon to view the settings, click on `Services`, select `Pivotal Tracker`, and paste in your Pivotal Tracker API key.
+In order to use the `pivotal-github` gem, you need to configure a post-receive hook for your repository. At GitHub, navigate to `Settings > Service Hooks > Pivotal Tracker` and paste in your Pivotal Tracker API token. (To find your Pivotal Tracker API token, go to your user profile and scroll to the bottom.) Be sure to check the **Active** box to activate the post-receive hook. At Bitbucket, click on the gear icon to view the settings, click on `Services`, select `Pivotal Tracker`, and paste in your Pivotal Tracker API key. In addition, the `git story-accept` command requires the existence of `.api_token` and `.project_id` files containing the Pivotal Tracker API token and project id, respectively.
 
 The `pivotal-github` command names follow the Git convention of being verbose (e.g., unlike Subversion, Git doesn't natively support `co` for `checkout`), but I recommend setting up aliases as necessary. Here are some suggestions, formatted so that they can be pasted directly into a terminal window:
 
     git config --global alias.sc story-commit
     git config --global alias.sm story-merge
     git config --global alias.spr story-pull-request
+    git config --global alias.sa story-accept
 
 I also recommend setting up an alias for `git push-branch` from [git-utils](https://github.com/mhartl/git-utils):
 
@@ -161,12 +179,13 @@ A single-developer workflow would then look like this:
     $ git sync
     $ git rebase master
     $ git sm
+    $ git sa
 
-Here `git sync` is also from [git-utils](https://github.com/mhartl/git-utils).
+Here `git sync` is from [git-utils](https://github.com/mhartl/git-utils).
 
 ## Workflow with integrated code reivew
 
-The `pivotal-github` gem is degined to support a workflow involving integrated code review, which has the usual benefits: at least two pairs of eyes see any committed code, and at least two brains know basically what the committed code does. The cost is that having a second developer involved can slow you down. I suggest using your judgment to determine which workflow makes the most sense on a story-by-story basis.
+The `pivotal-github` gem is designed to support a workflow involving integrated code review, which has the usual benefits: at least two pairs of eyes see any committed code, and at least two brains know basically what the committed code does. The cost is that having a second developer involved can slow you down. I suggest using your judgment to determine which workflow makes the most sense on a story-by-story basis.
 
 Here's the process in detail:
 
@@ -192,7 +211,7 @@ Rather than immediately submitting a pull request, Alice can also continue by br
 ### Developer #2 (Bob)
 
 1. Select **Pull Requests** at GitHub and review the pull request diffs
-2. If acceptable, merge the branch by clicking on the button at GitHub, and optionally accept the story at Pivotal Tracker
+2. If acceptable, merge the pull request into master, run `git pull` on `master` to pull in the changes, and run `git story-accept` to mark the corresponding stories accepted
 3. If not acceptable, manually change the state at Pivotal Tracker to **Rejected** and leave a note (at GitHub or at Pivotal Tracker) indicating the reason
 4. If the branch can't be automatically merged, mark the story as **Rejected**
 

data/bin/git-story-accept

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'pivotal-github/story_accept'
+
+exit Command.run!(StoryAccept, ARGV.dup)

data/lib/pivotal-github.rb

@@ -5,3 +5,4 @@ require "pivotal-github/story_commit"
 require "pivotal-github/story_merge"
 require "pivotal-github/story_open"
 require "pivotal-github/story_pull_request"
+require "pivotal-github/story_accept"

data/lib/pivotal-github/story_accept.rb

@@ -0,0 +1,105 @@
+require 'pivotal-github/command'
+require 'git'
+require 'net/http'
+require 'uri'
+require 'nokogiri'
+
+class StoryAccept < Command
+
+  def parser
+    OptionParser.new do |opts|
+      opts.banner = "Usage: git story-accept"
+      opts.on("-o", "--override", "override master branch requirement") do |opt|
+        self.options.override = opt
+      end
+      opts.on("-a", "--all", "process all stories (entire log)") do |opt|
+        self.options.all = opt
+      end
+      opts.on_tail("-h", "--help", "this usage guide") do
+        puts opts.to_s; exit 0
+      end
+    end
+  end
+
+  # Returns the ids to accept.
+  # These ids are of the form [Delivers #<story id>] or
+  # [Delivers #<story id> #<another story id>].
+  def ids_to_accept
+    delivered_regex = /\[Deliver(?:s|ed) (.*?)\]/
+    Git.open('.').log.inject([]) do |delivered_ids, commit|
+      message = commit.message
+      delivered = message.scan(delivered_regex).flatten
+      commit_ids = delivered.inject([]) do |ids, element|
+        ids.concat(element.scan(/[0-9]{8,}/).flatten)
+        ids
+      end
+      commit_ids.each do |commit_id|
+        return delivered_ids if already_accepted?(commit_id) && !options['all']
+        delivered_ids << commit_id
+        delivered_ids.uniq!
+      end
+      delivered_ids
+    end
+  end
+
+  # Returns true if a story has already been accepted.
+  def already_accepted?(story_id)
+    data = { 'X-TrackerToken' => api_token,
+             'Content-type' => "application/xml" }
+    response = Net::HTTP.start(story_uri.host, story_uri.port) do |http|
+      http.get(story_uri.path, data)
+    end
+    Nokogiri::XML(response.body).at_css('current_state').content == "accepted"
+  end
+
+  def api_token
+    api_filename = '.api_token'
+    if File.exist?(api_filename)
+      @api_token ||= File.read(api_filename).strip
+    else
+      puts "Please create a file called '#{api_filename}'"
+      puts "containing your Pivotal Tracker API token."
+      exit 1
+    end
+  end
+
+  def project_id
+    project_id_filename = '.project_id'
+    if File.exist?(project_id_filename)
+      @project_id_filename ||= File.read(project_id_filename)
+    else
+      puts "Please create a file called '#{project_id}'"
+      puts "containing the Pivotal Tracker project number."
+      exit 1
+    end
+  end
+
+  # Changes a story's state to **Accepted**.
+  def accept!(story_id)
+    accepted = "<story><current_state>accepted</current_state></story>"
+    data =  { 'X-TrackerToken' => api_token,
+              'Content-type' => "application/xml" }
+    Net::HTTP.start(story_uri.host, story_uri.port) do |http|
+      http.put(story_uri.path, accepted, data)
+    end
+  end
+
+  def run!
+    if story_branch != 'master' && !options['override']
+      puts "Runs only on the master branch by default"
+      puts "Use --override to override"
+      exit 1
+    end
+    ids_to_accept.each { |id| accept!(id) }
+  end
+
+  private
+
+    def api_base
+      'http://www.pivotaltracker.com/services/v3'
+    end
+
+    def story_uri
+      URI.parse("#{api_base}/projects/#{project_id}/stories/#{story_id}")
+    end
+end

data/lib/pivotal-github/version.rb

@@ -1,5 +1,5 @@
 module Pivotal
   module Github
-    VERSION = "0.9.1"
+    VERSION = "1.0.0"
   end
 end

data/spec/commands/story_accept_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe StoryAccept do
+
+  let(:command) { StoryAccept.new(['-o', '-a']) }
+  before do
+    command.stub(:story_branch).and_return('62831853-tau-manifesto')
+    command.stub(:already_accepted?).and_return(false)
+  end
+  subject { command }
+
+  it { should respond_to(:ids_to_accept) }
+
+  describe "ids_to_accept" do
+    let(:ids) { command.ids_to_accept }
+    subject { ids }
+
+    it { should_not be_empty }
+    it { should include("51204529") }
+    it { should include("51106181") }
+    it { should include("50566167") }
+
+    it "should not have duplicate ids" do
+      expect(ids).to eq ids.uniq
+    end
+  end
+
+
+  its(:api_token) { should_not be_empty }
+
+  describe "accept!" do
+    before do
+      command.stub(:accept!)
+    end
+
+    it "should accept each id" do
+      number_accepted = command.ids_to_accept.length
+      command.should_receive(:accept!).exactly(number_accepted).times
+      command.run!
+    end
+  end
+
+  describe "when stopping upon reading the first accepted id" do
+    let(:command) { StoryAccept.new(['-o']) }
+    before do
+      command.stub(:story_branch).and_return('62831853-tau-manifesto')
+      command.stub(:already_accepted?).and_return(false)
+      command.stub(:already_accepted?).with("50566167").and_return(true)
+    end
+    subject { command }
+
+    its(:ids_to_accept) { should include("51204529") }
+    its(:ids_to_accept) { should include("51106181") }
+    its(:ids_to_accept) { should_not include("50566167") }
+  end
+end

metadata

@@ -1,19 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: pivotal-github
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Michael Hartl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-09 00:00:00.000000000 Z
+date: 2013-06-18 00:00:00.000000000 Z
 dependencies: []
 description: Add commands for Pivotal Tracker-GitHub integration
 email:
 - michael@michaelhartl.com
 executables:
+- git-story-accept
 - git-story-commit
 - git-story-merge
 - git-story-pull-request
@@ -21,7 +22,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- .api_token
 - .gitignore
+- .project_id
 - .rspec
 - .ruby-gemset
 - .ruby-version
@@ -29,6 +32,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/git-story-accept
 - bin/git-story-commit
 - bin/git-story-merge
 - bin/git-story-pull-request
@@ -37,6 +41,7 @@ files:
 - lib/pivotal-github/command.rb
 - lib/pivotal-github/finished_command.rb
 - lib/pivotal-github/options.rb
+- lib/pivotal-github/story_accept.rb
 - lib/pivotal-github/story_commit.rb
 - lib/pivotal-github/story_merge.rb
 - lib/pivotal-github/story_open.rb
@@ -44,6 +49,7 @@ files:
 - lib/pivotal-github/version.rb
 - pivotal-github.gemspec
 - spec/commands/command_spec.rb
+- spec/commands/story_accept_spec.rb
 - spec/commands/story_commit_spec.rb
 - spec/commands/story_merge_spec.rb
 - spec/commands/story_open_spec.rb
@@ -75,6 +81,7 @@ specification_version: 4
 summary: See the README for full documentation
 test_files:
 - spec/commands/command_spec.rb
+- spec/commands/story_accept_spec.rb
 - spec/commands/story_commit_spec.rb
 - spec/commands/story_merge_spec.rb
 - spec/commands/story_open_spec.rb