export-pull-requests 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f3ef7be95a92abf1ffcd0eac471f5a3d5251fbe3
-  data.tar.gz: 99bba99a08631b69bc8174b83bea1e250eeae28e
+SHA256:
+  metadata.gz: d0cefccef824b6fde15c18ea2cde47d45add41b80ffe494bccbfedc71581bc94
+  data.tar.gz: 1f1ea671cc25edf027d5ab89f4cb97f542d50a3d481fa417c7f040a64bf0260f
 SHA512:
-  metadata.gz: 356deeb4db67174cbad7b8b9d3e88a51d004bf6ba10467b26e407478914832da6944060d8a5e0d9a7e67b75622e8c388f22764696418af1d9f5a779001ffcc97
-  data.tar.gz: 6780a66037eb01f5ce5de3fa9b62a0eb9e3228fb2fd41a8ab2864aa268d8063e87c6ffc029d267ca09ab4292f34a3f224d5a75d6eb46870694a5a7dfda107850
+  metadata.gz: 57204a618ac7874b0b7f50c598e538d932b5171ccf44e3a4064143110c78d8c5344aadf1b1269dfc2b6a67f8dc66cd366af667df38a11b1db49e29dbb3b009e6
+  data.tar.gz: fc654c6ec9ec407e16239dc6638cb366412f7298f9eec5fa9e5b2a380ea9217c110616ab93f38649e9517dcb75375cf92f2c4ecf05295f07a60e52f2567893e8

data/Changes

@@ -1,3 +1,19 @@
+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:

data/README.md

@@ -7,7 +7,6 @@ Supports GitHub, GitLab, and Bitbucket.
 ## Installation
 
 [Ruby](https://www.ruby-lang.org/en/documentation/installation/) is required.
-
 With Ruby installed run:
 
     gem install export-pull-requests
@@ -66,10 +65,17 @@ 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
 
+**Due to [various issues with the Bitbucket gem](https://github.com/sshaw/export-pull-requests/issues/26) support for Bitbucket
+requires using a Ruby version < 3 and manually installing the Bitbucket library via `gem install bitbucket_rest_api`.**
+
+**Alternatively, on a Ruby version < 3 you can run: gem install export-pull-requests -v=0.3.7**
+
 You can use [app passwords](https://confluence.atlassian.com/bitbucket/app-passwords-828781300.html) for the API token.
 Just provide your token info in `bitbucket_username:app_password` format:
 

data/bin/epr

@@ -7,9 +7,8 @@ require "logger"
 
 require "github_api"
 require "gitlab"
-require "bitbucket_rest_api"
 
-VERSION = "0.3.3"
+VERSION = "0.4.0"
 SERVICES = %w[github gitlab bitbucket]
 GIT_CONFIGS = %w[epr.token github.oauth-token]
 
@@ -70,13 +69,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),
@@ -162,10 +162,20 @@ def github(user, repo)
         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 "..."
@@ -215,9 +225,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
 
@@ -226,17 +243,31 @@ 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))
     when "bitbucket"
+      begin
+        require "bitbucket_rest_api"
+      rescue LoadError => e
+        # Could be an error due to gem version conflict
+        abort e.message unless e.instance_of?(LoadError)
+        abort(<<MESSAGE)
+As of v0.4 the Bitbucket API is no longer included by default. To use Bitbucket you must use
+a Ruby version < 3 and install the dependency yourself via: gem install bitbucket_rest_api.
+
+Alternatively, on a Ruby version < 3 you can run: gem install export-pull-requests -v=0.3.7
+MESSAGE
+      end
+
       rows.concat(bitbucket(user, repo))
     else
       abort "unknown service provider: #$provider"
@@ -311,7 +342,13 @@ parser = OptionParser.new do |opts|
   end
 
   opts.on "-v", "--version", "epr version" do
-    puts "v#{VERSION} (GitHub v#{Github::VERSION}, GitLab v#{Gitlab::VERSION}, Bitbucket v#{BitBucket::VERSION::STRING})"
+    begin
+      require "bitbucket_rest_api"
+    rescue LoadError
+    end
+
+    bb_version = defined?(BitBucket) ? "v#{BitBucket::VERSION::STRING}" : "[Not installed]"
+    printf "v#{VERSION} (GitHub v#{Github::VERSION}, GitLab v#{Gitlab::VERSION}, Bitbucket %s)\n", bb_version
     exit
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: export-pull-requests
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Skye Shaw
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-01 00:00:00.000000000 Z
+date: 2022-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github_api
@@ -39,33 +39,39 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: bitbucket_rest_api
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   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
@@ -98,9 +104,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Export pull requests and issues to a CSV file.
 test_files: []