github_trello_importer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1f4c971d242049aaf128baf764bb468e50f18dc4
+  data.tar.gz: dc9064366728eb83106448c9720bb0085759fcc4
+SHA512:
+  metadata.gz: fc740b9e61a45fb59a2c64d3c19fa5584876e4181bae105a4df0c0b5565620a06b64b7aa1e259746d65c0c61982acefbb2d76083588cb9b4513976e1bf502f4a
+  data.tar.gz: 4afaca60c4213c6919371c1a2f18fe6c95d144c842aa4ca8baf1961c28f447891ddceff254b26cbe251aa8941d9ef70f7824fcdf9a4618d73f43132d5ca0a65a

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,66 @@
+# 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)
+
+Trello is a good tool for quick data entry of user stories or issues, but it kinda sucks as a bug tracker. Fortunately it's easy to export cards from Trello in JSON, and GitHub's API makes it rather simple to create Issues from that.
+
+## Installation
+
+GitHub Trello Importer is built with Ruby and needs Ruby 2.0 or higher. Install it with RubyGems.
+
+```
+gem install github_trello_importer
+```
+
+Some environments may require `sudo` permissions.
+
+```
+sudo gem install github_trello_importer
+```
+
+## Usage
+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.
+
+`--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.
+
+`--closed` By default, only Open issues are exported. Adding this flag will include Closed ones as well.
+
+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 --closed 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]
+```
+
+## Roadmap
+
+
+## Contributing
+
+ * Fork
+ * Make it better
+ * Create a Pull Request

data/bin/import-trello

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby -W
+# Copyright (c) 2016 Tallwave
+
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + "/../lib")
+
+require "importer/cli"
+
+module TrelloImporter
+  class Command
+    include CLI
+
+    def about
+      VERSION
+    end
+
+    def usage
+      <<HERE
+Import a Trello export into GitHub issues.
+
+Usage: #{$PROGRAM_NAME} [FILE_NAME] [OWNER] [REPO] [TOKEN]
+
+Example: #{$PROGRAM_NAME} /path/to/file.json swilliams issue_exporter abcdef
+
+-h, --help        display this help and exit
+    --version     display the version
+
+HERE
+
+    end
+
+    def correct_number_of_args(arg_count)
+      arg_count == 4
+    end
+
+    def process_input(arg, index)
+      case index
+      when 0
+        @json_file = arg
+      when 1
+        @owner = arg
+      when 2
+        @repo = arg
+      when 3
+        @token = arg
+      end
+    end
+
+    def perform_action
+      importer = TrelloImporter::Importer.new(@json_file, @owner, @repo, @token)
+      importer.import
+    end
+  end
+end
+
+TrelloImporter::Command.new.run

data/github_trello_importer.gemspec

@@ -0,0 +1,21 @@
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/lib')
+
+require 'importer'
+
+Gem::Specification.new do |s|
+  s.name                  = 'github_trello_importer'
+  s.version               = TrelloImporter::VERSION
+  s.required_ruby_version = '>= 2.0'
+  s.summary               = 'Tools to import GitHub Issues from Trello'
+  s.description           = <<-HERE
+    Take JSON from Trello and create GitHub issues.
+  HERE
+  s.license               = 'MIT'
+  s.author                = 'Scott Williams'
+  s.email                 = 'scott.williams@tallwave.com'
+  s.homepage              = 'https://github.com/Tallwave/github_trello_importer'
+  s.files                 = Dir['{bin,lib}/**/*'] + ['github_trello_importer.gemspec']
+  s.executables           = ['import-trello']
+  s.extra_rdoc_files      = ['LICENSE', 'README.md']
+  s.require_paths         = ['lib']
+end

data/lib/importer.rb

@@ -0,0 +1,11 @@
+# Copyright (c) 2015 Scott Williams
+
+require "English"
+require "shellwords"
+require "json"
+require "importer/trello_issue_mapper"
+require "importer/github"
+require "importer/error_handler"
+require "importer/import"
+require "importer/error"
+require "importer/version"

data/lib/importer/cli.rb

@@ -0,0 +1,38 @@
+# Copyright (c) 2015 Scott Williams
+
+require "optparse"
+require "importer"
+
+module TrelloImporter
+  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" unless correct_number_of_args ARGV.count
+      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/importer/error.rb

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

data/lib/importer/error_handler.rb

@@ -0,0 +1,23 @@
+module TrelloImporter
+  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/importer/github.rb

@@ -0,0 +1,27 @@
+require "open-uri"
+
+module TrelloImporter
+  def self.api_url
+    "https://api.github.com/repos/%s/%s/issues?access_token=%s"
+  end
+
+  def self.make_url(owner, repo, token, options = {})
+    url_format = TrelloImporter.api_url
+    root_url = url_format % [owner, repo, token]
+    return root_url unless options[:include_closed_issues] == true
+    root_url + "&state=all"
+  end
+
+  def self.make_uri(owner, repo, token, options = {})
+    URI.parse TrelloImporter.make_url(owner, repo, token, options)
+  end
+
+  def self.turn_options_into_querystring(options)
+    querystring = ''
+    options.each do |k, v|
+      escaped_k, escaped_v = URI::encode(k), URI::encode(v)
+      querystring += "#{escaped_k}=#{escaped_v}&"
+    end
+    querystring.chop
+  end
+end

data/lib/importer/import.rb

@@ -0,0 +1,81 @@
+require "net/http"
+require "json"
+
+module TrelloImporter
+  class Importer
+    def initialize(json_file, owner, repo, token)
+      @json_file = json_file
+      @owner = owner
+      @repo = repo
+      @token = token
+    end
+
+    def import
+      file_contents = read_file @json_file
+      import_json(file_contents) unless file_contents.nil?
+    end
+
+    private
+
+    def import_json(json_obj)
+      if json_obj.class == Hash
+        if json_obj["cards"].nil?
+          puts "Could not find 'cards' key"
+        else
+          all_cards = json_obj["cards"]
+          import_json_array all_cards
+        end
+      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(trello_hash)
+      gh_hash = TrelloImporter::Mapper.map_from_trello trello_hash
+      create_issue(gh_hash)
+    end
+
+    def create_issue(json_obj)
+      uri = TrelloImporter.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 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/importer/trello_issue_mapper.rb

@@ -0,0 +1,9 @@
+module TrelloImporter
+  class Mapper
+    def self.map_from_trello(trello_hash)
+      body = "#{trello_hash["name"]}<br><br>#{trello_hash["desc"]}<br><br><a href=\"#{trello_hash["url"]}\">View on Trello.</a>"
+
+      {"body" => body, "title" => trello_hash["name"]}
+    end
+  end
+end

data/lib/importer/version.rb

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

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: github_trello_importer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Scott Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-08 00:00:00.000000000 Z
+dependencies: []
+description: |2
+      Take JSON from Trello and create GitHub issues.
+email: scott.williams@tallwave.com
+executables:
+- import-trello
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- LICENSE
+- README.md
+- bin/import-trello
+- github_trello_importer.gemspec
+- lib/importer.rb
+- lib/importer/cli.rb
+- lib/importer/error.rb
+- lib/importer/error_handler.rb
+- lib/importer/github.rb
+- lib/importer/import.rb
+- lib/importer/trello_issue_mapper.rb
+- lib/importer/version.rb
+homepage: https://github.com/Tallwave/github_trello_importer
+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 import GitHub Issues from Trello
+test_files: []