Initial commit

Author: rgustavs

DESCRIPTION

@@ -0,0 +1,14 @@
+Package: tidyJira
+Type: Package
+Title: Tidy exports of jira data
+Version: 0.1.0
+Author: Richard Gustavsson [aut, cre]
+Maintainer: Richard Gustavsson <rgustavs@gmail.com>
+Description: Tidy data export of jira issues. Data set includes issues and issues worklog. Integration is based on REST api
+ and authentication based on login/password.
+Imports: dplyr, httr, jsonlite, lubridate
+License: GPL-3
+Encoding: UTF-8
+LazyData: true
+Suggests: testthat
+RoxygenNote: 6.0.1

NAMESPACE

@@ -0,0 +1,7 @@
+# Generated by roxygen2: do not edit by hand
+
+export(jira_connect)
+export(jira_get)
+export(jira_issue)
+export(jira_issue_worklog)
+#export(map_chr_hack)

R/jira_connect.R

@@ -0,0 +1,35 @@
+
+#' Validate the connection to jira by logging in an performing a search
+#'
+#' @param host 
+#' @param user 
+#' @param password 
+#'
+#' @return
+#' @export
+#'
+#' @examples
+jira_connect <- function(host, user, password) {
+  if(is.null(host))
+    stop('host is NULL.')
+  
+  if(is.null(user))
+    stop("user is NULL")
+  
+  if(is.null(password))
+    stop("password is NULL")
+  
+  url <- file.path(host, "rest/api/latest/search?&maxResults=1")
+  res <- jira_get(url = url, user = user, password = password)
+  res <- res$issues
+  
+  #Check if we got an response
+  if(length(res) != 1) {
+    stop(paste0("Cannot connect to host:", host))
+  }
+  
+  #Return
+  con <- list(user=user, password=password, host=host)
+  con
+  
+}

R/jira_issue.R

@@ -0,0 +1,92 @@
+#' Returns a list of jira issues
+#' 
+#' input can either be a a jira connection or a file with raw data
+#' 
+#' @param con - a jira connection object
+#' @param raw_issue_file - instead of alternative to online query. 
+#'
+#' @return a data frame containing issues
+#' @export
+#'
+#' @examples
+#' 
+#' issue <- jira_issue(con)
+#' issue <- jira_issue(issue_raw_file = "./issue_raw.RData")
+jira_issue <- function(con = NULL, issue_raw_file = NULL){
+  
+  if(is.null(issue_raw_file)){
+    #
+    # online query
+    #
+    #Check input - expecting 3 arguments
+    if(length(con) != 3)
+      stop('Malformed connection')
+    
+    #Build query and execute
+    #url <- file.path(con$host, "rest/api/latest/search?project=TO&maxResults=1000")
+    #url <- file.path(con$host, "rest/api/latest/search?jql=assignee=marcgide&maxResults=1000")
+    #url <- file.path(con$host, "rest/api/2/TO/search?")
+    position <- 0
+    increment <- 100
+    issue <- NULL
+  
+    repeat{ 
+      url <- file.path(con$host, paste0('rest/api/latest/search?jql=project%20%3D%20"TO"%20&startAt=', position, '&maxResults=', increment))
+      #url <- file.path(con$host, paste0('rest/api/latest/search?&startAt=', position, '&maxResults=', increment))
+      url
+      res <- jira_get(url = url, user = con$user, password = con$password, verbose = TRUE)
+      issue_element <- jira_issue_raw_2_issue(res$issues)
+      if(is.null(issue)){ issue <- issue_element } else {issue <- bind_rows(issue, issue_element)}
+      if( position + length(res$issues) > res$total){ break }
+      print(paste0("position: ", position, "/", res$total))
+      position <- position + increment
+    }
+  } else {
+    #
+    # file based input
+    #
+    load(issue_raw_file)
+    if( !(exists("issue_raw")) )
+      stop('Malformed raw file')
+    issue <- jira_issue_raw_2_issue(issue_raw)
+  }
+
+  #return
+  issue
+  
+}    
+
+jira_issue_raw_2_issue <- function(issue_raw){
+  # Transform output
+  # using pattern from https://jennybc.github.io/purrr-tutorial/ls01_map-name-position-shortcuts.html
+  issue <-  issue_raw %>% {
+    tibble(
+      #Identifiers
+      id = map_chr(., "id"),
+      key = map_chr(., "key"),
+      summary = map_chr_hack(., ~ .x[["fields"]][["summary"]]),
+      
+      #Category
+      issuetype_id = map_chr_hack(., ~ .x[["fields"]][["issuetype"]][["id"]]),
+      issuetype_name = map_chr_hack(., ~ .x[["fields"]][["issuetype"]][["name"]]),
+      
+      #Effort - How much
+      timespent = map_chr_hack(., ~ .x[["fields"]][["timespent"]]) %>% as.numeric(),
+      
+      #Who - creators,
+      #resolution = map_chr_hack(., ~ .x[["fields"]][["resolution"]]),
+      creator_key = map_chr_hack(., ~ .x[["fields"]][["creator"]][["key"]]),
+      creator_name = map_chr_hack(., ~ .x[["fields"]][["creator"]][["name"]]),
+      assignee_key = map_chr_hack(., ~ .x[["fields"]][["assignee"]][["key"]]),
+      assignee_name = map_chr_hack(., ~ .x[["fields"]][["assignee"]][["name"]]),
+      
+      #Dates - when
+      created_date = map_chr_hack(., ~ .x[["fields"]][["created"]]) %>% ymd_hms(),
+      resolution_date = map_chr_hack(., ~ .x[["fields"]][["resolutiondate"]]) %>% ymd_hms(),
+      last_viewed_date = map_chr_hack(., ~ .x[["fields"]][["lastViewed"]]) %>% ymd_hms()
+    )
+  }
+  #return
+  issue
+  
+}

R/jira_issue_worklog.R

@@ -0,0 +1,60 @@
+#' iterates through issues and returns issue worklog items
+#'
+#' @param con - a validated jira connection
+#' @param issue - uses issue$key to identify issues to iterate through
+#'
+#' @return a data frame containing issue_worklog items
+#' @export
+#'
+#' @examples
+#' issue_worklog <- jira_issue_worklog(con, issue)
+jira_issue_worklog <- function(con, issue){
+  
+  r <- map(issue$key, ~ jira_issue_worklog_element(con,.x))
+  a <- bind_rows(r)
+  
+  a <- a %>% 
+    mutate(time_spent_hours = as.numeric(time_spent_seconds)/3600) %>%
+    mutate(started_day = floor_date(started), unit="day")
+  #return 
+  a
+}
+
+jira_issue_worklog_element <- function(con, key){
+  
+  #Check input - expecting 3 arguments
+  if(length(con) != 3)
+    stop('Malformed connection')
+  
+  #
+  print(paste0("processing id ", key))
+  
+  #Build query and execute
+  url <- file.path(host, paste0("rest/api/2/issue/", key , "/worklog"))
+  res <- jira_get(url = url, user = con$user, password = con$password, verbose = verbose)
+  
+  # Transform output
+  issue_worklog_raw <- res$worklogs
+  
+  # using pattern from https://jennybc.github.io/purrr-tutorial/ls01_map-name-position-shortcuts.html
+  issue_worklog <-  issue_worklog_raw %>% {
+    tibble(
+      #Identifiers
+      self = map_chr(., "self"),
+      id = map_chr(., "id"),
+      issue_id = map_chr(., "issueId"),
+      comment = map_chr(., "comment"),
+      created = map_chr(., "created") %>% ymd_hms(),
+      updated = map_chr(., "updated") %>% ymd_hms(),
+      started = map_chr(., "started") %>% ymd_hms(),
+      assignee_email = map_chr_hack(., ~ .x[["author"]][["emailAddress"]]),
+      updater_email = map_chr_hack(., ~ .x[["updateAuthor"]][["emailAddress"]]),
+      time_spent = map_chr(., "timeSpent"),
+      time_spent_seconds = map_chr(., "timeSpentSeconds")
+    )
+  }   
+  
+  #return
+  issue_worklog
+  
+}

R/jira_utils.R

@@ -0,0 +1,57 @@
+#---------------------------
+#file container helper functions
+#
+
+#
+# GET data from jira
+#
+#' Runs a rest GET call towards jira 
+#'
+#' @param url 
+#' @param user 
+#' @param password 
+#' @param verbose 
+#'
+#' @return a parsed rest document (in the shape of a list)
+#' @export
+#'
+#' @examples
+#' 
+#' res <- jira_get(url = url, user = user, password = password)
+
+jira_get <- function(url = url, user = user, password = password, verbose = verbose){
+  
+  verbose <- TRUE
+  res <- GET(url = url,
+    authenticate(user = user, password = password, "basic"),
+    add_headers("Content-Type" = "application/json")
+    #verbose(data_out = verbose, data_in = verbose, info = verbose)
+  )
+  res <- content(res, as = "parsed")
+  
+  res$startAt 
+  return(res)
+}
+
+
+#
+#' to avoid issues with map_chr and NULL
+#' @param .x 
+#' @param .f 
+#' @param ... 
+#'
+#' @return a character vector
+#' @export
+#'
+#' @examples
+#' A helper function from https://github.com/jennybc/analyze-github-stuff-with-r#readme
+#' same arguments as map_chr
+#' 
+#'   issue <-  res$issues %>% {
+#'      tibble(issuetype_id = map_chr_hack(., ~ .x[["fields"]][["issuetype"]][["id"]]))} 
+map_chr_hack <- function(.x, .f, ...) {
+  map(.x, .f, ...) %>%
+    map_if(is.null, ~ NA_character_) %>%
+    flatten_chr()
+}
+

R/tidyJira.R

@@ -0,0 +1,9 @@
+#' tidyJira: A package to generate tidy jira exports for issues 
+#' 
+#' The package is used in three steps
+#' 1. Connect to jira
+#' 2. Get issues
+#' 3. Iterate through issues to get extended information
+#' 
+#' @docType package
+#' @name tidyJira