github-auto-locker 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc9273f3326183b6f148ea285e832a062f41ecbf
+  data.tar.gz: 8bd1bc2c80f9974e6e693283dc275d6d071cfb52
+SHA512:
+  metadata.gz: abea29689d9933d08b0df9ffcbe5ed03a4d973bb951143530ebd36ac828bc7b4d5cd0104ce2cf921127f6ddc03b0b292ac062860702fc92cc007bd55a64bded9
+  data.tar.gz: 7cee629c8db329bf402bf34e9e6bed026bdaaca098b3561a3bfabc7b29e5dc1157dea0cbc5588de495491ad4d4173b9dbb8dce5181b49fe6684ee25f325777bb

data/README.md

@@ -0,0 +1,20 @@
+## GitHub AutoLocker
+
+Automatically locks old GitHub issues that have already been closed.
+
+By default it locks closed issues that are over 120 days old.
+
+### Usage
+
+This requires Ruby.
+
+* Clone or download repo
+* Run `./bin/github-auto-locker USER REPO TOKEN [age in days]`
+
+The age is optional.
+
+`TOKEN` is a personal access token from [here](https://github.com/settings/tokens). It will require the 'repo' scope.
+
+### License
+
+MIT

data/bin/github-auto-locker

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require_relative '../lib/locker'
+
+abort "Usage: auto-lock [user] [repo] [token] [days]" unless ARGV[2]
+
+Locker.new(ARGV[0], ARGV[1], ARGV[2], ARGV[3] || 120).lock

data/lib/locker.rb

@@ -0,0 +1,106 @@
+require 'json'
+require 'date'
+require 'net/http'
+require 'base64'
+
+# Automatically locks old issues that have been closed already
+class Locker
+  def initialize user, repo, token, old_days = 120
+    @user = user
+    @repo = repo
+    @token = token
+    @old_days = old_days
+  end
+
+  # Locks old closed issues
+  def lock
+    notify "Getting closed issues..."
+    issues = get_closed_issues
+
+    if issues.empty?
+      notify "No issues to lock"
+    else
+      notify "Received #{issues.length} issues"
+      notify "Locking old closed issues..."
+      lock_old_closed_issues issues
+    end
+  end
+
+  # Fetches all closed, unlocked issues closed before cutoff date
+  def get_closed_issues
+    issues = []
+    path = "/repos/#@user/#@repo/issues?state=closed&access_token=#@token&sort=updated&direction=asc"
+    page = 1
+    http = Net::HTTP.start("api.github.com", 443, nil, nil, nil, nil, use_ssl: true)
+
+    loop do
+      notify "Retrieving page #{page}..."
+
+      resp = http.get(path)
+      new_issues = JSON.parse(resp.body)
+      issues += new_issues
+
+      # Pagination
+      if resp['Link'].match /<https:\/\/api\.github\.com(\/[^>]+)>; rel="next",/
+        path = $1
+        page = path.match(/page=(\d+)/)[1]
+      else
+        http.finish
+        break
+      end
+    end
+
+    cutoff_date = (Date.today - @old_days).iso8601
+
+    issues.reject do |issue|
+      issue["locked"] or
+        issue["closed_at"] > cutoff_date
+    end
+  end
+
+  # Expects array of issues from API call
+  def lock_old_closed_issues issues
+    headers = {'Accept' => 'application/vnd.github.the-key-preview+json', # required for new lock API
+               'Content-Length' => '0', # required for PUT with no body
+               'Authorization' => "Basic #{Base64.strict_encode64("#@user:#@token")}"}
+
+    Net::HTTP.start("api.github.com", 443, nil, nil, nil, nil, use_ssl: true) do |http|
+      total = issues.length
+
+      issues.each_with_index do |issue, i|
+        number = issue['number']
+        locking number, i, total
+
+        path = issue["url"][22..-1] # pull path from full URL
+        response = http.put("#{path}/lock", '', headers)
+
+        if response.code == "204" # 204 means it worked, apparently
+          locked
+        else
+          error response.inspect
+        end
+      end
+    end
+  end
+
+  # Print locking message
+  def locking number, item, total
+    print "[INFO] Locking #{number} (#{item + 1}/#{total})..."
+  end
+
+  # Print locked message
+  def locked
+    puts 'locked!'
+  end
+
+  # Print INFO message
+  def notify message
+    puts "[INFO] #{message}"
+  end
+
+  # Print ERROR message
+  def error message
+    warn "[ERROR] #{message}"
+  end
+end
+

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: github-auto-locker
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Justin Collins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-13 00:00:00.000000000 Z
+dependencies: []
+description: "Automatically locks GitHub issues older than a specified number of days.\nThis
+  forces people to open new issues instead of attaching themselves to old (typically
+  unrelated) issues. \n"
+email: 
+executables:
+- github-auto-locker
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/github-auto-locker
+- lib/locker.rb
+homepage: https://github.com/presidentbeef/github-auto-locker
+licenses: []
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Simple script to lock closed GitHub issues over a certain age.
+test_files: []