marhan_cli 0.0.9 → 0.0.11

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Changelog.md

@@ -35,4 +35,13 @@
 
 ## v0.0.9
 
-* Name (configuration key) of device as parameter of unmount command. (command => crypt:unmount)
+* Name (configuration key) of device as parameter of unmount command. (command => crypt:unmount)
+
+## v0.0.10
+
+* Refactorings for cleaner code.
+
+## v0.0.11
+
+* First RSpec tests and guard added for TDD development.
+* VirtualBox command for start and stop virtual guest systems added. (command => vbox:[start|stop])

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec' do
+  watch(%r{^spec/(.+)\.rb$})
+  watch(%r{^lib/(.+)\.rb$})
+end
+

data/README.md

@@ -28,6 +28,11 @@ Configuration file `~/.marhan_cli.yml` is used for several commands
       mount_folder: /Volumes
       encrypted_devices:
         enc1: /dev/rdisk1s2
+        hdd: /dev/rdisk2s2
+    vbox:
+      guests:
+        linux: Linux
+        windows: Windows XP
 
 ## Contributing
 

data/lib/marhan_cli/app/virtual_box_app.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+require 'marhan_cli/helper/constraint'
+
+module MarhanCli
+  class VirtualBoxApp
+
+    attr_reader :guests
+
+    def initialize(guests)
+      @guests = guests
+    end
+
+    def start_guest(guest_config_name)
+      "VBoxManage startvm '#{vbox_name(guest_config_name)}'"
+    end
+
+    def stop_guest(guest_config_name)
+      "VBoxManage controlvm '#{vbox_name(guest_config_name)}' poweroff"
+    end
+
+    def vbox_name(guest_config_name)
+      Constraint.not_nil_or_empty! guest_config_name, "Guest config name have to be set!"
+      vbox_name = @guests[guest_config_name]
+      Constraint.not_nil_or_empty! vbox_name, "No guest with key '#{guest_config_name}' found in configuration"
+      vbox_name
+    end
+  end
+end

data/lib/marhan_cli/command.rb

@@ -10,6 +10,19 @@ module MarhanCli
 
     CONFIG_FILE = ".marhan_cli.yml"
 
+    def execute(proc)
+      begin
+        say ""
+        say "Starting command...", :green
+        say ""
+        proc.call
+        say ""
+        say "End of command", :green
+      rescue Exception => e
+        exit_with_error(e)
+      end
+    end
+
     def exit_with_error(message)
       say message, :red
       exit(1)
@@ -20,7 +33,6 @@ module MarhanCli
       unless File.exists?(config_file_path)
         raise "Stop processing! Command needs the configuration file '#{CONFIG_FILE}' in you're home directory."
       end
-      #say "I will use the '#{CONFIG_FILE}' configuration file in you're home directory.", :cyan
       config = Ambience.create(config_file_path)
       config.to_mash
     end

data/lib/marhan_cli/commands/true_crypt.rb

@@ -15,15 +15,7 @@ module MarhanCli
                   :desc => "Name of device in configuration file."
 
     def mount
-      begin
-        config = load_crypt_config
-        true_crypt = TrueCryptApp.new(config.mount_folder)
-        device = get_or_ask(:device)
-        run true_crypt.mount_command(config.encrypted_devices[device], device)
-        say "finished", :green
-      rescue Exception => e
-        exit_with_error(e)
-      end
+      execute mount_proc
     end
 
     desc "crypt:umount", "Unmounts encrypted disk with TrueCrypt"
@@ -34,31 +26,42 @@ module MarhanCli
                   :desc => "Name of device in configuration file."
 
     def umount
-      begin
+      execute unmount_proc
+    end
+
+    desc "crypt:umount_all", "Unmounts all encrypted disk with TrueCrypt"
+
+    def umount_all
+      execute unmount_all_proc
+    end
+
+    private
+
+    def mount_proc
+      Proc.new do
         config = load_crypt_config
         true_crypt = TrueCryptApp.new(config.mount_folder)
         device = get_or_ask(:device)
-        run true_crypt.unmount_command(device)
-        say "finished", :green
-      rescue Exception => e
-        exit_with_error(e)
+        run true_crypt.mount_command(config.encrypted_devices[device], device)
       end
     end
 
-    desc "crypt:umount_all", "Unmounts all encrypted disk with TrueCrypt"
+    def unmount_proc
+      Proc.new do
+        config = load_crypt_config
+        true_crypt = TrueCryptApp.new(config.mount_folder)
+        device = get_or_ask(:device)
+        run true_crypt.unmount_command(device)
+      end
+    end
 
-    def umount_all
-      begin
+    def unmount_all_proc
+      Proc.new do
         true_crypt = TrueCryptApp.new
         run true_crypt.unmount_all_command
-        say "finished", :green
-      rescue Exception => e
-        exit_with_error(e)
       end
     end
 
-    protected
-
     def load_crypt_config
       load_config.crypt
     end

data/lib/marhan_cli/commands/vbox.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+require 'marhan_cli/command'
+require 'marhan_cli/app/virtual_box_app'
+
+module MarhanCli
+  class VBox < MarhanCli::Command
+
+    namespace :vbox
+
+    desc "vbox:start", "Starts VirtualBox guest system"
+
+    method_option :guest,
+                  :type => :string,
+                  :aliases => "-g",
+                  :desc => "Name of the guest system in configuration file."
+
+    def start
+      execute start_guest
+    end
+
+    desc "vbox:stop", "Stops VirtualBox guest system"
+
+    method_option :guest,
+                  :type => :string,
+                  :aliases => "-g",
+                  :desc => "Name of the guest system in configuration file."
+
+    def stop
+      execute stop_guest
+    end
+
+    private
+
+    def start_guest
+      Proc.new do
+        config = load_vbox_config
+        virtual_box = VirtualBoxApp.new(config.guests)
+        guest_to_start = get_or_ask(:guest)
+        run virtual_box.start_guest(guest_to_start)
+      end
+    end
+
+    def stop_guest
+      Proc.new do
+        config = load_vbox_config
+        virtual_box = VirtualBoxApp.new(config.guests)
+        guest_to_start = get_or_ask(:guest)
+        run virtual_box.stop_guest(guest_to_start)
+      end
+    end
+
+    def load_vbox_config
+      load_config.vbox
+    end
+
+  end
+end

data/lib/marhan_cli/commands/web.rb

@@ -7,13 +7,21 @@ module MarhanCli
 
     namespace :web
 
-    desc "web:my-ip", "Gives out the external IP from the world wide web"
+    desc "web:myip", "Gives out the external IP from the world wide web"
 
-    def my_ip
-      uri = URI('http://checkip.dyndns.org')
-      response = Net::HTTP.get(uri)
-      ip_address = /[0-9\.]+/.match(response)
-      say("Your public IP is: #{ip_address}", :blue)
+    def myip
+      execute my_ip_proc()
+    end
+
+    private
+
+    def my_ip_proc
+      Proc.new do
+        uri = URI('http://checkip.dyndns.org')
+        response = Net::HTTP.get(uri)
+        ip_address = /[0-9\.]+/.match(response)
+        say("Your public IP is: #{ip_address}", :cyan)
+      end
     end
 
   end

data/lib/marhan_cli/helper/constraint.rb

@@ -1,9 +1,15 @@
 module MarhanCli
   class Constraint
 
-    def self.notNil!(argument, argument_name)
+    def self.not_nil!(argument, argument_name)
       raise ArgumentError, "Given argument '#{argument_name}' must not be nil" if argument.nil?
     end
 
+    def self.not_nil_or_empty!(argument, message)
+      if argument.nil? or argument.empty?
+        raise ArgumentError, message
+      end
+    end
+
   end
 end

data/lib/marhan_cli/network/remote_machine.rb

@@ -5,16 +5,16 @@ module MarhanCli
   class RemoteMachine
 
     def initialize(host, port)
-      Constraint.notNil!(host, "host")
-      Constraint.notNil!(port, "port")
+      Constraint.not_nil!(host, "host")
+      Constraint.not_nil!(port, "port")
       @host = host
       @port = port
     end
 
     def add_id_to_authorized_keys(user, password, id_file)
-      Constraint.notNil!(user, "user")
-      Constraint.notNil!(password, "password")
-      Constraint.notNil!(id_file, "id_file")
+      Constraint.not_nil!(user, "user")
+      Constraint.not_nil!(password, "password")
+      Constraint.not_nil!(id_file, "id_file")
 
       id_pub_content = File.read File.expand_path(id_file)
       id_pub_content = id_pub_content.chomp

data/lib/marhan_cli/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module MarhanCli
-  VERSION = "0.0.9"
+  VERSION = "0.0.11"
 end

data/marhan_cli.gemspec

@@ -20,4 +20,10 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency('thor')
   gem.add_runtime_dependency('net-ssh', '~> 2.6.1')
   gem.add_runtime_dependency('ambience', '~> 2.0.0')
+
+  gem.add_development_dependency('rspec', '~> 2.12.0')
+  gem.add_development_dependency('guard', '~> 1.5.4')
+  gem.add_development_dependency('guard-rspec', '~> 2.3.1')
+  gem.add_development_dependency('rb-fsevent', '~> 0.9.1')
+
 end

data/spec/marhan_cli/app/virtual_box_app_spec.rb

@@ -0,0 +1,78 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'marhan_cli/app/virtual_box_app'
+
+describe "VirtualBoxApp" do
+
+  let(:config_param) { Hashie::Mash.new(:linux => 'Ubuntu Linux') }
+
+  context ".new" do
+    describe "with empty hash as argument" do
+      let(:subject) { MarhanCli::VirtualBoxApp.new({}) }
+      it "creates a new objects" do
+        subject.should be_a(MarhanCli::VirtualBoxApp)
+      end
+    end
+
+    describe "with config hash as argument" do
+      let(:subject) { MarhanCli::VirtualBoxApp.new(config_param) }
+
+      it "has set config hash" do
+        subject.guests.should eq(config_param)
+      end
+    end
+  end
+
+  context ".start_guest" do
+    let(:subject) { MarhanCli::VirtualBoxApp.new(config_param) }
+
+    describe "with configured guest as argument" do
+      it "returns correct command" do
+        subject.start_guest('linux').should eq("VBoxManage startvm 'Ubuntu Linux'")
+      end
+    end
+
+  end
+
+  context ".vbox_name" do
+    let(:subject) { MarhanCli::VirtualBoxApp.new(config_param) }
+
+    describe "with configured guest as argument" do
+      it "returns correct command" do
+        subject.vbox_name('linux').should eq('Ubuntu Linux')
+      end
+    end
+
+    describe "with not configured guest as argument" do
+      it "raise error" do
+        expect {
+          subject.vbox_name('minix')
+        }.to raise_error(
+                 error=ArgumentError,
+                 message="No guest with key 'minix' found in configuration")
+      end
+    end
+
+    describe "with empty guest as argument" do
+      it "raise error" do
+        expect {
+          subject.vbox_name('')
+        }.to raise_error(
+                 error=ArgumentError,
+                 message="Guest config name have to be set!")
+      end
+    end
+  end
+
+  context ".stop_guest" do
+
+    let(:subject) { MarhanCli::VirtualBoxApp.new(config_param) }
+
+    describe "with configured guest as argument" do
+      it "returns correct command" do
+        subject.stop_guest('linux').should eq("VBoxManage controlvm 'Ubuntu Linux' poweroff")
+      end
+    end
+  end
+
+end

data/spec/marhan_cli/helper/constraint_spec.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'marhan_cli/helper/constraint'
+
+describe "Constraint" do
+
+  context ".not_nil!" do
+    describe "with nil as argument" do
+      it "throws exception" do
+        expect { MarhanCli::Constraint.not_nil!(nil, "") }.to raise_error
+      end
+    end
+
+    describe "with valid string as argument" do
+      it "throws exception" do
+        expect { MarhanCli::Constraint.not_nil!("any_string", "any_string") }.to_not raise_error
+      end
+    end
+  end
+
+  context ".not_nil_or_empty!" do
+    describe "with nil as argument" do
+      it "throws exception" do
+        expect { MarhanCli::Constraint.not_nil_or_empty!(nil, "") }.to raise_error
+      end
+    end
+    describe "with empty string as argument" do
+      it "throws exception" do
+        expect { MarhanCli::Constraint.not_nil_or_empty!("", "") }.to raise_error
+      end
+    end
+
+    describe "with valid string as argument" do
+      it "throws no exception" do
+        expect { MarhanCli::Constraint.not_nil!("any_string", "any_string") }.to_not raise_error
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'hashie'
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: marhan_cli
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.11
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-03 00:00:00.000000000 Z
+date: 2012-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -59,6 +59,70 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.4
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
 description: 
 email: me@markushanses.de
 executables:
@@ -67,24 +131,31 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - .rvmrc
 - Changelog.md
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/mcli
 - lib/marhan_cli.rb
 - lib/marhan_cli/app/true_crypt_app.rb
+- lib/marhan_cli/app/virtual_box_app.rb
 - lib/marhan_cli/command.rb
 - lib/marhan_cli/commands/network.rb
 - lib/marhan_cli/commands/true_crypt.rb
+- lib/marhan_cli/commands/vbox.rb
 - lib/marhan_cli/commands/web.rb
 - lib/marhan_cli/helper/constraint.rb
 - lib/marhan_cli/network/errors.rb
 - lib/marhan_cli/network/remote_machine.rb
 - lib/marhan_cli/version.rb
 - marhan_cli.gemspec
+- spec/marhan_cli/app/virtual_box_app_spec.rb
+- spec/marhan_cli/helper/constraint_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/marhan/marhan_cli
 licenses: []
 post_install_message: 
@@ -109,4 +180,7 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Helper routines for my computers
-test_files: []
+test_files:
+- spec/marhan_cli/app/virtual_box_app_spec.rb
+- spec/marhan_cli/helper/constraint_spec.rb
+- spec/spec_helper.rb