apical 0.1.4

data/lib/apical/writers/console_writer.rb

@@ -0,0 +1,26 @@
+module Apical
+  class ConsoleWriter
+    def initialize(runner)
+      @runner = runner
+    end
+
+    def write(stream)
+      @runner.run
+
+      stream.write( @runner.resources.map{|r| resource_text(r) }.join )
+      stream.rewind if @runner.resources.any?
+      stream
+    end
+
+    def resource_text(resource)
+      <<-TXT
+        method:   #{resource.method}
+        path:     #{resource.path}
+        desc:     #{resource.desc}
+        params:   #{resource.formatted_params}
+        response: #{resource.formatted_response}
+
+      TXT
+    end
+  end
+end

data/lib/apical/writers/html_writer.rb

@@ -0,0 +1,37 @@
+module Apical
+  class HtmlWriter
+    def initialize(runner)
+      @runner = runner
+    end
+
+    def markdown_to_html(str)
+      Kramdown::Document.new(str).to_html
+    end
+
+    def write(stream)
+      @runner.run
+
+      stream.write(
+        Mustache.to_html(File.read(File.dirname(__FILE__) + '/../../../templates/layout.mustache'), {
+          name: @runner.name,
+          desc: markdown_to_html(@runner.desc),
+          content: @runner.resources.map {|r| resource_html(r) }.join
+        })
+      )
+      stream.rewind
+      stream
+    end
+
+    def resource_html(resource) 
+      Mustache.to_html(File.read(File.dirname(__FILE__) + '/../../../templates/resource.mustache'), {
+        method: resource.method,
+        path: resource.path,
+        desc: markdown_to_html(resource.desc),
+        accept: resource.accept,
+        params: resource.formatted_params,
+        content_type: resource.content_type,
+        response: resource.formatted_response
+      })
+    end
+  end
+end

data/spec/apical/adapters/http_adapter_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Apical::HttpAdapter do
+  before do
+    stub_request(:get, "http://mocksite.com/tacos.json").
+      to_return(:status => 200, :body => "{some:'json'}", :headers => {})
+    stub_request(:post, "http://mocksite.com/tacos.json").
+      to_return(:status => 200, :body => "{made: 'a taco'}", :headers => {})
+  end
+
+  subject { Apical::HttpAdapter.new(base_uri: "http://mocksite.com") }
+  describe "when making a GET request" do
+    it "should return the raw response" do
+      subject.get('/tacos.json').body.should == "{some:'json'}"
+    end
+  end
+
+  describe "when making a POST request" do
+    it "should return the raw response" do
+      subject.post("/tacos.json").body.should == "{made: 'a taco'}"
+    end
+  end
+end
+

data/spec/apical/cli_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+require 'stringio'
+require 'sinatra/base'
+require 'fileutils'
+
+describe Apical::CLI do
+
+  def capture(*streams)
+    streams.map! { |stream| stream.to_s }
+    begin
+      result = StringIO.new
+      streams.each { |stream| eval "$#{stream} = result" }
+      yield
+    ensure
+      streams.each { |stream| eval("$#{stream} = #{stream.upcase}") }
+    end
+    result.string
+  end
+
+  describe "when printing the version information" do
+    let(:output) { capture(:stdout) { subject.version } }
+    it "should print the version number to STDOUT" do
+      output.should == "#{Apical::VERSION}\n" 
+    end
+  end
+
+  describe "when compiling" do
+    before do
+      class ExampleApp < Sinatra::Base
+        get '/example.json' do
+          JSON.generate({ status: 'example, mothafucka' })
+        end
+      end
+    end
+
+    describe "using an input file" do
+      before { subject.options = { app: "ExampleApp" } }
+      let(:output) { capture(:stdout) { subject.compile(ROOT.join(*%w{spec fixtures cli_example_1.rb})) } }
+
+      it "should print its output to the console by default" do
+        output.should include("example get resource")
+      end
+    end
+
+    describe "with the app specified in the API file itself" do
+      let(:output) { capture(:stdout) { subject.compile(ROOT.join(*%w{spec fixtures cli_example_2.rb})) } }
+
+      it "should print its output to the console by default" do
+        output.should include("example get resource")
+      end
+    end
+
+    describe "with HTML format specified" do
+      before { subject.options = { format: "html" } }
+      let(:output) { capture(:stdout) { subject.compile(ROOT.join(*%w{spec fixtures cli_example_1.rb})) } }
+
+      it "should print HTML output to STDOUT" do
+        output.should include("<html")
+      end
+    end
+
+    describe "with an output file specified" do
+      before do 
+        subject.options = {
+          app: "ExampleApp", 
+          output_path: ROOT.join(*%w{spec fixtures cli_example_1.html}) 
+        }
+      end
+
+      after do
+        FileUtils.rm subject.options[:output_path]
+      end
+
+      it "should write the output to the file instead of stdout" do
+        subject.compile(ROOT.join(*%w{spec fixtures cli_example_1.rb}))
+        File.read(subject.options[:output_path]).should include('example get resource')
+      end
+    end
+  end
+end
+

data/spec/apical/content_types_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Apical::JsonContentType do
+  its(:to_s) { should == 'json' }
+end
+
+describe Apical::FormContentType do
+  its(:to_s) { should == 'form' }
+end

data/spec/apical/rack_adapter_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Apical::RackAdapter do
+  subject { Apical::RackAdapter.new(app: TestApp) }
+  describe "when making a GET request" do
+    it "should return the raw response" do
+      subject.get('/tacos.json').body.should == 
+        JSON.generate([ { meat: 'beef' }, { meat: 'chicken' } ])
+    end
+  end
+end
+

data/spec/apical_spec.rb

@@ -0,0 +1,360 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Apical do
+  def stream_from writer, doc
+    StringIO.new.tap do |stream|
+      writer.new(doc).write(stream)
+    end.read
+  end
+
+  before do
+    @doc = Apical.new do
+      adapter :rack, app: TestApp
+      name "The Tacos API"
+      desc "An API for the making and consumption of delicious tacos"
+
+      get '/tacos.json' do
+        desc "Get all tacos"
+      end
+    end
+  end
+
+  subject { @doc }
+
+  its(:name) { should == "The Tacos API" }
+  its(:desc) { should == "An API for the making and consumption of delicious tacos" }
+
+  it "should have one resource" do
+    subject.resources.length.should == 1
+  end
+
+  it "returns itself after a run" do
+    @doc.run.should be(@doc)
+  end
+
+  describe "the /tacos.json resource" do
+    before do
+      @doc.run
+    end
+
+    subject { @doc.resources.first }
+    its(:method) { should == 'GET' }
+    its(:path) { should == '/tacos.json' }
+    its(:response_body) { should == JSON.generate([ { meat: 'beef' }, { meat: 'chicken' } ]) }
+  end
+
+  context "a Resource" do
+    describe "when setting the accept, content type and authorization headers" do
+      let(:doc) do
+        Apical.new do
+
+          adapter :rack, app: TestApp
+
+          get '/tacos.json' do
+            desc "Stuff"
+            accept :json
+            content_type :json
+            auth_header "One To Rule Them All"
+          end
+        end
+      end
+
+      it "sets the headers on the resource" do
+        doc.run.resources.first.tap do |res|
+          res.accept.should be_a(Apical::JsonContentType)  
+          res.content_type.should be_a(Apical::JsonContentType)
+          res.custom_header('Authorization').should == 'One To Rule Them All'
+        end
+      end
+    end
+
+    describe "when setting the default accept, content type and authorization headers" do
+      before do
+        @doc = Apical.new do
+          adapter :rack, app: TestApp
+          accept :json
+          content_type :json
+          auth_header "OAuth 123abc456"
+
+          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
+
+      it "propagates the authorization header to its resources" do
+        @doc.resources.first.auth_header.should == "OAuth 123abc456"
+      end
+    end    
+  end
+
+  describe "when setting a custom header" do
+    let(:doc) do
+      Apical.new do
+        adapter :rack, app: TestApp
+        get '/tacos.json' do
+          before do
+            @character = "Gandalf"
+          end
+
+          header "Custom-Header", "One To Rule Them All"
+          header "Custom-Header-By-Lambda", Proc.new { @character }
+        end
+      end
+    end
+
+    it "sets the header on the resource when specifying a string value" do
+      doc.run.resources.first.custom_header('Custom-Header').should == "One To Rule Them All"
+    end
+
+    it "calls the proc bound to the resource when setting a header with a proc value" do
+      doc.run.resources.first.custom_header('Custom-Header-By-Lambda').should == "Gandalf"
+    end
+  end
+
+  describe "when writing to the console" do
+    subject { stream_from Apical::ConsoleWriter, @doc }
+
+    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 { stream_from Apical::ConsoleWriter, @doc }
+
+      it "should prett-print the JSON data" do
+        subject.should include(%Q|{\n  \"meat\": \"beef\",\n  \"lettuce\": true\n}\n|)
+      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"
+            content_type :json
+            params do
+              { meat: 'beef', lettuce: true }
+            end
+          end
+        end
+
+        @doc.run
+      end
+
+      subject { stream_from Apical::ConsoleWriter, @doc }
+
+      it "should pretty-print the response JSON data" do
+        subject.should include(%Q|"body": "meat=beef&lettuce=true"|) 
+      end
+    end
+  end
+
+  describe "when writing to HTML" do
+    subject { stream_from Apical::HtmlWriter, @doc }
+
+    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 { stream_from Apical::HtmlWriter, @doc }
+
+      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 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"
+            content_type :json
+            params do
+              { meat: 'beef', lettuce: true }
+            end
+          end
+        end
+
+        @doc.run
+      end
+
+      subject { stream_from Apical::HtmlWriter, @doc }
+
+      it "should pretty-print the JSON data in the OUT section" do
+        # subject.should include("{\n  "meat": "beef",\n  "lettuce": true\n}")
+        subject.should include(""body": "meat=beef&lettuce=true"")
+      end
+    end
+  end
+
+  describe "different request methods" do
+    before do
+      @doc = Apical.new do
+        adapter :rack, app: RequestMethodsApp
+        get '/get.json' do
+          desc "a get request"
+        end
+
+        post '/post.json' do
+          desc "a post request"
+        end
+
+        put '/put.json' do
+          desc "a put request"
+        end
+
+        delete '/delete.json' do
+          desc "a delete request" 
+        end
+
+        options '/options.json' do
+          desc "an options request"
+        end
+      end
+    end
+
+    it "should have all five resources" do
+      @doc.resources.length.should == 5
+    end
+  end
+
+  describe "when specifying a request with parameters" do
+    before do
+      @doc = Apical.new do
+        adapter :rack, app: TestApp
+        post '/tacos.json' do
+          accept :json
+          content_type :json
+          desc "Make a new delicious taco"
+          params do
+            { meat: 'beef', lettuce: true }
+          end
+        end
+      end
+
+      @doc.run
+    end
+
+    subject { @doc.resources.first }
+
+    its(:params) { should == { meat: 'beef', lettuce: true } }
+  end
+
+  describe "when specifying a request with an interpolated path" do
+    before do
+      @doc = Apical.new do
+        adapter :rack, app: TestApp
+        get '/tacos/:id.json' do
+          accept :json
+          content_type :json
+          desc "Get a specific taco by its ID"
+          params do
+            { id: 123 }
+          end
+        end
+      end
+
+      @doc.run
+    end
+
+    subject { @doc.resources.first }
+
+    its(:path) { should == '/tacos/:id.json' }
+    its(:params) { should == { id: 123 } }
+    its(:response_body) { should == JSON.generate({ meat: 'beef', id: '123' }) }
+  end
+
+  describe "when specifying a resource with params that reference instance variables" do
+    before do
+      @doc = Apical.new do
+        adapter :rack, app: TestApp
+        get '/tacos/:id.json' do
+          accept :json
+          content_type :json
+          desc "Get a specific taco by its ID"
+
+          before do
+            @taco = { id: 123 }
+          end
+
+          params do
+            { id: @taco[:id] }
+          end
+        end
+      end
+
+      @doc.run
+    end
+
+    subject { @doc.resources.first }
+
+    its(:params) { should == { id: 123 } }
+  end
+
+end
+