github_issue_exporter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 354c890b4dfbc919bdf6a9f613c51f77e9749998
+  data.tar.gz: fd7dc8cf8f2c0e92f9c3dbaddb6f3f755b7be2e8
+SHA512:
+  metadata.gz: ecb5b1495eb91c1c905286982274ef5e0551cbbc9b4f29ae264cc8addc85d0d7d0dd617b9a2071b1fb0cb2341af42974b1f54876c43ecd032cf31bd4fa22f871
+  data.tar.gz: 4dd49545cd5fa7db758abae755ebfafa573421c5a4d72aad17b9f63c588c770bbb6d6bd6632d9eb8c9afb03ab61270465deaa500159f3ca544665a24d336c0a6

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Scott Williams
+
+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,39 @@
+# GitHub Issue Exporter
+
+[![Circle CI](https://circleci.com/gh/Tallwave/github_issue_exporter.svg?style=shield&circle-token=:circle-token)](https://circleci.com/gh/Tallwave/github_issue_exporter) [![Code Climate](https://codeclimate.com/github/Tallwave/github_issue_exporter/badges/gpa.svg)](https://codeclimate.com/github/Tallwave/github_issue_exporter)
+
+Need to archive some repositories that are stored on GitHub? Great. Don't forget to hold on to any open issues you may still have. GitHub Issue Exporter is a command-line utility that will download all the open issues for a single repository.
+
+## Installation
+
+GitHub Issue Exporter is built with Ruby and needs Ruby 2.0 or higher. Install it with RubyGems.
+
+```
+gem install github_issue_exporter
+```
+
+Some environments may require `sudo` permissions.
+
+```
+sudo gem install github_issue_exporter
+```
+
+## Usage
+You'll need 3 things to run this, the name of the owner of the repository, the repository name, and an access token that has the authority to download the Issues. You can generate this token from [here](https://github.com/settings/tokens), and clicking on "Generate new token". Here's a [blog post with some more of the details involved](http://blog.swilliams.me/words/2015/04/01/two-factor-authentication-for-github/).
+
+The Exporter has a couple of options.
+
+`--multiple-files` By default Issue Exporter downloads and stores all the issues into a single JSON file. Setting the `multiple-files` flag will create a separate file for each Issue.
+
+`--output` Set the directory to store the issues in. By default it is the current directory.
+
+## Roadmap
+
+ * Import issues back into a repository.
+ * Allow outputting to stdout.
+
+## Contributing
+
+ * Fork
+ * Make it better
+ * Create a Pull Request

data/bin/export-github-issues

@@ -0,0 +1,70 @@
+#!/usr/bin/env ruby -W
+# Copyright (c) 2015 Scott Williams
+
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+require 'issue_exporter/cli'
+
+module IssueExporting
+  class Command
+    include CLI
+
+    def about
+      VERSION
+    end
+
+    def usage
+      <<HERE
+Download all open issues from a GitHub repository.
+
+Usage: #{$PROGRAM_NAME} [OPTION]... [OWNER] [REPO] [TOKEN]
+
+Example: #{$PROGRAM_NAME} swilliams issue_exporter abcdef
+
+TOKEN is only necessary for private repositories.
+
+-o, --output      DIRECTORY
+                    set output path
+                      (default: current working directory)
+
+    --multiple-files Use a separate file for each issue
+                    (default: one single file)
+
+-h, --help        display this help and exit
+    --version     display the version
+
+HERE
+
+    end
+
+    def initialize
+      super
+      @output = nil
+      @multiple_files = false
+    end
+
+    def define_options(opts)
+      opts.on('-o', '--output ARG') { |arg| @output = arg }
+      opts.on('--multiple-files')      { @multiple_files = true }
+    end
+
+    def process_input(arg, index)
+      case index
+      when 0
+        @owner = arg
+      when 1
+        @repo = arg
+      when 2
+        @token = arg
+      end
+    end
+
+    def perform_action
+      options = { path: @output, multiple_files: @multiple_files }
+      exporter = IssueExporting::Exporter.new(@owner, @repo, @token, options)
+      exporter.export
+    end
+  end
+end
+
+IssueExporting::Command.new.run

data/github_issue_exporter.gemspec

@@ -0,0 +1,21 @@
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/lib')
+
+require 'issue_exporter'
+
+Gem::Specification.new do |s|
+  s.name                  = 'github_issue_exporter'
+  s.version               = IssueExporting::VERSION
+  s.required_ruby_version = '>= 2.0'
+  s.summary               = 'Tools to export GitHub Issues'
+  s.description           = <<-HERE
+    Download Issues from a GitHub repository.
+  HERE
+  s.license               = 'MIT'
+  s.author                = 'Scott Williams'
+  s.email                 = 'scott@swilliams.me'
+  s.homepage              = 'https://github.com/Tallwave/github_issue_exporter'
+  s.files                 = Dir['{bin,lib}/**/*'] + ['github_issue_exporter.gemspec']
+  s.executables           = ['export-github-issues']
+  s.extra_rdoc_files      = ['LICENSE', 'README.md']
+  s.require_paths         = ['lib']
+end

data/lib/issue_exporter.rb

@@ -0,0 +1,9 @@
+# Copyright (c) 2015 Scott Williams
+
+require 'English'
+require 'shellwords'
+require 'json'
+require 'issue_exporter/outputter'
+require 'issue_exporter/export'
+require 'issue_exporter/error'
+require 'issue_exporter/version'

data/lib/issue_exporter/cli.rb

@@ -0,0 +1,38 @@
+# Copyright (c) 2015 Scott Williams
+
+require 'optparse'
+require 'issue_exporter'
+
+module IssueExporting
+  module CLI
+
+    def run
+      begin
+        OptionParser.new do |opts|
+          define_options opts
+          opts.on '-h', '--help' do
+            puts usage
+            exit
+          end
+
+          opts.on '--version' do
+            puts about
+            exit
+          end
+
+        end.parse!
+      rescue OptionParser::ParseError => e
+        raise UsageError, e
+      end
+
+      fail UsageError, 'missing argument' if ARGV.empty?
+      fail UsageError, 'incorrect number of arguments' if ARGV.count != 3
+      ARGV.each_with_index { |arg, index| process_input arg, index }
+      perform_action()
+
+    rescue UsageError => e
+      puts "#{$PROGRAM_NAME}: #{e}\nTry `#{$PROGRAM_NAME} --help` for more information."
+      exit false
+    end
+  end
+end

data/lib/issue_exporter/error.rb

@@ -0,0 +1,6 @@
+# Copyright (c) 2015 Scott Williams
+
+module IssueExporting
+  class UsageError < RuntimeError
+  end
+end

data/lib/issue_exporter/export.rb

@@ -0,0 +1,55 @@
+# Copyright (c) 2015 Scott Williams
+
+require 'net/http'
+require 'json'
+
+module IssueExporting
+  class Exporter
+
+    attr_accessor :outputter
+
+    def initialize(owner, repo, token = nil, options = {})
+      @owner = owner
+      @repo = repo
+      @token = token
+      @outputter = FileOutputter.new options
+    end
+
+    def export
+      url = URI.parse make_url
+      response = Net::HTTP::get url
+      if err = error_message(response)
+        handle_error err
+      else
+        outputter.write response
+      end
+    end
+
+    private
+    def error_message(response_text)
+      response_object = JSON.parse response_text
+      if response_object.is_a? Hash
+        response_object["message"]
+      end
+    end
+
+    def handle_error(error_message)
+      abort "ERROR: #{error_message}"
+    end
+
+    def make_url
+      url_format = @token ? url_with_token : url_without_token
+      url_format % [@owner, @repo, @token]
+    end
+
+    def url_with_token
+      "#{url_without_token}?access_token=%s"
+    end
+
+    def url_without_token
+      "https://api.github.com/repos/%s/%s/issues"
+    end
+
+  end
+end
+

data/lib/issue_exporter/outputter.rb

@@ -0,0 +1,41 @@
+# Copyright (c) 2015 Scott Williams
+
+module IssueExporting
+  class FileOutputter
+    def initialize(options = {})
+      @options = options
+    end
+
+    def write(response_text)
+      path = @options[:path] || default_path
+      if @options[:multiple_files]
+        write_multi_file path, response_text
+      else
+        write_single_file path, response_text
+      end
+    end
+
+    private
+    def default_path
+      Dir.pwd
+    end
+
+    def default_filename
+      "issues.json"
+    end
+
+    def write_single_file(dir, response_text)
+      path = "#{dir}/#{default_filename}"
+      File.open(path, 'w') { |f| f.write response_text }
+    end
+
+    def write_multi_file(dir, response_text)
+      array_of_issues = JSON.parse response_text
+      array_of_issues.each do |issue|
+        issue_number = issue["number"]
+        filename = "#{dir}/issue-#{issue_number}.json"
+        File.open(filename, 'w') { |f| f.write issue.to_json }
+      end
+    end
+  end
+end

data/lib/issue_exporter/version.rb

@@ -0,0 +1,5 @@
+# Copyright (c) 2015 Scott Williams
+
+module IssueExporting
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: github_issue_exporter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Scott Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-11 00:00:00.000000000 Z
+dependencies: []
+description: |2
+      Download Issues from a GitHub repository.
+email: scott@swilliams.me
+executables:
+- export-github-issues
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- LICENSE
+- README.md
+- bin/export-github-issues
+- github_issue_exporter.gemspec
+- lib/issue_exporter.rb
+- lib/issue_exporter/cli.rb
+- lib/issue_exporter/error.rb
+- lib/issue_exporter/export.rb
+- lib/issue_exporter/outputter.rb
+- lib/issue_exporter/version.rb
+homepage: https://github.com/Tallwave/github_issue_exporter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Tools to export GitHub Issues
+test_files: []