ms_teams_notification 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bfb249a3e91d820836863718c53f9e86c2a454de8619faefb25e1b9720cf7640
+  data.tar.gz: c988cb1572833486317fde003f0cb9a8c54d36f9feb3bc6204408e5a3a416276
+SHA512:
+  metadata.gz: 70f0fb885391cb86803aba55c243dbe51cd5a898ee943d068fdbcbcab8713bb1da6dd44d704521260cd98cb4c86e8198ca5a937a9c154d761d796f5948f43b8e
+  data.tar.gz: '0859660f2eae0ef259a3509151acfd7e54673da2d2e2b71b970071b5c487e1f6ac94a6c781a7e6c0baecaadbfee4f9bc220ac2d57db9ea9e89958885177b8934'

data/.ruby-gemset

@@ -0,0 +1 @@
+ms_teams_notification

data/.ruby-version

@@ -0,0 +1 @@
+3.3.1

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Abdullah Barrak
+
+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.

data/README.md

@@ -0,0 +1,57 @@
+# MS Teams Notifier
+
+A ruby library from simple notification capablities for Microsoft Teams.
+
+> Extracted from [volume sweeper](https://github.com/abarrak/volume_sweeper/blob/main/lib/volume_sweeper) tool.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add ms_teams_notification
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install ms_teams_notification
+```
+
+## Usage
+
+You can build your notifer per configuration:
+
+```ruby
+opts = { ms_teams_webhook: "", notification_subject: "Notice: for service maintenance" }
+notifier = MsTeamsNotification::Base.new **options
+```
+
+**Optionally** you can formlate a rich message with formatter.
+THe formatter accepts a hash of additional fields that will be appended as list after the message.
+
+```ruby
+text = "The system will undergo maintenace today."
+text_opts = { time: Time.now, support_phone: "9304-1343"}
+
+message = MsTeamsNotification::Formatter.formlate_meessage text, text_opts
+```
+
+Then, fire it:
+
+```ruby
+notifier.send_ms_teams_notice message
+```
+
+
+## API Docs
+
+The gem specs can [be found at RubyDocs.](https://www.rubydoc.info/gems/ms_teams_notification)
+
+## Contributing
+
+Bug reports and pull requests are welcome [on GitHub](https://github.com/abarrak/ms_teams_notification).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/ms_teams_notification/base.rb

@@ -0,0 +1,62 @@
+require 'uri'
+require 'active_support/core_ext/object/blank'
+require_relative 'logger'
+
+module MsTeamsNotification
+  class Base
+
+    attr_reader :default_subject
+
+    def initialize **kwargs
+      @log = MsTeamsNotification::Logger.instance
+
+      setup_configuration **kwargs
+      configure_ms_teams
+    end
+
+    def send_ms_teams_notice text
+      return unless @webhook_url.present?
+
+      @log.msg "#{self_name}: sending ms teams notification."
+
+      request = Net::HTTP::Post.new @webhook_url.request_uri
+      request['Content-Type'] = 'application/json'
+      request.body = { title: message_subject, text: text }.to_json
+
+      http = Net::HTTP.new @webhook_url.host, @webhook_url.port
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+      body = http.request(request)&.body
+      @log.msg "#{self_name}: ms teams notification is sent."
+      body
+    rescue StandardError => e
+      @log.msg "#{self_name}: ms teams notification failed.", level: :error
+      @log.msg "#{self_name}: #{e.message}.", level: :error
+    end
+
+    private
+
+    def self_name
+      @klass ||= self.class.name.downcase.split(":").last
+    end
+
+    def setup_configuration **opts
+      %i[notification_subject ms_teams_webhook].each do |sym|
+          @log.msg "#{self_name}: argument #{sym} is empty.", level: :warn if opts[sym].blank?
+          instance_variable_set "@#{sym.to_s}", opts[sym]
+      end
+
+      @default_subject = "Automated Notification."
+    end
+
+    def configure_ms_teams
+      return unless @ms_teams_webhook.present?
+      @webhook_url = URI.parse @ms_teams_webhook
+    end
+
+    def message_subject
+      @notification_subject || default_subject
+    end
+  end
+end

data/lib/ms_teams_notification/formatter.rb

@@ -0,0 +1,27 @@
+require 'erb'
+require 'active_support/core_ext/object/blank'
+
+module MsTeamsNotification
+  class Formatter
+
+    def initialize fields
+      @fields = fields
+    end
+
+    def formlate_meessage message, fields_values: nil
+      ERB.new(
+        <<~HTML
+          <%= message %>
+          <u>More Details:</u>
+          <br>
+          <ul style="color: #400707">
+            <% @fields.each do |f| %>
+            <li><%= f #>: <%= fields_values[f] %>.</li>
+            <% end %>
+          </ul>
+        HTML
+      ).result(binding)
+    end
+
+  end
+end

data/lib/ms_teams_notification/logger.rb

@@ -0,0 +1,17 @@
+require 'logger'
+require 'singleton'
+
+module MsTeamsNotification
+  class Logger
+    include Singleton
+
+    def initialize
+      @logger = ::Logger.new STDOUT
+      @logger.level = ::Logger::DEBUG
+    end
+
+    def msg *message, level: :info
+      @logger.send level.to_s, message.join('').to_s if @logger.respond_to?(level)
+    end
+  end
+end

data/lib/ms_teams_notification/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MsTeamsNotification
+  VERSION = "1.0.0"
+end

data/lib/ms_teams_notification.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "ms_teams_notification/version"
+require_relative "ms_teams_notification/base"
+require_relative "ms_teams_notification/formatter"
+
+module MsTeamsNotification
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: ms_teams_notification
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Abdullah Barrak
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A ruby library that offers simple notification capablities for Microsoft
+  Teams.
+email:
+- abdullah@abarrak.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ruby-gemset"
+- ".ruby-version"
+- ".standard.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ms_teams_notification.rb
+- lib/ms_teams_notification/base.rb
+- lib/ms_teams_notification/formatter.rb
+- lib/ms_teams_notification/logger.rb
+- lib/ms_teams_notification/version.rb
+homepage: https://rubygems.org/gems/ms_teams_notification
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/ms_teams_notification
+  source_code_uri: https://github.com/abarrak/ms_teams_notification/blob/main/lib/ms_teams_notification
+  changelog_uri: https://github.com/abarrak/ms_teams_notification/releases
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: A simple ms teams noftifier gem.
+test_files: []