Integrations allow you to push alerts to various platforms. For now, Klaxon supports Slack. We hope to add more in the future. If you’re interested in helping, visit our repo.
+Integrations allow you to push alerts to various platforms. For now, Klaxon supports Slack, Microsoft Teams, and Amazon SQS. We hope to add more in the future. If you’re interested in helping, visit our repo.
| Channel | ++ |
|---|---|
| <%= integration.channel %> | +<%= link_to "Edit", edit_teams_integration_path(integration), class: 'btn btn-default btn-block pull-right', style: "max-width: 136px !important;" %> + | +
It looks like you haven't configured any Slack notifications yet, would you like to? <%= link_to "Go to settings.", integrations_path %> +
It looks like you haven't configured any Teams notifications yet, would you like to? <%= link_to "Go to settings.", integrations_path %> +
Which of the Teams channels that you’ve added should get notification when this item changes?
+ + <% @teams_integrations.each do |teams| %> +Klaxon enables reporters and editors to monitor scores of sites and files on the web for newsworthy changes. Get email and Slack notifications when something changes.
+Klaxon enables reporters and editors to monitor scores of sites and files on the web for newsworthy changes. Get email, Slack, Microsoft Teams, and/or Amazon SQS notifications when something changes.
Integrations allow you to push alerts to various platforms. For now, Klaxon supports Slack. We hope to add more in the future. If you’re interested in helping, visit our repo.
+Integrations allow you to push alerts to various platforms. For now, Klaxon supports Slack, Microsoft Teams, and Amazon SQS. We hope to add more in the future. If you’re interested in helping, visit our repo.
Integrations allow you to push alerts to various platforms. For now, Klaxon supports Slack. We hope to add more in the future. If you’re interested in helping, visit our repo.
+Integrations allow you to push alerts to various platforms. For now, Klaxon supports Slack, Microsoft Teams, and Amazon SQS. We hope to add more in the future. If you’re interested in helping, visit our repo.
Integrations allow you to push alerts to various platforms. For now, Klaxon supports Slack and Amazon SQS. We hope to add more in the future. If you’re interested in helping, visit our repo.
+Integrations allow you to push alerts to various platforms. For now, Klaxon supports Slack, Microsoft Teams, and Amazon SQS. We hope to add more in the future. If you’re interested in helping, visit our repo.
Integrations allow you to push alerts to various platforms. For now, Klaxon supports Slack and Amazon SQS. We hope to add more in the future. If you’re interested in helping, visit our repo.
+Integrations allow you to push alerts to various platforms. For now, Klaxon supports Slack, Microsoft Teams, and Amazon SQS. We hope to add more in the future. If you’re interested in helping, visit our repo.
Klaxon enables reporters and editors to monitor scores of sites and files on the web for newsworthy changes. Get email and Slack notifications when something changes. It’s an open source project being built by The Marshall Project.
+Klaxon enables reporters and editors to monitor scores of sites and files on the web for newsworthy changes. Get email, Slack, Microsoft Teams, and/or Amazon SQS notifications when something changes. It’s an open source project being built by The Marshall Project.
Integrations allow you to push alerts to various platforms. For now, Klaxon supports Teams. We hope to add more in the future. If you’re interested in helping, visit our repo.
+<%= notice %>
+ +| Channel | +Webhook url | ++ | ||
|---|---|---|---|---|
| <%= teams_integration.channel %> | +<%= teams_integration.webhook_url %> | +<%= link_to 'Show', teams_integration %> | +<%= link_to 'Edit', edit_teams_integration_path(teams_integration) %> | +<%= link_to 'Destroy', teams_integration, method: :delete, data: { confirm: 'Are you sure?' } %> | +
Integrations allow you to push alerts to various platforms. For now, Klaxon supports Teams. We hope to add more in the future. If you’re interested in helping, visit our repo.
+<%= notice %>
+ ++ Channel: + <%= @teams_integration.channel %> +
+ ++ Webhook url: + <%= @teams_integration.webhook_url %> +
+ +<%= link_to 'Edit', edit_teams_integration_path(@teams_integration) %> | +<%= link_to 'Back', teams_integrations_path %> diff --git a/config/routes.rb b/config/routes.rb index 78fe2cba..d13c8a93 100644 --- a/config/routes.rb +++ b/config/routes.rb @@ -44,6 +44,7 @@ get '/' => 'integrations#index', as: :integrations resources :slack, as: 'slack_integrations', controller: 'slack_integrations' resources :sqs, as: 'sqs_integrations', controller: 'sqs_integrations' + resources :teams, as: 'teams_integrations', controller: 'teams_integrations' end get '/help' => 'static#help', as: :help diff --git a/data/help.md b/data/help.md index 0a59f3b9..e6b05ad8 100644 --- a/data/help.md +++ b/data/help.md @@ -1,6 +1,6 @@ ## How Klaxon works -Klaxon is a tool that enables journalists and researchers to monitor scores of websites for noteworthy changes. When it finds something new on one of the pages it's watching, it saves a version of it, or a "snapshot,” and emails an alert and pings a Slack channel. +Klaxon is a tool that enables journalists and researchers to monitor scores of websites for noteworthy changes. When it finds something new on one of the pages it's watching, it saves a version of it, or a "snapshot,” and alerts via email, Slack, Microsoft Teams, and/or Amazon SQS. #Bookmark Set-Up diff --git a/db/migrate/20211230105330_create_teams_integrations.rb b/db/migrate/20211230105330_create_teams_integrations.rb new file mode 100644 index 00000000..38439cb6 --- /dev/null +++ b/db/migrate/20211230105330_create_teams_integrations.rb @@ -0,0 +1,10 @@ +class CreateTeamsIntegrations < ActiveRecord::Migration[4.2] + def change + create_table :teams_integrations do |t| + t.string :channel + t.text :webhook_url + + t.timestamps null: false + end + end +end diff --git a/db/schema.rb b/db/schema.rb index c8b20819..e3bf505f 100644 --- a/db/schema.rb +++ b/db/schema.rb @@ -10,7 +10,7 @@ # # It's strongly recommended that you check this file into your version control system. -ActiveRecord::Schema.define(version: 2019_02_23_221320) do +ActiveRecord::Schema.define(version: 2021_12_30_105330) do # These are extensions that must be enabled in order to support this database enable_extension "plpgsql" @@ -72,6 +72,13 @@ t.datetime "updated_at", null: false end + create_table "teams_integrations", id: :serial, force: :cascade do |t| + t.string "channel" + t.text "webhook_url" + t.datetime "created_at", null: false + t.datetime "updated_at", null: false + end + create_table "subscriptions", id: :serial, force: :cascade do |t| t.integer "watcher_id" t.string "watcher_type" diff --git a/spec/controllers/teams_integrations_controller_spec.rb b/spec/controllers/teams_integrations_controller_spec.rb new file mode 100644 index 00000000..c4ecb8ab --- /dev/null +++ b/spec/controllers/teams_integrations_controller_spec.rb @@ -0,0 +1,156 @@ +require 'rails_helper' + +# This spec was generated by rspec-rails when you ran the scaffold generator. +# It demonstrates how one might use RSpec to specify the controller code that +# was generated by Rails when you ran the scaffold generator. +# +# It assumes that the implementation code is generated by the rails scaffold +# generator. If you are using any extension libraries to generate different +# controller code, this generated spec may or may not pass. +# +# It only uses APIs available in rails and/or rspec-rails. There are a number +# of tools you can use to make these specs even more expressive, but we're +# sticking to rails and rspec-rails APIs to keep things simple and stable. +# +# Compared to earlier versions of this generator, there is very limited use of +# stubs and message expectations in this spec. Stubs are only used when there +# is no simpler way to get a handle on the object needed for the example. +# Message expectations are only used when there is no simpler way to specify +# that an instance is receiving a specific message. + +RSpec.describe TeamsIntegrationsController, type: :controller do + + # This should return the minimal set of attributes required to create a valid + # TeamsIntegration. As you add validations to TeamsIntegration, be sure to + # adjust the attributes here as well. + let(:valid_attributes) { + skip("Add a hash of attributes valid for your model") + } + + let(:invalid_attributes) { + skip("Add a hash of attributes invalid for your model") + } + + before(:each) { login } + + describe "GET #index" do + it "assigns all teams_integrations as @teams_integrations" do + teams_integration = TeamsIntegration.create! valid_attributes + get :index, params: {} + expect(assigns(:teams_integrations)).to eq([teams_integration]) + end + end + + describe "GET #show" do + it "assigns the requested teams_integration as @teams_integration" do + teams_integration = TeamsIntegration.create! valid_attributes + get :show, params: {:id => teams_integration.to_param} + expect(assigns(:teams_integration)).to eq(teams_integration) + end + end + + describe "GET #new" do + it "assigns a new teams_integration as @teams_integration" do + get :new, params: {} + expect(assigns(:teams_integration)).to be_a_new(TeamsIntegration) + end + end + + describe "GET #edit" do + it "assigns the requested teams_integration as @teams_integration" do + teams_integration = TeamsIntegration.create! valid_attributes + get :edit, params: {:id => teams_integration.to_param} + expect(assigns(:teams_integration)).to eq(teams_integration) + end + end + + describe "POST #create" do + context "with valid params" do + it "creates a new TeamsIntegration" do + expect { + post :create, params: {:teams_integration => valid_attributes} + }.to change(TeamsIntegration, :count).by(1) + end + + it "assigns a newly created teams_integration as @teams_integration" do + post :create, params: {:teams_integration => valid_attributes} + expect(assigns(:teams_integration)).to be_a(TeamsIntegration) + expect(assigns(:teams_integration)).to be_persisted + end + + it "redirects to the created teams_integration" do + post :create, params: {:teams_integration => valid_attributes} + expect(response).to redirect_to(TeamsIntegration.last) + end + end + + context "with invalid params" do + it "assigns a newly created but unsaved teams_integration as @teams_integration" do + post :create, params: {:teams_integration => invalid_attributes} + expect(assigns(:teams_integration)).to be_a_new(TeamsIntegration) + end + + it "re-renders the 'new' template" do + post :create, params: {:teams_integration => invalid_attributes} + expect(response).to render_template("new") + end + end + end + + describe "PUT #update" do + context "with valid params" do + let(:new_attributes) { + skip("Add a hash of attributes valid for your model") + } + + it "updates the requested teams_integration" do + teams_integration = TeamsIntegration.create! valid_attributes + put :update, params: {:id => teams_integration.to_param, :teams_integration => new_attributes} + teams_integration.reload + skip("Add assertions for updated state") + end + + it "assigns the requested teams_integration as @teams_integration" do + teams_integration = TeamsIntegration.create! valid_attributes + put :update, params: {:id => teams_integration.to_param, :teams_integration => valid_attributes} + expect(assigns(:teams_integration)).to eq(teams_integration) + end + + it "redirects to the teams_integration" do + teams_integration = TeamsIntegration.create! valid_attributes + put :update, params: {:id => teams_integration.to_param, :teams_integration => valid_attributes} + expect(response).to redirect_to(teams_integration) + end + end + + context "with invalid params" do + it "assigns the teams_integration as @teams_integration" do + teams_integration = TeamsIntegration.create! valid_attributes + put :update, params: {:id => teams_integration.to_param, :teams_integration => invalid_attributes} + expect(assigns(:teams_integration)).to eq(teams_integration) + end + + it "re-renders the 'edit' template" do + teams_integration = TeamsIntegration.create! valid_attributes + put :update, params: {:id => teams_integration.to_param, :teams_integration => invalid_attributes} + expect(response).to render_template("edit") + end + end + end + + describe "DELETE #destroy" do + it "destroys the requested teams_integration" do + teams_integration = TeamsIntegration.create! valid_attributes + expect { + delete :destroy, params: {:id => teams_integration.to_param} + }.to change(TeamsIntegration, :count).by(-1) + end + + it "redirects to the teams_integrations list" do + teams_integration = TeamsIntegration.create! valid_attributes + delete :destroy, params: {:id => teams_integration.to_param} + expect(response).to redirect_to(teams_integrations_url) + end + end + +end diff --git a/spec/factories.rb b/spec/factories.rb index dcaf2115..f027d4d4 100644 --- a/spec/factories.rb +++ b/spec/factories.rb @@ -17,6 +17,11 @@ queue_url { "https://sqs.us-east-1.amazonaws.com/1234567890/klaxon-sqs-q-test" } end + factory :teams_integration do + channel { "Klaxon" } + webhook_url { "https://test.webhook.office.com/webhookb2/wxyz-789@1234-abc/IncomingWebhook/abcdefg/abc-def-g1234" } + end + factory :change do end diff --git a/spec/helpers/teams_integrations_helper.rb b/spec/helpers/teams_integrations_helper.rb new file mode 100644 index 00000000..6a7ab013 --- /dev/null +++ b/spec/helpers/teams_integrations_helper.rb @@ -0,0 +1,15 @@ +require 'rails_helper' + +# Specs in this file have access to a helper object that includes +# the TeamsIntegrationsHelper. For example: +# +# describe TeamsIntegrationsHelper do +# describe "string concat" do +# it "concats two strings with spaces" do +# expect(helper.concat_strings("this","that")).to eq("this that") +# end +# end +# end +RSpec.describe TeamsIntegrationsHelper, type: :helper do + pending "add some examples to (or delete) #{__FILE__}" +end diff --git a/spec/models/subscription_spec.rb b/spec/models/subscription_spec.rb index 4e2200f1..4d3e5a32 100644 --- a/spec/models/subscription_spec.rb +++ b/spec/models/subscription_spec.rb @@ -27,4 +27,13 @@ expect(slack_integration.watching).to include(page) end + + it "allows a teams channel to subscribe to a page" do + teams_integration = create(:teams_integration) + page = create(:page) + + teams_integration.subscribe(page) + + expect(teams_integration.watching).to include(page) + end end diff --git a/spec/models/teams_integrations_spec.rb b/spec/models/teams_integrations_spec.rb new file mode 100644 index 00000000..a74f75da --- /dev/null +++ b/spec/models/teams_integrations_spec.rb @@ -0,0 +1,17 @@ +require 'rails_helper' + +RSpec.describe TeamsIntegration, type: :model do + it "generates the correct payload" do + stub_request(:post, /test-webhook.com/) + + page = create(:page, :with_snapshots, snapshot_count: 2) + teams = create(:teams_integration) + + teams.subscribe(page) + + change = page.latest_change + expect(change.after.page).to eq page + + payload = teams.send_notification(change) + end +end diff --git a/spec/requests/teams_integrations_spec.rb b/spec/requests/teams_integrations_spec.rb new file mode 100644 index 00000000..4b69e48d --- /dev/null +++ b/spec/requests/teams_integrations_spec.rb @@ -0,0 +1,6 @@ +require 'rails_helper' + +RSpec.describe "TeamsIntegrations", type: :request do + describe "GET /teams_integrations" do + end +end diff --git a/spec/routing/teams_integrations_routing_spec.rb b/spec/routing/teams_integrations_routing_spec.rb new file mode 100644 index 00000000..956fe80d --- /dev/null +++ b/spec/routing/teams_integrations_routing_spec.rb @@ -0,0 +1,39 @@ +require "rails_helper" + +RSpec.describe TeamsIntegrationsController, type: :routing do + describe "routing" do + + # it "routes to #index" do + # expect(:get => "/teams_integrations").to route_to("teams_integrations#index") + # end + + # it "routes to #new" do + # expect(:get => "/teams_integrations/new").to route_to("teams_integrations#new") + # end + + # it "routes to #show" do + # expect(:get => "/teams_integrations/1").to route_to("teams_integrations#show", :id => "1") + # end + + # it "routes to #edit" do + # expect(:get => "/teams_integrations/1/edit").to route_to("teams_integrations#edit", :id => "1") + # end + + # it "routes to #create" do + # expect(:post => "/teams_integrations").to route_to("teams_integrations#create") + # end + + # it "routes to #update via PUT" do + # expect(:put => "/teams_integrations/1").to route_to("teams_integrations#update", :id => "1") + # end + + # it "routes to #update via PATCH" do + # expect(:patch => "/teams_integrations/1").to route_to("teams_integrations#update", :id => "1") + # end + + # it "routes to #destroy" do + # expect(:delete => "/teams_integrations/1").to route_to("teams_integrations#destroy", :id => "1") + # end + + end +end diff --git a/spec/views/teams_integrations/edit.html.erb_spec.rb b/spec/views/teams_integrations/edit.html.erb_spec.rb new file mode 100644 index 00000000..4bb7cc4d --- /dev/null +++ b/spec/views/teams_integrations/edit.html.erb_spec.rb @@ -0,0 +1,21 @@ +require 'rails_helper' + +RSpec.describe "teams_integrations/edit", type: :view do + # before(:each) do + # @teams_integration = assign(:teams_integration, TeamsIntegration.create!( + # :channel => "MyString", + # :webhook_url => "MyText" + # )) + # end + + # it "renders the edit teams_integration form" do + # render + + # assert_select "form[action=?][method=?]", teams_integration_path(@teams_integration), "post" do + + # assert_select "input#teams_integration_channel[name=?]", "teams_integration[channel]" + + # assert_select "textarea#teams_integration_webhook_url[name=?]", "teams_integration[webhook_url]" + # end + # end +end diff --git a/spec/views/teams_integrations/index.html.erb_spec.rb b/spec/views/teams_integrations/index.html.erb_spec.rb new file mode 100644 index 00000000..edf8f5b7 --- /dev/null +++ b/spec/views/teams_integrations/index.html.erb_spec.rb @@ -0,0 +1,22 @@ +require 'rails_helper' + +RSpec.describe "teams_integrations/index", type: :view do + # before(:each) do + # assign(:teams_integrations, [ + # TeamsIntegration.create!( + # :channel => "Channel", + # :webhook_url => "MyText" + # ), + # TeamsIntegration.create!( + # :channel => "Channel", + # :webhook_url => "MyText" + # ) + # ]) + # end + + # it "renders a list of teams_integrations" do + # render + # assert_select "tr>td", :text => "Channel".to_s, :count => 2 + # assert_select "tr>td", :text => "MyText".to_s, :count => 2 + # end +end diff --git a/spec/views/teams_integrations/new.html.erb_spec.rb b/spec/views/teams_integrations/new.html.erb_spec.rb new file mode 100644 index 00000000..0fb44f69 --- /dev/null +++ b/spec/views/teams_integrations/new.html.erb_spec.rb @@ -0,0 +1,21 @@ +require 'rails_helper' + +RSpec.describe "teams_integrations/new", type: :view do + # before(:each) do + # assign(:teams_integration, TeamsIntegration.new( + # :channel => "MyString", + # :webhook_url => "MyText" + # )) + # end + + # it "renders new teams_integration form" do + # render + + # assert_select "form[action=?][method=?]", teams_integrations_path, "post" do + + # assert_select "input#teams_integration_channel[name=?]", "teams_integration[channel]" + + # assert_select "textarea#teams_integration_webhook_url[name=?]", "teams_integration[webhook_url]" + # end + # end +end diff --git a/spec/views/teams_integrations/show.html.erb_spec.rb b/spec/views/teams_integrations/show.html.erb_spec.rb new file mode 100644 index 00000000..85714611 --- /dev/null +++ b/spec/views/teams_integrations/show.html.erb_spec.rb @@ -0,0 +1,16 @@ +require 'rails_helper' + +RSpec.describe "teams_integrations/show", type: :view do + # before(:each) do + # @teams_integration = assign(:teams_integration, TeamsIntegration.create!( + # :channel => "Channel", + # :webhook_url => "MyText" + # )) + # end + + # it "renders attributes in" do + # render + # expect(rendered).to match(/Channel/) + # expect(rendered).to match(/MyText/) + # end +end