Added CORS support and Swagger documentation.

dblock · dblock · commit 004670804472 · 2013-06-21T11:24:34.000-04:00
diff --git a/Gemfile b/Gemfile
@@ -5,6 +5,8 @@ gem "grape", :git => "https://github.com/intridea/grape.git"
 gem "json", "~> 1.7.7"
 gem "newrelic_rpm", "~> 3.5.4.34"
 gem "newrelic-grape", "~> 1.1.0"
+gem "rack-cors", "~> 0.2.8"
+gem "grape-swagger", "~> 0.6.0"
 
 group :development do
   gem "rake", "~> 10.0.3"
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -33,6 +33,9 @@ GEM
     descendants_tracker (0.0.1)
     diff-lcs (1.2.4)
     ffi (1.8.1)
+    grape-swagger (0.6.0)
+      grape (>= 0.2.0)
+      kramdown
     growl (1.0.3)
     guard (1.6.2)
       listen (>= 0.6.0)
@@ -50,6 +53,7 @@ GEM
     hashie (2.0.5)
     i18n (0.6.1)
     json (1.7.7)
+    kramdown (1.0.2)
     listen (0.7.2)
     lumberjack (1.0.2)
     method_source (0.8.1)
@@ -68,6 +72,8 @@ GEM
     rack (1.4.5)
     rack-accept (0.4.5)
       rack (>= 0.4)
+    rack-cors (0.2.8)
+      rack
     rack-mount (0.8.3)
       rack (>= 1.0.0)
     rack-test (0.6.2)
@@ -104,13 +110,15 @@ PLATFORMS
 DEPENDENCIES
   capybara (= 2.1.0)
   grape!
+  grape-swagger (~> 0.6.0)
   guard (~> 1.6.1)
   guard-bundler (~> 1.0.0)
   guard-rack (~> 1.2.2)
   json (~> 1.7.7)
   newrelic-grape (~> 1.1.0)
   newrelic_rpm (~> 3.5.4.34)
   rack (~> 1.4.1)
+  rack-cors (~> 0.2.8)
   rack-test (~> 0.6.2)
   rake (~> 10.0.3)
   rspec (~> 2.13.0)
diff --git a/README.md b/README.md
@@ -54,6 +54,11 @@ $ curl -X POST -i -F image_file=@spec/fixtures/grape_logo.png https://localhost:9
 {"filename":"grape_logo.png","size":4272}
 ```
 
+Explore the API
+---------------
+
+Explore the API using [Swagger UI](https://petstore.swagger.wordnik.com). Run the application and point the explorer to `https://localhost:9292/api/swagger_doc`.
+
 New Relic
 ---------
 
diff --git a/app/acme_app.rb b/app/acme_app.rb
@@ -1,5 +1,6 @@
 module Acme
   class App
+
     def initialize
       @filenames = [ '', '.html', 'index.html', '/index.html' ]
       @rack_static = ::Rack::Static.new(
@@ -9,6 +10,21 @@ def initialize
         })
     end
 
+    def self.instance
+      @instance ||= Rack::Builder.new do
+        api = Acme::API
+
+        use Rack::Cors do
+          allow do
+            origins '*'
+            resource '*', headers: :any, methods: :get
+          end
+        end
+
+        run api
+      end.to_app
+    end
+
     def call(env)
       # api
       response = Acme::API.call(env)
diff --git a/app/api.rb b/app/api.rb
@@ -10,6 +10,7 @@ class API < Grape::API
     mount ::Acme::Post_Json
     mount ::Acme::Content_Type
     mount ::Acme::Upload_File
+    add_swagger_documentation api_version: 'v1'
   end
 end
 
diff --git a/config.ru b/config.ru
@@ -8,5 +8,5 @@ end
 
 NewRelic::Agent.manual_start
 
-run Acme::App.new
+run Acme::App.instance
 
diff --git a/spec/api/cors_spec.rb b/spec/api/cors_spec.rb
@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Acme::API do
+  include Rack::Test::Methods
+
+  def app
+    Acme::App.instance
+  end
+
+  context "CORS" do
+    it "supports options" do
+      options "/", {}, {
+        "HTTP_ORIGIN" => "https://cors.example.com",
+        "HTTP_ACCESS_CONTROL_REQUEST_HEADERS" => "Origin, Accept, Content-Type",
+        "HTTP_ACCESS_CONTROL_REQUEST_METHOD" => "GET"
+      }
+      last_response.status.should == 200
+      last_response.headers['Access-Control-Allow-Origin'].should == "https://cors.example.com"
+      last_response.headers['Access-Control-Expose-Headers'].should == ""
+    end
+    it "includes Access-Control-Allow-Origin in the response" do
+      get "/api/ping", {}, "HTTP_ORIGIN" => "https://cors.example.com"
+      last_response.status.should == 200
+      last_response.headers['Access-Control-Allow-Origin'].should == "https://cors.example.com"
+    end
+    it "includes Access-Control-Allow-Origin in errors" do
+      get "/invalid", {}, "HTTP_ORIGIN" => "https://cors.example.com"
+      last_response.status.should == 404
+      last_response.headers['Access-Control-Allow-Origin'].should == "https://cors.example.com"
+    end
+  end
+
+end
+
diff --git a/spec/api/documentation_spec.rb b/spec/api/documentation_spec.rb
@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Acme::API do
+  include Rack::Test::Methods
+
+  def app
+    Acme::API
+  end
+
+  it "swagger documentation" do
+    get "/api/swagger_doc"
+    last_response.status.should == 200
+    json_response = JSON.parse(last_response.body)
+    json_response["apiVersion"].should == "v1"
+    json_response["apis"].size.should == 1
+  end
+
+end
+

Original file line number	Diff line number	Diff line change
`@@ -8,5 +8,5 @@ end`
`8`	`8`
`9`	`9`	`NewRelic::Agent.manual_start`
`10`	`10`
`11`		`-run Acme::App.new`
	`11`	`+run Acme::App.instance`
`12`	`12`