export-pull-requests 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a531cf40cb67b6e178bc75a254ee821758369d6
-  data.tar.gz: da773616d8a630e16bc43b68bf19a6dcddfca440
+  metadata.gz: 4d378c2d847231e7d5b29e98aeec72a952100258
+  data.tar.gz: f0a364c762a48ec22d0dc35ed1f94fb501bf76ca
 SHA512:
-  metadata.gz: 859d3b348f3e95edefa52cf74de68a5a3ce253863ddd9c8695b663fa5b3488193d9672740822f51b6becf14558a9ac4d623d36f56df79fc2ddd23d365f2a3aea
-  data.tar.gz: 883f927bd24a27b417b085550fc4697e06ce4f631c3212ce54e53e8ce74f901df02c7b33ae9d7df99f9aa20b80cdc81288deadea57c1e0eb860f8a7f7af6ca20
+  metadata.gz: 007731af9e311ef0f38155aa1c0a13c3dafb61211939239f3f2a5ac7483d953d1e1daac26ac1c511c51d6297595b151368c7a093918b84fab7bd84a7f879e1e6
+  data.tar.gz: 663950b5114a6634b51d063885fc9e862766694f4f9817b7da5f900affa39ff868629de0aab642fd4ba005febbf4bae1aceb3eba75c0923838d45ff67fc6a335

data/Changes

@@ -0,0 +1,23 @@
+--------------------
+v0.2.0  2017-09-21
+--------------------
+Enhancements:
+* Add support for issues
+
+Changes:
+* Always show Repository column (was excluded if only 1 repo was given)
+
+--------------------
+v0.1.1   2017-07-23
+--------------------
+Enhancements:
+* Add support for Bitbucket
+
+--------------------
+v0.1.0   2017-07-23
+--------------------
+Enhancements:
+* Add support for GitLab
+
+Changes:
+* Do not require a token

data/README.md

@@ -0,0 +1,83 @@
+# Export Pull Requests
+
+Export pull requests/merge requests and/or issues to a CSV file.
+
+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
+
+This installs the `epr` executable.
+
+## Usage
+
+    usage: epr [-hv] [-s state] [-t token] [-c user1,user2...] user/repo1 [user/repo2...]
+        -c, --creator=USER1,USER2,...    Export PRs created by given username(s); prepend `!' to exclude user
+        -h, --help                       Show this message
+        -p, --provider=NAME              Service provider: bitbucket, github, or gitlab; defaults to github
+        -t, --token=TOKEN                API token
+        -s, --state=STATE                Export PRs in the given state, defaults to open
+        -v, --version                    epr version
+        -x, --export=TYPE                What to export: pr, issues, or all; defaults to all
+
+### Config
+
+These can all be set by one of the below methods or [via the command line](#usage).
+
+#### Token
+
+The API token can be set by:
+
+* `EPR_TOKEN` environment variable
+* `epr.token` setting in `.gitconfig`
+* `github.oauth-token` setting in `.gitconfig`
+
+#### Default Service
+
+github is the default. You can set a new default via `EPR_SERVICE`.
+
+### Examples
+
+Export open PRs and issues in `sshaw/git-link` and `sshaw/itunes_store_transporter`:
+
+    epr sshaw/git-link sshaw/itunes_store_transporter > pr.csv
+
+Export open pull request not created by `sshaw` in `padrino/padrino-framework`:
+
+    epr -x pr -c '!sshaw' padrino/padrino-framework > pr.csv
+
+Export open merge requests from a GitLab project:
+
+    epr -x pr -p gitlab gitlab-org/gitlab-ce > pr.csv
+
+Export all issues from a GitLab project:
+
+    epr -x issues -p gitlab gitlab-org/gitlab-ce > pr.csv
+
+## Service Notes
+
+### 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`.
+
+### GitLab
+
+Authentication can be done via a [personal access token](https://gitlab.com/profile/personal_access_tokens).
+
+Currently the API endpoint URL is hardcoded to `https://gitlab.com/api/v4`.
+
+Enterprise editions of GitLab have an [issue export feature](https://docs.gitlab.com/ee/user/project/issues/csv_export.html).
+
+## Author
+
+Skye Shaw [skye.shaw AT gmail]
+
+## License
+
+Released under the MIT License: www.opensource.org/licenses/MIT

data/bin/epr

@@ -9,8 +9,15 @@ require "github_api"
 require "gitlab"
 require "bitbucket_rest_api"
 
-VERSION = "0.1.1"
+VERSION = "0.2.0"
 SERVICES = %w[github gitlab bitbucket]
+GIT_CONFIGS = %w[epr.token github.oauth-token]
+
+TYPE_ISSUE = "Issue"
+TYPE_PR = "PR"
+
+EXPORT_ISSUES = "issues"
+EXPORT_PRS = "pr"
 
 def localtime(t)
   Time.parse(t).localtime.strftime("%x %X")
@@ -31,7 +38,7 @@ def lookup_token
   return ENV["EPR_TOKEN"] unless ENV["EPR_TOKEN"].to_s.strip.empty?
 
   begin
-    %w[epr.token github.oauth-token].each do |setting|
+    GIT_CONFIGS.each do |setting|
       token = `git config #{setting}`.chomp
       return token unless token.empty?
     end
@@ -41,33 +48,78 @@ def lookup_token
 end
 
 def bitbucket(user, repo)
-  page = 0
-  rows = []
-
-  $bitbucket ||= BitBucket.new(:basic_auth => $token)
   # TODO: make sure no need to translate any states
   # https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/pullrequests
 
-  loop do
-    page += 1
+  $bitbucket ||= BitBucket.new(:basic_auth => $token)
 
-    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)
+  rows = []
+  no_user = "Anonymous"
+  repo_name = "#{user}/#{repo}"
+
+  pull_requests = lambda do
+    page = 0
+
+    loop do
+      page += 1
+
+      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)
+
+        rows << [
+          repo_name,
+          TYPE_PR,
+          pr.id,
+          pr.author ? pr.author.username : no_user,
+          pr.title,
+          pr.state,
+          localtime(pr.created_on),
+          localtime(pr.updated_on),
+          pr["links"].html.href
+        ]
+      end
+
+      break unless prs["next"]
+    end
+  end
 
-      rows << [
-        "#{user}/#{repo}",
-        pr.id,
-        pr.author ? pr.author.username : "-",
-        pr.title,
-        pr.state,
-        localtime(pr.created_on),
-        localtime(pr.updated_on),
-        pr["links"].html.href
-      ]
+  issues = lambda do
+    start = 0
+
+    loop do
+      issues = $bitbucket.issues.list_repo(user, repo, :start => start, :status => $filter)
+      break unless issues.any?
+
+      issues.each do |issue|
+        next if issue["reported_by"] && skip_user?(issue["reported_by"]["username"])
+
+        rows << [
+          repo_name,
+          TYPE_ISSUE,
+          issue["local_id"],
+          issue["reported_by"] ? issue["reported_by"]["username"] : no_user,
+          issue["title"],
+          issue["status"],
+          localtime(issue["utc_created_on"]),
+          localtime(issue["utc_last_updated"]),
+          # Not in response
+          sprintf("https://bitbucket.org/%s/issues/%s", repo_name, issue["local_id"])
+        ]
+      end
+
+      start += issues.size
     end
+  end
 
-    break unless prs["next"]
+  case $export
+  when EXPORT_PRS
+    pull_requests[]
+  when EXPORT_ISSUES
+    issues[]
+  else
+    pull_requests[]
+    issues[]
   end
 
   rows
@@ -75,23 +127,27 @@ end
 
 def github(user, repo)
   rows = []
+  method = $export == EXPORT_PRS ? :pull_requests : :issues
 
   $gh ||= Github.new(:oauth_token => $token, :auto_pagination => true)
-  $gh.pull_requests.list(:user => user, :repo => repo, :state => $filter).each_page do |page|
+  $gh.public_send(method).list(:user => user, :repo => repo, :state => $filter).each_page do |page|
     next if page.size.zero?     # Needed for auto_pagination
 
-    page.each do |pr|
-      next if skip_user?(pr.user.login)
+    page.each do |item|
+      # issues method will return issues and PRs
+      next if $export == EXPORT_ISSUES && item.pull_request
+      next if skip_user?(item.user.login)
 
       rows << [
         "#{user}/#{repo}",
-        pr.number,
-        pr.user.login,
-        pr.title,
-        pr.state,
-        localtime(pr.created_at),
-        localtime(pr.updated_at),
-        pr.html_url,
+        item.pull_request ? TYPE_PR : TYPE_ISSUE,
+        item.number,
+        item.user.login,
+        item.title,
+        item.state,
+        localtime(item.created_at),
+        localtime(item.updated_at),
+        item.html_url,
       ]
     end
   end
@@ -102,34 +158,47 @@ end
 def gitlab(user, repo)
   rows = []
 
+  case $export
+  when EXPORT_PRS
+    methods = [:merge_requests]
+  when EXPORT_ISSUES
+    methods = [:issues]
+  else
+    methods = [:merge_requests, :issues]
+  end
+
   # Do we care about this differing in output?
   state = $filter == "open" ? "opened" : $filter
 
   # TODO: custom endpoint
-  $gitlab ||= Gitlab.client(:token => $token, :endpoint => "https://gitlab.com/api/v4")
-  $gitlab.merge_requests("#{user}/#{repo}", :state => state).auto_paginate do |mr|
-    next if skip_user?(mr.author.username)
-
-    rows << [
-      "#{user}/#{repo}",
-      # Yes, it's called iid
-      mr.iid,
-      mr.author.username,
-      mr.title,
-      mr.state,
-      localtime(mr.created_at),
-      localtime(mr.updated_at),
-      mr.web_url
-    ]
+  $gitlab ||= Gitlab.client(:auth_token => $token, :endpoint => "https://gitlab.com/api/v4")
+  methods.each do |method|
+    $gitlab.public_send(method, "#{user}/#{repo}", :state => state).auto_paginate do |item|
+      next if skip_user?(item.author.username)
+
+      rows << [
+        "#{user}/#{repo}",
+        method == :issues ? TYPE_ISSUE : TYPE_PR,
+        # Yes, it's called iid
+        item.iid,
+        item.author.username,
+        item.title,
+        item.state,
+        localtime(item.created_at),
+        localtime(item.updated_at),
+        item.web_url
+      ]
+    end
   end
 
   rows
 end
 
-def export_repos(repos)
+def export_repos(argv)
   rows = []
-  rows << %w[Repository # User Title State Created Updated URL]
+  rows << %w[Repository Type # User Title State Created Updated URL]
 
+  repos = parse_repos(argv)
   repos.each do |user, repo|
     case $provider
     when "github"
@@ -142,11 +211,7 @@ def export_repos(repos)
       abort "unknown service provider: #$provider"
     end
 
-    rows.each do |r|
-      # Drop Repository column if we only have one repo
-      r.shift unless repos.size > 1
-      puts r.to_csv
-    end
+    rows.each { |r| puts r.to_csv }
     rows.clear
   end
 end
@@ -157,6 +222,7 @@ Hashie.logger = Logger.new(File::NULL) if defined?(Hashie)
 
 $exclude_users = []
 $include_users = []
+$export = "all"
 $filter = "open"
 $provider = ENV["EPR_SERVICE"] || SERVICES[0]
 $token = lookup_token
@@ -164,7 +230,7 @@ $token = lookup_token
 parser = OptionParser.new do |opts|
   opts.banner = "usage: #{File.basename($0)} [-hv] [-s state] [-t token] [-c user1,user2...] user/repo1 [user/repo2...]"
 
-  opts.on "-c", "--creator=user1,user2,...", Array, "Export PRs created by given username(s); prepend `!' to exclude user" do |u|
+  opts.on "-c", "--creator=USER1,USER2,...", Array, "Export PRs created by given username(s); prepend `!' to exclude user" do |u|
     $exclude_users, $include_users = u.partition { |name| name.start_with?("!") }
     $exclude_users.map! { |name| name[1..-1] } # remove "!"
   end
@@ -178,14 +244,18 @@ parser = OptionParser.new do |opts|
     $token = t
   end
 
-  opts.on "-p, --provider=NAME", SERVICES, "Service provider, one of: #{SERVICES}" do |name|
+  opts.on "-p, --provider=NAME", SERVICES, "Service provider: bitbucket, github, or gitlab; defaults to github" do |name|
     $provider = name
   end
 
-  opts.on "-s", "--state=STATE", %w[open closed all merged], "Export PRs in the given state, defaults to open" do |f|
+  opts.on "-s", "--state=STATE", "Export items in the given state, defaults to open" do |f|
     $filter = f
   end
 
+  opts.on "-x", "--export=WHAT", %w[pr issues all], "What to export: pr, issues, or all; defaults to all" do |x|
+    $export = x
+  end
+
   opts.on "-v", "--version", "epr version" do
     puts "v#{VERSION} (GitHub v#{Github::VERSION}, GitLab v#{Gitlab::VERSION}, Bitbucket v#{BitBucket::VERSION::STRING})"
     exit
@@ -196,7 +266,7 @@ parser.parse!
 abort parser.banner if ARGV.empty?
 
 begin
-  export_repos(parse_repos(ARGV))
+  export_repos(ARGV)
 rescue => e
   abort "Export failed: #{e}"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: export-pull-requests
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Skye Shaw
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-23 00:00:00.000000000 Z
+date: 2017-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github_api
@@ -67,19 +67,23 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 description: Program to export GitHub, GitLab, or Bitbucket pull requests/merge requests
-  to CSV a file.
+  and issues to CSV a file.
 email: skye.shaw@gmail.com
 executables:
 - epr
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- Changes
 files:
+- Changes
+- README.md
 - bin/epr
 homepage: https://github.com/sshaw/export-pull-requests
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: Use the `epr' command to export your pull requests.
 rdoc_options: []
 require_paths:
 - lib
@@ -98,5 +102,5 @@ rubyforge_project:
 rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: Export pull requests to a CSV file.
+summary: Export pull requests and issues to a CSV file.
 test_files: []