openhab-scripting 5.20.0 → 5.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04fb1ca1c7f49ca0f821111edd4c1d178066d6d0c55ce0d574efc7bf1307aa36
-  data.tar.gz: aa5005277edc1667540d6c87aee158e5dcd02095ce6633303eacaa5343ecc1b1
+  metadata.gz: 756e126e160f646932df226702f4174537f335211766d9eba33c2d44cf1c1c70
+  data.tar.gz: 6afda8cddcc7a0fd916fe061a2eb2dab4621d46cdcef75138b4c524db05b669d
 SHA512:
-  metadata.gz: e3c2c463868f6c9ec8f452bc8d1e0c0a5dc4c0f34243eceb4ad6661d9e52deafc04cddad3a4332c51fe039f246d0133b245f1c885b9e892f79e913f38f6c6619
-  data.tar.gz: b6e03f118796c8af22d2a6922fba92368954ba3fd15c13029b6d627c5dc9cd5f1f27507f77990545176f8bd67af588e987b780393e76090f3c49b4a663351168
+  metadata.gz: c57f40667e47bacb3c2a2cc62f6fce829413cf832502e1f743cb82fbbc0e5a962800907b27261bea5513020612a8f7652378a7817aa6b0d924c88220ccca7328
+  data.tar.gz: 769878c8db809e0ed1815605551fc964de147329209e89517cab012a782b84e8a21e46fa445f3167723eea4f2454bd290a767991e39cfdb6495c742c874d295e

data/lib/openhab/core/actions.rb

@@ -51,31 +51,85 @@ module OpenHAB
       module_function
 
       #
-      # Send a notification.
+      # Send a notification using
+      # {https://next.openhab.org/addons/integrations/openhabcloud/#cloud-notification-actions
+      # openHAB Cloud Notification Action}.
       #
       # @param msg [String] The message to send.
-      # @param email [String, nil] The email address to send to. If `nil`,
-      #   the message will be broadcast.
-      # @param icon [String, Symbol, nil]
-      # @param severity [String, Symbol, nil]
+      # @param email [String, nil] The email address to send to. If `nil`, the message will be broadcast.
+      # @param icon [String, Symbol, nil] The icon name
+      #   (as described in {https://next.openhab.org/docs/configuration/items.html#icons Items}).
+      # @param severity [String, Symbol, nil] A description of the severity of the incident.
+      # @param title [String, nil] The title of the notification.
+      #   When `nil`, it defaults to `openHAB` inside the Android and iOS apps.
+      # @param on_click [String, nil] The action to be performed when the user clicks on the notification.
+      #   Specified using the {https://next.openhab.org/addons/integrations/openhabcloud/#action-syntax action syntax}.
+      # @param attachment [String, nil] The URL of the media attachment to be displayed with the notification.
+      #   This URL must be reachable by the push notification client.
+      # @param buttons [Array<String>, Hash<String, String>, nil] Buttons to include in the notification.
+      #   - In array form, each element is specified as `Title=$action`, where `$action` follows the
+      #   {https://next.openhab.org/addons/integrations/openhabcloud/#action-syntax action syntax}.
+      #   - In hash form, the keys are the button titles and the values are the actions.
+      #
+      #   The maximum number of buttons is 3.
       # @return [void]
       #
+      # @note The parameters `title`, `on_click`, `attachment`, and `buttons` were added in openHAB 4.2.
+      #
+      # @see https://www.openhab.org/addons/integrations/openhabcloud/
+      #
       # @example Send a broadcast notification via openHAB Cloud
-      #   rule 'Send an alert' do
+      #   rule "Send an alert" do
       #     changed Alarm_Triggered, to: ON
-      #     run { notify 'Red Alert!' }
+      #     run { notify "Red Alert!" }
+      #   end
+      #
+      # @example Provide action buttons in a notification
+      #   rule "Doorbell" do
+      #     changed Doorbell, to: ON
+      #     run do
+      #       notify "Someone pressed the doorbell!",
+      #         title: "Doorbell",
+      #         attachment: "http://myserver.local/cameras/frontdoor.jpg",
+      #         buttons: {
+      #           "Show Camera" => "ui:/basicui/app?w=0001&sitemap=cameras",
+      #           "Unlock Door" => "command:FrontDoor_Lock:OFF"
+      #         }
+      #     end
       #   end
       #
-      def notify(msg, email: nil, icon: nil, severity: nil)
+      def notify(
+        msg,
+        email: nil,
+        icon: nil,
+        severity: nil,
+        title: nil,
+        on_click: nil,
+        attachment: nil,
+        buttons: nil
+      )
         unless Actions.const_defined?(:NotificationAction)
           raise NotImplementedError, "NotificationAction is not available. Please install the openHAB Cloud addon."
         end
 
+        args = []
         if email
-          NotificationAction.send_notification(email.to_s, msg.to_s, icon&.to_s, severity&.to_s)
+          args.push(:send_notification, email)
         else
-          NotificationAction.send_broadcast_notification(msg.to_s, icon&.to_s, severity&.to_s)
+          args.push(:send_broadcast_notification)
         end
+        args.push(msg.to_s, icon&.to_s, severity&.to_s)
+
+        # @!deprecated OH 4.1
+        if Core.version >= Core::V4_2
+          buttons ||= []
+          buttons = buttons.map { |title, action| "#{title}=#{action}" } if buttons.is_a?(Hash)
+          raise ArgumentError, "buttons must contain (0..3) elements." unless (0..3).cover?(buttons.size)
+
+          args.push(title&.to_s, on_click&.to_s, attachment&.to_s, buttons[0]&.to_s, buttons[1]&.to_s, buttons[2]&.to_s)
+        end
+
+        NotificationAction.__send__(*args)
       end
     end
   end

data/lib/openhab/core/types/string_type.rb

@@ -56,8 +56,7 @@ module OpenHAB
         #
         # Coerce object to a StringType
         #
-        # @param [String] other object to coerce to a
-        #   DateTimeType
+        # @param [String] other object to coerce to a StringType
         #
         # @return [[StringType, StringType], nil]
         #

data/lib/openhab/core_ext/ruby/time.rb

@@ -92,6 +92,11 @@ class Time
     to_java(java.time.ZonedDateTime)
   end
 
+  # @return [java.time.Instant]
+  def to_instant
+    to_java(java.time.Instant)
+  end
+
   #
   # Converts to a {ZonedDateTime} if `other`
   # is also convertible to a ZonedDateTime.

data/lib/openhab/dsl/version.rb

@@ -4,6 +4,6 @@ module OpenHAB
   module DSL
     # Version of openHAB helper libraries
     # @return [String]
-    VERSION = "5.20.0"
+    VERSION = "5.21.0"
   end
 end

data/lib/openhab/rspec/openhab/core/actions.rb

@@ -5,10 +5,37 @@ module OpenHAB
     module Actions
       # redefine these to do nothing so that rules won't fail
 
-      module_function
+      class NotificationAction
+        class << self
+          def send_notification(
+            email,
+            msg,
+            icon,
+            severity,
+            title = nil,
+            on_click = nil,
+            attachment = nil,
+            button1 = nil,
+            button2 = nil,
+            button3 = nil
+          )
+            logger.debug("send_notification: #{email}, #{msg}, #{icon}, #{severity}, #{title}, #{on_click}, #{attachment}, #{button1}, #{button2}, #{button3}") # rubocop:disable Layout/LineLength
+          end
 
-      def notify(msg, email: nil)
-        logger.debug("notify: #{msg}")
+          def send_broadcast_notification(
+            msg,
+            icon,
+            severity,
+            title = nil,
+            on_click = nil,
+            attachment = nil,
+            button1 = nil,
+            button2 = nil,
+            button3 = nil
+          )
+            logger.debug("send_broadcast_notification: #{msg}, #{icon}, #{severity}, #{title}, #{on_click}, #{attachment}, #{button1}, #{button2}, #{button3}") # rubocop:disable Layout/LineLength
+          end
+        end
       end
 
       class Voice

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 5.20.0
+  version: 5.21.0
 platform: ruby
 authors:
 - Brian O'Connell
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-27 00:00:00.000000000 Z
+date: 2024-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler