terminalwire-core 0.3.0.alpha1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c16ed0f8c654d33471f56add7eb3637b8439b2283c41a764b852999a3cb0eb2a
+  data.tar.gz: 5bfe86bc41fe0e368739a7997348612fc14ef63c9289a8c7520957a64983e6de
+SHA512:
+  metadata.gz: 8ce7a3ca741099a128f01cc3470b99fa16f8b446d60218be22136a4bfa8d03453273e82e72c2765ebf9150728a30c9e3b243fb46e668099ef3425ada7f85680e
+  data.tar.gz: 1f25dda033f5402f7ebb0f26384441a0604645868d06006d779d7e9100556023d0c209d257dbdf5372b9ab0ccea1ad4e0dc161e8d119ff28729f33be0ed96298

data/lib/terminalwire/adapter.rb

@@ -0,0 +1,53 @@
+require 'msgpack'
+
+module Terminalwire::Adapter
+  # Works with Test, TCP, Unix, WebSocket, and other socket-like abstractions.
+  class Socket
+    include Terminalwire::Logging
+
+    attr_reader :transport
+
+    def initialize(transport)
+      @transport = transport
+    end
+
+    def write(data)
+      logger.debug "Adapter: Sending #{data.inspect}"
+      packed_data = MessagePack.pack(data, symbolize_keys: true)
+      @transport.write(packed_data)
+    end
+
+    def read
+      logger.debug "Adapter: Reading"
+      packed_data = @transport.read
+      return nil if packed_data.nil?
+      data = MessagePack.unpack(packed_data, symbolize_keys: true)
+      logger.debug "Adapter: Received #{data.inspect}"
+      data
+    end
+
+    def close
+      @transport.close
+    end
+  end
+
+  # This is a test adapter that can be used for testing purposes.
+  class Test
+    attr_reader :responses
+
+    def initialize(responses = [])
+      @responses = responses
+    end
+
+    def write(**data)
+      @responses << data
+    end
+
+    def response
+      @responses.pop
+    end
+
+    def close
+    end
+  end
+end

data/lib/terminalwire/cache.rb

@@ -0,0 +1,116 @@
+require "pathname"
+require "msgpack"
+require "base64"
+require "time"
+require "fileutils"
+
+# Caches used on the client side for licesens, HTTP requests, etc.
+module Terminalwire::Cache
+  module File
+    # Hoist the File class to avoid conflicts with the standard library.
+    File = ::File
+
+    class Store
+      include Enumerable
+
+      def initialize(path:)
+        @path = Pathname.new(path).expand_path
+        FileUtils.mkdir_p(@path) unless @path.directory?
+      end
+
+      def entry(key)
+        Entry.new(path: @path.join(Entry.key_path(key)))
+      end
+      alias :[] :entry
+
+      def evict
+        each(&:evict)
+      end
+
+      def destroy
+        each(&:destroy)
+      end
+
+      def each
+        @path.each_child do |path|
+          yield Entry.new(path:)
+        end
+      end
+    end
+
+    class Entry
+      VERSION = "1.0"
+
+      def self.key_path(value)
+        Base64.urlsafe_encode64(value)
+      end
+
+      attr_accessor :value, :expires
+
+      def initialize(path:)
+        @path = path
+        deserialize if persisted?
+      end
+
+      def nil?
+        @value.nil?
+      end
+
+      def present?
+        not nil?
+      end
+
+      def persisted?
+        File.exist? @path
+      end
+
+      def expired?(time: Time.now)
+        @expires && @expires < time.utc
+      end
+
+      def fresh?(...)
+        not expired?(...)
+      end
+
+      def hit?
+        persisted? and fresh?
+      end
+
+      def miss?
+        not hit?
+      end
+
+      def save
+        File.open(@path, "wb") do |file| # Write in binary mode
+          file.write(serialize)
+        end
+      end
+
+      def evict
+        destroy if expired?
+      end
+
+      def deserialize
+        case MessagePack.unpack(File.open(@path, "rb", &:read), symbolize_keys: true)
+        in { value:, expires:, version: VERSION }
+          @value = value
+          @expires = Time.parse(expires).utc if expires
+        end
+      end
+
+      def destroy
+        File.delete(@path)
+      end
+
+      private
+
+      def serialize
+        MessagePack.pack(
+          value: @value,
+          expires: @expires&.utc&.iso8601,
+          version: VERSION
+        )
+      end
+    end
+  end
+end

data/lib/terminalwire/logging.rb

@@ -0,0 +1,8 @@
+require 'logger'
+
+module Terminalwire
+  module Logging
+    DEVICE = Logger.new($stdout, level: ENV.fetch("TERMINALWIRE_LOG_LEVEL", "info"))
+    def logger = DEVICE
+  end
+end

data/lib/terminalwire/transport.rb

@@ -0,0 +1,58 @@
+require 'uri'
+require 'async/websocket/client'
+
+module Terminalwire
+  module Transport
+    class Base
+      def self.connect(url)
+        raise NotImplementedError, "Subclass must implement .connect"
+      end
+
+      def self.listen(url)
+        raise NotImplementedError, "Subclass must implement .listen"
+      end
+
+      def read
+        raise NotImplementedError, "Subclass must implement #read"
+      end
+
+      def write(data)
+        raise NotImplementedError, "Subclass must implement #write"
+      end
+
+      def close
+        raise NotImplementedError, "Subclass must implement #close"
+      end
+    end
+
+    class WebSocket < Base
+      def self.connect(url)
+        uri = URI(url)
+        endpoint = Async::HTTP::Endpoint.parse(uri)
+        adapter = Async::WebSocket::Client.connect(endpoint)
+        new(adapter)
+      end
+
+      def self.listen(url)
+        # This would need to be implemented with a WebSocket server library
+        raise NotImplementedError, "WebSocket server not implemented"
+      end
+
+      def initialize(websocket)
+        @websocket = websocket
+      end
+
+      def read
+        @websocket.read&.buffer
+      end
+
+      def write(data)
+        @websocket.write(data)
+      end
+
+      def close
+        @websocket.close
+      end
+    end
+  end
+end

data/lib/terminalwire/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Terminalwire
+  VERSION = "0.3.0.alpha1"
+end

data/lib/terminalwire-core.rb

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

data/lib/terminalwire.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative "terminalwire/version"
+
+require 'forwardable'
+require 'uri'
+
+require 'async'
+require 'async/http/endpoint'
+require 'async/websocket/client'
+require 'async/websocket/adapters/rack'
+require 'uri-builder'
+
+require "zeitwerk"
+Zeitwerk::Loader.for_gem.tap do |loader|
+  loader.ignore File.join(__dir__, "terminalwire-core.rb")
+  loader.setup
+end
+
+module Terminalwire
+  class Error < StandardError; end
+
+  # Used by Terminalwire client to connect to Terminalire.com for license
+  # validations, etc.
+  TERMINALWIRE_URL = "https://terminalwire.com".freeze
+  def self.url = URI.build(TERMINALWIRE_URL)
+
+  module Resource
+    class Base
+      attr_reader :name, :adapter
+
+      def initialize(name, adapter)
+        @name = name.to_s
+        @adapter = adapter
+      end
+
+      def connect; end
+      def disconnect; end
+
+      def fail(response, **data)
+        respond(status: "failure", response:, **data)
+      end
+
+      def succeed(response, **data)
+        respond(status: "success", response:, **data)
+      end
+
+      private
+
+      def respond(**response)
+        adapter.write(event: "resource", name: @name, **response)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: terminalwire-core
+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: async-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.30'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.30'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  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'
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: uri-builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.9
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Stream command-line apps from your server without a web API
+email:
+- brad@terminalwire.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/terminalwire-core.rb
+- lib/terminalwire.rb
+- lib/terminalwire/adapter.rb
+- lib/terminalwire/cache.rb
+- lib/terminalwire/logging.rb
+- lib/terminalwire/transport.rb
+- lib/terminalwire/version.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
+  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: []