qiita_team_services 0.3.1

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

@@ -0,0 +1,58 @@
+<div class="form-group">
+  <%= label :hook, "properties_color", "#{hook.class.human_attribute_name(:color)} *", class: "control-label" %>
+  <%= select_tag "hook[properties][color]", options_for_select(hook.class::AVAILABLE_COLORS.map { |color| [color, color] }), class: "form-control" %>
+  <% if hook.errors.key?(:color) %>
+    <br/>
+    <div class="alert alert-warning">
+      <% hook.errors.full_messages_for(:color).each do |message| %>
+        <p><%= message %></p>
+      <% end %>
+    </div>
+  <% end %>
+</div>
+
+<div class="form-group">
+  <%= label :hook, "properties_from", "#{hook.class.human_attribute_name(:from)} *", class: "control-label" %>
+  <%= text_field_tag "hook[properties][from]", hook.from, class: "form-control" %>
+  <% if hook.errors.key?(:from) %>
+    <br/>
+    <div class="alert alert-warning">
+      <% hook.errors.full_messages_for(:from).each do |message| %>
+        <p><%= message %></p>
+      <% end %>
+    </div>
+  <% end %>
+</div>
+
+<div class="form-group">
+  <%= label :hook, "properties_room", "#{hook.class.human_attribute_name(:room)} *", class: "control-label" %>
+  <%= text_field_tag "hook[properties][room]", hook.room, class: "form-control" %>
+  <% if hook.errors.key?(:room) %>
+    <br/>
+    <div class="alert alert-warning">
+      <% hook.errors.full_messages_for(:room).each do |message| %>
+        <p><%= message %></p>
+      <% end %>
+    </div>
+  <% end %>
+</div>
+
+<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="checkbox">
+  <label for="hook_properties_with_notification">
+    <%= check_box_tag "hook[properties][with_notification]" %>
+    <%= hook.class.human_attribute_name(:with_notification) %>
+  </label>
+</div>

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

@@ -0,0 +1,54 @@
+<div class="form-group">
+  <%= label :hook, "properties_teamname", "#{hook.class.human_attribute_name(:teamname)} *", class: "control-label" %>
+  <%= text_field_tag "hook[properties][teamname]", hook.teamname, class: "form-control" %>
+  <% if hook.errors.key?(:teamname) %>
+    <br/>
+    <div class="alert alert-warning">
+      <% hook.errors.full_messages_for(:teamname).each do |message| %>
+        <p><%= message %></p>
+      <% end %>
+    </div>
+  <% end %>
+</div>
+
+<div class="form-group">
+  <%= label :hook, "properties_integration_token", "#{hook.class.human_attribute_name(:integration_token)} *", class: "control-label" %>
+  <%= text_field_tag "hook[properties][integration_token]", hook.integration_token, class: "form-control" %>
+  <% if hook.errors.key?(:integration_token) %>
+    <br/>
+    <div class="alert alert-warning">
+      <% hook.errors.full_messages_for(:integration_token).each do |message| %>
+        <p><%= message %></p>
+      <% end %>
+    </div>
+  <% end %>
+</div>
+
+<div class="form-group">
+  <%= label :hook, "properties_username", "#{hook.class.human_attribute_name(:username)} *", class: "control-label" %>
+  <%= text_field_tag "hook[properties][username]", hook.username, class: "form-control" %>
+  <% if hook.errors.key?(:username) %>
+    <br/>
+    <div class="alert alert-warning">
+      <% hook.errors.full_messages_for(:username).each do |message| %>
+        <p><%= message %></p>
+      <% end %>
+    </div>
+  <% end %>
+</div>
+
+<div class="form-group">
+  <%= label :hook, "properties_icon_emoji", "#{hook.class.human_attribute_name(:icon_emoji)}", class: "control-label" %>
+  <%= text_field_tag "hook[properties][icon_emoji]", hook.icon_emoji, class: "form-control" %>
+  <% if hook.errors.key?(:icon_emoji) %>
+    <br/>
+    <div class="alert alert-warning">
+      <% hook.errors.full_messages_for(:icon_emoji).each do |message| %>
+        <p><%= message %></p>
+      <% end %>
+    </div>
+  <% end %>
+  <div class="help-block">
+    <%= I18n.t("qiita.team.services.templates.slack_v2.icon_emoji_help_block_html") %>
+  </div>
+</div>

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

@@ -0,0 +1,44 @@
+<div class="form-group">
+  <%= label :hook, "properties_webhook_url", "#{hook.class.human_attribute_name(:webhook_url)} *", class: "control-label" %>
+  <%= text_field_tag "hook[properties][webhook_url]", hook.webhook_url, class: "form-control" %>
+  <% if hook.errors.key?(:webhook_url) %>
+    <br/>
+    <div class="alert alert-warning">
+      <% hook.errors.full_messages_for(:webhook_url).each do |message| %>
+        <p><%= message %></p>
+      <% end %>
+    </div>
+  <% end %>
+  <div class="help-block">
+    <%= I18n.t("qiita.team.services.templates.slack_v2.webhook_url_help_block_html") %>
+  </div>
+</div>
+
+<div class="form-group">
+  <%= label :hook, "properties_username", "#{hook.class.human_attribute_name(:username)} *", class: "control-label" %>
+  <%= text_field_tag "hook[properties][username]", hook.username, class: "form-control" %>
+  <% if hook.errors.key?(:username) %>
+    <br/>
+    <div class="alert alert-warning">
+      <% hook.errors.full_messages_for(:username).each do |message| %>
+        <p><%= message %></p>
+      <% end %>
+    </div>
+  <% end %>
+</div>
+
+<div class="form-group">
+  <%= label :hook, "properties_icon_emoji", "#{hook.class.human_attribute_name(:icon_emoji)}", class: "control-label" %>
+  <%= text_field_tag "hook[properties][icon_emoji]", hook.icon_emoji, class: "form-control" %>
+  <% if hook.errors.key?(:icon_emoji) %>
+    <br/>
+    <div class="alert alert-warning">
+      <% hook.errors.full_messages_for(:icon_emoji).each do |message| %>
+        <p><%= message %></p>
+      <% end %>
+    </div>
+  <% end %>
+  <div class="help-block">
+    <%= I18n.t("qiita.team.services.templates.slack_v2.icon_emoji_help_block_html") %>
+  </div>
+</div>

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

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

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

@@ -0,0 +1,3 @@
+module Qiita::Team::Services
+  VERSION = "0.3.1"
+end

data/lib/qiita_team_services.rb

@@ -0,0 +1,34 @@
+module Qiita
+  module Team
+    module Services
+    end
+  end
+end
+
+require "qiita/team/services/engine"
+require "qiita/team/services/errors"
+require "qiita/team/services/events/item_became_coediting"
+require "qiita/team/services/events/item_comment_created"
+require "qiita/team/services/events/item_comment_destroyed"
+require "qiita/team/services/events/item_comment_updated"
+require "qiita/team/services/events/item_created"
+require "qiita/team/services/events/item_destroyed"
+require "qiita/team/services/events/item_updated"
+require "qiita/team/services/events/project_activated"
+require "qiita/team/services/events/project_archived"
+require "qiita/team/services/events/project_comment_created"
+require "qiita/team/services/events/project_comment_destroyed"
+require "qiita/team/services/events/project_comment_updated"
+require "qiita/team/services/events/project_created"
+require "qiita/team/services/events/project_destroyed"
+require "qiita/team/services/events/project_updated"
+require "qiita/team/services/events/team_member_added"
+require "qiita/team/services/events/team_member_removed"
+require "qiita/team/services/properties/boolean_property"
+require "qiita/team/services/properties/string_property"
+require "qiita/team/services/hooks/chatwork_v1"
+require "qiita/team/services/hooks/hipchat_v1"
+require "qiita/team/services/hooks/slack_v1"
+require "qiita/team/services/hooks/slack_v2"
+require "qiita/team/services/hooks/webhook"
+require "qiita/team/services/version"

data/qiita_team_services.gemspec

@@ -0,0 +1,42 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+module ::Qiita
+  module Team
+    module Services
+    end
+  end
+end
+
+require "qiita/team/services/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "qiita_team_services"
+  spec.version       = Qiita::Team::Services::VERSION
+  spec.authors       = ["Yuku Takahashi"]
+  spec.email         = ["yuku@qiita.com"]
+  spec.summary       = "Official Qiita:Team Services Integration"
+  spec.homepage      = "https://github.com/increments/qiita-team-services"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 0.9"
+  spec.add_dependency "faraday_middleware", "~> 0.10"
+  spec.add_dependency "rails", "~> 4.2"
+  spec.add_dependency "rails-i18n"
+
+  # Service dependencies
+  spec.add_dependency "hipchat", "~> 1.5.2"
+  spec.add_dependency "slacken", "~> 0.1.3"
+
+  spec.add_development_dependency "factory_girl", "~> 4.5.0"
+  spec.add_development_dependency "ffaker", "~> 2.1"
+  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 "webmock", "~> 1.21"
+  spec.add_development_dependency "yard", "~> 0.8.7"
+end

data/spec/hooks/chatwork_v1_spec.rb

@@ -0,0 +1,118 @@
+describe Qiita::Team::Services::Hooks::ChatworkV1 do
+  include Qiita::Team::Services::Helpers::EventHelper
+  include Qiita::Team::Services::Helpers::HttpClientStubHelper
+  include Qiita::Team::Services::Helpers::HookHelper
+
+  EXPECTED_AVAILABLE_EVENT_NAMES = [
+    :item_became_coediting,
+    :item_comment_created,
+    :item_created,
+    :item_updated,
+    :project_activated,
+    :project_archived,
+    :project_comment_created,
+    :project_created,
+    :project_updated,
+    :team_member_added,
+  ]
+
+  shared_context "Delivery success" do
+    before do
+      stubs = get_http_client_stub(hook)
+      stubs.post("/v1/rooms/#{room_id}/messages") do |_env|
+        [200, { "Content-Type" => "application/json" }, { message_id: 1 }]
+      end
+    end
+  end
+
+  shared_context "Delivery fail" do
+    before do
+      stubs = get_http_client_stub(hook)
+      stubs.post("/v1/rooms/#{room_id}/messages") do |_env|
+        [400, {}, ""]
+      end
+    end
+  end
+
+  let(:hook) do
+    described_class.new(properties)
+  end
+
+  let(:properties) do
+    { "room_id" => room_id, "token" => token }
+  end
+
+  let(:room_id) do
+    1
+  end
+
+  let(:token) do
+    "abc"
+  end
+
+  it_behaves_like "hook"
+
+  describe ".service_name" do
+    subject do
+      described_class.service_name
+    end
+
+    it { should eq "ChatWork" }
+  end
+
+  describe ".available_event_names" do
+    subject do
+      described_class.available_event_names
+    end
+
+    it { should match_array EXPECTED_AVAILABLE_EVENT_NAMES }
+  end
+
+  describe "#ping" do
+    subject do
+      hook.ping
+    end
+
+    it "sends a text message" do
+      expect(hook).to receive(:send_message).with(a_kind_of(String))
+      subject
+    end
+
+    context "when message is delivered successful" do
+      include_context "Delivery success"
+
+      it { expect { subject }.not_to raise_error }
+    end
+
+    context "when message is not delivered" do
+      include_context "Delivery fail"
+
+      it { expect { subject }.not_to raise_error }
+    end
+  end
+
+  EXPECTED_AVAILABLE_EVENT_NAMES.each do |event_name|
+    describe "##{event_name}" do
+      subject do
+        hook.public_send(event_name, public_send("#{event_name}_event"))
+      end
+
+      it "sends a text message" do
+        expect(hook).to receive(:send_message).with(a_kind_of(String))
+        subject
+      end
+
+      context "when message is delivered successfully" do
+        include_context "Delivery success"
+
+        it { expect { subject }.not_to raise_error }
+      end
+
+      context "when message is not delivered successfully" do
+        include_context "Delivery fail"
+
+        it { expect { subject }.to raise_error(Qiita::Team::Services::DeliveryError) }
+      end
+    end
+  end
+end

data/spec/hooks/hipchat_v1_spec.rb

@@ -0,0 +1,139 @@
+describe Qiita::Team::Services::Hooks::HipchatV1 do
+  include Qiita::Team::Services::Helpers::EventHelper
+  include Qiita::Team::Services::Helpers::HookHelper
+
+  EXPECTED_AVAILABLE_EVENT_NAMES = [
+    :item_became_coediting,
+    :item_comment_created,
+    :item_created,
+    :item_updated,
+    :project_activated,
+    :project_archived,
+    :project_comment_created,
+    :project_created,
+    :project_updated,
+    :team_member_added,
+  ]
+
+  shared_context "Delivery success" do
+    before do
+      allow_any_instance_of(HipChat::Room).to receive(:send).and_return(true)
+    end
+  end
+
+  shared_context "Delivery fail" do
+    before do
+      allow_any_instance_of(HipChat::Room).to receive(:send).and_raise(HipChat::UnknownRoom)
+    end
+  end
+
+  let(:hook) do
+    described_class.new(properties)
+  end
+
+  let(:properties) do
+    {
+      "color" => color,
+      "from" => from,
+      "room" => room,
+      "token" => token,
+      "with_notification" => with_notification,
+    }
+  end
+
+  let(:color) do
+    "yellow"
+  end
+
+  let(:from) do
+    "Qiita:Team"
+  end
+
+  let(:room) do
+    "development"
+  end
+
+  let(:token) do
+    "secrethipchattoken"
+  end
+
+  let(:with_notification) do
+    false
+  end
+
+  it_behaves_like "hook"
+
+  describe ".service_name" do
+    subject do
+      described_class.service_name
+    end
+
+    it { should eq "HipChat" }
+  end
+
+  describe ".available_event_names" do
+    subject do
+      described_class.available_event_names
+    end
+
+    it { should match_array EXPECTED_AVAILABLE_EVENT_NAMES }
+  end
+
+  describe "#ping" do
+    subject do
+      hook.ping
+    end
+
+    it "sends a text message" do
+      expect_any_instance_of(HipChat::Room).to receive(:send).with(
+        from,
+        a_kind_of(String),
+        color: color,
+        notify: with_notification,
+      ).once
+      subject
+    end
+
+    context "when message is delivered successful" do
+      include_context "Delivery success"
+
+      it { expect { subject }.not_to raise_error }
+    end
+
+    context "when message is not delivered" do
+      include_context "Delivery fail"
+
+      it { expect { subject }.not_to raise_error }
+    end
+  end
+
+  EXPECTED_AVAILABLE_EVENT_NAMES.each do |event_name|
+    describe "##{event_name}" do
+      subject do
+        hook.public_send(event_name, public_send("#{event_name}_event"))
+      end
+
+      it "sends a text message with HipChat client" do
+        expect_any_instance_of(HipChat::Room).to receive(:send).with(
+          from,
+          a_kind_of(String),
+          color: color,
+          notify: with_notification,
+        ).once
+        subject
+      end
+
+      context "when message is delivered successfully" do
+        include_context "Delivery success"
+
+        it { expect { subject }.not_to raise_error }
+      end
+
+      context "when message is not delivered successfully" do
+        include_context "Delivery fail"
+
+        it { expect { subject }.to raise_error(Qiita::Team::Services::DeliveryError) }
+      end
+    end
+  end
+end

data/spec/hooks/slack_v1_spec.rb

@@ -0,0 +1,55 @@
+describe Qiita::Team::Services::Hooks::SlackV1 do
+  include Qiita::Team::Services::Helpers::HttpClientStubHelper
+  include Qiita::Team::Services::Helpers::HookHelper
+  include Qiita::Team::Services::Helpers::SlackHookHelper
+
+  shared_context "Delivery success" do
+    before do
+      stubs = get_http_client_stub(hook)
+      stubs.post("/services/hooks/incoming-webhook?token=#{integration_token}") do |_env|
+        [200, { "Content-Type" => "application/json" }, { message_id: 1 }]
+      end
+    end
+  end
+
+  shared_context "Delivery fail" do
+    before do
+      stubs = get_http_client_stub(hook)
+      stubs.post("/services/hooks/incoming-webhook?token=#{integration_token}") do |_env|
+        [400, {}, ""]
+      end
+    end
+  end
+
+  let(:hook) do
+    described_class.new(properties)
+  end
+
+  let(:properties) do
+    {
+      "teamname" => teamname,
+      "integration_token" => integration_token,
+      "username" => username,
+      "icon_emoji" => icon_emoji,
+    }
+  end
+
+  let(:teamname) do
+    "increments"
+  end
+
+  let(:integration_token) do
+    "integrationtoken"
+  end
+
+  let(:username) do
+    "qiitan"
+  end
+
+  let(:icon_emoji) do
+    ":qiitan:"
+  end
+
+  it_behaves_like "hook"
+  it_behaves_like "Slack hook"
+end

data/spec/hooks/slack_v2_spec.rb

@@ -0,0 +1,50 @@
+describe Qiita::Team::Services::Hooks::SlackV2 do
+  include Qiita::Team::Services::Helpers::HttpClientStubHelper
+  include Qiita::Team::Services::Helpers::HookHelper
+  include Qiita::Team::Services::Helpers::SlackHookHelper
+
+  shared_context "Delivery success" do
+    before do
+      stubs = get_http_client_stub(hook)
+      stubs.post(webhook_url) do |_env|
+        [200, { "Content-Type" => "application/json" }, { message_id: 1 }]
+      end
+    end
+  end
+
+  shared_context "Delivery fail" do
+    before do
+      stubs = get_http_client_stub(hook)
+      stubs.post(webhook_url) do |_env|
+        [400, {}, ""]
+      end
+    end
+  end
+
+  let(:hook) do
+    described_class.new(properties)
+  end
+
+  let(:properties) do
+    {
+      "webhook_url" => webhook_url,
+      "username" => username,
+      "icon_emoji" => icon_emoji,
+    }
+  end
+
+  let(:webhook_url) do
+    "https://example.com"
+  end
+
+  let(:username) do
+    "qiitan"
+  end
+
+  let(:icon_emoji) do
+    ":qiitan:"
+  end
+
+  it_behaves_like "hook"
+  it_behaves_like "Slack hook"
+end