teams_connector 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6a72ee260e0976efb58e9871414f88ea25090fef32d9786a9d0b2b5dad252be
-  data.tar.gz: 8a17c4cf19aa3313bd2361a2a2ca5524ba354d6be8079f594ef065209fd60c44
+  metadata.gz: 40959c6f8d45faa4aa12b64948404cc58fcb6d382088a0d62a1407256472892b
+  data.tar.gz: 02cc425ed3911368332604643bb923423b22349c4934567395655312590b7dd9
 SHA512:
-  metadata.gz: 51b2a71c1d50f252f1804a037e546d9e240707553f7052128b31191e1c28316177a95afb598eadfff11d1a7dd414eaa7d53294dd64da859fc9d3c6f73112af74
-  data.tar.gz: 9f39957ce3655246af7404d99b1f7281c0cc200257faf3ccf4c64ec02d45cd83ef08264e47f8769c0fc2affab1a7cfedf9ce10e60a876a8b9cff21aed2fd6a89
+  metadata.gz: 2687ee07637e06bd3fb52bd4bdef9c9997ab1fc37e8736d0eaa54879d726f254053b796f0e4552b222127b7b8d97c5feaf73c1774dffa35fe1e33a009660e0fa
+  data.tar.gz: 841a4a799f57f98adf218fec0b555d13028412ade5a59438a0ff9ef5d8f7859d11f82f10587f9b47faddb3042b3f2c5cd9f83d51b68eefad4d6dbdb1051b3866

data/CHANGES.md

@@ -1,5 +1,9 @@
 # Teams Connector Changelog
 
+0.1.2
+---
+- Use `TeamsConnector::Configuration#load_from_rails_credentials` to load encrypted channel URLs in your Rails environment
+
 0.1.1
 ---
 - Adaptive Card Notification

data/README.md

@@ -25,10 +25,10 @@ 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`.
+After setting up the Incoming Webhook Connector for your Microsoft Teams channel, it is as simple as configuring the channel and creating a new `TeamsConnector::Notification`.
 
 ```ruby
-# Configuration
+# TeamsConnector initializer
 TeamsConnector.configure do |config|
   config.channel :channel_id, "https://<YOUR COMPLETE WEBHOOK URL GOES HERE>"
 end
@@ -46,9 +46,38 @@ content = {
 }
 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
+### Secure Channel Configuration
+Since the Incoming Webhook Connector does not allow any authentication at the endpoint it is crucial that you keep your channel urls secret.
+At best nobody finds the url but it can also lead to spam or even faking of critical messages.
+
+In Rails provides the credentials functionality for [environmental security](https://edgeguides.rubyonrails.org/security.html#environmental-security). This mechanism can be used by TeamsConnector to load channels from an encrypted file. This also allows easy separation of production and development channel URLs.
+All channels are defined under the top-level entry `teams_connector` and will be identified by their key.
+```yaml
+# $ bin/rails credentials:edit
+teams_connector:
+  default: "<INSERT DEFAULT URL HERE>"
+  sales: "<INSERT URL FOR THE :sales CHANNEL HERE>"
+```
+
+After configuration of the credentials you can load the channels in your initializer.
+Since `#load_from_rails_configuration` is a wrapper around `#channel` both methods can be used together.
+
+```ruby
+# TeamsConnector initializer
+TeamsConnector.configure do |config|
+  config.load_from_rails_credentials
+  # After loading the :default channel is available and can be set as the default 
+  config.default = :default
+  config.channel :another_channel, "<URL>"
+end
+```
+
+### Templates
+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
 -----|-------
@@ -56,13 +85,13 @@ Template name | Description
 :facts_card | A card with title, subtitle and a list of facts
 :test_card | A simple text message without any configurable content for testing
 
-### Custom Templates
+#### Custom Templates
 
 Custom templates are stored in the directory specified by the configuration option `template_dir`. As an array of strings, describing the path relative to the project root. When using Rails or Bundler their root is used, otherwise it is the current working directory.
 
 Templates are json files with the extension `.json.erb`. The file is parsed and populated by the ruby ERB module.
 
-### Builder
+#### Builder
 
 You can use TeamsConnector::Builder to create Adaptive Cards directly in ruby. YOu can output the result of the builder as JSON for future use with `TeamsController::Notification::AdaptiveCard#pretty_print`.
 

data/lib/teams_connector/configuration.rb

@@ -27,5 +27,16 @@ module TeamsConnector
     def channel(name, url)
       @channels[name] = url;
     end
+
+    def load_from_rails_credentials
+      unless defined? Rails
+        raise RuntimeError, "This method is only available in Ruby on Rails."
+      end
+
+      webhook_urls = Rails.application.credentials.teams_connector!
+      webhook_urls.each do |entry|
+        channel(entry[0], entry[1])
+      end
+    end
   end
 end

data/lib/teams_connector/version.rb

@@ -1,3 +1,3 @@
 module TeamsConnector
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teams_connector
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Lucas Keune
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-15 00:00:00.000000000 Z
+date: 2021-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler