code_review_notifier 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69b61c9f19daf4e8a85cfef15ffe035d232a5352a7240b326fadc8930b85bf9f
-  data.tar.gz: 1e2f0b33a43e4db336fc20a2ee99a9c5e79b3da9856f48b15ac04daa87f180fd
+  metadata.gz: 308e660e0f67acffeca0e216ed7ed61da80fd095053c980aef42ec958cd4896e
+  data.tar.gz: 909a4d189606fc053d8e08684873d79492adec0f2798b4cf2686e608e55b9025
 SHA512:
-  metadata.gz: 3fe2b9b7ef4e7b40b2e8e3581ba8ba73b7e8c93686a32c93be4f5dfd6ab9534c7aaf8016d59994ebd9bd7ec45df9260d62e91d000ba459425309b8dd2eecd5d4
-  data.tar.gz: f79a7ab782fd1f7d73fb6ceead88144523cb39ea7cb7228563ff2393d7941bf296083af15e66ac563dd41d8ffffa4ee65fcba82781e7d59b891d4020ad93f34b
+  metadata.gz: e329b52cc09b78df230a7ee383d0ad796a746cc6283a1704aadf38fedcaf5590a51b338036c369ff233d60541627229bdb0bfb39e124e636660c2c7dc5249b3f
+  data.tar.gz: 8bddaab17fbe6ce88db2f1b96f5f1a94fa06276bf616688319b9a1ec782dc0a99500fafb9549dd44bd730752909f1c4a4f9adfebffae5d659b29bfcdbbca4740

data/Gemfile

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

data/bin/code_review_notifier

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'code_review_notifier'
+require_relative "../lib/code_review_notifier.rb"
 
-CodeReviewNotifier.call(ARGV)
+CodeReviewNotifier.new(ARGV).call

data/lib/code_change_notification.rb

@@ -0,0 +1,28 @@
+require "rubiclifier"
+require_relative "./api.rb"
+
+class CodeChangeNotification
+  attr_reader :code_change_activity
+  private :code_change_activity
+
+  def initialize(code_change_activity)
+    @code_change_activity = code_change_activity
+  end
+
+  def send
+    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
+    Rubiclifier::Notification.new(
+      author,
+      message,
+      "#{owner}: #{subject}",
+      Api.current_api.favicon,
+      Api.current_api.code_change_url(code_change)
+    ).send
+  end
+end

data/lib/code_review_notifier.rb

@@ -1,74 +1,87 @@
-require "io/console"
+require "rubiclifier"
 require_relative "./api.rb"
-require_relative "./notifier.rb"
+require_relative "./code_change_notification.rb"
 
 SECONDS_BETWEEN_RUNS = 90
 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"
-      print("What's the base URL? (i.e. https://gerrit.google.com) ")
-      DB.save_setting("base_api_url", STDIN.gets.chomp, is_secret: false)
+class CodeReviewNotifier < Rubiclifier::BaseApplication
+  def show_help
+    puts
+    puts("This polls for updates to patch sets/pull requests and notifies you about any relevant changes.")
+    puts
+    puts("Usage:")
+    puts("  code_review_notifier --help  | Shows this help menu")
+    puts("  code_review_notifier --setup | Runs setup")
+    puts("  code_review_notifier         | Start listening for changes (should be run in background)")
+    puts
+    exit
+  end
 
-      print("What's the account username? ")
-      DB.save_setting("username", STDIN.gets.chomp, is_secret: false)
+  def run_application
+    while true
+      unless Rubiclifier::IdleDetector.is_idle?
+        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|
+          cc.code_change_activity.sort! { |a, b| a.created_at <=> b.created_at }
+          all_activity.concat(cc.code_change_activity)
+        end
+        all_activity.select(&:should_notify?).each do |code_change_activity|
+          code_change_activity.notified
+          unless is_first_run
+            puts("Notifying of change!")
+            CodeChangeNotification.new(code_change_activity).send
+            sleep(SECONDS_BETWEEN_NOTIFICATIONS)
+          end
+        end
+      end
+      sleep(SECONDS_BETWEEN_RUNS)
+    end
+  end
 
-      print("What's the account password? (hiding input) ")
-      DB.save_setting("password", STDIN.noecho(&:gets).chomp, is_secret: true)
-      puts
+  def not_setup
+    Rubiclifier::Notification.new(
+      "Missing Setup Info",
+      "Run `code_review_notifier --setup` to setup."
+    ).send
+  end
 
-      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)
+  def features
+    [
+      Rubiclifier::Feature::BACKGROUND,
+      Rubiclifier::Feature::DATABASE,
+      Rubiclifier::Feature::IDLE_DETECTION,
+      Rubiclifier::Feature::NOTIFICATIONS
+    ]
+  end
 
-      puts("All setup!")
-      puts
-      puts("It's recommended that you set this up as a system service with serviceman. Check it out here: https://git.rootprojects.org/root/serviceman")
-      puts("Set code_review_notifier to run on startup with `serviceman add --name code_review_notifier code_review_notifier`")
-      exit
-    end
+  def settings
+    @settings ||= [
+      Rubiclifier::Setting.new("base_api_url", "base URL", explanation: "e.g. https://gerrit.google.com"),
+      Rubiclifier::Setting.new("username", "account username"),
+      Rubiclifier::Setting.new("password", "account password", explanation: "input hidden", is_secret: true),
+      Rubiclifier::Setting.new("account_id", "account ID", explanation: -> {"check #{Api.current_api.base_api_url}/settings/"})
+    ]
+  end
 
-    if !Api.current_api.is_setup?
-      Notifier.notify("Missing Setup Info", "Run `code_review_notifier --setup` to setup.")
-      puts
-      puts("You must finish setup first by running with the `--setup` option.")
-      puts("`code_review_notifier --setup`")
-      exit
-    end
+  def executable_name
+    "code_review_notifier"
   end
 
-  def self.call(args)
-    setup(args)
+  def data_directory
+    "~/.code_review_notifier"
+  end
 
-    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_about_code_change(code_change_activity)
-          sleep(SECONDS_BETWEEN_NOTIFICATIONS)
-        end
-      end
-      sleep(SECONDS_BETWEEN_RUNS)
-    end
+  def migrations_location
+    "#{File.expand_path(File.dirname(__FILE__) + "/..")}/migrations.rb"
   end
 
-  def self.is_first_run?
-    DB.query_single_row("SELECT id FROM code_change_activity_notified;").nil?
+  def is_first_run?
+    Rubiclifier::DB.query_single_row("SELECT id FROM code_change_activity_notified;").nil?
   end
 end

data/lib/gerrit_api.rb

@@ -1,10 +1,15 @@
-require_relative "./base_api.rb"
+require "rubiclifier"
 require_relative "./models/code_change.rb"
 require_relative "./models/code_change_activity.rb"
 
-class GerritApi < BaseApi
-  def self.authenticate
-    @token = nil
+class HTTParty::Parser
+  def json
+    JSON.parse(body.gsub(")]}'", ""))
+  end
+end
+
+class GerritApi < Rubiclifier::BaseApi
+  def self.login_and_get_api_token
     res = post("/login/", {
       body: "username=#{username}&password=#{URI.escape(password)}&rememberme=1",
       headers: {
@@ -13,22 +18,23 @@ class GerritApi < BaseApi
       follow_redirects: false
     })
     set_cookie_header = res.headers["set-cookie"] || ""
-    token = set_cookie_header.match("GerritAccount=(.*?);")&.to_a&.fetch(1)
-    if token.nil?
-      Notifier.notify("Incorrect Credentials", "Trying running `code_review_notifier --setup` again.")
-      sleep(120)
-      exit
-    else
-      DB.save_setting("api_token", token, is_secret: true)
-      token
-    end
+    set_cookie_header.match("GerritAccount=(.*?);")&.to_a&.fetch(1)
+  end
+
+  def self.invalid_credentials_error
+    Rubiclifier::Notification.new(
+      "Incorrect Credentials",
+      "Trying running `code_review_notifier --setup` again."
+    ).send
+    sleep(120)
+    exit
   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};"
+          "Cookie" => "GerritAccount=#{api_token};"
         }
       })
     end.parsed_response.flat_map { |js| js.map { |j| code_change_from_json(j) } }
@@ -51,4 +57,24 @@ class GerritApi < BaseApi
   def self.code_change_url(code_change)
     "#{base_api_url}/c/#{code_change.id}"
   end
+
+  def self.api_token_db_key
+    "api_token"
+  end
+
+  def self.base_api_url_db_key
+    "base_api_url"
+  end
+
+  def self.username
+    @username ||= Rubiclifier::DB.get_setting("username")
+  end
+
+  def self.password
+    @password ||= Rubiclifier::DB.get_setting("password")
+  end
+
+  def self.account_id
+    @account_id ||= Rubiclifier::DB.get_setting("account_id")
+  end
 end

data/lib/models/code_change.rb

@@ -1,10 +1,8 @@
 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
@@ -15,7 +13,6 @@ class CodeChange
   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
+    @activity_from_self_at ||= code_change_activity.find { |a| a.is_self }&.created_at
   end
 end

data/lib/models/code_change_activity.rb

@@ -1,3 +1,5 @@
+require "rubiclifier"
+
 MESSAGES_TO_IGNORE = [/Uploaded patch set 1/, /Build Started/, /owns \d+% of/]
 AUTHOR_TRANSLATIONS = {
   "Service Cloud Jenkins" => "Jenkins",
@@ -17,14 +19,14 @@ class CodeChangeActivity
   end
 
   def notified
-    DB.execute("INSERT INTO code_change_activity_notified (id, notified_at) VALUES('#{id}', CURRENT_TIMESTAMP);")
+    Rubiclifier::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}'")
+      !Rubiclifier::DB.query_single_row("SELECT id FROM code_change_activity_notified WHERE id = '#{id}'")
   end
 
   def self.translate_author(author)

data/migrations.rb

@@ -0,0 +1,8 @@
+migrations = []
+migrations << <<SQL
+  CREATE TABLE IF NOT EXISTS code_change_activity_notified (
+    id VARCHAR(50) PRIMARY KEY,
+    notified_at TIMESTAMP
+  );
+SQL
+migrations

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: code_review_notifier
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Kyle Grinstead
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-08 00:00:00.000000000 Z
+date: 2020-07-10 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: kyleag@hey.com
@@ -17,24 +17,22 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- Brewfile
 - Gemfile
 - bin/code_review_notifier
 - lib/api.rb
-- lib/base_api.rb
-- lib/cipher.rb
+- lib/code_change_notification.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
+- migrations.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: 
+post_install_message: "\n\e[32mThanks for installing code_review_notifier!\e[0m\n\e[32mSet
+  it up by running `\e[0mcode_review_notifier --setup\e[32m`\e[0m\n\n"
 rdoc_options: []
 require_paths:
 - lib

data/Brewfile

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

data/lib/base_api.rb

@@ -1,66 +0,0 @@
-require "httparty"
-require_relative "./gerrit_api.rb"
-
-class HTTParty::Parser
-  def json
-    JSON.parse(body.gsub(")]}'", ""))
-  end
-end
-
-class BaseApi
-  include HTTParty
-
-  def self.token
-    @token ||= DB.get_setting("api_token") || self.authenticate
-  end
-
-  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.chomp("/")
-                      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

@@ -1,31 +0,0 @@
-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/database.rb

@@ -1,48 +0,0 @@
-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/notifier.rb

@@ -1,31 +0,0 @@
-require_relative './api.rb'
-
-class Notifier
-  def self.notify_about_code_change(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
-    notify(author, message, "#{owner}: #{subject}", Api.current_api.favicon, Api.current_api.code_change_url(code_change))
-  end
-
-  def self.notify(title, message, subtitle = nil, icon = nil, url = nil)
-    args = {
-      "title" => title,
-      "message" => message,
-      "subtitle" => subtitle,
-      "appIcon" => icon,
-      "open" => url
-    }
-    all_args = args.keys.reduce("") do |arg_string, key|
-      if args[key]
-        arg_string += " -#{key} '#{args[key]}'"
-      end
-      arg_string
-    end
-    system("/usr/local/bin/terminal-notifier #{all_args}")
-  end
-end