export-pull-requests 0.3.0 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 016a62a2e3de917954ac3d80513c491938d48b50
-  data.tar.gz: 9ae66c248e9221b8cc00abdcdf34caf66ba72e0c
+  metadata.gz: 9aa3a32a54b67ebcc317255f9575cd1cb92eabef
+  data.tar.gz: e614ed2ff03d1d3571513fe0923bf0162bc45c38
 SHA512:
-  metadata.gz: 0fff380fb343736b01c1af4ff0e77fb788d6eaa76f3f59ddc9be2da0074ebfe66d296aca68d8c178f0e24bcf2143c04d3cb99e97d7cd68c0517fe49b498bd050
-  data.tar.gz: fcdb405a3e51b4210019c9a9c343d173f5d72823968ecdc9a860ff6e32b882f868300e9aaef8a677592904c0ecbd7ff2da5b05a136ab6079d54f7e0c766af950
+  metadata.gz: d584c1f5406cba8733a910513a8079f37d2544cc07656f0484a856d4d38b0121892e9ef49cd809bca61a614ec75f27d2491f1af4a02dad7ac65685224013061a
+  data.tar.gz: 53b26f30445b60c26955e2212396cd069ab262374a50876938f40b7c131d91472bd3aebf43093738428d8181e298a3020b167aac23df7b5018e8dc1768507ce1

data/Changes

@@ -1,3 +1,30 @@
+v0.3.5  2021-03-16
+--------------------
+Enhancements:
+* Add Merged column containing PR merge time
+* Exit with failure if attempting to export GitHub milestones for PRs
+
+v0.3.4  2021-02-12
+--------------------
+Bug Fixes:
+* Bitbucket username not exported for PRs under 2.0 API (#20)
+
+v0.3.3  2019-05-01
+--------------------
+Bug Fixes:
+* GitHub PR only exports were output as an "issue" instead of "PR"
+
+v0.3.2  2019-02-09
+--------------------
+Bug Fixes:
+* Don't supply assignee or milestone for GitHub if nil
+
+--------------------
+v0.3.1  2019-01-28
+--------------------
+Enhancements:
+* Add support for filtering on milestones and labels to GitLab
+
 --------------------
 v0.3.0  2019-01-10
 --------------------

data/README.md

@@ -20,9 +20,9 @@ This installs the `epr` executable.
         -b, --body                       Include the issue/pr body description in the output (GitHub only)
         -c, --creator=USER1,USER2,...    Export PRs created by given username(s); prepend `!' to exclude user
         -e, --endpoint=URL               Endpoint URL for 'enterprise', etc... repositories
-        -m, --milestone=WHAT             Export items assigned to the given milestone (GitHub only)
-        -a, --assignee=USER              Export items assigned to the given user (GitHub only)
-        -l, --labels=LABEL(S)            Export items with the given label(s) (GitHub only)
+        -m, --milestone=WHAT             Export items assigned to the given milestone (GitHub/GitLab only)
+        -a, --assignee=USER              Export items assigned to the given user (GitHub/GitLab only)
+        -l, --labels=LABEL(S)            Export items with the given label(s) (GitHub/GitLab only)
         -h, --help                       Show this message
         -p, --provider=NAME              Service provider: bitbucket, github, or gitlab; defaults to github
         -s, --state=STATE                Export items in the given state, defaults to open
@@ -66,12 +66,16 @@ Export all issues from a GitLab project:
 
 ## Service Notes
 
-To connect to a custom/"Enterprise" installation of any of the supported services use the endpoint option (`-e`)
+To connect to a custom/"Enterprise" installation of any of the supported services use the endpoint option (`-e`).
+
+The provided URL must point the API endpoint, not the user-facing site. For GitHub this is `http(s)://YOUR-SITE/api/v3`.
 
 ### Bitbucket
 
 You can use [app passwords](https://confluence.atlassian.com/bitbucket/app-passwords-828781300.html) for the API token.
-Just provide your token HTTP Auth style using: `username:app_password`.
+Just provide your token info in `bitbucket_username:app_password` format:
+
+    epr -p bitbucket -t bitbucket_username:app_password user/repo1
 
 ### GitLab
 

data/bin/epr

@@ -9,7 +9,7 @@ require "github_api"
 require "gitlab"
 require "bitbucket_rest_api"
 
-VERSION = "0.3.0"
+VERSION = "0.3.5"
 SERVICES = %w[github gitlab bitbucket]
 GIT_CONFIGS = %w[epr.token github.oauth-token]
 
@@ -70,13 +70,14 @@ def bitbucket(user, repo)
 
       prs = $bitbucket.repos.pull_request.all(user, repo, :page => page, :state => $filter.upcase)
       prs["values"].each do |pr|
-        next if pr.author && skip_user?(pr.author.username)
+        next if pr.author && (skip_user?(pr.author.display_name) || skip_user?(pr.author.nickname))
 
         rows << [
           repo_name,
           TYPE_PR,
           pr.id,
-          pr.author ? pr.author.username : no_user,
+          # With the 2.0 API is this check necessary?
+          pr.author ? pr.author.display_name : no_user,
           pr.title,
           pr.state,
           localtime(pr.created_on),
@@ -138,12 +139,12 @@ def github(user, repo)
   options[:endpoint] = $endpoint if $endpoint
 
   $gh ||= Github.new(options)
-  $gh.public_send(method).list(:user => user,
-                               :repo => repo,
-                               :state => $filter,
-                               :milestone => $milestone,
-                               :assignee => $assignee,
-                               :labels => $labels).each_page do |page|
+
+  options = { :user => user, :repo => repo, :state => $filter, :labels => $labels }
+  options[:milestone] = $milestone if $milestone
+  options[:assignee] = $assignee if $assignee
+
+  $gh.public_send(method).list(options).each_page do |page|
 
     next if page.size.zero?     # Needed for auto_pagination
 
@@ -154,16 +155,28 @@ def github(user, repo)
 
       rows << [
         "#{user}/#{repo}",
-        item.pull_request ? TYPE_PR : TYPE_ISSUE,
+        # If we're only retrieving PRs then item.pull_request will be nil
+        # It's only populated when retrieving both (issues method).
+        item.pull_request || method == :pull_requests ? TYPE_PR : TYPE_ISSUE,
         item.number,
         item.user.login,
         item.title,
         item.state,
         localtime(item.created_at),
-        localtime(item.updated_at),
-        item.html_url,
+        localtime(item.updated_at)
       ]
 
+      # GitHub issues API returns PRs but not their merged_at time. To get that we need to specifically export PRs
+      if item.pull_request && $export != EXPORT_ISSUES
+        rows[-1] << "(use `-x pr` option)"
+      elsif $export != EXPORT_PRS
+        rows[-1] << "N/A"
+      else
+        rows[-1] << (item.merged_at ? localtime(item.merged_at) : nil)
+      end
+
+      rows[-1] << item.html_url
+
       if $body
         body = item.body
         # -3 for "..."
@@ -190,10 +203,18 @@ def gitlab(user, repo)
 
   # Do we care about this differing in output?
   state = $filter == "open" ? "opened" : $filter
+  options = {
+    :milestone => $milestone,
+    :labels => $labels,
+    :state => state
+  }
+
+  # If assignee_id is nil an error is raised
+  options[:assignee_id] = $assignee if $assignee
 
   $gitlab ||= Gitlab.client(:auth_token => $token, :endpoint => $endpoint || "https://gitlab.com/api/v4")
   methods.each do |method|
-    $gitlab.public_send(method, "#{user}/#{repo}", :state => state).auto_paginate do |item|
+    $gitlab.public_send(method, "#{user}/#{repo}", options).auto_paginate do |item|
       next if skip_user?(item.author.username)
 
       rows << [
@@ -205,9 +226,16 @@ def gitlab(user, repo)
         item.title,
         item.state,
         localtime(item.created_at),
-        localtime(item.updated_at),
-        item.web_url
+        localtime(item.updated_at)
       ]
+
+      if method == :issues
+        rows[-1] << "N/A"
+      else
+        rows[-1] << (item.merged_at ? localtime(item.merged_at) : nil)
+      end
+
+      rows[-1] << item.web_url
     end
   end
 
@@ -216,13 +244,14 @@ end
 
 def export_repos(argv)
   rows = []
-  rows << %w[Repository Type # User Title State Created Updated URL]
+  rows << %w[Repository Type # User Title State Created Updated Merged URL]
   rows[-1].insert(4, "Body") if $body
 
   repos = parse_repos(argv)
   repos.each do |user, repo|
     case $provider
     when "github"
+      abort "milestone filtering can only be used with issues" if $milestone && $export == EXPORT_PRS
       rows.concat(github(user, repo))
     when "gitlab"
       rows.concat(gitlab(user, repo))
@@ -267,15 +296,15 @@ parser = OptionParser.new do |opts|
     $endpoint = url
   end
 
-  opts.on "-m", "--milestone=WHAT", "Export items assigned to the given milestone (GitHub only)" do |m|
+  opts.on "-m", "--milestone=WHAT", "Export items assigned to the given milestone (GitHub/GitLab only)" do |m|
     $milestone = m
   end
 
-  opts.on "-a", "--assignee=USER", "Export items assigned to the given user (GitHub only)" do |a|
+  opts.on "-a", "--assignee=USER", "Export items assigned to the given user (GitHub/GitLab only)" do |a|
     $assignee = a
   end
 
-  opts.on "-l", "--labels=LABEL(S)", "Export items with the given label(s) (GitHub only)" do |l|
+  opts.on "-l", "--labels=LABEL(S)", "Export items with the given label(s) (GitHub/GitLab only)" do |l|
     $labels = l
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: export-pull-requests
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.5
 platform: ruby
 authors:
 - Skye Shaw
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-10 00:00:00.000000000 Z
+date: 2021-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github_api
@@ -56,16 +56,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 12.3.3
 description: Program to export GitHub, GitLab, or Bitbucket pull requests/merge requests
   and issues to CSV a file.
 email: skye.shaw@gmail.com