qiita_team_services 0.3.1

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

@@ -0,0 +1,143 @@
+require "hipchat"
+
+require "qiita/team/services/hooks/base"
+
+module Qiita::Team::Services
+  module Hooks
+    class HipchatV1 < Base
+      AVAILABLE_COLORS = %w(yellow red green purple random).freeze
+
+      define_property :color, default: "yellow"
+      define_property :from, default: "Qiita:Team"
+      define_property :room
+      define_property :token
+      define_property :with_notification, default: false, type: :boolean
+
+      validates :color, inclusion: AVAILABLE_COLORS
+      validates :from, presence: true
+      validates :room, presence: true
+      validates :token, presence: true
+      validates :with_notification, inclusion: [true, false]
+
+      # @note Override {Services::Base.service_name}.
+      def self.service_name
+        "HipChat"
+      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 "#{user_link(event.user)} created #{item_link(event.item)}."
+      end
+
+      # @param event [Qiita::Team::Services::Events::ItemUpdated]
+      # @return [void]
+      # @raise [Qiita::Team::Services::DeliveryError]
+      def item_updated(event)
+        send_message "#{user_link(event.user)} updated #{item_link(event.item)}."
+      end
+
+      # @param event [Qiita::Team::Services::Events::ItemBecameCoediting]
+      # @return [void]
+      # @raise [Qiita::Team::Services::DeliveryError]
+      def item_became_coediting(event)
+        send_message "#{user_link(event.user)} changed #{item_link(event.item)} to coedit mode."
+      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
+        #{user_link(event.user)} commented on #{item_link(event.item)}.
+        <pre>#{event.comment.body.truncate(100)}</pre>
+        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
+        #{user_link(event.user)} commented on #{project_link(event.project)}.
+        <pre>#{event.comment.body.truncate(100)}</pre>
+        EOM
+      end
+
+      # @param event [Qiita::Team::Services::Events::MemberAdded]
+      # @return [void]
+      # @raise [Qiita::Team::Services::DeliveryError]
+      def team_member_added(event)
+        send_message("#{user_link(event.member)} was 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("#{user_link(event.user)} created #{project_link(event.project)} project.")
+      end
+
+      # @param event [Qiita::Team::Services::Events::ProjectUpdated]
+      # @return [void]
+      # @raise [Qiita::Team::Services::DeliveryError]
+      def project_updated(event)
+        send_message("#{user_link(event.user)} updated #{project_link(event.project)} project.")
+      end
+
+      # @param event [Qiita::Team::Services::Events::ProjectActivated]
+      # @return [void]
+      # @raise [Qiita::Team::Services::DeliveryError]
+      def project_activated(event)
+        send_message("#{user_link(event.user)} activated #{project_link(event.project)} project.")
+      end
+
+      # @param event [Qiita::Team::Services::Events::ProjectArchived]
+      # @return [void]
+      # @raise [Qiita::Team::Services::DeliveryError]
+      def project_archived(event)
+        send_message("#{user_link(event.user)} archived #{event.project.name} project.")
+      end
+
+      private
+
+      # @param message [String]
+      def send_message(message)
+        client.send(from, message, color: color, notify: with_notification)
+      rescue HipChat::UnknownRoom, HipChat::Unauthorized, HipChat::UnknownResponseCode
+        raise DeliveryError
+      end
+
+      # @return [HipChat::Client] configured with API v1.
+      def client
+        @client ||= HipChat::Client.new(token)[room]
+      end
+
+      # @param user [Qiita::Team::Services::Resources::User]
+      # @return [String]
+      def user_link(user)
+        "<a href='#{user.url}'>#{user.name}</a>"
+      end
+
+      # @param item [Qiita::Team::Services::Resources::Item]
+      # @return [String]
+      def item_link(item)
+        "<a href='#{item.url}'>#{item.title}</a>"
+      end
+
+      # @param project [Qiita::Team::Services::Resources::Project]
+      # @return [String]
+      def project_link(project)
+        "<a href='#{project.url}'>#{project.name}</a>"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require "qiita/team/services/hooks/base"
+require "qiita/team/services/hooks/concerns/slack"
+
+module Qiita::Team::Services
+  module Hooks
+    class SlackV1 < Base
+      deprecated
+
+      include Concerns::Slack
+
+      define_property :teamname
+      define_property :integration_token
+
+      validates :teamname, presence: true
+      validates :integration_token, presence: true
+
+      private
+
+      # @note Implement Concerns::HttpClient#url.
+      def url
+        "https://#{teamname}.slack.com/services/hooks/incoming-webhook?token=#{integration_token}"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require "qiita/team/services/hooks/base"
+require "qiita/team/services/hooks/concerns/slack"
+
+module Qiita::Team::Services
+  module Hooks
+    class SlackV2 < Base
+      include Concerns::Slack
+
+      define_property :webhook_url
+
+      validates :webhook_url, presence: true
+
+      private
+
+      # @note Implement Concerns::HttpClient#url.
+      alias_method :url, :webhook_url
+    end
+  end
+end

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

@@ -0,0 +1,193 @@
+require "securerandom"
+
+require "qiita/team/services/hooks/base"
+
+module Qiita::Team::Services
+  module Hooks
+    class Webhook < Base
+      include Concerns::HttpClient
+
+      define_property :url
+      define_property :token
+
+      validates :token, format: %r{\A[A-Za-z0-9+/=]{20,40}\z}
+      validates :url, presence: true
+
+      # @note Override {Qiita::Team::Services::Hooks::Base.service_name}.
+      def self.service_name
+        "Webhook"
+      end
+
+      # @return [String]
+      def self.generate_token
+        SecureRandom.base64(20)
+      end
+
+      # @param hash [Hash{String => Object}]
+      def initialize(hash)
+        unless hash.key?("token")
+          hash = hash.dup.merge("token" => self.class.generate_token)
+        end
+        super(hash)
+      end
+
+      def ping
+        send_hook(
+          action: "requested",
+          message: "ping",
+          model: "ping",
+        )
+      end
+
+      # @param event [Qiita::Team::Services::Events::ItemCreated]
+      def item_created(event)
+        send_hook(
+          action: "created",
+          model: "item",
+          item: event.resource,
+          user: event.user,
+        )
+      end
+
+      # @param event [Qiita::Team::Services::Events::ItemUpdated]
+      def item_updated(event)
+        send_hook(
+          action: "updated",
+          model: "item",
+          message: event.resource.message,
+          item: event.resource,
+          user: event.user,
+        )
+      end
+
+      # @param event [Qiita::Team::Services::Events::ItemDestroyed]
+      def item_destroyed(event)
+        send_hook(
+          action: "destroyed",
+          model: "item",
+          item: event.resource,
+        )
+      end
+
+      # @param event [Qiita::Team::Services::Events::ItemCommentCreated]
+      def item_comment_created(event)
+        send_hook(
+          action: "created",
+          model: "comment",
+          comment: event.resource,
+          item: event.item,
+        )
+      end
+
+      # @param event [Qiita::Team::Services::Events::ItemCommentUpdated]
+      def item_comment_updated(event)
+        send_hook(
+          action: "updated",
+          model: "comment",
+          comment: event.resource,
+          item: event.item,
+        )
+      end
+
+      # @param event [Qiita::Team::Services::Events::ItemCommentDestroyed]
+      def item_comment_destroyed(event)
+        send_hook(
+          action: "destroyed",
+          model: "comment",
+          comment: event.resource,
+          item: event.item,
+        )
+      end
+
+      # @param event [Qiita::Team::Services::Events::ProjectCommentCreated]
+      def project_comment_created(event)
+        send_hook(
+          action: "created",
+          model: "comment",
+          comment: event.resource,
+          item: event.project,
+        )
+      end
+
+      # @param event [Qiita::Team::Services::Events::ProjectCommentUpdated]
+      def project_comment_updated(event)
+        send_hook(
+          action: "updated",
+          model: "comment",
+          comment: event.resource,
+          item: event.project,
+        )
+      end
+
+      # @param event [Qiita::Team::Services::Events::ProjectCommentDestroyed]
+      def project_comment_destroyed(event)
+        send_hook(
+          action: "destroyed",
+          model: "comment",
+          comment: event.resource,
+          item: event.project,
+        )
+      end
+
+      # @param event [Qiita::Team::Services::Events::TeamMemberAdded]
+      def team_member_added(event)
+        send_hook(
+          action: "added",
+          model: "member",
+          user: event.resource,
+        )
+      end
+
+      # @param event [Qiita::Team::Services::Events::TeamMemberRemoved]
+      def team_member_removed(event)
+        send_hook(
+          action: "removed",
+          model: "member",
+          user: event.resource,
+        )
+      end
+
+      # @param event [Qiita::Team::Services::Events::ProjectCreated]
+      def project_created(event)
+        send_hook(
+          action: "created",
+          model: "project",
+          project: event.resource,
+          user: event.user,
+        )
+      end
+
+      # @param event [Qiita::Team::Services::Events::ProjectUpdated]
+      def project_updated(event)
+        send_hook(
+          action: "updated",
+          model: "project",
+          message: event.resource.message,
+          project: event.resource,
+          user: event.user,
+        )
+      end
+
+      # @param event [Qiita::Team::Services::Events::ProjectDestroyed]
+      def project_destroyed(event)
+        send_hook(
+          action: "destroyed",
+          model: "project",
+          project: event.resource,
+        )
+      end
+
+      private
+
+      def send_hook(properties)
+        http_post(
+          properties.as_json,
+          {
+            "X-Qiita-Event-Model" => properties[:model],
+            "X-Qiita-Token" => token,
+          }.reject { |_key, value| value.nil? },
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Qiita::Team::Services
+  module Hooks
+    class << self
+      # @return [Array<Qiita::Team::Services::Hooks::Base>]
+      def all_hooks
+        @all_hooks ||= []
+      end
+
+      # @return [Array<Qiita::Team::Services::Hooks::Base>]
+      def active_hooks
+        all_hooks.reject(&:deprecated?)
+      end
+
+      # @return [Array<Qiita::Team::Services::Hooks::Base>]
+      def deprecated_hooks
+        all_hooks.select(&:deprecated?)
+      end
+
+      # @return [Array<String>]
+      def all_hook_types
+        all_hooks.map(&:hook_type)
+      end
+    end
+  end
+end

data/lib/qiita/team/services/properties/base.rb

@@ -0,0 +1,20 @@
+require "qiita/team/services/properties"
+
+module Qiita::Team::Services
+  module Properties
+    # @abstract
+    class Base
+      # @return [String]
+      attr_reader :name
+
+      def initialize(name, default)
+        @name = name
+        @default = default
+      end
+
+      def default
+        fail NotImplementedError
+      end
+    end
+  end
+end

data/lib/qiita/team/services/properties/boolean_property.rb

@@ -0,0 +1,12 @@
+require "qiita/team/services/properties/base"
+
+module Qiita::Team::Services
+  module Properties
+    class BooleanProperty < Base
+      # @note Implement {Base#default}.
+      def default
+        @default.nil? ? true : @default
+      end
+    end
+  end
+end

data/lib/qiita/team/services/properties/string_property.rb

@@ -0,0 +1,12 @@
+require "qiita/team/services/properties/base"
+
+module Qiita::Team::Services
+  module Properties
+    class StringProperty < Base
+      # @note Implement {Base#default}.
+      def default
+        @default.nil? ? "" : @default
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module Qiita::Team::Services
+  module Properties
+    class << self
+      # @param name [Symbol]
+      # @param type [Symbol] :string or :boolean.
+      # @param default [String, true, false, nil]
+      def create(name, type, default)
+        # NOTE: Property name must be a string instance to serialize and
+        #       deserialize correctly.
+        case type
+        when :string
+          StringProperty.new(name.to_s, default)
+        when :boolean
+          BooleanProperty.new(name.to_s, default)
+        else
+          ArgumentError
+        end
+      end
+    end
+  end
+end

data/lib/qiita/team/services/resources/README.md

@@ -0,0 +1,177 @@
+# Qiita::Team::Services::Resources
+
+There are several resources in `Qiita::Team::Services::Resources` module.
+They are defined in Qiita core.
+
+- [Team](#team)
+- [User](#team)
+- [Item](#item)
+- [Project](#project)
+- [Comment](#comment)
+- [Tagging](#tagging)
+
+## Team
+
+method  | type   | description
+--------|--------|----------------
+`#id`   | String | Unique team id.
+`#name` | String | Team name.
+`#url`  | String | Team root url.
+
+### Example
+
+```rb
+team.id
+#=> "increments"
+team.name
+#=> "Increments inc."
+team.url
+#=> "https://increments.qiita.com"
+```
+
+## User
+
+method               | type   | description
+---------------------|--------|---------------------
+`#id`                | String | Unique user id.
+`#url_name`          | String | Qiita ID.
+`#name`              | String | Human readable name.
+`#profile_image_url` | String | User icon url.
+`#url`               | String | Url to the user page.
+
+### Example
+
+```rb
+user.id
+#=> 1
+user.url_name
+#=> "qiitan"
+user.name
+#=> "Mr. Qiitan"
+user.profile_image_url
+#=> "https://example.com"
+user.url
+#=> "https://increments.qiita.com/qiitan"
+```
+
+## Item
+
+method           | type                                            | description
+-----------------|-------------------------------------------------|------------------------------------------
+`#id`            | String                                          | Unique id.
+`#title`         | String                                          | Item title.
+`#body`          | String                                          | Item body in Markdown.
+`#rendered_body` | String                                          | Item body in HTML.
+`#url`           | String                                          | Item resource url.
+`#coediting?`    | Boolean                                         | A flag whether this item is co-edit mode.
+`#user`          | User                                            | User who created this item.
+`#tags`          | Array<Qiita::Team::Services::Resouces::Tagging> | Array of tag names.
+`#created_at`    | Time                                            | Time when this item was created.
+`#updated_at`    | Time                                            | Time when this item was last updated.
+
+### Example
+
+```rb
+item.id
+#=> "4bd431809afb1bb99e4f"
+item.title
+#=> "Example title"
+item.body
+#=> "# Example"
+item.rendered_body
+#=> "<h1>Example</h1>
+item.url
+#=> "https://increments.qiita.com/qiitan/items/4bd431809afb1bb99e4f"
+item.coediting?
+#=> false
+item.user
+#=> <Qiita::Team::Services::Resouces::User>
+item.tags
+#=> [<Qiita::Team::Services::Resouces::Tagging>]
+item.created_at
+#=> 2000-01-01T00:00:00+00:00
+item.updated_at
+#=> 2000-01-01T00:00:00+00:00
+```
+
+## Project
+
+method           | type     | description
+-----------------|----------|-------------------------------------
+`#id`            | Fixnum   | Project unique id.
+`#name`          | String   | Project name.
+`#body`          | String   | Project body in Markdown.
+`#rendered_body` | String   | Project body in HTML.
+`#url`           | String   | Project resource url.
+`#archived?`     | Boolean  | A flag whether this project has been archived.
+`#created_at`    | Time     | Time when this project was created.
+`#updated_at`    | Time     | Time when this project was last updated.
+
+### Example
+
+```rb
+project.id
+#=> 1
+project.name
+#=> "Example project"
+project.body
+#=> "# Example"
+project.rendered_body
+#=> "<h1>Example</h1>"
+project.url
+#=> "https://increments.qiita.com/projects/1"
+project.archived?
+#=> false
+project.created_at
+#=> 2000-01-01T00:00:00+00:00
+project.updated_at
+#=> 2000-01-01T00:00:00+00:00
+```
+
+## Comment
+
+method           | type          | description
+-----------------|---------------|----------------------------------------
+`#id`            | String        | Comment unique id.
+`#body`          | String        | Comment body in Markdown.
+`#rendered_body` | String        | Comment body in HTML.
+`#url`           | String        | Comment resource url.
+`#item`          | Item, Project | Commented item or project.
+`#created_at`    | Time          | Time when this comment was created.
+
+### Example
+
+```rb
+comment.id
+#=> "3391f50c35f953abfc4f"
+comment.body
+#=> "# Example"
+comment.rendered_body
+#=> "<h1>Example</h1>
+comment.url
+#=> "https://increments.qiita.com/qiitan/items/4bd431809afb1bb99e4f#comment-3391f50c35f953abfc4f
+comment.item
+#=> <Qiita::Team::Services::Resouces::Item>
+comment.created_at
+#=> 2000-01-01T00:00:00+00:00
+```
+
+## Tagging
+
+method           | type          | description
+-----------------|---------------|----------------------------------------
+`#name`          | String        | Human tag name.
+`#url_name`      | String        | Tag name for URL.
+`#versions`      | Array<String> | Version strings.
+
+### Example
+
+```rb
+
+tagging.name
+#=> "Ruby"
+tagging.url_name
+#=> "ruby"
+tagging.versions
+#=> ["2.2.1"]
+``

data/lib/qiita/team/services/templates/chatwork_v1.html.erb

@@ -0,0 +1,25 @@
+<div class="form-group">
+  <%= label :hook, "properties_token", "#{hook.class.human_attribute_name(:token)} *", class: "control-label" %>
+  <%= text_field_tag "hook[properties][token]", hook.token, class: "form-control" %>
+  <% if hook.errors.key?(:token) %>
+    <br/>
+    <div class="alert alert-warning">
+      <% hook.errors.full_messages_for(:token).each do |message| %>
+        <p><%= message %></p>
+      <% end %>
+    </div>
+  <% end %>
+</div>
+
+<div class="form-group">
+  <%= label :hook, "properties_room_id", "#{hook.class.human_attribute_name(:room_id)} *", class: "control-label" %>
+  <%= text_field_tag "hook[properties][room_id]", hook.room_id, class: "form-control" %>
+  <% if hook.errors.key?(:room_id) %>
+    <br/>
+    <div class="alert alert-warning">
+      <% hook.errors.full_messages_for(:room_id).each do |message| %>
+        <p><%= message %></p>
+      <% end %>
+    </div>
+  <% end %>
+</div>