async_rack_test 0.0.2

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+html
+pkg

data/.rspec

@@ -0,0 +1 @@
+--tag ~slow

data/CHANGELOG.rdoc

@@ -0,0 +1,5 @@
+=== 0.0.1 / 2012-02-23
+
+* Initial commit, copied from:
+    http://github.com/raggi/async_sinatra
+    http://libraggi.rubyforge.org/async_sinatra

data/Gemfile

@@ -0,0 +1,5 @@
+group :test do
+  gem 'rack-test'
+  gem 'rspec'
+  gem 'em-spec', :require => 'em/spec'
+end

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  specs:
+    bacon (1.1.0)
+    diff-lcs (1.1.3)
+    em-spec (0.2.6)
+      bacon
+      eventmachine
+      rspec (> 2.6.0)
+      test-unit
+    eventmachine (1.0.0.beta.4)
+    rack (1.3.6)
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    test-unit (2.4.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  em-spec
+  rack-test
+  rspec

data/README.rdoc

@@ -0,0 +1,81 @@
+= async_rack_test
+
+https://github.com/thoughtless/async_rack_test
+
+Inspired by async_sinatra:
+http://github.com/raggi/async_sinatra
+http://libraggi.rubyforge.org/async_sinatra
+
+== DESCRIPTION:
+
+Extends rack-test to make working with EventMachine easier.
+
+== SYNOPSIS:
+
+A quick example:
+
+  require 'spec_helper'
+  require 'async_rack_test'
+
+  describe MyAsyncApp, :type => :request do
+    include AsyncRackTest::Methods
+    let(:app) { MyAsyncApp.new }
+
+    it 'should be successful' do
+      apost "/some_url", "some data"
+
+      last_response.should be_ok
+    end
+  end
+
+
+== REQUIREMENTS:
+
+TODO
+
+
+== INSTALL:
+
+TODO
+
+
+== RUNNING THE SPECS:
+
+If you want to run the tests for this gem, note that the included .rspec file
+excludes the slow tests by default. To run the slow tests, use something like:
+
+  be rspec spec --tag slow
+
+
+== TODO:
+
+MAYBE: look into rack-test giving us a simple hook to add middleware
+* ultimately AsyncRackTest just inserts ResyncApp as middleware
+* maybe I can just do something like "use ResyncApp" rather than using my weird wrapper with aliases
+Update gemspec file to include all the dependencies (development, test, and otherwise)
+
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2012 Paul Cortens
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/async_rack_test.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require "async_rack_test/version"
+
+Gem::Specification.new do |s|
+  s.name        = "async_rack_test"
+  s.version     = AsyncRackTest::Version::STRING
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Paul Cortens"]
+  s.email       = "paul@thoughtless.ca"
+  s.homepage    = "http://github.com/thoughtless/async_rack_test"
+  s.summary     = "async_rack_test-#{AsyncRackTest::Version::STRING}"
+  s.description = "Extends rack-test to make working with EventMachine easier."
+
+  s.files            = `git ls-files`.split("\n")
+  s.test_files       = `git ls-files -- {spec,features}/*`.split("\n")
+  s.executables      = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.extra_rdoc_files = [ 'README.rdoc', 'CHANGELOG.rdoc']
+  s.rdoc_options     = ["--charset=UTF-8"]
+  s.require_path     = "lib"
+
+  # TODO: Add rack-test as a dependency
+end

data/lib/async_rack_test.rb

@@ -0,0 +1,42 @@
+require 'rack/test'
+require 'async_rack_test/resync_app'
+
+
+# Adds aget, apost, etc. which treat an asynchronous rack-app as synchronous.
+module AsyncRackTest
+  class Timeout < StandardError; end
+
+  module Methods
+    include Rack::Test::Methods
+
+    # The original app
+    def async_app
+      @async_app ||= app
+    end
+    def sync_app
+      @sync_app ||= begin
+        ResyncApp.new(async_app)
+      end
+    end
+
+    def use_sync
+      async_app # Ensure we have cached the original app first.
+      self.instance_eval { class << self; self; end }.class_eval { alias :app :sync_app }
+    end
+    def use_async
+      async_app # Ensure we have cached the original app first.
+      self.instance_eval { class << self; self; end }.class_eval { alias :app :async_app }
+    end
+
+    %w(get put post delete head options).each do |m|
+      eval <<-RUBY, binding, __FILE__, __LINE__ + 1
+      def a#{m}(*args)
+        use_sync
+        #{m}(*args)
+        use_async
+      end
+      RUBY
+    end
+
+  end
+end

data/lib/async_rack_test/resync_app.rb

@@ -0,0 +1,44 @@
+# Turns an async rack app into a sync one. This let's you test the app with
+# rack-test as if it were synchronous.
+module AsyncRackTest
+  class ResyncApp
+    attr_reader :app
+
+    # app => The async app that this is meant to wrap.
+    # opts
+    #   :timeout => Number of seconds before giving up on the async app.
+    def initialize(app, opts={})
+      @app = app
+      @timeout = opts[:timeout] || 5
+    end
+
+    def call(env)
+      result = nil
+      env['async.callback'] = method(:write_async_response)
+      EM.run do
+        response = app.call(env)
+        if response[0] == -1
+          EM.add_periodic_timer(0.1) do
+            unless @async_response.nil?
+              result = @async_response
+              EM.stop
+            end
+          end
+          EM.add_timer(@timeout) do
+            raise Timeout, "Did not receive a response from the app within #{@timeout} seconds--app: #{app.inspect}"
+          end
+        else
+          result = response
+          EM.stop
+        end
+      end
+      result
+    end
+
+    private
+
+    def write_async_response(response)
+      @async_response = response
+    end
+  end
+end

data/lib/async_rack_test/version.rb

@@ -0,0 +1,5 @@
+module AsyncRackTest # :nodoc:
+  module Version
+    STRING = '0.0.2'
+  end
+end

data/spec/async_rack_test_spec.rb

@@ -0,0 +1,145 @@
+require 'spec_helper'
+
+describe AsyncRackTest do
+  class DummyTest
+    include AsyncRackTest::Methods
+    def app
+      @app ||= Proc.new do |env|
+        EM.next_tick do
+          env['async.callback'].call [200, {}, []]
+        end
+        [-1, {}, []]
+      end
+    end
+  end
+
+  describe AsyncRackTest::Methods do
+    let(:test_obj) { DummyTest.new }
+    describe '#sync_app' do
+      it 'should be a ResyncApp' do
+        test_obj.sync_app.should be_kind_of(AsyncRackTest::ResyncApp)
+      end
+    end
+
+    describe '#async_app' do
+      it 'should be the original app' do
+        test_obj.async_app.should be_kind_of(Proc)
+      end
+    end
+
+    describe '#app' do
+      context 'default' do
+        it 'should be the original app' do
+          test_obj.app.should == test_obj.async_app
+        end
+      end
+      context 'after calling #use_sync' do
+        it 'should be a ResyncApp' do
+          test_obj.use_sync
+          test_obj.app.should == test_obj.sync_app
+        end
+        context 'then after calling #use_async' do
+          it 'should be the original app' do
+            test_obj.use_sync
+            test_obj.use_async
+            test_obj.app.should == test_obj.async_app
+          end
+        end
+      end
+    end
+
+    describe '#aget' do
+      it 'should set the app be a ResyncApp' do
+        test_obj.should_receive(:use_sync)
+        test_obj.stub(:get)
+        test_obj.stub(:use_async)
+        test_obj.aget '/'
+      end
+      it 'should call #call on #sync_app' do
+        test_obj.sync_app.should_receive(:call).and_return([200, {}, []])
+        test_obj.aget '/'
+      end
+      it 'should call #get' do
+        test_obj.should_receive(:get)
+        test_obj.aget '/'
+      end
+      it 'should put the app back to the original' do
+        test_obj.aget '/'
+        test_obj.app.should == test_obj.async_app
+      end
+    end
+  end
+
+
+  describe AsyncRackTest::ResyncApp do
+    let(:resync_app) { AsyncRackTest::ResyncApp.new(DummyTest.new.app) }
+    describe '#call' do
+      it "should call #call on the passed in app" do
+        resync_app.app.should_receive(:call).and_return([200, {}, []])
+        resync_app.call({})
+      end
+
+      it "should return when the passed in app returns a status code other than -1", :slow => true do
+        @trigger_async = nil
+        async_app = Proc.new do |env|
+          EM.add_periodic_timer(0.01) do
+            if @trigger_async # This lets us control when the async behavior actually happens.
+              env['async.callback'].call [200, {}, []]
+            end
+          end
+          [-1, {}, []]
+        end
+        resync_app = AsyncRackTest::ResyncApp.new(async_app)
+
+        @result = nil
+        thread = Thread.new { @result = resync_app.call({}) }
+
+        sleep 1 # Give some time to guarantee the thread has had time to run.
+        @result.should be_nil
+        @trigger_async = true
+        thread.join
+        @result.should == [200, {}, []]
+      end
+
+      it "should return instantly when the passed in app is not async", :slow => true do
+        @trigger_async = nil
+        async_app = Proc.new do |env|
+          EM.add_periodic_timer(0.01) do
+            if @trigger_async # This lets us control when the async behavior actually happens.
+              raise 'This should never happen'
+            end
+          end
+          [200, {}, []]
+        end
+        resync_app = AsyncRackTest::ResyncApp.new(async_app)
+
+        @result = nil
+        thread = Thread.new { @result = resync_app.call({}) }
+
+        sleep 1 # Give some time to guarantee the thread has had time to run.
+        @result.should == [200, {}, []]
+        @trigger_async = true
+        sleep 1 # Give some time to guarantee the thread has had time to run.
+        thread.join
+      end
+
+      context "#sync_app doesn't respond within the set timeout", :slow => true do
+        let(:slow_app) do
+          Proc.new do |env|
+            EM.add_timer(1.1) do
+              env['async.callback'].call [200, {}, []]
+            end
+            [-1, {}, []]
+          end
+        end
+        let(:resync_app) { AsyncRackTest::ResyncApp.new(slow_app, :timeout => 1) }
+
+        it "should time out" do
+          lambda {
+            resync_app.call({})
+          }.should raise_error(AsyncRackTest::Timeout)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'bundler/setup'
+require 'async_rack_test'
+require 'em-spec/rspec'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# # in spec/support/ and its subdirectories.
+Dir[File.join(File.expand_path("..", __FILE__), "support/**/*.rb")].each {|f| require f}

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: async_rack_test
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Paul Cortens
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-06-12 00:00:00 Z
+dependencies: []
+
+description: Extends rack-test to make working with EventMachine easier.
+email: paul@thoughtless.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- CHANGELOG.rdoc
+files: 
+- .gitignore
+- .rspec
+- CHANGELOG.rdoc
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- async_rack_test.gemspec
+- lib/async_rack_test.rb
+- lib/async_rack_test/resync_app.rb
+- lib/async_rack_test/version.rb
+- spec/async_rack_test_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/thoughtless/async_rack_test
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.11
+signing_key: 
+specification_version: 3
+summary: async_rack_test-0.0.2
+test_files: []
+