activitysmith 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01ceddf3ae5045d286636cd3fa23783c922dc649b79e04ec96920994fbbf20e4
-  data.tar.gz: 3beeee49f2549b2d76db40ad5ab3e68ebc47b19513090780ac1dbc8891599edb
+  metadata.gz: 6be18d3495ded4e85d34cb9dfa10b9108f9dbd5e35ace8bd6303867fb6b31172
+  data.tar.gz: 64b2d345bf824795d5b809d0ce5e9e40ee239d7f86878c20213704892f95db4e
 SHA512:
-  metadata.gz: 82dac88237bf62fd4b7d9895d235a65d6b85cda0818a36808b6851779977e70b13e2f5e1066104f1590fda9b3d4f250198cb85da57c3a18fe3027ea5b0c9142f
-  data.tar.gz: f0f9ed517c2fbe3e870061ce4ae7240b4efa93e66965f5c0779a79b9bbb0b5784fcb5e86eeba4d8d65a842a670f4aaa8d9895a0fbea5e0685789fa961c11139f
+  metadata.gz: 72f3a210715d8e9e660142c12ba0b5ae1d99bcd87fd49196c1aa8a6f4732b6aa83fd4408b11afc5816ef3e214804dfded8ba7dd23eb1ded669f805e1067df442
+  data.tar.gz: a022698cba1e043612fb3490fe3fc8805c20ef61dd8104137d74b3f8a0b36b9e378522ce76e5b4123a520a29ce2f1359f3fad6238758a701e7e672bca508ce8f

data/README.md

@@ -214,6 +214,36 @@ response = activitysmith.notifications.send(
 )
 ```
 
+## Rich Push Notifications with Media
+
+<p align="center">
+  <img src="https://cdn.activitysmith.com/features/rich-push-notification-with-image.png" alt="Rich push notification with image" width="680" />
+</p>
+
+```ruby
+response = activitysmith.notifications.send(
+  {
+    title: "Homepage ready",
+    message: "Your agent finished the redesign.",
+    media: "https://cdn.example.com/output/homepage-v2.png",
+    redirection: "https://github.com/acme/web/pull/482"
+  }
+)
+```
+
+Send images, videos, or audio with your push notifications, press and hold to preview media directly from the notification, then tap through to open the linked content.
+
+<p align="center">
+  <img src="https://cdn.activitysmith.com/features/rich-push-notification-with-audio.png" alt="Rich push notification with audio" width="680" />
+</p>
+
+What will work:
+
+- direct image URL: `.jpg`, `.png`, `.gif`, etc.
+- direct audio file URL: `.mp3`, `.m4a`, etc.
+- direct video file URL: `.mp4`, `.mov`, etc.
+- URL that responds with a proper media `Content-Type`, even if the path has no extension
+
 ## Push Notification Redirection and Actions
 
 Push notification redirection and actions are optional and can be used to redirect the user to a specific URL when they tap the notification or to trigger a specific action when they long-press the notification.

data/generated/activitysmith_openapi/api/push_notifications_api.rb

@@ -20,7 +20,7 @@ module OpenapiClient
       @api_client = api_client
     end
     # Send a push notification
-    # Sends a push notification to devices matched by API key scope and optional target channels. Supports optional redirection URL (tap) and up to 4 interactive actions (long-press on iOS).
+    # Sends a push notification to devices matched by API key scope and optional target channels. Supports optional redirection URL, optional media preview or playback when the notification is expanded, and up to 4 interactive actions. `media` cannot be combined with `actions`.
     # @param push_notification_request [PushNotificationRequest] 
     # @param [Hash] opts the optional parameters
     # @return [PushNotificationResponse]
@@ -30,7 +30,7 @@ module OpenapiClient
     end
 
     # Send a push notification
-    # Sends a push notification to devices matched by API key scope and optional target channels. Supports optional redirection URL (tap) and up to 4 interactive actions (long-press on iOS).
+    # Sends a push notification to devices matched by API key scope and optional target channels. Supports optional redirection URL, optional media preview or playback when the notification is expanded, and up to 4 interactive actions. `media` cannot be combined with `actions`.
     # @param push_notification_request [PushNotificationRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(PushNotificationResponse, Integer, Hash)>] PushNotificationResponse data, response status code and response headers

data/generated/activitysmith_openapi/models/push_notification_request.rb

@@ -21,10 +21,13 @@ module OpenapiClient
 
     attr_accessor :subtitle
 
-    # Optional HTTPS URL opened when user taps the notification body.
+    # Optional HTTPS URL for an image, audio file, or video that users can preview or play when they expand the notification. If `redirection` is omitted, tapping the notification opens this URL. Cannot be combined with `actions`.
+    attr_accessor :media
+
+    # Optional HTTPS URL opened when user taps the notification body. Overrides the default tap target from `media` when both are provided.
     attr_accessor :redirection
 
-    # Optional interactive actions shown on iOS long-press.
+    # Optional interactive actions shown when users expand the notification. Cannot be combined with `media`.
     attr_accessor :actions
 
     attr_accessor :payload
@@ -41,6 +44,7 @@ module OpenapiClient
         :'title' => :'title',
         :'message' => :'message',
         :'subtitle' => :'subtitle',
+        :'media' => :'media',
         :'redirection' => :'redirection',
         :'actions' => :'actions',
         :'payload' => :'payload',
@@ -61,6 +65,7 @@ module OpenapiClient
         :'title' => :'String',
         :'message' => :'String',
         :'subtitle' => :'String',
+        :'media' => :'String',
         :'redirection' => :'String',
         :'actions' => :'Array<PushNotificationAction>',
         :'payload' => :'Hash<String, Object>',
@@ -105,6 +110,10 @@ module OpenapiClient
         self.subtitle = attributes[:'subtitle']
       end
 
+      if attributes.key?(:'media')
+        self.media = attributes[:'media']
+      end
+
       if attributes.key?(:'redirection')
         self.redirection = attributes[:'redirection']
       end
@@ -143,6 +152,11 @@ module OpenapiClient
         invalid_properties.push('invalid value for "title", title cannot be nil.')
       end
 
+      pattern = Regexp.new(/^https:\/\//)
+      if !@media.nil? && @media !~ pattern
+        invalid_properties.push("invalid value for \"media\", must conform to the pattern #{pattern}.")
+      end
+
       pattern = Regexp.new(/^https:\/\//)
       if !@redirection.nil? && @redirection !~ pattern
         invalid_properties.push("invalid value for \"redirection\", must conform to the pattern #{pattern}.")
@@ -160,11 +174,27 @@ module OpenapiClient
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @title.nil?
+      return false if !@media.nil? && @media !~ Regexp.new(/^https:\/\//)
       return false if !@redirection.nil? && @redirection !~ Regexp.new(/^https:\/\//)
       return false if !@actions.nil? && @actions.length > 4
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] media Value to be assigned
+    def media=(media)
+      if media.nil?
+        fail ArgumentError, 'media cannot be nil'
+      end
+
+      pattern = Regexp.new(/^https:\/\//)
+      if media !~ pattern
+        fail ArgumentError, "invalid value for \"media\", must conform to the pattern #{pattern}."
+      end
+
+      @media = media
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] redirection Value to be assigned
     def redirection=(redirection)
@@ -202,6 +232,7 @@ module OpenapiClient
           title == o.title &&
           message == o.message &&
           subtitle == o.subtitle &&
+          media == o.media &&
           redirection == o.redirection &&
           actions == o.actions &&
           payload == o.payload &&
@@ -219,7 +250,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [title, message, subtitle, redirection, actions, payload, badge, sound, target].hash
+      [title, message, subtitle, media, redirection, actions, payload, badge, sound, target].hash
     end
 
     # Builds the object from hash

data/lib/activitysmith/client.rb

@@ -11,6 +11,7 @@ module ActivitySmith
 
       config = OpenapiClient::Configuration.new
       config.access_token = api_key
+      config.user_agent = VersionedUserAgent.value if config.respond_to?(:user_agent=)
 
       api_client = OpenapiClient::ApiClient.new(config)
       @notifications = Notifications.new(OpenapiClient::PushNotificationsApi.new(api_client))

data/lib/activitysmith/notifications.rb

@@ -7,12 +7,16 @@ module ActivitySmith
     end
 
     def send(request, opts = {})
-      @api.send_push_notification(normalize_channels_target(request), opts)
+      normalized = normalize_channels_target(request)
+      assert_valid_media_actions!(normalized)
+      @api.send_push_notification(normalized, opts)
     end
 
     # Backward-compatible alias.
     def send_push_notification(push_notification_request, opts = {})
-      @api.send_push_notification(normalize_channels_target(push_notification_request), opts)
+      normalized = normalize_channels_target(push_notification_request)
+      assert_valid_media_actions!(normalized)
+      @api.send_push_notification(normalized, opts)
     end
 
     def method_missing(name, *args, &block)
@@ -49,5 +53,29 @@ module ActivitySmith
         []
       end
     end
+
+    def assert_valid_media_actions!(request)
+      media = request_value(request, :media)
+      actions = request_value(request, :actions)
+      has_media = media.is_a?(String) ? !media.strip.empty? : !media.nil?
+      has_actions = actions.respond_to?(:empty?) ? !actions.empty? : !actions.nil?
+
+      return unless has_media && has_actions
+
+      raise ArgumentError, "ActivitySmith: media cannot be combined with actions"
+    end
+
+    def request_value(request, key)
+      if request.is_a?(Hash)
+        return request[key] if request.key?(key)
+        return request[key.to_s] if request.key?(key.to_s)
+
+        return nil
+      end
+
+      return request.public_send(key) if request.respond_to?(key)
+
+      nil
+    end
   end
 end

data/lib/activitysmith/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActivitySmith
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

data/lib/activitysmith/versioned_user_agent.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ActivitySmith
+  module VersionedUserAgent
+    def self.value
+      "activitysmith-ruby/#{ActivitySmith::VERSION}"
+    end
+  end
+end

data/lib/activitysmith.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "activitysmith/version"
+require_relative "activitysmith/versioned_user_agent"
 require_relative "activitysmith/notifications"
 require_relative "activitysmith/live_activities"
 require_relative "activitysmith/client"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activitysmith
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - ActivitySmith
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-10 00:00:00.000000000 Z
+date: 2026-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -109,6 +109,7 @@ files:
 - lib/activitysmith/live_activities.rb
 - lib/activitysmith/notifications.rb
 - lib/activitysmith/version.rb
+- lib/activitysmith/versioned_user_agent.rb
 homepage: https://activitysmith.com/docs/sdks/ruby
 licenses:
 - MIT