github_export 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ee53ab8656f9e71f6ff5ecdcd091a888230b04d
+  data.tar.gz: 2a572fc0c2cd86a3a9655c684d125baaffd35d8e
+SHA512:
+  metadata.gz: 81612ccce6cb82f5b19ff6a1af3363011192e49334d4749de4b14f9a3d44dc7419e89b4b85137d479de97c881b0f2c9143932383820841a78005f2fd4f377386
+  data.tar.gz: df66c2e2033a6f66632e3674c99d8b3c685f453e41bedda4ef2c70d6efdb505d19bec1ae490745b42c546c0e214b7847d15dd1c1fd41bad46306d465b7985e44

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/buckup

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at akm2000@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in github_export.gemspec
+gemspec
+
+group :development do
+  gem 'pry'
+  gem 'pry-byebug'
+  gem 'pry-stack_explorer'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 akm
+
+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,72 @@
+# github_export
+
+`github_export` command exports your issues, pull requests, comments, labels, milestones and events to `.json` file.
+And it downloads your files which was uploaded to the issues or the comments.
+
+You can use the exported `.json` files and downloaded files for backup or migration to the other.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'github_export'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install github_export
+
+## Usage
+
+```bash
+$ github_export all <org_or_user>/<repo> -d path/to/export
+```
+
+Or you can specify access token with `--access-token` options if you know the access token.
+
+```bash
+$ github_export all <org_or_user>/<repo> -d path/to/export -t <access token>
+```
+
+See help for more detail
+
+```bash
+$ github_export
+Commands:
+  github_export all REPO           # Export all of the repository
+  github_export assets             # Download assets of the repository
+  github_export assets_check       # Check downloaded assets exist with assets.txt
+  github_export assets_download    # Download assets with assets.txt
+  github_export assets_list FILES  # Scan asset urls to assets.txt
+  github_export comments REPO      # Export comments of the repository
+  github_export events REPO        # Export events of the repository
+  github_export help [COMMAND]     # Describe available commands or one specific command
+  github_export issue_events REPO  # Export issue events of the repository
+  github_export issues REPO        # Export issues of the repository
+  github_export labels REPO        # Export labels of the repository
+  github_export milestones REPO    # Export milestones of the repository
+  github_export releases REPO      # Export releases of the repository
+  github_export repository REPO    # Export repository itself
+
+Options:
+  -t, [--access-token=ACCESS_TOKEN]  # Personal Access Token
+  -d, [--output-dir=OUTPUT_DIR]      # Output directory path
+                                     # Default: /Users/akima/groovenauts/github_export
+  -V, [--verbose], [--no-verbose]    # Show more details
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/github_export. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "github_export"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/github_export

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require "github_export"
+GithubExport::Command.start(ARGV)

data/github_export.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'github_export/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "github_export"
+  spec.version       = GithubExport::VERSION
+  spec.authors       = ["akm"]
+  spec.email         = ["akm2000@gmail.com"]
+
+  spec.summary       = %q{Export Issues, Contents and so on }
+  spec.description   = %q{Export Issues, Contents and so on}
+  spec.homepage      = "https://github.com/groovenauts/github_export"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "octokit"
+  spec.add_runtime_dependency "faraday", "= 0.9.1"
+  spec.add_runtime_dependency "thor"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/github_export.rb

@@ -0,0 +1,5 @@
+require "github_export/version"
+
+module GithubExport
+  autoload :Command, 'github_export/command'
+end

data/lib/github_export/command.rb

@@ -0,0 +1,211 @@
+# http://whatisthor.com/
+# https://github.com/erikhuda/thor
+require 'thor'
+
+# https://github.com/octokit/octokit.rb
+require 'octokit'
+
+require 'uri'
+require 'fileutils'
+require 'io/console'
+
+module GithubExport
+  class Command < Thor
+    class_option :access_token, aliases: '-t', type: :string, desc: 'Personal Access Token'
+    class_option :output_dir  , aliases: '-d', type: :string, desc: 'Output directory path', default: Dir.pwd
+    class_option :verbose     , aliases: '-V', type: :boolean, desc: "Show more details"
+
+    desc 'all REPO', "Export all of the repository"
+    def all(repo)
+      repository(repo)
+      milestones(repo)
+      releases(repo)
+      labels(repo)
+      issues(repo)
+      comments(repo)
+      events(repo)
+      issue_events(repo)
+      assets
+    end
+
+    desc 'repository REPO', "Export repository itself"
+    def repository(repo)
+      result = client.repository(repo)
+      output_to_file('repository.json', JSON.pretty_generate(result.to_attrs))
+    end
+
+    desc 'milestones REPO', "Export milestones of the repository"
+    def milestones(repo)
+      call_repo_method(repo, :list_milestones, 'milestones.json')
+    end
+
+    desc 'releases REPO', "Export releases of the repository"
+    def releases(repo)
+      call_repo_method(repo, :releases, 'releases.json')
+    end
+
+    desc 'labels REPO', "Export labels of the repository"
+    def labels(repo)
+      call_repo_method(repo, :labels, 'labels.json')
+    end
+
+    desc 'issues REPO', "Export issues of the repository"
+    def issues(repo)
+      call_repo_method(repo, :list_issues, 'issues.json', state: 'all', sort: 'created', direction: 'asc')
+    end
+
+    desc 'comments REPO', "Export comments of the repository"
+    def comments(repo)
+      call_repo_method(repo, :issues_comments, 'comments.json', sort: 'created', direction: 'asc')
+    end
+
+    desc 'events REPO', "Export events of the repository"
+    def events(repo)
+      call_repo_method(repo, :repository_events, 'events.json', sort: 'created', direction: 'asc')
+    end
+
+    # desc 'network_events REPO', "Export network events of the repository"
+    # def network_events(repo)
+    #   call_repo_method(repo, :repository_network_events, 'network_events.json')
+    # end
+
+    desc 'issue_events REPO', "Export issue events of the repository"
+    def issue_events(repo)
+      call_repo_method(repo, :repository_issue_events, 'issue_events.json', sort: 'created', direction: 'asc')
+    end
+
+    ASSETS_LIST_FILENAME = 'assets.txt'.freeze
+
+    desc 'assets', "Download assets of the repository"
+    def assets
+      files = Dir.glob(File.join(options[:output_dir], '**/*.json'))
+      assets_list(*files)
+      assets_download
+      assets_check
+    end
+
+    ASSET_PATTERN = /\!\[[^\[\]]+\]\(([^\(\)]+)\)/.freeze
+    desc 'assets_list FILES', "Scan asset urls to #{ASSETS_LIST_FILENAME}"
+    def assets_list(*files)
+      urls = files.map{|file|
+        File.read(file).lines.map{|line| line.scan(ASSET_PATTERN)}.delete_if(&:empty?).flatten.uniq
+      }.flatten.sort.uniq
+      output_to_file(ASSETS_LIST_FILENAME, urls.join("\n"))
+    end
+
+    desc 'assets_download', "Download assets with #{ASSETS_LIST_FILENAME}"
+    option :client_num, aliases: '-n', type: :numeric, default: 3, desc: "Number of clients to download"
+    option :force     , aliases: '-f', type: :boolean            , desc: "Overwrite if the file exists"
+    def assets_download
+      num = [options[:client_num].to_i, 1].max
+      lines = read_from_output_file(ASSETS_LIST_FILENAME).lines.map(&:strip)
+      tasks = lines.group_by.with_index{|_, i| i % num}
+      tasks.each do |idx, task_lines|
+        fork do
+          task_lines.each do |url|
+            uri = URI.parse(url)
+            dest = File.join(options[:output_dir], uri.path)
+            if options[:force] || !File.exist?(dest)
+              verbose "DL #{url}"
+              FileUtils.mkdir_p(File.dirname(dest))
+              File.binwrite(dest, client.get(url))
+            else
+              verbose "SKIP #{url}"
+            end
+          end
+        end
+        Process.waitall
+      end
+    end
+
+    CHECK_MSG_OK = "\e[32mOK %s\e[0m".freeze
+    CHECK_MSG_NG = "\e[31mNG %s\e[0m".freeze
+
+    desc 'assets_check', "Check downloaded assets exist with #{ASSETS_LIST_FILENAME}"
+    def assets_check
+      read_from_output_file(ASSETS_LIST_FILENAME).lines.map(&:strip).each do |line|
+        path = File.join(options[:output_dir], URI.parse(line).path)
+        fmt = File.exist?(path) ? CHECK_MSG_OK : CHECK_MSG_NG
+        puts fmt % path
+      end
+    end
+
+    no_commands do
+      def client
+        unless @client
+          Octokit.auto_paginate = true
+          access_token = options[:access_token]
+          access_token ||= generate_access_token
+          @client = Octokit::Client.new access_token: access_token
+        end
+        @client
+      end
+
+      ACCESS_TOKEN_NAME = 'Github Export'.freeze
+
+      def generate_access_token
+        login = ask 'login: '
+        pw = ask 'password: ', echo: false
+        $stdout.print "\n" # For noecho
+        client = Octokit::Client.new login: login, password: pw
+        verbose(client.inspect)
+
+        opts = {:scopes => ["repo", "user"], :note => ACCESS_TOKEN_NAME}
+        two_fa_code = ask 'two-factor authentication OTP code(Optional): '
+        unless two_fa_code.empty?
+          opts[:headers] = { "X-GitHub-OTP" => two_fa_code }
+        end
+        verbose("client.create_authorization(#{opts.inspect})")
+        begin
+          res = client.create_authorization(opts)
+          verbose("token: #{res.inspect}")
+          return res[:token]
+        rescue Octokit::Unauthorized => e
+          puts_error "Authentication failed. Your login name or password is wrong."
+          exit(1)
+        rescue Octokit::OneTimePasswordRequired => e
+          puts_error "You must specify two-factor authentication OTP code."
+          exit(1)
+        rescue Octokit::UnprocessableEntity => e
+          if e.errors.any?{|err| err[:code] == 'already_exists' && err[:resource] == 'OauthAccess'}
+            puts_error "Access Token named \"#{ACCESS_TOKEN_NAME}\" is already created." \
+                       "\nPlease remove the personal access token named \"#{ACCESS_TOKEN_NAME}\" at https://github.com/settings/tokens ." \
+                       "\nOr you can regenerate token on Edit view of the personal access token and add --access-token option to github_export command."
+          end
+          exit(1)
+        end
+      end
+
+      def call_repo_method(repo, name, filename, api_opts = {})
+        results = client.send(name, repo, api_opts)
+        output_to_file(filename, JSON.pretty_generate(results.map(&:to_attrs)))
+      end
+
+      def output_to_file(filename, content)
+        path = File.join(options[:output_dir], filename)
+        FileUtils.mkdir_p(File.dirname(path))
+        open(path, 'w') do |f|
+          f.puts(content)
+        end
+      end
+
+      def read_from_output_file(filename)
+        File.read(File.join(options[:output_dir], filename))
+      end
+
+      def puts_error(msg)
+        $stderr.puts "\e[31m#{msg}\e[0m"
+      end
+
+      def puts_info(msg)
+        $stderr.puts "\e[0m#{msg}\e[0m"
+      end
+
+      def verbose(msg)
+        $stderr.puts "\e[34m#{msg}\e[0m" if options[:verbose]
+      end
+
+    end
+
+  end
+end

data/lib/github_export/version.rb

@@ -0,0 +1,3 @@
+module GithubExport
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: github_export
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- akm
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+description: Export Issues, Contents and so on
+email:
+- akm2000@gmail.com
+executables:
+- github_export
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/github_export
+- github_export.gemspec
+- lib/github_export.rb
+- lib/github_export/command.rb
+- lib/github_export/version.rb
+homepage: https://github.com/groovenauts/github_export
+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.6.4
+signing_key: 
+specification_version: 4
+summary: Export Issues, Contents and so on
+test_files: []