net-simple 0.1.0

data/README.textile

@@ -0,0 +1,57 @@
+h1. net-simple
+
+h2. Description
+
+A simple wrapper for net-ssh and net-scp which allows running commands and
+transferring files. Inspired by some functionality found
+
+h2. Installation
+
+    sudo gem install tpitale-net-simple
+
+h2. Usage
+
+    require 'net/simple'
+
+Make a connection:
+
+    host = Net::Simple.new('ip or host', 'username', 'password')
+
+Three ways to run a command:
+
+    host.connect do
+      run('ls')
+    end
+
+    host.with_connection do |conn|
+      conn.run('ls')
+    end
+
+    host.connect
+    host.run('ls')
+    host.close
+
+h2. License
+
+Copyright (c) 2009 Tony Pitale
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+
+require 'lib/net/simple/version'
+
+task :default => :test
+
+spec = Gem::Specification.new do |s|
+  s.name            = 'net-simple'
+  s.version         = NetSimple::Version.to_s
+  s.summary         = "Simple wrapper for net/ssh and net/scp"
+  s.author          = 'Tony Pitale'
+  s.email           = 'tpitale@gmail.com'
+  s.homepage        = 'http://t.pitale.com'
+  s.files           = %w(README.textile Rakefile) + Dir.glob("lib/**/*")
+  s.test_files      = Dir.glob("test/**/*_test.rb")
+
+  s.add_dependency('net-ssh', '~> 2.0.10')
+  s.add_dependency('net-scp', '~> 1.0.1')
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+desc 'Generate the gemspec to serve this Gem from Github'
+task :github do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, 'w') {|f| f << spec.to_ruby }
+  puts "Created gemspec: #{file}"
+end
+
+begin
+  require 'rcov/rcovtask'
+  
+  desc "Generate RCov coverage report"
+  Rcov::RcovTask.new(:rcov) do |t|
+    t.test_files = FileList['test/**/*_test.rb']
+    t.rcov_opts << "-x lib/net/simple/version.rb"
+  end
+rescue LoadError
+  nil
+end

data/lib/net/simple.rb

@@ -0,0 +1,45 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'net/ssh'
+require 'net/scp'
+
+module Net
+  class Simple
+    def initialize(host, username, password="", verbose = :fatal)
+      @host = host
+      @username = username
+      @ssh_options = {:password => password, :verbose => verbose}
+    end
+
+    def connect(&block)
+      @connection ||= Net::SSH.start(@host, @username, @ssh_options)
+      block_given? ? (instance_eval(&block) and close) : @connection
+    end
+
+    def with_connection(&block)
+      connect
+      yield self if block_given?
+      close
+    end
+
+    def run(command)
+      @connection.exec!(command)
+    end
+
+    def close
+      @connection.close
+    end
+
+    # def sudo(command)
+    #   @connection.exec!("sudo #{command}")
+    # end
+
+    def download(remote, local)
+      Net::SCP.download!(@host, @username, remote, local, :ssh => @ssh_options)
+    end
+
+    def upload(local, remote)
+      Net::SCP.upload!(@host, @username, local, remote, :ssh => @ssh_options)
+    end
+  end
+end

data/lib/net/simple/version.rb

@@ -0,0 +1,13 @@
+module NetSimple
+  module Version
+    
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+    
+    def self.to_s # :nodoc:
+      [MAJOR, MINOR, TINY].join('.')
+    end
+    
+  end
+end

data/test/unit/net_simple_test.rb

@@ -0,0 +1,60 @@
+require File.join(File.dirname(__FILE__), "..", "test_helper")
+
+class SimpleTest < Test::Unit::TestCase
+  context "The Net/Simple class" do
+    setup do
+      @simple = Net::Simple.new('host', 'username', 'password')
+      @options = {:password => 'password', :verbose => :fatal}
+    end
+
+    should "make a connection" do
+      Net::SSH.expects(:start).with('host', 'username', @options).returns('connection')
+      assert_equal 'connection', @simple.connect
+    end
+
+    should "make a connection and eval a block" do
+      Net::SSH.expects(:start).with('host', 'username', @options).returns('connection')
+      @simple.expects(:run).with('hello').returns(true)
+      @simple.expects(:close)
+
+      @simple.connect do
+        run('hello')
+      end
+    end
+
+    should "run with a connection" do
+      @simple.expects(:connect)
+      @simple.expects(:close)
+      @simple.expects(:run).with('hello')
+      @simple.with_connection do |conn|
+        conn.run('hello')
+      end
+    end
+
+    should "run commands given to it" do
+      connection = mock
+      connection.expects(:exec!).with('hello').returns('hi to you')
+      Net::SSH.expects(:start).with('host', 'username', @options).returns(connection)
+      @simple.connect
+      assert_equal 'hi to you', @simple.run('hello')
+    end
+
+    should "download a file from a remote host" do
+      Net::SCP.expects(:download!).with('host', 'username', 'here', 'there', :ssh => @options).returns('download')
+      assert_equal 'download', @simple.download('here','there')
+    end
+
+    should "upload a file from a remote host" do
+      Net::SCP.expects(:upload!).with('host', 'username', 'here', 'there', :ssh => @options).returns('upload')
+      assert_equal 'upload', @simple.upload('here','there')
+    end
+
+    should "close an open connection" do
+      connection = mock
+      connection.expects(:close)
+      Net::SSH.expects(:start).with('host', 'username', @options).returns(connection)
+      @simple.connect
+      @simple.close
+    end
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: net-simple
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tony Pitale
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-02 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: net-ssh
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.0.10
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: net-scp
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.1
+    version: 
+description: 
+email: tpitale@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.textile
+- Rakefile
+- lib/net/simple/version.rb
+- lib/net/simple.rb
+- test/unit/net_simple_test.rb
+has_rdoc: true
+homepage: http://t.pitale.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: Simple wrapper for net/ssh and net/scp
+test_files: 
+- test/unit/net_simple_test.rb