event-expectr 0.1

data/.gitignore

@@ -0,0 +1,2 @@
+.*.swp
+.*.swo

data/README.md

@@ -0,0 +1,32 @@
+Event Expectr
+=============
+
+This is a wraper around the Expectr gem (https://github.com/cwuest/expectr).  It simply allows you to define a list of patterns and code blocks which will all be checked for a match against an instance of Expectr.  When one of them matches, the code block is executed.  This makes automating some processes easier, however it breaks with the original expect (ala TCL) workflow.
+
+Example
+-------
+
+```ruby
+irb(main):001:0> require 'event-expectr'
+=> true
+irb(main):002:0> e = EventExpectr.new "ssh root@server.example.com", :flush_buffer => false
+=> #<EventExpectr:0x007ff2eb09abd8 @timeout=30, @expectr=#<Expectr:0x007ff2eb09abb0 @buffer="", @discard="", @timeout=0.01, @flush_buffer=false, @buffer_size=8192, @constrain=false, @force_match=false, @out_mutex=#<Mutex:0x007ff2eb09aa70>, @out_update=false, @interact=false, @stdout=#<File:/dev/ttys004>, @stdin=#<File:/dev/ttys004>, @pid=8828>, @patterns={}>
+irb(main):003:0> e.expect("Are you sure you want to continue connecting (yes/no)?") {|match| e.expectr.puts "yes"}
+=> #<Proc:0x007ff2eb0201d0@(irb):5>
+irb(main):004:0> e.expect(/Password: $/) {|match| e.expectr.puts "pa55w0rd"}
+=> #<Proc:0x007ff2eb19f920@(irb):6>
+irb(main):005:0> e.expect(/^root@([a-z0-9]+).*# /i) {|match| puts "Login to #{match[1]} successful"}
+=> #<Proc:0x007ff2eb17d3c0@(irb):7>
+irb(main):005:0> e.run!, :blocking => true
+```
+
+Each time a pattern matches, it is removed from the internal hash of patterns it checks in the EventExpectr#run! method.  When there are no patterns left to check, run! will return true.  It will also return with a false value if the timeout is reached before all the matches are made.
+
+You can set the EventExpectr#running value to false at any time when the run! method is running to cause it to bail out immediatly.  So, if you have many patterns and code blocks, and when one of them matches you want to stop all further matching, just do something like this:
+
+```ruby
+e.expect /^root@([a-z0-9]+).*# /i do |match|
+  puts "Login to #{match[1]} successful"
+  e.running = false
+end
+```

data/event-expectr.gemspec

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'event-expectr/version'
+
+Gem::Specification.new do |s|
+  s.name = "event-expectr"
+  s.version = EventExpectr::VERSION
+
+  s.description = "Wraps the Expectr class so that you can \"register\" a list of several patterns to search for and have a block of code be executed when and if they match."
+  s.summary = "Wrapper for Ruby's expectr gem that enables a different type of workflow."
+  s.authors = ["Andrew Regner"]
+  s.email = "andrew@aregner.com"
+  s.homepage = "http://github.com/adregner/event-expectr"
+
+  s.files = `git ls-files`.split("\n")
+	#s.test_files = s.files.select { |f| f =~ /^test\/test_/ }
+
+  s.license = 'MIT'
+end

data/lib/event-expectr/version.rb

@@ -0,0 +1,3 @@
+class EventExpectr
+  VERSION = "0.1"
+end

data/lib/event-expectr.rb

@@ -0,0 +1,69 @@
+require 'expectr'
+require 'timeout'
+
+class EventExpectr
+  # hash of patterns mapping to code blocks to execute when they match
+  attr_reader :patterns
+
+  # Expectr instance this class wraps
+  attr_reader :expectr
+
+  # boolean value that keeps the run! method running.  set to false to bail out.
+  attr_accessor :running
+
+  def initialize(cmd, args={})
+    @timeout = args.delete(:timeout) || 30
+    
+    @expectr = Expectr.new(cmd, args)
+    @expectr.timeout = 0.01
+
+    @patterns = {}
+  end
+
+  def expect(pattern, &block)
+    if not [String, Regexp].include? pattern.class
+      raise TypeError, "Pattren class should be String or Regexp"
+    end
+
+    @patterns[pattern] = block
+  end
+
+  def run!
+    if @patterns.count == 0
+      raise RuntimeError, "No patterns have been defined yet, this would just look forever"
+    end
+
+    @running = true
+
+    begin
+      Timeout::timeout(@timeout) do
+        while @running
+          @patterns.each_pair do |pattern, block|
+            match = @expectr.expect(pattern, true)
+            if match
+              # run the code provided with this pattern
+              block.call(match)
+
+              # remove it so we don't try to match again
+              @patterns.delete(pattern)
+
+              # the code block may have turned this off
+              break unless @running
+            end
+
+            @running = false if @patterns.count == 0
+          end
+
+          sleep 0.1
+        end
+      end
+    rescue Timeout::Error
+      # haven't found all the matches in the time given.  oh well.
+      return false
+    end
+
+    # this is an intentional end of the run process
+    return true
+  end
+
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: event-expectr
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Regner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-28 00:00:00.000000000 Z
+dependencies: []
+description: Wraps the Expectr class so that you can "register" a list of several
+  patterns to search for and have a block of code be executed when and if they match.
+email: andrew@aregner.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- README.md
+- event-expectr.gemspec
+- lib/event-expectr.rb
+- lib/event-expectr/version.rb
+homepage: http://github.com/adregner/event-expectr
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Wrapper for Ruby's expectr gem that enables a different type of workflow.
+test_files: []
+has_rdoc: