stark-rack 1.0.0

data/lib/stark/rack/verbose_protocol.rb

@@ -0,0 +1,36 @@
+class Stark::Rack
+  # Slightly more verbose protocol so that we can get struct and field names
+  # included.
+  class VerboseProtocol < Thrift::BinaryProtocol
+    def write_struct_begin(name)
+      write_string name
+    end
+
+    def read_struct_begin
+      read_string
+    end
+
+    def write_field_begin(name, type, id)
+      write_string name
+      super
+    end
+
+    def write_field_stop
+      write_string ""
+      super
+    end
+
+    def read_field_begin
+      name = read_string
+      result = super
+      result[0] = name unless name.empty?
+      result
+    end
+  end
+
+  class VerboseProtocolFactory < Thrift::BinaryProtocolFactory
+    def get_protocol(trans)
+      return VerboseProtocol.new(trans)
+    end
+  end
+end

data/stark-rack.gemspec

@@ -0,0 +1,42 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "stark-rack"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Evan Phoenix"]
+  s.date = "2013-05-22"
+  s.description = "Provides middleware for mounting Stark/Thrift services as Rack endpoints."
+  s.email = ["evan@phx.io"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
+  s.files = [".autotest", ".gemtest", "History.txt", "Manifest.txt", "README.txt", "Rakefile", "lib/stark/rack.rb", "lib/stark/rack/content_negotiation.rb", "lib/stark/rack/logging_processor.rb", "lib/stark/rack/metadata.rb", "lib/stark/rack/rest.rb", "stark-rack.gemspec", "test/calc-opt.rb", "test/calc.thrift", "test/config.ru", "test/gen-rb/calc.rb", "test/gen-rb/calc_constants.rb", "test/gen-rb/calc_types.rb", "test/helper.rb", "test/test_metadata.rb", "test/test_rack.rb", "test/test_rest.rb"]
+  s.homepage = "https://github.com/evanphx/stark-rack"
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = "stark-rack"
+  s.rubygems_version = "1.8.23"
+  s.summary = "Provides middleware for mounting Stark/Thrift services as Rack endpoints."
+  s.test_files = ["test/test_metadata.rb", "test/test_rack.rb", "test/test_rest.rb"]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<stark>, ["< 2.0.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 4.0"])
+      s.add_development_dependency(%q<rack>, [">= 1.5.0"])
+      s.add_development_dependency(%q<hoe>, ["~> 3.6"])
+    else
+      s.add_dependency(%q<stark>, ["< 2.0.0"])
+      s.add_dependency(%q<rdoc>, ["~> 4.0"])
+      s.add_dependency(%q<rack>, [">= 1.5.0"])
+      s.add_dependency(%q<hoe>, ["~> 3.6"])
+    end
+  else
+    s.add_dependency(%q<stark>, ["< 2.0.0"])
+    s.add_dependency(%q<rdoc>, ["~> 4.0"])
+    s.add_dependency(%q<rack>, [">= 1.5.0"])
+    s.add_dependency(%q<hoe>, ["~> 3.6"])
+  end
+end

data/test/calc-opt.rb

@@ -0,0 +1,31 @@
+module Calc
+  class Client
+    def add(lhs, rhs)
+      op = @oprot
+      op.write_message_begin 'add', ::Thrift::MessageTypes::CALL, 0
+      op.write_struct_begin "add_args"
+      op.write_field_begin 'lhs', ::Thrift::Types::I32, 1
+      op.write_i32 lhs
+      op.write_field_end
+      op.write_field_begin 'rhs', ::Thrift::Types::I32, 2
+      op.write_i32 rhs
+      op.write_field_end
+      op.write_field_stop
+      op.write_struct_end
+      op.write_message_end
+      op.trans.flush
+      ip = @iprot
+      fname, mtype, rseqid = ip.read_message_begin
+      handle_exception mtype
+      ip.read_struct_begin
+      rname, rtype, rid = ip.read_field_begin
+      result = ip.read_i32
+      rname, rtype, rid = ip.read_field_begin
+      fail if rtype != ::Thrift::Types::STOP
+      ip.read_field_end
+      ip.read_struct_end
+      ip.read_message_end
+      return result
+    end
+  end
+end

data/test/calc.thrift

@@ -0,0 +1,13 @@
+struct State {
+  1: i32 last_result
+  2: map<string,i32> vars
+}
+
+service Calc {
+  i32 add(1: i32 lhs, 2: i32 rhs)
+  i32 last_result()
+  void store_vars(1: map<string,i32> vars)
+  i32 get_var(1: string name)
+  void set_state(1: State state)
+  State get_state()
+}

data/test/config.ru

@@ -0,0 +1,19 @@
+require 'thrift/rack'
+
+$:.unshift File.expand_path("../gen-rb", __FILE__)
+
+require 'calc'
+
+class CalcImpl
+  def add(lhs, rhs)
+    lhs + rhs
+  end
+end
+
+impl = CalcImpl.new
+
+processor = Calc::Processor.new impl
+
+obj = Thrift::Rack.new processor
+
+run obj

data/test/gen-rb/calc.rb

@@ -0,0 +1,80 @@
+#
+# Autogenerated by Thrift Compiler (0.8.0)
+#
+# DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
+#
+
+require 'thrift'
+require 'calc_types'
+
+module Calc
+  class Client
+    include ::Thrift::Client
+
+    def add(lhs, rhs)
+      send_add(lhs, rhs)
+      return recv_add()
+    end
+
+    def send_add(lhs, rhs)
+      send_message('add', Add_args, :lhs => lhs, :rhs => rhs)
+    end
+
+    def recv_add()
+      result = receive_message(Add_result)
+      return result.success unless result.success.nil?
+      raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'add failed: unknown result')
+    end
+
+  end
+
+  class Processor
+    include ::Thrift::Processor
+
+    def process_add(seqid, iprot, oprot)
+      args = read_args(iprot, Add_args)
+      result = Add_result.new()
+      result.success = @handler.add(args.lhs, args.rhs)
+      write_result(result, oprot, 'add', seqid)
+    end
+
+  end
+
+  # HELPER FUNCTIONS AND STRUCTURES
+
+  class Add_args
+    include ::Thrift::Struct, ::Thrift::Struct_Union
+    LHS = 1
+    RHS = 2
+
+    FIELDS = {
+      LHS => {:type => ::Thrift::Types::I32, :name => 'lhs'},
+      RHS => {:type => ::Thrift::Types::I32, :name => 'rhs'}
+    }
+
+    def struct_fields; FIELDS; end
+
+    def validate
+    end
+
+    ::Thrift::Struct.generate_accessors self
+  end
+
+  class Add_result
+    include ::Thrift::Struct, ::Thrift::Struct_Union
+    SUCCESS = 0
+
+    FIELDS = {
+      SUCCESS => {:type => ::Thrift::Types::I32, :name => 'success'}
+    }
+
+    def struct_fields; FIELDS; end
+
+    def validate
+    end
+
+    ::Thrift::Struct.generate_accessors self
+  end
+
+end
+

data/test/gen-rb/calc_constants.rb

@@ -0,0 +1,8 @@
+#
+# Autogenerated by Thrift Compiler (0.8.0)
+#
+# DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
+#
+
+require 'calc_types'
+

data/test/gen-rb/calc_types.rb

@@ -0,0 +1,7 @@
+#
+# Autogenerated by Thrift Compiler (0.8.0)
+#
+# DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
+#
+
+

data/test/helper.rb

@@ -0,0 +1,60 @@
+module TestHelper
+  class Handler
+    def initialize(n)
+      @state = n::State.new
+    end
+    def add(a,b)
+      @state.last_result = a + b
+    end
+    def last_result
+      @state.last_result
+    end
+    def store_vars(hash)
+      @state.vars ||= {}
+      hash.each do |k,v|
+        @state.vars[k] = v.to_i
+      end
+    end
+    def get_var(name)
+      @state.vars[name]
+    end
+    def get_state
+      @state
+    end
+    def set_state(state)
+      @state = state
+    end
+  end
+
+  def setup
+    @n = Module.new
+
+    Stark.materialize File.expand_path("../calc.thrift", __FILE__), @n
+
+    @sr, @cw = IO.pipe
+    @cr, @sw = IO.pipe
+
+    @prev_logger = Stark.logger
+    @log_stream = StringIO.new
+    Stark.logger = Logger.new @log_stream
+
+    @client_t = Thrift::IOStreamTransport.new @cr, @cw
+    @client_p = Thrift::BinaryProtocol.new @client_t
+
+    @client = @n::Calc::Client.new @client_p, @client_p
+    @handler = Handler.new(@n)
+  end
+
+  def teardown
+    print @log_stream.string unless passed?
+    Stark.logger = @prev_logger
+
+    @client_t.close
+    @sr.close
+    @sw.close
+  end
+
+  def stark_rack
+    @stark_rack ||= Stark::Rack.new(@n::Calc::Processor.new(@handler), :log => false)
+  end
+end

data/test/test_metadata.rb

@@ -0,0 +1,43 @@
+require "test/unit"
+require "stark/rack"
+require "stark/rack/metadata"
+require "helper"
+
+class TestMetadata < Test::Unit::TestCase
+  include TestHelper
+
+  def setup
+    super
+    @metadata = { 'version' => '1.0 baby', 'name' => "This is a sweet service" }
+    @rack = Stark::Rack::Metadata.new stark_rack, @metadata
+  end
+
+  def test_call_to_metadata
+    @client = Stark::Rack::Metadata::Client.new @client_p, @client_p
+    st = Thread.new do
+      env = { 'rack.input' => @sr, 'PATH_INFO' => '/metadata', 'REQUEST_METHOD' => 'POST' }
+      code, headers, out = @rack.call env
+
+      out.each do |s|
+        @sw << s
+      end
+    end
+
+    assert_equal @metadata, @client.metadata
+  end
+
+  def test_call_add_passes_through_metadata
+    st = Thread.new do
+      env = { 'rack.input' => @sr, 'PATH_INFO' => '/', 'REQUEST_METHOD' => 'POST' }
+      code, headers, out = @rack.call env
+
+      out.each do |s|
+        @sw << s
+      end
+    end
+
+    result = @client.add 1, 1
+    assert_equal 2, result
+  end
+
+end

data/test/test_rack.rb

@@ -0,0 +1,65 @@
+require "test/unit"
+require "stark/rack"
+require "helper"
+
+class TestRack < Test::Unit::TestCase
+  include TestHelper
+
+
+  def test_call_to_thrift
+    st = Thread.new do
+      env = { 'rack.input' => @sr, 'REQUEST_METHOD' => 'POST' }
+      env['PATH_INFO'] = ''
+
+      code, headers, out = stark_rack.call env
+
+      out.each do |s|
+        @sw << s
+      end
+    end
+
+    out = @client.add 3, 4
+
+    assert_equal 7, out
+  end
+
+  def test_json_protocol
+    @client_p = Thrift::JsonProtocol.new @client_t
+    @client = @n::Calc::Client.new @client_p, @client_p
+
+    st = Thread.new do
+      env = { 'rack.input' => @sr, 'REQUEST_METHOD' => 'POST' }
+      env['PATH_INFO'] = ''
+      env['HTTP_CONTENT_TYPE'] = 'application/vnd.thrift+json'
+
+      code, headers, out = stark_rack.call env
+
+      out.each do |s|
+        @sw << s
+      end
+    end
+
+    out = @client.add 3, 4
+
+    assert_equal 7, out
+  end
+
+  def test_call_with_wrong_method
+    env = { 'REQUEST_METHOD' => 'GET' }
+    env['PATH_INFO'] = '/'
+
+    code, headers, out = stark_rack.call env
+
+    assert_equal 405, code
+  end
+
+  def test_call_to_undefined_url
+    env = { 'REQUEST_METHOD' => 'POST' }
+    env['PATH_INFO'] = '/blah'
+
+    code, headers, out = stark_rack.call env
+
+    assert_equal 404, code
+  end
+
+end

data/test/test_rest.rb

@@ -0,0 +1,175 @@
+require "test/unit"
+require "stark/rack"
+require "stark/rack/metadata"
+require "stark/rack/rest"
+require "helper"
+
+class TestREST < Test::Unit::TestCase
+  include TestHelper
+
+  def test_get_last_result
+    rack = Stark::Rack::REST.new stark_rack
+    @handler.add 2, 2
+
+    out = ['']
+    Thread.new do
+      env = {'rack.input' => StringIO.new, 'REQUEST_METHOD' => 'GET',
+        'PATH_INFO' => '/last_result', 'QUERY_STRING' => ''}
+
+      code, headers, out = rack.call env
+    end.join
+
+    json = '{"result":4}'
+    assert_equal json, out.join
+  end
+
+  def test_store_vars_with_single_arg_map
+    rack = Stark::Rack::REST.new stark_rack
+    Thread.new do
+      env = {'rack.input' => StringIO.new, 'REQUEST_METHOD' => 'GET',
+        'PATH_INFO' => '/store_vars', 'QUERY_STRING' => 'a=1&b=2&c=3'}
+
+      code, headers, out = rack.call env
+    end.join
+
+    assert_equal 1, @handler.get_var('a')
+    assert_equal 2, @handler.get_var('b')
+    assert_equal 3, @handler.get_var('c')
+  end
+
+  def test_add_with_arg_map
+    rack = Stark::Rack::REST.new stark_rack
+    @handler.store_vars 'a' => 42
+    out = ['']
+    Thread.new do
+      env = {'rack.input' => StringIO.new, 'REQUEST_METHOD' => 'GET',
+        'PATH_INFO' => '/add', 'QUERY_STRING' => 'arg[1]=1&arg[2]=1'}
+
+      code, headers, out = rack.call env
+    end.join
+
+    json = '{"result":2}'
+    assert_equal json, out.join
+  end
+
+  def test_add_with_arg_map_missing_an_argument
+    rack = Stark::Rack::REST.new stark_rack
+    @handler.store_vars 'a' => 42
+    out = ['']
+    Thread.new do
+      env = {'rack.input' => StringIO.new, 'REQUEST_METHOD' => 'GET',
+        'PATH_INFO' => '/add', 'QUERY_STRING' => 'arg[2]=1'}
+
+      code, headers, out = rack.call env
+    end.join
+
+    json = '{"error":"undefined method `+\' for nil:NilClass (NoMethodError)"}'
+    assert_equal json, out.join
+  end
+
+  def test_get_var_with_arg_map
+    rack = Stark::Rack::REST.new stark_rack
+    @handler.store_vars 'a' => 42
+    out = ['']
+    Thread.new do
+      env = {'rack.input' => StringIO.new, 'REQUEST_METHOD' => 'GET',
+        'PATH_INFO' => '/get_var', 'QUERY_STRING' => 'arg[1]=a'}
+
+      code, headers, out = rack.call env
+    end.join
+
+    json = '{"result":42}'
+    assert_equal json, out.join
+  end
+
+  def test_get_var_with_arg_array
+    rack = Stark::Rack::REST.new stark_rack
+    @handler.store_vars 'a' => 42
+    out = ['']
+    Thread.new do
+      env = {'rack.input' => StringIO.new, 'REQUEST_METHOD' => 'GET',
+        'PATH_INFO' => '/get_var', 'QUERY_STRING' => 'args[]=a'}
+
+      code, headers, out = rack.call env
+    end.join
+
+    json = '{"result":42}'
+    assert_equal json, out.join
+  end
+
+  def test_get_state
+    rack = Stark::Rack::REST.new stark_rack
+    @handler.store_vars 'a' => 42
+    @handler.add 2, 2
+    out = ['']
+    Thread.new do
+      env = {'rack.input' => StringIO.new, 'REQUEST_METHOD' => 'GET',
+        'PATH_INFO' => '/get_state', 'QUERY_STRING' => ''}
+
+      code, headers, out = rack.call env
+    end.join
+
+    json = '{"result":{"_struct_":"State","1:last_result":4,"2:vars":{"a":42}}}'
+    assert_equal json, out.join
+  end
+
+  def test_set_state_with_GET
+    rack = Stark::Rack::REST.new stark_rack
+    Thread.new do
+      env = {'rack.input' => StringIO.new, 'REQUEST_METHOD' => 'GET',
+        'PATH_INFO' => '/set_state',
+        'QUERY_STRING' => '_struct_=State&1-last_result=0&2-vars[a]=1&2-vars[b]=2'}
+
+      code, headers, out = rack.call env
+    end.join
+
+    assert_equal 0, @handler.last_result
+    assert_equal 1, @handler.get_var('a')
+    assert_equal 2, @handler.get_var('b')
+  end
+
+  def test_set_state_with_json_POST
+    rack = Stark::Rack::REST.new stark_rack
+    Thread.new do
+      env = {'rack.input' => StringIO.new('[{"_struct_":"State","1:last_result":0,"2:vars":{"a":1,"b":2}}]'),
+        'REQUEST_METHOD' => 'POST', 'PATH_INFO' => '/set_state',
+        'HTTP_CONTENT_TYPE' => 'application/json' }
+
+      code, headers, out = rack.call env
+    end.join
+
+    assert_equal 0, @handler.last_result
+    assert_equal 1, @handler.get_var('a')
+    assert_equal 2, @handler.get_var('b')
+  end
+
+  def test_set_state_json_bad_request
+    rack = Stark::Rack::REST.new stark_rack
+    code = headers = out = nil
+    Thread.new do
+      env = {'rack.input' => StringIO.new('42'),
+        'REQUEST_METHOD' => 'POST', 'PATH_INFO' => '/set_state',
+        'HTTP_CONTENT_TYPE' => 'application/json' }
+
+      code, headers, out = rack.call env
+    end.join
+
+    assert_equal 400, code
+  end
+
+  def test_get_metadata
+    metadata = { 'version' => '1.0 baby', 'name' => "This is a sweet service" }
+    rack = Stark::Rack::REST.new Stark::Rack::Metadata.new(stark_rack, metadata)
+
+    out = ['']
+    Thread.new do
+      env = {'rack.input' => StringIO.new, 'REQUEST_METHOD' => 'GET',
+        'PATH_INFO' => '/metadata', 'QUERY_STRING' => ''}
+
+      code, headers, out = rack.call env
+    end.join
+
+    json = '{"result":{"version":"1.0 baby","name":"This is a sweet service"}}'
+    assert_equal json, out.join
+  end
+end