terminalwire-rails 0.3.5.alpha2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1042e6507c0e480ec99a84c3ef81f874eb46d3c937f3c3878940dfb065df2e87
-  data.tar.gz: 99e20e7324f22619d6ec67938fcc31ee96bd6b083bb1817674ccbffe1ceca715
+  metadata.gz: ed6ed5844031c4aed946289c735aa1956a5f88deb571bb67dcd163b3fd209316
+  data.tar.gz: 4466f5755eb45b06fa58ebded9b4ef81a0104aa60808c07a277be58081924d1e
 SHA512:
-  metadata.gz: 83e28d56aaccb65d679bdfdbc260fa2d887197d90db8f323f67d9d2f8c2c467426b5f1d7b72fab93897c6ad205bbecc3a53cb85b8681951ea4de17fc1c4b8c49
-  data.tar.gz: e5b5ac7371bfc02554c7d9123502fcd9165a744f20e2573860e3b9d50277ccf5461f184f27d9b83eb06b93074129e725b7a4f8325a8ac7d8d26fde3fae95675f
+  metadata.gz: 4930364b90f660e7c06b0b60bed426e21b152726c30b0fcf41256efbed337322b91d939f66e2794c2df9d13d62a1bdfb3559c323483ecfa3fb37c8fa8304d3a0
+  data.tar.gz: 2383456285b2b09a28f5baedecab2218707a9b23cce04068c5f565b5077a3d6b965073fb72619b238acc8b1267b2fcdb9b125f62679fe485f62689e7a855cc33

data/README.md

@@ -0,0 +1,31 @@
+# terminalwire-rails
+
+Drop-in [Terminalwire](https://terminalwire.com) integration for Rails — serve a
+Thor CLI over Terminalwire straight from your Rails app. You write your CLI *in
+your app* (calling your models and business logic directly); your users install
+one small, self-updating client with a single `curl … | bash`.
+
+```ruby
+# Gemfile
+gem "terminalwire-rails"
+```
+
+Then follow the Rails guide to mount your CLI and ship it.
+
+## Documentation
+
+- Rails guide: https://terminalwire.com/docs/rails
+- Client manual: https://terminalwire.com/docs/client
+- All docs: https://terminalwire.com/docs
+
+## License
+
+The Terminalwire **server** (this gem) is open source under the **Apache License
+2.0** — free to use, modify, and self-host, including commercially.
+
+The Terminalwire **client** your users install is proprietary, and only
+Terminalwire distributes it. Shipping a **commercial** CLI to your users needs a
+subscription, priced per active client install:
+
+- Pricing & licensing: https://terminalwire.com/pricing
+- Terms: https://terminalwire.com/terms — Privacy: https://terminalwire.com/privacy

data/lib/generators/terminalwire/install/templates/application_terminal.rb.tt

@@ -9,9 +9,9 @@ class ApplicationTerminal < Thor
   private
 
   def current_user=(user)
-    # The Session object is a hash-like object that encrypts and signs a hash that's
-    # stored on the client's file sytem. Conceptually, it's similar to Rails signed
-    # and encrypted client-side cookies.
+    # The Session object is a hash-like object that's encrypted and signed
+    # (AES-256-GCM, keyed off secret_key_base) and stored on the client's file
+    # system. Conceptually, it's similar to Rails' encrypted client-side cookies.
     session["user_id"] = user.id
   end
 

data/lib/terminalwire/rails.rb

@@ -1,241 +1,17 @@
-require "terminalwire-server"
-require "thor"
-require "rails"
-require "jwt"
-
-module Terminalwire
-  module Rails
-    class Channel
-      # Prefix used to for channel name to avoid conflicts.
-      NAMESPACE = "terminalwire".freeze
-
-      # Length of random channel name.
-      RANDOM_NAME_LENGTH = 32
-
-      # 5 minutes, which is really way too much time.
-      TIMEOUT_SECONDS = 5 * 60
-
-      attr_reader :name, :server, :logger, :timeout
-
-      def initialize(name: self.class.random_name, server: self.class.server, logger: self.class.logger, timeout: TIMEOUT_SECONDS)
-        @server = server
-        @name = name
-        @queue = Queue.new
-        @logger = logger
-        @timeout = timeout
-
-        yield self if block_given?
-      end
-
-      def broadcast(message)
-        @logger.info "ActiveExchange: Publishing #{message.inspect} to #{@name.inspect}"
-        @server.broadcast(@name, message)
-      end
-      alias :publish :broadcast
-
-      def subscribe
-        return if @queue.closed?
-        @logger.info "ActiveExchange: Subscribed to #{@name.inspect}"
-        @server.subscribe(@name, -> (message) { @queue << message })
-      end
-
-      def read
-        Timeout::timeout @timeout do
-          subscribe
-          @logger.debug "Queue: waiting"
-          @queue.pop
-        end
-      ensure
-        @logger.debug "Queue: closed"
-        @queue.close
-      end
-      alias :pop :read
-
-      def to_param
-        self.class.verifier.generate(@name, expires_in: @timeout)
-      end
-
-      class << self
-        def server
-          ActionCable.server.pubsub
-        end
-
-        def logger
-          ::Rails.logger
-        end
-
-        def random_name
-          [NAMESPACE, SecureRandom.hex(RANDOM_NAME_LENGTH)].join(":")
-        end
-
-        # Use Rails' secret_key_base for signing
-        def verifier
-          @verifier ||= ActiveSupport::MessageVerifier.new(::Rails.application.secret_key_base)
-        end
-
-        def from_param(...)
-          new name: verifier.verify(...)
-        end
-        alias :find :from_param
-      end
-    end
-
-    class Session
-      # JWT file name for the session file.
-      FILENAME = "session.jwt"
-
-      # Empty dictionary the user can stash all their session data into.
-      EMPTY_SESSION = {}.freeze
-
-      extend Forwardable
-
-      # Delegate `dig` and `fetch` to the `read` method
-      def_delegators :read,
-        :dig, :fetch, :[]
-
-      def initialize(context:, path: nil, secret_key: self.class.secret_key)
-        @context = context
-        @path = Pathname.new(path || context.storage_path)
-        @config_file_path = @path.join(FILENAME)
-        @secret_key = secret_key
-
-        ensure_file
-      end
-
-      def read
-        jwt_token = @context.file.read(@config_file_path)
-        decoded_data = JWT.decode(jwt_token, @secret_key, true, algorithm: 'HS256')
-        decoded_data[0]  # JWT payload is the first element in the array
-      rescue JWT::DecodeError => e
-        raise "Invalid or tampered file: #{e.message}"
-      end
-
-      def reset
-        @context.file.delete @config_file_path
-      end
-
-      def edit
-        config = read
-        yield config
-        write(config)
-      end
-
-      def []=(key, value)
-        edit { |config| config[key] = value }
-      end
-
-      def write(config)
-        token = JWT.encode(config, @secret_key, 'HS256')
-        @context.file.write(@config_file_path, token)
-      end
-
-      private
-
-      def ensure_file
-        return true if @context.file.exist? @config_file_path
-        # Create the path if it doesn't exist on the client.
-        @context.directory.create @path
-        # Write an empty configuration on initialization
-        write(EMPTY_SESSION)
-      end
-
-      def self.secret_key
-        ::Rails.application.secret_key_base
-      end
-    end
-
-    class Thor < Server::WebSocket
-      include Logging
-
-      def initialize(cli_class)
-        @cli_class = cli_class
-
-        unless @cli_class.included_modules.include?(Terminalwire::Server::Thor)
-          raise 'Add `include Terminalwire::Server::Thor` to the #{@cli_class.inspect} class.'
-        end
-      end
-
-      def error_message
-        "An error occurred. Please try again."
-      end
-
-      def handle(adapter:, env:)
-        logger.info "ThorServer: Running #{@cli_class.inspect}"
-        while message = adapter.read
-          case message
-          in { event: "initialization", protocol:, program: { arguments: }, entitlement: }
-            context = Terminalwire::Server::Context.new(adapter:, entitlement:)
-            exit_code = 0
-
-            begin
-              @cli_class.terminalwire arguments:, context: do |cli|
-                cli.default_url_options[:host] = env["HTTP_HOST"]
-              end
-            rescue ::Thor::UndefinedCommandError, ::Thor::InvocationError => e
-              context.stdout.puts e.message
-            rescue ::StandardError => e
-              # Log the error
-              handler_error_message = <<~ERROR
-                #{e.class.name} (#{e.message})
-
-                #{e.backtrace.join("\n")}
-              ERROR
-
-              ::Rails.logger.error(handler_error_message)
-              # Report the error to Rails' notification system
-              ::Rails.error.report(e, handled: true)
-
-              if ::Rails.application.config.consider_all_requests_local
-                # Show the full error message with stack trace in development
-                context.stderr.puts handler_error_message
-              else
-                # Show a generic message in production
-                context.stderr.puts error_message
-              end
-              exit_code = 1
-            ensure
-              context.exit exit_code
-            end
-          end
-        end
-      end
-    end
-  end
-
-  # If I move this, then the current production integration breaks because
-  # it wants `include Terminalwire::Thor`.
-  module Thor
-    class Shell < Terminalwire::Server::Thor::Shell
-      attr_reader :session
-
-      def initialize(context, *, **, &)
-        @session = Terminalwire::Rails::Session.new(context:)
-        super(context, *,**,&)
-      end
-    end
-
-    def self.included(base)
-      base.include Terminalwire::Server::Thor
-      base.extend ClassMethods
-
-      # I have to do this in a block to deal with some of Thor's DSL
-      base.class_eval do
-        protected
-
-        no_commands do
-          def_delegators :shell,
-            :session
-
-          include ::Rails.application.routes.url_helpers
-        end
-      end
-    end
-
-    module ClassMethods
-      # Use the extend Rails shell with this shell
-      def terminalwire_shell(context)
-        Terminalwire::Thor::Shell.new(context)
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+# terminalwire-rails 2.x: the v2 Rails integration.
+#
+# Bundler auto-requires this for `gem "terminalwire-rails"`. It loads the v2 server
+# and defines the v1 API names backed by v2 (see terminalwire/v2/rails.rb):
+#
+#   * Terminalwire::Thor          -> the v2 Rails terminal mixin (include in your CLI)
+#   * Terminalwire::Rails::Thor   -> the v2 Rack handler (mount in routes)
+#   * Terminalwire::Rails::Session -> the v2 encrypted client session
+#     (AES-256-GCM via ActiveSupport::MessageEncryptor; reads and migrates
+#     legacy signed-only JWT sessions on first access)
+#
+# So a 1.x/0.x app upgrades to v2 by bumping this gem to "~> 2.0" and redeploying —
+# its unchanged `include Terminalwire::Thor` and
+# `match "/terminal", to: Terminalwire::Rails::Thor.new(MainTerminal)` now serve v2.
+require "terminalwire/v2/rails"

metadata

@@ -1,63 +1,93 @@
 --- !ruby/object:Gem::Specification
 name: terminalwire-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.5.alpha2
+  version: 2.0.0
 platform: ruby
 authors:
 - Brad Gessler
 bindir: bin
 cert_chain: []
-date: 2025-05-01 00:00:00.000000000 Z
+date: 2026-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: terminalwire-server
+  name: terminalwire
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.3.5.alpha2
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.3.5.alpha2
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '7.2'
-  type: :development
+        version: '7.1'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
-description: Stream command-line apps from your server without a web API
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.2'
+description: 'Serve a Thor CLI over Terminalwire v2 from a Rails app. Drop-in for
+  the v1 terminalwire-rails: bump to 2.x and redeploy.'
 email:
 - brad@terminalwire.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/generators/terminalwire/install/USAGE
 - lib/generators/terminalwire/install/install_generator.rb
 - lib/generators/terminalwire/install/templates/application_terminal.rb.tt
@@ -65,15 +95,12 @@ files:
 - lib/generators/terminalwire/install/templates/main_terminal.rb
 - lib/terminalwire-rails.rb
 - lib/terminalwire/rails.rb
-homepage: https://terminalwire.com/ruby
+homepage: https://terminalwire.com
 licenses:
-- AGPL
+- Apache-2.0
 metadata:
-  allowed_push_host: https://rubygems.org/
-  homepage_uri: https://terminalwire.com/ruby
-  source_code_uri: https://github.com/terminalwire/ruby/tree/main/terminalwire-rails
-  changelog_uri: https://github.com/terminalwire/ruby/tags
-  funding_uri: https://terminalwire.com/funding
+  allowed_push_host: https://rubygems.org
+  source_code_uri: https://github.com/terminalwire/ruby/tree/main/gem/terminalwire-rails
 rdoc_options: []
 require_paths:
 - lib
@@ -81,7 +108,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -90,5 +117,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.2
 specification_version: 4
-summary: Ship a CLI for your web app. No API required.
+summary: Drop-in Terminalwire v2 integration for Rails
 test_files: []