mobilize-ssh 1.0.1

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+config/
+log/
+log
+config

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mobilize-bash.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,202 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2012 ngmoco, LLC
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,175 @@
+Mobilize-Ssh
+============
+
+Mobilize-Ssh adds the power of ssh to [mobilize-base][mobilize-base].
+* move files, execute scripts, and output logs and datasets, all through
+Google Spreadsheets.
+
+Table Of Contents
+-----------------
+* [Overview](#section_Overview)
+* [Install](#section_Install)
+  * [Mobilize-Ssh](#section_Install_Mobilize-Ssh)
+  * [Install Dirs and Files](#section_Install_Dirs_and_Files)
+* [Configure](#section_Configure)
+  * [Ssh](#section_Configure_Ssh)
+* [Start](#section_Start)
+  * [Create Job](#section_Start_Create_Job)
+  * [Run Test](#section_Start_Run_Test)
+* [Meta](#section_Meta)
+* [Author](#section_Author)
+
+<a name='section_Overview'></a>
+Overview
+-----------
+
+* Mobilize-ssh adds script deployment to mobilize-base.
+
+<a name='section_Install'></a>
+Install
+------------
+
+Make sure you go through all the steps in the [mobilize-base][mobilize-base]
+install section first.
+
+<a name='section_Install_Mobilize-Ssh'></a>
+### Mobilize-Ssh
+
+add this to your Gemfile:
+
+``` ruby
+gem "mobilize-ssh", "~>1.0"
+```
+
+or do
+
+  $ gem install mobilize-ssh
+
+for a ruby-wide install.
+
+<a name='section_Install_Dirs_and_Files'></a>
+### Dirs and Files
+
+### Rakefile
+
+Inside the Rakefile in your project's root dir, make sure you have:
+
+``` ruby
+require 'mobilize-base/rakes'
+require 'mobilize-ssh/rakes'
+```
+
+This defines rake tasks essential to run the environment.
+
+### Config Dir
+
+run 
+
+  $ rake mobilize_ssh:setup
+
+This will copy over a sample ssh.yml to your config dir.
+
+<a name='section_Configure'></a>
+Configure
+------------
+
+<a name='section_Configure_Ssh'></a>
+### Configure Ssh
+
+The Ssh configuration consists of:
+* tmp_file_dir, which is where files will be stored before being scp'd
+over to the nodes. They will be deleted afterwards, unless the job
+fails in mid-copy. By default this is tmp/file/.
+* nodes, identified by aliases, such as `test_node`. This alias is what you should
+pass into the "node_alias" param over in the ssh.run task.
+
+Each node has a host, and optionally has a gateway. If you don't need a
+gateway, remove that row from the configuration file.
+
+Each host and gateway has a series of ssh params:
+* name - the ip address or name of the host
+* key - the relative path of the ssh key file. Default is
+"config/mobilize/ssh_private.key"
+* port - the port to connect on
+* user - the user you are connecting as
+
+Sample ssh.yml:
+
+``` yml
+
+development:
+  tmp_file_dir: "tmp/file/"
+  nodes:
+    dev_node:
+      host: {name: dev-host.com, key: "config/mobilize/ssh_private.key", port: 22, user: host_user}
+      gateway: {name: dev-gateway.com, key: "config/mobilize/ssh_private.key", port: 22, user: gateway_user}
+test:
+  tmp_file_dir: "tmp/file/"
+  nodes:
+    test_node:
+      host: {name: test-host.com, key: "config/mobilize/ssh_private.key", port: 22, user: host_user}
+      gateway: {name: test-gateway.com, key: "config/mobilize/ssh_private.key", port: 22, user: gateway_user}
+production:
+  tmp_file_dir: "tmp/file/"
+  nodes:
+    prod_node:
+      host: {name: prod-host.com, key: "config/mobilize/ssh_private.key", port: 22, user: host_user}
+      gateway: {name: prod-gateway.com, key: "config/mobilize/ssh_private.key", port: 22, user: gateway_user}
+```
+
+<a name='section_Start'></a>
+Start
+-----
+
+<a name='section_Start_Create_Job'></a>
+### Create Job
+
+* For mobilize-ssh, the following task is available:
+  * ssh.run `<node_alias>,<command>,*<gsheet_full_paths>`, which reads
+all gsheets, copies them to a temporary folder on the selected node, and
+runs the command inside that folder. 
+  * The test uses `ssh.run "test_node", "ruby code.rb", "Runner_mobilize(test)/code.rb", "Runner_mobilize(test)/code.sh"`
+
+<a name='section_Start_Run_Test'></a>
+### Run Test
+
+To run tests, you will need to 
+
+1) go through the [mobilize-base][mobilize-base] test first
+
+2) clone the mobilize-ssh repository 
+
+From the project folder, run
+
+3) $ rake mobilize_ssh:setup
+
+Copy over the config files from the mobilize-base project into the
+config dir, and populate the values in the ssh.yml file, esp. the
+test_node item.
+
+You should also copy the ssh private key you wish to use into your
+desired path (by default: config/mobilize/ssh_private.key), and make sure it is referenced in ssh.yml
+
+3) $ rake test
+
+This will populate your test Runner from mobilize-base with a sample ssh job.
+
+The purpose of the test will be to deploy two code files, have the first
+execute the second, which is a "tail /var/log/syslog" command, and write the resulting output to a gsheet.
+
+<a name='section_Meta'></a>
+Meta
+----
+
+* Code: `git clone git://github.com/ngmoco/mobilize-ssh.git`
+* Home: <https://github.com/ngmoco/mobilize-ssh>
+* Bugs: <https://github.com/ngmoco/mobilize-ssh/issues>
+* Gems: <http://rubygems.org/gems/mobilize-ssh>
+
+<a name='section_Author'></a>
+Author
+------
+
+Cassio Paes-Leme :: cpaesleme@ngmoco.com :: @cpaesleme
+
+[mobilize-base]: https://github.com/ngmoco/mobilize-base

data/Rakefile

@@ -0,0 +1,17 @@
+require "bundler/gem_tasks"
+
+require 'mobilize-base/rakes'
+require 'mobilize-ssh/rakes'
+
+#
+# Tests
+#
+require 'rake/testtask'
+
+Rake::TestTask.new do |test|
+  test.verbose = true
+  test.libs << "test"
+  test.libs << "lib"
+  test.test_files = FileList['test/**/*_test.rb']
+end
+task :default => :test

data/lib/mobilize-ssh.rb

@@ -0,0 +1,15 @@
+require "mobilize-ssh/version"
+require "mobilize-base"
+require "net/ssh"
+require "net/ssh/gateway"
+require "net/scp"
+require "mobilize-ssh/extensions/net-ssh-connection-session"
+require "mobilize-ssh/extensions/net-ssh-gateway"
+require "mobilize-ssh/extensions/socket"
+require "mobilize-ssh/extensions/string"
+
+module Mobilize
+  module Ssh
+  end
+end
+require "mobilize-ssh/handlers/ssh"

data/lib/mobilize-ssh/extensions/net-ssh-connection-session.rb

@@ -0,0 +1,14 @@
+class Net::SSH::Connection::Session
+  def run(command)
+    stdout,stderr = ["",""]
+    self.exec!(command) do |ch, stream, data|
+      if stream == :stderr
+        stderr += data
+      else
+        stdout += data
+      end
+    end
+    raise stderr if stderr.length>0
+    return stdout
+  end
+end