tokite 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 42f015a1f6506f8fa787106a51d82f4947ef26f9
-  data.tar.gz: cf9f1533ccb4e27eeb99132c5551df9588169a38
+SHA256:
+  metadata.gz: 73bba954a04f930ead15e40578f8ca568af8556be9c590aebc0af83b0a10acfb
+  data.tar.gz: 9d1621ce6e6bd627fccc1b1a5c67b3da1fa531ea7eef6378f9d599b8765c61cf
 SHA512:
-  metadata.gz: d802bf0c26babe1c2c076539ecb7bea0bcec17e5a9263827a64282fc13c173f9b61bb35b2ce64934f5bb94924f4e06d3cb6bf38a9bf21a923a0abdecab696f62
-  data.tar.gz: 65409e232f6a19aaf482aa42b85fdecb52e86c8530a4f9129ad59e11b18ec7f3b773f6d95e6cc991aed0dbaee48269a8c61156766dff8bb59dff50b9e392fd80
+  metadata.gz: 4e25b16e531706114b7ea766af525058055c2b0679d30ccd9b03fcb13f05fb19bb00071d354b2bd0e995489d408fe743ed14c3e86b910759732415b13dde8581
+  data.tar.gz: cd61a51ed21d5a7410b7930ac77c8c1d6022c7853f081546333fa069f4a09c4339e5ec1b84d8de3aa7c8eda52d2433102097e971f88ea2e5a646b978f60c0b4e

data/README.md

@@ -1,4 +1,4 @@
-# Tokite [![CircleCI](https://circleci.com/gh/hogelog/tokite.svg?style=svg)](https://circleci.com/gh/hogelog/tokite) [![Gem Version](https://badge.fury.io/rb/tokite.svg)](https://badge.fury.io/rb/tokite)
+# Tokite [![Gem Version](https://badge.fury.io/rb/tokite.svg)](https://badge.fury.io/rb/tokite)
 
 Tokite send GitHub event (pull-request, issue and comment) to Slack.
  
@@ -23,8 +23,9 @@ end
 ### Setup database
 ```console
 $ ./bin/rails db:create
-$ ./bin/rails tokite:ridgepole:install
-$ ./bin/rails tokite:ridgepole:apply
+$ ./bin/rails app:tokite:ridgepole:install
+$ ./bin/rails app:tokite:ridgepole:apply
+$ RAILS_ENV=test ./bin/rails app:tokite:ridgepole:apply
 ```
 
 ### Setup yarn pkg
@@ -34,8 +35,8 @@ $ ./bin/rails tokite:yarn:install
 
 ## Configuration
 <table>
-<tr><th>GITHUB_CLIENT_ID</th><td>Google+ OAuth2 client ID</td></tr>
-<tr><th>GITHUB_CLIENT_SECRET</th><td>Google+ OAuth2 client secret</td></tr>
+<tr><th>GITHUB_CLIENT_ID</th><td>GitHub OAuth2 client ID</td></tr>
+<tr><th>GITHUB_CLIENT_SECRET</th><td>GitHub OAuth2 client secret</td></tr>
 <tr><th>GITHUB_HOST (optional)</th><td>GitHub Enterprise host</td></tr>
 <tr><th>SECRET_KEY_BASE</th><td><code>rails secret</code> key</td></tr>
 <tr><th>SLACK_WEBHOOK_URL</th><td>Slack incoming webhook url</td></tr>
@@ -67,11 +68,14 @@ Tokite support only below events now.
 
 <table>
 <tr><th>Name</th><th>Description</th><th>Example</th></tr>
-<tr><td>repo:</td><td>Match repository name.</td><td>repo:hogelog/tokite</td></tr>
+<tr><td>repo:</td><td>Match repository name.</td><td>repo:cookpad/tokite</td></tr>
 <tr><td>title:</td><td>Match pull_request or issues title.</td><td>title:Bug</td></tr>
 <tr><td>event:</td><td>Match event type pull_request, issues, issue_comment, pull_request_review, pull_request_review_comment.</td><td>event:/pull_request|issues|pull_request_review|pull_request_review_comment/</td></tr>
 <tr><td>body:</td><td>Match body text.</td><td>body:"review please"</td></tr>
 <tr><td>user:</td><td>Match user name.</td><td>user:hogelog</td></tr>
+<tr><td>label:</td><td>Match pull_request or issue label.</td><td>label:Feature</td></tr>
 <tr><td>review_state:</td><td>Match pull_request_review state.</td><td>review_state:/commented|approved|changes_requested/</td></tr>
+<tr><td>requested_reviewer:</td><td>Match user name of review requested reviewer</td><td>requested_reviewer:hogelog</td></tr>
+<tr><td>requested_team:</td><td>Match team name of review requested team</td><td>requested_team:cookpad/chef</td></tr>
 <tr><td>unspecified</td><td>Match title or body field.</td><td>review please</td></tr>
 </table>

data/app/controllers/tokite/hooks_controller.rb

@@ -3,15 +3,15 @@
 module Tokite
   class HooksController < ActionController::API
     GITHUB_EVENT_HEADER = "X-GitHub-Event"
-  
+
     def create
       logger.debug("Hook triggered: #{github_event}")
       Hook.fire!(github_event, request.request_parameters)
       render plain: "ok"
     end
-  
+
     private
-  
+
     def github_event
       request.headers[GITHUB_EVENT_HEADER]
     end

data/app/controllers/tokite/repositories_controller.rb

@@ -7,9 +7,12 @@ module Tokite
     end
 
     def new
-      github_repos = octokit_client.repositories.select{|r| r.permissions.admin }.delete_if(&:fork)
+      github_repos = octokit_client.repositories.
+        select{|r| r.permissions.admin }.
+        delete_if(&:fork).
+        delete_if(&:archived)
       @repositories = github_repos.map do |repo|
-        Repository.new(name: repo.full_name, url: repo.html_url)
+        Repository.new(name: repo.full_name, url: repo.html_url, private: repo.private)
       end
       Repository.all.pluck(:name).each do |existing_name|
         @repositories.delete_if {|repo| repo.name == existing_name }
@@ -17,11 +20,22 @@ module Tokite
     end
 
     def create
-      params[:names].each do |name|
-        github_repo = octokit_client.repository(name)
-        Repository.hook!(octokit_client, github_repo)
+      if params[:names].nil?
+        flash[:error] = "Error: No repository was selected"
+      else
+        github_repos = params[:names].map do |name|
+          octokit_client.repository(name)
+        end
+        errors = github_repos.select(&:archived).map(&:full_name)
+        if errors != []
+          flash[:error] = %(Error: The following repositories have been archived: #{errors.join(", ")})
+        else
+          github_repos.each do |repo|
+            Repository.hook!(octokit_client, repo)
+          end
+          flash[:info] = "Import repositories."
+        end
       end
-      flash[:info] = "Import repositories."
       redirect_to repositories_path
     end
 

data/app/controllers/tokite/rules_controller.rb

@@ -46,7 +46,7 @@ module Tokite
     private
 
     def rule_params
-      params.require(:rule).permit(:user_id, :name, :query, :channel, :icon_emoji, :additional_text)
+      params.require(:rule).permit(:user_id, :name, :query, :channel, :icon_emoji, :additional_text, :display_name)
     end
   end
 end

data/app/models/tokite/hook.rb

@@ -1,7 +1,7 @@
 module Tokite
   class Hook
     attr_reader :event
-  
+
     HOOK_EVENTS = {
       "pull_request" => HookEvent::PullRequest,
       "issues" => HookEvent::Issues,
@@ -9,16 +9,16 @@ module Tokite
       "pull_request_review" => HookEvent::PullRequestReview,
       "pull_request_review_comment" => HookEvent::PullRequestReviewComment,
     }.freeze
-  
+
     def self.fire!(github_event, hook_params)
       event_class = HOOK_EVENTS[github_event]
       Hook.new(event_class.new(hook_params)).fire! if event_class
     end
-  
+
     def initialize(event)
       @event = event
     end
-  
+
     def fire!
       return unless event.notify?
       payloads = []
@@ -32,6 +32,7 @@ module Tokite
         if payloads.none? {|payload| payload[:channel] == rule.channel && payload[:emoji] == emoji && payload[:additional_text] == additional_text }
           payloads << {
             channel: rule.channel,
+            username: rule.display_name.presence || "tokite",
             text: event.slack_text,
             emoji: emoji,
             additional_text: additional_text,
@@ -40,11 +41,25 @@ module Tokite
         end
       end
       payloads.each do |payload|
-        notify!(channel: payload[:channel], text: payload[:text], icon_emoji: payload[:emoji], attachments: payload[:attachments])
-        notify!(channel: payload[:channel], text: payload[:additional_text], icon_emoji: payload[:emoji], parse: "full") if payload[:additional_text].present?
+        notify!(
+          channel: payload[:channel],
+          text: payload[:text],
+          icon_emoji: payload[:emoji],
+          attachments: payload[:attachments],
+          username: payload[:username]
+        )
+        if payload[:additional_text].present?
+          notify!(
+            channel: payload[:channel],
+            text: payload[:additional_text],
+            icon_emoji: payload[:emoji],
+            parse: "full",
+            username: payload[:username]
+          ) 
+        end
       end
     end
-  
+
     def notify!(payload)
       NotifyGithubHookEventJob.perform_now(payload.compact)
     end

data/app/models/tokite/hook_event/issue_comment.rb

@@ -7,17 +7,18 @@ module Tokite
           repo: hook_params[:repository][:full_name],
           body: hook_params[:comment][:body],
           user: hook_params[:comment][:user][:login],
+          label: hook_params[:issue][:labels].map { |label| label[:name] },
         }
       end
-  
+
       def notify?
         %w(created).include?(hook_params[:action])
       end
-  
+
       def slack_text
         "[#{hook_params[:repository][:full_name]}] New comment by #{hook_params[:comment][:user][:login]} on issue <#{hook_params[:comment][:html_url]}|##{hook_params[:issue][:number]}: #{hook_params[:issue][:title]}>"
       end
-  
+
       def slack_attachment
         {
           fallback: hook_params[:comment][:body],

data/app/models/tokite/hook_event/issues.rb

@@ -6,8 +6,9 @@ module Tokite
           event: "issues",
           repo: hook_params[:repository][:full_name],
           title: hook_params[:issue][:title],
-          body: hook_params[:issue][:body],
+          body: hook_params[:issue][:body] || "",
           user: hook_params[:issue][:user][:login],
+          label: hook_params[:issue][:labels].map { |label| label[:name] },
         }
       end
   
@@ -24,7 +25,7 @@ module Tokite
           title: "##{hook_params[:issue][:number]} #{hook_params[:issue][:title]}",
           title_link: hook_params[:issue][:html_url],
           fallback: "#{hook_params[:issue][:title]}\n#{hook_params[:issue][:body]}",
-          text: hook_params[:issue][:body],
+          text: hook_params[:issue][:body] || "",
           color: "good",
         }
       end

data/app/models/tokite/hook_event/pull_request.rb

@@ -8,23 +8,40 @@ module Tokite
           title: hook_params[:pull_request][:title],
           body: hook_params[:pull_request][:body],
           user: hook_params[:pull_request][:user][:login],
+          label: hook_params[:pull_request][:labels].map { |label| label[:name] },
+          requested_reviewer: hook_params[:requested_reviewer]&.[](:login) || hook_params[:pull_request][:requested_reviewers].map { |reviewer| reviewer[:login] },
+          requested_team: hook_params[:pull_request][:requested_teams].map { |team| parse_team_name(team) },
         }
       end
-  
+
+      def parse_team_name(team)
+        html_url = team[:html_url]
+        if /\/orgs\/(?<org_name>[^\s\/]+)\/teams\/(?<team_name>[^\s\/]+)\z/ =~ html_url
+          org_name + "/" + team_name
+        else
+          team[:slug] || team[:name]
+        end
+      end
+
       def notify?
-        %w(opened).include?(hook_params[:action])
+        %w(opened review_requested).include?(hook_params[:action])
       end
-  
+
       def slack_text
-        "[#{hook_params[:repository][:full_name]}] Pull request submitted by <#{hook_params[:pull_request][:user][:html_url]}|#{hook_params[:pull_request][:user][:login]}>"
+        case hook_params[:action]
+        when 'opened'
+          "[#{hook_params[:repository][:full_name]}] Pull request submitted by <#{hook_params[:pull_request][:user][:html_url]}|#{hook_params[:pull_request][:user][:login]}>"
+        when 'review_requested'
+          "[#{hook_params[:repository][:full_name]}] Pull request review requested by <#{hook_params[:pull_request][:user][:html_url]}|#{hook_params[:pull_request][:user][:login]}>"
+        end
       end
-  
+
       def slack_attachment
         {
           title: "##{hook_params[:pull_request][:number]} #{hook_params[:pull_request][:title]}",
           title_link: hook_params[:pull_request][:html_url],
           fallback: "#{hook_params[:pull_request][:title]}\n#{hook_params[:pull_request][:body]}",
-          text: hook_params[:pull_request][:body],
+          text: hook_params[:pull_request][:body] || "No description provided.",
           color: "good",
         }
       end

data/app/models/tokite/hook_event/pull_request_review.rb

@@ -5,16 +5,17 @@ module Tokite
         {
           event: "pull_request_review",
           repo: hook_params[:repository][:full_name],
-          body: hook_params[:review][:body],
+          body: hook_params[:review][:body] || "",
           user: hook_params[:review][:user][:login],
           review_state: hook_params[:review][:state],
         }
       end
 
       def notify?
-        return false unless hook_params[:action] == "submitted"
-        if hook_params[:review][:state] == "commented"
-          hook_params[:review][:body]
+        if hook_params[:action] != "submitted"
+          false
+        elsif hook_params[:review][:state] == "commented"
+          hook_params[:review][:body] != nil
         else
           true
         end
@@ -35,7 +36,6 @@ module Tokite
       end
 
       def slack_attachment
-        return unless hook_params[:review][:body]
         case hook_params[:review][:state]
           when "commented"
           when "approved"
@@ -44,8 +44,8 @@ module Tokite
             color = "warning"
         end
         {
-          fallback: hook_params[:review][:body],
-          text: hook_params[:review][:body],
+          fallback: hook_params[:review][:body] || "",
+          text: hook_params[:review][:body] || "",
           color: color,
         }
       end

data/app/models/tokite/rule.rb

@@ -1,7 +1,7 @@
 module Tokite
   class Rule < ApplicationRecord
     attr_reader :search_query
-  
+
     belongs_to :user
 
     validates :name, presence: true
@@ -19,27 +19,27 @@ module Tokite
         rule.match?(event)
       end
     end
-  
+
     def search_query
       @search_query ||= SearchQuery.new(query)
     end
-  
+
     def match?(event)
       search_query.match?(event.fields)
     end
-  
+
     def slack_attachment_fallback
       "#{name} by #{user.name}"
     end
-  
+
     def slack_attachment_text
       "#{rule_name_link} (#{user_link}) "
     end
-  
+
     def rule_name_link
       "<#{Tokite::Engine.routes.url_helpers.edit_rule_url(self)}|#{name}>"
     end
-  
+
     def user_link
       "<#{Tokite::Engine.routes.url_helpers.user_url(user)}|#{user.name}>"
     end
@@ -47,8 +47,8 @@ module Tokite
     private
 
     def validate_query
-      SearchQuery.parse(query)
-    rescue SearchQuery::ParseError => e
+      SearchQuery.validate(query)
+    rescue SearchQuery::QueryError => e
       errors.add(:query, e.message)
     end
 

data/app/models/tokite/search_query.rb

@@ -6,7 +6,11 @@ module Tokite
 
     DEFAULT_FIELDS = %i(title body)
 
-    class ParseError < StandardError
+    class QueryError < StandardError
+    end
+    class QueryParseError < QueryError
+    end
+    class QueryRegexpError < QueryError
     end
   
     class Parser < Parslet::Parser
@@ -37,7 +41,16 @@ module Tokite
     def self.parse(query)
       Array.wrap(parser.parse(query))
     rescue Parslet::ParseFailed => e
-      raise ParseError, e
+      raise QueryParseError, e
+    end
+
+    def self.validate(query)
+      tree = SearchQuery.parse(query)
+      tree.each do |word|
+        Regexp.compile(word[:regexp_word].to_s, Regexp::IGNORECASE) if word[:regexp_word]
+      end
+    rescue RegexpError => e
+      raise QueryRegexpError, e
     end
 
     def initialize(query)
@@ -49,13 +62,25 @@ module Tokite
       tree.all? do |word|
         field = word[:field]
         if field
-          targets = doc[field.to_sym] ? [doc[field.to_sym].downcase] : []
+          targets =
+            case doc[field.to_sym]
+            when Array
+              doc[field.to_sym].map(&:downcase)
+            when nil
+              []
+            else
+              [doc[field.to_sym].downcase]
+            end
         else
           targets = DEFAULT_FIELDS.map{|field| doc[field]&.downcase }.compact
         end
         if word[:regexp_word]
-          regexp = Regexp.compile(word[:regexp_word].to_s, Regexp::IGNORECASE)
-          matched = targets.any?{|text| regexp.match?(text) }
+          begin
+            regexp = Regexp.compile(word[:regexp_word].to_s, Regexp::IGNORECASE)
+            matched = targets.any?{|text| regexp.match?(text) }
+          rescue RegexpError
+            matched = false
+          end
         else
           value = word[:word].to_s.downcase
           matched = targets.any?{|text| text.index(value) }

data/app/views/layouts/tokite/application.html.haml

@@ -20,6 +20,8 @@
             %span.nav-item.is-tab= current_user.name_with_provider
 
     %section.section
+      - if flash[:error]
+        .notification.is-danger= flash[:error]
       - if flash[:info]
         .notification.is-success= flash[:info]
 

data/app/views/tokite/repositories/new.html.haml

@@ -7,6 +7,8 @@
             %label.checkbox
               = check_box_tag "names[]", repo.name, false, id: "names_#{sanitize_to_id(repo.name)}", multiple: true
               = repo.name
+              - if repo.private?
+                %span.tag.is-danger{style: "height: 1.5em"} private
               = link_to "@", repo.url
 
     .vspace-40

data/app/views/tokite/rules/_form.html.haml

@@ -4,6 +4,7 @@
   = form_text_field f, :channel, size: 40, class: "input"
   = form_text_field f, :icon_emoji, size: 40, class: "input"
   = form_text_field f, :additional_text, size: 40, class: "input"
+  = form_text_field f, :display_name, size: 40, class: "input"
   .field.columns
     .column.is-8= f.submit "Update", class: "button is-primary"
     - if @rule.persisted?
@@ -41,7 +42,7 @@
       %tr
         %td repo:
         %td Match repository name.
-        %td repo:hogelog/tokite
+        %td repo:cookpad/tokite
       %tr
         %td title:
         %td Match pull_request or issues title.
@@ -58,10 +59,22 @@
         %td user:
         %td Match user name.
         %td user:hogelog
+      %tr
+        %td label:
+        %td Match pull_request or issue label.
+        %td label:Feature
       %tr
         %td review_state:
         %td Match pull_request_review state.
         %td review_state:/commented|approved|changes_requested/
+      %tr
+        %td requested_reviewer:
+        %td Match user name of review requested reviewer.
+        %td requested_reviewer:hogelog
+      %tr
+        %td requested_team:
+        %td Match team name of review requested team.
+        %td requested_team:cookpad/chef
       %tr
         %td unspecified
         %td Match title or body field.

data/lib/tokite/version.rb

@@ -1,3 +1,3 @@
 module Tokite
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/schema/tokite_repositories.schema

@@ -2,6 +2,7 @@ create_table "tokite_repositories", force: :cascade do |t|
   t.string   "name",       limit: 200, null: false
   t.string   "url",        limit: 200, null: false
   t.datetime "created_at",             null: false
+  t.boolean  "private",                null: false, default: false
 end
 
 add_index "tokite_repositories", ["name"], name: "tokite_repositories_uniq_name", unique: true, using: :btree

data/schema/tokite_rules.schema

@@ -3,10 +3,11 @@ create_table "tokite_rules", force: :cascade do |t|
   t.string   "name",            limit: 50,   null: false
   t.string   "query",           limit: 2000, null: false
   t.string   "channel",         limit: 100,  null: false
-  t.string   "icon_emoji",      limit: 20,   null: false, default: ""
+  t.string   "icon_emoji",      limit: 30,   null: false, default: ""
   t.string   "additional_text", limit: 200,  null: false, default: ""
   t.datetime "created_at",                   null: false
   t.datetime "updated_at",                   null: false
+  t.string   "display_name",    limit: 60,   null: false, default: ""
 end
 
 add_index "tokite_rules", ["user_id", "name"], name: "tokite_rule_uniq_name", unique: true, using: :btree

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tokite
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - hogelog
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-06-12 00:00:00.000000000 Z
+date: 2023-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.1.1
+        version: '5.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.1.1
+        version: '5.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.8.1
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: haml
   requirement: !ruby/object:Gem::Requirement
@@ -156,14 +162,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
   name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
@@ -251,11 +257,11 @@ files:
 - schema/tokite_rules.schema
 - schema/tokite_secure_user_tokens.schema
 - schema/tokite_users.schema
-homepage: https://github.com/hogelog/tokite/
+homepage: https://github.com/cookpad/tokite/
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -270,9 +276,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Customizable Slack notification from GitHub
 test_files: []