openhab-scripting 3.0.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7eb19f2aa4bac30a6fb3b4f07953a9b78a54419795d4845c073432d803fa8629
-  data.tar.gz: 7528671d2c2db7a58ecdc46b33f9b94656ff2cfc878ab76bc2703fcff4c49a7b
+  metadata.gz: 0be2b09569b3f3e96c5a79dbec4c6b0be6616a46d013831650c1e5d60cee374f
+  data.tar.gz: f71890c321e188f6322191e0c40099a6de22bc086d89085743b0c20f6b211649
 SHA512:
-  metadata.gz: 6ef8331db3b6985bcc1ebb3b3b16fb251b61a482e10fc586e1d6bb2f7460ca197ecf8e38492613effd7fe6ff3f62f3975b443879f698373083c0b6ec192542d5
-  data.tar.gz: 20451cc85edb7a50ad3d5f7d80415b6b769129d5ce5b9cd246f98d51f1c588036340a7c1c9211184c396b1919a44c8d49fa303b3637d6182964b28cf76ca6edb
+  metadata.gz: ff1e955329247a70b39158dff4a3694f51e2974fb11ce18260ff7048b686ac1181a99c7e941299def6f77697cacdaabf8f67e72d5c8bc0193f3b4334df761f94
+  data.tar.gz: db0fb2c35af26aaa963107b7971e83bfbfdd43c42d951cc470dec1192e8f743978ed91e04859953b5970e076516c275f7133784d12545a842e856181e76ef5af

data/lib/openhab/core/entity_lookup.rb

@@ -87,8 +87,10 @@ module OpenHAB
       # @return [Object] the ruby wrapper for the item
       #
       # rubocop: disable Metrics/MethodLength
+      # rubocop: disable Metrics/CyclomaticComplexity
       # Disabled line length and branch size - case dispatch pattern
       def self.decorate_item(item)
+        logger.trace("Decorating #{item.class}")
         case item
         when Java::OrgOpenhabCoreItems::GroupItem
           OpenHAB::DSL::Items::GroupItem.new(item)
@@ -102,11 +104,15 @@ module OpenHAB
           OpenHAB::DSL::Items::RollershutterItem.new(item)
         when Java::OrgOpenhabCoreLibraryItems::PlayerItem
           OpenHAB::DSL::Items::PlayerItem.new(item)
+        when Java::OrgOpenhabCoreLibraryItems::ImageItem
+          OpenHAB::DSL::Items::ImageItem.new(item)
         else
+          logger.trace("Returning undecorated item #{item.class}")
           item
         end
       end
       # rubocop: enable Metrics/MethodLength
+      # rubocop: enable Metrics/CyclomaticComplexity
 
       #
       # Looks up a Thing in the OpenHAB registry replacing '_' with ':'

data/lib/openhab/dsl/dsl.rb

@@ -14,6 +14,7 @@ require 'openhab/dsl/group'
 require 'openhab/dsl/things'
 require 'openhab/dsl/items/items'
 require 'openhab/dsl/items/datetime_item'
+require 'openhab/dsl/items/image_item'
 require 'openhab/dsl/items/number_item'
 require 'openhab/dsl/items/player_item'
 require 'openhab/dsl/items/group_item'

data/lib/openhab/dsl/items/datetime_item.rb

@@ -5,6 +5,7 @@ require 'java'
 require 'time'
 require 'openhab/dsl/types/datetime'
 require 'openhab/dsl/items/item_delegate'
+require 'openhab/dsl/items/item_command'
 
 module OpenHAB
   module DSL

data/lib/openhab/dsl/items/image_item.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require 'base64'
+require 'net/http'
+require 'java'
+require 'mimemagic'
+require 'openhab/dsl/items/item_command'
+require 'openhab/dsl/items/item_delegate'
+
+module OpenHAB
+  module DSL
+    module Items
+      #
+      # Delegator to OpenHAB Player Item
+      #
+      class ImageItem
+        extend OpenHAB::DSL::Items::ItemCommand
+        extend OpenHAB::DSL::Items::ItemDelegate
+
+        def_item_delegator :@image_item
+
+        item_type Java::OrgOpenhabCoreLibraryItems::ImageItem
+
+        #
+        # Creates a new ImageItem
+        #
+        # @param [Java::OrgOpenhabCoreLibraryItems::ImageItem] image_item
+        #   The OpenHAB ImageItem to delegate to
+        #
+        def initialize(image_item)
+          logger.trace("Wrapping #{image_item}")
+          @image_item = image_item
+
+          item_missing_delegate { @image_item }
+
+          super()
+        end
+
+        #
+        #
+        # Update image with base64 encoded OpenHAB compatable image
+        #
+        # @param [String] base_64 base_64 encoding of an image
+        #
+        #
+        def update(base_64_encoded_image)
+          logger.trace { "Updating #{self} with Base64 image #{base_64_encoded_image}" }
+          @image_item.update base_64_encoded_image
+        end
+
+        #
+        # Update image from file
+        #
+        # @param [String] file location
+        # @param [String] mime_type of image
+        #
+        #
+        def update_from_file(file, mime_type: nil)
+          file_data = IO.binread(file)
+          mime_type ||= (MimeMagic.by_path(file) || MimeMagic.by_magic(file_data))&.type
+          update_from_bytes(file_data, mime_type: mime_type)
+        end
+
+        #
+        # Update image from image at URL
+        #
+        # @param [String] uri location of image
+        #
+        #
+        def update_from_url(uri)
+          logger.debug("Downloading image from #{uri}")
+          response = Net::HTTP.get_response(URI(uri))
+          mime_type = response['content-type']
+          bytes = response.body
+          mime_type ||= detect_mime_from_bytes(bytes: bytes)
+          update_from_bytes(bytes, mime_type: mime_type)
+        end
+
+        #
+        # Update image from image bytes
+        #
+        # @param [String] mime_type of image
+        # @param [Object] bytes image data
+        #
+        #
+        def update_from_bytes(bytes, mime_type: nil)
+          mime_type ||= detect_mime_from_bytes(bytes: bytes)
+          base_64_image = encode_image(mime_type: mime_type, bytes: bytes)
+          update base_64_image
+        end
+
+        #
+        # Get the mime type for the image item
+        #
+        # @return [String] mime type for image, e.g. image/png
+        #
+        def mime_type
+          state&.mime_type
+        end
+
+        #
+        # Get the bytes of the image
+        #
+        # @return [Array] Bytes that comprise the image
+        #
+        def bytes
+          state&.get_bytes
+        end
+
+        private
+
+        #
+        # Encode image information in the format required by OpenHAB
+        #
+        # @param [String] mime_type for image
+        # @param [Object] bytes image data
+        #
+        # @return [String] OpenHAB image format with image data Base64 encoded
+        #
+        def encode_image(mime_type:, bytes:)
+          "data:#{mime_type};base64,#{Base64.strict_encode64(bytes)}"
+        end
+
+        #
+        # Detect the mime type based on bytes
+        #
+        # @param [Array] bytes representing image data
+        #
+        # @return [String] mime type if it can be detected, nil otherwise
+        #
+        def detect_mime_from_bytes(bytes:)
+          logger.trace('Detecting mime type from file image contents')
+          MimeMagic.by_magic(bytes)&.type
+        end
+      end
+    end
+  end
+end

data/lib/openhab/dsl/items/rollershutter_item.rb

@@ -43,7 +43,7 @@ module OpenHAB
         # @return [Java::OrgOpenhabCoreLibraryTypes::PercentType] the position of the rollershutter
         #
         def position
-          state.as(PercentType)
+          state&.as(PercentType)
         end
 
         #
@@ -54,6 +54,8 @@ module OpenHAB
         # @return [Integer] -1, 0 or 1 depending on the result of the comparison
         #
         def <=>(other)
+          return nil unless state?
+
           case other
           when PercentType, Java::OrgOpenhabCoreLibraryTypes::DecimalType then position.compare_to(other)
           when Numeric then position.int_value <=> other
@@ -73,8 +75,8 @@ module OpenHAB
           raise ArgumentError, "Cannot coerce to #{other.class}" unless other.is_a? Numeric
 
           case other
-          when Integer then [other, position.int_value]
-          when Float then [other, position.float_value]
+          when Integer then [other, position&.int_value]
+          when Float then [other, position&.float_value]
           end
         end
 
@@ -84,7 +86,7 @@ module OpenHAB
         %i[+ - * / %].each do |operator|
           define_method(operator) do |other|
             right, left = coerce(other)
-            left.send(operator, right)
+            left&.send(operator, right)
           end
         end
       end

data/lib/openhab/dsl/monkey_patch/items/contact_item.rb

@@ -36,6 +36,8 @@ module OpenHAB
           #   result from super if not supplied an OpenClosedType
           #
           def ==(other)
+            other = other.get_state_as(OpenClosedType) if other.respond_to?(:get_state_as)
+
             if other.is_a? OpenClosedType
               state? && state == other
             else

data/lib/openhab/dsl/monkey_patch/items/switch_item.rb

@@ -56,6 +56,8 @@ module OpenHAB
           #   otherwise result from super
           #
           def ==(other)
+            other = other.get_state_as(OnOffType) if other.respond_to?(:get_state_as)
+
             if other.is_a? OnOffType
               state? && state == other
             else

data/lib/openhab/dsl/monkey_patch/ruby/string.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'openhab/dsl/types/quantity'
+require 'openhab/dsl/types/datetime'
+require 'openhab/dsl/items/datetime_item'
 
 module OpenHAB
   module DSL
@@ -21,7 +23,8 @@ module OpenHAB
           #
           def ==(other)
             case other
-            when OpenHAB::DSL::Types::Quantity, QuantityType, Java::OrgOpenhabCoreLibraryTypes::StringType
+            when OpenHAB::DSL::Types::Quantity, QuantityType, Java::OrgOpenhabCoreLibraryTypes::StringType,
+              OpenHAB::DSL::Types::DateTime, OpenHAB::DSL::Items::DateTimeItem
               other == self
             else
               super

data/lib/openhab/dsl/monkey_patch/types/on_off_type.rb

@@ -44,6 +44,21 @@ module OpenHAB
             end
             # rubocop:enable Style/CaseLikeIf
           end
+
+          #
+          # Test for equality
+          #
+          # @param [Object] other Other object to compare against
+          #
+          # @return [Boolean] true if self and other can be considered equal, false otherwise
+          #
+          def ==(other)
+            if other.respond_to?(:get_state_as)
+              self == other.get_state_as(OnOffType)
+            else
+              super
+            end
+          end
         end
       end
     end

data/lib/openhab/dsl/monkey_patch/types/open_closed_type.rb

@@ -33,6 +33,21 @@ module OpenHAB
               super
             end
           end
+
+          #
+          # Test for equality
+          #
+          # @param [Object] other Other object to compare against
+          #
+          # @return [Boolean] true if self and other can be considered equal, false otherwise
+          #
+          def ==(other)
+            if other.respond_to?(:get_state_as)
+              self == other.get_state_as(OpenClosedType)
+            else
+              super
+            end
+          end
         end
       end
     end

data/lib/openhab/dsl/monkey_patch/types/up_down_type.rb

@@ -30,6 +30,21 @@ module OpenHAB
               super
             end
           end
+
+          #
+          # Test for equality
+          #
+          # @param [Object] other Other object to compare against
+          #
+          # @return [Boolean] true if self and other can be considered equal, false otherwise
+          #
+          def ==(other)
+            if other.respond_to?(:get_state_as)
+              self == other.get_state_as(UpDownType)
+            else
+              super
+            end
+          end
         end
       end
     end

data/lib/openhab/dsl/rules/automation_rule.rb

@@ -29,6 +29,7 @@ module OpenHAB
           set_name(config.name)
           set_description(config.description)
           set_triggers(config.triggers)
+          @run_context = config.caller
           @run_queue = config.run
           @guard = config.guard
           between = config.between&.yield_self { between(config.between) }
@@ -288,7 +289,7 @@ module OpenHAB
         #
         def process_otherwise_task(event, task)
           logger.trace { "Executing rule '#{name}' otherwise block with event(#{event})" }
-          task.block.call(event)
+          @run_context.instance_exec(event, &task.block)
         end
 
         #
@@ -316,7 +317,7 @@ module OpenHAB
           return unless event&.item
 
           logger.trace { "Executing rule '#{name}' trigger block with item (#{event.item})" }
-          task.block.call(event.item)
+          @run_context.instance_exec(event.item, &task.block)
         end
 
         #
@@ -328,7 +329,7 @@ module OpenHAB
         #
         def process_run_task(event, task)
           logger.trace { "Executing rule '#{name}' run block with event(#{event})" }
-          task.block.call(event)
+          @run_context.instance_exec(event, &task.block)
         end
 
         #

data/lib/openhab/dsl/rules/rule.rb

@@ -23,10 +23,11 @@ module OpenHAB
       def rule(rule_name, &block)
         @rule_name = rule_name
         config = RuleConfig.new(rule_name, block.binding)
-        config.instance_eval(&block)
+        config.instance_exec(config, &block)
         config.guard = Guard::Guard.new(only_if: config.only_if, not_if: config.not_if)
         logger.trace { config.inspect }
         process_rule_config(config)
+        config
       rescue StandardError => e
         re_raise_with_backtrace(e)
       end

data/lib/openhab/dsl/rules/rule_config.rb

@@ -40,6 +40,9 @@ module OpenHAB
         # @return [Array] Of trigger guards
         attr_accessor :guard
 
+        # @return [Object] object that invoked rule method
+        attr_accessor :caller
+
         #
         # Struct holding a run block
         #

data/lib/openhab/dsl/rules/triggers/trigger.rb

@@ -61,7 +61,7 @@ module OpenHAB
         # @return [Array] A new flat array with any GroupMembers object left intact
         #
         def separate_groups(item_array)
-          return item_array if item_array.length <= 1 && item_array.grep(Array).length.zero?
+          return item_array if item_array.grep(Array).length.zero?
 
           groups, items = item_array.partition { |item| item.is_a? OpenHAB::DSL::Items::GroupItem::GroupMembers }
           groups + separate_groups(items.flatten(1))

data/lib/openhab/dsl/types/datetime.rb

@@ -75,13 +75,13 @@ module OpenHAB
         # @return [Integer] -1, 0 or 1 depending on the outcome
         #
         def <=>(other)
+          if other.respond_to?(:zoned_date_time)
+            return zoned_date_time.to_instant.compare_to(other.zoned_date_time.to_instant)
+          end
+
           case other
-          when DateTime, DateTimeType, DateTimeItem
-            zoned_date_time.to_instant.compare_to(other.zoned_date_time.to_instant)
-          when TimeOfDay::TimeOfDay, TimeOfDay::TimeOfDayRangeElement
-            to_tod <=> other
-          when String
-            self <=> DateTime.parse(DATE_ONLY_REGEX =~ other ? "#{other}'T'00:00:00#{zone}" : other)
+          when TimeOfDay::TimeOfDay, TimeOfDay::TimeOfDayRangeElement then to_tod <=> other
+          when String then self <=> DateTime.parse(DATE_ONLY_REGEX =~ other ? "#{other}'T'00:00:00#{zone}" : other)
           else
             self <=> DateTime.from(other)
           end

data/lib/openhab/version.rb

@@ -5,5 +5,5 @@
 #
 module OpenHAB
   # @return [String] Version of OpenHAB helper libraries
-  VERSION = '3.0.0'
+  VERSION = '3.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-02 00:00:00.000000000 Z
+date: 2021-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: mimemagic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 description: JRuby Helper Libraries for OpenHAB Scripting
 email:
 - broconne@gmail.com
@@ -41,6 +55,7 @@ files:
 - lib/openhab/dsl/group.rb
 - lib/openhab/dsl/items/datetime_item.rb
 - lib/openhab/dsl/items/group_item.rb
+- lib/openhab/dsl/items/image_item.rb
 - lib/openhab/dsl/items/item_command.rb
 - lib/openhab/dsl/items/item_delegate.rb
 - lib/openhab/dsl/items/items.rb