Class: NgrokAPI::Services::TunnelsClient
- Inherits:
-
Object
- Object
- NgrokAPI::Services::TunnelsClient
- Defined in:
- lib/ngrokapi/services/tunnels_client.rb
Overview
Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.
Constant Summary collapse
- LIST_PROPERTY =
The List Property from the resulting API for list calls
'tunnels'
- PATH =
The API path for the requests
'/tunnels'
Instance Attribute Summary collapse
-
#client ⇒ Object
readonly
Returns the value of attribute client.
Instance Method Summary collapse
-
#get(id: "") ⇒ NgrokAPI::Models::Tunnel
Get the status of a tunnel by ID.
-
#get!(id: "") ⇒ NgrokAPI::Models::Tunnel
Get the status of a tunnel by ID Throws an exception if API error.
-
#initialize(client:) ⇒ TunnelsClient
constructor
A new instance of TunnelsClient.
-
#list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all online tunnels currently running on the account.
-
#list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all online tunnels currently running on the account.
Constructor Details
#initialize(client:) ⇒ TunnelsClient
Returns a new instance of TunnelsClient.
18 19 20 |
# File 'lib/ngrokapi/services/tunnels_client.rb', line 18 def initialize(client:) @client = client end |
Instance Attribute Details
#client ⇒ Object (readonly)
Returns the value of attribute client.
16 17 18 |
# File 'lib/ngrokapi/services/tunnels_client.rb', line 16 def client @client end |
Instance Method Details
#get(id: "") ⇒ NgrokAPI::Models::Tunnel
Get the status of a tunnel by ID
82 83 84 85 86 87 88 89 90 |
# File 'lib/ngrokapi/services/tunnels_client.rb', line 82 def get(id: "") path = '/tunnels/%{id}' replacements = { id: id, } data = {} result = @client.get(path % replacements, data: data) NgrokAPI::Models::Tunnel.new(client: self, attrs: result) end |
#get!(id: "") ⇒ NgrokAPI::Models::Tunnel
Get the status of a tunnel by ID Throws an exception if API error.
100 101 102 103 104 105 106 107 108 |
# File 'lib/ngrokapi/services/tunnels_client.rb', line 100 def get!(id: "") path = '/tunnels/%{id}' replacements = { id: id, } data = {} result = @client.get(path % replacements, data: data, danger: true) NgrokAPI::Models::Tunnel.new(client: self, attrs: result) end |
#list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all online tunnels currently running on the account.
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
# File 'lib/ngrokapi/services/tunnels_client.rb', line 31 def list(before_id: nil, limit: nil, url: nil) result = @client.list( before_id: before_id, limit: limit, url: url, path: PATH ) NgrokAPI::Models::Listable.new( client: self, attrs: result, list_property: LIST_PROPERTY, klass: NgrokAPI::Models::Tunnel ) end |
#list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all online tunnels currently running on the account. Throws an exception if API error.
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 |
# File 'lib/ngrokapi/services/tunnels_client.rb', line 57 def list!(before_id: nil, limit: nil, url: nil) result = @client.list( before_id: before_id, limit: limit, danger: true, url: url, path: PATH ) NgrokAPI::Models::Listable.new( client: self, attrs: result, list_property: LIST_PROPERTY, klass: NgrokAPI::Models::Tunnel, danger: true ) end |