fix: add uri to signage plugin

Author: stakach

migration/db/migrations/20260319100500000_add_plugins_and_playlist_fields.sql

@@ -15,6 +15,7 @@ CREATE TABLE IF NOT EXISTS "signage_plugin"(
 
   name TEXT NOT NULL,
   description TEXT,
+  uri TEXT NOT NULL,
   enabled BOOLEAN NOT NULL DEFAULT TRUE,
   params JSONB NOT NULL DEFAULT '{}'::jsonb,
   defaults JSONB NOT NULL DEFAULT '{}'::jsonb,

spec/generator.cr

@@ -106,6 +106,7 @@ module PlaceOS::Model
     def self.signage_plugin(
       name : String = Faker::Hacker.noun,
       description : String = "",
+      uri : String = "/plugins/default",
       authority : Authority? = nil,
       params : Hash(String, JSON::Any) = {"type" => JSON::Any.new("object"), "properties" => JSON::Any.new({"play_at_period" => JSON::Any.new({"type" => JSON::Any.new("integer")} of String => JSON::Any)} of String => JSON::Any)},
       defaults : Hash(String, JSON::Any) = {"play_at_period" => JSON::Any.new(10_i64)},
@@ -118,6 +119,7 @@ module PlaceOS::Model
       SignagePlugin.new(
         name: name,
         description: description,
+        uri: uri,
         authority_id: authority.id,
         params: params,
         defaults: defaults,

spec/signage_plugin_spec.cr

@@ -60,5 +60,27 @@ module PlaceOS::Model
       )
       plugin.save.should eq true
     end
+
+    it "allows a local resource URI" do
+      plugin = Generator.signage_plugin(uri: "/plugins/weather")
+      plugin.save.should eq true
+    end
+
+    it "allows an https URL" do
+      plugin = Generator.signage_plugin(uri: "https://example.com/plugins/weather")
+      plugin.save.should eq true
+    end
+
+    it "rejects http URLs" do
+      plugin = Generator.signage_plugin(uri: "http://example.com/plugins/weather")
+      plugin.save.should eq false
+      plugin.errors.any? { |e| e.field == :uri }.should eq true
+    end
+
+    it "requires a uri" do
+      plugin = Generator.signage_plugin(uri: "")
+      plugin.save.should eq false
+      plugin.errors.any? { |e| e.field == :uri }.should eq true
+    end
   end
 end

src/placeos-models/signage_plugin.cr

@@ -1,3 +1,4 @@
+require "uri"
 require "./base/model"
 
 module PlaceOS::Model
@@ -8,6 +9,7 @@ module PlaceOS::Model
 
     attribute name : String, es_subfield: "keyword"
     attribute description : String = ""
+    attribute uri : String
 
     belongs_to Authority, foreign_key: "authority_id"
 
@@ -19,6 +21,20 @@ module PlaceOS::Model
     ###############################################################################################
 
     validates :name, presence: true
+    validates :uri, presence: true
+
+    validate ->(this : SignagePlugin) {
+      return unless uri = this.uri.presence
+      begin
+        parsed = URI.parse(uri)
+        raise "requires a request target" unless parsed.request_target.presence
+        if scheme = parsed.scheme
+          raise "scheme must be https" unless scheme.downcase == "https"
+        end
+      rescue error
+        this.validation_error(:uri, "not valid: #{error.message}")
+      end
+    }
 
     # ensure keys in defaults exist in params properties
     validate ->(this : SignagePlugin) {