ngrok-v1 0.0.1 → 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 9e124310d039cbe23943427cc55b9df9cc4cc1ee
4
- data.tar.gz: dbaa073fb1ba22d226df0972d7e1a57057e8839e
3
+ metadata.gz: da3310420fe4db5842c9c3c87c241e7aec47c1b7
4
+ data.tar.gz: 150bcb7497112b56a6947b251e1ac37499cc3c7e
5
5
  SHA512:
6
- metadata.gz: 7774135990e8924811b543a6ed86951adf9a86b1f7c7aadefad01fe3c7f5202b6361491034ab49c9af79e7b9fc2ece3beac782ffefdc9e0256578758ec6015f2
7
- data.tar.gz: bb54000002cdd9169c3f9c7213398aab0ba45cc7903214c6c83c8bf933ff9f23ac43d83821425638d3b33ef460131237c9d615bc246d408986ba9ff7c02bb4a4
6
+ metadata.gz: 7a8e70755436a3c8b0917edf964722b49ebf2fc5d775f2e48b5e6440cef2fd0487ae46a192bc6668c458f7a33cf9d9a56283e76514aa5703f6a3c1464a185172
7
+ data.tar.gz: a28614e31e59168fa90e08319a2e3bdc3707c73f079c127de30c047201ff5653798a14e62fa5b7b1ba82a2493d51260cd5beb83e89b2fa0dc802c0543806f92e
data/README.md CHANGED
@@ -1,7 +1,9 @@
1
- # ngrok-v1
1
+ # ngrok-v1 [![Gem version](http://img.shields.io/gem/v/ngrok-v1.svg?style=flat-square)](http://rubygems.org/gems/ngrok-v1)
2
2
 
3
3
  Ruby gem wrapping [ngrok](https://ngrok.com) v1.
4
4
 
5
+ If you're using ngrok v2+, then this gem is not for you; use the [ngrok-tunnel](https://github.com/bogdanovich/ngrok-tunnel) gem instead.
6
+
5
7
  ## Installation
6
8
 
7
9
  Add this line to your application's Gemfile:
@@ -16,6 +18,24 @@ And then execute:
16
18
  $ bundle install
17
19
  ```
18
20
 
21
+ Lastly, install the ngrok v1 binary and ensure that it is available in your `PATH`.
22
+
19
23
  ## Usage
20
24
 
21
- TODO.
25
+ A basic example:
26
+
27
+ ```ruby
28
+ require 'ngrok-v1'
29
+
30
+ tunnel = NgrokV1::Client.new(port: 3000, protocol: 'http')
31
+
32
+ tunnel.start
33
+
34
+ tunnel.running? # => true
35
+
36
+ tunnel.uri # => http://75cab18e.ngrok.com
37
+
38
+ tunnel.stop
39
+
40
+ tunnel.running? # => false
41
+ ```
@@ -1,3 +1,3 @@
1
1
  module NgrokV1
2
- VERSION = "0.0.1"
2
+ VERSION = "1.0.0"
3
3
  end
data/localtunnel.gemspec CHANGED
@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
14
14
  spec.license = "MIT"
15
15
  spec.files = `git ls-files -z`.split("\x0")
16
16
  spec.require_paths = ["lib"]
17
- spec.post_install_message = "Please ensure that ngrok v1 is installed."
17
+ spec.post_install_message = "Please ensure that the ngrok v1 binary is installed."
18
18
  spec.add_development_dependency "bundler", "~> 1.10"
19
19
  spec.add_development_dependency "rake", "~> 10.0"
20
20
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ngrok-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.1
4
+ version: 1.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Swinburne Software Innovation Lab
@@ -58,7 +58,7 @@ homepage: https://github.com/ssilab/ngrok-v1
58
58
  licenses:
59
59
  - MIT
60
60
  metadata: {}
61
- post_install_message: Please ensure that ngrok v1 is installed.
61
+ post_install_message: Please ensure that the ngrok v1 binary is installed.
62
62
  rdoc_options: []
63
63
  require_paths:
64
64
  - lib