Recipes

• How to get details of a project with project name?

  projectKey = "DEMO"
  puts "Details for project " + projectKey + ":"
  puts jira.getProject(projectKey).inspect , "\n"
  

• How to retrieve values of a custom field

  # Retrieves custom field values for custom field with ID 10083
  # The custom field ID can be found via SQL command:
  # select id from customfield where cfname = "your custom field name"
  customfieldID = "customfield_10150"
  puts "Value of issue " + issue.key + "'s custom field with ID " +
  	customfieldID + ":"
  customFieldValues = issue.customFieldValues
  customFieldValues.each { |cf|
  	puts cf.values if cf.customfieldId == "customfield_10150"
  }
  puts "\n"
  

• How to add comment

  comment = RemoteComment.new()
  comment.body = "commented from jira4r"
  begin
  	jira.addComment(issue.key, comment)
  	puts "Added comment " + comment.body + " in issue " + issue.key , "\n"
  rescue
  end
  

• How to change field value

  summary = RemoteFieldValue.new("summary", "new summary info from jira4r")
  begin
  	jira.updateIssue(issue.key, summary)
  	puts "Updated issue " + issue.key + "'s field " + summary.id , "\n"
  rescue
  end
  

• How to create a user

  begin
  	user = jira.createUser("jon", `date`.strip, "Jon Happy", "jon@usa.com")
  	puts "Created user " + user.name , "\n"
  rescue
  end
  

• How to add a new user to a group

  # Add user to a group
  # This issue and workaround is documented at JRA-7971
  begin
  	newuser = RemoteUser.new()
  	newuser.name = user.name
  	jira.addUserToGroup(group,newuser)
  	puts "Added user " + user.name + " in group " + group.name
  rescue
  end
  

• How to add a new version

  version = RemoteVersion.new()
  version.name = "version 99"
  begin
  	jira.addVersion(project.name, version)
  	puts "Added version " + version.name + " for group " + group.name
  rescue
  end
  

• How to list all projects' keys

  jira.getProjects().each { |project|
  	puts project.key
  }