grape-async 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b8a6658bdec057ab8c3af4a2ad4bee0723e759a
-  data.tar.gz: 8846be8cad70cd13854af9953867f756eeace202
+  metadata.gz: 7818cb5a44ad63386d861fd483b728ffd55b746c
+  data.tar.gz: f9f8b85b67ef81d34a61a4d3bdb69a8f808123f5
 SHA512:
-  metadata.gz: 207a6b8ac1f3fbf66036668fb5f20882085a943a59e8a36faf51c2bb5d4aa7dd2c4d358c75cfdba8cac5729bc738bc2a90c04ced5e8a65d22492db49d1a055a9
-  data.tar.gz: 3174176234b9fd20749c4dae03194875d51d6af7da28c3150739803a8de1369f0a66b7ef5e7d1dae738f1c75460e8b39aa7f0bd5a5b76dcd9002384a53ce5db3
+  metadata.gz: 4b40b12de2ddf6a8254b0d5a0982f02ba7be4e3e27e63910e7e7befc5902dbfbd8315ca0189986201d653fce8f818446597ea0de3597d18e6ae325a2823c1847
+  data.tar.gz: 2b5b48fb30d35bf643a100691eed443c67b98d18626f86dbd56e2601c51b0c20052b8719ab395a9094798bc0204eafb8b89ee732cb3259003c906c53f1c0ec2d

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    grape-async (0.1.0)
-      activesupport
-      eventmachine
-      grape
+    grape-async (0.1.2)
+      activesupport (~> 4.2)
+      eventmachine (~> 1.0)
+      grape (~> 0.14)
 
 GEM
   remote: https://rubygems.org/
@@ -20,12 +20,6 @@ GEM
       ice_nine (~> 0.11.0)
       thread_safe (~> 0.3, >= 0.3.1)
     builder (3.2.2)
-    capybara (2.5.0)
-      mime-types (>= 1.16)
-      nokogiri (>= 1.3.3)
-      rack (>= 1.0.0)
-      rack-test (>= 0.5.4)
-      xpath (~> 2.0)
     coderay (1.1.0)
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)
@@ -70,16 +64,10 @@ GEM
       rb-inotify (>= 0.9)
     lumberjack (1.0.9)
     method_source (0.8.2)
-    mime-types (3.0)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2015.1120)
-    mini_portile2 (2.0.0)
     minitest (5.8.3)
     multi_json (1.11.2)
     multi_xml (0.5.5)
     nenv (0.2.0)
-    nokogiri (1.6.7.1)
-      mini_portile2 (~> 2.0.0.rc2)
     notiffany (0.0.8)
       nenv (~> 0.1)
       shellany (~> 0.0)
@@ -127,21 +115,18 @@ GEM
       coercible (~> 1.0)
       descendants_tracker (~> 0.0, >= 0.0.3)
       equalizer (~> 0.0, >= 0.0.9)
-    xpath (2.0.0)
-      nokogiri (~> 1.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler
-  capybara
+  bundler (~> 1.0)
   grape-async!
   guard
   guard-rspec
   pry
   puma
-  rack-test
+  rack-test (~> 0.5)
   rake
   rspec
   thin

data/Guardfile

@@ -1,7 +1,7 @@
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
-guard :rspec, cmd: 'bundle exec rspec', after_all_pass: false do
+guard :rspec, cmd: 'bundle exec rspec', after_all_pass: false, failed_mode: :focus do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^spec/support/.+$})  { "spec" }
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }

data/README.md

@@ -30,6 +30,20 @@ end
 The `async` directive accepts either `:em` for EventMachine based async or `:threaded` for thread based async. 
 The default is `:threaded`.
 
+## Examples
+
+To run the provided example with Thin:
+
+```shell
+bundle exec thin start -R examples/config.ru
+```
+
+or with Puma
+
+```shell
+bundle exec puma examples/config.ru -t 8:32 -w 3 -b tcp://0.0.0.0:3000
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/stuart/grape-async/fork )

data/examples/config.ru

@@ -1,7 +1,7 @@
-require '../lib/grape-async'
+require './lib/grape-async'
 
 class API < Grape::API
-  use Grape::Middleware::Async
+  use Grape::Async
   
   async :em
   desc "Get status using EM async timer"

data/grape-async.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "grape-async"
-  spec.version       = '0.1.2'
+  spec.version       = '0.1.3'
   spec.platform      = Gem::Platform::RUBY
   spec.authors       = ["Lachlan Laycock"]
   spec.email         = ["l.laycock@stuart.com"]
@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "eventmachine", '~> 1.0'
   spec.add_dependency "activesupport", '~> 4.2'
 
-  spec.add_development_dependency 'bundler', '~> 3.0'
+  spec.add_development_dependency 'bundler', '~> 1.0'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rack-test', '~> 0.5'
   spec.add_development_dependency 'rspec', '~> 3.0'

data/lib/grape-async.rb

@@ -1,4 +1,4 @@
 require "grape"
-require "grape-async/api"
+require "grape-async/async"
 require "grape-async/endpoint"
-require "grape-async/middleware/async"
+require "grape-async/extension"

data/lib/grape-async/async.rb

@@ -0,0 +1,73 @@
+module Grape
+  class Async < Grape::Middleware::Base
+    
+    def call!(env)
+      @env = env
+      if endpoint.async_route? && !async_io.nil?
+        if endpoint.async_route?(:em)
+          proc = lambda {
+            EM.next_tick do
+              super
+              endpoint.deferred_resp.callback do
+                resp = endpoint.file || [endpoint.body]
+                async_call [endpoint.status, endpoint.header, resp]
+              end
+            end
+          }
+          if !EM.reactor_running?
+            EM.run do
+              proc.call
+            end
+          else
+            proc.call
+          end
+        
+        else
+          Thread.new do
+            result = super
+            async_call result
+            yield
+          end
+        end
+        
+        [-1, {}, []] # Return async response
+        
+      else
+        super
+
+      end
+    end
+    
+    def async_call(result)
+      if @env['async.callback']
+        async_io.call result
+      elsif @env['rack.hijack']
+        status, headers, body = result
+        begin
+          async_io.write("HTTP/1.1 #{status}\r\n")
+          headers.each do |key, value|
+            async_io.write("#{key}: #{value}\r\n")
+          end
+          async_io.write("Connection: close\r\n")
+          async_io.write("\r\n")
+          body.each do |data|
+            async_io.write(data)
+          end
+        ensure
+          async_io.close
+        end
+      end
+    end
+    
+    def async_io
+      @async_io ||= @env['async.callback'] || begin
+        @env.key?('rack.hijack') ? @env['rack.hijack'].call : nil
+      end
+    end
+    
+    def endpoint
+      @env[Grape::Env::API_ENDPOINT]
+    end
+    
+  end
+end

data/lib/grape-async/{api.rb → extension.rb}

@@ -1,11 +1,13 @@
 module Grape
-  class API
+  class Async
+    module Extension
 
-    class << self
       def async(method = :threaded)
         route_setting :async, { async: true, async_method: method }
       end
+      
+      Grape::API.extend self
+      
     end
   end
-
 end

data/spec/lib/grape-async/{middleware/async_spec.rb → async_spec.rb}

@@ -3,18 +3,26 @@ require 'eventmachine'
 require 'thin'
 require 'puma'
 
-describe Grape::Middleware::Async do
+describe Grape::Async do
 
   def setup_async_obj!
     async_obj = double(:async_obj)
     allow(async_obj).to receive(:call)
-    allow_any_instance_of(Grape::Middleware::Async).to receive(:async_io) {
+    allow_any_instance_of(Grape::Async).to receive(:async_io) {
       async_obj
     }
   end
   
-  let(:host) { 'localhost' }
-  let(:port) { 3333 }
+  def kill_server
+    @server.kill if @server.is_a?(Thread) and @server.alive?
+  end
+  
+  def port
+    3333
+  end
+  
+  let(:host)  { 'localhost' }
+  let(:delay) { 0.25 }
   
   before(:each) do
     Spec::Support::EndpointFaker::FakerAPI.clear_requests!
@@ -22,20 +30,25 @@ describe Grape::Middleware::Async do
   
   context "server async requests", type: :feature do
     
-    let(:reqs_tracker) { Spec::Support::EndpointFaker::FakerAPI.requests }
-    let(:async_responses) { %w(start start start done done done) }
-    let(:sync_responses)  { %w(start done start done start done) }
+    let(:reqs_tracker)    { Spec::Support::EndpointFaker::FakerAPI.requests }
+    let(:async_responses) { %w(start:1 start:2 start:3 done:1 done:2 done:3) }
+    let(:sync_responses)  { %w(start:1 done:1 start:2 done:2 start:3 done:3) }
     
     shared_examples "async requests" do
       
       let(:route) { '/async' }
-      
+
       it "should make 3 thread based async requests" do
         threads = []
+        counter = 0
+        expect(@server).to be_alive
         3.times do
           threads << Thread.new {
-            `curl -s http://#{host}:#{port}#{route}`
+            counter += 1
+            uri = URI.parse("http://#{host}:#{port}#{route}?counter=#{counter}&delay=#{delay}")
+            response = Net::HTTP.get_response(uri)
           }
+          sleep(delay / 3.0)
         end
         threads.each(&:join)
         expect(reqs_tracker).to eql(async_responses)
@@ -49,10 +62,14 @@ describe Grape::Middleware::Async do
       
       it "should make sync 3 requests" do
         threads = []
+        counter = 0
         3.times do
           threads << Thread.new {
-            `curl -s http://#{host}:#{port}#{route}`
+            counter += 1
+            uri = URI.parse("http://#{host}:#{port}#{route}?counter=#{counter}")
+            response = Net::HTTP.get_response(uri)
           }
+          sleep(delay/3.0)
         end
         threads.each(&:join)
         expect(reqs_tracker).to eql(sync_responses)
@@ -64,13 +81,13 @@ describe Grape::Middleware::Async do
 
       before(:all) do
         @server = Thread.new {
-          Thin::Server.start('localhost', 3333) { run Spec::Support::EndpointFaker::FakerAPI }
+          Thin::Server.start('localhost', port) { run Spec::Support::EndpointFaker::FakerAPI }
         }
         sleep(1)
       end
 
       after(:all) do
-        @server.kill if @server.is_a?(Thread) and @server.alive?
+        kill_server
       end
 
       context "sync endpoints are run as sync" do
@@ -92,16 +109,17 @@ describe Grape::Middleware::Async do
     context "using the puma server" do
 
       before(:all) do
-        @server = Thread.new {
-          app = Spec::Support::EndpointFaker::FakerAPI.new
-          Puma::Server.new(app).tap do |s|
-            s.add_tcp_listener 'localhost', 3333
-          end.run
-        }
+        app  = Spec::Support::EndpointFaker::FakerAPI.new
+        puma = Puma::Server.new(app).tap do |s|
+          s.add_tcp_listener 'localhost', port
+        end
+        puma.run
+        @server = puma.thread
+        sleep(1)
       end
 
       after(:all) do
-        @server.kill if @server.is_a?(Thread) and @server.alive?
+        kill_server
       end
 
       context "sync endpoints are run as sync" do
@@ -131,13 +149,13 @@ describe Grape::Middleware::Async do
 
       before(:all) do
         @server = Thread.new {
-          Rack::Handler::WEBrick.run(Spec::Support::EndpointFaker::FakerAPI.new, :Port => 3333)
+          Rack::Handler::WEBrick.run(Spec::Support::EndpointFaker::FakerAPI.new, :Port => port)
         }
         sleep(1)
       end
 
       after(:all) do
-        @server.kill if @server.is_a?(Thread) and @server.alive?
+        kill_server
       end
 
       context "sync endpoints are run as sync" do
@@ -160,38 +178,39 @@ describe Grape::Middleware::Async do
         run Spec::Support::EndpointFaker::FakerAPI.new
       end
     }
+    let(:counter) { 1 }
 
     context "async endpoints" do
       it "should pass through the async middleware" do
-        expect_any_instance_of(Grape::Middleware::Async).to receive(:call!).and_return([-1, {}, []])
+        expect_any_instance_of(Grape::Async).to receive(:call!).and_return([-1, {}, []])
         get '/async'
       end
 
       it "should receive async response" do
         setup_async_obj!
-        get '/async'
+        get '/async', counter: counter, delay: delay
         expect(last_response.status).to eq(-1)
       end
 
       it "should NOT receive async response without server asysnc support" do
-        get '/async'
+        get '/async', counter: counter, delay: delay
         expect(last_response.status).to eq(200)
       end
     end
 
     context "sync endpoints" do
       it "should pass through the async middleware" do
-        expect_any_instance_of(Grape::Middleware::Async).to receive(:call!).and_return([200, {}, ['ok']])
-        get '/sync'
+        expect_any_instance_of(Grape::Async).to receive(:call!).and_return([200, {}, ['ok']])
+        get '/sync', counter: counter
       end
 
       it "should NOT receive async response" do
-        get '/sync'
+        get '/sync', counter: counter
         expect(last_response.status).to eq(200)
       end
 
       it "should NOT receive async response without server asysnc support" do
-        get '/sync'
+        get '/sync', counter: counter
         expect(last_response.status).to eq(200)
       end
 

data/spec/support/endpoint_faker.rb

@@ -19,46 +19,51 @@ module Spec
           
         end
         
-        logger = Logger.new('log/app.log')
-        use Grape::Middleware::Async
-        use Rack::CommonLogger
-        
+        use Grape::Async
+
         helpers do
-          def logger
-            API.logger
-          end
-              
-          def log_before!
-            FakerAPI.requests << "start"
+          def log_start!(i)
+            FakerAPI.requests << "start:#{i}"
           end
         
-          def log_done!
-            FakerAPI.requests << "done"
+          def log_done!(i)
+            FakerAPI.requests << "done:#{i}"
           end
         end
         
         async
+        params do
+          requires :counter, type: Integer
+          requires :delay, type: Float
+        end
         get :async do
-          log_before!
-          sleep(1)
+          log_start!(params[:counter])
+          sleep(params[:delay])
           present({ status: 'ok'})
-          log_done!
+          log_done!(params[:counter])
         end
 
         async :em
+        params do
+          requires :counter, type: Integer
+          requires :delay, type: Float
+        end
         get :async_em do
-          log_before!
-          EM.add_timer(1) do
+          log_start!(params[:counter])
+          EM.add_timer(params[:delay]) do
             present({ status: 'ok'})
             done
-            log_done!
+            log_done!(params[:counter])
           end
         end
 
+        params do
+          requires :counter, type: Integer
+        end
         get :sync do
-          log_before!
+          log_start!(params[:counter])
           present({ status: 'ok'})
-          log_done!
+          log_done!(params[:counter])
         end
 
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-async
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Lachlan Laycock
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-30 00:00:00.000000000 Z
+date: 2016-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -128,13 +128,13 @@ files:
 - grape-async.gemspec
 - lib/.DS_Store
 - lib/grape-async.rb
-- lib/grape-async/api.rb
+- lib/grape-async/async.rb
 - lib/grape-async/endpoint.rb
-- lib/grape-async/middleware/async.rb
+- lib/grape-async/extension.rb
 - spec/factories.rb
 - spec/lib/grape-async/api_spec.rb
+- spec/lib/grape-async/async_spec.rb
 - spec/lib/grape-async/endpoint_spec.rb
-- spec/lib/grape-async/middleware/async_spec.rb
 - spec/spec_helper.rb
 - spec/support/endpoint_faker.rb
 homepage: https://github.com/stuartapp/grape-async
@@ -157,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Enable asyncronous endpoints to avoid blocking slow requests within EventMachine
@@ -165,7 +165,7 @@ summary: Enable asyncronous endpoints to avoid blocking slow requests within Eve
 test_files:
 - spec/factories.rb
 - spec/lib/grape-async/api_spec.rb
+- spec/lib/grape-async/async_spec.rb
 - spec/lib/grape-async/endpoint_spec.rb
-- spec/lib/grape-async/middleware/async_spec.rb
 - spec/spec_helper.rb
 - spec/support/endpoint_faker.rb

data/lib/grape-async/middleware/async.rb

@@ -1,71 +0,0 @@
-module Grape
-  module Middleware
-    class Async < Grape::Middleware::Base
-      
-      def call!(env)
-        @env = env
-        if endpoint.async_route? && !async_io.nil?
-          if endpoint.async_route?(:em)
-            proc = lambda {
-              EM.next_tick do
-                super
-                endpoint.deferred_resp.callback do
-                  resp = endpoint.file || [endpoint.body]
-                  async_call [endpoint.status, endpoint.header, resp]
-                end
-              end
-            }
-            if !EM.reactor_running?
-              EM.run do
-                proc.call
-              end
-            else
-              proc.call
-            end
-          else
-            Thread.new do
-              result = super
-              async_call result
-              yield
-            end
-          end
-          
-          [-1, {}, []] # Return async response
-          
-        else
-          super
-
-        end
-      end
-      
-      def async_call(result)
-        if @env['async.callback']
-          async_io.call result
-        elsif @env['rack.hijack']
-          begin
-            if result.last.is_a?(Rack::BodyProxy)
-              async_io << result.last.body.first
-              result.last.close unless result.last.closed?
-            elsif result.last.is_a?(Array)
-              async_io << result.last.first
-            end
-          ensure
-            EM.stop if endpoint.async_route?(:em)
-            @env['rack.hijack'].close
-          end
-        end
-      end
-      
-      def async_io
-        @env['async.callback'] || begin
-          @env.key?('rack.hijack') ? @env['rack.hijack'].call : nil
-        end
-      end
-      
-      def endpoint
-        @env[Grape::Env::API_ENDPOINT]
-      end
-      
-    end
-  end
-end