travis_migrate_to_apps 0.0.1 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f62ca1e281bce57365c17ea8826871ba7cbf80fa
-  data.tar.gz: bf406955dd183c6e2ea7e3b5758a31af43964040
+SHA256:
+  metadata.gz: 11aa9acdabfe9c4b3266ef1c1561efab04abd4ac06f89cb02931ebe29580cbb3
+  data.tar.gz: 21d585480351fbd6bc1e3745025e6aba13208d23a64e4f4bc32ca08f0499dfd2
 SHA512:
-  metadata.gz: e1bda52e5041df03d4a7885cdd1ab1e0e25afe9c439293f356a15e03bd4c1c12030e3e0cc4ecf6fdcf3c7511676307037fb885c8d7ff7ebbc22ad40f261a53bd
-  data.tar.gz: '09364eab42385c7bb39e772fa6a2ce468c787aee39eaeffd1cfbe5282bc0fbf6e37edf3f33c102569deb79da0f55d520f1baa02fc1db09b11e1ad5ed203b8720'
+  metadata.gz: 5ddb124d2978f0845f223287e6e7bf4a688179793371971a05aa134b918889ae8dddd41ee805b050236431705fdb71c283b24851646c3f05839692f7a1d2271b
+  data.tar.gz: 550a753c4c3f6c654923ca8fc5b0c994707b3dd4e884cfdfb141427fd387f4aa29aaf63047a9bc160e079ff82c7291cf52a4c211924df259ea06fab99da4a524

data/README.md

@@ -0,0 +1,74 @@
+# 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 travis_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
+
+```
+travis_migrate_to_apps [owner_name] [travis_access_token] [github_access_token]
+```
+
+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
+
+Happy migration!

data/bin/travis_migrate_to_apps

@@ -2,4 +2,4 @@
 
 require 'travis_migrate_to_apps'
 
-TravisMigrateToApps.new(*ARGV)
+TravisMigrateToApps::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/travis_migrate_to_apps/cli.rb

@@ -0,0 +1,158 @@
+require 'net/https'
+require 'json'
+require 'colors'
+
+module TravisMigrateToApps
+  class Cli < Struct.new(:owner_name, :travis_access_token, :github_access_token, :api_endpoint, :github_api_endpoint)
+    include Colors
+
+    USAGE = 'Usage: travis_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/travis_migrate_to_apps/version.rb

@@ -1,3 +1,3 @@
 module TravisMigrateToApps
-  VERSION = '0.0.1'
+  VERSION = '0.0.5'
 end

data/lib/travis_migrate_to_apps.rb

@@ -1,127 +1 @@
-require 'net/https'
-require 'json'
-
-class TravisMigrateToApps < Struct.new(:owner_name, :travis_access_token, :github_access_token)
-  USAGE = 'Usage: travis_migrate_to_apps [owner_name] [travis_access_token] [github_access_token]'
-
-  MSGS = {
-    start:                'Starting to migrate %s to use the Travis CI GitHub App integration',
-    migrate_repos:        'Starting to migrate %i repositories',
-    migrated_repo:        'Migrated repository %s',
-    done:                 'Done.',
-    missing_installation: 'Sorry but we could not find an active installation for %s',
-    missing_repos:        'Sorry but we could not find any repositories to migrate',
-    request_failed:       "Sorry but a request %s failed, please check your auth token. (%i: %s)",
-  }
-
-  URIS = {
-    travis: {
-      installation: 'https://api.travis-ci.com/owner/%s?include=owner.installation',
-      repositories: 'https://api.travis-ci.com/owner/%s/repos?repository.active=true&repository.managed_by_installation=false&limit=%i&offset=%i'
-    },
-    github: {
-      installation_repos: 'https://api.github.com/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
-
-  def initialize(*)
-    super
-    to_h.keys.each do |key|
-      abort "#{USAGE}\nNo #{key} given" unless send(key)
-    end
-  end
-
-  def run
-    msg :start, owner_name
-    validate
-    migrate_repos
-    msg :done
-  end
-
-  private
-
-    def installation
-      @installation ||= fetch_installation
-    end
-
-    def repos
-      @repos ||= fetch_repos
-    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)
-      uri = uri(:github, :installation_repos, repo['github_id'], installation['github_id'])
-      request(:put, uri, headers(:github))
-      msg :migrated_repo, repo['name']
-    end
-
-    def fetch_installation
-      uri = uri(:travis, :installation, 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, owner_name, PER_PAGE, offset)
-      data   = request(:get, uri, headers(:travis))
-      repos += data['repositories'].map { |repo| only(repo, 'name', 'github_id') }
-      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)
-      res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
-        http.request(req)
-      end
-      error :request_failed, uri, res.code, res.body unless res.is_a?(Net::HTTPSuccess)
-      JSON.parse(res.body) if method == :get
-    end
-
-    def error(key, *args)
-      abort MSGS[key] % args
-    end
-
-    def msg(key, *args)
-      puts MSGS[key] % args
-    end
-
-    def only(hash, *keys)
-      hash.select { |key, _| keys.include?(key) }
-    end
-end
+require 'travis_migrate_to_apps/cli'

metadata

@@ -1,27 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: travis_migrate_to_apps
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.5
 platform: ruby
 authors:
 - Travis CI
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-28 00:00:00.000000000 Z
+date: 2022-01-20 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: []
+executables:
+- travis_migrate_to_apps
 extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
-- Gemfile.lock
 - LICENSE.md
+- README.md
 - bin/travis_migrate_to_apps
+- lib/colors.rb
 - lib/travis_migrate_to_apps.rb
+- lib/travis_migrate_to_apps/cli.rb
 - lib/travis_migrate_to_apps/version.rb
 homepage: https://github.com/travis-ci/travis_migrate_to_apps
 licenses:
@@ -42,8 +45,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Migrate your GitHub organizations to use the Travis CI GitHub App integration

data/Gemfile.lock

@@ -1,44 +0,0 @@
-PATH
-  remote: .
-  specs:
-    travis_migrate_to_apps (0.0.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.3)
-    hashdiff (0.3.7)
-    public_suffix (3.0.2)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    safe_yaml (1.0.4)
-    webmock (3.3.0)
-      addressable (>= 2.3.6)
-      crack (>= 0.3.2)
-      hashdiff
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  rspec
-  travis_migrate_to_apps!
-  webmock
-
-BUNDLED WITH
-   1.16.1