dexiecable 2.0.0.alpha4 → 2.0.0.alpha5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 502a99e32deef9551c55b8cb0bdae2e2d74af751e4f9889543f76ceea6d5a2ce
-  data.tar.gz: f42e9bca1c1d05ef287b3b72373e7c264af8ab78c350c092b8ccd9f887aa0270
+  metadata.gz: 16d440593b555940ff8039e04091edf54026d8678183acfb5d56b6189b08560c
+  data.tar.gz: 78c9c8e4b7e8e9cd3ae3d8cb7367b040962ef7ea0149d167a20396c58093a938
 SHA512:
-  metadata.gz: 37dc5d8afc9449875b3074c2684856ebb5d1f29e44a0c8d83558d061cf96baa270b8e5d1ad2a35a17bd01363b25956ec2946aead6929c3c465bee447a0c5d8d8
-  data.tar.gz: 7c370e6be94b70a65c63cf8bd47bb762b353df0ce0e964cd0f68b256703514c6a790124605a973008595358976319f9d6fdb3876fd5cfc97eeba65a8b5902642
+  metadata.gz: d1d15766bb5dde84e8aaac57998da45e3dc88665740c6beb333d12dafddb3115b148b4e3b49ec8badf706d898eaba1c6fd7c8ad33e77b2aa60083b6b6e3b3a88
+  data.tar.gz: c716de1ee2d50979513c911b168879da8fc640d49f85ddd288ad70715197691c35ffb9020872a2250ae00a62fb35909214a501f91cdeb458323d31cb201bf511

data/README.md

@@ -88,11 +88,17 @@ Stream tokens are signed with the application secret, so a client can only subsc
 DexieChannel.stream_token_for(target)
 ```
 
-For an ActiveRecord model it signs the record's GlobalID:
+For an ActiveRecord model it returns a signed GlobalID (Rails' `signed_id`):
 
 ```ruby
 DexieChannel.stream_token_for(current_user)
-# => "signed token for gid://app/User/1"
+# => "signed global id"
+```
+
+Tokens never expire by default. Pass `expires_in:` or `expires_at:` to limit a token's lifetime:
+
+```ruby
+DexieChannel.stream_token_for(current_user, expires_in: 1.day)
 ```
 
 Send that token to the client (render it in a view, return it from an endpoint, etc.) and add it to the subscription:
@@ -123,13 +129,16 @@ Add custom actions or push initial data directly on your channel:
 class DexieChannel < ApplicationCable::Channel
   include DexieCable
 
-  # Push a snapshot when a private stream is added.
+  # Push a snapshot when a stream is added. `record` is a record for private
+  # streams, or the stream name (String) for public streams.
   def subscribed_to(record, params)
     case record
     when User
       table("notifications").bulkAdd(record.notifications.map(&:as_json_for_dexie))
     when Conversation
       table("messages").bulkAdd(record.messages.where("seq_id > ?", params[:last_seq_id]).map(&:as_json_for_dexie))
+    when String
+      table(record).bulkAdd(Announcement.for_stream(record).map(&:as_json_for_dexie))
     end
   end
 

data/lib/dexiecable/concern.rb

@@ -25,6 +25,7 @@ module DexieCable
   extend ActiveSupport::Concern
 
   PUBLIC_STREAM_PREFIX = "public:"
+  STREAM_TOKEN_PURPOSE = "dexiecable:streams"
 
   included do
     public :transmit
@@ -40,15 +41,23 @@ module DexieCable
       ScopedChannel.new(self, target)
     end
 
-    # Returns a signed token for +target+ (a record or other private
-    # target). Send it to the client, which passes it to
-    # +subscription.addStream+.
-    def stream_token_for(target)
-      verifier.generate(target.respond_to?(:to_gid_param) ? target.to_gid_param : target.to_s)
-    end
-
-    def verifier
-      @verifier ||= Rails.application.message_verifier("dexiecable:streams")
+    # Returns a signed token for +target+ (a record). Send it to the client,
+    # which passes it to +subscription.addStream+.
+    #
+    # Tokens never expire by default. Pass +expires_in:+ (a duration) or
+    # +expires_at:+ (a time) to limit a token's lifetime.
+    def stream_token_for(target, expires_at: nil, expires_in: nil)
+      options = { for: STREAM_TOKEN_PURPOSE }
+
+      if expires_at
+        options[:expires_at] = expires_at
+      elsif expires_in
+        options[:expires_in] = expires_in
+      else
+        options[:expires_at] = nil # never expire
+      end
+
+      target.to_sgid_param(**options)
     end
   end
 
@@ -63,19 +72,19 @@ module DexieCable
   end
 
   def add_stream(data)
-    target = verified_target(data["stream"])
-    return unless target
+    record = resolve_subscribe_target(data["stream"])
+    return unless record
 
-    stream_for target
+    stream_for record
     params = data.except("action", "stream").with_indifferent_access
-    subscribed_to(resolve_subscribe_target(target), params)
+    subscribed_to(record, params)
   end
 
   def remove_stream(data)
-    target = verified_target(data["stream"])
-    return unless target
+    record = resolve_subscribe_target(data["stream"])
+    return unless record
 
-    stop_stream_from self.class.broadcasting_for(target)
+    stop_stream_from self.class.broadcasting_for(record)
   end
 
   def remove_all_streams(_data)
@@ -84,7 +93,11 @@ module DexieCable
 
   def add_public_stream(data)
     name = data["stream"].to_s
-    stream_from public_stream_name(name) if name.present?
+    return if name.blank?
+
+    stream_from public_stream_name(name)
+    params = data.except("action", "stream").with_indifferent_access
+    subscribed_to(name, params)
   end
 
   def remove_public_stream(data)
@@ -92,9 +105,9 @@ module DexieCable
     stop_stream_from public_stream_name(name) if name.present?
   end
 
-  # Override to push initial data when a private stream is added. +record+
-  # is the resolved target and +params+ are any extra params sent from the
-  # client.
+  # Override to push initial data when a stream is added. +record+ is the
+  # resolved target — a record for private streams, or the stream name for
+  # public streams — and +params+ are any extra params sent from the client.
   def subscribed_to(_record, _params)
   end
 
@@ -104,15 +117,9 @@ module DexieCable
     self.class.broadcasting_for("#{PUBLIC_STREAM_PREFIX}#{name}")
   end
 
-  def verified_target(token)
-    return unless token.present?
-
-    self.class.verifier.verify(token)
-  rescue ActiveSupport::MessageVerifier::InvalidSignature
+  def resolve_subscribe_target(token)
+    GlobalID::Locator.locate_signed(token, for: STREAM_TOKEN_PURPOSE)
+  rescue ActiveRecord::RecordNotFound, NameError
     nil
   end
-
-  def resolve_subscribe_target(target)
-    target.start_with?("gid://") ? GlobalID::Locator.locate(target) : target
-  end
 end

data/lib/dexiecable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DexieCable
-  VERSION = "2.0.0.alpha4"
+  VERSION = "2.0.0.alpha5"
 end

data/lib/dexiecable.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "dexiecable/version"
+require "global_id/railtie" if defined?(Rails::Railtie)
 require_relative "dexiecable/concern"
 require_relative "dexiecable/scoped_channel"
 require_relative "dexiecable/query"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dexiecable
 version: !ruby/object:Gem::Version
-  version: 2.0.0.alpha4
+  version: 2.0.0.alpha5
 platform: ruby
 authors:
 - Stefan Buhrmester
@@ -37,6 +37,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: globalid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
 description: DexieCable augments ActionCable channels with a query DSL that mirrors
   the Dexie.js API, letting you push database mutations from the server to the client
   in real time. Includes an ActiveRecord macro (syncs_to_dexie) for automatic change