view_server 0.0.5 → 0.0.6

data/README.md

@@ -1,24 +1,73 @@
-# ViewServer
+# view_server
+## Description
 
-TODO: Write a gem description
+Sometimes when working on a remote server you want to view data in a local app like Excel. The traditionnal way to acheive this is to save the data into a file then copy it using scp, then opening it with the app of your choice. If you have to do this many times a day it can really slow down your workflow.
+With the view\_server it's very easy to view a file.
+
+view\_server also offers you a way to access your local clipboard from a remote server.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+    gem install view_server
 
-    gem 'view_server'
+## Usage
 
-And then execute:
+### Show file
 
-    $ bundle
+Start the server on your local machine. At the moment only OS X is supported.
 
-Or install it yourself as:
+    view_server
 
-    $ gem install view_server
+Now open a ssh session to the remote server and create a reverse tunnel to your local machine:
 
-## Usage
+    ssh -R 10021:localhost:10021 username@remoteserver.com
+
+Then install the gem on the remote server:
+
+    gem install view_server
+
+Now that your setup is complete. You can view data from the remote server. Open a irb console on the remote server and try this:
+
+    require 'view_server'
+
+    ViewServer::Client.new.server.show <<EOF, 'csv'
+    1,2
+    3,4
+    EOF
+
+This will open Excel with a spreadsheet filled with the data defined in the here document.
+
+The last paramenter of the show method represents the file extension of the temporary file that will be created before being opened on your local computer. If you want to open it with your text editor just change this parameter with 'txt'
+
+There is also a command line utility to that you can use:
+
+    echo  -e "1,2\n2,3" | show -e csv
+
+### Clipboard support
+
+On the remote server you can copy to the local clipboard:
+
+    ls | cbcopy
+
+You can also paste to the remote server:
+
+    cbpaste > file.txt
+
+## Simplifying the ssh command
+
+It can be teadious to add the -R parameter each time that you want to ssh to the remote server.
+In order to create the tunnel automaticaly when you ssh to a server you can add this at the end of your ~/.ssh/config
+
+    Host * !*github* !*bitbucket*
+    RemoteForward 10021 localhost:10021
+
+The first line tells ssh to create the tunnel for all ssh connection except for github and bitbucket.
+
+Now each time that you connect to a remote server with ssh the tunnel will be made, to need to add the -R option.
+
+## TODO
 
-TODO: Write usage instructions here
+Adding tests
 
 ## Contributing
 
@@ -28,4 +77,4 @@ TODO: Write usage instructions here
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 =======
-view_server
+view\_server

data/Rakefile

@@ -6,9 +6,9 @@ require 'bundler/gem_tasks'
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|
-  t.pattern = "test/*_test.rb"
+  t.pattern = "spec/*_spec.rb"
   # To avoid requirement of File.expand_path(File.dirname(__FILE__) + 'test_helper') from test files
-  t.libs << 'test'
+  t.libs << 'spec'
 end
 
 

data/bin/cbcopy

@@ -3,9 +3,4 @@
 require 'main'
 require 'view_server'
 
-Main do
-  def run
-    ViewServer::Client.new.server.to_cb($stdin.read)
-  end
-end
-
+ViewServer::CbCopyRunner.run(ARGV)

data/bin/cbpaste

@@ -3,9 +3,4 @@
 require 'main'
 require 'view_server'
 
-Main do
-  def run
-    $stdout << ViewServer::Client.new.server.paste
-  end
-end
-
+ViewServer::CbPasteRunner.run(ARGV)

data/bin/show

@@ -1,48 +1,5 @@
 #! /usr/bin/env ruby
-
 require 'main'
 require 'view_server'
-require 'optparse'
-
-options = {}
-
-class ShowRunner
-  def self.parse(args)
-    options = {}
-    opt_parser = OptionParser.new do |opts|
-      opts.banner = "Usage: show [options] [file]"
-
-      opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
-        options[:verbose] = v
-      end
-
-      opts.on("-e", "--extension EXTENSION", "File extension") do |v|
-        options[:ext] = v
-      end
-
-      opts.on("-p", "--port PORT", "Port number") do |v|
-        options[:ext] = v
-      end
-    end
-
-    opt_parser.parse!(args)
-    filename = ARGV.first
-    if filename
-      data = File.read filename
-      ext = File.extname(filename)[1..-1]
-    else
-      data = $stdin.read
-      ext = options.fetch(:ext) {'txt'}
-    end
-
-    {:data => data, :ext => ext }
-  end
-
-  def self.run(args)
-    opts = self.parse args
-    ViewServer::Client.new.server.show(opts[:data], opts[:ext])
-  end
-end
-options = ShowRunner.run(ARGV)
-
 
+ViewServer::ShowRunner.run(ARGV)

data/lib/view_server.rb

@@ -1,8 +1,13 @@
 require "view_server/version"
+require "view_server/show_runner"
 
 module ViewServer
-  autoload :Server,  'view_server/server'
-  autoload :Client,  'view_server/client'
-  autoload :Runner,  'view_server/runner'
-  autoload :TmpFile, 'view_server/tmp_file'
+  autoload :Server,       "view_server/server"
+  autoload :Client,       "view_server/client"
+  autoload :Runner,       "view_server/runner"
+  autoload :TmpFile,      "view_server/tmp_file"
+  autoload :ShowRunner,   "view_server/show_runner"
+  autoload :CbCopyRunner, "view_server/cbcopy_runner"
+  autoload :CbPasteRunner,"view_server/cbpaste_runner"
+  autoload :Launcher,     "view_server/launcher"
 end

data/lib/view_server/cbcopy_runner.rb

@@ -0,0 +1,31 @@
+require 'optparse'
+require 'clipboard'
+
+module ViewServer
+  class CbCopyRunner
+    def self.parse(args)
+      options = {:port => 10021}
+      opt_parser = OptionParser.new do |opts|
+        opts.banner = "Usage: cbcopy [options]"
+
+        opts.on("-p", "--port PORT", "Port number. Default is 10021") do |v|
+          options[:port] = Integer(v)
+        end
+      end
+      opt_parser.parse!(args)
+      options
+    end
+
+    def self.run(args = [])
+      opts = parse(args)
+      server = if opts[:port] == -1
+        ViewServer::Server.new(nil)
+      else
+        ViewServer::Client.new(opts[:port])
+      end
+      content = $stdin.read
+      server.to_cb(content)
+    end
+  end
+end
+

data/lib/view_server/cbpaste_runner.rb

@@ -0,0 +1,29 @@
+require 'optparse'
+require 'clipboard'
+
+module ViewServer
+  class CbPasteRunner
+    def self.parse(args)
+      options = {:port => 10021}
+      opt_parser = OptionParser.new do |opts|
+        opts.banner = "Usage: cbpaste [options]"
+
+        opts.on("-p", "--port PORT", "Port number. Default is 10021") do |v|
+          options[:port] = Integer(v)
+        end
+      end
+      opt_parser.parse!(args)
+      options
+    end
+
+    def self.run(args = [])
+      opts = parse(args)
+      server = if opts[:port] == -1
+        ViewServer::Server.new(nil)
+      else
+        ViewServer::Client.new(opts[:port])
+      end
+      $stdout << server.paste
+    end
+  end
+end

data/lib/view_server/client.rb

@@ -1,12 +1,17 @@
 require 'drb'
+require 'delegate'
 
 module ViewServer
-  class Client
+  class Client < Delegator
     attr_reader :server
 
     def initialize(port = 10021)
       DRb.start_service
       @server = DRbObject.new(nil, "druby://localhost:#{port}")
     end
+
+    def __getobj__
+      @server
+    end
   end
 end

data/lib/view_server/launcher.rb

@@ -0,0 +1,12 @@
+module ViewServer
+  class Launcher
+    def launch(data, file_ext = 'txt')
+      TmpFile.open("", "." + file_ext) do |a|
+        a << data
+        a.close
+        `open #{a.path} `
+        sleep 5 #We don't want to delete the file before it's loaded
+      end
+    end
+  end
+end

data/lib/view_server/runner.rb

@@ -2,38 +2,6 @@ require 'main'
 
 module ViewServer
   class Runner
-    def self.old_run
-      options = Clip do |p|
-        p.flag 's', 'server',:desc => 'Is a server', :default => false
-
-        p.optional 'p', 'port', :desc => 'The port', :default => 10021 do |v|
-          v.to_i # always deal with integers
-        end
-        p.flag 'c', 'copy_to_clipboard', :desc => "Send to clipboard" 
-        p.flag 'P', 'paste_from_clipboard', :desc => "Read from clipboard" 
-        p.flag 'v', 'verbose', :desc => 'Make it chatty'
-      end
-
-      if options.valid?
-        if options.verbose?
-          puts options.host
-          puts options.port
-          puts 'files:'
-          options.files.each do |f|
-            puts "\t#{f}"
-          end
-        end
-        if options.server?
-          Server.serve(options) 
-        else
-          Client.new(options.port).send(options) 
-        end
-      else
-        # print error message(s) and usage
-        $stderr.puts options.to_s
-      end
-    end
-
     def self.run 
       main.run
     end

data/lib/view_server/server.rb

@@ -1,28 +1,30 @@
 require 'drb'
+require 'clipboard'
 
 module ViewServer
   class Server
+    attr_reader :launcher, :clipboard
+
+    def initialize(launcher = Launcher.new)
+      @launcher = launcher
+      @clipboard = Clipboard
+    end
+
     # I wanted to use the display method but it conflicts 
     # with the Object#display method
     def show(data, file_ext = 'txt')
-      TmpFile.open("", "." + file_ext) do |a|
-        a << data
-        a.close
-        `open #{a.path} `
-        sleep 5 #We don't want to delete the file before it's loaded
-      end
+      launcher.launch(data, file_ext)
     end
 
     def to_cb(data) # To clipboard
-      File.open("#{ENV['HOME']}/tmp/clipboard", "w"){|a| a << data}
-      IO.popen('pbcopy', 'w'){|a| a << data}
+      clipboard.copy(data)
     end
 
     def paste # From clipboard
-      `pbpaste`
+      clipboard.paste
     end
 
-    def self.serve(port)
+    def self.serve(launcher = Launcher.new, port)
       DRb.start_service "druby://localhost:#{port}", Server.new
       puts DRb.uri
       DRb.thread.join

data/lib/view_server/show_runner.rb

@@ -0,0 +1,43 @@
+require 'optparse'
+
+module ViewServer
+  class ShowRunner
+    def self.parse(args)
+      options = {:port => 10021}
+      opt_parser = OptionParser.new do |opts|
+        opts.banner = "Usage: show [options] [file]"
+
+        opts.on("-e", "--extension EXTENSION", "File extension") do |v|
+          options[:ext] = v
+        end
+
+        opts.on("-p", "--port PORT", "Port number. Default is 10021") do |v|
+          options[:port] = Integer(v)
+        end
+      end
+
+      opt_parser.parse!(args)
+
+      filename = ARGV.first
+      if filename
+        data = File.read filename
+        ext = File.extname(filename)[1..-1]
+      else
+        data = $stdin.read
+        ext = options.fetch(:ext) {'txt'}
+      end
+
+      options.merge({:data => data, :ext => ext })
+    end
+
+    def self.run(args, launcher = Launcher.new)
+      opts = parse(args)
+
+      if opts[:port] == -1
+        ViewServer::Server.new(launcher).show(opts[:data], opts[:ext])
+      else
+        ViewServer::Client.new(opts[:port]).show(opts[:data], opts[:ext])
+      end
+    end
+  end
+end

data/lib/view_server/version.rb

@@ -1,3 +1,3 @@
 module ViewServer
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/cbcopy_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe 'CbCopyRunner' do
+  it 'should copy to the clipboard' do
+    data = 'This is the clipboard content'
+    capture_io(data) do
+      ViewServer::CbCopyRunner.run %w[-p -1]
+    end
+
+    pasted = capture_io('') do
+      ViewServer::CbPasteRunner.run %w[-p -1]
+    end
+
+    pasted.must_equal data
+  end
+end

data/spec/show_runner_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe 'ShowRunner' do
+  it 'should call the show server method with data and extension' do
+    data = 'This is data'
+    launcher = mock('launcher')
+    launcher.expects(:launch).with(data, 'csv')
+    capture_io data do
+      ViewServer::ShowRunner.run %w[-e csv -p -1], launcher
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,60 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'mocha/setup'
+
+require 'view_server'
+require 'fileutils'
+require 'stringio'
+require 'open3'
+require 'colored'
+require 'pry'
+
+class MiniTest::Spec
+  BIN_DIR = File.join(File.dirname(File.expand_path(__FILE__)), '../bin' )
+  LIB_DIR = File.join(File.dirname(File.expand_path(__FILE__)), '../lib' )
+
+  def run_exe(executable, stdin_str, cmd_arg = [])
+    env       = {"RUBYLIB" => "#{LIB_DIR}:#{ENV['RUBYLIB']}"}
+    filepath  = File.join(BIN_DIR, executable)
+    outstream = StringIO.new
+
+    Open3.popen3(env, filepath, *cmd_arg) do |stdin, stdout, stderr, wait_thr|
+      stdin << stdin_str
+      stdin.close
+      outstream << stdout.read
+      raise_on_error(wait_thr.value, stderr, executable, stdout)
+    end
+    outstream.string
+  end
+
+  def capture_io(in_str)
+    old_stdin, old_stdout = $stdin, $stdout
+    $stdin = StringIO.new(in_str)
+    $stdout = StringIO.new
+    yield
+    out_str = $stdout.string
+    out_str
+  ensure
+    $stdin, $stdout = old_stdin, old_stdout
+  end
+
+  def raise_on_error(status, stderr, executable, stdout)
+    if ! status.success?
+      msg = <<EOF
+Error running #{executable}"
+stdout:
+#{stdout.read}
+
+stderr:
+#{stderr.read}
+
+status:
+#{status}
+EOF
+      raise msg
+    end
+  end
+end

data/view_server.gemspec

@@ -6,13 +6,16 @@ require 'view_server/version'
 Gem::Specification.new do |gem|
   gem.name          = "view_server"
   gem.version       = ViewServer::VERSION
-  gem.add_dependency "clip"
   gem.add_dependency "main"
-  gem.add_development_dependency 'rake'
+  gem.add_dependency "clipboard"
+  gem.add_development_dependency "rake"
   gem.add_development_dependency "bundler", "~> 1.0"
-  gem.add_development_dependency 'minitest'
-  gem.add_development_dependency 'pry'
-  gem.add_development_dependency 'pry-nav'
+  gem.add_development_dependency "minitest"
+  gem.add_development_dependency "pry"
+  gem.add_development_dependency "pry-nav"
+  gem.add_development_dependency "colored"
+  gem.add_development_dependency "mocha"
+
   gem.authors       = ["Martin Chabot"]
   gem.email         = ["chabotm@gmail.com"]
   gem.description   = %q{Allow local viewing of remote files}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: view_server
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,10 +9,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-14 00:00:00.000000000 Z
+date: 2013-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: clip
+  name: main
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -28,7 +28,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: main
+  name: clipboard
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -123,6 +123,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Allow local viewing of remote files
 email:
 - chabotm@gmail.com
@@ -144,14 +176,19 @@ files:
 - bin/show
 - bin/view_server
 - lib/view_server.rb
+- lib/view_server/cbcopy_runner.rb
+- lib/view_server/cbpaste_runner.rb
 - lib/view_server/client.rb
+- lib/view_server/launcher.rb
 - lib/view_server/runner.rb
 - lib/view_server/server.rb
+- lib/view_server/show_runner.rb
 - lib/view_server/tmp_file.rb
 - lib/view_server/version.rb
-- test/runner_spec.rb
-- test/spec_helper.rb
-- test/view_server_test.rb
+- spec/cb_paste_runner_spec.rb
+- spec/cbcopy_spec.rb
+- spec/show_runner_spec.rb
+- spec/spec_helper.rb
 - view_server.gemspec
 homepage: ''
 licenses: []
@@ -167,7 +204,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4378741166747802808
+      hash: -1787566526224458814
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -176,7 +213,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4378741166747802808
+      hash: -1787566526224458814
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -184,6 +221,7 @@ signing_key:
 specification_version: 3
 summary: Allow local viewing of remote files
 test_files:
-- test/runner_spec.rb
-- test/spec_helper.rb
-- test/view_server_test.rb
+- spec/cb_paste_runner_spec.rb
+- spec/cbcopy_spec.rb
+- spec/show_runner_spec.rb
+- spec/spec_helper.rb

data/test/runner_spec.rb

@@ -1,10 +0,0 @@
-require 'spec_helper'
-
-describe 'ViewServer Runner Main' do
-  before do
-    @main = ViewServer.main
-  end
-
-  it 'should start as a sever' do
-  end
-end

data/test/spec_helper.rb

@@ -1,4 +0,0 @@
-$:.unshift File.expand_path('..', __FILE__)
-$:.unshift File.expand_path('../../lib', __FILE__)
-require 'minitest/spec'
-require 'minitest/autorun'

data/test/view_server_test.rb

@@ -1,9 +0,0 @@
-require 'test_helper'
-
-module ViewServer
-  class ViewServerTest < MiniTest::Unit::TestCase
-    def test_truth
-      assert true 
-    end
-  end 
-end