export-pull-requests 0.2.2 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1415cd62e08619538dbdec7223e66a1f60fab235
-  data.tar.gz: a58ad25901d787bbb288f9c1727993f2dc2fd68c
+  metadata.gz: 88245d15b5031425be423a98f42b42451a5e7810
+  data.tar.gz: 1d60dce9efefbb4d282110b537756ac31a8d6a06
 SHA512:
-  metadata.gz: 338d6bd1513bf8f18d654662a783e50d15aba5d5b5e2164dd745c8af033139e83533e5ef6966b2b44442a793697c054d54f8b6cd425d04c8b4d51330e0ac43bd
-  data.tar.gz: 2d562890c7fe9795cab0d11f1712e39cd47ace2c2e977493513622e5c4f3ea2b05b14f2e032c8f44ad671e5256ec870a75e6472cc473a3fea7eb0c64065577dc
+  metadata.gz: 49af965c7fb6817c8bf8dcdbfbf07608e4b384abf35b2af56692b1f04dcdac63378e8f01bcb015b3d3af78395b431c1a5a5c4090b0199045a15516b5b15c9e49
+  data.tar.gz: c3f868be0eaeb4a760ae8e71f5a49d3a855dba2662149b361b8ef5e6fcdbfe9316f1b458bcce5bead831a629966edb3a8007724fff77d40823ddeb7f63fb5404

data/Changes

@@ -1,3 +1,31 @@
+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
+--------------------
+Enhancements:
+* Add support for filtering on milestones and labels (GitHub only)
+* Add support for filtering on assignees (GitHub only, thanks Caroline Boyden)
+
 --------------------
 v0.2.2  2018-11-30
 --------------------

data/README.md

@@ -16,10 +16,13 @@ This installs the `epr` executable.
 
 ## Usage
 
-    usage: epr [-bhv] [-e url] [-s state] [-t token] [-c user1,user2...] user/repo1 [user/repo2...]
+    usage: epr [options] user/repo1 [user/repo2...]
         -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/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
@@ -63,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
 
@@ -76,6 +83,10 @@ Authentication can be done via a [personal access token](https://gitlab.com/prof
 
 Enterprise editions of GitLab have an [issue export feature](https://docs.gitlab.com/ee/user/project/issues/csv_export.html).
 
+## See Also
+
+- [Batch Labels](https://github.com/sshaw/batchlabels) - Add/remove labels in batches to/from GitHub issues and pull requests.
+
 ## Author
 
 Skye Shaw [skye.shaw AT gmail]

data/bin/epr

@@ -9,7 +9,7 @@ require "github_api"
 require "gitlab"
 require "bitbucket_rest_api"
 
-VERSION = "0.2.2"
+VERSION = "0.3.4"
 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,7 +139,13 @@ def github(user, repo)
   options[:endpoint] = $endpoint if $endpoint
 
   $gh ||= Github.new(options)
-  $gh.public_send(method).list(:user => user, :repo => repo, :state => $filter).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
 
     page.each do |item|
@@ -148,7 +155,9 @@ 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,
@@ -184,10 +193,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 << [
@@ -239,13 +256,14 @@ $exclude_users = []
 $include_users = []
 $export = "all"
 $endpoint = nil
+$milestone = $labels = $assignee = nil
 $filter = "open"
 $provider = ENV["EPR_SERVICE"] || SERVICES[0]
 $token = lookup_token
 $body = false
 
 parser = OptionParser.new do |opts|
-  opts.banner = "usage: #{File.basename($0)} [-bhv] [-e url] [-s state] [-t token] [-c user1,user2...] user/repo1 [user/repo2...]"
+  opts.banner = "usage: #{File.basename($0)} [options] user/repo1 [user/repo2...]"
 
   opts.on "-b", "--body", "Include the issue/pr body description in the output (GitHub only)" do
     $body = true
@@ -260,6 +278,18 @@ parser = OptionParser.new do |opts|
     $endpoint = url
   end
 
+  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/GitLab only)" do |a|
+    $assignee = a
+  end
+
+  opts.on "-l", "--labels=LABEL(S)", "Export items with the given label(s) (GitHub/GitLab only)" do |l|
+    $labels = l
+  end
+
   opts.on "-h", "--help", "Show this message" do
     puts opts
     exit

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: export-pull-requests
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.4
 platform: ruby
 authors:
 - Skye Shaw
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-30 00:00:00.000000000 Z
+date: 2021-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github_api