Class: GitPivotalTrackerIntegration::Command::Base Abstract

Inherits:
Object
  • Object
show all
Defined in:
lib/git-pivotal-tracker-integration/command/base.rb

Overview

This class is abstract.

Subclass and override #run to implement command functionality

An abstract base class for all commands

Direct Known Subclasses

Deliver, Finish, Newbug, Newfeature, Release, Report, Start

Constant Summary collapse

TIMER_TOKENS =

Toggl keys name : The name of the task (string, required, unique in project) pid : project ID for the task (integer, required) wid : workspace ID, where the task will be saved (integer, project’s workspace id is used when not supplied) uid : user ID, to whom the task is assigned to (integer, not required) estimated_seconds : estimated duration of task in seconds (integer, not required) active : whether the task is done or not (boolean, by default true) at : timestamp that is sent in the response for PUT, indicates the time task was last updated – Additional fields – done_seconds : duration (in seconds) of all the time entries registered for this task uname : full name of the person to whom the task is assigned to

{
    "m" => (60),
    "h" => (60 * 60),
    "d" => (60 * 60 * 8) # a work day is 8 hours
}

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Base

Common initialization functionality for all command classes. This enforces that:

  • the command is being run within a valid Git repository

  • the user has specified their Pivotal Tracker API token

  • all communication with Pivotal Tracker will be protected with SSL

  • the user has configured the project id for this repository



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/git-pivotal-tracker-integration/command/base.rb', line 29

def initialize
  self.start_logging
  self.check_version

  git_global_push_default = (Util::Shell.exec "git config --global push.default", false).chomp
  if git_global_push_default != "simple"
    puts "git config --global push.default simple"
    puts Util::Shell.exec "git config --global push.default simple"
  end

  @repository_root  = Util::Git.repository_root
  @toggl            = Toggl.new
  @configuration    = Command::Configuration.new

  @configuration.check_for_config_file
  @configuration.check_for_config_contents

  @client           = TrackerApi::Client.new(:token => @configuration.api_token, :logger => Logger.new('faraday.log'))
  @platform         = @configuration.platform_name

  current_project_id  = @configuration.project_id.to_i
  @project            = @client.project current_project_id
  my_projects         = @client.projects

  unless my_projects && my_projects.map(&:id).include?(current_project_id)
    project_manager_name  = @configuration.pconfig["project"]["project-manager"]
    project_manager_email = @configuration.pconfig["project"]["project-manager-email"]
    project_name          = @configuration.pconfig["project"]["project-name"]
    abort "This project requires access to the Pivotal Tracker project [#{project_name} - #{current_project_id}]. Please speak with project manager [#{project_manager_name} - #{project_manager_email}] and ask him to add you to the project in Pivotal Tracker."
  end
end

Instance Method Details

#check_version ⇒ Object 



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/git-pivotal-tracker-integration/command/base.rb', line 90

def check_version
  gem_latest_version    = (Util::Shell.exec "gem list v2gpti --remote")[/\(.*?\)/].delete "()"
  gem_installed_version = Gem.loaded_specs["v2gpti"].version.version
  if (gem_installed_version == gem_latest_version)
      $LOG.info("v2gpti verison #{gem_installed_version} is up to date.")
  else
      $LOG.fatal("Out of date")
      if OS.windows?
        abort "\n\nYou are using v2gpti version #{gem_installed_version}, but the current version is #{gem_latest_version}.\nPlease update your gem with the following command.\n\n    gem update v2gpti\n\n"
      else
  abort "\n\nYou are using v2gpti version #{gem_installed_version}, but the current version is #{gem_latest_version}.\nPlease update your gem with the following command.\n\n    sudo gem update v2gpti\n\n"
end
  end
rescue StandardError => se
  puts ""
end

#create_backlog_bug_story(args) ⇒ Object 



207
208
209
 
# File 'lib/git-pivotal-tracker-integration/command/base.rb', line 207

def create_backlog_bug_story(args)
  create_story_with_type_state("bug", "unstarted", args)
end

#create_backlog_feature_story(args) ⇒ Object 



215
216
217
 
# File 'lib/git-pivotal-tracker-integration/command/base.rb', line 215

def create_backlog_feature_story(args)
  create_story_with_type_state("feature", "unstarted", args)
end

#create_icebox_bug_story(args) ⇒ Object 



203
204
205
 
# File 'lib/git-pivotal-tracker-integration/command/base.rb', line 203

def create_icebox_bug_story(args)
  create_story_with_type_state("bug", "unscheduled", args)
end

#create_icebox_feature_story(args) ⇒ Object 



211
212
213
 
# File 'lib/git-pivotal-tracker-integration/command/base.rb', line 211

def create_icebox_feature_story(args)
 create_story_with_type_state("feature", "unscheduled", args)
end

#create_story(args) ⇒ Object 



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/git-pivotal-tracker-integration/command/base.rb', line 173

def create_story(args)
  story_types = {"f" => "feature", "b" => "bug", "c" => "chore"}
  new_story_type = nil
  new_story_title = nil
  new_story_estimate = -1
  args.each do |arg|
    new_story_type = story_types[arg[-1]] if arg.include? '-n'
    new_story_title = arg if arg[0] != "-"
  end

  while new_story_type.nil?
    nst = ask("Please enter f for feature, b for bug, or c for chore")
    new_story_type = story_types[nst]
  end

  while (new_story_title.nil? || new_story_title.empty?)
    new_story_title = ask("Please enter the title for this #{new_story_type}.")
  end

  if (new_story_type == "feature" && (new_story_estimate < 0 || new_story_estimate > 3))
    new_story_estimate = estimate_story
  end

  attrs = {:story_type => new_story_type, :current_state => 'unstarted', :name => new_story_title}
  attrs[:estimate] = new_story_estimate if new_story_type == "feature"

  @project.create_story(attrs)

end

#estimated_seconds(story) ⇒ Object 



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/git-pivotal-tracker-integration/command/base.rb', line 155

def estimated_seconds(story)
  estimate = story.estimate
  seconds = 0
  case estimate
    when 0
      estimate = 15 * 60
    when 1
      estimate = 1.25 * 60 * 60
    when 2
      estimate = 3 * 60 * 60
    when 3
      estimate = 8 * 60 * 60
    else
      estimate = -1 * 60 * 60
  end
  estimate
end

#finish_toggle(configuration, time_spent) ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/git-pivotal-tracker-integration/command/base.rb', line 61

def finish_toggle(configuration, time_spent)
  current_story = @configuration.story(@project)

  # If a story gets rejected and the developer works on it, then we need to check if the task is already created or not.
  params =  parameters(configuration, time_spent)
  if params[:tid].nil?
    begin
      @toggl.create_task(parameters(configuration, time_spent))
    rescue TogglException => te
      puts ""
    end
  end

  #If for some reason time entry cannot be done, then catch exception and continue.
  begin
    @toggl.create_time_entry(parameters(configuration, time_spent))
  rescue TogglException => te
    puts "Unable to log the time."
  end
end

#logger_filename ⇒ Object 



86
87
88
 
# File 'lib/git-pivotal-tracker-integration/command/base.rb', line 86

def logger_filename
  return "#{Dir.home}/.v2gpti_local.log"
end

#parameters(configuration, time_spent) ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/git-pivotal-tracker-integration/command/base.rb', line 129

def parameters(configuration, time_spent)
  current_story              = configuration.story(@project)
  params                     = Hash.new
  params[:name]              = "#{current_story.id}" + " - " + "#{current_story.name}"
  params[:estimated_seconds] = estimated_seconds current_story
  params[:pid]               = configuration.toggl_project_id
  params[:uid]               = @toggl.me["id"]
  params[:tags]              = [current_story.story_type]
  params[:active]            = false
  params[:description]       = "#{current_story.id}" + " commit:" + "#{(Util::Shell.exec "git rev-parse HEAD").chomp[0..6]}"
  params[:created_with]      = "v2gpti"
  params[:duration]          = seconds_spent(time_spent)
  params[:start]             = (Time.now - params[:duration]).iso8601
  task                       = @toggl.get_project_task_with_name(configuration.toggl_project_id, "#{current_story.id}")
   if !task.nil?
     params[:tid] = task['id']
   end
  params
end

#run ⇒ Object

This method is abstract.

Override this method to implement command functionality

The main entry point to the command’s execution

Raises:

  • (NotImplementedError) 


109
110
111
 
# File 'lib/git-pivotal-tracker-integration/command/base.rb', line 109

def run
  raise NotImplementedError
end

#seconds_spent(time_spent) ⇒ Object 



148
149
150
151
152
153
154
 
# File 'lib/git-pivotal-tracker-integration/command/base.rb', line 148

def seconds_spent(time_spent)
  seconds = 0
  time_spent.scan(/(\d+)(\w)/).each do |amount, measure|
    seconds += amount.to_i * TIMER_TOKENS[measure]
  end
  seconds
end

#start_logging ⇒ Object 



82
83
84
 
# File 'lib/git-pivotal-tracker-integration/command/base.rb', line 82

def start_logging
  $LOG = Logger.new("#{logger_filename}", 'weekly')
end