ms_teams 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6fbb7f62e16f89c6b71560721645badd5d0ddd02753229c92e28788305c09994
+  data.tar.gz: 8fc8cef22666d53c94f0da9b9ff70acb604671c334d6647c73cce75d6b93392f
+SHA512:
+  metadata.gz: b7ca3b0e79592a457882e55b26cd8633fb5f307ca4544888872afe2fc77e34783604cc152e7a32c9503092b32b00cf93050655c70457170e1e77d61d58845ecb
+  data.tar.gz: bd9a78cee380a61afec3dce2150e4106aad4d614e4d95df2a0903b2807985b53284876d7fbdcfcd1a13fd98449ceb75b6ec4a139de10a5f32f9c22d79b2e337d

data/.gitignore

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Kevin Chandler
+
+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,121 @@
+# MS-Teams
+
+A lightweight Ruby gem to send
+[actionable message cards](https://docs.microsoft.com/en-us/outlook/actionable-messages/send-via-connectors)
+to an Office 365 group (Microsoft Teams)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "ms_teams"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ms_teams
+
+## Usage
+
+Sending a simple message with just text:
+
+The most-barebones your message will be will include at least:
+ - `url`: The Incoming Webhook connector generated via Teams
+ - `text`: The text of the message you are sending
+
+Example:
+```ruby
+require "ms_teams"
+
+message = MsTeams::Message.new do |m|
+    m.url = "https://outlook.office.com/...."
+    m.text = "Hello World!"
+end
+
+message.send
+
+```
+
+You can build the message with any supported [card fields](https://docs.microsoft.com/en-us/outlook/actionable-messages/message-card-reference#card-fields).
+This example is taken directly from [Microsoft Docs](https://docs.microsoft.com/en-us/outlook/actionable-messages/send-via-connectors)
+```ruby
+require "ms_teams"
+
+message = MsTeams::Message.new do |m|
+    m.url = "https://outlook.office.com/...."
+    m.themeColor = "0072C6"
+    m.title = "Visit the Outlook Dev Portal"
+    m.text = "Click **Learn More** to learn more about Actionable Messages!"
+    m.potentialAction = [
+        {
+            "@type": "ActionCard",
+            "name": "Send Feedback",
+            "inputs": [{
+                "@type": "TextInput",
+                "id": "feedback",
+                "isMultiline": true,
+                "title": "Let us know what you think about Actionable Messages"
+            }],
+            "actions": [{
+                "@type": "HttpPOST",
+                "name": "Send Feedback",
+                "isPrimary": true,
+                "target": "http://..."
+            }]
+        },
+        {
+            "@type": "OpenUri",
+            "name": "Learn More",
+            "targets": [
+                { "os": "default", "uri": "https://docs.microsoft.com/outlook/actionable-messages" }
+            ]
+        }
+    ]
+end
+
+
+# You can edit any field after the message has been built by modifying the `builder` object
+message.builder.text = "Something new"
+
+message.send
+```
+
+Error Handling:
+
+A non-2xx response code will raise a `MsTeams::Message::FailedRequest` error
+
+```ruby
+# ...
+begin
+    message.send
+rescue MsTeams::Message::FailedRequest => e
+    # Do stuff
+end
+```
+
+
+Building an invalid message object will immediately raise an error
+
+```ruby
+message = MsTeams::Message.new do |m|
+    # no url set
+    m.text = "Hello World"
+end
+
+> ArgumentError (`url` cannot be nil. Must be set during initialization)
+
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/shirts/microsoft-teams-ruby
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/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

data/lib/ms_teams.rb

@@ -0,0 +1,6 @@
+require_relative "ms_teams/version"
+require_relative "ms_teams/message"
+
+module MsTeams
+end
+

data/lib/ms_teams/message.rb

@@ -0,0 +1,69 @@
+require "net/http"
+require "json"
+
+module MsTeams
+  class Message
+    class FailedRequest < StandardError; end
+
+    # Necessary fields to successfully send a message
+    REQUIRED_FIELDS = %w(text url).freeze
+
+    attr_accessor :builder
+
+    # Initializes Team::Messages and builds an OpenStruct object
+    #   from a required block containing arbitrary values
+    #   and validates that the required fields are present
+    # @param block [Proc]
+    def initialize( &block )
+      @builder = OpenStruct.new
+      yield @builder
+      validate
+    end
+
+
+    # POSTs a message to the url.
+    #   If the response is not successful it raises
+    #   a MsTeams::Message::FailedRequest error
+    # @return response [Net:HTTPResponse]
+    def send
+      uri = URI.parse( @builder.url )
+      http = Net::HTTP.new( uri.host, uri.port )
+      http.use_ssl = true
+      response = http.post( uri.path, @builder.to_h.to_json, "Content-Type": "application/json" )
+      unless successful_response?( response )
+        raise FailedRequest, "Unable to send message successfully. Response code `#{response.code}`"
+      end
+      response
+    end
+
+
+    # Ensures that the required fields are present
+    #   Raises an ArgumentError if the required fields are not present.
+    def validate
+      REQUIRED_FIELDS.each do |field|
+        error( field ) if @builder[field].nil? || @builder[field].empty?
+      end
+
+      true
+    end
+
+
+    private
+
+
+    def error( field )
+      raise ArgumentError, "`#{field}` cannot be nil. Must be set during initialization"
+    end
+
+
+    def successful_response?( http_response )
+      code = http_response&.code&.to_i
+      if code < 200 || code >= 300
+        return false
+      end
+
+      true
+    end
+
+  end
+end

data/lib/ms_teams/version.rb

@@ -0,0 +1,3 @@
+module MsTeams
+  VERSION = "1.0.0"
+end

data/ms_teams.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/ms_teams/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ms_teams"
+  spec.version       = MsTeams::VERSION
+  spec.authors       = ["Kevin Chandler", "Jana Abumeri"]
+  spec.email         = ["im.kevin@me.com", "jabumeri@uci.edu"]
+
+  spec.summary       = %q{A lightweight Ruby gem to send actionable message cards to an Office 365 group (Microsoft Teams) }
+  spec.homepage      = "https://github.com/shirts/microsoft-teams-ruby"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/shirts/microsoft-teams-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/shirts/microsoft-teams-ruby/releases"
+
+  # 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(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 3.8"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: ms_teams
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kevin Chandler
+- Jana Abumeri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+description: 
+email:
+- im.kevin@me.com
+- jabumeri@uci.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/setup
+- lib/ms_teams.rb
+- lib/ms_teams/message.rb
+- lib/ms_teams/version.rb
+- ms_teams.gemspec
+homepage: https://github.com/shirts/microsoft-teams-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/shirts/microsoft-teams-ruby
+  source_code_uri: https://github.com/shirts/microsoft-teams-ruby
+  changelog_uri: https://github.com/shirts/microsoft-teams-ruby/releases
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: A lightweight Ruby gem to send actionable message cards to an Office 365
+  group (Microsoft Teams)
+test_files: []