fulmar-shell 1.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 163cd665e5afb087113d0f5db20bc22ce723060f
+  data.tar.gz: 84b82d03fd5473f437ef8bb35ebf4691819733d4
+SHA512:
+  metadata.gz: 7e970c4ae6bcd02b1c82c15314cb31ae754eee8b4ba89979dacc0a059a902c6b24223aa5a3f601fa6a0ea6c9535603d14157da1957b8df7754cacd179c7d016e
+  data.tar.gz: 82013e50a32a6170d0d1cdf73dfb9fdbf9290dfed86ecf905b3e6b9bf9bf53c035e4857cf690ebfbc71e50ac1e172028d5e9f17ebdd0cb67f7c93df5f4acc8b9

data/.gitignore

@@ -0,0 +1,11 @@
+/.idea/
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Gerrit Visscher
+
+MIT License
+
+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/README.md

@@ -0,0 +1,74 @@
+# Fulmar Shell
+
+This service takes a directory and a hostname (which might be 'localhost'). It then runs all commands given
+in the given directory on that machine. You can access the return values and the output on both stdout and stderr.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fulmar-shell', :git => 'https://github.com/CORE4/fulmar-shell.git'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ git clone https://github.com/CORE4/fulmar-shell.git
+    $ cd fulmar-shell
+    $ gem build fulmar-shell.gemspec
+    $ gem install fulmar-shell-#.#.#.gem
+
+## Usage
+
+You can test the shell in irb:
+
+    $ irb -r fulmar-shell
+
+And get a new shell object with
+
+    irb(main):001:0> shell = Fulmar::Shell.new '.'
+
+Shell.new takes two parameters: a directory (this is mandatory) and a hostname which is configured for
+access via ssh with key authentication (i.e. does not require a password). You can supply a username with
+'my-user@my-host'.
+All commands will be executed in the given directory, which is the current directory in the example above.
+
+    irb(main):002:0> shell.run 'echo Hello World'
+
+This will run echo and return true/false depending on the return code of the command. Currently, you cannot
+access the return code directly. You can, however, get the output of the last command(s):
+
+    irb(main):003:0> shell.last_output
+    => ["Hello World"]
+
+And of course the last error messages:
+
+    irb(main):004:0> shell.run 'echo Hello World 1>&2'
+    Hello World
+    => true
+    irb(main):005:0> shell.last_error
+    => ["Hello World"]
+
+If you want to run multiple commands, you can supply them as an array. This is especially recommended if
+you work on a remote shell since it will only connect once and chain all commands (with an "&&", so the first
+failure will stop the execution of the list).
+
+    irb(main):006:0> shell.run ['echo foo', 'echo bar', 'test -f non_existing_file', 'echo Hidden']
+    => false
+    irb(main):007:0> shell.last_output
+    => ["foo", "bar"]
+
+You can see that it stopped after the third command. You get the output of all commands before that.
+
+If you activate the debug output, you can see which commands are executed:
+
+    irb(main):008:0> shell.run ["echo 'in single quotes'", "echo \"in double quotes\""]
+    sh -c 'cd . && echo '\''in single quotes'\'' && echo "in double quotes"'
+    => true
+
+The commands will always be run in /bin/sh. Single quotes will be escaped and if you run this on a remote shell,
+it will escape them twice which might look weird. :)

data/fulmar-shell.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fulmar/shell'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fulmar-shell'
+  spec.version       = Fulmar::Shell::VERSION
+  spec.authors       = ['Gerrit Visscher']
+  spec.email         = ['g.visscher@core4.de']
+
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = 'TODO: Set to \'http://mygemserver.com\' to prevent pushes to rubygems.org, or delete to allow pushes to any server.'
+  # end
+
+  spec.summary       = 'Small service to run shell commands on a local or remote shell'
+  spec.description   = 'This service takes a directory and a hostname (which might be \'localhost\'). It then runs all commands given in the given directory on that machine.'
+  spec.homepage      = 'https://github.com/CORE4/fulmar-shell'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(/^(test|spec|features)\//) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/fulmar/shell.rb

@@ -0,0 +1,64 @@
+require 'open3'
+
+# This shell is part of the fulmar deployment tools
+# it can be used stand-alone, though
+module Fulmar
+  # Implements simple access to shell commands
+  class Shell
+    VERSION = '1.1.2'
+
+    attr_accessor :debug, :last_output, :last_error, :quiet
+
+    def initialize(path, host = 'localhost')
+      @path = (path.nil? || path.empty?) ? '.' : path
+      @host = host
+      @last_output = []
+      @last_error = []
+      @debug = false
+      @quiet = false
+    end
+
+    def run(command)
+      command = [command] if command.class == String
+
+      command.unshift "cd #{@path}"
+
+      if local?
+        execute("sh -c '#{escape_for_sh(command.join(' && '))}'")
+      else
+        remote_command = escape_for_sh('/bin/sh -c \'' + escape_for_sh(command.join(' && ')) + '\'')
+        execute("ssh #{@host} '#{remote_command}'")
+      end
+    end
+
+    def local?
+      @host == 'localhost'
+    end
+
+    protected
+
+    # Run the command and capture the output
+    def execute(command)
+      # DEBUG, baby!
+      puts command if @debug
+
+      stdin, stdout, stderr, wait_thr = Open3.popen3(command)
+
+      # Remove annoying newlines at the end
+      @last_output = stdout.readlines.collect(&:chomp)
+      @last_error = stderr.readlines.collect(&:chomp)
+
+      stdin.close
+      stdout.close
+      stderr.close
+
+      @last_error.each { |line| puts line } unless @quiet
+
+      wait_thr.value == 0
+    end
+
+    def escape_for_sh(text)
+      text.gsub('\\', '\\\\').gsub("'", "'\\\\''")
+    end
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: fulmar-shell
+version: !ruby/object:Gem::Version
+  version: 1.1.2
+platform: ruby
+authors:
+- Gerrit Visscher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: This service takes a directory and a hostname (which might be 'localhost').
+  It then runs all commands given in the given directory on that machine.
+email:
+- g.visscher@core4.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- fulmar-shell.gemspec
+- lib/fulmar/shell.rb
+homepage: https://github.com/CORE4/fulmar-shell
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Small service to run shell commands on a local or remote shell
+test_files: []