pivotal-git-tracker 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5ade6820466519a7d7a21ea6840893b2be0fa5d
-  data.tar.gz: 3c14d53daff6caa970f28108a1421aaa378cd603
+  metadata.gz: 2651207423effbf1213ad57a1acdd440ad066284
+  data.tar.gz: 3d1066dc2d476e125008fbc11e4b643147c00c8e
 SHA512:
-  metadata.gz: 82ec3bbcdb85c62b1a151a1ff3d70ad335e848bf75834dbb98ab4d9b25821f655862779ec8b3701ca986bcf16baecd2a51361a47fe0a65a7a2d32ca904a012c4
-  data.tar.gz: cd087b2f2c298fced103756387f4d722d46218361d5d8be0eb30e2265cc5750c182672bc198cc566b7f084b53a4a2e441f38011892a8c810294f8d69c211c94b
+  metadata.gz: 7155033ee3bf6421389cba48fbbb65bb6496c4983b57ee2ec36c03fc2dd4099f5945c87d4e867935b0f22cb552aefe6fb6c1c433eeca7bd62010bfcc0b104fb6
+  data.tar.gz: 26ca8296f54aa21ec7afb1db917bbe15ec8efbbe8e20fc182429c9533ac3d3d68eaf755d733f9a302d04959dab47c21742830d187e6c0d6628adadb3e75abec3

data/README.md

@@ -2,15 +2,15 @@
 
 Update Pivotal Tracker depending on your local Git repository.
 
-This gem finds all finished stories and bugs and if it finds the story id in a Git commit, marks that story as delivery.
-
+This gem finds all finished stories and bugs and if it finds the story id in a Git commit, marks that story as delivered.
 This has proved useful as part of a 'deploy to staging' strategy. If you automatically deploy to a staging environment after a successful continuous integration build, and want to update a story from 'finished' to 'delivered', then this Gem is for you.
+The gem will add a comment to the Pivotal story everytime the commit is deployed to an environment (for example: staging -> acceptance -> production).
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'tracker-git'
+    gem 'pivotal-git-tracker'
 
 And then execute:
 
@@ -18,7 +18,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install tracker-git
+    $ gem install pivotal-git-tracker
 
 ## Usage
 
@@ -27,36 +27,8 @@ the tracker id and access token as command line arguments, or with following
 environment variables set, and your finished stories will be updated to
 delivered.
 
-    export TRACKER_PROJECT_ID=123456
-    export TRACKER_TOKEN=abc123
-    tracker
-
-You can also pass the project id and token in as parameters
-
-    tracker 123456 abc123
+    tracker 123456 abc123 branch-name server-name
     
-## Optional parameters
-
-Optionally you can specify a git branch to search for completed story IDs as
-the third command line argument or with the GIT\_BRANCH environment variable.
-
-If you want to add a label (tag) to the story marked as delivered, you
-can use the `--label` flag:
-
-    tracker --label THE_LABEL
-
-
-For detect tasks only in commits which delivered to servers
-
-    --remote-branch=heroku/master
-
-For commenting task with message 'Delivered by script to <%server_name_parameter%>'
-
-    --server-name=staging
-
-Optionally you can specify a git branch to search for completed story IDs as
-the third command line argument or with the GIT\_BRANCH environment variable.
-
 ## Contributing
 
 1. Fork it

data/bin/tracker

@@ -1,52 +1,22 @@
 #!/usr/bin/env ruby
-require 'optparse'
 
 begin
   require 'pivotal-git-tracker'
-  require 'optparse'
 rescue LoadError
   require 'rubygems'
   require 'pivotal-git-tracker'
 end
 
-remote_branch, server_name = [ENV['REMOTE_BRANCH'], ENV['SERVER_NAME']]
-options = {}
-OptionParser.new do |opts|
-  opts.banner = "Usage: example.rb [options]"
-
-  opts.on("-l", "--label LABEL", "Add a label to a story marked as deployed") do |label|
-    options[:label] = label if label =~ /[^[:space:]]/
-  end
-
-  opts.on("-a", "--accept", "Changes status from delivered to accepted") do |accept|
-    options[:accept] = true
-  end
-
-  opts.on('--remote-branch [VALUE]') do |value|
-    remote_branch = value
-  end
-
-  opts.on('--server-name [VALUE]') do |value|
-    server_name = value
-  end
-end.parse!
-
-project_id, tracker_token, git_branch, server_name = \
-  if [2, 3, 4].include? ARGV.size
+project_id, tracker_token, git_branch, server_name, version = \
+  if [2, 3, 4, 5].include? ARGV.size
     ARGV
-  else
-    [ENV['TRACKER_PROJECT_ID'], ENV['TRACKER_TOKEN'], ENV['GIT_BRANCH']]
   end
 
 unless tracker_token && project_id
   puts <<-USAGE
 Usage: Pass your pivotal tracker project id and access token on the command
 line, e.g:
-  tracker 123456 abc123
-or as an environment variable:
-  export TRACKER_PROJECT_ID=123456
-  export TRACKER_TOKEN=abc123
-  tracker
+  tracker 123456 abc123 branch-name server-name version
   USAGE
 	exit(1)
 end
@@ -54,5 +24,5 @@ end
 project = Tracker::Project.new(tracker_token, project_id)
 git = Tracker::Git.new
 deliverer = Tracker::Deliverer.new(project, git)
-deliverer.mark_as_delivered(git_branch, remote_branch, options[:label], false, server_name)
-deliverer.mark_as_accepted(git_branch, remote_branch, options[:label]) if options[:accept]
+deliverer.mark_as_delivered(git_branch, server_name)
+deliverer.find_and_comment(git_branch, server_name, version)

data/lib/pivotal-git-tracker.rb

@@ -1,5 +1,5 @@
-require "pivotal-git-tracker/version"
-require "pivotal-git-tracker/project"
-require "pivotal-git-tracker/git"
-require "pivotal-git-tracker/deliverer"
+require 'pivotal-git-tracker/version'
+require 'pivotal-git-tracker/project'
+require 'pivotal-git-tracker/git'
+require 'pivotal-git-tracker/deliverer'
 

data/lib/pivotal-git-tracker/deliverer.rb

@@ -6,25 +6,31 @@ module Tracker
       @git = git
     end
 
-    def mark_as_delivered(branch = nil,remote_branch= nil, label = nil, use_accepted = false, server_name = nil)
+    def mark_as_delivered(branch = nil, server_name = nil)
       options = {}
       options[:branch] = branch if branch
-      options[:remote_branch] = remote_branch if remote_branch
 
-      collection = use_accepted ? project.delivered : project.finished
+      collection = project.finished
 
       collection.each do |story|
         if git.contains?(story.id, options)
-          project.accept(story) if use_accepted
-          project.deliver(story) unless use_accepted
-          project.add_label(story, label) if label
+          puts "Delivering story with id #{story.id} on server #{server_name}"
+          project.deliver(story)
           project.comment(story, server_name) if server_name
         end
       end
     end
 
-    def mark_as_accepted(branch = nil,remote_branch = nil, label = nil)
-      mark_as_delivered(branch, remote_branch, label, true)
+    def find_and_comment(branch = nil, server_name = nil, version = nil)
+      options = {}
+      options[:branch] = branch if branch
+
+      for story_id in git.latest_log(options)
+        puts "Found story with id #{story_id} on server #{server_name}"
+        story = project.find(story_id)
+        project.comment(story, server_name)
+        project.add_label(story, version) if version
+      end
     end
   end
 end

data/lib/pivotal-git-tracker/git.rb

@@ -1,10 +1,17 @@
 module Tracker
   class Git
     def contains?(message, options = {})
-      branch = options.fetch(:branch, "HEAD")
+      branch = options.fetch(:branch, 'HEAD')
       remote_branch = options[:remote_branch]
       result = `git log #{[remote_branch, branch].compact.join('..')} --grep='#{message}'`
       result.length > 0
     end
+
+    def latest_log(options = {})
+      branch = options.fetch(:branch, 'HEAD')
+      remote_branch = options[:remote_branch]
+      commits = `git log -n 100 #{[remote_branch, branch].compact.join('..')} --grep='#' --oneline`
+      commits = commits.scan(/#([0-9]+)/).flatten
+    end
   end
 end

data/lib/pivotal-git-tracker/project.rb

@@ -13,30 +13,37 @@ module Tracker
       PivotalTracker::Client.use_ssl = true
     end
 
+    def find(story_id)
+      _project.stories.find(story_id)
+    end
+
     def finished
-      _project.stories.all(state: "finished", story_type: ['bug', 'feature'])
+      _project.stories.all(state: 'finished', story_type: ['bug', 'feature'])
     end
 
     def delivered
-      _project.stories.all(state: "delivered", story_type: ['bug', 'feature'])
+      _project.stories.all(state: 'delivered', story_type: ['bug', 'feature'])
     end
 
     def deliver(story)
-      story.update(current_state: "delivered")
+      story.update(current_state: 'delivered')
     end
 
     def accept(story)
-      story.update(current_state: "accepted")
+      story.update(current_state: 'accepted')
     end
 
     def add_label(story, label)
-      labels = (story.labels || "").split(",")
+      labels = (story.labels || '').split(',')
       labels << label
-      story.update(labels: labels.join(","))
+      story.update(labels: labels.join(','))
     end
 
     def comment(story, server_name)
-      story.notes.create(:text => "Delivered by script to #{server_name}")
+      msg = "Delivered by script to #{server_name}"
+      unless story.notes.all.include? msg
+        story.notes.create(:text => msg)
+      end
     end
 
     private

data/lib/pivotal-git-tracker/version.rb

@@ -1,3 +1,3 @@
 module Tracker
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'
 end

data/spec/deliverer_spec.rb

@@ -4,9 +4,9 @@ describe Tracker::Deliverer do
 
   let(:tracker_token) { double }
   let(:project_id) { double }
-  let(:commited_story) { double(id: 1) }
-  let(:uncommited_story) { double(id: 2) }
-  let(:finished_stories) { [commited_story, uncommited_story] }
+  let(:committed_story) { double(id: 1) }
+  let(:uncommitted_story) { double(id: 2) }
+  let(:finished_stories) { [committed_story, uncommitted_story] }
   let(:project) { double }
   let(:git) { double }
   let(:deliverer) { Tracker::Deliverer.new(project, git) }
@@ -17,9 +17,9 @@ describe Tracker::Deliverer do
         expect(project).to receive(:finished) { finished_stories }
         expect(git).to receive(:contains?).with(1, {}) { true }
         expect(git).to receive(:contains?).with(2, {}) { false }
-        expect(project).to receive(:deliver).with(commited_story)
-        expect(project).to_not receive(:deliver).with(uncommited_story)
-        expect(project).to_not receive(:comment).with(uncommited_story)
+        expect(project).to receive(:deliver).with(committed_story)
+        expect(project).to_not receive(:deliver).with(uncommitted_story)
+        expect(project).to_not receive(:comment).with(uncommitted_story)
 
         deliverer.mark_as_delivered
       end
@@ -30,37 +30,23 @@ describe Tracker::Deliverer do
         expect(project).to receive(:finished) { finished_stories }
         expect(git).to receive(:contains?).with(1, {branch: 'develop'}) { true }
         expect(git).to receive(:contains?).with(2, {branch: 'develop'}) { false }
-        expect(project).to receive(:deliver).with(commited_story)
-        expect(project).to_not receive(:deliver).with(uncommited_story)
+        expect(project).to receive(:deliver).with(committed_story)
+        expect(project).to_not receive(:deliver).with(uncommitted_story)
         expect(project).to_not receive(:comment)
         deliverer.mark_as_delivered('develop')
       end
     end
 
-    context 'when given a label to add' do
-      it('should mark stories as delivered and add a label') do
-        expect(project).to receive(:finished) { finished_stories }
-        expect(git).to receive(:contains?).with(1, {}) { true }
-        expect(git).to receive(:contains?).with(2, {}) { false }
-        expect(project).to receive(:deliver).with(commited_story)
-        expect(project).to_not receive(:deliver).with(uncommited_story)
-        expect(project).to receive(:add_label).with(commited_story, 'label')
-        expect(project).to_not receive(:add_label).with(uncommited_story, 'label')
-
-        deliverer.mark_as_delivered(nil, nil, 'label')
-      end
-    end
-
     context 'when given a specific server name' do
       it('should comment story with server name where story is delivered') do
         expect(project).to receive(:comment)
         expect(project).to receive(:finished) { finished_stories }
         expect(git).to receive(:contains?).with(1, {}) { true }
         expect(git).to receive(:contains?).with(2, {}) { false }
-        expect(project).to receive(:deliver).with(commited_story)
-        expect(project).not_to receive(:deldeliveriver).with(commited_story)
+        expect(project).to receive(:deliver).with(committed_story)
+        expect(project).not_to receive(:deldeliveriver).with(committed_story)
 
-        deliverer.mark_as_delivered(nil, nil, nil, false, 'spot instance')
+        deliverer.mark_as_delivered(nil, 'staging-server')
       end
 
     end

data/spec/git_spec.rb

@@ -1,57 +1,64 @@
 require 'spec_helper'
 
 describe Tracker::Git do
-  describe "#search" do
-    let(:message) { "[Finishes #123456]" }
-    let(:branch) { "HEAD" }
+  describe '#search' do
+    let(:message) { '[Finishes #123456]' }
+    let(:branch) { 'HEAD' }
     let(:query) { "git log #{branch} --grep='#{message}'" }
-    let(:result) { "Some git message" }
+    let(:result) { 'Some git message' }
     let(:git) { Tracker::Git.new }
 
+    context 'from history' do
+      before do
+        expect(git).to receive(:`).with("git log -n 100 HEAD --grep='#' --oneline") { '#100 #99' }
+      end
+
+      it 'gets latest x logs' do
+        expect(git.latest_log).to eq(['100', '99'])
+      end
+    end
+
     context 'when remote branch is not used' do
       before do
         expect(git).to receive(:`).with(query) { result }
       end
 
-      context "defaults" do
-        it "searches via system calls using default branch" do
+      context 'defaults' do
+        it 'searches via system calls using default branch' do
           expect(git.contains?(message)).to eq(true)
         end
 
-        context "passing branch" do
-          let(:branch) { "test" }
-          it "searches via system calls using given branch" do
+        context 'passing branch' do
+          let(:branch) { 'test' }
+          it 'searches via system calls using given branch' do
             expect(git.contains?(message, branch: branch)).to eq(true)
           end
 
-          context "passing branch" do
-            let(:branch) { "test" }
-            it "searches via system calls using given branch" do
+          context 'passing branch' do
+            let(:branch) { 'test' }
+            it 'searches via system calls using given branch' do
               expect(git.contains?(message, branch: branch)).to eq(true)
             end
           end
 
         end
 
-        context "no result found" do
-          let(:result) { "" }
-          it "returns false" do
+        context 'no result found' do
+          let(:result) { '' }
+          it 'returns false' do
             expect(git.contains?(message)).to eq(false)
           end
         end
       end
     end
 
-    context "when remote brach is not blank" do
+    context 'when remote brach is not blank' do
       let(:remote_branch) { 'remote/branch' }
       before { expect(git).to receive(:`).with("git log #{remote_branch}..#{branch} --grep='#{message}'") { result } }
 
-      it "searches via system calls using geven remote and local branches" do
+      it 'searches via system calls using geven remote and local branches' do
         git.contains?(message, branch: branch, remote_branch: remote_branch)
       end
-
     end
-
-
   end
 end

data/spec/project_spec.rb

@@ -8,8 +8,8 @@ describe Tracker::Project do
   let(:feature) { double }
   let(:bug) { double }
 
-  describe "#initialize" do
-    it "initializes the project class" do
+  describe '#initialize' do
+    it 'initializes the project class' do
       project = Tracker::Project.new(tracker_token, project_id)
       expect(project).to be
       expect(project.tracker_token).to eq(tracker_token)
@@ -17,38 +17,37 @@ describe Tracker::Project do
     end
   end
 
-  describe "#finished" do
-
+  describe '#finished' do
     let(:query) { double }
 
     before do
       expect(PivotalTracker::Project).to receive(:find).with(project_id) { the_project }
       expect(the_project).to receive(:stories) { query }
-      expect(query).to receive(:all).with(state: "finished", story_type: ['bug', 'feature']) { [feature, bug] }
+      expect(query).to receive(:all).with(state: 'finished', story_type: ['bug', 'feature']) { [feature, bug] }
     end
 
-    it "retrieves finished stories and bugs" do
+    it 'retrieves finished stories and bugs' do
       project = Tracker::Project.new(tracker_token, project_id)
       expect(project.finished).to eq([feature, bug])
     end
   end
 
-  describe "#deliver" do
+  describe '#deliver' do
     let(:project) { Tracker::Project.new(double, double) }
     let(:story) { double }
 
-    it "marks the story as delivered" do
-      expect(story).to receive(:update).with(current_state: "delivered")
+    it 'marks the story as delivered' do
+      expect(story).to receive(:update).with(current_state: 'delivered')
       project.deliver(story)
     end
   end
 
-  describe "#add_label" do
+  describe '#add_label' do
     let(:project) { Tracker::Project.new(double, double) }
     let(:story) { double }
 
     context 'there is no label on the story' do
-      it "adds a label" do
+      it 'adds a label' do
         expect(story).to receive(:labels) { '' }
         expect(story).to receive(:update).with(labels: 'label')
         project.add_label(story, 'label')
@@ -56,7 +55,7 @@ describe Tracker::Project do
     end
 
     context 'there is already one label on the story' do
-      it "adds a label" do
+      it 'adds a label' do
         expect(story).to receive(:labels) { 'foo' }
         expect(story).to receive(:update).with(labels: 'foo,label')
         project.add_label(story, 'label')
@@ -64,7 +63,7 @@ describe Tracker::Project do
     end
 
     context 'there is already two labels on the story' do
-      it "adds a label" do
+      it 'adds a label' do
         expect(story).to receive(:labels) { 'foo,bar' }
         expect(story).to receive(:update).with(labels: 'foo,bar,label')
         project.add_label(story, 'label')
@@ -72,7 +71,7 @@ describe Tracker::Project do
     end
   end
 
-  describe "#comment" do
+  describe '#comment' do
     let(:project) { Tracker::Project.new(double, double) }
     let(:story) { double }
     let(:notes_stub) { double }
@@ -81,7 +80,7 @@ describe Tracker::Project do
     before { allow(notes_stub).to receive(:create).with( hash_including(:text => "Delivered by script to #{server_name}")) }
     before { expect(story).to receive(:notes) { notes_stub } }
 
-    it "comment story with server" do
+    it 'comment story with server' do
       project.comment story, server_name
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pivotal-git-tracker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Marcel Panse