zenhub2pivotal 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 307aa6ea29ee6ee23260aca8b645e267c957ee92
+  data.tar.gz: ab4c8b969e8cc81e8421f3b02177b94b1aa63d6d
+SHA512:
+  metadata.gz: 56e17f9b974f754f6ac96864ddb5507fd69778be84bc20949f18a1100f65b7649cb231ca8e0c56d4257db39d89c19f644da78b9fd3e3a0b9ead291b5d1dd91c6
+  data.tar.gz: 8f439ae891574ad023ef4a20f74a5db89ed8af97d7a3bc1e9e89b07f8270a488f2f3b88d1918eaddc94bafe57f4fff029eec9763a5dbaae336a14b637074ae3e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/.zenhub2pivotal.yml
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.3

data/.zenhub2pivotal.yml.sample

@@ -0,0 +1,7 @@
+github_access_token: 0123456789abcdef0123456789abcdef01234567
+zenhub_access_token: 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
+pipelines:
+  "Wish List": icebox
+  Todo: backlog
+  Doing: current
+  Done: done

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 irohiroki@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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in zenhub2pivotal.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    zenhub2pivotal (0.1.0)
+      octokit
+      zenhub_ruby
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    diff-lcs (1.2.5)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.10.0)
+      faraday (>= 0.7.4, < 0.10)
+    multipart-post (2.0.0)
+    octokit (4.3.0)
+      sawyer (~> 0.7.0, >= 0.5.3)
+    rake (10.5.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    sawyer (0.7.0)
+      addressable (>= 2.3.5, < 2.5)
+      faraday (~> 0.8, < 0.10)
+    zenhub_ruby (0.1.1)
+      faraday
+      faraday_middleware
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  zenhub2pivotal!
+
+BUNDLED WITH
+   1.12.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Hiroki Yoshioka
+
+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,63 @@
+# Zenhub2pivotal
+
+A command line tool to generate CSV to migrate from ZenHub to Pivotal Tracker. Name all repo names in your ZenHub board and you get csv lines that suit to be imported to Pivotal Tracker.
+
+## Installation
+
+Assuming you have Ruby installed:
+
+    $ gem install zenhub2pivotal
+
+## Configuration
+
+You need 3 things:
+
+* GitHub Access Token
+* ZenHub Access Token
+* Pipeline-to-Panel mapping
+
+All information should be in `.zenhub2pivotal.yml` in the working directory. Consult [.zenhub2pivotal.yml.sample](.zenhub2pivotal.yml.sample) regarding the format.
+
+### GitHub Access Token
+
+You can manage your access tokens in [Personal settings](https://github.com/settings/tokens) page in GitHub. [A detailed documentation](https://developer.github.com/v3/oauth/) is also available.
+
+### ZenHub Access Token
+
+Your ZenHub Access Token can be generated in [Settings](https://dashboard.zenhub.io/#/settings) page in ZenHub dashboard. See [the document](https://github.com/ZenHubIO/API#authentication) for more information.
+
+### Pipeline-to-Panel mapping
+
+In ZenHub you can create "Pipelines" and name them as you like, while Pivotal Tracker has 4 "Panels", whose names are fixed (Icebox, Backlog, Current, and Done). Zenhub2pivotal need to know which pipeline corresponds to which panel. The format looks like the following:
+
+    "Wish List": icebox
+
+In which case, all issues in Wish List pipeline will go into the Icebox. 4 panel names (`icebox`, `backlog`, `current`, and `done`) are keyword and must be accurate.
+
+Only pipelines named in the configuration file will be processed.
+
+## Usage
+
+Give repository names as arguments.
+
+    $ zenhub2pivotal your_org/repo1 [your_org/repo2 ...]
+
+CSV lines should be out to the standard output.
+
+## Limitation
+
+### Comments
+
+Issue comments are not supported.
+
+### Issue order
+
+Some issues might appear in a different position (order) in Pivotal Tracker. (The tool orders issues based on their position value fetched from ZenHub API.)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/irohiroki/zenhub2pivotal. 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 "zenhub2pivotal"
+
+# 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/bin/zenhub2pivotal

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$:.push File.expand_path('../../lib', __FILE__)
+require 'zenhub2pivotal'
+
+Zenhub2pivotal::Cli.new(ARGV).run

data/lib/zenhub2pivotal.rb

@@ -0,0 +1,36 @@
+require 'octokit'
+require 'zenhub_ruby'
+
+require_relative 'zenhub2pivotal/cli'
+require_relative 'zenhub2pivotal/config'
+require_relative 'zenhub2pivotal/github'
+require_relative 'zenhub2pivotal/issue'
+require_relative 'zenhub2pivotal/repository'
+require_relative 'zenhub2pivotal/version'
+require_relative 'zenhub2pivotal/zenhub'
+
+module Zenhub2pivotal
+  class Main
+    def initialize(repo_names, out)
+      @repo_names = repo_names
+      @out = out
+    end
+
+    def perform
+      @out.puts 'Id,Title,Labels,Iteration,Iteration Start,Iteration End,Type,Estimate,Current State,Created at,Accepted at,Deadline,Requested By,Description,URL,Owned By,Comment'
+      Config.pipelines.each do |pipeline_name, panel|
+        repositories.flat_map {|repository|
+          repository.issues(pipeline: pipeline_name)
+        }.sort.each {|issue|
+          @out.puts(issue.csv(panel: panel))
+        }
+      end
+    end
+
+    def repositories
+      @repositories ||= @repo_names.map do |repo_name|
+        Repository.new(repo_name)
+      end
+    end
+  end
+end

data/lib/zenhub2pivotal/cli.rb

@@ -0,0 +1,11 @@
+module Zenhub2pivotal
+  class Cli
+    def initialize(argv)
+      @argv = argv
+    end
+
+    def run
+      Main.new(@argv, $stdout).perform
+    end
+  end
+end

data/lib/zenhub2pivotal/config.rb

@@ -0,0 +1,20 @@
+require 'yaml'
+
+module Zenhub2pivotal
+  class Config
+    def self.all
+      YAML.load_file("#{Dir.pwd}/.zenhub2pivotal.yml")
+    rescue => e
+      $stderr.puts("Can't load configuration file: #{e.message}")
+      nil
+    end
+
+    class << self
+      %i[github_access_token zenhub_access_token pipelines].each do |method_name|
+        define_method method_name do
+          all[method_name.to_s]
+        end
+      end
+    end
+  end
+end

data/lib/zenhub2pivotal/github.rb

@@ -0,0 +1,92 @@
+module Zenhub2pivotal
+  class GitHub
+    def self.client
+      @client ||= Octokit::Client.new(access_token: Config.github_access_token)
+    end
+
+    def self.repository(name)
+      @repositories ||= {}
+      @repositories[name] ||= Repository.new(name)
+    end
+
+    class IssueCache
+      def initialize(repository)
+        @repository = repository
+        @cache = []
+      end
+
+      def find_and_merge(zenhub_issue)
+        issues.lazy.find{|issue|
+          issue[:number] == zenhub_issue['issue_number']
+        }.to_attrs.merge(zenhub_issue)
+      end
+
+      def issues
+        Enumerator.new do |yielder|
+          @cache.each do |issue_datum|
+            yielder << issue_datum
+          end
+
+          loop do
+            issue_data = loader.next
+            break if issue_data.nil?
+            @cache += issue_data
+            issue_data.each do |issue_datum|
+              yielder << issue_datum
+            end
+          end
+        end
+      end
+
+      def load
+        issues
+      end
+
+      def loader
+        @loader ||= IssueLoader.new(@repository)
+      end
+    end
+
+    class IssueLoader
+      def initialize(repository)
+        @repository = repository
+      end
+
+      def next
+        if @response
+          rel_next = @response.rels[:next]
+          if rel_next
+            @response = rel_next.get
+            @response.data
+          else
+            nil
+          end
+        else
+          GitHub.client.issues(@repository.name)
+          @response = GitHub.client.last_response
+          @response.data
+        end
+      end
+    end
+
+    class Repository
+      attr_reader :name
+
+      def initialize(name)
+        @name = name
+      end
+
+      def data
+        @data ||= GitHub.client.repo(name)
+      end
+
+      def id
+        data[:id]
+      end
+
+      def issues
+        @issue_cache ||= IssueCache.new(self)
+      end
+    end
+  end
+end

data/lib/zenhub2pivotal/issue.rb

@@ -0,0 +1,87 @@
+require 'csv'
+require 'ostruct'
+
+module Zenhub2pivotal
+  class Issue
+    STATE = {
+      'done'    => 'accepted',
+      'current' => 'started',
+      'backlog' => 'unstarted',
+      'icebox'  => 'unscheduled',
+    }
+
+    def initialize(attrs)
+      @attrs = attrs
+    end
+
+    def <=>(other)
+      if position.nil?
+        other.position.nil? ? 0 : 1
+      else
+        other.position.nil? ? -1 : position - other.position
+      end
+    end
+
+    def accepted_at
+      format_time(:closed_at)
+    end
+
+    def assignee
+      @attrs[:assignee][:login] if @attrs[:assignee]
+    end
+
+    def created_at
+      format_time(:created_at)
+    end
+
+    def csv(panel:)
+      CSV.generate do |csv|
+        #       Id , Title, Labels, Iteration, Iteration Start, Iteration End, Type, Estimate, Current State, Created at, Accepted at, Deadline, Requested By, Description, URL, Owned By , Comment
+        csv << [nil, title, labels, nil      , nil            , nil          , type, estimate, STATE[panel] , created_at, accepted_at, nil     , user_login  , body       , nil, assignee, nil]
+      end
+    end
+
+    def github_labels
+      @attrs[:labels].map{|label|
+        label[:name]
+      }
+    end
+
+    def labels
+      (github_labels - ['bug'] + [repo_name]).join(',')
+    end
+
+    def estimate
+      @attrs['estimate'] && @attrs['estimate']['value']
+    end
+
+    def position
+      @attrs['position']
+    end
+
+    def repo_name
+      @attrs[:repo_name][/(?<=\/).*/]
+    end
+
+    def type
+      github_labels.include?('bug') ? 'bug' : 'feature'
+    end
+
+    def user_login
+      @attrs[:user][:login]
+    end
+
+    def method_missing(symbol, *args)
+      if [:body, :title].include?(symbol)
+        @attrs[symbol]
+      else
+        super
+      end
+    end
+
+    private
+      def format_time(key)
+        @attrs[key].strftime('%b %-m, %Y') if @attrs[key]
+      end
+  end
+end

data/lib/zenhub2pivotal/repository.rb

@@ -0,0 +1,34 @@
+require 'forwardable'
+
+module Zenhub2pivotal
+  class Repository
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+    end
+
+    def board
+      @board ||= ZenHub.new(id).board
+    end
+
+    def github_issues
+      GitHub.repository(name).issues
+    end
+
+    def id
+      GitHub.repository(name).id
+    end
+
+    def issues(pipeline:)
+      pipeline_data(pipeline)['issues'].map do |zenhub_issue|
+        Issue.new(github_issues.find_and_merge(zenhub_issue).merge(repo_name: name))
+      end
+    end
+
+    private
+      def pipeline_data(pipeline)
+        board.pipelines[pipeline] or raise "No such pipeline: #{pipeline}"
+      end
+  end
+end

data/lib/zenhub2pivotal/version.rb

@@ -0,0 +1,3 @@
+module Zenhub2pivotal
+  VERSION = "0.1.0"
+end

data/lib/zenhub2pivotal/zenhub.rb

@@ -0,0 +1,29 @@
+module Zenhub2pivotal
+  class ZenHub
+    def initialize(id)
+      @id = id
+    end
+
+    def board
+      @board ||= Board.new(client.board_data(@id).body)
+    end
+
+    def client
+      @client ||= ZenhubRuby::Client.new(Config.zenhub_access_token)
+    end
+
+    class Board
+      def initialize(data)
+        @data = data
+      end
+
+      def pipelines
+        @pipelines ||= Hash[
+          @data['pipelines'].dup.map{|pipeline_data|
+            [pipeline_data.delete('name'), pipeline_data]
+          }
+        ]
+      end
+    end
+  end
+end

data/zenhub2pivotal.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zenhub2pivotal/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zenhub2pivotal"
+  spec.version       = Zenhub2pivotal::VERSION
+  spec.authors       = ["Hiroki Yoshioka"]
+  spec.email         = ["irohiroki@gmail.com"]
+
+  spec.summary       = %q{ZenHub to Pivotal Tracker migration tool.}
+  spec.description   = %q{Exports issues from ZenHub (GitHub) and makes csv that can be imported to Pivotal Tracker.}
+  spec.homepage      = "https://github.com/irohiroki/zenhub2pivotal"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = "zenhub2pivotal"
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "octokit"
+  spec.add_dependency "zenhub_ruby"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: zenhub2pivotal
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hiroki Yoshioka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-26 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: zenhub_ruby
+  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: Exports issues from ZenHub (GitHub) and makes csv that can be imported
+  to Pivotal Tracker.
+email:
+- irohiroki@gmail.com
+executables:
+- zenhub2pivotal
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".zenhub2pivotal.yml.sample"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/zenhub2pivotal
+- lib/zenhub2pivotal.rb
+- lib/zenhub2pivotal/cli.rb
+- lib/zenhub2pivotal/config.rb
+- lib/zenhub2pivotal/github.rb
+- lib/zenhub2pivotal/issue.rb
+- lib/zenhub2pivotal/repository.rb
+- lib/zenhub2pivotal/version.rb
+- lib/zenhub2pivotal/zenhub.rb
+- zenhub2pivotal.gemspec
+homepage: https://github.com/irohiroki/zenhub2pivotal
+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.5.1
+signing_key: 
+specification_version: 4
+summary: ZenHub to Pivotal Tracker migration tool.
+test_files: []