Initial Commit

- Configuration of the gem
- Send basic notifications and simple message cards

Author: Luckeu

.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/.idea/
+
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 1.17.3

CHANGES.md

@@ -0,0 +1,6 @@
+# Teams Connector Changelog
+
+0.1.0
+---
+- Initial commit of the Teams Connector gem
+- Send messages as cards defined by JSON templates to configured Microsoft Teams channels

Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in teams_connector.gemspec
+gemspec

LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Qurasoft GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,67 @@
+# Teams Connector
+
+Welcome to Teams Connector. This gem allows you to easily send messages from your ruby project to Microsoft Teams channels.
+It integrates in your rails project, when you are using bundler or even in plain ruby projects.
+
+The messages can be send synchronous or asynchronous with [Sidekiq](https://github.com/mperham/sidekiq). 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'teams_connector'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install teams_connector
+
+## Usage
+After setting up the Incoming Webhook Connector four your Microsoft Teams channel, it is as simple as configuring the channel and creating a new `TeamsConnector::Notification`.
+
+```ruby
+# Configuration
+TeamsConnector.configure do |config|
+  config.channel :channel_id, "https://<YOUR COMPLETE WEBHOOK URL GOES HERE>"
+end
+
+# Send a test card to your channel
+TeamsConnector::Notification.new(:test_card, :channel_id).deliver_later
+
+# Send a card with a list of facts
+content = {
+  title: "Teams Connector Readme",
+  subtitle: "A list of facts",
+  facts: {
+    "Usage": "Testing the facts Card"
+  }
+}
+TeamsConnector::Notification::Message.new(:facts_card, "This is a summary", content).deliver_later
+```
+This gem provides some basic templates in its default template path. You can also define your own templates in your own path. The default templates will be still available so you can mix and match.
+
+### Default templates
+
+Template name | Description
+-----|-------
+:test_card | A simple text message without any configurable content for testing
+:facts_card | A card with title, subtitle and a list of facts
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/qurasoft/teams_connector. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

bin/console

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "teams_connector"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+TeamsConnector.configure do |config|
+  config.channel :default, "<INSERT YOUR WEBHOOK URL HERE>"
+  config.default = :default
+  config.always_use_default = true
+  config.method = :direct
+end
+
+require "irb"
+IRB.start(__FILE__)

bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

lib/teams_connector.rb

@@ -0,0 +1,39 @@
+require 'teams_connector/configuration'
+require 'teams_connector/version'
+require 'teams_connector/notification'
+require 'teams_connector/notification/message'
+
+module TeamsConnector
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  def self.project_root
+    if defined?(Rails)
+      return Rails.root
+    end
+
+    if defined?(Bundler)
+      return Bundler.root
+    end
+
+    Dir.pwd
+  end
+
+  def self.gem_root
+    spec = Gem::Specification.find_by_name("teams_connector")
+    spec.gem_dir rescue project_root
+  end
+end

lib/teams_connector/configuration.rb

@@ -0,0 +1,31 @@
+module TeamsConnector
+  class Configuration
+    DEFAULT_TEMPLATE_DIR = %w[templates teams_connector]
+
+    attr_accessor :default, :channels, :always_use_default, :method, :template_dir, :color
+
+    def initialize
+      @default = nil
+      @channels = {}
+      @always_use_default = false
+      @method = :direct
+      @template_dir = DEFAULT_TEMPLATE_DIR
+      @color = "3f95b5"
+    end
+
+    def default=(channel)
+      raise ArgumentError, "Desired default channel '#{channel}' is not configured" unless @channels.key?(channel)
+      @default = channel
+    end
+
+    def method=(method)
+      raise ArgumentError, "Method '#{method.to_s}' is not supported" unless [:direct, :sidekiq].include? method
+      raise ArgumentError, "Sidekiq is not available" if method == :sidekiq && !defined? Sidekiq
+      @method = method
+    end
+
+    def channel(name, url)
+      @channels[name] = url;
+    end
+  end
+end

lib/teams_connector/notification.rb

@@ -0,0 +1,46 @@
+require 'erb'
+require 'net/http'
+require 'teams_connector/post_worker' if defined? Sidekiq
+
+module TeamsConnector
+  class Notification
+    attr_accessor :template, :channel
+
+    def initialize(template, channel)
+      @template = template
+      @channel = channel
+    end
+
+    def deliver_later
+      template_path = find_template
+
+      renderer = ERB.new(File.read(template_path))
+      renderer.location = [template_path.to_s, 0]
+
+      url = TeamsConnector.configuration.channels[@channel]
+      url = TeamsConnector.configuration.channels[TeamsConnector.configuration.default] if TeamsConnector.configuration.always_use_default
+      raise ArgumentError, "The Teams channel '#{@channel}' is not available in the configuration." if url.nil?
+
+      content = renderer.result(binding)
+
+      if TeamsConnector.configuration.method == :sidekiq
+        TeamsConnector::PostWorker.perform_async(url, content)
+      else
+        response = Net::HTTP.post(URI(url), content, { "Content-Type": "application/json" })
+        response.value
+      end
+    end
+
+    private
+
+    def find_template
+      path = File.join(TeamsConnector::project_root, *TeamsConnector.configuration.template_dir, "#{@template.to_s}.json.erb")
+      unless File.exist? path
+        path = File.join(TeamsConnector::gem_root, *TeamsConnector::Configuration::DEFAULT_TEMPLATE_DIR, "#{@template.to_s}.json.erb")
+      end
+      raise ArgumentError, "The template '#{@template}' is not available." unless File.exist? path
+
+      path
+    end
+  end
+end

lib/teams_connector/notification/message.rb

@@ -0,0 +1,11 @@
+module TeamsConnector
+  class Notification::Message < Notification
+    attr_accessor :summary, :content
+
+    def initialize(template, summary, content = {}, channel = TeamsConnector.configuration.default)
+      super(template, channel)
+      @summary = summary
+      @content = content
+    end
+  end
+end

lib/teams_connector/post_worker.rb

@@ -0,0 +1,14 @@
+require 'net/http'
+require 'sidekiq/worker'
+
+module TeamsConnector
+  class PostWorker
+    # === Includes ===
+    include Sidekiq::Worker
+
+    def perform(url, content)
+      response = Net::HTTP.post(URI(url), content, { "Content-Type": "application/json" })
+      response.value
+    end
+  end
+end

lib/teams_connector/version.rb

@@ -0,0 +1,3 @@
+module TeamsConnector
+  VERSION = "0.1.0"
+end

spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require "bundler/setup"
+require 'webmock/rspec'
+require 'sidekiq'
+require "teams_connector"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

spec/teams_connector/configuration_spec.rb

@@ -0,0 +1,55 @@
+RSpec.describe TeamsConnector::Configuration do
+  before do
+    TeamsConnector.reset
+  end
+
+  subject { TeamsConnector.configuration }
+
+  it "has a default configuration" do
+    is_expected.to have_attributes(default: nil)
+    is_expected.to have_attributes(channels: {})
+    is_expected.to have_attributes(always_use_default: false)
+    is_expected.to have_attributes(method: :direct)
+    is_expected.to have_attributes(template_dir: %w[templates teams_connector])
+    is_expected.to have_attributes(color: "3f95b5")
+  end
+
+  it "has a function to add a channel" do
+    expect(subject.channels).to be_empty
+    expect { subject.channel :default, "https://test.url/" }.to change { subject.channels }
+    expect(subject.channels.count).to eq 1
+    expect(subject.channels).to include :default
+  end
+
+  context "default=" do
+    it "allows setting an existing channel as default" do
+      subject.channel :new_default, "https.//new.default.url/"
+      expect { subject.default = :new_default }.to change { subject.default }.from(nil).to(:new_default)
+    end
+
+    it "raises an error if a non existing channel is selected as default" do
+      expect { subject.default = :not_existing_channel }.to raise_error ArgumentError
+    end
+  end
+
+  context "method=" do
+    it "supports direct" do
+      subject.method = :direct
+      expect(subject.method).to eq :direct
+    end
+
+    it "supports sidekiq" do
+      subject.method = :sidekiq
+      expect(subject.method).to eq :sidekiq
+    end
+
+    it "does not allow sidekiq when it is not available" do
+      hide_const("Sidekiq")
+      expect { subject.method = :sidekiq }.to raise_error ArgumentError
+    end
+
+    it "does not allow invalid" do
+      expect { subject.method = :invalid }.to raise_error ArgumentError
+    end
+  end
+end