tcie_migrate_to_apps 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bd0b653bee43e2b70c8fd2351ce7e170367e52e0361ca23c8f0683b7833bdaf6
+  data.tar.gz: 654516acb0dbd500c3766b795e4a3605d11982712ca3e858822cd01085696e53
+SHA512:
+  metadata.gz: '071843f2b51a9326a90416eda0799e6427470274e598279299c4044f2e6c160c24ff3fb1f9548e60a2baaa75da88c1c4fff15686cae72d0289528575e04c2900'
+  data.tar.gz: a4e58b0c6654f21531b0734b6ebadbd3e0dcf0089bb11a1ac9d0f02fb68eb884bb23dae30f535d80711be4a87d92613e19f433d758881676ba005f3c8363b47e

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rspec'
+  gem 'webmock'
+end

data/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT LICENSE
+
+Copyright (c) 2018 Travis CI <support@travis-ci.com>
+
+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,76 @@
+# Migrate your GitHub organizations to use the Travis CI GitHub App integration
+
+This gem will help you migrate the repositories you have on [https://travis-ci.com](travis-ci.com) from legacy [GitHub Services](https://developer.github.com/v3/guides/replacing-github-services/) integration to the new [GitHub Apps](https://developer.github.com/apps/) integration.
+
+The main difference is that you will now give Travis CI access to your repositories on a repository basis instead of giving it access to all of them.
+
+Hence, we have developped this gem to help you migrate your repositories that are currently active on Travis CI in one sweep rather than having to add them manually one by one in the GitHub UI.
+
+Here are the steps:
+
+## 1. Install the gem
+```
+gem install tcie_migrate_to_apps
+```
+
+## 2. Generate a GitHub personal access token with repo scope
+
+You can generate a new GitHub token [here](https://github.com/settings/tokens/new).
+
+Choose the name of your liking and ensure to select the whole `repo` scope as shown below:
+
+![GitHub new token page](https://github.com/travis-ci/travis_migrate_to_apps/blob/assets/github-token-new.png)
+
+Then click the "Generate token" button at the bottom to generate the token.
+
+You'll then be back on the GitHub token page:
+
+![GitHub token page](https://github.com/travis-ci/travis_migrate_to_apps/blob/assets/github-token-added.png)
+
+Take care of copying the newly generated token and save it for later usage.
+
+**Note: if you are migrating an organization, the token must be generated by [an owner of the GitHub organization](https://help.github.com/articles/permission-levels-for-an-organization/).**
+
+## 3. Activate the Travis CI GitHub Apps integration with 1 repo
+
+Go to your profile page on Travis CI: https://travis-ci.com/profile
+
+Click the "Activate GitHub Apps Integration" button highlighted below:
+
+![Activate GitHub Apps Integration button](https://github.com/travis-ci/travis_migrate_to_apps/blob/assets/github-apps-button-on-profile-page.png)
+
+You'll directed to the GitHub Apps page for the Travis CI app:
+
+![GitHub Apps page](https://github.com/travis-ci/travis_migrate_to_apps/blob/assets/travis-ci-github-app.png)
+
+Choose at least one repository and click the "Approve & Install" button.
+
+You'll then be redirected to your profile page on Travis CI and the newly added repository should appear under "GitHub Apps Integration":
+
+![Travis CI profile page](https://github.com/travis-ci/travis_migrate_to_apps/blob/assets/travis-ci-profile-with-github-apps-integration.png)
+
+## 4. Get your Travis CI API token
+
+Here are the two ways you can get this token:
+
+1. On your profile page: https://travis-ci.com/profile
+
+![Travis CI token on profile page](https://github.com/travis-ci/travis_migrate_to_apps/blob/assets/travis-ci-token-profile-page.png)
+
+2. Via the [Travis CI client](https://github.com/travis-ci/travis.rb) by running: `travis token --pro`
+
+## 5. Run the gem
+
+```
+tcie_migrate_to_apps [owner_name] [travis_access_token] [github_access_token] [travis api endpoint | https://api.travis-ci.com] [github api endpoint |  https://api.github.com]
+```
+
+where 
+
+- `[owner_name]` is the GitHub account (user or organization) where the repositories you want to migrate are located
+- `[travis_access_token]` is the Travis CI token obtained in step #4 above
+- `[github_access_token]` is the GitHub token obtained in step #2 above
+- `[travis api endpoint]`  - Travis CI API endpoint - Enterprise only
+- `[github api endpoint]`  - GitHub API endpoint - Enterprise only
+
+Happy migration!

data/bin/tcie_migrate_to_apps

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'tcie_migrate_to_apps'
+
+TcieMigrateToApps::Cli.new(*ARGV).run

data/lib/colors.rb

@@ -0,0 +1,15 @@
+module Colors
+  COLORS = {
+    red:    "\e[31m",
+    green:  "\e[32m",
+    yellow: "\e[33m",
+    blue:   "\e[34m",
+    gray:   "\e[37m",
+    reset:  "\e[0m"
+  }
+
+  def colored(color, str)
+    return str if color == :none
+    [COLORS[color], str, COLORS[:reset]].join
+  end
+end

data/lib/tcie_migrate_to_apps.rb

@@ -0,0 +1 @@
+require 'tcie_migrate_to_apps/cli'

data/lib/tcie_migrate_to_apps/cli.rb

@@ -0,0 +1,158 @@
+require 'net/https'
+require 'json'
+require 'colors'
+
+module TcieMigrateToApps
+  class Cli < Struct.new(:owner_name, :travis_access_token, :github_access_token, :api_endpoint, :github_api_endpoint)
+    include Colors
+
+    USAGE = 'Usage: tcie_migrate_to_apps [owner_name] [travis_access_token] [github_access_token] [travis api endpoint | https://api.travis-ci.com] [github api endpoint |  https://api.github.com]'
+
+    MSGS = {
+      start:                'Starting to migrate the account %s to use the Travis CI GitHub App integration.',
+      fetch_installation:   "Looking up %s's GitHub App installation.",
+      fetch_repos:          "Looking up %s's active repositories.",
+      migrate_repos:        'Starting to migrate %i repositories.',
+      migrating_repo:       'Migrating repository %s ... ',
+      migrated_repo:        'done.',
+      done:                 'Done.',
+      missing_installation: 'Sorry, we could not find an active installation for %s.',
+      missing_repos:        'Sorry, we could not find any repositories to migrate.',
+      request_failed:       "Sorry, a %s request to %s failed, please check your auth token. (%i: %s)",
+    }
+
+    URIS = {
+      travis: {
+        installation: '%s/owner/%s?include=owner.installation',
+        repositories: '%s/owner/%s/repos?repository.active=true&repository.managed_by_installation=false&limit=%i&offset=%i'
+      },
+      github: {
+        installation_repos: '%s/user/installations/%i/repositories/%i'
+      }
+    }
+
+    HEADERS = {
+      travis: {
+        'Travis-API-Version' => '3',
+        'User-Agent'         => 'Travis GitHub App Migration Tool',
+        'Authorization'      => 'token %{token}'
+      },
+      github: {
+        'Accept'        => 'application/vnd.github.machine-man-preview+json',
+        'Authorization' => 'token %{token}'
+      }
+    }
+
+    PER_PAGE = 20
+
+    attr_reader :installation
+    attr_reader :api_endpoint
+    attr_reader :github_api_endpoint
+
+    def initialize(*)
+      super
+      to_h.keys.each do |key|
+        if key == :api_endpoint
+          @api_endpoint = to_h[key] ? to_h[key] :  'https://api.travis-ci.com'
+        elsif key == :github_api_endpoint
+          @github_api_endpoint = to_h[key] ? to_h[key] :  'https://api.github.com'
+        else
+          missing_arg(key) unless send(key)
+        end
+      end
+    end
+
+    def run
+      msg :start, owner_name, color: :yellow
+      validate
+      migrate_repos
+      msg :done, color: :green
+    end
+
+    private
+
+      def installation
+        @installation ||= fetch_installation
+      end
+
+      def repos
+        @repos ||= begin
+          msg :fetch_repos, owner_name
+          fetch_repos
+        end
+      end
+
+      def validate
+        error :missing_installation, owner_name unless installation
+        error :missing_repos                    unless repos.any?
+      end
+
+      def migrate_repos
+        msg :migrate_repos, repos.count
+        repos.each { |repo| migrate_repo(repo) }
+      end
+
+      def migrate_repo(repo)
+        msg :migrating_repo, repo['name'], nl: false
+        uri = uri(:github, :installation_repos, github_api_endpoint, installation['github_id'], repo['github_id'])
+        request(:put, uri, headers(:github))
+        msg :migrated_repo, repo['name']
+      end
+
+      def fetch_installation
+        msg :fetch_installation, owner_name
+        uri = uri(:travis, :installation, api_endpoint, owner_name)
+        data = request(:get, uri, headers(:travis))
+        data['installation']
+      end
+
+      def fetch_repos(repos = [], page = 1)
+        offset = (page - 1) * PER_PAGE
+        uri    = uri(:travis, :repositories, api_endpoint, owner_name, PER_PAGE, offset)
+        data   = request(:get, uri, headers(:travis))
+        repos += data['repositories'].map { |repo| only(repo, 'name', 'github_id') }
+        repos  = fetch_repos(repos, page + 1) unless data['@pagination']['is_last']
+        repos
+      end
+
+      def uri(target, resource, *args)
+        URI(URIS[target][resource] % args)
+      end
+
+      def headers(target)
+        args = { token: send(:"#{target}_access_token") }
+        HEADERS[target].map { |key, value| [key, value % args] }.to_h
+      end
+
+      def request(method, uri, headers)
+        req = Net::HTTP.const_get(method.to_s.capitalize).new(uri)
+        headers.each { |key, value| req[key] = value }
+        http = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true)
+        res = http.request(req)
+        error :request_failed, method, uri, res.code, res.body unless res.is_a?(Net::HTTPSuccess)
+        JSON.parse(res.body) if method == :get
+      end
+
+      def error(key, *args)
+        abort colored(:red, MSGS[key] % args)
+      end
+
+      def msg(key, *args)
+        opts = args.last.is_a?(Hash) ? args.pop : {}
+        msg = MSGS[key] % args
+        msg = colored(opts[:color], msg) if opts[:color]
+        method = opts[:nl].is_a?(FalseClass) ? :print : :puts
+        send(method, msg)
+      end
+
+      def missing_arg(key)
+        puts colored(:red, "No #{key} given")
+        puts USAGE
+        abort
+      end
+
+      def only(hash, *keys)
+        hash.select { |key, _| keys.include?(key) }
+      end
+  end
+end

data/lib/tcie_migrate_to_apps/version.rb

@@ -0,0 +1,3 @@
+module TcieMigrateToApps
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: tcie_migrate_to_apps
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Travis CI
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-08-19 00:00:00.000000000 Z
+dependencies: []
+description: Migrate your GitHub organizations to use the Travis CI GitHub App integration.
+email:
+- support@travis-ci.com
+executables:
+- tcie_migrate_to_apps
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.md
+- README.md
+- bin/tcie_migrate_to_apps
+- lib/colors.rb
+- lib/tcie_migrate_to_apps.rb
+- lib/tcie_migrate_to_apps/cli.rb
+- lib/tcie_migrate_to_apps/version.rb
+homepage: https://github.com/travis-ci/travis_migrate_to_apps
+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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Migrate your GitHub organizations to use the Travis CI GitHub App integration
+test_files: []