terminalwire 0.2.4 → 0.3.0.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8a974238ae54d86b1c98334295187af746fede63382fe22d3cb527c4216f728
-  data.tar.gz: c99cdc090e070a11eb5a05ad2e2e0aebbb1d0c919899b5b0ed891c6ef693a9e8
+  metadata.gz: 1937bd63daba6afa08a9fa2b8409bb857994435aaca41625478d1141e372c989
+  data.tar.gz: 392a7a5abefa4f05a0c71c7f748845209cb580622900a692ccf65cb931756b43
 SHA512:
-  metadata.gz: 0df6c3219578c496eb45b8050164d9427207feb57012071abcf9d683ab6953ea95a92bf9c8eee0ab32c13f5335161777f4d4b1e06e53fdeb524f1d8f4d8987b7
-  data.tar.gz: 988d13343b1b408d7c70c3e3252ccd43385081c7438263f8add6c21c6320ac93a9e0a8795764dc250a1db601daccd86253fd3c09c2b487dcdec377350ccb6f4e
+  metadata.gz: 4af7d35e43e1b79dbf2fdac4b3d0215c2d54cb8732fe4693e6e549577962c2cb797a0296ab46fea4e8de39f98f9ac22536f61b550bf9ab36c116acafe477a740
+  data.tar.gz: 4204aad1b0893dd3a926fda32cf7f7271823c6b9b9b08b5826a76c280c9b5cf407acb3d4c50ce10b07b4d2ba2925bac11a2f791ec2aef0cfc6793511f19232b6

data/exe/terminalwire

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-require_relative "../lib/terminalwire.rb"
+require "terminalwire/client"
 
 begin
   Terminalwire::Client.websocket(url: "wss://terminalwire.com/terminal")

data/exe/terminalwire-exec

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-require_relative "../lib/terminalwire.rb"
+require "terminalwire/client"
 
 begin
   Terminalwire::Client::Exec.start

metadata

@@ -1,155 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: terminalwire
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0.alpha1
 platform: ruby
 authors:
 - Brad Gessler
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-08 00:00:00.000000000 Z
+date: 2024-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: async-websocket
+  name: terminalwire-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.30'
+        version: 0.3.0.alpha1
   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: 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: 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: launchy
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !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'
-- !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: 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'
-- !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'
+        version: 0.3.0.alpha1
 description: Stream command-line apps from your server without a web API
 email:
 - brad@terminalwire.com
@@ -159,49 +33,15 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
-- CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- LICENSE.txt
-- README.md
-- Rakefile
-- examples/exec/localrails
 - exe/terminalwire
 - exe/terminalwire-exec
-- 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.rb
-- lib/terminalwire/adapter.rb
-- lib/terminalwire/cache.rb
-- lib/terminalwire/client.rb
-- lib/terminalwire/client/entitlement.rb
-- lib/terminalwire/client/entitlement/environment_variables.rb
-- lib/terminalwire/client/entitlement/paths.rb
-- lib/terminalwire/client/entitlement/policy.rb
-- lib/terminalwire/client/entitlement/schemes.rb
-- lib/terminalwire/client/exec.rb
-- lib/terminalwire/client/handler.rb
-- lib/terminalwire/client/resource.rb
-- lib/terminalwire/client/server_license_verification.rb
-- lib/terminalwire/logging.rb
-- lib/terminalwire/rails.rb
-- lib/terminalwire/server.rb
-- lib/terminalwire/server/context.rb
-- lib/terminalwire/server/resource.rb
-- lib/terminalwire/thor.rb
-- lib/terminalwire/transport.rb
-- lib/terminalwire/version.rb
-- sig/terminalwire.rbs
 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
+  source_code_uri: https://github.com/terminalwire/ruby/tree/main/terminalwire
   changelog_uri: https://github.com/terminalwire/ruby/tags
   funding_uri: https://terminalwire.com/funding
 post_install_message:
@@ -219,7 +59,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Ship a CLI for your web app. No API required.

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/CHANGELOG.md

@@ -1,5 +0,0 @@
-## [Unreleased]
-
-## [0.1.0] - 2024-08-29
-
-- Initial release

data/CODE_OF_CONDUCT.md

@@ -1,132 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, caste, color, religion, or sexual
-identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall
-  community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or advances of
-  any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email address,
-  without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official email address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-[INSERT CONTACT METHOD].
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of
-actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or permanent
-ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior, harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the
-community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.1, available at
-[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
-
-Community Impact Guidelines were inspired by
-[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
-
-For answers to common questions about this code of conduct, see the FAQ at
-[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
-[https://www.contributor-covenant.org/translations][translations].
-
-[homepage]: https://www.contributor-covenant.org
-[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
-[Mozilla CoC]: https://github.com/mozilla/diversity
-[FAQ]: https://www.contributor-covenant.org/faq
-[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -1,9 +0,0 @@
-Copyright (c) 2024 Brad Gessler.
-
-License is propietary. Here's the deal:
-
-* You need to pay for Terminalwire if your organization has more than $1m in assets or makes more than $100k/year in revenue.
-* Terminalwire is free for personal use, hobbyists, or businesses that are just starting out, but server licenses still need to be registered at https://terminalwire.com/developers/licenses.
-* You can only use the Terminalwire client with licensed Terminalwire servers.
-
-This list is not exhaustive, please read the full license text at https://terminalwire.com/license.

data/README.md

@@ -1,45 +0,0 @@
-# Terminalwire
-
-Unlike most command-line tools for web services that require an API, Terminalwire streams terminal I/O between a web server and client over WebSockets. This means you can use your preferred command-line parser within your favorite web server framework to deliver a delightful CLI experience to your users.
-
-## Installation
-
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add terminalwire
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install terminalwire
-
-## Rails
-
-Run the intallation command:
-
-    $ rails g terminalwire:install my-app
-
-This generates the `./bin/my-app` file. Run it to verify that it connects to the server.
-
-    $ bin/my-app
-    Commands:
-      my-app help [COMMAND]  # Describe available commands or one specific command
-
-To edit the command-line, open `./app/cli/main_cli.rb` and make changes to the `MainCLI` class.
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/terminalwire/ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/terminalwire/ruby/blob/main/CODE_OF_CONDUCT.md).
-
-## License
-
-The gem is available as a propietary license. Email brad@terminalwire.com to discuss licensing.
-
-## Code of Conduct
-
-Everyone interacting in the Terminalwire project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/terminalwire/ruby/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec

data/examples/exec/localrails

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

data/lib/generators/terminalwire/install/USAGE

@@ -1,9 +0,0 @@
-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

@@ -1,38 +0,0 @@
-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::Server::Thor.new(MainTerminal),
-        via: [:get, :connect]
-    ROUTE
-  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

@@ -1,21 +0,0 @@
-# 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

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

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

@@ -1,40 +0,0 @@
-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
-      puts "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
-      puts "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/adapter.rb

@@ -1,53 +0,0 @@
-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