terminalwire-server 0.3.0.alpha1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6478b8cc01d3c36333ca938f647700798e211487fd6a4c076b91809348f8adaf
+  data.tar.gz: 5bf273aeb4f3cf36df8b4af47e78b96761daf2be32f6fc31945c6beb4bc235e9
+SHA512:
+  metadata.gz: 5f6793ba99120adaef93ae16bbe9b71f38213f426bf3765ff19bea8d47fa7c5784df7d9c42c7e338769aa29ad9b3ae466cb961446f3cdaa77c6680429cfa4469
+  data.tar.gz: c0bbf7cb3d28d0a97893ad7befcf5b39404bdef47d55a7074cbfa6d1e3401466fd1b887d6ea46347b6b42050015568c3177b0d3bb66afd477b0a88d213fe692d

data/lib/terminalwire/server/context.rb

@@ -0,0 +1,80 @@
+require "fileutils"
+
+module Terminalwire::Server
+  # Contains all of the resources that are accessible to the server on the client-side.
+  # It's the primary interface for the server to interact with the client and is integrated
+  # into other libraries like Thor, etc.
+  class Context
+    extend Forwardable
+
+    attr_reader \
+      :stdout, :stdin, :stderr,
+      :browser,
+      :file, :directory,
+      :environment_variable,
+      :authority,
+      :root_path,
+      :authority_path,
+      :storage_path
+
+    def_delegators :@stdout, :puts, :print
+    def_delegators :@stdin, :gets, :getpass
+
+    def initialize(adapter:, entitlement:)
+      @adapter = adapter
+      @entitlement = entitlement
+
+      # Initialize resources
+      @stdout = Resource::STDOUT.new("stdout", @adapter)
+      @stdin = Resource::STDIN.new("stdin", @adapter)
+      @stderr = Resource::STDERR.new("stderr", @adapter)
+      @browser = Resource::Browser.new("browser", @adapter)
+      @file = Resource::File.new("file", @adapter)
+      @directory = Resource::Directory.new("directory", @adapter)
+      @environment_variable = Resource::EnvironmentVariable.new("environment_variable", @adapter)
+
+      # Authority is provided by the client.
+      @authority = @entitlement.fetch(:authority)
+      # The Terminalwire home path is provided by the client and set
+      # as an environment variable.
+      @root_path = Pathname.new(
+        @environment_variable.read("TERMINALWIRE_HOME")
+      )
+      # Now derive the rest of the paths from the Terminalwire home path.
+      @authority_path = @root_path.join("authorities", @authority)
+      @storage_path = @authority_path.join("storage")
+
+      if block_given?
+        begin
+          yield self
+        ensure
+          exit
+        end
+      end
+    end
+
+    # Wraps the environment variables in a hash-like object that can be accessed
+    # from client#ENV. This makes it look and feel just like the ENV object in Ruby.
+    class Env
+      def initialize(context:)
+        @context = context
+      end
+
+      def [](name)
+        @context.environment_variable.read(name)
+      end
+    end
+
+    def ENV
+      @ENV ||= Env.new(context: self)
+    end
+
+    def exit(status = 0)
+      @adapter.write(event: "exit", status: status)
+    end
+
+    def close
+      @adapter.close
+    end
+  end
+end

data/lib/terminalwire/server/resource.rb

@@ -0,0 +1,120 @@
+module Terminalwire::Server
+  # Representation of the resources avilable to the server on the client-side. These
+  # classes encapsulate the API alls to the client and provide a more Ruby-like interface.
+  module Resource
+    class Base < Terminalwire::Resource::Base
+      private
+
+      def command(command, **parameters)
+        @adapter.write(
+          event: "resource",
+          name: @name,
+          action: "command",
+          command: command,
+          parameters: parameters
+        )
+
+        response = @adapter.read
+        case response.fetch(:status)
+        when "success"
+          response.fetch(:response)
+        when "failure"
+          raise Terminalwire::Error, response.inspect
+        end
+      end
+    end
+
+    class EnvironmentVariable < Base
+      # Accepts a list of environment variables to permit.
+      def read(name)
+        command("read", name:)
+      end
+
+      # def write(name:, value:)
+      #   command("write", name:, value:)
+      # end
+    end
+
+    class STDOUT < Base
+      def puts(data)
+        command("print_line", data: data)
+      end
+
+      def print(data)
+        command("print", data: data)
+      end
+
+      def flush
+        # Do nothing
+      end
+    end
+
+    class STDERR < STDOUT
+    end
+
+    class STDIN < Base
+      def getpass
+        command("read_password")
+      end
+
+      def gets
+        command("read_line")
+      end
+    end
+
+    class File < Base
+      def read(path)
+        command("read", path: path.to_s)
+      end
+
+      def write(path, content)
+        command("write", path: path.to_s, content:)
+      end
+
+      def append(path, content)
+        command("append", path: path.to_s, content:)
+      end
+
+      def delete(path)
+        command("delete", path: path.to_s)
+      end
+      alias :rm :delete
+
+      def exist?(path)
+        command("exist", path: path.to_s)
+      end
+
+      def change_mode(path, mode)
+        command("change_mode", path: path.to_s, mode:)
+      end
+      alias :chmod :change_mode
+    end
+
+    class Directory < Base
+      def list(path)
+        command("list", path: path.to_s)
+      end
+      alias :ls :list
+
+      def create(path)
+        command("create", path: path.to_s)
+      end
+      alias :mkdir :create
+
+      def exist?(path)
+        command("exist", path: path.to_s)
+      end
+
+      def delete(path)
+        command("delete", path: path.to_s)
+      end
+      alias :rm :delete
+    end
+
+    class Browser < Base
+      def launch(url)
+        command("launch", url: url)
+      end
+    end
+  end
+end

data/lib/terminalwire/server/thor.rb

@@ -0,0 +1,69 @@
+require 'thor'
+
+module Terminalwire
+  module Server
+    module Thor
+      class Shell < ::Thor::Shell::Basic
+        extend Forwardable
+
+        # Encapsulates all of the IO resources for a Terminalwire adapter.
+        attr_reader :context, :session
+
+        def_delegators :context,
+          :stdin, :stdout, :stderr
+
+        def initialize(context, *, **, &)
+          @context = context
+          @session = Terminalwire::Rails::Session.new(context:)
+          super(*,**,&)
+        end
+      end
+
+      def self.included(base)
+        base.extend ClassMethods
+
+        # I have to do this in a block to deal with some of Thor's DSL
+        base.class_eval do
+          extend Forwardable
+
+          protected
+
+          no_commands do
+            def_delegators :shell,
+              :context, :session
+            def_delegators :context,
+              :stdout, :stdin, :stderr, :browser
+            def_delegators :stdout,
+              :puts, :print
+            def_delegators :stdin,
+              :gets, :getpass
+
+            # Prints text to the standard error stream.
+            def warn(...)
+              stderr.puts(...)
+            end
+
+            # Prints text to the standard error stream and exits the program.
+            def fail(...)
+              stderr.puts(...)
+              context.exit 1
+            ensure
+              super
+            end
+            # Feels more naturual to call `client.files` etc. from
+            # the serve since it's more apparent that it's a client.
+            alias :client :context
+          end
+        end
+      end
+
+      module ClassMethods
+        def start(given_args = ARGV, config = {})
+          context = config.delete(:context)
+          config[:shell] = Shell.new(context) if context
+          super(given_args, config)
+        end
+      end
+    end
+  end
+end

data/lib/terminalwire/server.rb

@@ -0,0 +1,27 @@
+require "terminalwire"
+require "terminalwire/logging"
+
+require "zeitwerk"
+Zeitwerk::Loader.for_gem_extension(Terminalwire).tap do |loader|
+  loader.setup
+end
+
+module Terminalwire
+  module Server
+    class WebSocket
+      include Logging
+
+      def call(env)
+        Async::WebSocket::Adapters::Rack.open(env, protocols: ['ws']) do |connection|
+          handle(Adapter::Socket.new(Terminalwire::Transport::WebSocket.new(connection)))
+        end or [200, { "Content-Type" => "text/plain" }, ["Connect via WebSockets"]]
+      end
+
+      def handle(adapter)
+        while message = adapter.read
+          puts message
+        end
+      end
+    end
+  end
+end

data/lib/terminalwire-server.rb

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

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: terminalwire-server
+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: 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: terminalwire-core
+  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
+description: Stream command-line apps from your server without a web API
+email:
+- brad@terminalwire.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/terminalwire-server.rb
+- lib/terminalwire/server.rb
+- lib/terminalwire/server/context.rb
+- lib/terminalwire/server/resource.rb
+- lib/terminalwire/server/thor.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-server
+  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: []