apidoc 0.1.0 → 0.1.1

data/Gemfile.lock

@@ -27,9 +27,9 @@ GEM
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.8.0)
     sinatra (1.3.2)
-      rack (>= 1.3.6, ~> 1.3)
+      rack (~> 1.3, >= 1.3.6)
       rack-protection (~> 1.2)
-      tilt (>= 1.3.3, ~> 1.3)
+      tilt (~> 1.3, >= 1.3.3)
     thor (0.15.2)
     tilt (1.3.3)
 

data/README.rdoc

@@ -9,10 +9,8 @@ stumbled upon http://apiary.io. While I appreciate the motivation for this
 project, I really wanted an API documentation tool that is:
 
 1. Example based: Show me what a _real_ request looks like with _real_ data.
-2. Self-testing and replicable: Build API documentation as part of your CI build, and know
-it's up-to-date because it ran real requests against your application.
-3. Minimalist: `apidoc` is designed to make requests using the content type of
-your choice and display the request, response and a short description. Nothing more. 
+2. Self-testing and replicable: Build API documentation as part of your CI build, and know it's up-to-date because it ran real requests against your application.
+3. Minimalist: `apidoc` is designed to make requests using the content type of your choice and display the request, response and a short description. Nothing more. 
 
 
 == Install

data/VERSION

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

data/apidoc.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "apidoc"
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["T.J. VanSlyke"]
-  s.date = "2012-06-03"
+  s.date = "2012-06-04"
   s.description = "Minimalist API documentation generator for Rack applications."
   s.email = "tj@turing.com"
   s.executables = ["apidoc"]

data/lib/apidoc.rb

@@ -17,13 +17,17 @@ module ApiDoc
 
   class Runner
     def initialize(&block)
-      @resources = []
-      @accept    = nil
-      @content_type = nil
+      @resources          = []
+      @accept             = nil
+      @content_type       = nil
+      @before_each_blocks = []
+      @before_all_blocks  = []
+      @after_each_blocks  = []
+      @after_all_blocks   = []
       Blueprint.new self, &block
     end
 
-    attr_accessor :resources, :accept, :content_type
+    attr_accessor :resources, :accept, :content_type, :before_each_blocks, :before_all_blocks, :after_each_blocks, :after_all_blocks
 
     class Blueprint
       def initialize(runner, &block)
@@ -35,6 +39,24 @@ module ApiDoc
         @runner.accept = type
       end
 
+      def before(type=:each, &block)
+        case type
+        when :each
+          @runner.before_each_blocks << block
+        when :all
+          @runner.before_all_blocks << block
+        end
+      end
+
+      def after(type=:each, &block)
+        case type
+        when :each
+          @runner.after_each_blocks << block
+        when :all
+          @runner.after_all_blocks << block
+        end
+      end
+
       def content_type(type)
         @runner.content_type = type
       end
@@ -61,7 +83,13 @@ module ApiDoc
     end
 
     def run
-      @resources.each(&:run)
+      @before_all_blocks.each {|block| block.call}
+      @resources.each do |resource|
+        @before_each_blocks.each {|block| block.call}
+        resource.run
+        @after_each_blocks.each {|block| block.call}
+      end
+      @after_all_blocks.each {|block| block.call}
     end
   end
 
@@ -121,10 +149,12 @@ module ApiDoc
       @runner = runner
       @path = path
       @params = nil
+      @before_blocks = []
+      @after_blocks = []
       Blueprint.new self, &block
     end
 
-    attr_accessor :path, :method, :setup, :params, :desc
+    attr_accessor :path, :method, :params, :desc, :before_blocks, :after_blocks
     attr_writer :accept, :content_type
 
     class Blueprint
@@ -149,8 +179,12 @@ module ApiDoc
         @resource.params = block
       end
 
-      def setup(&block)
-        @resource.setup = block
+      def before(&block)
+        @resource.before_blocks << block
+      end
+
+      def after(&block)
+        @resource.after_blocks << block
       end
     end
 
@@ -169,11 +203,10 @@ module ApiDoc
     end
 
     def run
-      if @setup
-        instance_eval &@setup
-      end
+      @before_blocks.each {|block| instance_eval &block }
       @params = @params.call if @params.is_a?(Proc)
       @response = make_request(@path, @params)
+      @after_blocks.each {|block| instance_eval &block }
     end
 
     def response_body

data/spec/apidoc_spec.rb

@@ -207,5 +207,204 @@ describe ApiDoc do
     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
+  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
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apidoc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-03 00:00:00.000000000Z
+date: 2012-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70176282425060 !ruby/object:Gem::Requirement
+  requirement: &70350038658700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70176282425060
+  version_requirements: *70350038658700
 - !ruby/object:Gem::Dependency
   name: mustache
-  requirement: &70176282424240 !ruby/object:Gem::Requirement
+  requirement: &70350038681100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70176282424240
+  version_requirements: *70350038681100
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70176282423620 !ruby/object:Gem::Requirement
+  requirement: &70350038680340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70176282423620
+  version_requirements: *70350038680340
 - !ruby/object:Gem::Dependency
   name: mustache
-  requirement: &70176282410920 !ruby/object:Gem::Requirement
+  requirement: &70350038679720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70176282410920
+  version_requirements: *70350038679720
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70176282410100 !ruby/object:Gem::Requirement
+  requirement: &70350038679140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *70176282410100
+  version_requirements: *70350038679140
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70176282409460 !ruby/object:Gem::Requirement
+  requirement: &70350038678540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *70176282409460
+  version_requirements: *70350038678540
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70176282408660 !ruby/object:Gem::Requirement
+  requirement: &70350038678040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70176282408660
+  version_requirements: *70350038678040
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70176282407880 !ruby/object:Gem::Requirement
+  requirement: &70350038677520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *70176282407880
+  version_requirements: *70350038677520
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70176282407180 !ruby/object:Gem::Requirement
+  requirement: &70350038676880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70176282407180
+  version_requirements: *70350038676880
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70176282406500 !ruby/object:Gem::Requirement
+  requirement: &70350038676280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,7 +120,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70176282406500
+  version_requirements: *70350038676280
 description: Minimalist API documentation generator for Rack applications.
 email: tj@turing.com
 executables:
@@ -167,7 +167,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1506073471830786691
+      hash: 1447906958388022363
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: