squidward 0.5 → 0.6

data/lib/squidward/command.rb

@@ -1,3 +1,4 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'commands/base'
+require 'commands/secured'
 Dir["#{File.dirname(__FILE__)}/commands/*"].each { |c| require c }

data/lib/squidward/commands/base.rb

@@ -3,53 +3,7 @@ module Squidward
     # Base command from where all the other commands inherit
     # it contains the most used methods (stout, sterror, etc) and 
     # also handles the configuration, hence AWS credentials
-    class Base
-      # Creates a new instance and prompts the user for the 
-      # credentials if they aren't stored
-      def initialize()
-        unless (@credentials = read_credentials)
-          @credentials = ask_for_credentials
-          store_credentials(@credentials)
-        end
-      end
-      
-      # Gets the AWS Credentials from the user
-      def ask_for_credentials
-        puts "Enter your AWS credentials."
-
-        print "Access Key ID: "
-        user = ask
-
-        print "Secret Access Key: "
-        password = ask_for_password
-
-        return [user, password]
-      end
-      
-      # Turns off the standard output while writting the password
-      def echo_off
-        system "stty -echo"
-      end
-      
-      # Turns on the standard output after writting the password
-      def echo_on
-        system "stty echo"
-      end
-      
-      # Gets trimmed input from the user
-      def ask
-        gets.strip
-      end
-
-      # Gets trimmed input from the user but with echoing off
-      def ask_for_password
-        echo_off
-        password = ask
-        puts
-        echo_on
-        return password
-      end
-      
+    class Base            
       # Reads the configuration from the profile, if the reload parameter is set to true, it will 
       # read it again, if not it will just return what it's already in-memory.
       def configuration(reload = false)
@@ -61,13 +15,6 @@ module Squidward
         @configuration = YAML.load_file(path)
       end
       
-      # Reads credentials from the configuration file
-      def read_credentials
-        conf = self.configuration
-        return nil unless conf[:credentials]
-        return [conf[:credentials][:access_key], conf[:credentials][:secret_key]]
-      end
-
       # Dumps configuration file contents to the user profile
       def store_configuration(new_configuration)
         FileUtils.mkpath(File.expand_path(CONF_PATH))
@@ -76,14 +23,6 @@ module Squidward
         end
       end
       
-      # Stores the users credentials on the configuration.
-      def store_credentials(credentials)
-        conf = configuration
-        conf[:credentials] = {}
-        conf[:credentials][:access_key], conf[:credentials][:secret_key] = credentials[0], credentials[1]
-        store_configuration(conf)
-      end
-      
       # Nice and clean way of echoing
       def display(msg, newline=true)
         if newline

data/lib/squidward/commands/bucket.rb

@@ -1,7 +1,7 @@
 module Squidward
   module Command
     # Handles all the command related to AWS S3's buckets
-    class Bucket < Base
+    class Bucket < Secured
       # Sets the destination bucket for the backups to be uploaded on S3
       def set(args)
         new_configuration = configuration

data/lib/squidward/commands/credentials.rb

@@ -1,13 +1,18 @@
 module Squidward
   module Command
     # Handles all the commands related to credentials
-    class Credentials < Base
+    class Credentials < Secured
       # Removes the stored credentials from the current configuration
       def clear(args = nil)
         new_configuration = configuration
         new_configuration[:credentials] = nil
         store_configuration(new_configuration)
       end
+      
+      # Stores the credentials to the current configuration
+      def set(args = nil)
+        # don't do anything, already handles it the parent class
+      end
     end
   end
 end

data/lib/squidward/commands/domain.rb

@@ -1,7 +1,7 @@
 module Squidward
   module Command
     # Handles everything related to AWS SimpleDB Domains for Backup
-    class Domain < Base
+    class Domain < Secured
       # Configures a SimpleDB domain for backup. When given the second parameter is 
       # the virtual path inside the bucket to be stored.
       def backup(args)

data/lib/squidward/commands/info.rb

@@ -4,6 +4,11 @@ module Squidward
     class Info < Base
       # Goes thru the settings and echos their values.
       def index(args = nil)
+        return show_info if (read_credentials)
+        puts("Not yet configured. Run 'squidward credentials:set' for configuring credentials.")
+      end
+      
+      def show_info
         display("=== Current Settings")
         display("Amazon Web Services Account:  #{configuration[:credentials][:access_key]}")
         display("Amazon S3 Bucket:             #{configuration[:default_bucket]}")
@@ -21,6 +26,13 @@ module Squidward
         end
         display("")
       end
+      
+      # Reads credentials from the configuration file
+      def read_credentials
+        conf = self.configuration
+        return nil unless conf[:credentials]
+        return [conf[:credentials][:access_key], conf[:credentials][:secret_key]]
+      end
     end
   end
 end

data/lib/squidward/commands/run.rb

@@ -1,7 +1,7 @@
 module Squidward
   module Command
     # Core class of the whole application. It simply runs everything once it has been configured.
-    class Run < Base
+    class Run < Secured
       def initialize()
         super
         aws_config = {}

data/lib/squidward/commands/secured.rb

@@ -0,0 +1,68 @@
+module Squidward
+  module Command
+    # Base command from where all the commands 
+    # are secured and need credentials, hence it handles AWS credentials
+    class Secured < Base
+      # Creates a new instance and prompts the user for the 
+      # credentials if they aren't stored
+      def initialize()
+        unless (@credentials = read_credentials)
+          @credentials = ask_for_credentials
+          store_credentials(@credentials)
+        end
+      end
+      
+      # Gets the AWS Credentials from the user
+      def ask_for_credentials
+        puts "Enter your AWS credentials."
+
+        print "Access Key ID: "
+        user = ask
+
+        print "Secret Access Key: "
+        password = ask_for_password
+
+        return [user, password]
+      end
+      
+      # Turns off the standard output while writting the password
+      def echo_off
+        system "stty -echo"
+      end
+      
+      # Turns on the standard output after writting the password
+      def echo_on
+        system "stty echo"
+      end
+      
+      # Gets trimmed input from the user
+      def ask
+        gets.strip
+      end
+
+      # Gets trimmed input from the user but with echoing off
+      def ask_for_password
+        echo_off
+        password = ask
+        puts
+        echo_on
+        return password
+      end
+            
+      # Reads credentials from the configuration file
+      def read_credentials
+        conf = self.configuration
+        return nil unless conf[:credentials]
+        return [conf[:credentials][:access_key], conf[:credentials][:secret_key]]
+      end
+      
+      # Stores the users credentials on the configuration.
+      def store_credentials(credentials)
+        conf = configuration
+        conf[:credentials] = {}
+        conf[:credentials][:access_key], conf[:credentials][:secret_key] = credentials[0], credentials[1]
+        store_configuration(conf)
+      end
+    end
+  end
+end

data/lib/squidward/commands/version.rb

@@ -2,7 +2,7 @@ module Squidward
   module Command
     # Gem Versioning Helper and also displays current version to the user
     class Version < Base
-      GEM_VERSION = "0.5"
+      GEM_VERSION = "0.6"
       
       # Displays current gem version to the user
       def index(args = nil)

data/rakefile

@@ -19,6 +19,16 @@ task :specs do
   Rake::Task['specs_run'].invoke
 end
 
+namespace :docs do
+  Rake::RDocTask.new do |t|
+  	t.rdoc_dir = 'sdk/public/'
+  	t.options << '--line-numbers' << '--inline-source' << '-A cattr_accessor=object'
+  	t.options << '--charset' << 'utf-8'
+  	t.rdoc_files.include('README.rdoc')
+  	t.rdoc_files.include('lib/**/*.rb')
+  end
+end
+
 namespace :dist do  
   spec = Gem::Specification.new do |s|
     s.name              = 'squidward'
@@ -48,4 +58,9 @@ namespace :dist do
   Rake::GemPackageTask.new(spec) do |pkg|
     pkg.need_tar = true
   end
+end
+
+task :cleanup do 
+  `rm -rf pkg`
+  `rm -rf coverage`
 end

data/spec/commands/base_test.rb

@@ -4,36 +4,7 @@ require 'spec_config'
 
 describe "base commands functionality" do
   
-  it "should prompt for AWS Credentials when they do not exist" do
-    Squidward::Command::Base.any_instance.expects(:read_credentials).returns(false)
-    Squidward::Command::Base.any_instance.expects(:ask_for_credentials).returns(["access_key", "secret_key"])
-    Squidward::Command::Base.any_instance.expects(:store_credentials).with(["access_key", "secret_key"])
-    my_command = Squidward::Command::Base.new()
-  end
-  
-  it "should ask for credentials" do
-    Squidward::Command::Base.any_instance.expects(:read_credentials).returns(true)
-    my_command = Squidward::Command::Base.new()
-    my_command.expects(:puts).with("Enter your AWS credentials.")
-    my_command.expects(:print).with("Access Key ID: ")
-    my_command.expects(:print).with("Secret Access Key: ")
-    my_command.expects(:ask).returns("user")
-    my_command.expects(:ask_for_password).returns("password")
-    my_command.ask_for_credentials.should == ["user", "password"]
-  end
-  
-  it "when asking for password should turn off echo and turn it on" do
-    Squidward::Command::Base.any_instance.expects(:read_credentials).returns(true)
-    my_command = Squidward::Command::Base.new()
-    my_command.expects(:echo_off)
-    my_command.expects(:echo_on)
-    my_command.expects(:puts)
-    my_command.expects(:ask).returns("password")
-    my_command.ask_for_password.should == "password"
-  end
-  
   it "should read the configuration when its prompted for config (no relaod)" do
-    Squidward::Command::Base.any_instance.expects(:read_credentials).returns(true)
     configuration_path = File.expand_path(File.join(CONF_PATH, SETTINGS_FILE))
     File.expects(:exists?).with(configuration_path).returns(true)
     YAML::expects(:load_file).with(configuration_path)
@@ -42,7 +13,6 @@ describe "base commands functionality" do
   end
   
   it "should return the existing configuration when its prompted for config (no relaod)" do
-    Squidward::Command::Base.any_instance.expects(:read_credentials).returns(true)
     configuration_path = File.expand_path(File.join(CONF_PATH, SETTINGS_FILE))
     File.expects(:exists?).with(configuration_path).returns(true)
     YAML::expects(:load_file).with(configuration_path).returns({:key => "value"})
@@ -53,24 +23,9 @@ describe "base commands functionality" do
   end
   
   it "should store configuration" do
-    Squidward::Command::Base.any_instance.expects(:read_credentials).returns(true)
     File.expects(:open).with(File.expand_path(File.join(CONF_PATH, SETTINGS_FILE)), "w+")
     FileUtils.expects(:mkpath).with(File.expand_path(CONF_PATH))
     my_command = Squidward::Command::Base.new()
     my_command.store_configuration({})
   end
-  
-  it "should read credentials when already there" do
-    Squidward::Command::Base.any_instance.expects(:configuration).returns({:credentials => {:secret_key => "secret", :access_key => "access"}}).twice
-    my_command = Squidward::Command::Base.new()
-    my_command.read_credentials.should == ["access", "secret"]
-  end 
-  
-  it "should store credentials after getting them" do
-    Squidward::Command::Base.any_instance.expects(:read_credentials).returns(false)
-    Squidward::Command::Base.any_instance.expects(:ask_for_credentials).returns(["access_key", "secret_key"])
-    Squidward::Command::Base.any_instance.expects(:configuration).returns({:credentials => {}})
-    Squidward::Command::Base.any_instance.expects(:store_configuration).returns()
-    my_command = Squidward::Command::Base.new()
-  end
 end

data/spec/commands/bucket_test.rb

@@ -2,7 +2,7 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__) + '/../')
 require 'spec_config'
 
-describe "runner command functionality" do
+describe "bucket command functionality" do
   before do 
     Squidward::Command::Bucket.any_instance.expects(:read_credentials).returns(["access_key", "secret_key"])
   end

data/spec/commands/credentials_test.rb

@@ -2,11 +2,20 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__) + '/../')
 require 'spec_config'
 
-describe "runner command functionality" do
+describe "credentials command functionality" do
   it "should clear the stored credentials" do
     my_command = Squidward::Command::Credentials.new()
     my_command.expects(:configuration).returns({:credentials => ["foo", "bar"]})
     my_command.expects(:store_configuration).with({:credentials => nil})
     my_command.clear
   end
+  
+  it "should store credentials" do
+    Squidward::Command::Credentials.any_instance.expects(:read_credentials).returns(false)
+    Squidward::Command::Credentials.any_instance.expects(:ask_for_credentials).returns({:credentials => ["foo", "bar"]})
+    Squidward::Command::Credentials.any_instance.expects(:store_credentials).returns(true)
+
+    my_command = Squidward::Command::Credentials.new()
+    my_command.set
+  end
 end

data/spec/commands/info_test.rb

@@ -0,0 +1,13 @@
+# enabling the load of files from root (on RSpec)
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../')
+require 'spec_config'
+
+describe "info command functionality" do
+  it "should tell that is not configured when not configured" do
+    Squidward::Command::Info.any_instance.expects(:read_credentials).returns(false)
+    
+    my_command = Squidward::Command::Info.new()
+    my_command.expects(:puts).with("Not yet configured. Run 'squidward credentials:set' for configuring credentials.")
+    my_command.index
+  end
+end

data/spec/commands/logs_test.rb

@@ -2,15 +2,7 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__) + '/../')
 require 'spec_config'
 
-describe "runner command functionality" do
-  before do 
-    Squidward::Command::Logs.any_instance.expects(:read_credentials).returns(["access_key", "secret_key"])
-  end
-  
-  it "should inherit the Base functionality" do
-    my_command = Squidward::Command::Logs.new()
-  end
-  
+describe "log command functionality" do  
   it "should set backup default bucket" do
     my_command = Squidward::Command::Logs.new()
     my_command.expects(:system).with("tail -n 25 #{File.expand_path(File.join(CONF_PATH, LOG_FILE))}")

data/spec/commands/secured_test.rb

@@ -0,0 +1,47 @@
+# enabling the load of files from root (on RSpec)
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../')
+require 'spec_config'
+
+describe "secured commands functionality" do  
+  it "should prompt for AWS Credentials when they do not exist" do
+    Squidward::Command::Secured.any_instance.expects(:read_credentials).returns(false)
+    Squidward::Command::Secured.any_instance.expects(:ask_for_credentials).returns(["access_key", "secret_key"])
+    Squidward::Command::Secured.any_instance.expects(:store_credentials).with(["access_key", "secret_key"])
+    my_command = Squidward::Command::Secured.new()
+  end
+  
+  it "should ask for credentials" do
+    Squidward::Command::Secured.any_instance.expects(:read_credentials).returns(true)
+    my_command = Squidward::Command::Secured.new()
+    my_command.expects(:puts).with("Enter your AWS credentials.")
+    my_command.expects(:print).with("Access Key ID: ")
+    my_command.expects(:print).with("Secret Access Key: ")
+    my_command.expects(:ask).returns("user")
+    my_command.expects(:ask_for_password).returns("password")
+    my_command.ask_for_credentials.should == ["user", "password"]
+  end
+  
+  it "when asking for password should turn off echo and turn it on" do
+    Squidward::Command::Secured.any_instance.expects(:read_credentials).returns(true)
+    my_command = Squidward::Command::Secured.new()
+    my_command.expects(:echo_off)
+    my_command.expects(:echo_on)
+    my_command.expects(:puts)
+    my_command.expects(:ask).returns("password")
+    my_command.ask_for_password.should == "password"
+  end
+      
+  it "should read credentials when already there" do
+    Squidward::Command::Secured.any_instance.expects(:configuration).returns({:credentials => {:secret_key => "secret", :access_key => "access"}}).twice
+    my_command = Squidward::Command::Secured.new()
+    my_command.read_credentials.should == ["access", "secret"]
+  end 
+  
+  it "should store credentials after getting them" do
+    Squidward::Command::Secured.any_instance.expects(:read_credentials).returns(false)
+    Squidward::Command::Secured.any_instance.expects(:ask_for_credentials).returns(["access_key", "secret_key"])
+    Squidward::Command::Secured.any_instance.expects(:configuration).returns({:credentials => {}})
+    Squidward::Command::Secured.any_instance.expects(:store_configuration).returns()
+    my_command = Squidward::Command::Secured.new()
+  end
+end

data/spec/commands/version_test.rb

@@ -2,11 +2,7 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__) + '/../')
 require 'spec_config'
 
-describe "runner command functionality" do
-  before do 
-    Squidward::Command::Version.any_instance.expects(:read_credentials).returns(["access_key", "secret_key"])
-  end
-
+describe "version command functionality" do
   it "should show version string as {gem_name}-{version}" do
     my_command = Squidward::Command::Version.new()
     my_command.expects(:display).with("squidward-#{Squidward::Command::Version::GEM_VERSION}")

metadata

@@ -4,8 +4,8 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 5
-  version: "0.5"
+  - 6
+  version: "0.6"
 platform: ruby
 authors: 
 - Johnny G. Halife
@@ -13,7 +13,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-26 00:00:00 -03:00
+date: 2010-05-03 00:00:00 -03:00
 default_executable: squidward
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -60,14 +60,17 @@ files:
 - lib/squidward/commands/info.rb
 - lib/squidward/commands/logs.rb
 - lib/squidward/commands/run.rb
+- lib/squidward/commands/secured.rb
 - lib/squidward/commands/version.rb
 - lib/squidward.rb
 - spec/commands/base_test.rb
 - spec/commands/bucket_test.rb
 - spec/commands/credentials_test.rb
 - spec/commands/domain_test.rb
+- spec/commands/info_test.rb
 - spec/commands/logs_test.rb
 - spec/commands/run_test.rb
+- spec/commands/secured_test.rb
 - spec/commands/version_test.rb
 - spec/mock_command.rb
 - spec/spec_config.rb