zz-export-pull-requests 0.3.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4fac5c505982f4e25b9dd2ac9cbeac689c0ba84cc1e0f90e3980f8dc8641a922
+  data.tar.gz: 53cde9d89cf8026a46ddd8c8de6c72d583cc00a445aef2f02a5e0f0ee6ae3e7e
+SHA512:
+  metadata.gz: f8b2fd94abe182a4151c077cc8717f9feaca7f848c82bc8ce306d7d9557ee5ea0af2b6d07f7bb9c8fe1d6df200c73ae7c4581e48758a67ab235a6e73e2ff79b7
+  data.tar.gz: cbb6dd165e062e1367a2d53a801c9ada34ba6811bd289c9d14f1003aca25e6804bc27bbba9f82ca43195cdb221d427961b4ab86d67e4f1e021519ab47eb02dfd

data/Changes

@@ -0,0 +1,58 @@
+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
+--------------------
+Enhancements:
+* Add support for exporting issue body (GitHub only)
+
+--------------------
+v0.2.1  2018-06-05
+--------------------
+Enhancements:
+* Add support for custom endpoints
+
+--------------------
+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,98 @@
+# 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 zz-export-pull-requests
+
+This installs the `epr` executable.
+
+## Usage
+
+    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
+        -t, --token=TOKEN                API token
+        -x, --export=WHAT                What to export: pr, pr_comments (BitBucket only), issues, or all; defaults to all
+        -v, --version                    epr version
+
+### 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` (add via `git config --add epr.token <your API token>`)
+- `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
+
+To connect to a custom/"Enterprise" installation of any of the supported services use the endpoint option (`-e`)
+
+### Bitbucket
+
+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:
+
+    epr -p bitbucket -t bitbucket_username:app_password user/repo1
+
+### GitLab
+
+Authentication can be done via a [personal access token](https://gitlab.com/profile/personal_access_tokens).
+
+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]
+
+## License
+
+Released under the MIT License: www.opensource.org/licenses/MIT
+
+---
+
+Made by [ScreenStaring](http://screenstaring.com)

data/bin/epr

@@ -0,0 +1,385 @@
+#!/usr/bin/env ruby
+
+require "csv"
+require "optparse"
+require "time"
+require "logger"
+
+require "github_api"
+require "gitlab"
+require "bitbucket_rest_api"
+
+VERSION = "0.3.5"
+SERVICES = %w[github gitlab bitbucket]
+GIT_CONFIGS = %w[epr.token github.oauth-token]
+
+TYPE_ISSUE = "Issue"
+TYPE_PR = "PR"
+TYPE_PR_COMMENT = "PR Comment"
+
+EXPORT_ISSUES = "issues"
+EXPORT_PRS = "pr"
+EXPORT_PR_COMMENTS = "pr_comments"
+
+DEFAULT_BODY_LENGTH = 2 ** 32 - 1
+
+def localtime(t)
+  # MM/DD/YY HH:MM:SS
+  # Time.parse(t).localtime.strftime("%x %X")
+
+  # Epoch
+  Time.parse(t).localtime.to_i
+end
+
+def parse_repos(repos)
+  repos.map do |r|
+    abort "invalid repository #{r}" unless r =~ %r{\A(\S+)/(\S+)\z}
+    [ $1, $2 ]
+  end
+end
+
+def skip_user?(user)
+  $exclude_users.include?(user) || $include_users.any? && !$include_users.include?(user)
+end
+
+def lookup_token
+  return ENV["EPR_TOKEN"] unless ENV["EPR_TOKEN"].to_s.strip.empty?
+
+  begin
+    GIT_CONFIGS.each do |setting|
+      token = `git config #{setting}`.chomp
+      return token unless token.empty?
+    end
+  rescue Errno::ENOENT
+    # git not found, ignore
+  end
+end
+
+def bitbucket(user, repo)
+  # 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
+
+  options = { :basic_auth => $token }
+  options[:endpoint] = $endpoint if $endpoint
+
+  $bitbucket ||= BitBucket.new(options)
+
+  rows = []
+  no_user = "Anonymous"
+  repo_name = "#{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.display_name)
+
+        rows << [
+          repo_name,
+          TYPE_PR,
+          pr.id,
+          pr.author ? pr.author.display_name : no_user,
+          pr.title,
+          pr.state,
+          localtime(pr.created_on),
+          localtime(pr.updated_on),
+          pr["links"].html.href,
+          pr.summary.raw,
+          pr.summary.html,
+          !pr.source.commit.nil? ? pr.source.commit["hash"] : "",
+          !pr.destination.commit.nil? ? pr.destination.commit["hash"] : "",
+          !pr.source.branch.nil? ? pr.source.branch.name : "",
+          !pr.destination.branch.nil? ? pr.destination.branch.name : "",
+          !pr.reason.nil? ? pr.reason : "",
+          !pr.merge_commit.nil? ? pr.merge_commit["hash"] : ""
+        ]
+      end
+
+      break unless prs["next"]
+    end
+  end
+
+  pull_request_comments = lambda do
+    pr_page = 0
+    
+    loop do
+      pr_page += 1
+      prs = $bitbucket.repos.pull_request.all(user, repo, :page => pr_page, :state => $filter.upcase)
+      
+      prs["values"].each do |pr|
+        comment_page = 0
+        loop do
+          comment_page += 1
+          comments = $bitbucket.repos.pull_request.comments(user, repo, pr.id, :page => comment_page)
+          comments["values"].each do |comment|
+            rows << [
+              repo_name,
+              TYPE_PR_COMMENT,
+              comment.pullrequest.id,
+              comment.user.display_name,
+              comment.inline? ? "inline" : "normal",
+              comment.content.raw,
+              comment.content.html,
+              localtime(comment.updated_on),
+              comment.deleted,
+              comment.inline? ? comment.inline.to : "",
+              comment.inline? ? comment.inline.from : "",
+              comment.inline? ? comment.inline.path : "",
+              comment["links"].code? ? comment["links"].code.href : ""
+            ]
+          end
+          break unless comments["next"]
+        end
+      end
+
+      break unless prs["next"]
+    end
+  end
+
+  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
+
+  case $export
+  when EXPORT_PRS
+    pull_requests[]
+  when EXPORT_PR_COMMENTS
+    pull_request_comments[]
+  when EXPORT_ISSUES
+    issues[]
+  else
+    pull_requests[]
+    issues[]
+  end
+
+  rows
+end
+
+def github(user, repo)
+  rows = []
+  method = $export == EXPORT_PRS ? :pull_requests : :issues
+
+  options = { :oauth_token => $token, :auto_pagination => true }
+  options[:endpoint] = $endpoint if $endpoint
+
+  $gh ||= Github.new(options)
+
+  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|
+      # 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}",
+        # 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,
+      ]
+
+      if $body
+        body = item.body
+        # -3 for "..."
+        body = body.slice(0, DEFAULT_BODY_LENGTH - 3) << "..." if body.size > DEFAULT_BODY_LENGTH unless body == nil
+        rows[-1].insert(4, body)
+      end
+    end
+  end
+
+  rows
+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
+  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}", options).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(argv)
+  rows = []
+
+  if $export == EXPORT_PR_COMMENTS 
+    rows << %w[Repository Type PRNumber User CommentType BodyRaw BodyHTML CreatedAt IsDeleted ToLine FromLine FilePath Diff]
+  else
+    rows << %w[Repository Type # User Title State CreatedAt UpdatedAt URL BodyRaw BodyHTML SourceCommit DestinationCommit SourceBranch DestinationBranch DeclineReason MergeCommit]
+  end
+
+  rows[-1].insert(4, "Body") if $body
+  repos = parse_repos(argv)
+
+  repos.each do |user, repo|
+    case $provider
+    when "github"
+      rows.concat(github(user, repo))
+    when "gitlab"
+      rows.concat(gitlab(user, repo))
+    when "bitbucket"
+      rows.concat(bitbucket(user, repo))
+    else
+      abort "unknown service provider: #$provider"
+    end
+
+    rows.each { |r| puts r.to_csv }
+    rows.clear
+  end
+end
+
+# Hashie is used by Bitbucket, and it spews warnings to stdout. We stop that,
+# specifically: https://github.com/bitbucket-rest-api/bitbucket/issues/87
+Hashie.logger = Logger.new(File::NULL) if defined?(Hashie)
+
+$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)} [options] user/repo1 [user/repo2...]"
+
+  opts.on "-b", "--body", "Include the issue/pr body description in the output (GitHub only)" do
+    $body = true
+  end
+
+  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
+
+  opts.on "-e", "--endpoint=URL", "Endpoint URL for 'enterprise', etc... repositories" do |url|
+    $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
+  end
+
+  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", "Export items in the given state, defaults to open" do |f|
+    $filter = f
+  end
+
+  opts.on "-t", "--token=TOKEN", "API token" do |t|
+    $token = t
+  end
+
+  opts.on "-x", "--export=WHAT", %w[pr pr_comments issues all], "What to export: pr, pr_comments, 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
+  end
+end
+
+parser.parse!
+abort parser.banner if ARGV.empty?
+
+begin
+  export_repos(ARGV)
+rescue => e
+  abort "Export failed: #{e}"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: zz-export-pull-requests
+version: !ruby/object:Gem::Version
+  version: 0.3.5
+platform: ruby
+authors:
+- Zulhilmi Zainudin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: github_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: gitlab
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: zz_bitbucket_rest_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Program to export GitHub, GitLab, or Bitbucket pull requests/merge requests
+  and issues to CSV a file. This is forked version of https://github.com/sshaw/export-pull-requests
+  project.
+email: zulhfreelancer@gmail.com
+executables:
+- epr
+extensions: []
+extra_rdoc_files:
+- README.md
+- Changes
+files:
+- Changes
+- README.md
+- bin/epr
+homepage: https://github.com/zulhfreelancer/export-pull-requests
+licenses:
+- MIT
+metadata: {}
+post_install_message: Use the `epr' command to export your pull requests.
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Export pull requests and issues to a CSV file.
+test_files: []