thrift-rack-middleware 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in thrift-rack-middleware.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  # Put spec opts in a file named .rspec in root
+end

data/lib/thrift/rack_middleware.rb

@@ -0,0 +1,74 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+# A Rack application to be used within a Rails application to provide an API
+# access via Thrift. You have to insert it into the MiddlewareStack of Rails
+# within a custom initializer and not within the environment, because Thrift
+# is not fully loaded at that point.
+# 
+# Here is a sample of to to use it:
+# 
+#     ActionController::Dispatcher.middleware.insert_before Rails::Rack::Metal, Thrift::RackMiddleware,
+#                                                                               { :processor => YourCustomProcessor.new,
+#                                                                                 :hook_path => "/the_path_to_receive_api_calls",
+#                                                                                 :protocol_factory => Thrift::BinaryProtocolAcceleratedFactory.new }
+# 
+# Some benchmarking showed this is much slower then any Thrift solution without
+# Rails, but it is still fast enough if you need to integrate your Rails app
+# into a Thrift-based infrastructure.
+# 
+begin
+  require 'rack'
+  require 'rack/response'
+  require 'rack/request'
+rescue LoadError => e
+  Kernel.warn "[WARNING] The Rack library could not be found. Please install it to use the Thrift::RackMiddleware server part."
+end
+
+require "thrift"
+
+module Thrift
+  class RackMiddleware
+    attr_reader :hook_path, :processor, :protocol_factory
+
+    def initialize(app, options = {})
+      @app              = app
+      @processor        = options[:processor] || (raise ArgumentError, "You have to specify a processor.")
+      @protocol_factory = options[:protocol_factory] || BinaryProtocolFactory.new
+      @hook_path        = options[:hook_path] || "/rpc_api"
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+      if request.post? && request.path == hook_path
+        output = StringIO.new
+        transport = IOStreamTransport.new(request.body, output)
+        protocol = @protocol_factory.get_protocol(transport)
+        @processor.process(protocol, protocol)
+
+        output.rewind
+        response = Rack::Response.new(output)
+        response["Content-Type"] = "application/x-thrift"
+        response.finish
+      else
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/thrift/rack_middleware/version.rb

@@ -0,0 +1,7 @@
+module Thrift
+  module Rack
+    module Middleware
+      VERSION = "0.0.1"
+    end
+  end
+end

data/spec/rack_middleware_spec.rb

@@ -0,0 +1,95 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+require 'spec_helper'
+require 'thrift/rack_middleware'
+
+  include Thrift
+
+  describe RackMiddleware do
+    before(:each) do
+      @processor = mock("Processor")
+      @factory = mock("ProtocolFactory")
+      @mock_app = mock("AnotherRackApp")
+      @middleware = RackMiddleware.new(@mock_app, :processor => @processor, :protocol_factory => @factory)
+    end
+
+    it "should call next rack application in the stack if request was not a post and not pointed to the hook_path" do
+      env = {"REQUEST_METHOD" => "GET", "PATH_INFO" => "not_the_hook_path"}
+      @mock_app.should_receive(:call).with(env)
+      Rack::Response.should_not_receive(:new)
+      @middleware.call(env)
+    end
+
+    it "should serve using application/x-thrift" do
+      env = {"REQUEST_METHOD" => "POST", "PATH_INFO" => "/rpc_api"}
+      IOStreamTransport.stub!(:new)
+      @factory.stub!(:get_protocol)
+      @processor.stub!(:process)
+      response = mock("RackResponse")
+      response.should_receive(:[]=).with("Content-Type", "application/x-thrift")
+      response.should_receive(:finish)
+      Rack::Response.should_receive(:new).and_return(response)
+      @middleware.call(env)
+    end
+
+    it "should use the IOStreamTransport" do
+      body = mock("body")
+      env = {"REQUEST_METHOD" => "POST", "PATH_INFO" => "/rpc_api", "rack.input" => body}
+      output = mock("output")
+      output.should_receive(:rewind)
+      StringIO.should_receive(:new).and_return(output)
+      protocol = mock("protocol")
+      transport = mock("transport")
+      IOStreamTransport.should_receive(:new).with(body, output).and_return(transport)
+      @factory.should_receive(:get_protocol).with(transport).and_return(protocol)
+      @processor.should_receive(:process).with(protocol, protocol)
+      response = mock("RackResponse")
+      response.stub!(:[]=)
+      response.should_receive(:finish)
+      Rack::Response.should_receive(:new).and_return(response)
+      @middleware.call(env)
+    end
+
+    it "should have appropriate defaults for hook_path and protocol_factory" do
+      mock_factory = mock("BinaryProtocolFactory")
+      mock_proc = mock("Processor")
+      BinaryProtocolFactory.should_receive(:new).and_return(mock_factory)
+      rack_middleware = RackMiddleware.new(@mock_app, :processor => mock_proc)
+      rack_middleware.hook_path.should == "/rpc_api"
+    end
+
+    it "should understand :hook_path, :processor and :protocol_factory" do
+      mock_proc = mock("Processor")
+      mock_factory = mock("ProtocolFactory")
+
+      rack_middleware = RackMiddleware.new(@mock_app, :processor => mock_proc,
+                                                      :protocol_factory => mock_factory,
+                                                      :hook_path => "/thrift_api")
+
+      rack_middleware.processor.should == mock_proc
+      rack_middleware.protocol_factory.should == mock_factory
+      rack_middleware.hook_path.should == "/thrift_api"
+    end
+
+    it "should raise ArgumentError if no processor was specified" do
+      lambda { RackMiddleware.new(@mock_app) }.should raise_error(ArgumentError)
+    end
+  end
+

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  #
+end

data/thrift-rack-middleware.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "thrift/rack_middleware/version"
+
+Gem::Specification.new do |s|
+  s.name        = "thrift-rack-middleware"
+  s.version     = Thrift::Rack::Middleware::VERSION
+  s.authors     = ["deees"]
+  s.email       = ["tomas.brazys@gmail.com"]
+  s.homepage    = "http://github.com/deees/thrift-rack-middleware"
+  s.summary     = "Thrift rack middleware"
+  s.description = "Rack middleware for thrift services"
+
+  s.rubyforge_project = "thrift-rack-middleware"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  s.add_runtime_dependency "rack"
+  s.add_runtime_dependency "thrift"
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: thrift-rack-middleware
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+  - deees
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-20 00:00:00 Z
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: rspec
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: rack
+    prerelease: false
+    requirement: &id002 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :runtime
+    version_requirements: *id002
+  - !ruby/object:Gem::Dependency 
+    name: thrift
+    prerelease: false
+    requirement: &id003 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :runtime
+    version_requirements: *id003
+description: Rack middleware for thrift services
+email: 
+  - tomas.brazys@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+  - .gitignore
+  - Gemfile
+  - Rakefile
+  - lib/thrift/rack_middleware.rb
+  - lib/thrift/rack_middleware/version.rb
+  - spec/rack_middleware_spec.rb
+  - spec/spec_helper.rb
+  - thrift-rack-middleware.gemspec
+homepage: http://github.com/deees/thrift-rack-middleware
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: thrift-rack-middleware
+rubygems_version: 1.8.9
+signing_key: 
+specification_version: 3
+summary: Thrift rack middleware
+test_files: 
+  - spec/rack_middleware_spec.rb
+  - spec/spec_helper.rb