code_review_notifier 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: edabbf2ed573f0042d93ae9559b8345bfa2b4ad697db78b43a1d6e736d06355e
+  data.tar.gz: 5b9be1ccc0d16556a7045e4b639ae809c9afea160461581b9bf6dd95cb137bae
+SHA512:
+  metadata.gz: 567ac263894da8edae616278d2d558b9efce9f29987f24feb5497447b4d49f8328aa35beefff1c51c244ea1cc01b33c5445c441a485f50d056ed2b12c82e3926
+  data.tar.gz: 9f89909ef2d81828fb9d06b4e0d9a5bcb418b45c3814a584bd0845cafba0f4fc26d4c6a064d6deb7eab8e96aa99e21086a465f9892b90d10f4013e1a6d231606

data/Brewfile

@@ -0,0 +1,2 @@
+brew 'sqlite'
+brew 'terminal-notifier'

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem "sqlite3"
+gem "httparty"

data/bin/code_review_notifier

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'code_review_notifier'
+
+CodeReviewNotifier.call(ARGV)

data/lib/api.rb

@@ -0,0 +1,7 @@
+require_relative "./gerrit_api.rb"
+
+class Api
+  def self.current_api
+    GerritApi
+  end
+end

data/lib/base_api.rb

@@ -0,0 +1,62 @@
+require "httparty"
+require_relative "./gerrit_api.rb"
+
+class HTTParty::Parser
+  def json
+    JSON.parse(body.gsub(")]}'", ""))
+  end
+end
+
+class BaseApi
+  include HTTParty
+
+  def self.authenticate
+    raise NotImplementedError
+  end
+
+  def self.all_code_changes
+    raise NotImplementedError
+  end
+
+  def self.favicon
+    raise NotImplementedError
+  end
+
+  def self.code_change_url(code_change)
+    raise NotImplementedError
+  end
+
+  def self.wrap_with_authentication(&block)
+    res = block.call
+    if res.code == 401 || res.code == 403
+      self.authenticate
+      block.call
+    else
+      res
+    end
+  end
+
+  def self.is_setup?
+    base_api_url && username && password && account_id
+  end
+
+  def self.base_api_url
+    @base_api_url ||= begin
+                        url = DB.get_setting("base_api_url")
+                        base_uri(url)
+                        url
+                      end
+  end
+
+  def self.username
+    @username ||= DB.get_setting("username")
+  end
+
+  def self.password
+    @password ||= DB.get_setting("password")
+  end
+
+  def self.account_id
+    @account_id ||= DB.get_setting("account_id")
+  end
+end

data/lib/cipher.rb

@@ -0,0 +1,31 @@
+require "base64"
+require "openssl"
+require "digest/sha1"
+
+KEY = ""
+
+class Cipher
+  def self.encrypt(text)
+    cipher = OpenSSL::Cipher.new("aes-256-cbc")
+    cipher.encrypt
+    key = Digest::SHA1.hexdigest("yourpass")[0..31]
+    iv = cipher.random_iv
+    cipher.key = key
+    cipher.iv = iv
+    encrypted = cipher.update(text)
+    encrypted << cipher.final
+    ["#{key}:#{Base64.encode64(iv).encode('utf-8')}", Base64.encode64(encrypted).encode('utf-8')]
+  end
+
+  def self.decrypt(encrypted, salt)
+    key, iv = salt.split(":")
+    iv = Base64.decode64(iv.encode('ascii-8bit'))
+    cipher = OpenSSL::Cipher.new("aes-256-cbc")
+    cipher.decrypt
+    cipher.key = key
+    cipher.iv = iv
+    decrypted = cipher.update(Base64.decode64(encrypted.encode('ascii-8bit')))
+    decrypted << cipher.final
+    decrypted
+  end
+end

data/lib/code_review_notifier.rb

@@ -0,0 +1,62 @@
+require "io/console"
+require_relative "./api.rb"
+require_relative "./notifier.rb"
+
+SECONDS_BETWEEN_RUNS = 120
+SECONDS_BETWEEN_NOTIFICATIONS = 5
+
+class CodeReviewNotifier
+  def self.setup(args)
+    system("mkdir -p ~/.code_review_notifier")
+    system("brew bundle --file #{File.expand_path(File.dirname(__FILE__) + "/..")}/Brewfile")
+
+    if args[0] == "--setup" || !Api.current_api.is_setup?
+      print("What's the base URL? (i.e. https://gerrit.google.com) ")
+      DB.save_setting("base_api_url", STDIN.gets.chomp, is_secret: false)
+
+      print("What's the account username? ")
+      DB.save_setting("username", STDIN.gets.chomp, is_secret: false)
+
+      print("What's the account password? (hiding input) ")
+      DB.save_setting("password", STDIN.noecho(&:gets).chomp, is_secret: true)
+      puts
+
+      print("What's the account id? (check #{Api.current_api.base_api_url}/settings/) ")
+      DB.save_setting("account_id", STDIN.gets.chomp, is_secret: false)
+
+      puts("All setup!")
+    end
+  end
+
+  def self.call(args)
+    setup(args)
+
+    while true
+      is_first_run = is_first_run?
+      puts
+      puts("Querying API...")
+      all_code_changes = Api.current_api.all_code_changes
+      puts("Checking for notifications to display...")
+      all_activity = []
+      all_code_changes.each do |cc|
+        activity_for_code_change = cc.code_change_activity
+        activity_for_code_change.sort! { |a, b| a.created_at <=> b.created_at }
+        cc.activity_from_self_at = activity_for_code_change.find { |a| a.is_self }&.created_at
+        all_activity.concat(activity_for_code_change)
+      end
+      all_activity.select(&:should_notify?).each do |code_change_activity|
+        code_change_activity.notified
+        unless is_first_run
+          puts("Notifying of change!")
+          Notifier.notify(code_change_activity)
+          sleep SECONDS_BETWEEN_NOTIFICATIONS
+        end
+      end
+      sleep SECONDS_BETWEEN_RUNS
+    end
+  end
+
+  def self.is_first_run?
+    DB.query_single_row("SELECT id FROM code_change_activity_notified;").nil?
+  end
+end

data/lib/database.rb

@@ -0,0 +1,48 @@
+require "sqlite3"
+require_relative "./cipher.rb"
+
+class DB
+  def self.db
+    @db ||= begin
+              db = SQLite3::Database.new(File.expand_path("~/.code_review_notifier/data.db"))
+              migrate_if_needed(db)
+              db
+            end
+  end
+
+  def self.migrate_if_needed(db)
+    db.execute("CREATE TABLE IF NOT EXISTS code_change_activity_notified (id VARCHAR(50) PRIMARY KEY, notified_at TIMESTAMP);")
+    db.execute("CREATE TABLE IF NOT EXISTS settings (key VARCHAR(50) PRIMARY KEY, value TEXT, salt TEXT);")
+  end
+
+  def self.execute(sql)
+    db.execute(sql)
+  end
+
+  def self.query_single_row(sql)
+    db.execute(sql) do |row|
+      return row
+    end
+    return nil
+  end
+
+  def self.save_setting(key, value, is_secret:)
+    salt = "NULL"
+    if is_secret
+      salt, encrypted = Cipher.encrypt(value)
+      salt = "'#{salt}'"
+      value = encrypted
+    end
+    db.execute("DELETE FROM settings WHERE key = '#{key}';")
+    db.execute("INSERT INTO settings (key, value, salt) VALUES('#{key}', '#{value}', #{salt});")
+  end
+
+  def self.get_setting(key)
+    row = query_single_row("SELECT value, salt FROM settings WHERE key = '#{key}'")
+    if row && row[1]
+      Cipher.decrypt(row[0], row[1])
+    elsif row
+      row[0]
+    end
+  end
+end

data/lib/gerrit_api.rb

@@ -0,0 +1,45 @@
+require_relative "./base_api.rb"
+require_relative "./models/code_change.rb"
+require_relative "./models/code_change_activity.rb"
+
+class GerritApi < BaseApi
+  def self.authenticate
+    res = post("/login/", {
+      body: "username=#{username}&password=#{URI.escape(password)}&rememberme=1",
+      headers: {
+        "Content-Type" => "application/x-www-form-urlencoded",
+      },
+      follow_redirects: false
+    })
+    @token = res.headers["set-cookie"].match("GerritAccount=(.*?);")[1]
+    raise "Your username or password is incorrect. Trying running `code_review_notifier --setup` again." if @token.nil?
+  end
+
+  def self.all_code_changes
+    wrap_with_authentication do
+      get("/changes/?S=0&q=is%3Aopen%20owner%3Aself%20-is%3Awip%20-is%3Aignored%20limit%3A25&q=is%3Aopen%20owner%3Aself%20is%3Awip%20limit%3A25&q=is%3Aopen%20-owner%3Aself%20-is%3Awip%20-is%3Aignored%20reviewer%3Aself%20limit%3A25&q=is%3Aclosed%20-is%3Aignored%20%28-is%3Awip%20OR%20owner%3Aself%29%20%28owner%3Aself%20OR%20reviewer%3Aself%29%20-age%3A4w%20limit%3A10&o=DETAILED_ACCOUNTS&o=MESSAGES", {
+        headers: {
+          "Cookie" => "GerritAccount=#{@token};"
+        }
+      })
+    end.parsed_response.flat_map { |js| js.map { |j| code_change_from_json(j) } }
+  end
+
+  def self.code_change_from_json(json)
+    code_change = CodeChange.new(json["_number"].to_s, json["owner"]["name"], json["project"], json["subject"], Time.parse(json["updated"]).to_i)
+    code_change.code_change_activity = json["messages"].map { |m| code_change_activity_from_json(code_change, m) }
+    code_change
+  end
+
+  def self.code_change_activity_from_json(code_change, json)
+    CodeChangeActivity.new(json["id"].to_s, json["author"]["name"], json["author"]["_account_id"].to_s == account_id, json["message"], Time.parse(json["date"]), code_change)
+  end
+
+  def self.favicon
+    "#{base_api_url}/favicon.ico"
+  end
+
+  def self.code_change_url(code_change)
+    "#{base_api_url}/c/#{code_change.id}"
+  end
+end

data/lib/models/code_change.rb

@@ -0,0 +1,21 @@
+require "date"
+require_relative "../database.rb"
+
+class CodeChange
+  attr_accessor :code_change_activity
+  attr_reader :id, :owner, :project, :subject, :updated_at
+  attr_writer :activity_from_self_at
+
+  def initialize(id, owner, project, subject, updated_at)
+    @id = id
+    @owner = owner
+    @project = project
+    @subject = subject.gsub("'", "")
+    @updated_at = updated_at
+  end
+
+  def activity_from_self_at
+    raise "@activity_from_self_at is not set" unless instance_variable_defined?("@activity_from_self_at")
+    @activity_from_self_at
+  end
+end

data/lib/models/code_change_activity.rb

@@ -0,0 +1,47 @@
+MESSAGES_TO_IGNORE = [/Uploaded patch set 1/, /Build Started/, /owns \d+% of/]
+AUTHOR_TRANSLATIONS = {
+  "Service Cloud Jenkins" => "Jenkins",
+  /\w+ Gergich \(Bot\)/ => "Gergich"
+}
+
+class CodeChangeActivity
+  attr_reader :id, :author, :is_self, :message, :created_at, :code_change
+
+  def initialize(id, author, is_self, message, created_at, code_change)
+    @id = id
+    @author = CodeChangeActivity.translate_author(author)
+    @is_self = is_self
+    @message = CodeChangeActivity.translate_message(message)
+    @created_at = created_at
+    @code_change = code_change
+  end
+
+  def notified
+    DB.execute("INSERT INTO code_change_activity_notified (id, notified_at) VALUES('#{id}', CURRENT_TIMESTAMP);")
+  end
+
+  def should_notify?
+    !is_self &&
+      code_change.activity_from_self_at && created_at > code_change.activity_from_self_at &&
+      MESSAGES_TO_IGNORE.none? { |m| message.match(m) } &&
+      !DB.query_single_row("SELECT id FROM code_change_activity_notified WHERE id = '#{id}'")
+  end
+
+  def self.translate_author(author)
+    AUTHOR_TRANSLATIONS.keys.each do |pattern|
+      author.sub!(pattern, AUTHOR_TRANSLATIONS[pattern])
+    end
+    author
+  end
+
+  def self.translate_message(message)
+    message.sub(/^Patch Set \d+:\s+/, "")
+           .gsub("'", %q(\\\\\\\\'))
+           .gsub("\n", " ")
+           .gsub("  ", " ")
+           .gsub(">", "")
+           .sub(/^\(/, "\\(")
+           .sub(/^\[/, "\\[")
+           .sub(/^-/, "\\-")
+  end
+end

data/lib/notifier.rb

@@ -0,0 +1,14 @@
+require_relative './api.rb'
+
+class Notifier
+  def self.notify(code_change_activity)
+    code_change = code_change_activity.code_change
+    id = code_change.id
+    owner = code_change.owner
+    subject = code_change.subject
+
+    message = code_change_activity.message
+    author = code_change_activity.author
+    system("terminal-notifier -title '#{author}' -subtitle '#{owner}: #{subject}' -message '#{message}' -appIcon #{Api.current_api.favicon} -open '#{Api.current_api.code_change_url(code_change)}'")
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: code_review_notifier
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kyle Grinstead
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-07 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: kyleag@hey.com
+executables:
+- code_review_notifier
+extensions: []
+extra_rdoc_files: []
+files:
+- Brewfile
+- Gemfile
+- bin/code_review_notifier
+- lib/api.rb
+- lib/base_api.rb
+- lib/cipher.rb
+- lib/code_review_notifier.rb
+- lib/database.rb
+- lib/gerrit_api.rb
+- lib/models/code_change.rb
+- lib/models/code_change_activity.rb
+- lib/notifier.rb
+homepage: https://rubygems.org/gems/code_review_notifier
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/MrGrinst/code_review_notifier
+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.7.6.2
+signing_key: 
+specification_version: 4
+summary: Get notifications when updates happen to patch sets/pull requests!
+test_files: []