export-pull-requests 0.3.1 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa3cfb134a324a1a09daa690b431a5092b2265c757fadaecd0f87bc0275fcddb
-  data.tar.gz: 3e85340c807d3a9f8a9a07a11d707f171d19d0322e67f741badc84cdca3806ee
+  metadata.gz: 0eeb60967960338e5c26e80b8fc8284b5e94a2c310ff4aa438d902e3a29a8882
+  data.tar.gz: ff4a1a83d12a48de37e192238316e796b00dd71ac5710f749863d4ffdc410324
 SHA512:
-  metadata.gz: f92e17537078e7f6d7a160c44ad1144538fb999c0eb2689d15801f81f498eeeb8305031d378ffce99821aa48dafdae5e4a74fa7c03efc060ad19ec2d38d1aa33
-  data.tar.gz: cbe3d1a3ef7a14fd40192ce1574fba71ad2d3f7076d67a652c4b6c9ab0dd0c2321abae4ef20b9ff79460ca40922fce540e48363c08b5728c75fc8e4a597948df
+  metadata.gz: 63992bbdfc22722a37a57993ab0420cff9e82884215aae4b2e192c2377d9cf55952654b76a74c1dc554880cfa9938a56fa5c1f429b5f0b2e2771501f001fd99f
+  data.tar.gz: bf4f67c8958fb7c9e9f9d7759b2494d48ca35c5d0e004430fb0cc986a7797f10534bddd6bc3a4d91f2d890dd4364e5c5f83f39cadc5e017f36a434f597e7050c

data/Changes

@@ -1,3 +1,29 @@
+v0.3.6  2021-04-28
+--------------------
+Bug fixes:
+* Require Ruby < 3 (#25)
+
+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
 --------------------

data/README.md

@@ -6,7 +6,8 @@ Supports GitHub, GitLab, and Bitbucket.
 
 ## Installation
 
-[Ruby](https://www.ruby-lang.org/en/documentation/installation/) is required.
+[Ruby](https://www.ruby-lang.org/en/documentation/installation/) version < 3 is required
+([why?](https://github.com/sshaw/export-pull-requests/issues/26)).
 
 With Ruby installed run:
 
@@ -66,12 +67,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.1"
+VERSION = "0.3.6"
 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 "..."
@@ -213,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
 
@@ -224,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))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: export-pull-requests
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.6
 platform: ruby
 authors:
 - Skye Shaw
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-28 00:00:00.000000000 Z
+date: 2021-04-28 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
@@ -89,9 +89,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "<"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -99,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Export pull requests and issues to a CSV file.