pry-remote-ssh 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: be15c99096d7fbbfb8185989ba383fbc537baf3a7145ea657fe90390c47fab3a
+  data.tar.gz: 45687fc70a7bea26792deebd4e8ac7153d7237160df24fcc99723a77c4c191cc
+SHA512:
+  metadata.gz: 802b64c777560ee6df5ffdecd68e9f0ae9be3318466dde144354aa0a8b1141a11825a034b244b826f37eb5f1328c052d060dcdfaf80e32ea65d72104145b474f
+  data.tar.gz: a668c26048c833b7862d43f264adc4541b997cb91d88dc79f33a500ae21424335030258319ea0fd05a80c5b48aaa2eb679f536ddadc318255775d3066c1c4de7

data/lib/pry-remote/ssh.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require 'pry-remote'
+require 'net/ssh'
+
+module PryRemote
+  module SSH
+    VERSION = '1.0.0'
+
+    ##
+    # Pry remote session forwarding over SSH.
+    class Server
+      ##
+      # Initialize the services and run the Pry remote session and SSH tunnel.
+      #
+      #    PryRemote::SSH::Server.run('remote_host', object, options)
+      def self.run(*args)
+        new(*args).run
+      end
+
+      ##
+      # Initialize the services.
+      #
+      # The only required argument is +remote_host+. By default, the +object+
+      # to run the Pry remote session on is set to `nil`. The optional argument
+      # +options+ hash can be used to set the +remote_user+, +local_port+, and
+      # +remote_port+ for the SSH tunnel, as well as the +ssh_options+ and the
+      # +pry_options+ for the Pry remote session.
+      #
+      #    PryRemote::SSH::Server.new('remote_host', object, options)
+      def initialize(remote_host, object = nil, options = {})
+        @remote_host = remote_host
+        @object      = object
+
+        @remote_user = options[:remote_user] || nil
+        @local_port  = options[:local_port]  || PryRemote::DefaultPort
+        @remote_port = options[:remote_port] || PryRemote::DefaultPort
+        @ssh_options = options[:ssh_options] || {}
+        @pry_options = options[:pry_options] || {}
+      end
+
+      ##
+      # Run the Pry remote session and SSH tunnel.
+      #
+      # The tunnel is teared down when the Pry remote session is closed.
+      def run
+        pry_remote = run_pry_remote
+        ssh = setup_ssh_tunnel
+
+        run_ssh_tunnel(ssh, pry_remote)
+      end
+
+      private
+
+      def run_pry_remote
+        Thread.new do
+          PryRemote::Server.run(@object, 'localhost', @local_port, @pry_options)
+        end
+      end
+
+      def run_ssh_tunnel(ssh, pry_remote)
+        loop do
+          break unless pry_remote.alive?
+
+          ssh.loop(1)
+        end
+      ensure
+        ssh.close
+        puts '[pry-remote] SSH Connection closed'
+      end
+
+      def setup_ssh_tunnel
+        ssh = Net::SSH.start(@remote_host, @remote_user, @ssh_options)
+        puts "[pry-remote] SSH Connection to #{@remote_host} established"
+
+        ssh.forward.remote(@local_port, 'localhost', @remote_port)
+        puts "[pry-remote] Forwarding port #{@local_port} to #{@remote_port}"
+
+        ssh
+      end
+    end
+  end
+end
+
+##
+# Pry remote session forwarding over SSH.
+class Object
+  ##
+  # Start a Pry remote session over SSH via object binding.
+  #
+  #    binding.remote_pry_ssh('remote_host')
+  def remote_pry_ssh(remote_host, options = {})
+    PryRemote::SSH::Server.run(remote_host, self, options)
+  end
+
+  alias pry_remote_ssh remote_pry_ssh
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: pry-remote-ssh
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tobias Schäfer
+bindir: bin
+cert_chain: []
+date: 2025-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.4'
+- !ruby/object:Gem::Dependency
+  name: pry-remote
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+description: 'Connect to Pry remotely via SSH forwarding
+
+  '
+email:
+- github@blackox.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/pry-remote/ssh.rb
+homepage: https://github.com/tschaefer/pry-remote-ssh
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/tschaefer/pry-remote-ssh
+  bug_tracker_uri: https://github.com/tschaefer/pry-remote-ssh/issues
+post_install_message: All your Pry connection are belong to us!
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.6
+specification_version: 4
+summary: Connect to Pry remotely via SSH forwarding
+test_files: []