expect-behaviors 0.1.3 → 0.1.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YzdhNTllYTdkNTc4YjE2ODg3YTc5ZDAwYTFmM2M0OTVlMjczYzlhZg==
+    ZDM1NWQyOTg2NmYxOTVhOTNlNWM1MTg4ODZjNWQ1NDVhNWExZmIwYg==
   data.tar.gz: !binary |-
-    M2FmM2MwZGVjMGRjM2U5MDk5ZmZmZDEzNWYxZmM1ODRlOWQwN2Y4ZA==
+    ZjU0MjMzYmE3ZjcwMGEyNThmMTcxMzY0Y2YxMTRhZGU4ODI0ODMwOQ==
 SHA512:
   metadata.gz: !binary |-
-    NjJjNTc5NDczYjQ4MGM4NjMzMWY4NTZiZmFjZTZmNjMzYjAyZDNiYTE1MmE5
-    MDQyOWQwYjcxOWFkMGQzYTdhNDYyOWFiYzA1NDBjNjc5MTdjMTIyY2NkMGYx
-    NjYzMTEzNmZjOGMyYWMyYWUyZGQ4MTk3MWQzZWU1MzM2OTQ3Yjg=
+    MzVjYmZhMDIyZWIyOGEzZWRiNDNhMmNiNWVhZGM2MGFjZmFkMzU2ZDdjMmEz
+    MWZjM2I2M2QzMjZlMjdjNDFmY2YzNWNmOTRlNTZhZDhjNDczZmE0MTVjZTZh
+    YThhMGNkYTlhN2E1MTIyZDBjZTkzNjkxYmY1ODljMDM2Njg4NDI=
   data.tar.gz: !binary |-
-    Y2ZkMDVlNjU0YzNjYmExMzE0ZmI4NGQzMTNkOWRlYTY5ZDI5ZTRmMTI5OTVi
-    NDcyNGE0MWY5ZDhlMmQ3ZTAxMjBkMWRkYzU2ZjcyYzA3MzgxMDNkOTZlNDJk
-    NWRlNGZjZDc0ODQ1ODNiOTIxMjFkYzI5OGJhY2UxZjFhMzdkNzc=
+    MmNjZDVhYzE4YjljMzNlZTU1OTg2Y2Q2NzY4NDRkZjAxZmQyNzQwYjUyZGUx
+    NmQ2ZTAwNWNiYTdjODNmNGMwOGFkODRhYjcxOWM5YmVkZGQ1MDE3YzNhODBl
+    OTE2MjI3NDQxYTUwMjhmYmUxZmQyNWUwY2Q3ZjFiNDIxYmE4YmI=

data/README.md

@@ -5,12 +5,91 @@ Ruby Mixin to add Expect Behaviors to SSH/Serial/Telnet controllers
 [![Code Climate](https://codeclimate.com/github/francisluong/expect-behaviors/badges/gpa.svg)](https://codeclimate.com/github/francisluong/expect-behaviors)
 [![Test Coverage](https://codeclimate.com/github/francisluong/expect-behaviors/badges/coverage.svg)](https://codeclimate.com/github/francisluong/expect-behaviors)
 
-# Contributing to expect-behaviors
-
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+# Using the Mixin
+
+Two public methods are required to support adding expect behaviors to your controller. 
+ 
+-   #exp_process - should do one iteration of handle input and append buffer
+-   #exp_buffer - provide the current buffer contents from controller and empty it
+
+The you need to include the module in your class:
+
+```ruby
+require 'expect/behavior'
+
+class Klass
+    include Expect::Behavior
+end
+
+```
+
+# Batteries Included: Expect::SSH
+
+You can find an example which uses the module in this repo: [Expect::SSH](lib/expect/ssh.rb).  This example implements the required methods:
+
+```ruby
+    ##
+    # exp_buffer - provide the current buffer contents and empty it
+    def exp_buffer
+      result = @receive_buffer
+      @receive_buffer = ''
+      result
+    end
+
+    ##
+    # exp_process - should do one iteration of handle input and append buffer
+    def exp_process
+      sleep(@wait_sec.to_f)
+      @ssh.process(0)
+    end
+```
+
+# Using Expect
+
+Once Expect::Behaviors has been included you should be able to use Expect blocks in your code.  
+
+Here is an example assuming an instance of Expect::SSH that expects a switch prompt and includes a timeout block that expires after 3 seconds.  It returns different values depending on how things work out.
+
+```ruby
+result = @ssh.expect do
+    when_matching(/switch-prompt1#/) do
+      "switch 1"
+    end
+    when_matching(/switch-prompt2#/) do
+      "switch 2"
+    end
+    when_timeout(3) do
+      "timed out"
+    end
+end
+```
+
+You can set the timeout value:
+
+```ruby
+@ssh.exp_timeout_sec = 2 * 60
+```
+
+You can set the exp_sleep_interval_sec between buffer checks:
+
+```ruby
+@includer.exp_sleep_interval_sec = 10
+```
+
+# Expect::Match
+
+And you can use #exp_match or return @exp_match from within a #when_matching block to return an Expect::Match object.
+
+Expect::Match exposes the following methods:
+
+ - #buffer - returns the full contents of the buffer that matched
+ - #exact_match_string - returns the first capture from the match
+ - #to_s - returns the contents of the buffer up to the match
+ - #remainder - returns the contents of the buffer following the first match
+ - #nil? - true if there were no matches 
+
+# That's All the Crummy Documentation?
+
+For now, yes.  I need to learn how to use YARD and RDOC.  Sorry!
+
+-Franco

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.1.4

data/expect-behaviors.gemspec

@@ -6,12 +6,12 @@
 
 Gem::Specification.new do |s|
   s.name = "expect-behaviors"
-  s.version = "0.1.3"
+  s.version = IO.read('VERSION')
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Francis Luong (Franco)"]
-  s.date = "2016-03-14"
+  s.date = File.mtime('VERSION')
   s.description = "Ruby Mixin to add Expect Behaviors to SSH/Serial/Telnet controllers"
   s.email = "me@francisluong.com"
   s.extra_rdoc_files = [

data/lib/expect/match.rb

@@ -8,6 +8,7 @@ module Expect
       @matches    = @buffer.match(@expression)
     end
 
+    # returns the first capture from the match
     def exact_match_string
       @matches.nil? ? nil : @matches[0]
     end
@@ -16,15 +17,18 @@ module Expect
       Regexp.new(".*?#{@expression.source}", @expression.options | Regexp::MULTILINE)
     end
 
+    # true if there were no matches
     def nil?
       @matches.nil?
     end
 
+    # returns the contents of the buffer up to the match
     def substring_up_to_match
       @matches.nil? ? nil : @buffer.match(expr_substring_to_match)[0]
     end
     alias_method :to_s, :substring_up_to_match
 
+    # returns the contents of the buffer following the first match
     def substring_remainder
       if @matches.nil?
         @buffer

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: expect-behaviors
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Francis Luong (Franco)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-14 00:00:00.000000000 Z
+date: 2016-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh