qiita_team_services 0.3.6 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fef4a03f843aba4fd94b121bb2bc3b167925c41c
-  data.tar.gz: 4fe8e266110be34bbc07f01dae2a46e4c3f580dc
+  metadata.gz: 70b69acd1694d493b37c1c671815a050d86eccce
+  data.tar.gz: 72daa651ac2a5dd8ec1b2b8d4f0371cdd61f1652
 SHA512:
-  metadata.gz: 581ea55242fad065de959775b300bc189c5ce7828ebb1cb7a3e1c68203e55eac9cfff6cf5dfd5c39be7cc3f645918c0159de0a087040d567842e04fde3cf30bf
-  data.tar.gz: 5e7d81e6e64d8e27afc29d0fa2772021897981ca0dcdc3d2186cfe696adf4da6a38271edddaff419cb4ec803d6be8f436a5df0a2c8224b69cff774eaef1e71b7
+  metadata.gz: ba5ba03c1ddf0aeeeac635a3a38e9a1525058b7a66ecfce8179fa21fe1f7cbea56eb7251215e4e62eea68c95bb0ecf02dbc0bd245112ca94dfae038068ca590e
+  data.tar.gz: e8051fc83329b6d9f6650873c9d96d8124196759ca88d14e370e9dd0ffbd80cef3174bcaf2306780a2ade269c8779f378fdd63fed35311536aeb22bb55daa08e

data/.rubocop.yml

@@ -1,3 +1,9 @@
+AllCops:
+  TargetRubyVersion: 2.1
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 
@@ -23,5 +29,8 @@ Metrics/MethodLength:
 Metrics/AbcSize:
   Max: 30
 
-Style/TrailingComma:
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInLiteral:
   EnforcedStyleForMultiline: comma

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 0.3.7
+
+- [#15] Truncate Slack message text to 7500 bytes.
+- [#14] Update outdated rubocop config.
+
 # 0.3.6
 
 - [#13] Escape special characters for slack markup.

data/Rakefile

@@ -3,7 +3,7 @@ require "rspec/core/rake_task"
 require "rubocop/rake_task"
 require "yard"
 
-YARD_DIR = ".publish"
+YARD_DIR = ".publish".freeze
 
 RuboCop::RakeTask.new
 RSpec::Core::RakeTask.new

data/lib/qiita/team/services/hooks/concerns/http_client.rb

@@ -9,7 +9,7 @@ module Qiita::Team::Services
         DEFAULT_HEADERS = {
           "Content-Type" => "application/json",
           "User-Agent" => "Qiita:Team",
-        }
+        }.freeze
         TIMEOUT = 5
 
         private
@@ -48,11 +48,8 @@ module Qiita::Team::Services
               req.headers[key] = value
             end
           end
-          if resp.success?
-            resp
-          else
-            fail DeliveryError
-          end
+          fail DeliveryError unless resp.success?
+          resp
         end
 
         # @return [Symbol] the request format type, `:json` or `:url_encoded`

data/lib/qiita/team/services/hooks/concerns/slack.rb

@@ -15,6 +15,7 @@ module Qiita::Team::Services
 
         DEFAULT_ICON_URL = "https://cdn.qiita.com/media/qiita-team-slack-icon.png".freeze
         ICON_EMOJI_FORMAT = /\A:[^:]+:\z/
+        TEXT_BYTESIZE_MAX = 7500
 
         included do
           include HttpClient
@@ -54,7 +55,7 @@ module Qiita::Team::Services
               author_icon: event.user.profile_image_url,
               title: event.item.title,
               title_link: event.item.url,
-              text: Slacken.translate(event.item.rendered_body),
+              text: truncate(Slacken.translate(event.item.rendered_body), event.item.url),
               mrkdwn_in: ["text"],
             ],
           )
@@ -105,7 +106,7 @@ module Qiita::Team::Services
               author_name: "@#{event.user.url_name}",
               author_link: event.user.url,
               author_icon: event.user.profile_image_url,
-              text: Slacken.translate(event.comment.rendered_body),
+              text: truncate(Slacken.translate(event.comment.rendered_body), event.comment.url),
               mrkdwn_in: ["text"],
             ],
           )
@@ -141,7 +142,7 @@ module Qiita::Team::Services
               author_name: "@#{event.user.url_name}",
               author_link: event.user.url,
               author_icon: event.user.profile_image_url,
-              text: Slacken.translate(event.comment.rendered_body),
+              text: truncate(Slacken.translate(event.comment.rendered_body), event.comment.url),
               mrkdwn_in: ["text"],
             ],
           )
@@ -288,6 +289,18 @@ module Qiita::Team::Services
           }
           text.gsub(/[&<>]/, table_for_escape)
         end
+
+        # Truncate the text to 7500 bytes.
+        # Now, Slack has a bug that we cannot send text larger than 8000 bytes.
+        #
+        # @param text [String]
+        # @param url [String]
+        # @return [String]
+        def truncate(text, url)
+          return text if text.bytesize <= TEXT_BYTESIZE_MAX
+          tail = "...\n<#{url}|Read more at Qiita:Team...>"
+          text.byteslice(0, TEXT_BYTESIZE_MAX - tail.bytesize).scrub("") + tail
+        end
       end
     end
   end

data/lib/qiita/team/services/hooks/slack_v2.rb

@@ -13,8 +13,6 @@ module Qiita::Team::Services
                                         message: :not_slack_url,
                                         allow_blank: true }
 
-      private
-
       # @note Implement Concerns::HttpClient#url.
       alias_method :url, :webhook_url
     end

data/lib/qiita/team/services/version.rb

@@ -1,3 +1,3 @@
 module Qiita::Team::Services
-  VERSION = "0.3.6"
+  VERSION = "0.3.7".freeze
 end

data/qiita_team_services.gemspec

@@ -37,7 +37,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rake", "~> 10.4"
   spec.add_development_dependency "rspec", "~> 3.3"
-  spec.add_development_dependency "rubocop", "~> 0.33"
+  spec.add_development_dependency "rubocop", "~> 0.36.0"
   spec.add_development_dependency "webmock", "~> 1.21"
   spec.add_development_dependency "yard", "~> 0.8.7"
 end

data/spec/hooks/chatwork_v1_spec.rb

@@ -14,7 +14,7 @@ describe Qiita::Team::Services::Hooks::ChatworkV1 do
     :project_created,
     :project_updated,
     :team_member_added,
-  ]
+  ].freeze
 
   shared_context "Delivery success" do
     before do

data/spec/hooks/hipchat_v1_spec.rb

@@ -13,7 +13,7 @@ describe Qiita::Team::Services::Hooks::HipchatV1 do
     :project_created,
     :project_updated,
     :team_member_added,
-  ]
+  ].freeze
 
   shared_context "Delivery success" do
     before do

data/spec/support/factory_girl.rb

@@ -1,8 +1,8 @@
 require "factory_girl"
 
 Dir.glob("spec/support/factories/*.rb")
-  .map { |filepath| filepath.split("/").last.split(".").first }
-  .each { |name| require "support/factories/#{name}" }
+   .map { |filepath| filepath.split("/").last.split(".").first }
+   .each { |name| require "support/factories/#{name}" }
 
 RSpec.configure do |config|
   config.include FactoryGirl::Syntax::Methods

data/spec/support/helpers/slack_hook_helper.rb

@@ -124,6 +124,12 @@ module Qiita::Team::Services
                 let(:user) { build(:user, name: "<Qiitan>") }
                 it_behaves_like "attachments request hook method"
               end
+
+              context "when the item's body has larger bytesize than the limit" do
+                let(:text_length) { Hooks::Concerns::Slack::TEXT_BYTESIZE_MAX / "あ".bytesize + 1 }
+                let(:resource) { build(:item, rendered_body: "あ" * text_length) }
+                it_behaves_like "attachments request hook method"
+              end
             end
 
             %w(became_coediting destroyed updated).each do |action_name|
@@ -160,6 +166,12 @@ module Qiita::Team::Services
                 let(:user) { build(:user, name: "<Qiitan>") }
                 it_behaves_like "attachments request hook method"
               end
+
+              context "when the comment's body has larger bytesize than the limit" do
+                let(:text_length) { Hooks::Concerns::Slack::TEXT_BYTESIZE_MAX / "あ".bytesize + 1 }
+                let(:resource) { build(:comment, rendered_body: "あ" * text_length) }
+                it_behaves_like "attachments request hook method"
+              end
             end
 
             %w(destroyed updated).each do |action_name|
@@ -217,6 +229,12 @@ module Qiita::Team::Services
                 let(:user) { build(:user, name: "<Qiitan>") }
                 it_behaves_like "attachments request hook method"
               end
+
+              context "when the comment's body has larger bytesize than the limit" do
+                let(:text_length) { Hooks::Concerns::Slack::TEXT_BYTESIZE_MAX / "あ".bytesize + 1 }
+                let(:resource) { build(:project_comment, rendered_body: "あ" * text_length) }
+                it_behaves_like "attachments request hook method"
+              end
             end
 
             %w(destroyed updated).each do |action_name|

data/spec/support/matchers/match_slack_attachments_request.rb

@@ -2,6 +2,12 @@ RSpec::Matchers.define :match_slack_attachments_request do
   match do |request_body|
     request_body.is_a?(Hash) && \
       request_body.key?(:attachments) && \
-      request_body[:attachments].is_a?(Array)
+      request_body[:attachments].is_a?(Array) && \
+      request_body[:attachments].all?(&method(:text_valid_length?))
+  end
+
+  def text_valid_length?(attachment)
+    attachment[:text].nil? || \
+      attachment[:text].bytesize <= Qiita::Team::Services::Hooks::Concerns::Slack::TEXT_BYTESIZE_MAX
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qiita_team_services
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.7
 platform: ruby
 authors:
 - Yuku Takahashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-08 00:00:00.000000000 Z
+date: 2016-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel-url_validator
@@ -184,14 +184,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.33'
+        version: 0.36.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.33'
+        version: 0.36.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement