teams_connector 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46a69bacfa1eb6a6b46616d436ff4b8c7890db602ce30c7f082e004e53e161c3
-  data.tar.gz: e98ac0f36a4fc64a1ec41f100ce6b062dc4b1ff4579a2094e2b6d49530b2b5f3
+  metadata.gz: 9ed38230a562264b9117ecea0aef7cd66b1bb7d947056f5b892e88cfaed906af
+  data.tar.gz: e3d01cfa5b8de620938e3f8bbd0c012591dc1ecbaf5b9dc742b03801b20c4d00
 SHA512:
-  metadata.gz: f5183b39ff855da474a6417861020f44b2933a4e93fbc497207eab427802e88a33d41511ca30c90390741baf85f39a72b30804ddf78a302f1247e49bfb3edd69
-  data.tar.gz: b68b7311f4ba4f7fd2b37c99bdc960fef80d0c7528fdad6a06002820df60131c0f4b5ae1eb2f5f08a9d57e54c5a7673ee96add2d9aca7219c76301ccc5d27f14
+  metadata.gz: 683b6a1095609d9f13263c71d7d17c4c466bd3041c334675985d13d4f2e9fd6f9b484354f21779c07b1ea4574fb11e3b10b6fae5e9d5f8fe9fdf2b34f72c27ea
+  data.tar.gz: c0144642fff244b53410dc78f4f6f59570f6354af3f431c6d429878c2fd7c9af377edcafe55a020b08765e40db11bac5a64819321a350d4d1ed05d92379645f6

data/CHANGES.md

@@ -1,5 +1,12 @@
 # Teams Connector Changelog
 
+0.1.5
+---
+- RSpec Matchers for testing, thanks to [rspec-rails](https://github.com/rspec/rspec-rails) for their ActionCable `have_broadcasted_to` matcher as reference
+- README update for testing
+- Sometimes use testing mode internally
+- Fixed code smells
+
 0.1.4
 ---
 - Add rudimentary testing method

data/README.md

@@ -112,18 +112,63 @@ TeamsConnector::Notification::AdaptiveCard.new(content: builder).deliver_later
 ## Testing
 
 To test TeamsConnector integration in your application you can use the `:testing` method.
-Instead of performing real HTTP requests, an array in `TeamsConnector.testing.requests` is filled in chronological order.
+Instead of performing real HTTP requests, an array in `TeamsConnector.testing.requests` is filled with your notifications in chronological order.
 
 The request elements have the following structure:
 ```ruby
 {
   channel: :default,
   template: :facts_card,
-  content: "rendered content",
+  content: '{"rendered content": "in JSON format"}',
   time: Time.now
 }
 ```
 
+### RSpec Matcher
+TeamsConnector provides the `have_sent_notification_to(channel = nil, template = nil)` matcher for RSpec.
+It is available by adding `require "teams_connector/rspec"` to your `spec_helper.rb`.
+The matcher supports filtering notifications by channel and template. If one is not given, it does not filter the notifications by it.
+There exists the alias `send_notification_to` for `have_sent_notification_to`.
+
+```ruby
+it "has sent exactly one notification to the channel" do
+  expect { notification.deliver_later }.to have_sent_notification_to(:channel)
+end
+```
+
+#### Expecting number of notifications
+By default `have_sent_notification_to` expects exactly one matching notification.
+You can change the expected amount by chaining `exactly`, `at_least` or `at_most`.
+
+Example:
+```ruby
+it "has sent less than 10 notifications to the channel" do
+  expect { notification.deliver_later }.to have_sent_notification_to(:channel).at_most(10)
+end
+```
+
+You can also use `once`, `twice` and `thrice` as an alias for `exactly(1..3)`.
+For more readable expectations `times` can be chained.
+
+#### Expecting templates
+The template argument in the matcher does filter the notifications.
+If you expect a template instead, you can chain with `with_template(:template)`.
+
+#### Expecting content
+To expect specific content, you can chain with `with(data = nil, &block)`.
+Data supports other RSpec matchers like `hash_including`.
+The block is called for every notification with the notification content hash and the raw notification itself.
+
+Example:
+```ruby
+expect {
+  notification(:default, :test_card).deliver_later
+}.to have_sent_notification_to(:default).with { |content, notification|
+  expect(notification[:channel]).to eq :default
+  expect(notification[:template]).to eq :test_card
+  expect(content["sections"]).to include(hash_including("activityTitle", "activitySubtitle", "facts", "markdown" => true))
+}
+```
 ## 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.

data/lib/teams_connector/matchers/have_sent_notification_to.rb

@@ -0,0 +1,163 @@
+module TeamsConnector
+  module Matchers
+    class HaveSentNotificationTo
+      include RSpec::Matchers::Composable
+
+      def initialize(channel, template)
+        @filter = {
+          channel: channel,
+          template: template
+        }
+        @block = proc {}
+        @data = nil
+        @template_data = nil
+        set_expected_number(:exactly, 1)
+      end
+
+      def with(data = nil, &block)
+        @data = data
+        @block = block if block
+        self
+      end
+
+      def with_template(template = nil)
+        @template_data = template
+        self
+      end
+
+      def exactly(count)
+        set_expected_number(:exactly, count)
+        self
+      end
+
+      def at_least(count)
+        set_expected_number(:at_least, count)
+        self
+      end
+
+      def at_most(count)
+        set_expected_number(:at_most, count)
+        self
+      end
+
+      def times
+        self
+      end
+
+      def once
+        exactly(:once)
+      end
+
+      def twice
+        exactly(:twice)
+      end
+
+      def thrice
+        exactly(:thrice)
+      end
+
+      def failure_message
+        "expected to send #{base_message}".tap do |msg|
+          if @unmatching_ntfcts.any?
+            msg << "\nSent notifications"
+            msg << " to #{@filter[:channel]}" if @filter[:channel]
+            msg << " of #{@filter[:template]}" if @filter[:template]
+            msg << ":"
+            @unmatching_ntfcts.each do |data|
+              msg << "\n   #{data}"
+            end
+          end
+        end
+      end
+
+      def failure_message_when_negated
+        "expected not to send #{base_message}"
+      end
+
+      def matches?(expectation)
+        if Proc === expectation
+          original_count = TeamsConnector.testing.requests.size
+          expectation.call
+          in_block_notifications = TeamsConnector.testing.requests.drop(original_count)
+        else
+          in_block_notifications = expectation
+        end
+
+        in_block_notifications = in_block_notifications.select { |msg|
+          @filter.map { |k, v| msg[k] === v unless v.nil? }.compact.all?
+        }
+
+        check(in_block_notifications)
+      end
+
+      def supports_block_expectations?
+        true
+      end
+
+      private
+
+      def check(notifications)
+        @matching_ntfcts, @unmatching_ntfcts = notifications.partition do |ntfct|
+          result = true
+
+          result &= ntfct[:template] == @template_data unless @template_data.nil?
+
+          decoded = JSON.parse(ntfct[:content])
+          if @data.nil? || @data === decoded
+            @block.call(decoded, ntfct)
+            result &= true
+          else
+            result = false
+          end
+
+          result
+        end
+
+        @matching_count = @matching_ntfcts.size
+
+        case @expectation_type
+        when :exactly then @expected_number == @matching_count
+        when :at_most then @expected_number >= @matching_count
+        when :at_least then @expected_number <= @matching_count
+        end
+      end
+
+      def set_expected_number(relativity, count)
+        @expectation_type = relativity
+        @expected_number =
+          case count
+          when :once then 1
+          when :twice then 2
+          when :thrice then 3
+          else Integer(count)
+          end
+      end
+
+      def base_message
+        "#{message_expectation_modifier} #{@expected_number} notifications".tap do |msg|
+          msg << " to #{@filter[:channel]}" if @filter[:channel]
+          msg << " of #{@filter[:template]}" if @filter[:template]
+          msg << " with template #{@template_data}" if @template_data
+          msg << " with content #{data_description(@data)}" if @data
+          msg << ", but sent #{@matching_count}"
+        end
+      end
+
+      def message_expectation_modifier
+        case @expectation_type
+        when :exactly then "exactly"
+        when :at_most then "at most"
+        when :at_least then "at least"
+        end
+      end
+
+      def data_description(data)
+        if RSpec::Support.is_a_matcher?(data) && data.respond_to?(:description)
+          data.description
+        else
+          data
+        end
+      end
+    end
+  end
+end

data/lib/teams_connector/matchers.rb

@@ -0,0 +1,11 @@
+require 'teams_connector/matchers/have_sent_notification_to'
+
+module TeamsConnector
+  module Matchers
+    def have_sent_notification_to(channel = nil, template = nil)
+      HaveSentNotificationTo.new(channel, template)
+    end
+
+    alias_method :send_notification_to, :have_sent_notification_to
+  end
+end

data/lib/teams_connector/notification/adaptive_card.rb

@@ -3,7 +3,7 @@ module TeamsConnector
     attr_accessor :content
 
     def initialize(template: :adaptive_card, content: {}, channel: TeamsConnector.configuration.default)
-      super(template: template, channel: channel)
+      super(template: template, channels: channel)
       if content.instance_of? TeamsConnector::Builder
         @content = {
           card: [content.result]

data/lib/teams_connector/notification.rb

@@ -30,7 +30,7 @@ module TeamsConnector
         elsif TeamsConnector.configuration.method == :testing
           TeamsConnector.testing.perform_request channel, @template, content
         else
-          response = Net::HTTP.post(URI(url), content, { "Content-Type": "application/json" })
+          response = Net::HTTP.post(URI(url), content, { "Content-Type" => "application/json" })
           response.value
         end
       end

data/lib/teams_connector/rspec.rb

@@ -0,0 +1,5 @@
+require "teams_connector/matchers"
+
+RSpec.configure do |config|
+  config.include TeamsConnector::Matchers
+end

data/lib/teams_connector/version.rb

@@ -1,3 +1,3 @@
 module TeamsConnector
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teams_connector
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Lucas Keune
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-02 00:00:00.000000000 Z
+date: 2021-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -117,10 +117,13 @@ files:
 - lib/teams_connector.rb
 - lib/teams_connector/builder.rb
 - lib/teams_connector/configuration.rb
+- lib/teams_connector/matchers.rb
+- lib/teams_connector/matchers/have_sent_notification_to.rb
 - lib/teams_connector/notification.rb
 - lib/teams_connector/notification/adaptive_card.rb
 - lib/teams_connector/notification/message.rb
 - lib/teams_connector/post_worker.rb
+- lib/teams_connector/rspec.rb
 - lib/teams_connector/testing.rb
 - lib/teams_connector/version.rb
 - teams_connector.gemspec