apical 0.1.4

data/spec/before_and_after_spec.rb

@@ -0,0 +1,211 @@
+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 = Apical.new do
+        adapter :rack, app: TestApp
+        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 = Apical.new do
+        adapter :rack, app: TestApp
+        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 = Apical.new do
+        adapter :rack, app: TestApp
+        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 = Apical.new do
+        adapter :rack, app: TestApp
+        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 = Apical.new do
+        adapter :rack, app: TestApp
+        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 = Apical.new do
+        adapter :rack, app: TestApp
+        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 = Apical.new do
+        adapter :rack, app: TestApp
+        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 = Apical.new do
+        adapter :rack, app: TestApp
+        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

data/spec/fixtures/cli_example_1.rb

@@ -0,0 +1,7 @@
+adapter :rack, app: ExampleApp
+name "CLI Example API"
+desc "This is an example. So don't tread on me, foo."
+
+get "/example.json" do
+  desc "An example get resource"
+end

data/spec/fixtures/cli_example_2.rb

@@ -0,0 +1,8 @@
+name "CLI Example API"
+desc "This is an example. So don't tread on me, foo."
+
+adapter :rack, app: ExampleApp
+
+get "/example.json" do
+  desc "An example get resource"
+end

data/spec/fixtures/example_require.rb

@@ -0,0 +1,3 @@
+
+$required = true 
+

data/spec/fixtures/load_paths_example.apical

@@ -0,0 +1 @@
+require 'example_require'

data/spec/html_writer_spec.rb

@@ -0,0 +1,117 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Apical::HtmlWriter do
+  before do
+    @doc = Apical.new do
+      adapter :rack, app: TestApp
+      get '/tacos.json' do
+        desc "Get all tacos"
+      end
+    end
+  end
+
+  describe "when writing to HTML" do
+    subject do
+      stream = StringIO.new
+      Apical::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 = Apical.new do
+          adapter :rack, app: TestApp
+          post '/tacos.json' do
+            desc "Make a new delicious taco"
+            accept :json
+            params do
+              { meat: 'beef', lettuce: true }
+            end
+          end
+        end
+
+        @doc.run
+      end
+
+      subject do
+        stream = StringIO.new
+        Apical::HtmlWriter.new(@doc).write(stream)
+        stream.read
+      end
+
+      it "should pretty-print the JSON data in the IN section" do
+        subject.should include("{\n  "meat": "beef",\n  "lettuce": true\n}")
+      end
+    end
+
+    describe "when setting the default accept and content type" do
+      before do
+        @doc = Apical.new do
+          adapter :rack, app: TestApp
+          accept :json
+          content_type :json
+
+          post '/tacos.json' do
+            desc "Make a new delicious taco"
+            params do
+              { 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 be_a(Apical::JsonContentType)
+      end
+
+      it "should propagate the content type to its resources" do
+        @doc.resources.first.content_type.should be_a(Apical::JsonContentType)
+      end
+    end
+
+    describe "when providing JSON as output" do
+      before do
+        @doc = Apical.new do
+          adapter :rack, app: TestApp
+          post '/tacos.json' do
+            desc "Make a new delicious taco"
+            accept :json
+            content_type :json
+            params do
+              { meat: 'beef', lettuce: true }
+            end
+          end
+        end
+
+        @doc.run
+      end
+
+      subject do
+        stream = StringIO.new
+        Apical::HtmlWriter.new(@doc).write(stream)
+        stream.read
+      end
+
+      it "should pretty-print the JSON data in the OUT section" do
+        subject.should include("{\n  "meat": "beef",\n  "lettuce": true\n}")
+      end
+    end
+
+  end
+end

data/spec/http_apical_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe "creating an apical from a real running HTTP server" do
+  before do
+    stub_request(:get, "http://mocksite.com/resource.json").
+      to_return(:status => 200, :body => "this is a resource", :headers => {})
+
+    @doc = Apical.new do
+      adapter :http, base_uri: "http://mocksite.com"
+
+      get "/resource.json" do
+        desc "A test GET resource"
+      end
+    end
+  end
+
+  subject { @doc.run }
+
+  it "should have run the request" do
+    subject.resources.first.response_body.should == "this is a resource"
+  end
+end
+

data/spec/load_paths_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe "an apical file with a relative require line" do
+  before do
+    @cli = Apical::CLI.new
+    @cli.compile File.dirname(__FILE__) + '/fixtures/load_paths_example.apical'
+  end
+
+  it "should load the file from within the same directory as the apical file" do
+    $required.should == true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'apical'
+
+require 'webmock/rspec'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+ROOT = Pathname.new(File.dirname(__FILE__) + '/../')
+
+RSpec.configure do |config|
+
+  config.before(:all) do
+  end
+  
+end

data/spec/support/test_apps.rb

@@ -0,0 +1,34 @@
+require 'sinatra/base'
+
+class TestApp < Sinatra::Base
+  get '/tacos.json' do
+    JSON.generate [ { meat: 'beef' }, { meat: 'chicken' } ]
+  end
+
+  post '/tacos.json' do
+    JSON.generate( { body: request.body.read } )
+  end
+
+  get '/tacos/:id.json' do
+    JSON.generate({ meat: 'beef', id: params['id'] })
+  end
+end
+
+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
+