github_labeler 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 21e8c495727bbb1dedeb2c52ece44b3def6c0290
+  data.tar.gz: d18b4d9bf033db40d62841716d26515e7a147655
+SHA512:
+  metadata.gz: e60f2a3d8177b3ff85229decb3ddab4f72dd681991fb6b38235cc267390974576b47ce014ebf58c8466c2627618df03d022c823dc18f8b44dec3fe0aa2123ef7
+  data.tar.gz: 7b8a60e750fc95e5b233898c54e4baf2d674511c3d2c5ce1e5ea652dedccc5014ebfb8f42756ab9001342361df5eb4c026e8161bb5e23c0125cb572427cf7d2b

data/bin/github_labeler

@@ -0,0 +1,288 @@
+#!/usr/bin/env ruby
+
+require "commander"
+require "json"
+require "github_labeler"
+
+ARGV.push('-h') if ARGV.empty?
+
+cli = HighLine.new($stdin, $stderr)
+
+Commander.configure do
+  program :name, 'GitHub Labeler'
+  program :version, '0.1.0'
+  program :description, 'Simple program for managing issue labels across GitHub repositories.'
+
+  global_option '--verbose', "Enable output of detailed debugging information to STDERR"
+  global_option '--execute', "Execute changes immediately, without asking for confirmation"
+  global_option '--token STRING', String, "GitHub OAuth token for making API calls. If not specified, the GITHUB_OAUTH_TOKEN environment variable is used. Create a token here: https://github.com/settings/token"
+
+  command :duplicate do |c|
+    c.syntax = 'github_labeler duplicate [options]'
+    c.description = 'Duplicate labels from one repository to another'
+
+    c.option '-s', '--source STRING', String, '(required) Source repository to copy labels from (USER/REPO)'
+    c.option '-d', '--destination STRING', String, '(required) Destination repository to copy labels to (USER/REPO), or name of JSON file with list of repositories'
+
+    c.example "Destination is repository name", "github_labeler duplicate -s github/linguist -d foo/bar"
+    c.example "Destinations are specified in JSON file", "github_labeler duplicate -s github/linguist -d dest.json"
+
+    c.action do |args, options|
+      options.default \
+        :verbose => false,
+        :execute => false,
+        :token => ENV["GITHUB_OAUTH_TOKEN"]
+
+      raise ArgumentError.new("Token is required") unless options.token
+      raise ArgumentError.new("Source is required") unless options.source
+      raise ArgumentError.new("Destination is required") unless options.destination
+
+      labeler = GitHubLabeler.new(options.token, options.verbose)
+      destination = File.file?(options.destination) ? JSON.parse(IO.read(options.destination), {:symbolize_names => true}) : [options.destination]
+      changes = labeler.duplicate_labels_from_repo(options.source, destination)
+
+      puts JSON.pretty_generate(changes)
+
+      if changes.size == 0
+        cli.say("No changes to execute.")
+      elsif options.execute or cli.agree("Execute #{changes.size} changes? [y/n]")
+        labeler.execute_changes(changes)
+      end
+
+      cli.say("Done!")
+    end
+  end
+
+  command :export do |c|
+    c.syntax = 'github_labeler export [options]'
+    c.description = 'Export a list of labels from a repository or list of repositories'
+
+    c.option '-r', '--repo STRING', String, '(required) Repository from which to extract labels (USER/REPO)'
+
+    c.example "Repository is repository name", "github_labeler export -r foo/bar"
+
+    c.action do |args, options|
+      options.default \
+        :verbose => false,
+        :execute => false,
+        :token   => ENV["GITHUB_OAUTH_TOKEN"]
+
+      raise ArgumentError.new("Token is required") unless options.token
+      raise ArgumentError.new("Repo is required") unless options.repo
+      raise ArgumentError.new("Token is required") unless options.token
+
+      labeler = GitHubLabeler.new(options.token, options.verbose)
+      labels = labeler.export_labels_from_repo(options.repo)
+
+      puts JSON.pretty_generate(labels)
+
+      cli.say("Done!")
+    end
+  end
+
+  command :execute do |c|
+    c.syntax = 'github_labeler execute [options]'
+    c.description = 'Execute changes previously created by the program'
+
+    c.option '-c', '--changes STRING', String, '(required) Name of JSON file with list of changes'
+
+    c.example "Changes are specified in JSON file", "github_labeler export -c changes.json"
+
+    c.action do |args, options|
+      options.default \
+        :verbose => false,
+        :execute => false,
+        :token   => ENV["GITHUB_OAUTH_TOKEN"]
+
+      raise ArgumentError.new("Token is required") unless options.token
+      raise ArgumentError.new("Changes are required") unless options.changes
+
+      labeler = GitHubLabeler.new(options.token, options.verbose)
+      changes = JSON.parse(IO.read(options.changes), {:symbolize_names => true})
+      result = labeler.execute_changes(changes)
+
+      puts JSON.pretty_generate(result)
+
+      cli.say("Done!")
+    end
+  end
+
+  command :add do |c|
+    c.syntax = 'github_labeler add [options]'
+    c.description = 'Add one or more label to one or more repositories'
+
+    c.option '-l', '--labels STRING', String, '(required) Label (NAME#COLOR) or name of JSON file with list of labels'
+    c.option '-r', '--repos STRING', String, '(required) Destination repository to add labels to (USER/REPO) or name of JSON file with list of repositories'
+
+    c.example "Label is a string and destination repo is repository name", "github_labeler add -r github/linguist -l api#c7def8"
+    c.example "Labels and repositories are specified in JSON files", "github_labeler add -r repos.json -l labels.json"
+
+    c.action do |args, options|
+      options.default \
+        :verbose => false,
+        :execute => false,
+        :token   => ENV["GITHUB_OAUTH_TOKEN"]
+
+      raise ArgumentError.new("Token is required") unless options.token
+      raise ArgumentError.new("Labels are required") unless options.labels
+      raise ArgumentError.new("Repos are required") unless options.repos
+
+      labeler = GitHubLabeler.new(options.token, options.verbose)
+      repos = File.file?(options.repos) ? JSON.parse(IO.read(options.repos), {:symbolize_names => true}) : [options.repos]
+      labels = options.labels
+
+      if File.file?(options.labels)
+        labels = JSON.parse(IO.read(options.labels), {:symbolize_names => true})
+      else
+        label_name, label_color = labels.split("#")
+        labels = [{:name => label_name, :color => label_color}]
+      end
+
+      changes = labeler.add_labels_to_repos(repos, labels)
+
+      puts JSON.pretty_generate(changes)
+
+      if changes.size == 0
+        cli.say("No changes to execute.")
+      elsif options.execute or cli.agree("Execute #{changes.size} changes? [y/n]")
+        labeler.execute_changes(changes)
+      end
+
+      cli.say("Done!")
+    end
+  end
+
+  command :delete do |c|
+    c.syntax = 'github_labeler delete [options]'
+    c.description = 'Delete one or more label from one or more repositories'
+
+    c.option '-l', '--labels STRING', String, '(required) Label (NAME) or name of JSON file with list of labels'
+    c.option '-r', '--repos STRING', String, '(required) Destination repository to delete labels from (USER/REPO) or name of JSON file with list of repositories'
+
+    c.example "Label is a string and destination repo is repository name", "github_labeler delete -r github/linguist -l api"
+    c.example "Labels and repositories are specified in JSON files", "github_labeler delete -r repos.json -l labels.json"
+
+    c.action do |args, options|
+      options.default \
+        :verbose => false,
+        :execute => false,
+        :token   => ENV["GITHUB_OAUTH_TOKEN"]
+
+      raise ArgumentError.new("Token is required") unless options.token
+      raise ArgumentError.new("Labels are required") unless options.labels
+      raise ArgumentError.new("Repos are required") unless options.repos
+
+      labeler = GitHubLabeler.new(options.token, options.verbose)
+      repos = File.file?(options.repos) ? JSON.parse(IO.read(options.repos), {:symbolize_names => true}) : [options.repos]
+      labels = options.labels
+
+      if File.file?(options.labels)
+        labels = JSON.parse(IO.read(options.labels), {:symbolize_names => true})
+      else
+        labels = [{:name => labels, :color => nil}]
+      end
+
+      changes = labeler.delete_labels_from_repos(repos, labels)
+
+      puts JSON.pretty_generate(changes)
+
+      if changes.size == 0
+        cli.say("No changes to execute.")
+      elsif options.execute or cli.agree("Execute #{changes.size} changes? [y/n]")
+        labeler.execute_changes(changes)
+      end
+
+      cli.say("Done!")
+    end
+  end
+
+  command :rename do |c|
+    c.syntax = 'github_labeler rename [options]'
+    c.description = 'Rename one or more labels in one or more repositories'
+
+    c.option '-l', '--labels STRING', String, '(required) Label (OLDNAME/NEWNAME) or name of JSON file with list of labels'
+    c.option '-r', '--repos STRING', String, '(required) Destination repository to rename labels in (USER/REPO) or name of JSON file with list of repositories'
+
+    c.example "Label is a string and destination repo is repository name", "github_labeler rename -r github/linguist -l design/ui"
+    c.example "Labels and repositories are specified in JSON files", "github_labeler rename -r repos.json -l labels.json"
+
+    c.action do |args, options|
+      options.default \
+        :verbose => false,
+        :execute => false,
+        :token   => ENV["GITHUB_OAUTH_TOKEN"]
+
+      raise ArgumentError.new("Token is required") unless options.token
+      raise ArgumentError.new("Labels are required") unless options.labels
+      raise ArgumentError.new("Repos are required") unless options.repos
+
+      labeler = GitHubLabeler.new(options.token, options.verbose)
+      repos = File.file?(options.repos) ? JSON.parse(IO.read(options.repos), {:symbolize_names => true}) : [options.repos]
+      labels = options.labels
+
+      if File.file?(options.labels)
+        labels = JSON.parse(IO.read(options.labels), {:symbolize_names => true})
+      else
+        old_name, new_name = labels.split("/")
+        labels = [{:name => old_name, :new_name => new_name}]
+      end
+
+      changes = labeler.rename_labels_in_repos(repos, labels)
+
+      puts JSON.pretty_generate(changes)
+
+      if changes.size == 0
+        cli.say("No changes to execute.")
+      elsif options.execute or cli.agree("Execute #{changes.size} changes? [y/n]")
+        labeler.execute_changes(changes)
+      end
+
+      cli.say("Done!")
+    end
+  end
+
+  command :recolor do |c|
+    c.syntax = 'github_labeler recolor [options]'
+    c.description = 'Recolor one or more labels in one or more repositories'
+
+    c.option '-l', '--labels STRING', String, '(required) Label (NAME#COLOR) or name of JSON file with list of labels'
+    c.option '-r', '--repos STRING', String, '(required) Destination repository to recolor labels in (USER/REPO) or name of JSON file with list of repositories'
+
+    c.example "Label is a string and destination repo is repository name", "github_labeler recolor -r github/linguist -l api#c7def8"
+    c.example "Labels and repositories are specified in JSON files", "github_labeler recolor -r repos.json -l labels.json"
+
+    c.action do |args, options|
+      options.default \
+        :verbose => false,
+        :execute => false,
+        :token   => ENV["GITHUB_OAUTH_TOKEN"]
+
+      raise ArgumentError.new("Token is required") unless options.token
+      raise ArgumentError.new("Labels are required") unless options.labels
+      raise ArgumentError.new("Repos are required") unless options.repos
+
+      labeler = GitHubLabeler.new(options.token, options.verbose)
+      repos = File.file?(options.repos) ? JSON.parse(IO.read(options.repos), {:symbolize_names => true}) : [options.repos]
+      labels = options.labels
+
+      if File.file?(options.labels)
+        labels = JSON.parse(IO.read(options.labels), {:symbolize_names => true})
+      else
+        label_name, label_color = labels.split("#")
+        labels = [{:name => label_name, :color => label_color}]
+      end
+
+      changes = labeler.recolor_labels_in_repos(repos, labels)
+
+      puts JSON.pretty_generate(changes)
+
+      if changes.size == 0
+        cli.say("No changes to execute.")
+      elsif options.execute or cli.agree("Execute #{changes.size} changes? [y/n]")
+        labeler.execute_changes(changes)
+      end
+
+      cli.say("Done!")
+    end
+  end
+end

data/lib/github_labeler.rb

@@ -0,0 +1,298 @@
+require "json"
+require "logger"
+require "Octokit"
+
+Octokit.auto_paginate = true
+
+class GitHubLabeler
+  attr_accessor :client,          # Octokit client for acesing the API
+                :repo_labels,     # Labels cache for repositories
+                :logger           # Logger for writing debugging info
+
+  def initialize(token, verbose=false, labels=nil)
+    @logger = Logger.new(STDERR)
+    @logger.sev_threshold = verbose ? Logger::DEBUG : Logger::WARN
+
+    @logger.debug "Creating new GitHubLabeler instance."
+
+    @logger.debug "Creating a new Octokit client with token #{token[0..5]}"
+
+    begin
+      @client = Octokit::Client.new(:access_token => token)
+      @client.rate_limit
+    rescue Octokit::Unauthorized => exception
+      @logger.error "Token #{token[0..5]} is not valid"
+      raise ArgumentError.new("Token #{token[0..5]} is not valid")
+    end
+
+    @logger.debug "Token #{token[0..5]} is valid"
+
+    @repo_labels = !labels.nil? ? labels : {}
+  end
+
+  #
+  # Checks if the remaining rate limit allows us to make the specified number of
+  # changes
+  #
+  def is_remaining_rate_limit_sufficient?(expected_number_of_calls)
+    remaining_limit = @client.rate_limit.remaining
+
+    @logger.debug "There are #{expected_number_of_calls} API calls to be made, and the remaining API rate limit quota is #{remaining_limit}."
+
+    return expected_number_of_calls <= @client.rate_limit.remaining
+  end
+
+  #
+  # Executes a list of label changes. Each change has the following format:
+  #
+  # {
+  #   :type => "update/create/delete",
+  #   :repo => "testrename/testing",
+  #   :label => {:color => "fc2929", :name => "design", :new_name => "ui"}
+  # }
+  #
+  def execute_changes(changes, options = {})
+    @logger.debug "Executing changes"
+
+    if !is_remaining_rate_limit_sufficient?(changes.size)
+      @logger.error "Remaining rate limit is not enough to make all changes. Wait for the limit to refresh and try again."
+      return []
+    end
+
+    changes = validate_changes(changes, options)
+
+    changes.each do |change|
+      @logger.debug "Executing change: #{change_string(change)}"
+
+      if change[:type] == "add"
+        success = @client.add_label(change[:repo], change[:label][:name], change[:label][:color])
+
+        if !@repo_labels[change[:repo]].nil?
+          @repo_labels[change[:repo]][success[:name].downcase] = {:name => success[:name], :color => success[:color]}
+        end
+
+        @logger.debug "Change succeded"
+        next
+      end
+
+      if change[:type] == "update"
+        new_label = {:name => change[:label][:new_name] || change[:label][:name]}
+        if !change[:label][:color].nil?
+          new_label[:color] = change[:label][:color]
+        end
+
+        success = @client.update_label(change[:repo], change[:label][:name], new_label)
+
+        if !@repo_labels[change[:repo]].nil?
+          @repo_labels[change[:repo]][success[:name].downcase] = {:name => success[:name], :color => success[:color]}
+        end
+
+        @logger.debug "Change succeded"
+        next
+      end
+
+      if change[:type] == "delete"
+        success = @client.delete_label!(change[:repo], change[:label][:name])
+
+        if !@repo_labels[change[:repo]].nil?
+          @repo_labels[change[:repo]][change[:label][:name].downcase] = nil
+        end
+
+        @logger.debug "Change succeded"
+        next
+      end
+    end
+
+    @logger.debug "Done executing changes"
+
+    return changes
+  end
+
+  #
+  # Updates repo labels cache for a specific label
+  #
+  def update_repos_labels_cache(repo, label)
+    @repo_labels[change[:repo]][change[:label][:name].downcase] = success
+  end
+
+  #
+  # Validates changes by merging multiple updates into one, removing
+  # duplicates, detecting conflicts, etc.
+  #
+  def validate_changes(changes, options = {})
+    return changes.sort_by { |hsh| [hsh["repo"], hsh["type"]] }
+  end
+
+  #
+  # Create changes for adding a list of labels to a list of repos
+  #
+  def add_labels_to_repos(repos, labels, options = {})
+    @logger.debug "Adding labels to repositories"
+    return process_labels_for_repos(repos, labels, method(:add_label_to_repo), options)
+  end
+
+  #
+  # Create changes for deleting a list of labels from a list of repos
+  #
+  def delete_labels_from_repos(repos, labels, options = {})
+    @logger.debug "Deleting labels from repositories"
+    return process_labels_for_repos(repos, labels, method(:delete_label_from_repo), options)
+  end
+
+  #
+  # Create changes for renaming a list of labels in a list of repos
+  #
+  def rename_labels_in_repos(repos, labels, options = {})
+    @logger.debug "Renaming labels in repositories"
+    return process_labels_for_repos(repos, labels, method(:rename_label_in_repo), options)
+  end
+
+  #
+  # Create changes for recoloring a list of labels in a list of repos
+  #
+  def recolor_labels_in_repos(repos, labels, options = {})
+    @logger.debug "Recoloring labels in repositories"
+    return process_labels_for_repos(repos, labels, method(:recolor_label_in_repo), options)
+  end
+
+  #
+  # Generic creation of changes for list of labels and list of repos
+  #
+  def process_labels_for_repos(repos, labels, change_creator, options = {})
+    if !is_remaining_rate_limit_sufficient?(repos.size)
+      @logger.error "Rate limit is not enough to process all labels in repositories"
+      return nil
+    end
+
+    changes = []
+
+    for repo in repos
+      repo_name = repo if repo.instance_of?(String)
+      repo_name = repo[:full_name] if repo.instance_of?(Hash)
+
+      @logger.debug "Processing labels for repository #{repo_name}"
+
+      refresh_repo_labels(repo_name, options)
+
+      for label in labels
+        @logger.debug "Processing label #{label[:name]}"
+        change = change_creator.call(repo_name, label, options)
+        changes << change if !change.nil?
+      end
+    end
+
+    return changes
+  end
+
+  #
+  # Fetches the list of labels in a repository and stores them
+  # in the labels cache
+  #
+  def refresh_repo_labels(repo, options = {})
+    @logger.debug "Fetching label information for #{repo}"
+
+    @repo_labels[repo] = {}
+    @client.labels(repo).each do |label|
+      @repo_labels[repo][label[:name].downcase] = label
+    end
+  end
+
+  #
+  # Create a single change for adding a label to a repo
+  #
+  def add_label_to_repo(repo, label, options = {})
+    existing_label = @repo_labels[repo][label[:name].downcase]
+
+    if existing_label
+      if existing_label[:color] != label[:color] or existing_label[:name] != label[:name]
+        @logger.warn "Label #{label[:name]} already exist, creating an update"
+        return { :type => "update", :repo => repo, :label => label }
+      end
+    else
+      return { :type => "add", :repo => repo, :label => label }
+    end
+
+    @logger.warn "Label #{label[:name]} already exist and is the same. No change created"
+    return nil
+  end
+
+  #
+  # Create a single change for deleting a label from a repo
+  #
+  def delete_label_from_repo(repo, label, options = {})
+    existing_label = @repo_labels[repo][label[:name].downcase]
+
+    if existing_label
+      return { :type => "delete", :repo => repo, :label => label }
+    end
+
+    @logger.warn "Label #{label[:name]} doesn't exist. No change created"
+    return nil
+  end
+
+  #
+  # Create a single change for renaming a label in a repo
+  #
+  def rename_label_in_repo(repo, label, options = {})
+    existing_label = @repo_labels[repo][label[:name].downcase]
+
+    if existing_label
+      if label[:new_name] and label[:new_name] != label[:name]
+        return { :type => "update", :repo => repo, :label => label }
+      end
+    else
+      @logger.warn "Label #{label[:name]} doesn't exist. Creating a create change"
+      newLabel = {:name => label[:new_name], :color => label[:color]}
+      return { :type => "add", :repo => repo, :label => newLabel }
+    end
+
+    @logger.warn "Label #{label[:name]} exist and is the same. No change created"
+    return nil
+  end
+
+  #
+  # Create a single change for recoloring a label in a repo
+  #
+  def recolor_label_in_repo(repo, label, options = {})
+    existing_label = @repo_labels[repo][label[:name].downcase]
+
+    if existing_label
+      if existing_label[:color] != label[:color]
+        return { :type => "update", :repo => repo, :label => label }
+      end
+    else
+      @logger.warn "Label #{label[:name]} doesn't exist. Creating a create change"
+      return { :type => "add", :repo => repo, :label => label }
+    end
+
+    @logger.warn "Label #{label[:name]} exist and is the same. No change created"
+    return nil
+  end
+
+  #
+  # Creates changes for duplicating labels from one repo to other repos
+  #
+  def duplicate_labels_from_repo(repo_source, repos_end, options = {})
+    @logger.debug "Duplicating labels from repo #{repo_source}"
+    source_repo_labels = export_labels_from_repo(repo_source, options)
+    return add_labels_to_repos(repos_end, source_repo_labels, options)
+  end
+
+  #
+  # Fetches a list of labels for a repository
+  #
+  def export_labels_from_repo(repo, options = {})
+    @logger.debug "Exporting labels from repo #{repo}"
+
+    @client.labels(repo).map do |label|
+      { :name => label[:name], :color => label[:color] }
+    end
+  end
+
+  #
+  # Get a human readable string representation of a change
+  #
+  def change_string(change, options = {})
+    return "#{change[:repo]} - #{change[:type]} - #{change[:label][:name]} - color: #{change[:label][:color]} - new_name: #{change[:label][:new_name]}"
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: github_labeler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ivan Zuzak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: 
+email: izuzak@gmail.com
+executables:
+- github_labeler
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/github_labeler
+- lib/github_labeler.rb
+homepage: https://github.com/izuzak/github_labeler
+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.2.3
+signing_key: 
+specification_version: 4
+summary: Utility for running actions on issue labels in groups of GitHub repositories
+test_files: []