qiita_team_services 0.3.1

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

@@ -0,0 +1,149 @@
+require "active_support/core_ext/string/strip"
+
+require "qiita/team/services/hooks/base"
+require "qiita/team/services/hooks/concerns/http_client"
+
+module Qiita::Team::Services
+  module Hooks
+    class ChatworkV1 < Base
+      include Concerns::HttpClient
+
+      define_property :token
+      define_property :room_id
+
+      validates :token, presence: true
+      validates :room_id, presence: true
+
+      # @note Override {Services::Base.service_name}.
+      def self.service_name
+        "ChatWork"
+      end
+
+      # @return [void]
+      def ping
+        send_message "Test message sent from Qiita:Team"
+      rescue DeliveryError
+        nil
+      end
+
+      # @param event [Qiita::Team::Services::Events::ItemCreated]
+      # @return [void]
+      # @raise [Qiita::Team::Services::DeliveryError]
+      def item_created(event)
+        send_message <<-EOM.strip_heredoc
+        #{event.user.name} created #{event.item.title}.
+        #{event.item.url}
+        EOM
+      end
+
+      # @param event [Qiita::Team::Services::Events::ItemUpdated]
+      # @return [void]
+      # @raise [Qiita::Team::Services::DeliveryError]
+      def item_updated(event)
+        send_message <<-EOM.strip_heredoc
+        #{event.user.name} updated #{event.item.title}.
+        #{event.item.url}
+        EOM
+      end
+
+      # @param event [Qiita::Team::Services::Events::ItemBecameCoediting]
+      # @return [void]
+      # @raise [Qiita::Team::Services::DeliveryError]
+      def item_became_coediting(event)
+        send_message <<-EOM.strip_heredoc
+        #{event.user.name} changed #{event.item.title} to coedit mode.
+        #{event.item.url}
+        EOM
+      end
+
+      # @param event [Qiita::Team::Services::Events::ItemCommentCreated]
+      # @return [void]
+      # @raise [Qiita::Team::Services::DeliveryError]
+      def item_comment_created(event)
+        send_message <<-EOM.strip_heredoc
+        #{event.user.name} commented on #{event.item.title}.
+        #{event.item.url}[info]#{event.comment.body.truncate(100)}[/info]
+        EOM
+      end
+
+      # @param event [Qiita::Team::Services::Events::ProjectCommentCreated]
+      # @return [void]
+      # @raise [Qiita::Team::Services::DeliveryError]
+      def project_comment_created(event)
+        send_message <<-EOM.strip_heredoc
+        #{event.user.name} commented on #{event.project.name} project.
+        #{event.project.url}[info]#{event.comment.body.truncate(100)}[/info]
+        EOM
+      end
+
+      # @param event [Qiita::Team::Services::Events::MemberAdded]
+      # @return [void]
+      # @raise [Qiita::Team::Services::DeliveryError]
+      def team_member_added(event)
+        send_message("#{event.member.name} is added to #{event.team.name} team.")
+      end
+
+      # @param event [Qiita::Team::Services::Events::ProjectCreated]
+      # @return [void]
+      # @raise [Qiita::Team::Services::DeliveryError]
+      def project_created(event)
+        send_message <<-EOM.strip_heredoc
+        #{event.user.name} created #{event.project.name} project.
+        #{event.project.url}
+        EOM
+      end
+
+      # @param event [Qiita::Team::Services::Events::ProjectUpdated]
+      # @return [void]
+      # @raise [Qiita::Team::Services::DeliveryError]
+      def project_updated(event)
+        send_message <<-EOM.strip_heredoc
+        #{event.user.name} updated #{event.project.name} project.
+        #{event.project.url}
+        EOM
+      end
+
+      # @param event [Qiita::Team::Services::Events::ProjectArchived]
+      # @return [void]
+      # @raise [Qiita::Team::Services::DeliveryError]
+      def project_archived(event)
+        send_message <<-EOM.strip_heredoc
+        #{event.user.name} archived #{event.project.name} project.
+        #{event.project.url}
+        EOM
+      end
+
+      # @param event [Qiita::Team::Services::Events::ProjectActivated]
+      # @return [void]
+      # @raise [Qiita::Team::Services::DeliveryError]
+      def project_activated(event)
+        send_message <<-EOM.strip_heredoc
+        #{event.user.name} activated #{event.project.name} project.
+        #{event.project.url}
+        EOM
+      end
+
+      private
+
+      # @param message [String]
+      def send_message(message)
+        http_post({ body: message }.to_query)
+      end
+
+      # @note Override Concerns::HttpClient#url.
+      def url
+        "https://api.chatwork.com/v1/rooms/#{room_id}/messages"
+      end
+
+      # @note Override Concerns::HttpClient#request_format.
+      def request_format
+        :url_encoded
+      end
+
+      # @note Override Concerns::HttpClient#request_headers.
+      def request_headers
+        { "X-ChatWorkToken" => token }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+require "active_support/concern"
+require "active_support/core_ext/module/delegation"
+
+module Qiita::Team::Services
+  module Hooks
+    module Concerns
+      module EventHandlable
+        extend ActiveSupport::Concern
+
+        class_methods do
+          # @return [true, false]
+          def deprecated?
+            @deprecated == true
+          end
+
+          # @return [true, false]
+          def pingable?
+            public_instance_methods.include?(:ping)
+          end
+
+          # List of implemented event names.
+          #
+          # @return [Array<Symbol>]
+          def available_event_names
+            public_instance_methods & Events.event_names
+          end
+
+          private
+
+          # Mark the service as deprecated.
+          #
+          # @return [void]
+          def deprecated
+            @deprecated = true
+          end
+        end
+
+        delegate :deprecated?, :pingable?, to: :class
+
+        # @param event [Qiita::Team::Services::Events::Base]
+        # @return [void]
+        def handle(event)
+          return unless respond_to?(event.class.event_name)
+          public_send(event.class.event_name, event)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+require "faraday"
+require "faraday_middleware"
+
+module Qiita::Team::Services
+  module Hooks
+    module Concerns
+      module HttpClient
+        DEFAULT_ADAPTER = :net_http
+        DEFAULT_HEADERS = {
+          "Content-Type" => "application/json",
+          "User-Agent" => "Qiita:Team",
+        }
+        TIMEOUT = 5
+
+        private
+
+        # @return [Faraday::Connection]
+        def http_client
+          @http_client ||= Faraday.new(faraday_parameters) do |faraday|
+            faraday.request request_format
+            faraday.adapter adapter
+          end
+        end
+
+        def faraday_parameters
+          {
+            headers: DEFAULT_HEADERS,
+            request: {
+              open_timeout: TIMEOUT,
+              timeout: TIMEOUT,
+            },
+          }
+        end
+
+        # @return [String]
+        def url
+          fail NotImplementedError
+        end
+
+        # @param request_body [Hash, Array] request payload.
+        # @return [Faraday::Response]
+        # @raise [Qiita::Team::Services::DeliveryError]
+        def http_post(request_body, headers = {})
+          resp = http_client.post do |req|
+            req.url url
+            req.body = request_body
+            request_headers.merge(headers).each_pair do |key, value|
+              req.headers[key] = value
+            end
+          end
+          if resp.success?
+            resp
+          else
+            fail DeliveryError
+          end
+        end
+
+        # @return [Symbol] the request format type, `:json` or `:url_encoded`
+        def request_format
+          :json
+        end
+
+        # @return [Hash{String => String}]
+        def request_headers
+          {}
+        end
+
+        def adapter
+          DEFAULT_ADAPTER
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+require "active_support/concern"
+
+require "qiita/team/services/properties"
+
+module Qiita::Team::Services
+  module Hooks
+    module Concerns
+      module Persistable
+        extend ActiveSupport::Concern
+
+        class_methods do
+          # @return [Array<Qiita::Team::Services::Properties::Base>]
+          def service_properties
+            @service_properties ||= []
+          end
+
+          # @return [Array<String>]
+          def property_names
+            service_properties.map(&:name)
+          end
+
+          private
+
+          # @param name [Symbol]
+          # @param type [Symbol] :string or :boolean.
+          # @param default [String, true, false]
+          # @return [void]
+          def define_property(name, type: :string, default: nil)
+            service_properties << Properties.create(name, type, default)
+            attr_accessor name
+          end
+        end
+
+        # @param hash [Hash{String => Object}] deserialized properties hash.
+        def initialize(hash)
+          self.class.service_properties.each do |property|
+            if hash.key?(property.name)
+              public_send("#{property.name}=", hash[property.name])
+            else
+              public_send("#{property.name}=", property.default)
+            end
+          end
+        end
+
+        # Serialize the service object.
+        #
+        # @return [Hash{String => Object}] serialized properties.
+        def to_hash
+          self.class.service_properties.map(&:name).each_with_object({}) do |name, hash|
+            hash[name] = public_send(name)
+          end
+        end
+
+        # Returns whether or not this record will be destroyed as part of
+        # the parents save transaction.
+        #
+        # @note Override ActiveRecord::AutosaveAssociation#marked_for_destruction?.
+        def marked_for_destruction?
+          false
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+require "active_support/concern"
+require "active_support/inflector"
+
+module Qiita::Team::Services
+  module Hooks
+    module Concerns
+      module Service
+        extend ActiveSupport::Concern
+
+        class_methods do
+          # @return [String]
+          def hook_type
+            name.demodulize.underscore
+          end
+
+          # @return [String]
+          def service_name
+            fail NotImplementedError
+          end
+        end
+
+        # The service name.
+        #
+        # @return [String]
+        def name
+          self.class.service_name
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,338 @@
+require "active_support/concern"
+require "slacken"
+
+require "qiita/team/services/hooks/concerns/http_client"
+
+module Qiita::Team::Services
+  module Hooks
+    module Concerns
+      # Send richly-formatted messages to Slack.
+      # Override {HttpClient#url} to implement HttpClient.
+      #
+      # @see https://api.slack.com/docs/attachments
+      module Slack
+        extend ActiveSupport::Concern
+
+        DEFAULT_ICON_URL = "https://cdn.qiita.com/media/qiita-team-slack-icon.png".freeze
+        ICON_EMOJI_FORMAT = /\A:[^:]+:\z/
+
+        included do
+          include HttpClient
+
+          define_property :username, default: "Qiita:Team"
+          define_property :icon_emoji
+
+          validates :username, presence: true
+          validates :icon_emoji, format: { with: ICON_EMOJI_FORMAT }, allow_blank: true
+        end
+
+        class_methods do
+          # @note Override {Services::Base.service_name}.
+          def service_name
+            "Slack"
+          end
+        end
+
+        # @return [void]
+        def ping
+          fallback = "Test message sent from Qiita:Team"
+          send_message(attachments: [fallback: fallback, pretext: fallback])
+        rescue DeliveryError
+          nil
+        end
+
+        # @param event [Qiita::Team::Services::Events::ItemCreated]
+        # @return [void]
+        # @raise [Qiita::Team::Services::DeliveryError]
+        def item_created(event)
+          fallback = "#{user_link(event.user)} created a new post"
+          send_message(
+            attachments: [
+              fallback: fallback,
+              pretext: fallback,
+              author_name: "@#{event.user.url_name}",
+              author_link: event.user.url,
+              author_icon: event.user.profile_image_url,
+              title: event.item.title,
+              title_link: event.item.url,
+              text: Slacken.translate(event.item.rendered_body),
+              mrkdwn_in: ["text"],
+            ],
+          )
+        end
+
+        # @param event [Qiita::Team::Services::Events::ItemUpdated]
+        # @return [void]
+        # @raise [Qiita::Team::Services::DeliveryError]
+        def item_updated(event)
+          fallback = "#{user_link(event.user)} updated #{item_link(event.item)}"
+          send_message(
+            attachments: [
+              fallback: fallback,
+              pretext: fallback,
+            ],
+          )
+        end
+
+        # @param event [Qiita::Team::Services::Events::ItemBecameCoediting]
+        # @return [void]
+        # @raise [Qiita::Team::Services::DeliveryError]
+        def item_became_coediting(event)
+          fallback = "#{user_link(event.user)} changed #{item_link(event.item)} to coedit mode"
+          send_message(
+            attachments: [
+              fallback: fallback,
+              pretext: fallback,
+            ],
+          )
+        end
+
+        # @param event [Qiita::Team::Services::Events::ItemDestroyed]
+        # @return [void]
+        # @raise [Qiita::Team::Services::DeliveryError]
+        def item_destroyed(event)
+          fallback = "#{user_link(event.user)} deleted #{event.item.title}"
+          send_message(
+            attachments: [
+              fallback: fallback,
+              pretext: fallback,
+            ],
+          )
+        end
+
+        # @param event [Qiita::Team::Services::Events::ItemCommentCreated]
+        # @return [void]
+        # @raise [Qiita::Team::Services::DeliveryError]
+        def item_comment_created(event)
+          fallback =
+            if event.item.coediting?
+              "New comment on #{item_link(event.item)}"
+            else
+              "New comment on #{user_link(event.item.user)}'s #{item_link(event.item)}"
+            end
+          send_message(
+            attachments: [
+              fallback: fallback,
+              pretext: fallback,
+              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),
+              mrkdwn_in: ["text"],
+            ],
+          )
+        end
+
+        # @param event [Qiita::Team::Services::Events::ItemCommentUpdated]
+        # @return [void]
+        # @raise [Qiita::Team::Services::DeliveryError]
+        def item_comment_updated(event)
+          fallback = "#{user_link(event.user)} updated a #{comment_link(event.comment)}"
+          fallback << " on #{item_link(event.item)}"
+          send_message(
+            attachments: [
+              fallback: fallback,
+              pretext: fallback,
+            ],
+          )
+        end
+
+        # @param event [Qiita::Team::Services::Events::ItemCommentDestroyed]
+        # @return [void]
+        # @raise [Qiita::Team::Services::DeliveryError]
+        def item_comment_destroyed(event)
+          fallback = "#{user_link(event.user)} deleted a comemnt on #{item_link(event.item)}"
+          send_message(
+            attachments: [
+              fallback: fallback,
+              pretext: fallback,
+            ],
+          )
+        end
+
+        # @param event [Qiita::Team::Services::Events::ProjectCommentCreated]
+        # @return [void]
+        # @raise [Qiita::Team::Services::DeliveryError]
+        def project_comment_created(event)
+          fallback = "New comment on #{project_link(event.project)}"
+          send_message(
+            attachments: [
+              fallback: fallback,
+              pretext: fallback,
+              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),
+              mrkdwn_in: ["text"],
+            ],
+          )
+        end
+
+        # @param event [Qiita::Team::Services::Events::ProjectCommentUpdated]
+        # @return [void]
+        # @raise [Qiita::Team::Services::DeliveryError]
+        def project_comment_updated(event)
+          fallback = "#{user_link(event.user)} updated a #{comment_link(event.comment)}"
+          fallback << " on #{project_link(event.project)}"
+          send_message(
+            attachments: [
+              fallback: fallback,
+              pretext: fallback,
+            ],
+          )
+        end
+
+        # @param event [Qiita::Team::Services::Events::ProjectCommentDestroyed]
+        # @return [void]
+        # @raise [Qiita::Team::Services::DeliveryError]
+        def project_comment_destroyed(event)
+          fallback = "#{user_link(event.user)} deleted a comemnt on #{project_link(event.project)}"
+          send_message(
+            attachments: [
+              fallback: fallback,
+              pretext: fallback,
+            ],
+          )
+        end
+
+        # @param event [Qiita::Team::Services::Events::MemberAdded]
+        # @return [void]
+        # @raise [Qiita::Team::Services::DeliveryError]
+        def team_member_added(event)
+          fallback = "#{user_link(event.member)} was added to the #{team_link(event.team)} team"
+          send_message(
+            attachments: [
+              fallback: fallback,
+              pretext: fallback,
+            ],
+          )
+        end
+
+        # @param event [Qiita::Team::Services::Events::MemberRemoved]
+        # @return [void]
+        # @raise [Qiita::Team::Services::DeliveryError]
+        def team_member_removed(event)
+          fallback = "#{event.member.name} was removed from the #{team_link(event.team)} team"
+          send_message(
+            attachments: [
+              fallback: fallback,
+              pretext: fallback,
+            ],
+          )
+        end
+
+        # @param event [Qiita::Team::Services::Events::ProjectCreated]
+        # @return [void]
+        # @raise [Qiita::Team::Services::DeliveryError]
+        def project_created(event)
+          fallback = "#{user_link(event.user)} created #{project_link(event.project)} project"
+          send_message(
+            attachments: [
+              fallback: fallback,
+              pretext: fallback,
+            ],
+          )
+        end
+
+        # @param event [Qiita::Team::Services::Events::ProjectUpdated]
+        # @return [void]
+        # @raise [Qiita::Team::Services::DeliveryError]
+        def project_updated(event)
+          fallback = "#{user_link(event.user)} updated #{project_link(event.project)} project"
+          send_message(
+            attachments: [
+              fallback: fallback,
+              pretext: fallback,
+            ],
+          )
+        end
+
+        # @param event [Qiita::Team::Services::Events::ProjectDestroyed]
+        # @return [void]
+        # @raise [Qiita::Team::Services::DeliveryError]
+        def project_destroyed(event)
+          fallback = "#{user_link(event.user)} deleted #{project_link(event.project)} project"
+          send_message(
+            attachments: [
+              fallback: fallback,
+              pretext: fallback,
+            ],
+          )
+        end
+
+        # @param event [Qiita::Team::Services::Events::ProjectArchived]
+        # @return [void]
+        # @raise [Qiita::Team::Services::DeliveryError]
+        def project_archived(event)
+          fallback = "#{user_link(event.user)} archived #{project_link(event.project)} project"
+          send_message(
+            attachments: [
+              fallback: fallback,
+              pretext: fallback,
+            ],
+          )
+        end
+
+        # @param event [Qiita::Team::Services::Events::ProjectActivated]
+        # @return [void]
+        # @raise [Qiita::Team::Services::DeliveryError]
+        def project_activated(event)
+          fallback = "#{user_link(event.user)} activated #{project_link(event.project)} project"
+          send_message(
+            attachments: [
+              fallback: fallback,
+              pretext: fallback,
+            ],
+          )
+        end
+
+        private
+
+        # @param request_body [Hash]
+        # @return [void]
+        def send_message(request_body)
+          http_post(user_hash.merge(request_body))
+        end
+
+        # @return [Hash]
+        def user_hash
+          if icon_emoji.blank?
+            { username: username, icon_url: DEFAULT_ICON_URL }
+          else
+            { username: username, icon_emoji: icon_emoji }
+          end
+        end
+
+        # @param user [Qiita::Team::Services::Resources::User]
+        # @return [String]
+        def user_link(user)
+          "<#{user.url}|#{user.name}>"
+        end
+
+        # @param item [Qiita::Team::Services::Resources::Item]
+        # @return [String]
+        def item_link(item)
+          "<#{item.url}|#{item.title}>"
+        end
+
+        # @param comment [Qiita::Team::Services::Resources::Comment]
+        # @return [String]
+        def comment_link(comment)
+          "<#{comment.url}|comment>"
+        end
+
+        # @param project [Qiita::Team::Services::Resources::Project]
+        # @return [String]
+        def project_link(project)
+          "<#{project.url}|#{project.name}>"
+        end
+
+        # @param team [Qiita::Team::Services::Resources::Team]
+        # @return [String]
+        def team_link(team)
+          "<#{team.url}|#{team.name}>"
+        end
+      end
+    end
+  end
+end