pipe2me-client 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6818635298fc7716a54a99493e062c5ebcd2cbc
-  data.tar.gz: b169f038d22b5a93a2391e1da087fad6e1c1a452
+  metadata.gz: 3a009fe77ae2b8d681d0424c93b2d6102e3e4381
+  data.tar.gz: 70a60b699c148d9223685ef7a0f6f05c9c52d2df
 SHA512:
-  metadata.gz: 16c8586bb0e9894c22eeddaaf2bef2d5bb49b0fa9d945821ea79582d441809ce0148aef8eeea7c634f9e5808c29513e1591382c13effe669478e893b02ea04fb
-  data.tar.gz: ec4679ba8efc33f46c0c9bbecb4344ac6fcb4b557881a51f2d66732cf341184bb1b679ada24d470e66e80736daf585ecffb05deca043ffd54b25562e8cd4e580
+  metadata.gz: 291f0bf6ad7946006b983d12cb8af281fa60e0ad72b195d4a5f6d2b519f28a65746c684a61aacf32c1f6727e4835c8e6a4d0babe108f1d65522c779f65f72df5
+  data.tar.gz: 216b17a55e96a6b4e3a1cc56b6ea5f40cfeaae3707b0f78245b708b9d4c877097be3820ef0d7867a9e37604686ff35eaddf05fc01b241450b4c5d673ad0cb395

data/README.mdown

@@ -17,7 +17,7 @@ Mini-example: This registers two tunnels with a single hostname for
 two services on localhost (http on port 9090, https on port 9091). 
 
     # Setup tunnels. This responds with the domain name
-    > ./bin/pipe2me setup -p http,https --server http://pipe2.me --auth 123 --ports 9090,9091
+    > ./bin/pipe2me setup -p http,https --server http://test.pipe2.me:8080 --token review@pipe2me --ports 9090,9091
     pretty-ivory-horse.test.pipe2.me
 
     # Review the assigned URLs:
@@ -55,36 +55,34 @@ Before submitting a pull request you should also run a test against the
 test.pipe2.me instance, which is available most of the time for that purpose. 
 To do that, run `rake test:release`.
 
-## Auth tokens
+## Tunnel tokens
 
 As ports and domain names are sparse resources the pipe2me server API
 requires the use of authorization tokens when requesting a tunnel. A
-token is similar to a currency in that it describes which tunnels are
-supported. This could limit the number of tunneled ports, the traffic
-for those ports, whether or not a certificate is self-signed or signed
-by a regular CA, etc. 
+token is similar to a 'currency' in that it describes which tunnels are
+supported. A token could limit the number of ports that can be tunnelled, 
+the amount of traffic for those ports, whether or not a certificate is 
+self-signed or signed by a regular CA, etc. 
+
 
 The features of a token are not defined within this protocol. However,
 there has to be one. Contact the administrator of the pipe2me server
 to know more.
 
-### Auth tokens on test.pipe2.me
-
-The test.pipe2.me server is configured to use some public tokens. 
+A freshly installed pipe2me server comes with a number of preconfigured tokens.
+Of course, a server admin should (and probably would) change those tokens.
+However, as a test target, the pipe2me test server at http://test.pipe2.me:8080
+supports these tokens: 
 
-- a test token: this builds tunnels that are available for 5 minutes.
+- `test@pipe2me`: this builds tunnels that are available for 5 minutes.
   The test token is intended for use with automated test scenarios.
-  The current test token is `test@test.kinko.me`.
-- a review token: this builds tunnels that are available for up to 
-  one day. A review token is intended for get a feel for the pipe2me
-  package. The current review token is `review@test.kinko.me`.
+- `review@pipe2me`: this builds tunnels that are available for up to 
+  one day. A review token should help you get a feel for the pipe2me
+  package. 
 
 If you need a longer lived token for development, review and/or test 
 feel free to contact us at contact@kinko.me. 
 
-If you want to use pipe2me for any practical purpose consider 
-signing up at https://pipe2.me, which should be online end of January. 
-
 ## Licensing
 
 **The pipe2me client software** is (c) The Kinko Team, 2014 and released to you 

data/lib/pipe2me/cli.rb

@@ -36,8 +36,8 @@ class Pipe2me::CLI < Thor
   end
 
   desc "setup", "fetch a new tunnel setup"
-  option :server, :default => "http://test.pipe2.me:8080"
-  option :auth, :required => true                     # "auth token"
+  option :server, :aliases => :s, :default => "http://test.pipe2.me:8080"
+  option :token, :required => true                    # "tunnel token"
   option :protocols, :default => "https"              # "protocol names, e.g. 'http,https,imap'"
   option :ports, :type => :string                     # "local ports, one per protocol"
   def setup

data/lib/pipe2me/tunnel.rb

@@ -31,7 +31,7 @@ module Pipe2me::Tunnel
     end
 
     # [todo] escape auth option
-    response = HTTP.post! "#{Pipe2me::Config.server}/tunnels/#{options[:auth]}",
+    response = HTTP.post! "#{Pipe2me::Config.server}/tunnels/#{options[:token]}",
       "protocols" => options[:protocols]
 
     server_info = ShellFormat.parse(response)

data/lib/pipe2me/version.rb

@@ -1,4 +1,4 @@
 module Pipe2me
-  VERSION = "0.2.3"
-  BANNER = "pipe2.me command line client V#{Pipe2me::VERSION}; (c) The kink team, 2013, 2014."
+  VERSION = "0.2.4"
+  BANNER = "pipe2me command line client V#{Pipe2me::VERSION}; (c) The kink team, 2013, 2014."
 end

data/test/auth-token-test.sh

@@ -4,7 +4,7 @@ describe "fails on invalid and missing auth"
 . $(dirname $1)/testhelper.inc
 
 it_fails_on_invalid_auth() {
-  ! $pipe2me setup --server $pipe2me_server --auth $pipe2me_token.invalid
+  ! $pipe2me setup --server $pipe2me_server --token $pipe2me_token.invalid
 }
 
 it_fails_on_missing_auth_token() {

data/test/env-test.sh

@@ -4,7 +4,7 @@ describe "show pipe2me environment"
 . $(dirname $1)/testhelper.inc
 
 it_start_a_tunnel() {
-  fqdn=$($pipe2me setup --server $pipe2me_server --auth $pipe2me_token)
+  fqdn=$($pipe2me setup --server $pipe2me_server --token $pipe2me_token)
   $pipe2me env > env
   echo "== env is ============="
   cat env

data/test/monitrc-test.sh

@@ -13,7 +13,7 @@ it_works_with_monitrc() {
 
 it_creates_a_monitrc_file() {
   ! [ -e pipe2me.monitrc ]
-  fqdn=$($pipe2me setup --server $pipe2me_server --auth $pipe2me_token)
+  fqdn=$($pipe2me setup --server $pipe2me_server --token $pipe2me_token)
 
   $pipe2me monitrc
   [ -e pipe2me.monitrc ]

data/test/opensslkey-test.sh

@@ -5,7 +5,7 @@ describe "openssl tests"
 
 # setup creates and signs openssl credentials
 it_sets_up_openssl_certs() {
-  fqdn=$($pipe2me setup --server $pipe2me_server --auth $pipe2me_token)
+  fqdn=$($pipe2me setup --server $pipe2me_server --token $pipe2me_token)
   test -f pipe2me.openssl.priv
   cat pipe2me.openssl.priv | grep "BEGIN RSA PRIVATE KEY"
 

data/test/setup-test.sh

@@ -5,7 +5,7 @@ describe "tunnel setup"
 
 # setup a tunnel
 it_sets_up_tunnels() {
-  fqdn=$($pipe2me setup --server $pipe2me_server --auth $pipe2me_token --ports 8100,8101 --protocols http,https)
+  fqdn=$($pipe2me setup --server $pipe2me_server --token $pipe2me_token --ports 8100,8101 --protocols http,https)
   
   # pipe2me setup --server $pipe2me_server returns the fqdn of the subdomain and nothing else
   test 1 -eq $(echo $fqdn | wc -l)  
@@ -14,5 +14,5 @@ it_sets_up_tunnels() {
   echo $fqdn | grep \.pipe2\.dev
 
   # Cannot setup a second tunnel in the same directory.
-  ! $pipe2me setup --server $pipe2me_server --auth $pipe2me_token
+  ! $pipe2me setup --server $pipe2me_server --token $pipe2me_token
 }

data/test/sshkey-test.sh

@@ -4,7 +4,7 @@ describe "ssh key creation"
 . $(dirname $1)/testhelper.inc
 
 it_sets_up_ssh_identity() {
-  fqdn=$($pipe2me setup --server $pipe2me_server --auth $pipe2me_token)
+  fqdn=$($pipe2me setup --server $pipe2me_server --token $pipe2me_token)
   test -f pipe2me.id_rsa.pub
   test -f pipe2me.id_rsa
   

data/test/testhelper.debug

@@ -1,2 +1,2 @@
 pipe2me_server=http://pipe2.dev:8080
-pipe2me_token=test@test.kinko.me
+pipe2me_token=test@pipe2me

data/test/testhelper.release

@@ -1,2 +1,2 @@
 pipe2me_server=http://pipe2.dev:8080
-pipe2me_token=test@test.kinko.me
+pipe2me_token=test@pipe2me

data/test/verify-test.sh

@@ -5,7 +5,7 @@ describe "verify subcommand"
 
 # setup a tunnel
 it_sets_up_tunnels_and_verifies() {
-  fqdn=$($pipe2me setup --server $pipe2me_server --auth short@test.kinko.me)
+  fqdn=$($pipe2me setup --server $pipe2me_server --token short@pipe2me)
 
   # pipe2me setup --server $pipe2me_server returns the fqdn of the subdomain and nothing else
   test 1 -eq $(echo $fqdn | wc -l)  

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pipe2me-client
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - radiospiel
@@ -66,7 +66,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: pipe2.me command line client V0.2.3; (c) The kink team, 2013, 2014.
+description: pipe2me command line client V0.2.4; (c) The kink team, 2013, 2014.
 email: contact@kinko.me
 executables:
 - pipe2me
@@ -131,5 +131,5 @@ rubyforge_project:
 rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
-summary: pipe2.me command line client V0.2.3; (c) The kink team, 2013, 2014.
+summary: pipe2me command line client V0.2.4; (c) The kink team, 2013, 2014.
 test_files: []