openhab-scripting 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8359f48a32afdddb1863616bf95c24974c31b059506ecb5a07656d2ed7ee1738
-  data.tar.gz: e1c45eba3ca90174d507becbe2158fc93154d11610d841ad01e6ba705433edb3
+  metadata.gz: f2c9b98ae8645ba9006e801fb670b8858442117e731f9eddd37186824f655704
+  data.tar.gz: b594df3783cbce82b7d1a80187f4455e2afa5ffad3230b1c64f7c7be8a7b6a66
 SHA512:
-  metadata.gz: 7472fd8ed608b6b74a38358e98fd00b1534e2d4e7d88adfe726018afd48c28783324fe3d2388d6a9749a4d8d8c804c4d795bf3ab338849783ee6c4a1f0cb69aa
-  data.tar.gz: feb348e3b10f8ec03659e4066dffeef8df1d5a7f41ba4d4faf31ac2078d5b63024360dbd0d6acb5fc0348fb9254e84a09409680d74a96a1415c3ecf017f0cca8
+  metadata.gz: 8d9dacf04c0bdeec592a0bd4742009754eb32433523b6f88a9abe34f1294d17fd41a93b940b5701f6b2dc28d1a7d29fef04d5eb07d98e9b0eeb9473aa25e1967
+  data.tar.gz: cb5585d43b36d101db8b3d81686eb503e6393e0336d0ff626a3ad7d33b6c0720ce13993886453176df2f245c3feea5c10dd42b19908d31ae4734919c72c4f09f

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/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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-03 00:00:00.000000000 Z
+date: 2021-03-08 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