Ruby

REST through SSH Tunnel

See more REST Examples

Demonstrates how to connect through an SSH Tunnel (via port-forwarding) to make REST API calls. Ruby

require 'chilkat'

success = false

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

tunnel = Chilkat::CkSocket.new()

sshHostname = "sftp.example.com"
sshPort = 22

# Connect to an SSH server and establish the SSH tunnel:
success = tunnel.SshOpenTunnel(sshHostname,sshPort)
if (success == false)
    print tunnel.lastErrorText() + "\n";
    exit
end

# Authenticate with the SSH server via a login/password
# or with a public key.
# This example demonstrates SSH password authentication.
success = tunnel.SshAuthenticatePw("mySshLogin","mySshPassword")
if (success == false)
    print tunnel.lastErrorText() + "\n";
    exit
end

#  OK, the SSH tunnel is setup.  Now open a channel within the tunnel.
#  (Any number of channels may be created from the same SSH tunnel.
#  Multiple channels may coexist at the same time.)

# This example connects to a REST server through the SSH tunnel.
# It will connect to the Amazon AWS service for this example.
rest = Chilkat::CkRest.new()

bTls = true
port = 443
maxWaitMs = 5000

# This returns a socket object that is a single channel within the SSH tunnel.
channel = Chilkat::CkSocket.new()
success = tunnel.SshNewChannel("s3.amazonaws.com",port,bTls,maxWaitMs,channel)
if (success == false)
    print tunnel.lastErrorText() + "\n";
    exit
end

# Use the connection.  (This connection is a TLS running on an SSH channel through an SSH tunnel.
# In other words, TLS is wrapped within the SSH tunnel.)
success = rest.UseConnection(channel,true)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

# Provide AWS credentials for the REST call.
authAws = Chilkat::CkAuthAws.new()
authAws.put_AccessKey("AWS_ACCESS_KEY")
authAws.put_SecretKey("AWS_SECRET_KEY")
authAws.put_ServiceName("s3")
success = rest.SetAuthAws(authAws)

# List all buckets for the account...
responseXml = rest.fullRequestNoBody("GET","/")
if (rest.get_LastMethodSuccess() != true)
    print rest.lastErrorText() + "\n";
    exit
end

xml = Chilkat::CkXml.new()
success = xml.LoadXml(responseXml)

# Show the full XML returned.
print xml.getXml() + "\n";

# Iterate over the buckets, showing each bucket name.
success = xml.FindChild2("Buckets")
if (xml.FirstChild2() == true)
    print xml.getChildContent("Name") + "\n";
    while (xml.NextSibling2() == true)
        print xml.getChildContent("Name") + "\n";
    end
end

# Move the internal pointer back to the root node.
xml.GetRoot2()