lackie 0.1.0

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+group :development do
+  gem 'bundler', '~> 1.0.7'
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    lackie (0.1.0)
+      rack (~> 1.2.1)
+      rest-client (~> 1.4.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    builder (2.1.2)
+    cgi_multipart_eof_fix (2.5.0)
+    cucumber (0.10.0)
+      builder (>= 2.1.2)
+      diff-lcs (~> 1.1.2)
+      gherkin (~> 2.3.2)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+    daemons (1.0.10)
+    diff-lcs (1.1.2)
+    fastthread (1.0.1)
+    gem_plugin (0.2.3)
+    gherkin (2.3.3)
+      json (~> 1.4.6)
+    json (1.4.6)
+    mime-types (1.16)
+    mongrel (1.1.5)
+      cgi_multipart_eof_fix (>= 2.4)
+      daemons (>= 1.0.3)
+      fastthread (>= 1.0.1)
+      gem_plugin (>= 0.2.3)
+    rack (1.2.1)
+    relevance-rcov (0.9.2.1)
+    rest-client (1.4.2)
+      mime-types (>= 1.16)
+    rspec (2.2.0)
+      rspec-core (~> 2.2)
+      rspec-expectations (~> 2.2)
+      rspec-mocks (~> 2.2)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    term-ansicolor (1.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.7)
+  cucumber (~> 0.10.0)
+  lackie!
+  mongrel (~> 1.1.5)
+  rack (~> 1.2.1)
+  relevance-rcov (~> 0.9.2.1)
+  rest-client (~> 1.4.2)
+  rspec (~> 2.2.0)

data/README.rdoc

@@ -0,0 +1,65 @@
+= Lackie
+
+== Warning
+
+I haven't used Lackie to develop an application yet. But I have used it in
+various browsers including firefox, chrome and the samsung maple emulator.
+
+== About
+
+Lackie enables automation of remote applications using an HTTP middleman:
+
+  Ruby Client -> Lackie Service <- Remote App
+
+Lackie automates applications running in environments that are difficult to
+control remotely. Lackie requires minimal support in target environments:
+scheduling (e.g. window.setInterval) and HTTP client capabilities (e.g. ajax).
+
+Where it's difficult to programmatically launch the remote application, it can
+be started manually before the automation begins. Lackie effectively "attaches"
+itself to the running "zombie" application.
+
+Lackie uses an HTTP service as a proxy for application automation commands:
+
+  1. application surrenders control to automation
+  2. the surrendered application polls Lackie for commands
+  3. the automator sends a command to Lackie
+  4. the application executes the command and sends the result to Lackie
+  5. the automator polls Lackie and receives the result (or error)
+
+== Usage
+
+Lackie is implemented as rack middleware, so:
+
+  require 'rack'
+  require 'lackie'
+  require 'lackie/rack'
+  
+  Rack::Builder.app do
+    use Lackie::Rack::Middleware
+    run MyApp
+  end
+  
+It will intercept all requests where the path starts with /lackie/
+
+Lackie expects remote applications to:
+
+  1. poll the middleware for commands expressed as strings
+  2. execute those commands when they appear
+  3. send string results back to the middleware
+
+== Example
+
+The source code includes an example rack app:
+
+  rackup features/support/config.ru
+
+Open this URL in your browser of choice:
+
+  http://localhost:9292/example_app/app.html
+
+Now you can execute commands in the remote application:
+
+  require 'rubygems'
+  require 'lackie'
+  Lackie::RemoteControl.new("localhost", 9292).exec("1 + 2") # => "3"

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rake'
+require 'rspec/core/rake_task'
+
+desc  "Run all specs with rcov"
+RSpec::Core::RakeTask.new(:rcov) do |t|
+  t.rcov = true
+  t.rcov_opts = %w{--exclude gems\/,spec\/,features\/}
+end
+
+desc  "Run all specs, then all features"
+task :default do
+  system("rspec spec && cucumber features")
+end

data/features/remote_control.feature

@@ -0,0 +1,19 @@
+Feature: Remote Control
+  In order to automate remote applications with HTTP client capabilities 
+  As a client
+  I want to surrender applications as javascript lackies
+  
+  Scenario: Remote Execution
+    Given I have surrendered my web page as a lackie
+    When  I tell the lackie to execute "1 + 1"
+    Then  I should see a result with the value "2"
+    
+  Scenario: Remote Execution Error
+    Given I have surrendered my web page as a lackie
+    When  I tell the lackie to execute "(function() { throw 'whoopsie'; })()"
+    Then  I should see an error with the message "whoopsie"
+
+  Scenario: Remote Log
+    Given I have surrendered my web page as a lackie
+    When  I tell the lackie to log "yipee"
+    Then  I should see a result with the value "yipee"

data/features/step_definitions/lackie_steps.rb

@@ -0,0 +1,23 @@
+Given /^I have surrendered my web page as a lackie$/ do
+  browse_example_app
+end
+
+When /^I tell the lackie to log "([^\"]*)"$/ do |message|
+  @response = remote_control.log(message)
+end
+
+When /^I tell the lackie to execute "([^\"]*)"$/ do |script|
+  begin
+    @response = remote_control.exec(script)
+  rescue => e
+    @error = e
+  end
+end
+
+Then /^I should see a result with the value "([^\"]*)"$/ do |value|
+  @response.to_s.should == value
+end
+
+Then /^I should see an error with the message "([^\"]*)"$/ do |message|
+  @error.message.should == message
+end

data/features/support/config.ru

@@ -0,0 +1,7 @@
+$:.unshift(File.dirname(__FILE__) + '/../../lib')
+$:.unshift(File.dirname(__FILE__))
+
+require 'lackie/rack'
+require 'example_app'
+
+run ExampleApp.build

data/features/support/env.rb

@@ -0,0 +1,54 @@
+$:.unshift(File.dirname(__FILE__) + '/../../lib')
+$:.unshift(File.dirname(__FILE__))
+
+require 'rack'
+require 'mongrel'
+require 'selenium-webdriver'
+require 'lackie'
+require 'lackie/rack'
+require 'example_app'
+
+module LackieWorld
+  def remote_control
+    Lackie::RemoteControl.new(host, port)
+  end
+  
+  def browse_example_app
+    web_driver.get "http://#{host}:#{port}/example_app/app.html"
+  end
+  
+  private
+  
+  def host
+    "localhost"
+  end
+  
+  def port
+    6663
+  end
+  
+  def web_driver
+    @@web_driver ||= begin
+      start_server
+      driver = Selenium::WebDriver.for :firefox
+      at_exit { driver.close }
+      driver
+    end
+  end
+  
+  def start_server
+    rack_server = nil
+    rack_thread = Thread.new do
+      ::Rack::Handler::Mongrel.run(ExampleApp.build, :Host => host, :Port => port) do |server|
+        rack_server = server
+      end
+    end
+    at_exit do
+      rack_server.stop
+      rack_thread.kill
+    end
+    sleep 0.05 while rack_server.nil?
+  end
+end
+
+World(LackieWorld)

data/features/support/example_app/app.html

@@ -0,0 +1,13 @@
+<html>
+  <head>
+    <title>Lackie: Surrendered Web Page Example</title>
+  </head>
+  <body>
+    
+    <!-- Lackie::RemoteControl#log creates elements under #LackieLog, if it exists -->
+    <div id="LackieLog" style="background-color:#ffffff"></div>
+    
+    <script type="text/javascript" src="/lackie/surrender"></script>
+  
+  </body>
+</html>

data/features/support/example_app.rb

@@ -0,0 +1,9 @@
+class ExampleApp
+  def self.build
+    ::Rack::Builder.app do
+      use Lackie::Rack::Middleware
+      use Rack::Static, :urls => ["/example_app"], :root => File.dirname(__FILE__)
+      run lambda { |e| [404, {'Content-Type' => 'text/html'}, ['Not Found']] }
+    end
+  end
+end

data/lackie.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require "lackie"
+
+Gem::Specification.new do |s|
+  s.name        = 'lackie'
+  s.version     = Lackie::VERSION
+  s.authors     = ['Josh Chisholm']
+  s.description = 'Automates remote applications using an HTTP middleman'
+  s.summary     = "lackie-#{s.version}"
+  s.email       = 'joshuachisholm@gmail.com'
+  s.homepage    = 'http://github.com/joshski/lackie'
+
+  s.add_dependency 'rack', '~> 1.2.1'
+  s.add_dependency 'rest-client', '~> 1.4.2'
+  
+  s.add_development_dependency 'rspec', '~> 2.2.0'
+  s.add_development_dependency 'cucumber', '~> 0.10.0'
+  s.add_development_dependency 'mongrel', '~> 1.1.5'
+  s.add_development_dependency 'relevance-rcov', '~> 0.9.2.1'
+  
+  s.rubygems_version  = "1.3.7"
+  s.files             = `git ls-files`.split("\n")
+  s.test_files        = `git ls-files -- {spec,features}/*`.split("\n")
+  s.extra_rdoc_files  = ["README.rdoc"]
+  s.require_path      = "lib"
+end