Provides telnet client functionality.
Clone or download
Latest commit 8a900c1 Jul 25, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin bundle gem net-telnet Apr 16, 2015
lib Bump version to 0.2.0 Jul 25, 2018
spec use require_relative. mspec didn't have helper file Jan 23, 2016
test refine test directory Apr 16, 2015
.gitignore bundle gem net-telnet Apr 16, 2015
.travis.yml Test on new Ruby versions Jan 16, 2018
Gemfile bundle gem net-telnet Apr 16, 2015
LICENSE.txt LICENSE Apr 17, 2015
README.md added badge Jan 6, 2016
Rakefile added rake task Apr 16, 2015
net-telnet.gemspec Add license to gemspec Dec 15, 2017

README.md

Net::Telnet

Build Status

Provides telnet client functionality.

This class also has, through delegation, all the methods of a socket object (by default, a TCPSocket, but can be set by the Proxy option to new()). This provides methods such as close() to end the session and sysread() to read data directly from the host, instead of via the waitfor() mechanism. Note that if you do use sysread() directly when in telnet mode, you should probably pass the output through preprocess() to extract telnet command sequences.

Installation

Add this line to your application's Gemfile:

gem 'net-telnet'

And then execute:

$ bundle

Or install it yourself as:

$ gem install net-telnet

Usage

Log in and send a command, echoing all output to stdout

localhost = Net::Telnet::new("Host" => "localhost",
                             "Timeout" => 10,
                             "Prompt" => /[$%#>] \z/n)
localhost.login("username", "password") { |c| print c }
localhost.cmd("command") { |c| print c }
localhost.close

Check a POP server to see if you have mail

pop = Net::Telnet::new("Host" => "your_destination_host_here",
                       "Port" => 110,
                       "Telnetmode" => false,
                       "Prompt" => /^\+OK/n)
pop.cmd("user " + "your_username_here") { |c| print c }
pop.cmd("pass " + "your_password_here") { |c| print c }
pop.cmd("list") { |c| print c }

Development

After checking out the repo, run bin/setup to install dependencies. Then, 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 to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

  1. Fork it ( https://github.com/ruby/net-telnet/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request