Class: Zit::Management

Inherits:
Object
  • Object
show all
Defined in:
lib/zit/management.rb

Instance Method Summary collapse

Constructor Details

#initialize(options = {}, settings) ⇒ Management

Returns a new instance of Management.



3
4
5
6
7
8
9
10
11
12
13
14
15
16
 
# File 'lib/zit/management.rb', line 3

def initialize(options = {}, settings)
  @options = options
  @settings = settings
  
  # Options = { 
  #   :system => [jira|zendesk]
  #   :project => 
  #   :foreign_key =>
  #   }
  
  #Validate ENV and Options
  Zit::Error.new("There was an error configuring the client.") unless set_client
  options_validation(options)
end

Instance Method Details

#branch_name(username) ⇒ Object 



54
55
56
57
58
 
# File 'lib/zit/management.rb', line 54

def branch_name(username)
  @options[:branch_name] ||= "#{username}/zd#{@options[:foreign_key]}"                        if @options[:system] == :zendesk
  @options[:branch_name] ||= "#{username}/#{@options[:project]}_#{@options[:foreign_key]}"    if @options[:system] == :jira
  @options[:branch_name]
end

#get_repsteps(audits) ⇒ Object 



111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/zit/management.rb', line 111

def get_repsteps(audits)
  macro_tag = @settings.get("repsteps_tag")
  aud = audits.detect do |audit|
    next unless audit.events.map(&:type).include?("Change")
    next unless audit.events.map(&:field_name).include?("tags")
    next unless audit.events.map(&:value).join(" ").include?(" #{macro_tag} ")
    audit
  end
  return aud.events.detect{|c| c.type == "Comment"}.body unless aud.nil?
  return nil
end

#jira_pingback(msg) ⇒ Object

Jira methods



133
134
135
136
137
 
# File 'lib/zit/management.rb', line 133

def jira_pingback(msg)
  issue = "#{@options[:project]}-#{@options[:foreign_key]}"
  response = @options[:client].add_comment_to_issue(msg, issue)
  puts "Jira issue updated!" if response == 201
end

#options_validation(options) ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/zit/management.rb', line 38

def options_validation(options)
  begin
    Zit::Error.new("Invalid system...") if options[:system] != :zendesk && options[:system] != :jira
    case options[:system]
    when :zendesk
      pick_ticket_recent if options[:foreign_key].nil?
    when :jira
      Zit::Error.new("No jira project!") if options[:project].nil?
      Zit::Error.new("No issue id!") if options[:foreign_key].nil?
    end
    true
  rescue NoMethodError
    Zit::Error.new("Nil Erorr")
  end
end

#pick_comment(comments) ⇒ Object 



82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/zit/management.rb', line 82

def pick_comment(comments)
  step = -1
  until (0..comments.size-1).include?(step)
    puts "Would you like to choose a comment from the issue as a description for your PR?"
    comments.each_index do |n|
      puts "#{n}. #{comments[n]["body"].inspect}"
    end
    print "(N)o, #:"
    step = gets.chomp
    step = Integer(step) unless step.to_s.downcase == "no"
    return nil if step.to_s.downcase == "no"
  end
  comments[step]["body"]
end

#pick_ticket_recent ⇒ Object 



123
124
125
126
127
128
129
 
# File 'lib/zit/management.rb', line 123

def pick_ticket_recent
  recent_list = @options[:client].tickets.recent.fetch
  puts "No ticket specified. You can specify a ticket by using \"-t [ticket_id]\" as a parameter."
  puts "Ticket ID\tSubject "
  recent_list.each{|ticket| puts "#{ticket["id"]}\t#{ticket["subject"]}"}
  exit
end

#ping_back(msg) ⇒ Object 



60
61
62
 
# File 'lib/zit/management.rb', line 60

def ping_back(msg)
  @options[:system] == :zendesk ? zendesk_pingback(msg) : jira_pingback(msg)
end

#pr_link ⇒ Object 



97
98
99
 
# File 'lib/zit/management.rb', line 97

def pr_link
  link = "#{@settings.get("base_repo")}/compare/master..."
end

#ready ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/zit/management.rb', line 64

def ready
  if @options[:system] == :zendesk
    ticket = @options[:client].tickets.find(:id => @options[:foreign_key])
    audits = ticket.audits.fetch
    comments = audits.map{|m| m["events"].select{|c| c if c["type"] == "Comment"} }
    rep_steps = (get_repsteps(audits) || pick_comment(comments.flatten!)) if @settings.get("include_repsteps_by_default")
  elsif @options[:system] == :jira
    issue = @options[:client].get_issue("#{@options[:project]}-#{@options[:foreign_key]}")
    comments = issue["fields"]["comment"]["comments"]
    rep_steps = (pick_comment(comments) || "Place a brief description here.") if @settings.get("include_repsteps_by_default")
  end
  rep_steps ||= "Description goes here..."
  link = "#{pr_link}#{@options[:current_branch]}"
  title_prefix = @options[:system] == :zendesk ? "ZD" : "#{@options[:project]}-"
  cmd = "open '#{link}?pull_request[title]=#{title_prefix}#{@options[:foreign_key]}&pull_request[body]=#{CGI.escape(rep_steps)}'"
  system(cmd)
end

#set_client ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/zit/management.rb', line 18

def set_client
  case @options[:system]
  when :zendesk
    env_set = (TOKEN.is_a?(String) && TOKEN.size > 0) && (USER.is_a?(String) && USER.size > 0)
    Zit::Error.new("Unable to locate the zendesk_token and zendesk_user environment variables. Please set them and try again.") unless env_set
    puts "Connecting to Zendesk..."
    @client = ZendeskAPI::Client.new do |config|
      config.url = @settings.get("zendesk_url")
      config.username = USER
      config.token = TOKEN
    end
    puts "Connected as #{@client.current_user[:name]}"
    @options[:client] = @client
    true
  when :jira
    @options[:client] = JiraClient.new()
    true
  end
end

#zendesk_pingback(msg) ⇒ Object

Zendesk methods



103
104
105
106
107
108
109
 
# File 'lib/zit/management.rb', line 103

def zendesk_pingback(msg)
  ticket = @options[:client].tickets.find(:id => @options[:foreign_key].to_i)
  ticket.comment = {:body => msg}
  ticket.comment.public = false
  puts "Creating ticket comment"
  ticket.save
end