frank-cucumber 0.8.13 → 0.8.14

data/frank-cucumber.gemspec

@@ -23,4 +23,6 @@ Gem::Specification.new do |s|
   s.add_dependency( "i18n" )
   s.add_dependency( "plist" )
   s.add_dependency( "json" ) # TODO: figure out how to be more permissive as to which JSON gems we allow
+
+  s.add_development_dependency( "rr" )
 end

data/lib/frank-cucumber/frank_helper.rb

@@ -2,11 +2,13 @@ require 'json'
 require 'frank-cucumber/gateway'
 require 'frank-cucumber/host_scripting'
 require 'frank-cucumber/wait_helper'
+require 'frank-cucumber/keyboard_helper'
 
 module Frank module Cucumber
 
 module FrankHelper 
   include WaitHelper
+  include KeyboardHelper
   include HostScripting
 
   class << self

data/lib/frank-cucumber/keyboard_helper.rb

@@ -0,0 +1,14 @@
+module Frank
+module Cucumber
+
+module KeyboardHelper
+  def type_into_keyboard(text_to_type)
+    text_to_type = text_to_type+"\n" unless text_to_type.end_with?("\n")
+    res = frank_server.send_post( 
+      'type_into_keyboard',
+      :text_to_type => text_to_type,
+    )
+    Frank::Cucumber::Gateway.evaluate_frankly_response( res, "typing the following into the keyboard '#{text_to_type}'" )
+  end
+end
+end end

data/lib/frank-cucumber/version.rb

@@ -1,5 +1,5 @@
 module Frank
   module Cucumber
-    VERSION = "0.8.13"
+    VERSION = "0.8.14"
   end
 end

data/lib/frank-cucumber/wait_helper.rb

@@ -3,6 +3,34 @@ require 'timeout'
 module Frank
 module Cucumber
 
+# What's going on here?!
+#
+# This module contains a single method called wait_until. When we mix this module into another class or module (such as 
+# FrankHelper) then that wait_until method will be available inside that class or module. Because we call module_function
+# at the end of the module this method is also available as a static method on the module. That means you can also call 
+# Frank::Cucumber::WaitHelper.wait_until from anywhere in your code.
+#
+#
+# wait_until will repeatedly execute the passed in block until either it returns true or a timeout expires. Between 
+# executions there is a pause of POLL_SLEEP seconds.
+#
+# wait_until takes two options, a timeout and a message. 
+# The timeout defaults to the WaitHelper::TIMEOUT constant. That constant is based off of a WAIT_TIMEOUT 
+# environment variable, otherwise it defaults to 240 seconds.
+# If a message is passed in as an option then that message is used when reporting a timeout.
+#
+#
+# Example usage: 
+#
+# wait_until( :timeout => 20, :message => 'timed out waiting for splines to reticulate' ) do
+#   num_splines_reticulated = reticulate_splines(1,2,3)
+#   num_splines_reticulated > 0
+# end
+# 
+# Here we will keep calling the reticulate_splines method until either it returns a result
+# greater than 0 or 20 seconds elapses. In the timeout case an exception will be raised 
+# saying "timed out waiting for splines to reticulate"
+
 module WaitHelper
   TIMEOUT = ENV['WAIT_TIMEOUT'].to_i || 240
   POLL_SLEEP = 0.1 #seconds

data/test/keyboard_helper_test.rb

@@ -0,0 +1,74 @@
+require_relative 'test_helper.rb'
+
+class HelperForTesting
+  include Frank::Cucumber::KeyboardHelper
+
+
+  def mock_frank_server
+    RR.mock(@mock_frank_server = Object.new)
+  end
+
+  private
+  def frank_server
+    @mock_frank_server
+  end
+end
+
+describe "frank keyboard helper" do
+  
+  the_helper = nil
+  before do
+    the_helper = HelperForTesting.new
+  end
+
+  def successful_response
+    %Q{ { "outcome": "SUCCESS" } }
+  end
+
+  it 'posts to the right endpoint' do
+    the_helper.mock_frank_server.send_post('type_into_keyboard', anything ){ successful_response }
+
+    the_helper.type_into_keyboard('blah')
+  end
+
+  it 'sends the right payload, adding a trailing new-line if needed' do
+    the_helper.mock_frank_server.send_post.with_any_args do |endpoint,payload|
+      payload.must_equal( {:text_to_type => "the text I want to type\n"} )
+
+      successful_response
+    end
+
+    the_helper.type_into_keyboard('the text I want to type')
+  end
+
+  it "doesn't add a trailing newline if already there" do
+    the_helper.mock_frank_server.send_post.with_any_args do |endpoint,payload|
+      payload.must_equal( {:text_to_type => "existing newline\n"} )
+
+      successful_response
+    end
+
+    the_helper.type_into_keyboard("existing newline\n")
+  end
+
+  it 'raises an exception if the server responds negatively' do
+    failure_message = <<-EOS
+    { 
+      "outcome": "NOT SUCCESS AT ALL",
+      "reason": "reason for failure",
+      "details": "details about failure"
+    }
+    EOS
+
+    the_helper.mock_frank_server.send_post.with_any_args{ failure_message }
+
+    exception = lambda{ 
+      the_helper.type_into_keyboard('text we attempted to type')
+    }.must_raise RuntimeError
+    
+    exception.message.must_match /text we attempted to type/ 
+    exception.message.must_match /reason for failure/ 
+    exception.message.must_match /details about failure/ 
+  end
+
+end

data/test/launcher_test.rb

@@ -1,5 +1,8 @@
 require_relative 'test_helper.rb'
 
+include Frank::Cucumber::Launcher
+include Frank::Cucumber::FrankHelper
+
 def wait_for_frank_to_come_up
   # orig FrankHelper::wait_for_frank_to_come_up
   # doing nothing

data/test/test_helper.rb

@@ -1,10 +1,16 @@
+require 'ostruct'
 require 'stringio'
 require 'minitest/autorun'
 require 'minitest/mock'
 require 'minitest/spec'
 include MiniTest
+
+require 'rr'
+class MiniTest::Unit::TestCase
+  include RR::Adapters::MiniTest
+end
+
 require_relative '../lib/frank-cucumber/color_helper'
 require_relative '../lib/frank-cucumber/frank_helper'
 require_relative '../lib/frank-cucumber/launcher'
-include Frank::Cucumber::Launcher
-include Frank::Cucumber::FrankHelper
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: frank-cucumber
 version: !ruby/object:Gem::Version
-  version: 0.8.13
+  version: 0.8.14
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-17 00:00:00.000000000Z
+date: 2012-05-22 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70094361339780 !ruby/object:Gem::Requirement
+  requirement: &70144982662120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70094361339780
+  version_requirements: *70144982662120
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70094361337940 !ruby/object:Gem::Requirement
+  requirement: &70144982661540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70094361337940
+  version_requirements: *70144982661540
 - !ruby/object:Gem::Dependency
   name: sim_launcher
-  requirement: &70094361335880 !ruby/object:Gem::Requirement
+  requirement: &70144982661020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70094361335880
+  version_requirements: *70144982661020
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70094361333760 !ruby/object:Gem::Requirement
+  requirement: &70144982660500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70094361333760
+  version_requirements: *70144982660500
 - !ruby/object:Gem::Dependency
   name: plist
-  requirement: &70094361332940 !ruby/object:Gem::Requirement
+  requirement: &70144982660000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70094361332940
+  version_requirements: *70144982660000
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70094361331940 !ruby/object:Gem::Requirement
+  requirement: &70144982659180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,7 +77,18 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70094361331940
+  version_requirements: *70144982659180
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: &70144982658640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70144982658640
 description: Use cucumber to test native iOS apps via Frank
 email:
 - gems@thepete.net
@@ -133,10 +144,12 @@ files:
 - lib/frank-cucumber/frank_localize.rb
 - lib/frank-cucumber/gateway.rb
 - lib/frank-cucumber/host_scripting.rb
+- lib/frank-cucumber/keyboard_helper.rb
 - lib/frank-cucumber/launcher.rb
 - lib/frank-cucumber/localize.yml
 - lib/frank-cucumber/version.rb
 - lib/frank-cucumber/wait_helper.rb
+- test/keyboard_helper_test.rb
 - test/launcher_test.rb
 - test/test_helper.rb
 homepage: http://rubygems.org/gems/frank-cucumber
@@ -164,5 +177,6 @@ signing_key:
 specification_version: 3
 summary: Use cucumber to test native iOS apps via Frank
 test_files:
+- test/keyboard_helper_test.rb
 - test/launcher_test.rb
 - test/test_helper.rb