tokite 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5713f325c58d3d8111e0a7d23474ff6f5102a15
-  data.tar.gz: c8c4507ea06af90e808469887e83dc8038af430e
+  metadata.gz: 93c9e70ee7ad42fe6addd071c719a4e99d501e08
+  data.tar.gz: c4402fec11b740e86ced9bdfa9b575a0a834cbf9
 SHA512:
-  metadata.gz: 8f13bf68e97bf9ce0b3ff43f1a6326964433545e1b4c6a6456da5371eecda96aa67f88d18e50c5591356cf7a0455f1a8557085f18703deb009eac3d808d9d602
-  data.tar.gz: 106be23f58cb08f37146689762decbd6e5d05a902c46ed03afb58392574c88b5715ee8fd0d7bb0a57bdc0d09fcb9c2fbd67f6bc59c5e9e4198afd723d5a98b09
+  metadata.gz: 9e729210aee4fe79beb3b6aa0cd9793125dd74040116ec457d8c938c87864303a9b89193e44d34c96c5038742da00f9c69ba033586305899b6168b572bd03f52
+  data.tar.gz: a22b3fc1e2344aaef19ee1b78f66039b2aee377f723f079f5310dccaca4908d9d377576abe4f7aaafcc0a5effc79000a35e4ee2d666759d474e87b9bbfeb00c5

data/README.md

@@ -34,13 +34,42 @@ $ ./bin/rails tokite:yarn:install
 
 ## Configuration
 <table>
-<tr><th>GOOGLE_CLIENT_ID</th><td>Google+ OAuth2 client ID</td></tr>
-<tr><th>GOOGLE_CLIENT_SECRET</th><td>Google+ OAuth2 client secret</td></tr>
-<tr><th>GOOGLE_HOSTED_DOMAIN (optional)</th><td>Limited by G Suite domain</td></tr>
+<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_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>
 <tr><th>SLACK_NAME (optional)</th><td>Slack notification user name</td></tr>
 <tr><th>SLACK_ICON_EMOJI (optional)</th><td>Slack notification icon</td></tr>
-<tr><th>SENTRY_DSN (optional)</th><td>Sentry DSN</td></tr>
 <tr><th>APP_HOST (optional)</th><td>Application host url</td></tr>
 </table>
+
+## Usage
+### Supported Event
+
+Tokite support only below events now.
+
+- pull_request
+- issues
+- issue_comment
+
+### Supported query type
+
+<table>
+<tr><th>Name</th><th>Example</th></tr>
+<tr><td>Plain text</td><td>hoge fuga moge</td></tr>
+<tr><td>Quoted text</td><td>hoge/fuga/moge</td></tr>
+<tr><td>Regular expression</td><td>/hoge|fuga|moge/</td></tr>
+</table>
+
+### Supported query field
+
+<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>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 or issue_comment.</td><td>event:/(pull_request|issues)/</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>unspecified</td><td>Match title or body field.</td><td>hogelog</td></tr>
+</table>

data/app/models/tokite/hook.rb

@@ -27,7 +27,7 @@ module Tokite
         emoji = rule.icon_emoji.chomp.presence
         additional_text = rule.additional_text
 
-        if payloads.none? {|payload| payload[:channel] == rule.channel && payload[:icon_emoji] == emoji && payload[:additional_text] == additional_text }
+        if payloads.none? {|payload| payload[:channel] == rule.channel && payload[:emoji] == emoji && payload[:additional_text] == additional_text }
           payloads << {
             channel: rule.channel,
             text: event.slack_text,

data/app/models/tokite/rule.rb

@@ -6,6 +6,11 @@ module Tokite
   
     validate :validate_query
     validate :validate_user_id
+    validate :validate_channel
+
+    before_validation :normalize_channel
+
+    INVALID_CHANNEL_CHARS = [" ", ","]
 
     # TODO: Performance
     def self.matched_rules(event)
@@ -37,7 +42,9 @@ module Tokite
     def user_link
       "<#{Tokite::Engine.routes.url_helpers.user_url(user)}|#{user.name}>"
     end
-  
+
+    private
+
     def validate_query
       SearchQuery.parse(query)
     rescue SearchQuery::ParseError => e
@@ -49,5 +56,19 @@ module Tokite
         errors.add(:user_id, "Unknown user_id: #{user_id}")
       end
     end
+
+    def validate_channel
+      INVALID_CHANNEL_CHARS.each do |invalid_char|
+        errors.add(:channel, %(Invalid character: "#{invalid_char}")) if channel.index(invalid_char)
+      end
+    end
+
+    def normalize_channel
+      if channel.start_with?("#")
+        self.channel = channel.strip
+      else
+        self.channel = "##{channel.strip}"
+      end
+    end
   end
 end

data/app/models/tokite/search_query.rb

@@ -4,6 +4,8 @@ module Tokite
   class SearchQuery
     attr_reader :query, :tree
 
+    DEFAULT_FIELDS = %i(title body)
+
     class ParseError < StandardError
     end
   
@@ -48,7 +50,7 @@ module Tokite
         if field
           targets = doc[field.to_sym] ? [doc[field.to_sym].downcase] : []
         else
-          targets = doc.values.map(&:downcase)
+          targets = DEFAULT_FIELDS.map{|field| doc[field]&.downcase }.compact
         end
         if word[:regexp_word]
           regexp = Regexp.compile(word[:regexp_word].to_s, Regexp::IGNORECASE)

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

@@ -57,5 +57,5 @@
         %td user:hogelog
       %tr
         %td unspecified
-        %td Match any field.
+        %td Match title or body field.
         %td hogelog

data/lib/tokite/version.rb

@@ -1,3 +1,3 @@
 module Tokite
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tokite
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - hogelog
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-15 00:00:00.000000000 Z
+date: 2017-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails