cgp_teams_connector 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 217d25edd1f919964c84812bb532f2f4e9888b46726e9af2c51e90594e1f984e
+  data.tar.gz: 6614fefbc11cd690a53a452ed931f1fab7ed91f5311fd5dca0189fe38ee5f2a2
+SHA512:
+  metadata.gz: 5c596a5bdb1c93b4f00cc2bc78c1c9aba49be0dbe0b09927f4b0b10c5af460625bc8404102cd4f9da02588b260b33affd5d78fa5f6be167697bbb95dbd452e42
+  data.tar.gz: '0293dcde0dd00786f33038dd0998dd45860ca6548b129f0486d573e081a1e3701d396dacdd3d2ab124beb83efd79180b78e8e2c5af1e91864176f916f0471dfd'

data/.rspec

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

data/.rspec_status

@@ -0,0 +1,4 @@
+example_id                              | status | run_time        |
+--------------------------------------- | ------ | --------------- |
+./spec/cgp_teams_connector_spec.rb[1:1] | passed | 0.0005 seconds  |
+./spec/cgp_teams_connector_spec.rb[1:2] | passed | 0.00042 seconds |

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-03-10
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 masciugo
+
+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,20 @@
+# CgpTeamsConnector
+
+Wrapper od teams_connector gem for CGP microservices usage
+
+## Installation
+
+Install the gem and add to the application's Gemfile after sidekiq (if in use):
+
+    $ gem "cgp_teams_connector"
+
+## Usage
+
+Two notifications example:
+
+    $ CgpTeamsConnector.notify_error(:server, exception, request.uuid)
+    $ CgpTeamsConnector.notify_error(:job, exception, job['jid'])
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/cgp_teams_connector.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "lib/cgp_teams_connector/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "cgp_teams_connector"
+  spec.version = CgpTeamsConnector::VERSION
+  spec.authors = ["masciugo"]
+  spec.email = ["masciugo@gmail.com"]
+
+  spec.summary     = "A gem to send error notifications to Microsoft Teams"
+  spec.description = "Uses teams_connector to send adaptive card messages for server/job errors"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.1.0"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "teams_connector", "~> 0.1"
+  spec.add_dependency "rails", "~> 6.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "byebug"
+
+end

data/lib/cgp_teams_connector/configuration.rb

@@ -0,0 +1,21 @@
+require "teams_connector"
+
+module CgpTeamsConnector
+  class Configuration
+    attr_accessor :channel, :ignored_exceptions, :method, :app_name
+
+    def initialize
+      @ignored_exceptions = []
+    end
+
+    def method=(arg)
+      TeamsConnector.configuration.method=(arg)
+    end
+
+    def default_channel=(arg)
+      TeamsConnector.configuration.channel :default, arg
+      TeamsConnector.configuration.default = :default
+    end
+
+  end
+end

data/lib/cgp_teams_connector/initializer.rb

@@ -0,0 +1,11 @@
+require "teams_connector"
+
+class TeamsConnector::Notification
+  def find_template
+    spec = Gem::Specification.find_by_name('cgp_teams_connector')
+    path = File.join(spec.gem_dir,'lib', 'cgp_teams_connector','templates', "#{@template}.json.erb")
+    raise ArgumentError, "The template '#{@template}' is not available." unless File.exist? path
+    path
+  end
+
+end

data/lib/cgp_teams_connector/templates/wide_adaptive_card.json.erb

@@ -0,0 +1,19 @@
+{
+  "type": "message",
+  "attachments": [
+    {
+      "contentType": "application/vnd.microsoft.card.adaptive",
+      "contentUrl": null,
+      "padding": "None",
+      "content": {
+        "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
+        "type": "AdaptiveCard",
+        "version": "1.2",
+        "msteams": { "width": "full" },
+        "body": [
+          <%= @content[:card].map {|k| k.to_json}.join(", ") %>
+        ]
+      }
+    }
+  ]
+}

data/lib/cgp_teams_connector/version.rb

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

data/lib/cgp_teams_connector.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+require_relative "cgp_teams_connector/version"
+require_relative "cgp_teams_connector/initializer"
+require_relative "cgp_teams_connector/configuration"
+
+module CgpTeamsConnector
+
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :config
+
+    def configure
+      self.config ||= Configuration.new
+      yield(config) if block_given?
+    end
+
+    def notify_error(type, exception, id = nil)
+      return if config.ignored_exceptions.include?(exception.class)
+
+      content = {
+        card: [
+          {
+            type: "Container",
+            items: [
+              {
+                type: "TextBlock",
+                text: "[#{config.app_name}] #{type.to_s.upcase} ERROR",
+                size: "ExtraLarge",
+                weight: "Bolder",
+                color: "Attention"
+              },
+              {
+                type: "TextBlock",
+                text: "**#{exception.class}**#{id ? " [#{type} ID: #{id}]" : nil}"
+              },
+              {
+                type: "CodeBlock",
+                codeSnippet: exception.message,
+                language: "PlainText"
+              },
+              {
+                type: "CodeBlock",
+                codeSnippet: exception.backtrace.first(5).join("\n"),
+                language: "bash"
+              }
+            ]
+          }
+        ]
+      }
+      msg = TeamsConnector::Notification::Message.new(:wide_adaptive_card, nil, content)
+      msg.deliver_later
+    end
+
+  end
+end

data/sig/cgp_teams_connector.rbs

@@ -0,0 +1,4 @@
+module CgpTeamsConnector
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: cgp_teams_connector
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- masciugo
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: teams_connector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Uses teams_connector to send adaptive card messages for server/job errors
+email:
+- masciugo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rspec_status"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- cgp_teams_connector.gemspec
+- lib/cgp_teams_connector.rb
+- lib/cgp_teams_connector/configuration.rb
+- lib/cgp_teams_connector/initializer.rb
+- lib/cgp_teams_connector/templates/wide_adaptive_card.json.erb
+- lib/cgp_teams_connector/version.rb
+- sig/cgp_teams_connector.rbs
+homepage:
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+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.4.14
+signing_key:
+specification_version: 4
+summary: A gem to send error notifications to Microsoft Teams
+test_files: []