github_issue_exporter 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 354c890b4dfbc919bdf6a9f613c51f77e9749998
-  data.tar.gz: fd7dc8cf8f2c0e92f9c3dbaddb6f3f755b7be2e8
+  metadata.gz: 83363ad95196320642cfe5355440361c0ecbf873
+  data.tar.gz: 88c3ee537a792ea633a8a006686d47365fdf5a09
 SHA512:
-  metadata.gz: ecb5b1495eb91c1c905286982274ef5e0551cbbc9b4f29ae264cc8addc85d0d7d0dd617b9a2071b1fb0cb2341af42974b1f54876c43ecd032cf31bd4fa22f871
-  data.tar.gz: 4dd49545cd5fa7db758abae755ebfafa573421c5a4d72aad17b9f63c588c770bbb6d6bd6632d9eb8c9afb03ab61270465deaa500159f3ca544665a24d336c0a6
+  metadata.gz: 4fcc17bad5c974b172e589b085f9c29fb3c705e2757e3b3bdb142c581a182f895999373f79ef259a3e30265471f1a601759e75a50c1e5b938f75521767d64a5a
+  data.tar.gz: 90dd4ee16a41cb77ba3adf2f234f11fab999926d38637c24ce3e3ba6f0f49184340dd40d5f6c8a1f159da991cdc5a10bd2da812e67d48ed4b08657a66255be9c

data/README.md

@@ -4,6 +4,8 @@
 
 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.
 
+There's also another executable for importing those issues back into a repository, so you can resurrect an archived repository with all of its issues.
+
 ## Installation
 
 GitHub Issue Exporter is built with Ruby and needs Ruby 2.0 or higher. Install it with RubyGems.
@@ -19,7 +21,9 @@ 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/).
+There are two executables, `export-github-issues` and `import-github-issues`. Both reneed at least three things to run, 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/).
+
+### export-github-issues
 
 The Exporter has a couple of options.
 
@@ -27,10 +31,36 @@ The Exporter has a couple of options.
 
 `--output` Set the directory to store the issues in. By default it is the current directory.
 
+The issues will be exported into either a single `issues.json` file or multiple `issue-[NUMBER].json` files.
+
+### Example
+
+```
+export-github-issues tallwave github_issue_exporter [TOKEN]
+
+export-github-issues --multiple-files --output ~/issues tallwave github_issue_exporter [TOKEN]
+```
+
+### import-github-issues
+You can import issues a couple of different ways. First is to provide the name of each JSON file created by the exporter.
+
+```
+import-github-issues issues.json more-issues.json tallwave github_issue_exporter [TOKEN]
+```
+
+Or you can use the `--directory` flag and load all the JSON files in the specified directory.
+
+```
+import-github-issues --directory ~/issues tallwave github_issue_exporter [TOKEN]
+```
+
+#### Importer Notes
+* Issues will be added to the repository as if they were brand new, so old issue numbers will not be used.
+* If your user does not have push access to the repository, assignees, milestones, and labels will not be set. Read more in the [GitHub documentation](https://developer.github.com/v3/issues/#create-an-issue).
+
 ## Roadmap
 
- * Import issues back into a repository.
- * Allow outputting to stdout.
+ * Better error handling.
 
 ## Contributing
 

data/bin/export-github-issues

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby -W
 # Copyright (c) 2015 Scott Williams
 
-$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + "/../lib")
 
-require 'issue_exporter/cli'
+require "issue_exporter/cli"
 
 module IssueExporting
   class Command
@@ -21,8 +21,6 @@ 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)
@@ -43,9 +41,13 @@ HERE
       @multiple_files = false
     end
 
+    def correct_number_of_args(arg_count)
+      arg_count == 3
+    end
+
     def define_options(opts)
-      opts.on('-o', '--output ARG') { |arg| @output = arg }
-      opts.on('--multiple-files')      { @multiple_files = true }
+      opts.on("-o", "--output ARG") { |arg| @output = arg }
+      opts.on("--multiple-files")      { @multiple_files = true }
     end
 
     def process_input(arg, index)

data/bin/import-github-issues

@@ -0,0 +1,81 @@
+#!/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
+Import issues downloaded from an archived GitHub repository into a new one.
+
+Usage: #{$PROGRAM_NAME} [OPTION] [FILE_NAMES]... [OWNER] [REPO] [TOKEN]
+
+--directory   DIRECTORY
+                rather than read individual files, read all appropriate files
+                in the provided directory
+
+-h, --help        display this help and exit
+    --version     display the version
+HERE
+
+    end
+
+    def initialize
+      super
+      @directory = nil
+      @directory_to_parse = nil
+      @args = []
+    end
+
+    def correct_number_of_args(arg_count)
+      has_directory? ? arg_count == 1 : arg_count >= 4
+    end
+
+    def define_options(opts)
+      opts.on("--directory")      { |arg| @directory = arg }
+    end
+
+    def perform_action
+      process_args
+      if has_directory?
+        importer = IssueExporting::DirectoryImporter.new @directory_to_parse
+        importer.import
+      else
+        importer = IssueExporting::Importer.new @files, @owner, @repo, @token
+        importer.import
+      end
+    end
+
+    # TODO: handle directory flag
+    def process_args
+      if has_directory?
+        @directory_to_parse = @args[0]
+      else
+        @files = @args[0...@args.count-3]
+        @owner = @args[@args.count-3]
+        @repo = @args[@args.count-2]
+        @token = @args[@args.count-1]
+      end
+    end
+
+    def process_input(arg, index)
+      @args << arg
+    end
+
+    private
+    def has_directory?
+      !@directory.nil?
+    end
+  end
+end
+
+IssueExporting::Command.new.run

data/github_issue_exporter.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   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.executables           = ['export-github-issues', 'import-github-issues']
   s.extra_rdoc_files      = ['LICENSE', 'README.md']
   s.require_paths         = ['lib']
 end

data/lib/issue_exporter.rb

@@ -1,9 +1,13 @@
 # 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'
+require "English"
+require "shellwords"
+require "json"
+require "issue_exporter/github"
+require "issue_exporter/error_handler"
+require "issue_exporter/outputter"
+require "issue_exporter/export"
+require "issue_exporter/import"
+require "issue_exporter/directory_importer"
+require "issue_exporter/error"
+require "issue_exporter/version"

data/lib/issue_exporter/cli.rb

@@ -1,7 +1,7 @@
 # Copyright (c) 2015 Scott Williams
 
-require 'optparse'
-require 'issue_exporter'
+require "optparse"
+require "issue_exporter"
 
 module IssueExporting
   module CLI
@@ -10,12 +10,12 @@ module IssueExporting
       begin
         OptionParser.new do |opts|
           define_options opts
-          opts.on '-h', '--help' do
+          opts.on "-h", "--help" do
             puts usage
             exit
           end
 
-          opts.on '--version' do
+          opts.on "--version" do
             puts about
             exit
           end
@@ -25,8 +25,8 @@ module IssueExporting
         raise UsageError, e
       end
 
-      fail UsageError, 'missing argument' if ARGV.empty?
-      fail UsageError, 'incorrect number of arguments' if ARGV.count != 3
+      fail UsageError, "missing argument" if ARGV.empty?
+      fail UsageError, "incorrect number of arguments" unless correct_number_of_args ARGV.count
       ARGV.each_with_index { |arg, index| process_input arg, index }
       perform_action()
 

data/lib/issue_exporter/directory_importer.rb

@@ -0,0 +1,16 @@
+module IssueExporting
+  class DirectoryImporter
+    def initialize(directory, owner, repo, token)
+      @directory = directory
+      @owner = owner
+      @repo = repo
+      @token = token
+    end
+
+    def import
+      files = Dir.glob "#{@directory}/*.json"
+      importer = IssueExporting::Importer.new(files, @owner, @repo, @token)
+      importer.import
+    end
+  end
+end

data/lib/issue_exporter/error_handler.rb

@@ -0,0 +1,23 @@
+module IssueExporting
+  class ErrorHandler
+    def response_has_error(response)
+      response.code.to_i > 299
+    end
+
+    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, should_abort = true)
+      msg = "ERROR: #{error_message}"
+      if should_abort
+        abort msg
+      else
+        puts msg
+      end
+    end
+  end
+end

data/lib/issue_exporter/export.rb

@@ -1,7 +1,7 @@
 # Copyright (c) 2015 Scott Williams
 
-require 'net/http'
-require 'json'
+require "net/http"
+require "json"
 
 module IssueExporting
   class Exporter
@@ -16,40 +16,16 @@ module IssueExporting
     end
 
     def export
-      url = URI.parse make_url
+      error_handler = ErrorHandler.new
+      url = IssueExporting.make_uri @owner, @repo, @token
       response = Net::HTTP::get url
-      if err = error_message(response)
-        handle_error err
+      if err = error_handler.error_message(response)
+        error_handler.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/github.rb

@@ -0,0 +1,14 @@
+module IssueExporting
+  def self.api_url
+    "https://api.github.com/repos/%s/%s/issues?access_token=%s"
+  end
+
+  def self.make_url(owner, repo, token)
+    url_format = IssueExporting.api_url
+    url_format % [owner, repo, token]
+  end
+
+  def self.make_uri(owner, repo, token)
+    URI.parse IssueExporting.make_url(owner, repo, token)
+  end
+end

data/lib/issue_exporter/import.rb

@@ -0,0 +1,87 @@
+require "net/http"
+require "json"
+
+module IssueExporting
+  class Importer
+    def initialize(files, owner, repo, token)
+      @files = files
+      @owner = owner
+      @repo = repo
+      @token = token
+    end
+
+    def import
+      @files.each do |file|
+        file_contents = read_file file
+        import_json(file_contents) unless file_contents.nil?
+      end
+    end
+
+    private
+
+    def import_json(json_obj)
+      if json_obj.class == Hash
+        import_json_hash json_obj
+      elsif json_obj.class == Array
+        import_json_array json_obj
+      else
+        puts "Unknown object: #{json_obj.class}"
+      end
+    end
+
+    def import_json_array(json_array)
+      json_array.each do |json_hash|
+        import_json_hash json_hash
+      end
+    end
+
+    def import_json_hash(json_hash)
+      create_issue(filter_json json_hash)
+    end
+
+    def filter_json(json_hash)
+      json_hash.select { |k, _v| allowed_properties.include? k }
+    end
+
+    def create_issue(json_obj)
+      uri = IssueExporting.make_uri @owner, @repo, @token
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true if uri.scheme == "https"
+      request = Net::HTTP::Post.new uri.request_uri
+      request.content_type = "application/json"
+      request.body = json_obj.to_json
+      handle_response http.request(request)
+    end
+
+    def allowed_properties
+      ["title", "body", "assignee", "milestone", "labels"]
+    end
+
+    def read_file(filename)
+      path = full_path filename
+      if File.exist? path
+        raw_text = File.read path
+        JSON.parse raw_text
+      else
+        handle_missing_file path
+        nil
+      end
+    end
+
+    def full_path(filename)
+      return filename if File.dirname(filename) != "."
+      "#{Dir.pwd}/#{filename}"
+    end
+
+    def handle_response(response)
+      error_handler = ErrorHandler.new
+      if error_handler.response_has_error response
+        error_handler.handle_error error_handler.error_message(response.body), true
+      end
+    end
+
+    def handle_missing_file(filename)
+      puts "Cannot open file: #{filename}"
+    end
+  end
+end

data/lib/issue_exporter/version.rb

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

metadata

@@ -1,20 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: github_issue_exporter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Scott Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-11 00:00:00.000000000 Z
+date: 2015-05-17 00:00:00.000000000 Z
 dependencies: []
 description: |2
       Download Issues from a GitHub repository.
 email: scott@swilliams.me
 executables:
 - export-github-issues
+- import-github-issues
 extensions: []
 extra_rdoc_files:
 - LICENSE
@@ -23,11 +24,16 @@ files:
 - LICENSE
 - README.md
 - bin/export-github-issues
+- bin/import-github-issues
 - github_issue_exporter.gemspec
 - lib/issue_exporter.rb
 - lib/issue_exporter/cli.rb
+- lib/issue_exporter/directory_importer.rb
 - lib/issue_exporter/error.rb
+- lib/issue_exporter/error_handler.rb
 - lib/issue_exporter/export.rb
+- lib/issue_exporter/github.rb
+- lib/issue_exporter/import.rb
 - lib/issue_exporter/outputter.rb
 - lib/issue_exporter/version.rb
 homepage: https://github.com/Tallwave/github_issue_exporter