edict 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9da327f1e5a1f5bd1537f2eaa220ebb072384156
+  data.tar.gz: 138b96d579ef6e788d0b11e3881f369fecc5bf3a
+SHA512:
+  metadata.gz: e571ab563934cad2d347b74159f77b625c990d927ea82c6a18650e5a1a4c4492187126027a297fadea5c50eea9ff6a78d6dd5779e915296a967a96bde749e62f
+  data.tar.gz: 7d2cb031265b90026a37161d57c97893bc900489f79abfd660676678b65674c017b619f0e952968357c5bc349dfd4aebd24f49072d3ded32ebf5583dde13f18a

data/lib/edict.rb

@@ -0,0 +1,6 @@
+require 'edict/rule'
+require 'edict/command'
+require 'edict/ssh-command'
+
+module Edict
+end

data/lib/edict/command.rb

@@ -0,0 +1,50 @@
+begin
+  require 'caliph'
+  require 'edict/rule'
+
+  module Edict
+    class Command < Rule
+      include Caliph::CommandLineDSL
+
+      setting :caliph_shell
+      setting :env_hash, {}
+      setting :command
+
+      def self.shell
+        @shell ||= Caliph.new
+      end
+
+      def setup
+        self.caliph_shell = Edict::Command.shell if field_unset?(:caliph_shell)
+      end
+
+      def build_command
+        cmd(*command)
+      end
+
+      def add_env(command)
+        env_hash.each_pair do |name, value|
+          command.set_env(name, value)
+        end
+        command
+      end
+
+      def run_command(command)
+        caliph_shell.run(command)
+      end
+
+      def check_result(result)
+        result.must_succeed!
+      end
+
+      def action
+        to_run = build_command
+        to_run = add_env(to_run)
+        result = run_command(to_run)
+        check_result(result)
+      end
+    end
+  end
+rescue LoadError
+  # no-op - we don't have Caliph
+end

data/lib/edict/rule.rb

@@ -0,0 +1,25 @@
+require 'calibrate'
+
+module Edict
+  class Rule
+    include Calibrate::Configurable
+    include Calibrate::Configurable::DirectoryStructure
+
+    def initialize
+      setup_defaults
+      yield self
+      setup
+    end
+
+    def setup
+    end
+
+    def enact
+      check_required # from Calibrate
+      action
+    end
+
+    def action
+    end
+  end
+end

data/lib/edict/ssh-command.rb

@@ -0,0 +1,49 @@
+
+begin
+  require 'caliph'
+  require 'edict/command'
+
+  module Edict
+    class SSHCommand < Command
+      setting(:remote_server, nested{
+        setting :address
+        setting :port, 22
+        setting :user, nil
+      })
+
+      setting(:ssh_options, [])
+      setting(:verbose, 0)
+      nil_fields(:id_file, :free_arguments)
+
+      def ssh_option(name, value)
+        ssh_options << "\"#{name}=#{value}\""
+      end
+
+      def wrap_ssh_around(command_on_remote)
+        raise "Empty remote command" if command_on_remote.nil?
+        cmd("ssh") do |cmd|
+          cmd.options << "-i #{id_file}" if id_file
+          cmd.options << "-l #{remote_server.user}" unless remote_server.user.nil?
+          cmd.options << remote_server.address
+          cmd.options << "-p #{remote_server.port}" #ok
+          cmd.options << "-n"
+          cmd.options << "-#{'v'*verbose}" if verbose > 0
+          unless ssh_options.empty?
+            ssh_options.each do |opt|
+              cmd.options << "-o #{opt}"
+            end
+          end
+          cmd - escaped_command(command_on_remote)
+        end
+      end
+
+      def run_command(command)
+        fail "Need remote server for #{self.class.name}" unless remote_server.address
+
+        super(wrap_ssh_around(command))
+      end
+    end
+  end
+rescue LoadError
+  # no Caliph...
+end

data/spec/edict/command_spec.rb

@@ -0,0 +1,37 @@
+require 'edict/command'
+
+describe Edict::Command do
+
+  let :mock_shell do
+    instance_double(Caliph::Shell)
+  end
+
+  let :test_line do
+    %w[a test command]
+  end
+
+  let :command_line do
+    instance_double(Caliph::CommandLine)
+  end
+
+  let :result do
+    instance_double(Caliph::CommandRunResult)
+  end
+
+  subject :command do
+    Edict::Command.new do |test|
+      test.env_hash = {:something => :else}
+      test.command = test_line
+      test.caliph_shell = mock_shell
+    end
+  end
+
+  it "should run the command and check output" do
+    allow(command).to receive(:cmd).with(*test_line).and_return(command_line)
+    expect(command_line).to receive(:set_env).with(:something, :else)
+    allow(mock_shell).to receive(:run).with(command_line).and_return(result)
+    expect(result).to receive(:must_succeed!)
+
+    command.enact
+  end
+end

data/spec/edict/ssh-command_spec.rb

@@ -0,0 +1,56 @@
+require 'edict'
+
+describe Edict::SSHCommand do
+
+  let :mock_shell do
+    instance_double(Caliph::Shell)
+  end
+
+  let :test_line do
+    %w[a test command]
+  end
+
+  let :command_line do
+    instance_double(Caliph::CommandLine, "remote command")
+  end
+
+  let :ssh_command_line do
+    instance_double(Caliph::CommandLine, "ssh command")
+  end
+
+  let :ssh_options do
+    []
+  end
+
+  let :result do
+    instance_double(Caliph::CommandRunResult)
+  end
+
+  let :server_address do
+    "123.45.67.89"
+  end
+
+  subject :command do
+    Edict::SSHCommand.new do |test|
+      test.env_hash = {:something => :else}
+      test.command = test_line
+      test.caliph_shell = mock_shell
+      test.remote_server.address = server_address
+    end
+  end
+
+  it "should run the command and check output" do
+    allow(command).to receive(:cmd).with(*test_line).and_return(command_line)
+    allow(command).to receive(:cmd).with("ssh").and_yield(ssh_command_line).and_return(ssh_command_line)
+    allow(ssh_command_line).to receive(:options).and_return(ssh_options)
+    allow(command).to receive(:escaped_command).and_return(command_line)
+    expect(ssh_command_line).to receive(:-).with(command_line)
+
+    expect(command_line).to receive(:set_env).with(:something, :else)
+
+    allow(mock_shell).to receive(:run).with(ssh_command_line).and_return(result)
+    expect(result).to receive(:must_succeed!)
+
+    command.enact
+  end
+end

data/spec_help/gem_test_suite.rb

@@ -0,0 +1,17 @@
+puts Dir::pwd
+require 'test/unit'
+begin
+  require 'spec'
+rescue LoadError
+  false
+end
+
+class RSpecTest < Test::Unit::TestCase
+  def test_that_rspec_is_available
+    assert_nothing_raised("\n\n *  RSpec isn't available - please run: gem install rspec  *\n\n"){ ::Spec }
+  end
+
+  def test_that_specs_pass
+    assert(system(*%w{spec -f e -p **/*.rb spec}),"\n\n *  Specs failed  *\n\n")
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: edict
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Judson Lester
+- Patricia Ho
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: calibrate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      Simple configurable tasks to make things do other things as a rule.
+email:
+- judson@lrdesign.com
+- patricia@lrdesign.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/edict.rb
+- lib/edict/command.rb
+- lib/edict/rule.rb
+- lib/edict/ssh-command.rb
+- spec/edict/command_spec.rb
+- spec/edict/ssh-command_spec.rb
+- spec_help/gem_test_suite.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--inline-source"
+- "--main"
+- doc/README
+- "--title"
+- edict-0.0.1 Documentation
+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: edict
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Simple configurable tasks
+test_files:
+- spec_help/gem_test_suite.rb