turbo-train 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8f44643f00dc3a0c248fd990ffc95631a63bf9df53768ecb8e740a5dda4bc45
-  data.tar.gz: 92d303ac07e6402c9dc9ce4f71dcb9c56345c78980184c59692b7c7508daaf4d
+  metadata.gz: 4ad7e01b88eb8b09c2eecdffee7a4ede7b383c35573a194eec411a24674ae44e
+  data.tar.gz: 26289d3f1a518cc8208f7b0b1db5ad8b06b00f8489d2bfffe3fd89d90ad10a93
 SHA512:
-  metadata.gz: 229de6bb9a249571e03daddb1b1288aa9138ddee9a1711538961bce90a6bc02e92ba2b83dd4f0062a78c75bb27cf92202126a40034303c10ae127bb9786eb34d
-  data.tar.gz: f2cd4ebef097ffc2d66fd6ec081537ae57b54c7318c132ed0cf508f26dfe03cdc2b13d3386839c209269062c344f9eb127ff8728593a7b82807db8407cb70dd2
+  metadata.gz: 5f000e44026c4e4d675eb5e6fa09ffab8b1f370ffd8f242f8582276542b9f5860b4ee8513a9f9f8350a4f5094b44d032894a10ca044f1d78c710e6a9ce42bad1
+  data.tar.gz: 84fd805f8e22ef1f1686cbe50a0cc7e4c3753f9f1f91225fab5c73be392d2a710acf2e9fe563166c1e28af7e9cf56e5b1f06a8c277d89486b7199f876ee951fd

data/README.md

@@ -4,19 +4,19 @@
 
 <img align="right" width="220" title="Turbo::Train logo"
      src="https://user-images.githubusercontent.com/3010927/210603861-4b265489-a4a7-4d2a-bceb-40ceccebcd96.jpg">
-     
 
-Real-time page updates for your Rails app over SSE with [Mercure](https://mercure.rocks) and [Hotwire Turbo](https://turbo.hotwired.dev/handbook/streams#integration-with-server-side-frameworks).
+
+Real-time page updates for your Rails app over SSE with [Mercure](https://mercure.rocks), [Fanout Cloud](https://fanout.io/cloud) or [AnyCable](https://anycable.io/) and [Hotwire Turbo](https://turbo.hotwired.dev/handbook/streams#integration-with-server-side-frameworks).
 
 * **Uses [SSE](https://html.spec.whatwg.org/multipage/server-sent-events.html)**. No more websockets, client libraries, JS code and handling reconnects. Just an HTTP connection. Let the [browser](https://caniuse.com/eventsource) do the work.
 * **Seamless Hotwire integration.** Use it exactly like [ActionCable](https://github.com/hotwired/turbo-rails#come-alive-with-turbo-streams). Drop-in replacement for `broadcast_action_to` and usual helpers.
-* **Simple.** Get running in minutes, scale easily in production 🚀 
+* **Simple.** Get running in minutes, scale easily in production 🚀
 
 ## Before your proceed
 
 Using this gem requires some knowledge of ActionCable and broadcasting turbo streams. Turbo::Train is designed to mimic those, so it is highly recommended to first try the original to understand the concept.
 
-You can start [here](https://hotwired.dev/) and proceed with the [Turbo Handbook](https://turbo.hotwired.dev/handbook/introduction). One of its chapters will be covering [Turbo Streams](https://turbo.hotwired.dev/handbook/streams). Specifically [this section](https://turbo.hotwired.dev/handbook/streams#integration-with-server-side-frameworks) would be the main prerequisite to understanding what this gem is about: it covers [Broadcastable](https://github.com/hotwired/turbo-rails/blob/main/app/models/concerns/turbo/broadcastable.rb) and the overall idea of working with Mercure.
+You can start [here](https://hotwired.dev/) and proceed with the [Turbo Handbook](https://turbo.hotwired.dev/handbook/introduction). One of its chapters will be covering [Turbo Streams](https://turbo.hotwired.dev/handbook/streams). Specifically [this section](https://turbo.hotwired.dev/handbook/streams#integration-with-server-side-frameworks) would be the main prerequisite to understanding what this gem is about: it covers [Broadcastable](https://github.com/hotwired/turbo-rails/blob/main/app/models/concerns/turbo/broadcastable.rb) and the overall idea of working with Mercure or Fanout Cloud.
 
 ## Prerequisites
 
@@ -40,7 +40,8 @@ Instructions for Rails 6
 1. Install [turbo-rails](https://github.com/hotwired/turbo-rails#installation)
 2. Repeat steps for Rails 7 above
 
-### Step 2. Mercure
+### Step 2. Server
+#### Mercure
 
 Mercure is installed as a plugin to [Caddy](https://github.com/caddyserver/caddy) server. For mac users everything is pretty easy:
 
@@ -57,6 +58,21 @@ Now you are ready to run 🚀
 ```
 caddy run
 ```
+#### Fanout Cloud
+
+We only support the cloud version today. To use [Fanout](https://fanout.io/cloud/) you must purchase a paid account with a contract for Fastly's services.
+
+#### Fanout self-hosted (Pushpin)
+
+Coming soon.
+
+#### AnyCable
+
+```
+anycable-go --host=localhost --port=8080 --sse --broadcast_adapter=http --broadcast_key=test --public_streams --noauth
+```
+
+Coming soon.
 
 ## Usage
 
@@ -98,17 +114,35 @@ You have the same options as original Rails Turbo helpers: rendering partials, p
 
 ## Configuration
 
-To specify different Mercure server settings, please adjust the generated `config/initializers/turbo_train.rb` file:
+To specify different Mercure or Fanout server settings, please adjust the generated `config/initializers/turbo_train.rb` file:
 
 ```ruby
 Turbo::Train.configure do |config|
-  config.mercure_domain = ...
-  config.publisher_key = ...
-  config.subscriber_key = ...
+  config.skip_ssl_verification = true # Development only; don't do this in production
+  config.default_server = :fanout # Default value is :mercure
+
+  config.server :mercure do |mercure|
+    mercure.mercure_domain = ...
+    mercure.publisher_key = ...
+    mercure.subscriber_key = ...
+  end
+
+  config.server :fanout do |fanout|
+    fanout.service_url = ...
+    fanout.service_id = ...
+    fanout.fastly_key = ...
+  end
+
+  config.server :anycable do |fanout| 
+    ac.anycable_url = 'http://0.0.0.0:8080'
+    ac.broadcast_key = 'test'
+  end
 end
 ```
 
-* Your SSE will connect to `https://#{configuration.mercure_domain}/.well-known`. 
+### Mercure
+
+* Your SSE will connect to `https://#{configuration.mercure_domain}/.well-known`.
 * The publisher/subscriber key correspond to the [configuration](https://mercure.rocks/docs/hub/config) or your Mercure server.
 
 By default, these are set to `localhost`/`test`/`testing` to match the configuration of the local development server from the installation instructions above.

data/lib/install/create_initializer.rb

@@ -2,10 +2,20 @@ say "Creating initializer"
 create_file Rails.root.join("config/initializers/turbo_train.rb") do
   %{
 Turbo::Train.configure do |config|
-  config.mercure_domain = 'localhost'
-  config.publisher_key = 'testing'
-  config.subscriber_key = 'test'
   config.skip_ssl_verification = true # Development only; don't do this in production
+  config.default_server =  # Default value is :mercure
+
+  config.server :mercure do |mercure|
+    mercure.mercure_domain = 'localhost'
+    mercure.publisher_key = 'testing'
+    mercure.subscriber_key = 'test'
+  end
+
+  config.server :fanout do |fanout|
+    fanout.service_url = ''
+    fanout.service_id = ''
+    fanout.fastly_key = ''
+  end
 end
   }
 end

data/lib/turbo/train/anycable_server.rb

@@ -0,0 +1,36 @@
+module Turbo
+  module Train
+    class AnycableServer < BaseServer
+      def publish(topics:, data:)
+        uri = URI(server_config.publish_url)
+        req = Net::HTTP::Post.new(uri)
+        req['Content-Type'] = 'application/json'
+        req['Authorization'] = "Bearer #{server_config.broadcast_key}"
+
+        message = data[:data].gsub("\n", '')
+
+        opts = {
+          use_ssl: uri.scheme == 'https'
+        }
+
+        payload = []
+
+        Array(topics).each do |topic|
+          payload << { stream: topic, data: message }
+        end
+
+        req.body = payload.to_json
+
+        opts[:verify_mode] = OpenSSL::SSL::VERIFY_NONE if configuration.skip_ssl_verification
+
+        Net::HTTP.start(uri.host, uri.port, opts) do |http|
+          http.request(req)
+        end
+      end
+
+      def server_config
+        configuration.anycable
+      end
+    end
+  end
+end

data/lib/turbo/train/config.rb

@@ -47,13 +47,32 @@ module Turbo
       end
     end
 
+    class AnycableConfiguration
+      attr_accessor :anycable_url, :broadcast_key
+
+      def initialize
+        super
+        @anycable_url = 'http://localhost:8080'
+        @broadcast_key = 'test'
+      end
+
+      def publish_url
+        "#{@anycable_url}/_broadcast"
+      end
+
+      def listen_url(topic, **)
+        "#{@anycable_url}/events?stream=#{Turbo::Train.signed_stream_name(topic)}"
+      end
+    end
+
     class Configuration
-      attr_accessor :skip_ssl_verification, :mercure, :fanout, :default_server
+      attr_accessor :skip_ssl_verification, :mercure, :fanout, :anycable, :default_server
 
       def initialize
         @skip_ssl_verification = Rails.env.development? || Rails.env.test?
         @mercure = nil
         @fanout = nil
+        @anycable = nil
         @default_server = :mercure
       end
 
@@ -65,6 +84,9 @@ module Turbo
         when :fanout
           @fanout ||= FanoutConfiguration.new
           yield(@fanout)
+        when :anycable
+          @anycable ||= AnycableConfiguration.new
+          yield(@anycable)
         else
           raise ArgumentError, "Unknown server name: #{server_name}"
         end

data/lib/turbo/train/test_helper.rb

@@ -8,6 +8,8 @@ module Turbo
                         Turbo::Train::TestServer.new(Turbo::Train.mercure_server, Turbo::Train.configuration)
                       when :fanout
                         Turbo::Train::TestServer.new(Turbo::Train.fanout_server, Turbo::Train.configuration)
+                      when :anycable
+                        Turbo::Train::TestServer.new(Turbo::Train.anycable_server, Turbo::Train.configuration)
                       else
                         raise "Unknown test server: #{ENV['TURBO_TRAIN_TEST_SERVER']}"
                       end
@@ -22,6 +24,8 @@ module Turbo
                         Turbo::Train.mercure_server
                       when :fanout
                         Turbo::Train.fanout_server
+                      when :anycable
+                        Turbo::Train.anycable_server
                       else
                         raise "Unknown test server: #{ENV['TURBO_TRAIN_TEST_SERVER']}"
                       end
@@ -60,6 +64,20 @@ module Turbo
           assert_match "Published\n", r.body
         elsif Turbo::Train.server.real_server.is_a?(Turbo::Train::MercureServer)
           assert_match /urn:uuid:.*/, r.body
+        elsif Turbo::Train.server.real_server.is_a?(Turbo::Train::AnycableServer)
+          assert_match '', r.body
+        else
+          raise "Unknown server type"
+        end
+      end
+
+      def assert_code_ok(r)
+        if Turbo::Train.server.real_server.is_a?(Turbo::Train::FanoutServer)
+          assert_equal r.code, '200'
+        elsif Turbo::Train.server.real_server.is_a?(Turbo::Train::MercureServer)
+          assert_equal r.code, '200'
+        elsif Turbo::Train.server.real_server.is_a?(Turbo::Train::AnycableServer)
+          assert_equal r.code, '201'
         else
           raise "Unknown server type"
         end

data/lib/turbo/train/train.rb

@@ -24,6 +24,8 @@ module Turbo
           mercure_server
         when :fanout
           fanout_server
+        when :anycable
+          anycable_server
         else
           raise ArgumentError, "Unknown server: #{server}"
         end
@@ -41,6 +43,12 @@ module Turbo
         @fanout_server ||= FanoutServer.new(configuration)
       end
 
+      def anycable_server
+        raise ArgumentError, "Anycable configuration is missing" unless configuration.anycable
+
+        @anycable_server ||= AnycableServer.new(configuration)
+      end
+
       def stream_name_from(streamables)
         if streamables.is_a?(Array)
           streamables.map  { |streamable| stream_name_from(streamable) }.join(":")

data/lib/turbo/train/version.rb

@@ -1,5 +1,5 @@
 module Turbo
   module Train
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/lib/turbo/train.rb

@@ -4,6 +4,7 @@ require 'turbo/train/broadcasts'
 require 'turbo/train/base_server'
 require 'turbo/train/mercure_server'
 require 'turbo/train/fanout_server'
+require 'turbo/train/anycable_server'
 require 'turbo/train/test_server'
 require 'turbo/train/test_helper'
 require "turbo/train/engine"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turbo-train
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Nick Savrov
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-29 00:00:00.000000000 Z
+date: 2024-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -84,6 +84,7 @@ files:
 - lib/install/install_node.rb
 - lib/tasks/install_tasks.rake
 - lib/turbo/train.rb
+- lib/turbo/train/anycable_server.rb
 - lib/turbo/train/base_server.rb
 - lib/turbo/train/broadcasts.rb
 - lib/turbo/train/config.rb