rack-swagger 0.0.1 → 0.0.6

data/lib/rack/swagger/server_helpers.rb

@@ -0,0 +1,55 @@
+module Rack
+  module Swagger
+    module ServerHelpers
+      def swagger_dist_path
+        ::File.expand_path("../../../../swagger-ui/dist", __FILE__)
+      end
+
+      def swagger_index_html_path
+        ::File.join(swagger_dist_path, "index.html")
+      end
+
+      def display_file_or_404(type, file, root_or_resource=nil)
+        if ::File.exists?(file)
+          [
+            200,
+            {
+              'Content-Type'  => type == :json ? 'application/json' : 'text/html',
+              'Cache-Control' => 'public, max-age=86400'
+            },
+            ::StringIO.new(display_file(type, file, root_or_resource))
+          ]
+        else
+          [404, {}, ["Not found"]]
+        end
+      end
+
+      def display_file(type, file, root_or_resource=nil)
+        @files ||= {}
+        @files[file] ||= begin
+                           contents = ::File.read(file)
+                           contents = overwrite_base_path(contents, base_path_value(root_or_resource)) if type == :json
+                           contents
+                         end
+      end
+
+      def base_path_value(root_or_resource=nil)
+        if root_or_resource == :root
+          @opts[:overwrite_base_path] + "/docs/api-docs"
+        else
+          @opts[:overwrite_base_path]
+        end
+      end
+
+      def overwrite_base_path(contents, value)
+        if value
+          contents = JSON.parse(contents)
+          contents["basePath"] = value
+          contents.to_json
+        else
+          contents
+        end
+      end
+    end
+  end
+end

data/lib/rack/swagger/sinatra_helpers.rb

@@ -0,0 +1,78 @@
+module Rack
+  module Swagger
+    module SinatraHelpers
+      def self.get_all_routes(*apps)
+        routes = {}
+        apps.each do |app|
+          routes_by_verb = get_routes app
+
+          HTTP_VERBS.each do |verb|
+            unless routes_by_verb[ verb ].nil?
+              routes[ verb ] ||= []
+              routes[ verb ] += routes_by_verb[ verb ]
+            end
+          end
+        end
+        routes
+      end
+
+      private
+
+      HTTP_VERBS = %w(  GET
+                        HEAD
+                        POST
+                        PUT
+                        DELETE
+                        TRACE
+                        OPTIONS
+                        CONNECT
+                        PATCH )
+
+      def self.expand_routes(routes)
+        all_routes = routes.map do |r|
+          path = r[0].to_s
+
+          # this is to undo sinatra/base.rb#compile()
+          path = path.gsub(/^\(\?-mix:\\A\\/, "").
+            gsub(/\\z\)$/, "").
+            gsub(/\\\/\?$/,"").
+            gsub("([^#]+)?", "").
+            gsub("(?:\\.|%2[Ee])",".").
+            gsub("\\/","/")
+
+          # this is to replace the regexes with param names from the array
+          r[1].each do |param|
+            path = path.sub("([^/?#]+)", "{#{param}}")
+          end
+
+          # this is to split paths with optional pieces into more than one path
+          alternate_paths = []
+          path.split("/?").each do |segment|
+            if alternate_paths.last
+              alternate_paths << alternate_paths.last + "/" + segment.sub(/\?$/, "")
+            else
+              alternate_paths << segment.sub(/\?$/, "")
+            end
+          end
+
+          if alternate_paths.empty?
+            path
+          else
+            alternate_paths
+          end
+        end
+
+        all_routes.flatten
+      end
+
+      def self.get_routes(app)
+        routes_by_verb = {}
+        HTTP_VERBS.each do |verb|
+          routes = app.routes[verb]
+          routes_by_verb[ verb ] = routes.nil? ? nil : expand_routes( routes )
+        end
+        routes_by_verb
+      end
+    end
+  end
+end

data/lib/rack/swagger/version.rb

@@ -1,5 +1,5 @@
 module Rack
   module Swagger
-    VERSION = "0.0.1"
+    VERSION = "0.0.6"
   end
 end

data/rack-swagger.gemspec

@@ -18,6 +18,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rack-test"
+
+  spec.add_dependency "bundler", "~> 1.7"
+  spec.add_dependency "rake", "~> 10.0"
+  spec.add_dependency "rack", "~> 1.4"
+  spec.add_dependency "httpclient", "~> 2"
+  spec.add_dependency "activesupport"
 end

data/spec/lib/rack/swagger/asset_server_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+
+describe Rack::Swagger::AssetServer do
+  include Rack::Test::Methods
+  include Rack::Swagger::ServerHelpers
+
+  def app
+    Rack::Swagger::AssetServer.new
+  end
+
+  it "serves files from swagger-ui" do
+    first_file = Dir.glob(swagger_dist_path + "/css/*").first
+    first_file.gsub!(swagger_dist_path, "")
+
+    get "/docs" + first_file
+    expect(last_response.body).to eq(File.read(swagger_dist_path + first_file))
+  end
+end

data/spec/lib/rack/swagger/index_page_server_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+describe Rack::Swagger::IndexPageServer do
+  include Rack::Test::Methods
+  include Rack::Swagger::ServerHelpers
+
+  def app
+    Rack::Swagger::IndexPageServer.new
+  end
+
+  it "serves index.html at docs/" do
+    get "/docs/", url: "api-docs"
+    expect(last_response.body).to eq(File.read(swagger_dist_path + "/index.html"))
+  end
+
+  it "redirects docs => docs/?url=api-docs" do
+    get "/docs"
+    expect(last_response.status).to eq(302)
+    expect(last_response.location).to eq("docs/?url=api-docs")
+  end
+end

data/spec/lib/rack/swagger/routes_to_models_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe Rack::Swagger::RoutesToModels do
+  include Rack::Swagger::RoutesToModels
+
+  let(:expected_result) {{
+    "Listing" =>
+    {id:"Listing", properties:
+     {id:{type:"string"}, lat:{type:"number", format:"float"},
+      lng:{type:"number", format:"float"}, free:{type:"boolean",
+                                                 format:"boolean"}
+    }
+    },
+    "Pins" => 
+    {id:"Pins", properties:
+     {total:
+      {type:"integer", format:"int64"},
+      listings:{type:"array", items:{"$ref"=>"Listing"}}
+    }
+    }
+  }}
+
+  let(:sample_response) {{
+    total:6,
+    listings:[
+      {id:"2395", lat:33.9482, lng:-84.261, free:false},
+      {id:"111", lat:33.9465, lng:-84.2262, free:false},
+      {id:"11413", lat:33.9444, lng:-84.2455, free:false},
+      {id:"83798", lat:33.9512, lng:-84.2451, free:false},
+      {id:"16993", lat:33.9696, lng:-84.2046, free:false},
+      {id:"16020", lat:33.9072, lng:-84.196, free:false}
+    ]
+  }}
+
+  let(:expected_result_2) {{
+    "AdMobBannerIds"=>
+      {:id=>"AdMobBannerIds",
+       :properties=>
+        {"AGBannerResultsListTelCoAdUnitId"=>{:type=>"string"},
+         "AGBannerResultsListAdUnitId"=>{:type=>"string"},
+         "AGBannerDetailsAdUnitId"=>{:type=>"string"},
+         "AGBannerDetailsTelCoAdUnitId_1"=>{:type=>"string"},
+         "AGBannerDetailsTelCoAdUnitId_2"=>{:type=>"string"},
+         "AGBannerThankYouAdUnitId"=>{:type=>"string"},
+         "AGBannerThankYouTelCoAdUnitId"=>{:type=>"string"}}},
+    "Config"=>
+      {:id=>"Config",
+       :properties=>
+        {"copyright"=>{:type=>"string"},
+         "offsiteAnalyticsFlag"=>{:type=>"string"},
+         "offsiteAnalyticsQueueLimit"=>{:type=>"string"},
+         "adMobBannerIds"=>{"$ref"=>"AdMobBannerIds"}
+        }
+      }
+  }}
+
+  let(:sample_response_2) {{
+    "copyright"=>
+      "Copyright 2014 RentPath, Inc.  All rights reserved.  All photos, videos, text and other content are the property of RentPath, Inc.  APARTMENT GUIDE and the APARTMENT GUIDE Trade Dress are registered trademarks of RentPath, Inc. or its affiliates.",
+      "offsiteAnalyticsFlag"=>"true",
+      "offsiteAnalyticsQueueLimit"=>"50",
+      "adMobBannerIds"=>
+        {"AGBannerResultsListTelCoAdUnitId"=>
+         "/7449/mob.aptguide.com.%@/Search/tlp_p",
+         "AGBannerResultsListAdUnitId"=>"/7449/mob.aptguide.com.%@/Search/b_lb_p1",
+         "AGBannerDetailsAdUnitId"=>"/7449/mob.aptguide.com.%@/Detail/b_lb_p1",
+         "AGBannerDetailsTelCoAdUnitId_1"=>"/7449/mob.aptguide.com.%@/Detail/tdp_p1",
+         "AGBannerDetailsTelCoAdUnitId_2"=>"/7449/mob.aptguide.com.%@/Detail/tdp_p2",
+         "AGBannerThankYouAdUnitId"=>"/7449/mob.aptguide.com.%@/ThankYou/b_lb_p1",
+         "AGBannerThankYouTelCoAdUnitId"=>"/7449/mob.aptguide.com.%@/ThankYou/tdp_p1"
+        }
+  }}
+
+  it "turns a response into a model declaration" do
+    expect(generate_models(sample_response, "Pins")).to eq expected_result
+  end
+
+  it "turns another response into a model declaration" do
+    expect(generate_models(sample_response_2, "Config")).to eq expected_result_2
+  end
+end

data/spec/lib/rack/swagger/server_helpers_spec.rb

@@ -0,0 +1,44 @@
+require "spec_helper"
+
+describe Rack::Swagger::ServerHelpers do
+  include Rack::Swagger::ServerHelpers
+  
+  before do
+    @opts = {}
+  end
+
+  describe "display_file_or_404" do
+    it "404 if file does not exist" do
+      result = display_file_or_404(:json, "blah.json")
+      expect(result[0]).to eq(404)
+    end
+
+    it "404 if file does not exist" do
+      result = display_file_or_404(:html, "blah.html")
+      expect(result[0]).to eq(404)
+    end
+
+    it "serves file if file does exist" do
+      result = display_file_or_404(:html, __FILE__)
+      expect(result[0]).to eq(200)
+      expect(result[2].read).to eq(File.read(__FILE__))
+    end
+
+    it "serves proper json content type for :json" do
+      result = display_file_or_404(:json, __FILE__)
+      expect(result[1]["Content-Type"]).to eq("application/json")
+    end
+  end
+
+  describe "overwrite_base_path" do
+    it "adds basePath" do
+      result = overwrite_base_path("{\"foo\":\"bar\"}", "baz")
+      expect(result).to eq("{\"foo\":\"bar\",\"basePath\":\"baz\"}")
+    end
+    it "overwrites basePath" do
+      @opts = {overwrite_base_path: "baz"}
+      result = overwrite_base_path("{\"basePath\":\"bar\"}", "baz")
+      expect(result).to eq("{\"basePath\":\"baz\"}")
+    end
+  end
+end

data/spec/lib/rack/swagger/sinatra_helpers_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+class MockSinatraApp
+  attr_accessor :routes
+end
+
+describe Rack::Swagger::SinatraHelpers do
+  before do
+    # removed the Procs from the Sinatra::Base.routes output because
+    # we don't need it (replaced with nil)
+    app1routes = {
+      "GET"=>[[/\A\/config\z/, [], [], nil],
+             [/\A\/listings\/?\z/, [], [], nil],
+             [/\A\/show\/?([^\/?#]+)?\/?\z/, ["id"], [], nil],
+             [/\A\/diamondmax\/?\z/, [], [], nil],
+             [/\A\/map\/pins(?:\.|%2[Ee])json\z/, [], [], nil],
+             [/\A\/map\/pin\/([^\/?#]+)\/?\z/, ["id"], [], nil],
+             [/\A\/refinementlist\/?\z/, [], [], nil],
+             [/\A\/reviews\/([^\/?#]+)\/?\z/, ["id"], [], nil],
+             [/\A\/listings\/search\/?\z/, [], [], nil],
+             [/\A\/search\/?\z/, [], [], nil],
+             [/\A\/telcos\z/, [], [], nil],
+             [/\A\/([^\/?#]+)\/states\/?\z/, ["channel"], [], nil],
+             [/\A\/([^\/?#]+)\/([^\/?#]+)\/cities\/?\z/, ["channel", "state"], [], nil],
+             [/\A\/mgtco\/([^\/?#]+)\/([^\/?#]+)\/([^\/?#]+)\/?\z/, ["state", "city", "mgtcoid"], [], nil],
+             [/\A\/listings\/([^\/?#]+)\/recommendations\/?\z/, ["id"], [], nil],
+             [/\A\/protobuf_test\z/, [], [], nil],
+             [/\A\/rent\/listings\/?\z/, [], [], nil]
+
+    ], "HEAD"=>[[/\A\/config\z/, [], [], nil],
+                [/\A\/listings\/?\z/, [], [], nil],
+                [/\A\/show\/?([^\/?#]+)?\/?\z/, ["id"], [], nil],
+                [/\A\/diamondmax\/?\z/, [], [], nil],
+                [/\A\/map\/pins(?:\.|%2[Ee])json\z/, [], [], nil],
+                [/\A\/map\/pin\/([^\/?#]+)\/?\z/, ["id"], [], nil],
+                [/\A\/refinementlist\/?\z/, [], [], nil],
+                [/\A\/reviews\/([^\/?#]+)\/?\z/, ["id"], [], nil],
+                [/\A\/listings\/search\/?\z/, [], [], nil],
+                [/\A\/search\/?\z/, [], [], nil],
+                [/\A\/telcos\z/, [], [], nil],
+                [/\A\/([^\/?#]+)\/states\/?\z/, ["channel"], [], nil],
+                [/\A\/([^\/?#]+)\/([^\/?#]+)\/cities\/?\z/, ["channel", "state"], [], nil],
+                [/\A\/mgtco\/([^\/?#]+)\/([^\/?#]+)\/([^\/?#]+)\/?\z/, ["state", "city", "mgtcoid"], [], nil],
+                [/\A\/listings\/([^\/?#]+)\/recommendations\/?\z/, ["id"], [], nil],
+                [/\A\/protobuf_test\z/, [], [], nil],
+                [/\A\/rent\/listings\/?\z/, [], [], nil]
+    ]}
+
+    app2routes = {
+      "GET"=>[[/\A\/reviews\/([^\/?#]+)\/?\z/, ["id"], [], nil],
+              [/\A\/reviews\/partial\/([^\/?#]+)\z/, ["id"], [], nil]],
+
+      "HEAD"=>[[/\A\/reviews\/([^\/?#]+)\/?\z/, ["id"], [], nil],
+               [/\A\/reviews\/partial\/([^\/?#]+)\z/, ["id"], [], nil]],
+
+      "POST"=>[[/\A\/reviews\/flag\/([^\/?#]+)\/([^\/?#]+)\/([^\/?#]+)\z/, ["id", "type", "review_id"], [], nil]]
+    }
+
+    @app1 = MockSinatraApp.new
+    @app1.routes = app1routes
+    @app2 = MockSinatraApp.new
+    @app2.routes = app2routes
+  end
+
+  it "extracts the API routes from the Sinatra::Base.routes" do
+
+    expected_result = {"GET"=>["/config", "/listings", "/show", "/show/{id}", "/diamondmax",
+                               "/map/pins.json", "/map/pin/{id}", "/refinementlist", "/reviews/{id}",
+                               "/listings/search", "/search", "/telcos", "/{channel}/states",
+                               "/{channel}/{state}/cities", "/mgtco/{state}/{city}/{mgtcoid}",
+                               "/listings/{id}/recommendations", "/protobuf_test", "/rent/listings",
+                               "/reviews/{id}", "/reviews/partial/{id}"],
+
+                       "HEAD"=>["/config", "/listings", "/show", "/show/{id}", "/diamondmax",
+                                "/map/pins.json", "/map/pin/{id}", "/refinementlist", "/reviews/{id}",
+                                "/listings/search", "/search", "/telcos", "/{channel}/states",
+                                "/{channel}/{state}/cities", "/mgtco/{state}/{city}/{mgtcoid}",
+                                "/listings/{id}/recommendations", "/protobuf_test", "/rent/listings",
+                                "/reviews/{id}", "/reviews/partial/{id}"],
+
+                       "POST"=>["/reviews/flag/{id}/{type}/{review_id}"]}
+
+    expect(Rack::Swagger::SinatraHelpers.get_all_routes(@app1, @app2)).to eq(expected_result)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "rack/swagger"
+require "rack/swagger/routes_to_models"
+require "rack/test"
+require "rspec"
+require 'rspec/autorun'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+# Dir[Rails.root.join("spec/support/**/*.rb")].each {|f| require f}
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+end

data/swagger-ui/dist/css/reset.css

@@ -0,0 +1,125 @@
+/* http://meyerweb.com/eric/tools/css/reset/ v2.0 | 20110126 */
+html,
+body,
+div,
+span,
+applet,
+object,
+iframe,
+h1,
+h2,
+h3,
+h4,
+h5,
+h6,
+p,
+blockquote,
+pre,
+a,
+abbr,
+acronym,
+address,
+big,
+cite,
+code,
+del,
+dfn,
+em,
+img,
+ins,
+kbd,
+q,
+s,
+samp,
+small,
+strike,
+strong,
+sub,
+sup,
+tt,
+var,
+b,
+u,
+i,
+center,
+dl,
+dt,
+dd,
+ol,
+ul,
+li,
+fieldset,
+form,
+label,
+legend,
+table,
+caption,
+tbody,
+tfoot,
+thead,
+tr,
+th,
+td,
+article,
+aside,
+canvas,
+details,
+embed,
+figure,
+figcaption,
+footer,
+header,
+hgroup,
+menu,
+nav,
+output,
+ruby,
+section,
+summary,
+time,
+mark,
+audio,
+video {
+  margin: 0;
+  padding: 0;
+  border: 0;
+  font-size: 100%;
+  font: inherit;
+  vertical-align: baseline;
+}
+/* HTML5 display-role reset for older browsers */
+article,
+aside,
+details,
+figcaption,
+figure,
+footer,
+header,
+hgroup,
+menu,
+nav,
+section {
+  display: block;
+}
+body {
+  line-height: 1;
+}
+ol,
+ul {
+  list-style: none;
+}
+blockquote,
+q {
+  quotes: none;
+}
+blockquote:before,
+blockquote:after,
+q:before,
+q:after {
+  content: '';
+  content: none;
+}
+table {
+  border-collapse: collapse;
+  border-spacing: 0;
+}