alice 0.1.0 → 0.1.1

data/README.rdoc

@@ -9,17 +9,17 @@ question is, Who in the world am I?
 
 == Usage
 
-  conn = Alice::Connection.new(:url => 'http://sushi.com') do
-    use Alice::Request::Yajl     # convert body to json with Yajl lib
-    use Alice::Adapter::Logger   # log the request somewhere?
-    use Alice::Adapter::Typhoeus # make http request with typhoeus
-    use Alice::Response::Yajl    # # parse body with yajl
+  conn = Alice::Connection.new(:url => 'http://sushi.com') do |builder|
+    builder.use Alice::Request::Yajl     # convert body to json with Yajl lib
+    builder.use Alice::Adapter::Logger   # log the request somewhere?
+    builder.use Alice::Adapter::Typhoeus # make http request with typhoeus
+    builder.use Alice::Response::Yajl    # # parse body with yajl
 
     # or use shortcuts
-    request  :yajl     # Alice::Request::Yajl
-    adapter  :logger   # Alice::Adapter::Logger
-    adapter  :typhoeus # Alice::Adapter::Typhoeus
-    response :yajl     # Alice::Response::Yajl
+    builder.request  :yajl     # Alice::Request::Yajl
+    builder.adapter  :logger   # Alice::Adapter::Logger
+    builder.adapter  :typhoeus # Alice::Adapter::Typhoeus
+    builder.response :yajl     # Alice::Response::Yajl
   end
 
   resp1 = conn.get '/nigiri/sake.json'
@@ -31,16 +31,30 @@ question is, Who in the world am I?
 
 == Testing
 
-  test = Alice::Connection.new do
-    adapter :test do |stub|
-      stub.get '/nigiri/sake.json' do
-        [200, {}, 'hi world']
-      end
+  # It's possible to define stubbed request outside a test adapter block.
+  stubs = Alice::Test::Stubs.new do |stub|
+    stub.get('/tamago') { [200, 'egg', {} }
+  end
+
+  # You can pass stubbed request to the test adapter or define them in a block
+  # or a combination of the two.
+  test = Alice::Connection.new do |builder|
+    builder.adapter :test, stubs do |stub|
+      stub.get('/ebi') {[ 200, 'shrimp', {} ]}
     end
   end
 
-  resp = test.get '/nigiri/sake.json'
-  resp.body # => 'hi world'
+  # It's also possible to stub additional requests after the connection has
+  # been initialized. This is useful for testing.
+  stubs.get('/uni') {[ 200, 'urchin', {} ]}
+
+  resp = test.get '/tamago'
+  resp.body # => 'egg'
+  resp = test.get '/ebi'
+  resp.body # => 'shrimp'
+  resp = test.get '/uni'
+  resp.body # => 'urchin'
+  resp = test.get '/else' #=> raises "no such stub" error
 
 == Note on Patches/Pull Requests
  

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/alice.gemspec

@@ -0,0 +1,87 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{alice}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["rick"]
+  s.date = %q{2010-01-07}
+  s.description = %q{HTTP/REST API client library using Rack-like middleware}
+  s.email = %q{technoweenie@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "alice.gemspec",
+     "lib/alice.rb",
+     "lib/alice/adapter/net_http.rb",
+     "lib/alice/adapter/patron.rb",
+     "lib/alice/adapter/test.rb",
+     "lib/alice/adapter/typhoeus.rb",
+     "lib/alice/builder.rb",
+     "lib/alice/connection.rb",
+     "lib/alice/error.rb",
+     "lib/alice/middleware.rb",
+     "lib/alice/request.rb",
+     "lib/alice/request/active_support_json.rb",
+     "lib/alice/request/yajl.rb",
+     "lib/alice/response.rb",
+     "lib/alice/response/active_support_json.rb",
+     "lib/alice/response/yajl.rb",
+     "test/adapters/live_test.rb",
+     "test/adapters/test_middleware_test.rb",
+     "test/adapters/typhoeus_test.rb",
+     "test/connection_app_test.rb",
+     "test/connection_test.rb",
+     "test/env_test.rb",
+     "test/helper.rb",
+     "test/live_server.rb",
+     "test/request_middleware_test.rb",
+     "test/response_middleware_test.rb"
+  ]
+  s.homepage = %q{http://github.com/technoweenie/alice}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{HTTP/REST API client library using Rack-like middleware}
+  s.test_files = [
+    "test/adapters/live_test.rb",
+     "test/adapters/test_middleware_test.rb",
+     "test/adapters/typhoeus_test.rb",
+     "test/connection_app_test.rb",
+     "test/connection_test.rb",
+     "test/env_test.rb",
+     "test/helper.rb",
+     "test/live_server.rb",
+     "test/request_middleware_test.rb",
+     "test/response_middleware_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rack>, [">= 0"])
+      s.add_runtime_dependency(%q<addressable>, [">= 0"])
+    else
+      s.add_dependency(%q<rack>, [">= 0"])
+      s.add_dependency(%q<addressable>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rack>, [">= 0"])
+    s.add_dependency(%q<addressable>, [">= 0"])
+  end
+end
+

data/lib/alice/adapter/test.rb

@@ -12,6 +12,8 @@ module Alice
     # resp.body # => 'hi world'
     #
     class Test < Middleware
+      attr_accessor :stubs
+
       def self.loaded?() false end
 
       class Stubs
@@ -25,44 +27,46 @@ module Alice
           @stack.empty?
         end
 
-        def match(request_method, path)
+        def match(request_method, path, body)
           return false if !@stack.key?(request_method)
-          @stack[request_method].detect { |stub| stub.matches?(path) }
+          stub = @stack[request_method].detect { |stub| stub.matches?(path, body) }
+          @stack[request_method].delete stub
         end
 
         def get(path, &block)
-          new_stub(:get, path, block)
+          new_stub(:get, path, &block)
         end
 
         def head(path, &block)
-          new_stub(:head, path, block)
+          new_stub(:head, path, &block)
         end
 
-        def post(path, &block)
-          new_stub(:post, path, block)
+        def post(path, body, &block)
+          new_stub(:post, path, body, &block)
         end
 
-        def put(path, &block)
-          new_stub(:put, path, block)
+        def put(path, body, &block)
+          new_stub(:put, path, body, &block)
         end
 
         def delete(path, &block)
-          new_stub(:delete, path, block)
+          new_stub(:delete, path, &block)
         end
 
-        def new_stub(request_method, path, block)
-          (@stack[request_method] ||= []) << Stub.new(path, block)
+        def new_stub(request_method, path, body=nil, &block)
+          (@stack[request_method] ||= []) << Stub.new(path, body, block)
         end
       end
 
-      class Stub < Struct.new(:path, :block)
-        def matches?(request_path)
-          request_path == path
+      class Stub < Struct.new(:path, :body, :block)
+        def matches?(request_path, request_body)
+          request_path == path && request_body == body
         end
       end
 
-      def initialize app, &block
+      def initialize app, stubs=nil, &block
         super(app)
+        @stubs = stubs || Stubs.new
         configure(&block) if block
       end
 
@@ -70,25 +74,18 @@ module Alice
         yield stubs
       end
 
-      def stubs
-        @stubs ||= Stubs.new
-      end
-
       def call(env)
-        if stub = stubs.match(env[:method], env[:url].path)
+        if stub = stubs.match(env[:method], env[:url].path, env[:body])
           status, headers, body = stub.block.call(env)
           env.update \
             :status           => status,
             :response_headers => headers,
             :body             => body
         else
-          env.update \
-            :status           => 404,
-            :response_headers => {},
-            :body             => 'no stubbed requests'
+          raise "no stubbed request for #{env[:method]} #{env[:url].path} with #{env[:body]}"
         end
         @app.call(env)
       end
     end
   end
-end
+end

data/lib/alice/builder.rb

@@ -1,5 +1,3 @@
-require 'rack/builder'
-
 module Alice
   # Possibly going to extend this a bit.
   #
@@ -8,7 +6,9 @@ module Alice
   #   adapter  :logger   # Alice::Adapter::Logger
   #   response :yajl     # Alice::Response::Yajl
   # end
-  class Builder < Rack::Builder
+  class Builder
+    attr_accessor :handlers
+
     def self.create_with_inner_app(&block)
       inner = lambda do |env| 
         if !env[:parallel_manager]
@@ -20,6 +20,24 @@ module Alice
       Builder.new(&block).tap { |builder| builder.run(inner) }
     end
 
+    def initialize
+      @handlers = []
+      yield self
+    end
+
+    def run app
+      @handlers.unshift app
+    end
+
+    def to_app
+      inner_app = @handlers.first
+      @handlers[1..-1].inject(inner_app) { |app, middleware| middleware.call(app) }
+    end
+
+    def use klass, *args, &block
+      @handlers.unshift(lambda { |app| klass.new(app, *args, &block) })
+    end
+
     def request(key, *args, &block)
       use_symbol Alice::Request, key, *args, &block
     end
@@ -36,4 +54,4 @@ module Alice
       use mod.lookup_module(key), *args, &block
     end
   end
-end
+end

data/lib/alice/response.rb

@@ -19,6 +19,7 @@ module Alice
     end
 
     extend AutoloadHelper
+
     autoload_all 'alice/response',
       :Yajl              => 'yajl',
       :ActiveSupportJson => 'active_support_json'

data/test/adapters/test_middleware_test.rb

@@ -4,11 +4,11 @@ module Adapters
   class TestMiddleware < Alice::TestCase
     describe "Test Middleware with simple path" do
       before :all do
-        @conn = Alice::Connection.new do
-          adapter :test do |stub|
-            stub.get('/hello') { [200, {'Content-Type' => 'text/html'}, 'hello'] }
-          end
+        @stubs = Alice::Adapter::Test::Stubs.new
+        @conn  = Alice::Connection.new do |builder|
+          builder.adapter :test, @stubs
         end
+        @stubs.get('/hello') { [200, {'Content-Type' => 'text/html'}, 'hello'] }
         @resp = @conn.get('/hello')
       end
 
@@ -25,4 +25,4 @@ module Adapters
       end
     end
   end
-end
+end

data/test/connection_app_test.rb

@@ -23,24 +23,21 @@ class TestConnectionApps < Alice::TestCase
   end
 
   before do
-    @conn = Alice::Connection.new do
-      use TestMiddleWare
-      use TestAdapter
-    end
-    class << @conn.builder
-      attr_reader :ins
+    @conn = Alice::Connection.new do |b|
+      b.use TestMiddleWare
+      b.use TestAdapter
     end
   end
 
   describe "#builder" do
     it "is built from Alice::Connection constructor" do
-      assert_kind_of Rack::Builder, @conn.builder
-      assert_equal 3, @conn.builder.ins.size
+      assert_kind_of Alice::Builder, @conn.builder
+      assert_equal 3, @conn.builder.handlers.size
     end
 
     it "adds middleware to the Builder stack" do
-      assert_kind_of TestMiddleWare, @conn.builder.ins[0].call(nil)
-      assert_kind_of TestAdapter,    @conn.builder.ins[1].call(nil)
+      assert_kind_of TestMiddleWare, @conn.builder.handlers[2].call(nil)
+      assert_kind_of TestAdapter,    @conn.builder.handlers[1].call(nil)
     end
   end
 

data/test/request_middleware_test.rb

@@ -6,9 +6,9 @@ class RequestMiddlewareTest < Alice::TestCase
       encoder = Alice::Request.lookup_module(key)
       next if !encoder.loaded?
       it "uses #{encoder}" do
-        @connection = Alice::Connection.new do
-          use encoder
-          adapter :test do |stub|
+        @connection = Alice::Connection.new do |b|
+          b.use encoder
+          b.adapter :test do |stub|
             stub.post('echo_body') { |env| [200, {'Content-Type' => 'text/html'}, env[:body]] }
           end
         end
@@ -16,4 +16,4 @@ class RequestMiddlewareTest < Alice::TestCase
       end
     end
   end
-end
+end

data/test/response_middleware_test.rb

@@ -6,14 +6,14 @@ class ResponseMiddlewareTest < Alice::TestCase
       parser = Alice::Response.lookup_module(key)
       next if !parser.loaded?
       it "uses #{parser}" do
-        @connection = Alice::Connection.new do
-          adapter :test do |stub|
+        @connection = Alice::Connection.new do |b|
+          b.adapter :test do |stub|
             stub.get('json') { [200, {'Content-Type' => 'text/html'}, "[1,2,3]"] }
           end
-          use parser
+          b.use parser
         end
         assert_equal [1,2,3], @connection.get('json').body
       end
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: alice
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - rick
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-03 00:00:00 -08:00
+date: 2010-01-07 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -48,6 +48,7 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- alice.gemspec
 - lib/alice.rb
 - lib/alice/adapter/net_http.rb
 - lib/alice/adapter/patron.rb