doable 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12cd4bee334b582b69a835051c8cfeb0314aa3e3
-  data.tar.gz: 84db114358f2ea2f7511900421206ed8ddcbe9d5
+  metadata.gz: ae66f67c0262597b37425580b07c0bad85c71621
+  data.tar.gz: 45ad1f5d2df72887db40ec4c441591b5ff02fe02
 SHA512:
-  metadata.gz: 380841e88c0f7dcf73a6d9a85bf6d3bdb0941a519f8072e0957515c42a38b224fc3e8be81ed6be0b4c338a7ae071f3c55228f0877fb634bfb8322cf7c69f4745
-  data.tar.gz: 56aea29e8c7bfd238d806d8953ab456ef13239b9ec019d2316b22be8e2a747bf9620106a3f686d7d429c4446d79ef41e2b7adfec0e98ba8de829596deabdfccd
+  metadata.gz: 36b6cff4e14a55d0e0f35a50aef0a7935c36c973ae5e5637270191b75254db61839706718543a356c9aa15eb529b8bbf33af061bd110e67ff1627014e199b977
+  data.tar.gz: a56729ec3909eb736ce770aae53dd97582bf8ddfb4418bcbb3790aab8e4eddc77f215f9f04c2c35323f6cec05fbc4bdac5bed9c9076b2df3f02a1063b98fff58

data/README.md

@@ -20,7 +20,7 @@ These goals are largely achieved through a small set of core features, with near
 Building
 -----
 
-The eventual goal is for this gem to simply be available via a normal rubygems search, but until then, you must build and install the gem yourself. This can be done like so:
+While it is recommended to simply install via a normal rubygems search via ` gem install doable` (or adding `gem "doable"` to your Gemfile), you can build and install the gem yourself. This can be done like so:
 
     #!bash
     # need Mercurial to clone the repo... or download it from https://bitbucket.org/jgnagy/doable/get/tip.zip
@@ -74,8 +74,64 @@ After this job runs, you should see output that looks something like:
     [2015/01/29 00:10:36] Here's a password for you...
     Password: ZwyIVH8LjHGYYzDX
     [2015/01/29 00:10:36] All Job steps completed successfully!
+    
+Let's try something more realistic. Say the goal is to: 
+
+* check to make sure we have enough space to do things
+* add a user (unless they already exist)
+* unpack some software
+* run it as our new user
+
+Here is an example job:
+
+    #!ruby
+    require 'doable/helpers/linux'
+    
+    class InstallCoolSoftware < Doable::Job
+      include Doable::Helpers::Linux
+    end
+    
+    job3 = InstallCoolSoftware.plan do |j|
+      # make sure we have 500MB of space
+      j.before  {
+        @app_dir = "/opt/coolsoft/server"
+        check_disk_space @app_dir, (500 * 1024 * 1024)
+      }
+      
+      j.step    { 
+        @user  = "cooluser"
+        find_or_create_user @user, File.dirname(@app_dir)
+      }
+      
+      j.step    {
+        find_or_create_directory @app_dir
+        
+        FileUtils.cd(@app_dir) do
+          tee "tar -xf /opt/media/files/coolsoft-server-1.2.3.tgz --strip=1"
+        end
+        
+        chown @user, @user, @app_dir, :recursive => true
+      }.rollback {
+        remove(@app_dir)
+      }
+      
+      j.step     {
+        run_as_user @user, File.join(@app_dir, "/bin", "start.sh")
+      }
+    end
+    
+    job3.run
+
+Hopefully this demonstrates how to get access to additional helper methods. Also, you may have noticed the `rollback` method added to the step for uncompressing the tarball. If things go wrong, rollbacks can be run to revert changes. To do so, just do this:
+
+    job3.rollback!
+
+The `Job` instance also has many other methods available for accessing its internals.
+
+RubyDoc
+-------
 
-Hopefully this demonstrates how to get access to additional helper methods.
+The latest, published documentation can be seen on [RubyDoc](http://www.rubydoc.info/gems/doable/)
 
 License
 -------
@@ -85,4 +141,4 @@ Doable is distributed under the MIT License.
 Contributing
 ------------
 
-I welcome pull-requests. I may or may not use your code, but I encourage the growth of others too. If this project inspires you to contribute, feel free to fork my code and submit a pull request. In most cases, I'll probably recommend you package additions in an extension gem rather than including new files, etc, directly into the core codebase.
+I welcome pull-requests. I may or may not use your code, but I encourage the growth of others too. If this project inspires you to contribute, feel free to fork my code and submit a pull request. In most cases, I'll probably recommend you package additions in an extension gem rather than including new files, etc, directly into the core codebase.

data/lib/doable/helpers/linux.rb

@@ -219,12 +219,12 @@ module Doable
       end
 
       # Finds the mount point for a directory, then checks it for a minimum number of kilobytes
-      # @param install_dir [String] Directory from which check starts
+      # @param directory [String] Directory from which check starts
       # @param min_space [Fixnum] Minumum amount of space required on mount-point discovered from install_dir
-      def check_disk_space(install_dir, min_space)
+      def check_disk_space(directory, min_space)
         all_filesystems = `df -PB 1024`.chomp.split("\n").collect {|fs| fs.split if fs.match(/^\/dev/) }.compact
         best_fit = nil
-        current_test = install_dir
+        current_test = directory
         until best_fit
           matching_fs = all_filesystems.collect {|fs| fs if File.expand_path(fs[5]) == File.expand_path(current_test) }.compact
           if matching_fs.size == 1

data/lib/doable/helpers/password.rb

@@ -11,18 +11,46 @@ module Doable
         (1..length).collect{|a| options[:characters][rand(options[:characters].size)] }.join
       end # generate_password()
 
-      def sha1_hash(password, add_salt = true)
-        salt = if add_salt?
-          if add_salt.kind_of?(String) and add_salt.downcase.match(/^[0-9a-f]+$/)
-            add_salt.downcase
+      # Generates a digest hash of a string
+      # @param password [String] string to digest
+      # @param options [Hash] Options hash for digest details
+      # @return [String]
+      def password_hash(password, options = { algorithm: :sha1, salt: true } )
+        options[:algorithm] ||= :sha1
+        options[:salt] = true unless options.has_key?(:salt)
+
+        salt = if options[:salt]
+          if options[:salt].kind_of?(String)
+            if options[:salt].downcase.match(/^[0-9a-f]+$/)
+              options[:salt].downcase
+            else
+              # hex encode the non-hex salt... good way to keep input sanitized
+              options[:salt].downcase.unpack('H*').join
+            end
           else
             generate_password(16, characters: [*(0..9), *('a'..'f')])
           end
         else
           ''
         end
-        Base64.encode64(Digest::SHA1.digest(password + salt) + salt).chomp
-      end
+
+        case options[:algorithm].to_sym
+        when :sha1
+          Base64.strict_encode64(Digest::SHA1.digest(password + salt) + salt)
+        when :sha256, :sha2
+          Base64.strict_encode64(Digest::SHA256.digest(password + salt) + salt)
+        when :sha384
+          Base64.strict_encode64(Digest::SHA384.digest(password + salt) + salt)
+        when :sha512
+          Base64.strict_encode64(Digest::SHA512.digest(password + salt) + salt)
+        when :md5
+          Base64.strict_encode64(Digest::MD5.digest(password + salt) + salt)
+        when :ripe160, :ripemd, :rmd160
+          Base64.strict_encode64(Digest::RMD160.digest(password + salt) + salt)
+        else
+          raise InvalidInput, "Invalid Hashing Algorithm: #{options[:algorithm].to_sym}"
+        end
+      end # password_hash()
     end
   end
 end

data/lib/doable/job.rb

@@ -37,6 +37,7 @@ module Doable
     def on(hook, options = {}, &block)
       @hooks[hook] ||= []
       @hooks[hook] << Step.new(self, options, &block)
+      @hooks[hook].last # return the last step (the one we just defined)
     end # on()
 
     # Adds a step to the queue
@@ -45,6 +46,7 @@ module Doable
     # @return [Step]
     def step(options = {}, &block)
       @steps << Step.new(self, options, &block)
+      @steps.last # return the last step (the one we just defined)
     end # step()
 
     # Registers an action to be performed before normal step execution
@@ -67,7 +69,7 @@ module Doable
     # WARNING! Exception handlers are __not__ used with these steps, as they never actually raise exceptions
     # @param options [Hash]
     # @param block [Proc]
-    # @return [Boolean] this will __always__ be true by the nature of "attempt"
+    # @return [Step] the step just create by this method
     def attempt(options = {}, &block)
       @steps << Step.new(self, options) do
         begin
@@ -78,7 +80,7 @@ module Doable
           log "Ignoring Exception in attempted step: #{colorize("#{e.class}: (#{e.message})", :red)}"
         end
       end
-      return true
+      @steps.last # return the last step (the one we just defined)
     end # attempt()
 
     # Allow running steps in the background
@@ -89,6 +91,7 @@ module Doable
       @steps << Step.new(self, options) do
         @threads << Thread.new { block.call }
       end
+      @steps.last # return the last step (the one we just defined)
     end # background()
 
     # Check if background steps are running
@@ -100,9 +103,9 @@ module Doable
     # Trigger a rollback of the entire Job, based on calls to #rollback!() on each eligible Step
     def rollback!
       log "Rolling Back...", :warn
-      @hooks[:after].reverse.each {|s| s.rollback! if s.rollbackable? }
+      @hooks[:after].reverse.each {|s| s.rollback! if s.rollbackable? }  if @hooks.has_key?(:after)
       @steps.reverse.each {|s| s.rollback! if s.rollbackable? }
-      @hooks[:before].reverse.each {|s| s.rollback! if s.rollbackable? }
+      @hooks[:before].reverse.each {|s| s.rollback! if s.rollbackable? } if @hooks.has_key?(:before)
       log "Rollback complete!", :warn
       raise RolledBack
     end # rollback!()

data/lib/doable/step.rb

@@ -66,7 +66,7 @@ module Doable
 
     # Actually rollback this step
     def rollback!
-      @rollback.call
+      @context.instance_exec(&@rollback)
       @status = :rolledback
       @success = false
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: doable
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Jonathan Gnagy
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-02 00:00:00.000000000 Z
+date: 2015-03-13 00:00:00.000000000 Z
 dependencies: []
 description: A framework for automating tasks with ease
 email: jonathan.gnagy@gmail.com