github_records_archiver 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 20d21627161e4f5e187d555f3a2f12b925a633c6c8c3c2ca3bf28b6aee26ed18
+  data.tar.gz: '0805b746a6b6495fddf921a9638245286ec6d89da41dfcf6c30117f514ea8fb7'
+SHA512:
+  metadata.gz: 448ef59368b08c0ffb7e221ecad0b0674ed5cbfb85a1dceec9f2ba3bbd5103d00694032decbf896f6febd34fb7ddae2e6324e539e4da70482e2a6df0170e6b8a
+  data.tar.gz: 2eaec591f98b3359ee9f3769c2797f71db0b94c85480be4f5eb29b80903fa7eccfb357c12b5616347f09fb335982aa5305ae83cd69cfe17a6fa96feef665220d

data/.github/CODEOWNERS

@@ -0,0 +1,3 @@
+# Require @benbalter's :+1: for changes to the .github repo-config files
+# mainly due to https://github.com/probot/settings privilege escalation
+.github/* @benbalter

data/.github/config.yml

@@ -0,0 +1,20 @@
+# Behaviorbot config. See https://github.com/behaviorbot/ for more information.
+# Note: Please Don't edit this file directly.
+# Edit https://github.com/benbalter/behaviorbot-config instead.
+
+# Configuration for update-docs - https://github.com/behaviorbot/update-docs
+updateDocsComment: "Thanks for the pull request! If you are making any changes to the user-facing functionality, please be sure to update the documentation in the `README` or `docs/` folder alongside your change. :heart:"
+
+# Configuration for request-info - https://github.com/behaviorbot/request-info
+requestInfoReplyComment: Thanks for this. Do you mind providing a bit more information about what problem you're trying to solve?
+requestInfoLabelToAdd: more-information-needed
+
+# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome
+#newIssueWelcomeComment: >
+#  Welcome!
+
+# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome
+newPRWelcomeComment: Welcome! Congrats on your first pull request to GitHub Records Archiver. If you haven't already, please be sure to check out [the contributing guidelines](https://github.com/benbalter/github-records-archiver/blob/master/docs/CONTRIBUTING.md).
+
+# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge
+firstPRMergeComment: "Congrats on getting your first pull request to GitHub Records Archiver merged! Without amazing humans like you submitting pull requests, we couldn’t run this project. You rock! :tada:<br /><br />If you're interested in tackling another bug or feature, take a look at [the open issues](https://github.com/benbalter/github-records-archiver/issues), especially those [labeled `help wanted`](https://github.com/benbalter/github-records-archiver/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)."

data/.github/no-response.yml

@@ -0,0 +1,13 @@
+# Configuration for probot-no-response - https://github.com/probot/no-response
+
+# Number of days of inactivity before an Issue is closed for lack of response
+daysUntilClose: 14
+# Label requiring a response
+responseRequiredLabel: more-information-needed
+# Comment to post when closing an Issue for lack of response. Set to `false` to disable
+closeComment: >
+  This issue has been automatically closed because there has been no response
+  to our request for more information from the original author. With only the
+  information that is currently in the issue, we don't have enough information
+  to take action. Please reach out if you have or find the answers we need so
+  that we can investigate further.

data/.github/settings.yml

@@ -0,0 +1,31 @@
+# Repository settings set via https://github.com/probot/settings
+
+repository:
+  has_issues: true
+  has_wiki: false
+  has_projects: false
+  has_downloads: false
+
+labels:
+  - name: help wanted
+    oldname: help-wanted
+    color: 0e8a16
+  - name: more-information-needed
+    color: d93f0b
+  - name: bug
+    color: b60205
+  - name: feature
+    color: 1d76db
+  - name: good first issue
+    color: "5319e7"
+
+# Not currently implemented by probot/settings, but manually implemented in script/deploy
+branch_protection:
+  restrictions: null
+  enforce_admins: false
+  required_status_checks:
+    strict: true
+    contexts:
+      - "continuous-integration/travis-ci"
+  required_pull_request_reviews:
+    require_code_owner_reviews: true

data/.github/stale.yml

@@ -0,0 +1,27 @@
+# Configuration for probot-stale - https://github.com/probot/stale
+
+# Number of days of inactivity before an Issue or Pull Request becomes stale
+daysUntilStale: 60
+
+# Number of days of inactivity before a stale Issue or Pull Request is closed
+daysUntilClose: 7
+
+# Issues or Pull Requests with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+
+# Label to use when marking as stale
+staleLabel: wontfix
+
+# Comment to post when marking as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+
+# Comment to post when closing a stale Issue or Pull Request. Set to `false` to disable
+closeComment: false
+
+# Limit to only `issues` or `pulls`
+# only: issues

data/.gitignore

@@ -0,0 +1,5 @@
+/.env
+/archive
+Gemfile.lock
+spec/examples.txt
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,19 @@
+AllCops:
+  Exclude:
+    - archive/**/*
+    - vendor/**/*
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+    - '*.gemspec'
+
+Metrics/LineLength:
+  Exclude:
+    - spec/**/*
+
+Layout/IndentHeredoc:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+  - 2.4
+before_install: gem install bundler
+langauage: ruby
+script: script/cibuild
+sudo: false
+cache: bundler

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ben Balter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# GitHub Records Archiver
+
+[![Build Status](https://travis-ci.org/benbalter/github-records-archiver.svg?branch=master)](https://travis-ci.org/benbalter/github-records-archiver) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
+
+Backs up a GitHub organization's repositories and all their associated information for archival purposes.
+
+## What it archives
+
+* Git data (change history, tags, branches, etc.)
+* Wikis (including change history)
+* Issues and pull request (including comments, current state, etc.)
+* Teams (including members and repository permissions)
+
+## Requirements
+
+1. Ruby
+2. A GitHub [personal access token](https://github.com/settings/tokens/new) with `public_repo` and `repo` scope.
+
+## Setup
+
+1. `git clone https://github.com/benbalter/github-records-archiver`
+2. `cd github-records-archiver`
+3. `gem install bundler`
+4. `bundle install`
+
+## Usage
+
+`bin/archive [ORGANIZATION]`
+
+You'll want to set the following environmental variable:
+
+* `GITHUB_TOKEN` - Your personal access token
+
+You *may* set the following environmental variables:
+
+* `GITHUB_ARCHIVE_DIR` to specify the output directory. It will default to `./archive`.
+* `GITHUB_ORGANIZATION` - The organization to archive if none is passed as an argument.
+
+These can be passed as `GITHUB_TOKEN=123ABC GITHUB_ORGANIZATION=whitehouse bin/archive`.
+
+You can also add the values to a `.env` file in the project's root directory, which will be automatically set as environmental variables.
+
+## Output
+
+The script will create an `archive` directory, with one folder for each repository.
+
+Within each folder will be the repository content as a git repository.
+
+If the repository has a Wiki, the wiki will be cloned as a `wiki` subfolder, as a Git repository.
+
+If the repository has issues or pull requests, it will create an `issues` sub-folder with each issue and its associated comments stored as both markdown (human readable) and JSON (machine readable).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/archive

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+# Backs up a GitHub organization's repositories and
+# all their associated information for archival purposes.
+# Usage: ruby archive.rb
+
+require './lib/github_records_archiver'
+require 'parallel'
+
+def logger
+  @logger ||= Logger.new(STDOUT)
+end
+
+def log(msg)
+  logger.info(msg)
+end
+
+def error(msg)
+  logger.error(msg)
+end
+
+archiver = GitHubRecordsArchiver
+pwd      = Dir.pwd
+start    = Time.now
+org_name = ARGV[0] || ENV['GITHUB_ORGANIZATION']
+org      = archiver::Organization.new org_name
+
+log "Starting archive for @#{org.name} in #{org.archive_dir}"
+
+log "Found #{org.teams.count} teams"
+Parallel.each(org.teams, progress: 'Archiving teams', &:archive)
+
+log "Found #{org.repos.count} repos"
+Parallel.each(org.repos, progress: 'Archiving repos') do |repo|
+  begin
+    repo.clone
+    repo.wiki.clone if repo.has_wiki?
+    Parallel.each(repo.issues, &:archive)
+  rescue GitHubRecordsArchiver::GitError => e
+    error "Failed to archive #{repo.name}"
+    error e.message
+  end
+end
+
+Dir.chdir pwd
+log "Done in #{Time.now - start} seconds."

data/docs/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at ben@balter.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/docs/CONTRIBUTING.md

@@ -0,0 +1,85 @@
+# Contributing to GitHub Records Archiver
+
+Hi there! We're thrilled that you'd like to contribute to GitHub Records Archiver. Your help is essential for keeping it great.
+
+GitHub Records Archiver is an open source project supported by the efforts of an entire community and built one contribution at a time by users like you. We'd love for you to get involved. Whatever your level of skill or however much time you can give, your contribution is greatly appreciated. There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests, helping other users by commenting on issues, or writing code which can be incorporated into GitHub Records Archiver itself.
+
+Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
+
+
+
+## How to report a bug
+
+Think you found a bug? Please check [the list of open issues](https://github.com/benbalter/github-records-archiver/issues) to see if your bug has already been reported. If it hasn't please [submit a new issue](https://github.com/benbalter/github-records-archiver/issues/new).
+
+Here are a few tips for writing *great* bug reports:
+
+* Describe the specific problem (e.g., "widget doesn't turn clockwise" versus "getting an error")
+* Include the steps to reproduce the bug, what you expected to happen, and what happened instead
+* Check that you are using the latest version of the project and its dependencies
+* Include what version of the project your using, as well as any relevant dependencies
+* Only include one bug per issue. If you have discovered two bugs, please file two issues
+* Include screenshots or screencasts whenever possible
+* Even if you don't know how to fix the bug, including a failing test may help others track it down
+
+**If you find a security vulnerability, do not open an issue. Please email ben@balter.com instead.**
+
+## How to suggest a feature or enhancement
+
+If you find yourself wishing for a feature that doesn't exist in GitHub Records Archiver, you are probably not alone. There are bound to be others out there with similar needs. Many of the features that GitHub Records Archiver has today have been added because our users saw the need.
+
+Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and goals of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible, including describing the problem you're trying to solve.
+
+[Open an issue](https://github.com/benbalter/github-records-archiver/issues/new) which describes the feature you would like to see, why you want it, how it should work, etc.
+
+
+
+## Your first contribution
+
+We'd love for you to contribute to the project. Unsure where to begin contributing to GitHub Records Archiver? You can start by looking through these "good first issue" and "help wanted" issues:
+
+* [Good first issues](https://github.com/benbalter/github-records-archiver/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) - issues which should only require a few lines of code and a test or two
+* [Help wanted issues](https://github.com/benbalter/github-records-archiver/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) - issues which may be a bit more involved, but are specifically seeking community contributions
+
+*p.s. Feel free to ask for help; everyone is a beginner at first* :smiley_cat:
+
+## How to propose changes
+
+Here's a few general guidelines for proposing changes:
+
+* If you are changing any user-facing functionality, please be sure to update the documentation
+* If you are adding a new behavior or changing an existing behavior, please be sure to update the corresponding test(s)
+* Each pull request should implement **one** feature or bug fix. If you want to add or fix more than one thing, submit more than one pull request
+* Do not commit changes to files that are irrelevant to your feature or bug fix
+* Don't bump the version number in your pull request (it will be bumped prior to release)
+* Write [a good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
+
+At a high level, [the process for proposing changes](https://guides.github.com/introduction/flow/) is:
+
+1. [Fork](https://github.com/benbalter/github-records-archiver/fork) and clone the project
+2. Configure and install the dependencies: `script/bootstrap`
+3. Make sure the tests pass on your machine: `script/cibuild`
+4. Create a descriptively named branch: `git checkout -b my-branch-name`
+5. Make your change, add tests and documentation, and make sure the tests still pass
+6. Push to your fork and [submit a pull request](https://github.com/benbalter/github-records-archiver/compare) describing your change
+7. Pat your self on the back and wait for your pull request to be reviewed and merged
+
+**Interesting in submitting your first Pull Request?** It's easy! You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
+
+## Bootstrapping your local development environment
+
+`script/bootstrap`
+
+## Running tests
+
+`script/cibuild`
+
+## Code of conduct
+
+This project is governed by [the Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
+
+## Additional Resources
+
+* [Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/)
+* [Using Pull Requests](https://help.github.com/articles/using-pull-requests/)
+* [GitHub Help](https://help.github.com)

data/github_records_archiver.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'github_records_archiver/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'github_records_archiver'
+  spec.version       = GitHubRecordsArchiver::VERSION
+  spec.authors       = ['Ben Balter']
+  spec.email         = ['ben.balter@github.com']
+
+  spec.summary       = <<-SUMMARY
+    Backs up a GitHub organization's repositories and all their associated
+    information for archival purposes
+  SUMMARY
+
+  spec.homepage      = 'https://github.com/benbalter/github_records_archiver'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'dotenv', '~> 2.0'
+  spec.add_dependency 'octokit', '~> 4.0'
+  spec.add_dependency 'parallel', '~> 1.10'
+  spec.add_dependency 'ruby-progressbar', '~> 1.0'
+  spec.add_development_dependency 'addressable', '~> 2.5'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.50'
+  spec.add_development_dependency 'webmock', '~> 3.0'
+end

data/lib/github_records_archiver/comment.rb

@@ -0,0 +1,32 @@
+module GitHubRecordsArchiver
+  class Comment
+    attr_reader :repository
+    attr_reader :id
+
+    include DataHelper
+
+    def initialize(repo, id)
+      repo = Repository.new(repo) if repo.is_a? String
+      @repository = repo
+      @id = id
+    end
+
+    def self.from_hash(repo, hash)
+      comment = Comment.new(repo, hash[:number])
+      comment.instance_variable_set '@data', hash.to_h
+      comment
+    end
+
+    def data
+      @data ||= begin
+        GitHubRecordsArchiver.client.issue_comment(repository.full_name, id)
+      end
+    end
+
+    def to_s
+      output = "@#{user[:login]} at #{created_at} wrote:\n\n"
+      output << body
+      output
+    end
+  end
+end

data/lib/github_records_archiver/data_helper.rb

@@ -0,0 +1,45 @@
+module GitHubRecordsArchiver
+  module DataHelper
+    attr_writer :data
+
+    def method_missing(method_sym, *arguments, &block)
+      return data[method_sym] if data_key?(method_sym)
+      if method_sym.to_s.end_with? '?'
+        !send(non_predicate_method(method_sym)).to_s.empty?
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_sym, include_private = false)
+      if data_key? non_predicate_method(method_sym)
+        true
+      else
+        super
+      end
+    end
+
+    def to_h
+      data.to_h
+    end
+    alias as_json to_h
+
+    def to_json
+      as_json.to_json
+    end
+
+    def data
+      raise 'Not implemented'
+    end
+
+    private
+
+    def data_key?(key)
+      data && data.key?(key)
+    end
+
+    def non_predicate_method(method_sym)
+      method_sym.to_s.gsub(/\?\z/, '').to_sym
+    end
+  end
+end

data/lib/github_records_archiver/git_repository.rb

@@ -0,0 +1,51 @@
+module GitHubRecordsArchiver
+  class GitError < StandardError; end
+
+  class GitRepository
+    def clone
+      if Dir.exist? repo_dir # Repo already exists, just pull new objects
+        Dir.chdir repo_dir do
+          git 'pull'
+        end
+      else # Clone Git content from scratch
+        git 'clone', clone_url, repo_dir
+      end
+    end
+
+    def repo_dir
+      raise 'Not implemented'
+    end
+
+    private
+
+    def clone_url
+      raise 'Not implemented'
+    end
+
+    # There's a bug, whereby if you attempt to clone a wiki that's enabled
+    # but has not yet been initialized, GitHub returns a remote error
+    # Rather than let this break the export, capture the error and continue
+    def wiki_does_not_exist?(output)
+      expected = '^fatal: remote error: access denied or repository not '
+      expected << "exported: .*?\.wiki\.git$"
+      output =~ /#{expected}/
+    end
+
+    # Attempting to clone an empty repo will rightfulyl fail at the Git level
+    # But we shouldn't let that fail the archive operation
+    def empty_repo?(output)
+      expected = 'Your configuration specifies to merge with the ref '
+      expected << "'refs/heads/master'\n"
+      expected << 'from the remote, but no such ref was fetched.'
+      output =~ Regexp.new(expected)
+    end
+
+    # Run a git command, piping output to stdout
+    def git(*args)
+      output, status = Open3.capture2e('git', *args)
+      return false if empty_repo?(output) || wiki_does_not_exist?(output)
+      raise GitError, output if status.exitstatus != 0
+      output
+    end
+  end
+end

data/lib/github_records_archiver/issue.rb

@@ -0,0 +1,70 @@
+module GitHubRecordsArchiver
+  class Issue
+    attr_reader :repository
+    attr_reader :number
+
+    include DataHelper
+
+    KEYS = %i[title number state html_url created_at closed_at].freeze
+
+    def initialize(repository: nil, number: nil)
+      repository = Repository.new(repository) if repository.is_a? String
+      @repository = repository
+      @number = number
+    end
+
+    def self.from_hash(repo, hash)
+      issue = Issue.new(repository: repo, number: hash[:number])
+      issue.instance_variable_set('@data', hash.to_h)
+      issue
+    end
+
+    def data
+      @data ||= GitHubRecordsArchiver.client.issue repository.name, number
+    end
+
+    def comments
+      @comments ||= begin
+        return [] if data[:comments].nil? || data[:comments].zero?
+        client = GitHubRecordsArchiver.client
+        comments = client.issue_comments repository.full_name, number
+        comments.map { |hash| Comment.from_hash(repository, hash) }
+      end
+    end
+
+    def to_s
+      md = meta_for_markdown.to_yaml + "---\n\n# #{title}\n\n"
+      md << body unless body.to_s.empty?
+      md << comments_string unless comments.nil?
+      md
+    end
+
+    def as_json
+      data.to_h.merge('comments' => comments.map(&:as_json))
+    end
+
+    def archive
+      File.write(path('md'), to_s)
+      File.write(path('json'), to_json)
+    end
+
+    private
+
+    def path(ext = 'md')
+      File.expand_path "#{number}.#{ext}", repository.issues_dir
+    end
+
+    def meta_for_markdown
+      meta = {}
+      KEYS.each { |key| meta[key.to_s] = data[key] }
+      meta['user']     = user[:login]
+      meta['assignee'] = assignee[:login] unless assignee.nil?
+      meta['tags']     = labels.map { |tag| tag[:name] }
+      meta
+    end
+
+    def comments_string
+      "\n\n---\n" + comments.map(&:to_s).join("\n\n---\n")
+    end
+  end
+end

data/lib/github_records_archiver/organization.rb

@@ -0,0 +1,48 @@
+module GitHubRecordsArchiver
+  class Organization
+    attr_reader :name
+
+    include DataHelper
+
+    def initialize(name)
+      @name = name
+    end
+
+    def data
+      @data ||= GitHubRecordsArchiver.client.organization name
+    end
+
+    def repositories
+      @repositories ||= begin
+        repos = GitHubRecordsArchiver.client.organization_repositories(name)
+        repos.map { |hash| Repository.new(hash) }
+      end
+    end
+    alias repos repositories
+
+    def teams
+      @teams ||= begin
+        teams = GitHubRecordsArchiver.client.organization_teams(name)
+        teams.map { |h| Team.from_hash(self, h) }
+      rescue Octokit::Forbidden
+        []
+      end
+    end
+
+    def archive_dir
+      @archive_dir ||= begin
+        dir = File.expand_path name, GitHubRecordsArchiver.dest_dir
+        FileUtils.mkdir_p(dir) unless Dir.exist?(dir)
+        dir
+      end
+    end
+
+    def teams_dir
+      @teams_dir ||= begin
+        dir = File.expand_path 'teams', archive_dir
+        FileUtils.mkdir_p(dir) unless Dir.exist?(dir)
+        dir
+      end
+    end
+  end
+end

data/lib/github_records_archiver/repository.rb

@@ -0,0 +1,54 @@
+module GitHubRecordsArchiver
+  class Repository < GitRepository
+    attr_reader :name
+    include DataHelper
+
+    KEYS = %i[
+      name full_name description private fork homepage
+      forks_count stargazers_count watchers_count size
+    ].freeze
+
+    def initialize(name_or_hash)
+      if name_or_hash.is_a?(String)
+        @name = name_or_hash
+      else
+        @data = name_or_hash.to_h
+        @name = @data[:full_name]
+      end
+    end
+
+    def data
+      @data ||= GitHubRecordsArchiver.client.repository(name)
+    end
+
+    def wiki
+      @wiki ||= Wiki.new(self) if has_wiki?
+    end
+
+    def issues
+      @issues ||= begin
+        issues = GitHubRecordsArchiver.client.list_issues name, state: 'all'
+        issues.map { |i| Issue.from_hash(self, i) }
+      end
+    end
+
+    def issues_dir
+      @issues_dir ||= begin
+        dir = File.expand_path 'issues', repo_dir
+        FileUtils.mkdir_p(dir) unless Dir.exist?(dir)
+        dir
+      end
+    end
+
+    private
+
+    def repo_dir
+      @repo_dir ||= File.expand_path data[:name], GitHubRecordsArchiver.dest_dir
+    end
+
+    def clone_url
+      replacement = "https://#{GitHubRecordsArchiver.token}:x-oauth-basic@"
+      data[:clone_url].gsub(%r{https?://}, replacement)
+    end
+  end
+end

data/lib/github_records_archiver/team.rb

@@ -0,0 +1,66 @@
+module GitHubRecordsArchiver
+  class Team
+    attr_reader :id
+    attr_reader :organization
+
+    include DataHelper
+
+    KEYS = %i[name slug description privacy permission].freeze
+
+    def initialize(org, id)
+      org = Organization.new(org) if org.is_a? String
+      @organization = org
+      @id = id
+    end
+
+    def self.from_hash(org, hash)
+      team = Team.new(org, hash[:id])
+      team.instance_variable_set '@data', hash.to_h
+      team
+    end
+
+    def data
+      @data ||= GitHubRecordsArchiver.client.team id
+    end
+
+    def repositories
+      @repositories ||= begin
+        repos = GitHubRecordsArchiver.client.team_repositories id
+        repos.map { |r| Repository.new(r) }
+      end
+    end
+
+    def members
+      @members ||= begin
+        members = GitHubRecordsArchiver.client.team_members id
+        members.map { |m| User.new(m) }
+      end
+    end
+
+    def archive
+      File.write(path, to_s)
+    end
+
+    def to_s
+      meta_for_markdown.to_yaml
+    end
+
+    def as_json
+      data.to_h.merge(repositories: repositories.map(&:name))
+    end
+
+    private
+
+    def path
+      File.expand_path "#{data[:slug]}.md", organization.teams_dir
+    end
+
+    def meta_for_markdown
+      meta = {}
+      KEYS.each { |key| meta[key.to_s] = data[key] }
+      meta['repositories'] = repositories.map(&:name)
+      meta['members'] = members.map(&:name)
+      meta
+    end
+  end
+end

data/lib/github_records_archiver/user.rb

@@ -0,0 +1,23 @@
+module GitHubRecordsArchiver
+  class User
+    attr_reader :login
+    alias name login
+
+    include DataHelper
+
+    KEYS = %i[login site_admin type].freeze
+
+    def initialize(login_or_hash)
+      if login_or_hash.is_a? String
+        @login = login_or_hash
+      else
+        @login = login_or_hash[:login]
+        @data = login_or_hash.to_h
+      end
+    end
+
+    def data
+      @data ||= GitHubRecordsArchiver.client.user login
+    end
+  end
+end

data/lib/github_records_archiver/version.rb

@@ -0,0 +1,3 @@
+module GitHubRecordsArchiver
+  VERSION = '0.1.0'.freeze
+end

data/lib/github_records_archiver/wiki.rb

@@ -0,0 +1,26 @@
+module GitHubRecordsArchiver
+  class Wiki < GitRepository
+    attr_accessor :repository
+
+    include DataHelper
+
+    def initialize(repository)
+      @repository = if repository.is_a?(String)
+                      Repository.new(repository)
+                    else
+                      repository
+                    end
+    end
+
+    def repo_dir
+      name = "#{repository.full_name}/wiki"
+      @repo_dir ||= File.expand_path name, GitHubRecordsArchiver.dest_dir
+    end
+
+    private
+
+    def clone_url
+      @clone_url ||= repository.clone_url.gsub(/\.git\z/, '.wiki.git')
+    end
+  end
+end

data/lib/github_records_archiver.rb

@@ -0,0 +1,43 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+# stdlib
+require 'yaml'
+require 'json'
+require 'logger'
+require 'fileutils'
+require 'open3'
+
+# gems
+require 'octokit'
+require 'dotenv'
+
+# Configuration
+Dotenv.load
+Octokit.auto_paginate = true
+
+module GitHubRecordsArchiver
+  autoload :DataHelper,    'github_records_archiver/data_helper'
+  autoload :Comment,       'github_records_archiver/comment'
+  autoload :GitRepository, 'github_records_archiver/git_repository'
+  autoload :Issue,         'github_records_archiver/issue'
+  autoload :Organization,  'github_records_archiver/organization'
+  autoload :Repository,    'github_records_archiver/repository'
+  autoload :Team,          'github_records_archiver/team'
+  autoload :User,          'github_records_archiver/user'
+  autoload :VERSION,       'github_records_archiver/version'
+  autoload :Wiki,          'github_records_archiver/wiki'
+
+  class << self
+    def token
+      ENV['GITHUB_TOKEN']
+    end
+
+    def client
+      @client ||= Octokit::Client.new access_token: token
+    end
+
+    def dest_dir
+      ENV['GITHUB_ARCHIVE_DIR'] || File.expand_path('./archive', Dir.pwd)
+    end
+  end
+end

data/script/bootstrap

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+set -ex
+
+bundle install

data/script/cibuild

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+set -ex
+
+bundle exec rspec
+bundle exec rubocop
+bundle exec gem build github_records_archiver.gemspec

data/script/console

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+set -ex
+
+bundle exec pry -r './lib/github_records_archiver'

metadata

@@ -0,0 +1,231 @@
+--- !ruby/object:Gem::Specification
+name: github_records_archiver
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Balter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  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: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.50'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- ben.balter@github.com
+executables:
+- archive
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/CODEOWNERS"
+- ".github/config.yml"
+- ".github/no-response.yml"
+- ".github/settings.yml"
+- ".github/stale.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/archive
+- docs/CODE_OF_CONDUCT.md
+- docs/CONTRIBUTING.md
+- github_records_archiver.gemspec
+- lib/github_records_archiver.rb
+- lib/github_records_archiver/comment.rb
+- lib/github_records_archiver/data_helper.rb
+- lib/github_records_archiver/git_repository.rb
+- lib/github_records_archiver/issue.rb
+- lib/github_records_archiver/organization.rb
+- lib/github_records_archiver/repository.rb
+- lib/github_records_archiver/team.rb
+- lib/github_records_archiver/user.rb
+- lib/github_records_archiver/version.rb
+- lib/github_records_archiver/wiki.rb
+- script/bootstrap
+- script/cibuild
+- script/console
+homepage: https://github.com/benbalter/github_records_archiver
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Backs up a GitHub organization's repositories and all their associated information
+  for archival purposes
+test_files: []