apidoc 0.1.2 → 0.1.3

data/spec/apidoc_spec.rb

@@ -1,18 +1,7 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-require 'sinatra/base'
 
 describe ApiDoc do
   before do
-    class TestApp < Sinatra::Base
-      get '/tacos.json' do
-        JSON.generate [ { meat: 'beef' }, { meat: 'chicken' } ]
-      end
-
-      post '/tacos.json' do
-        request.body
-      end
-    end
-
     @doc = ApiDoc.new(TestApp) do
       get '/tacos.json' do
         desc "Get all tacos"
@@ -37,127 +26,8 @@ describe ApiDoc do
     its(:response_body) { should == JSON.generate([ { meat: 'beef' }, { meat: 'chicken' } ]) }
   end
 
-  describe "when writing to HTML" do
-    subject do
-      stream = StringIO.new
-      ApiDoc::HtmlWriter.new(@doc).write(stream)
-      stream.read
-    end
-
-    it "should write the request method" do
-      subject.should include('GET')
-    end
-
-    it "should write the request path" do
-      subject.should include("/tacos.json")
-    end
-
-    it "should write the response body" do
-      subject.should include('meat')
-    end
-
-    describe "when accepting JSON as input" do
-      before do
-        @doc = ApiDoc.new(TestApp) do
-          post '/tacos.json' do
-            desc "Make a new delicious taco"
-            accept :json
-            params do
-              JSON.generate({ meat: 'beef', lettuce: true })
-            end
-          end
-        end
-
-        @doc.run
-      end
-
-      subject do
-        stream = StringIO.new
-        ApiDoc::HtmlWriter.new(@doc).write(stream)
-        stream.read
-      end
-
-      it "should pretty-print the JSON data in the IN section" do
-        subject.should include("{\n  &quot;meat&quot;: &quot;beef&quot;,\n  &quot;lettuce&quot;: true\n}")
-      end
-    end
-
-    describe "when setting the default accept and content type" do
-      before do
-        @doc = ApiDoc.new(TestApp) do
-          accept :json
-          content_type :json
-
-          post '/tacos.json' do
-            desc "Make a new delicious taco"
-            params do
-              JSON.generate({ meat: 'beef', lettuce: true })
-            end
-          end
-        end
-
-        @doc.run
-      end
-
-      subject { @doc }
-
-      it "should propagate the accept type to its resources" do
-        @doc.resources.first.accept.should == :json
-      end
-
-      it "should propagate the content type to its resources" do
-        @doc.resources.first.content_type.should == :json
-      end
-    end
-
-    describe "when providing JSON as output" do
-      before do
-        @doc = ApiDoc.new(TestApp) do
-          post '/tacos.json' do
-            desc "Make a new delicious taco"
-            content_type :json
-            params do
-              JSON.generate({ meat: 'beef', lettuce: true })
-            end
-          end
-        end
-
-        @doc.run
-      end
-
-      subject do
-        stream = StringIO.new
-        ApiDoc::HtmlWriter.new(@doc).write(stream)
-        stream.read
-      end
-
-      it "should pretty-print the JSON data in the OUT section" do
-        subject.should include("{\n  &quot;meat&quot;: &quot;beef&quot;,\n  &quot;lettuce&quot;: true\n}")
-      end
-    end
-
-  end
-
   describe "different request methods" do
     before do
-      class RequestMethodsApp < Sinatra::Base
-        get '/get.json' do
-          JSON.generate({ method: 'GET' })
-        end
-        post '/post.json' do
-          JSON.generate({ method: 'POST' })
-        end
-        put '/put.json' do
-          JSON.generate({ method: 'PUT' })
-        end
-        delete '/delete.json' do
-          JSON.generate({ method: 'DELETE' })
-        end
-        options '/options.json' do
-          JSON.generate({ method: 'OPTIONS' })
-        end
-      end
-
       @doc = ApiDoc.new(RequestMethodsApp) do
         get '/get.json' do
           desc "a get request"
@@ -191,9 +61,11 @@ describe ApiDoc do
     before do
       @doc = ApiDoc.new(TestApp) do
         post '/tacos.json' do
+          accept :json
+          content_type :json
           desc "Make a new delicious taco"
           params do
-            JSON.generate({ meat: 'beef', lettuce: true })
+            { meat: 'beef', lettuce: true }
           end
         end
       end
@@ -203,208 +75,32 @@ describe ApiDoc do
 
     subject { @doc.resources.first }
 
-    its(:params) { should == JSON.generate({ meat: 'beef', lettuce: true }) }
-    its(:response_body) { should == JSON.generate({ meat: 'beef', lettuce: true }) }
-  end
-
-  describe "when specifying a global before block" do
-    before do
-      $var = 0
-      @doc = ApiDoc.new(TestApp) do
-        before do
-          $var += 1
-        end
-
-        get '/tacos.json' do
-          desc "Get all tacos as JSON"
-        end
-
-        get '/tacos.xml' do
-          desc "Get all tacos as XML"
-        end
-      end
-
-      @doc.run
-    end
-
-    it "should have run the before block twice, once for each resource" do
-      $var.should == 2
-    end
+    its(:params) { should == { meat: 'beef', lettuce: true } }
+    its(:response_body) { should == JSON.pretty_generate({ meat: 'beef', lettuce: true }) }
   end
 
-  describe "when specifying a global before each block" do
+  describe "when specifying a request with an interpolated path" do
     before do
-      $var = 0
       @doc = ApiDoc.new(TestApp) do
-        before :each do
-          $var += 1
-        end
-
-        get '/tacos.json' do
-          desc "Get all tacos as JSON"
-        end
-
-        get '/tacos.xml' do
-          desc "Get all tacos as XML"
-        end
-      end
-
-      @doc.run
-    end
-
-    it "should have run the before block twice, once for each resource" do
-      $var.should == 2
-    end
-  end
-
-  describe "when specifying a global before all block" do
-    before do
-      $var = 0
-      @doc = ApiDoc.new(TestApp) do
-        before :all do
-          $var += 1
-        end
-
-        get '/tacos.json' do
-          desc "Get all tacos as JSON"
-        end
-
-        get '/tacos.xml' do
-          desc "Get all tacos as XML"
-        end
-      end
-
-      @doc.run
-    end
-
-    it "should have run the before block once and only once" do
-      $var.should == 1
-    end
-  end
-
-  describe "when specifying a global after block" do
-    before do
-      $var = 0
-      @doc = ApiDoc.new(TestApp) do
-        after do
-          $var += 1
-        end
-
-        get '/tacos.json' do
-          desc "Get all tacos as JSON"
-        end
-
-        get '/tacos.xml' do
-          desc "Get all tacos as XML"
-        end
-      end
-
-      @doc.run
-    end
-
-    it "should have run the after block twice, once for each resource" do
-      $var.should == 2
-    end
-  end
-
-  describe "when specifying a global after each block" do
-    before do
-      $var = 0
-      @doc = ApiDoc.new(TestApp) do
-        after :each do
-          $var += 1
-        end
-
-        get '/tacos.json' do
-          desc "Get all tacos as JSON"
-        end
-
-        get '/tacos.xml' do
-          desc "Get all tacos as XML"
-        end
-      end
-
-      @doc.run
-    end
-
-    it "should have run the after block twice, once for each resource" do
-      $var.should == 2
-    end
-  end
-
-  describe "when specifying a global after all block" do
-    before do
-      $var = 0
-      @doc = ApiDoc.new(TestApp) do
-        after :all do
-          $var += 1
-        end
-
-        get '/tacos.json' do
-          desc "Get all tacos as JSON"
-        end
-
-        get '/tacos.xml' do
-          desc "Get all tacos as XML"
-        end
-      end
-
-      @doc.run
-    end
-
-    it "should have run the after block once and only once" do
-      $var.should == 1
-    end
-  end
-
-  describe "when specifying a resource-specific before block" do
-    before do
-      $var = 0
-      @doc = ApiDoc.new(TestApp) do
-        get '/tacos.json' do
-          desc "Get all tacos as JSON"
-          before do
-            $var += 1
+        get '/tacos/:id.json' do
+          accept :json
+          content_type :json
+          desc "Get a specific taco by its ID"
+          params do
+            { id: 123 }
           end
         end
-
-        get '/tacos.xml' do
-          desc "Get all tacos as XML"
-        end
       end
 
       @doc.run
     end
 
-    it "should only run the before block for its resource" do
-      $var.should == 1
-    end
-  end
-
-  describe "when specifying a resource-specific after block" do
-    before do
-      $var = 0
-      @doc = ApiDoc.new(TestApp) do
-        get '/tacos.json' do
-          desc "Get all tacos as JSON"
-          after do
-            $var += 1
-          end
-        end
-
-        get '/tacos.xml' do
-          desc "Get all tacos as XML"
-        end
-      end
-
-      @doc.run
-    end
+    subject { @doc.resources.first }
 
-    it "should only run the before block for its resource" do
-      $var.should == 1
-    end
+    its(:path) { should == '/tacos/:id.json' }
+    its(:params) { should == { id: 123 } }
+    its(:response_body) { should == JSON.generate({ meat: 'beef', id: '123' }) }
   end
 
-
 end
 

data/spec/before_and_after_spec.rb

@@ -0,0 +1,203 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "before and after blocks" do
+
+  describe "when specifying a global before block" do
+    before do
+      $var = 0
+      @doc = ApiDoc.new(TestApp) do
+        before do
+          $var += 1
+        end
+
+        get '/tacos.json' do
+          desc "Get all tacos as JSON"
+        end
+
+        get '/tacos.xml' do
+          desc "Get all tacos as XML"
+        end
+      end
+
+      @doc.run
+    end
+
+    it "should have run the before block twice, once for each resource" do
+      $var.should == 2
+    end
+  end
+
+  describe "when specifying a global before each block" do
+    before do
+      $var = 0
+      @doc = ApiDoc.new(TestApp) do
+        before :each do
+          $var += 1
+        end
+
+        get '/tacos.json' do
+          desc "Get all tacos as JSON"
+        end
+
+        get '/tacos.xml' do
+          desc "Get all tacos as XML"
+        end
+      end
+
+      @doc.run
+    end
+
+    it "should have run the before block twice, once for each resource" do
+      $var.should == 2
+    end
+  end
+
+  describe "when specifying a global before all block" do
+    before do
+      $var = 0
+      @doc = ApiDoc.new(TestApp) do
+        before :all do
+          $var += 1
+        end
+
+        get '/tacos.json' do
+          desc "Get all tacos as JSON"
+        end
+
+        get '/tacos.xml' do
+          desc "Get all tacos as XML"
+        end
+      end
+
+      @doc.run
+    end
+
+    it "should have run the before block once and only once" do
+      $var.should == 1
+    end
+  end
+
+  describe "when specifying a global after block" do
+    before do
+      $var = 0
+      @doc = ApiDoc.new(TestApp) do
+        after do
+          $var += 1
+        end
+
+        get '/tacos.json' do
+          desc "Get all tacos as JSON"
+        end
+
+        get '/tacos.xml' do
+          desc "Get all tacos as XML"
+        end
+      end
+
+      @doc.run
+    end
+
+    it "should have run the after block twice, once for each resource" do
+      $var.should == 2
+    end
+  end
+
+  describe "when specifying a global after each block" do
+    before do
+      $var = 0
+      @doc = ApiDoc.new(TestApp) do
+        after :each do
+          $var += 1
+        end
+
+        get '/tacos.json' do
+          desc "Get all tacos as JSON"
+        end
+
+        get '/tacos.xml' do
+          desc "Get all tacos as XML"
+        end
+      end
+
+      @doc.run
+    end
+
+    it "should have run the after block twice, once for each resource" do
+      $var.should == 2
+    end
+  end
+
+  describe "when specifying a global after all block" do
+    before do
+      $var = 0
+      @doc = ApiDoc.new(TestApp) do
+        after :all do
+          $var += 1
+        end
+
+        get '/tacos.json' do
+          desc "Get all tacos as JSON"
+        end
+
+        get '/tacos.xml' do
+          desc "Get all tacos as XML"
+        end
+      end
+
+      @doc.run
+    end
+
+    it "should have run the after block once and only once" do
+      $var.should == 1
+    end
+  end
+
+  describe "when specifying a resource-specific before block" do
+    before do
+      $var = 0
+      @doc = ApiDoc.new(TestApp) do
+        get '/tacos.json' do
+          desc "Get all tacos as JSON"
+          before do
+            $var += 1
+          end
+        end
+
+        get '/tacos.xml' do
+          desc "Get all tacos as XML"
+        end
+      end
+
+      @doc.run
+    end
+
+    it "should only run the before block for its resource" do
+      $var.should == 1
+    end
+  end
+
+  describe "when specifying a resource-specific after block" do
+    before do
+      $var = 0
+      @doc = ApiDoc.new(TestApp) do
+        get '/tacos.json' do
+          desc "Get all tacos as JSON"
+          after do
+            $var += 1
+          end
+        end
+
+        get '/tacos.xml' do
+          desc "Get all tacos as XML"
+        end
+      end
+
+      @doc.run
+    end
+
+    it "should only run the before block for its resource" do
+      $var.should == 1
+    end
+  end
+
+end