Class: Toolshed::TicketTracking::PivotalTracker

Inherits:
Object
  • Object
show all
Extended by:
Toolshed::TicketTracking
Includes:
HTTParty
Defined in:
lib/toolshed/ticket_tracking/pivotal_tracker.rb

Constant Summary collapse

DEFAULT_COMPLETED_STATUS =
'finished'
USE_PROJECT_ID =
true

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Toolshed::TicketTracking

clean, story_id_from_branch_name

Constructor Details

#initialize(options = {}) ⇒ PivotalTracker

Returns a new instance of PivotalTracker.



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# File 'lib/toolshed/ticket_tracking/pivotal_tracker.rb', line 12

def initialize(options={})
  username = Toolshed::Client::pivotal_tracker_username
  password = Toolshed::Client::pivotal_tracker_password

  unless (options[:username].nil?)
    username = options[:username]
  end

  unless (options[:password].nil?)
     password = options[:password]
  end

  self.token = ::PivotalTracker::Client.token(username, password)

  self.project_id = (options[:project_id].nil?) ? Toolshed::Client.default_pivotal_tracker_project_id : options[:project_id]
  @pt_project = ::PivotalTracker::Project.find(self.project_id)
  self.story = @pt_project.stories.find(options[:ticket_id])
end

Instance Attribute Details

#project_idObject

Returns the value of attribute project_id.



10
11
12
# File 'lib/toolshed/ticket_tracking/pivotal_tracker.rb', line 10

def project_id
  @project_id
end

#storyObject

Returns the value of attribute story.



10
11
12
# File 'lib/toolshed/ticket_tracking/pivotal_tracker.rb', line 10

def story
  @story
end

#tokenObject

Returns the value of attribute token.



10
11
12
# File 'lib/toolshed/ticket_tracking/pivotal_tracker.rb', line 10

def token
  @token
end

Class Method Details

.create_instance(options = {}) ⇒ Object



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
# File 'lib/toolshed/ticket_tracking/pivotal_tracker.rb', line 94

def create_instance(options={})
  unless (options.has_key?(:project_id))
    raise 'Unable to use PivotalTracker as project id was not supplied'
  end

  unless (options.has_key?(:ticket_id))
    raise 'Unable to use PivotalTracker as story id was not supplied'
  end

  Toolshed::TicketTracking::PivotalTracker.new({
    project_id: options[:project_id],
    username:   Toolshed::TicketTracking::PivotalTracker.username,
    password:   Toolshed::TicketTracking::PivotalTracker.password,
    ticket_id:   options[:ticket_id],
  })
end

.passwordObject



81
82
83
84
85
86
87
88
89
90
91
92
# File 'lib/toolshed/ticket_tracking/pivotal_tracker.rb', line 81

def password
  password = Toolshed::Client::pivotal_tracker_password
  if (password.nil?)
    # prompt to ask for password
    system "stty -echo"
    puts "PivotalTracker password? "
    password = $stdin.gets.chomp.strip
    system "stty echo"
  end

  return password
end

.usernameObject



70
71
72
73
74
75
76
77
78
79
# File 'lib/toolshed/ticket_tracking/pivotal_tracker.rb', line 70

def username
  username = Toolshed::Client::pivotal_tracker_username
  if (username.nil?)
    # prompt to ask for username
    puts "PivotalTracker username? "
    username = $stdin.gets.chomp.strip
  end

  return username
end

Instance Method Details

#add_note(note_text) ⇒ Object



35
36
37
# File 'lib/toolshed/ticket_tracking/pivotal_tracker.rb', line 35

def add_note(note_text)
  results = self.story.notes.create(text: note_text)
end

#ticketObject



31
32
33
# File 'lib/toolshed/ticket_tracking/pivotal_tracker.rb', line 31

def ticket
  self.story
end

#titleObject



61
62
63
# File 'lib/toolshed/ticket_tracking/pivotal_tracker.rb', line 61

def title
  self.clean(self.story.name)
end

#update_ticket_status(current_state, options = {}) ⇒ Object



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# File 'lib/toolshed/ticket_tracking/pivotal_tracker.rb', line 39

def update_ticket_status(current_state, options={})
  options.merge!({
    :headers => {
        "X-TrackerToken"  => self.token,
        "User-Agent"      => "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_2) AppleWebKit/537.17 (KHTML, like Gecko) Chrome/24.0.1309.0 Safari/537.17",
        "Content-Type"    => "application/json",
    },
    body: {
      current_state: current_state
    }.to_json
  })

  response = HTTParty.put("#{Toolshed::Client::PIVOTAL_TRACKER_BASE_API_URL}projects/#{self.project_id}/stories/#{self.story.id}", options).response
  response = JSON.parse(response.body)

  if (response["error"].nil?)
    response
  else
    raise "validation errors #{response.inspect}"
  end
end

#url(ticket_id) ⇒ Object



65
66
67
# File 'lib/toolshed/ticket_tracking/pivotal_tracker.rb', line 65

def url(ticket_id)
  self.story.url
end