terminalwire-rails 0.3.0.alpha1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6ba7bd27bf86aee365f4f45139d8a125e08fa01295d872a059570de818b834f9
+  data.tar.gz: 9f71189cbd898c0c4b5033e1dcaadec72126e96f35e5860fa58e6711189a7982
+SHA512:
+  metadata.gz: 49fe21592da92e7587a2c2bd93f920d1bde2b2e4d40af8076a4d43a9405497c58e7fe343d50f4a6e831a7ea1c6f0106466904127ad2a575492c13cf7d4edcedc
+  data.tar.gz: 0fe43f8b5f6658131efe122161d5700bccdf8e4d958da4ba7c9cd6d72c2e9dc62cc490b2141b2cd8d26ad3068bd4683bf14274e493fb2230d2d034e0222de96d

data/lib/generators/terminalwire/install/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Installs Terminalwire
+
+Example:
+    bin/rails generate terminalwire:install
+
+    This will create:
+        app/terminal/application_terminal.rb
+        bin/<your-app>

data/lib/generators/terminalwire/install/install_generator.rb

@@ -0,0 +1,43 @@
+require "bundler"
+
+class Terminalwire::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path("templates", __dir__)
+
+  argument :binary_name, type: :string, required: true, banner: "binary_name"
+
+  def create_terminal_files
+    template "application_terminal.rb.tt", Rails.root.join("app/terminal/application_terminal.rb")
+    template "main_terminal.rb", Rails.root.join("app/terminal/main_terminal.rb")
+  end
+
+  def create_binary_files
+    copy_file "bin/terminalwire", binary_path
+    chmod binary_path, 0755, verbose: false
+  end
+
+  def add_route
+    route <<~ROUTE
+      match "/terminal",
+        to: Terminalwire::Rails::Thor.new(MainTerminal),
+        via: [:get, :connect]
+    ROUTE
+  end
+
+  def bundle_development_dependencies
+    # Add the terminalwire gem to the development group in the Gemfile.
+    gem "terminalwire", group: :development
+  end
+
+  def print_post_install_message
+    say ""
+    say "Terminalwire has been successfully installed!", :green
+    say "Run `#{binary_path.relative_path_from(Rails.root)}` to verify everything is in working order. For support visit https://terminalwire.com."
+    say ""
+  end
+
+  private
+
+  def binary_path
+    Rails.root.join("bin", binary_name)
+  end
+end

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

@@ -0,0 +1,21 @@
+# Learn how to use Thor at http://whatisthor.com.
+class ApplicationTerminal < Thor
+  # Enables IO Streaming.
+  include Terminalwire::Thor
+
+  # The name of your binary. Thor uses this for its help output.
+  def self.basename = "<%= binary_name %>"
+
+  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.
+    session["user_id"] = user.id
+  end
+
+  def current_user
+    @current_user ||= User.find(session["user_id"])
+  end
+end

data/lib/generators/terminalwire/install/templates/bin/terminalwire

@@ -0,0 +1,2 @@
+#!/usr/bin/env terminalwire-exec
+url: "ws://localhost:3000/terminal"

data/lib/generators/terminalwire/install/templates/main_terminal.rb

@@ -0,0 +1,40 @@
+class MainTerminal < ApplicationTerminal
+  desc "hello NAME", "say hello to NAME"
+  def hello(name)
+    puts "Hello #{name}"
+  end
+
+  desc "login", "Login to your account"
+  def login
+    print "Email: "
+    email = gets.chomp
+
+    print "Password: "
+    password = getpass
+
+    # Replace this with your own authentication logic; this is an example
+    # of how you might do this with Devise.
+    user = User.find_for_authentication(email: email)
+    if user && user.valid_password?(password)
+      self.current_user = user
+      puts "Successfully logged in as #{current_user.email}."
+    else
+      fail "Could not find a user with that email and password."
+    end
+  end
+
+  desc "whoami", "Displays current user information."
+  def whoami
+    if self.current_user
+      puts "Logged in as #{current_user.email}."
+    else
+      fail "Not logged in. Run `#{self.class.basename} login` to login."
+    end
+  end
+
+  desc "logout", "Logout of your account"
+  def logout
+    session.reset
+    puts "Successfully logged out."
+  end
+end

data/lib/terminalwire/rails.rb

@@ -0,0 +1,116 @@
+require "terminalwire-server"
+require "thor"
+require "rails"
+require "jwt"
+
+module Terminalwire
+  module Rails
+    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)
+        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:)
+
+            begin
+              @cli_class.start(arguments, context:)
+              context.exit
+            rescue StandardError => e
+              if ::Rails.application.config.consider_all_requests_local
+                # Show the full error message with stack trace in development
+                context.stderr.puts "#{e.inspect}\n#{e.backtrace.join("\n")}"
+              else
+                # Show a generic message in production
+                context.stderr.puts error_message
+              end
+              context.exit 1
+            end
+          end
+        end
+      end
+    end
+  end
+
+  # Alias so we can put off breaking `include Terminalwire::Thor`
+  # in the ApplicationTerminal class.
+  Thor = Terminalwire::Server::Thor
+end

data/lib/terminalwire-rails.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'terminalwire/rails'

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: terminalwire-rails
+version: !ruby/object:Gem::Version
+  version: 0.3.0.alpha1
+platform: ruby
+authors:
+- Brad Gessler
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: terminalwire-server
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.0.alpha1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.0.alpha1
+- !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'
+- !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
+email:
+- brad@terminalwire.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/generators/terminalwire/install/USAGE
+- lib/generators/terminalwire/install/install_generator.rb
+- lib/generators/terminalwire/install/templates/application_terminal.rb.tt
+- lib/generators/terminalwire/install/templates/bin/terminalwire
+- lib/generators/terminalwire/install/templates/main_terminal.rb
+- lib/terminalwire-rails.rb
+- lib/terminalwire/rails.rb
+homepage: https://terminalwire.com/ruby
+licenses:
+- Proprietary (https://terminalwire.com/license)
+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
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
+summary: Ship a CLI for your web app. No API required.
+test_files: []