useless-doc 0.1.1 → 0.1.2

data/lib/useless/doc/rack/application.rb

@@ -33,6 +33,7 @@ module Useless
               use ::Rack::CommonLogger
               use Useless::Doc::Rack::UI
               use Useless::Doc::Rack::Stylesheet
+              use Useless::Doc::Rack::Retriever
               use Useless::Doc::Rack::Transform
 
               run Useless::Doc::Rack::Proxy.new(subdomains)

data/lib/useless/doc/rack/proxy.rb

@@ -33,12 +33,16 @@ module Useless
         end
 
         def call(env)
+          unless env['useless.doc.retriever']
+            raise 'No retriever specified.'
+          end
+
           request = ::Rack::Request.new(env)
 
           if valid_subdomain?(request.url)
             url = Proxy.transform_url(request.url)
 
-            if json = retrieve_resource(url)
+            if json = env['useless.doc.retriever'].retrieve(url)
               [200, {'Content-Type' => 'application/json'}, [json]]
             else
               [404, {'Content-Type' => 'text/plain'}, ['Documentation JSON is missing.']]
@@ -50,25 +54,9 @@ module Useless
 
         private
 
-        def retrieve_resource(url)
-          response = Typhoeus.options url, headers: { 'Accept' => 'application/json' }
-          response.response_body
-        end
-
         def valid_subdomain?(url)
           @subdomains.include?(url[/((?:\w|\-)+)\.doc\./, 1])
         end
-
-        # +Proxy::Stub+ retrieves JSON from the spec/documents directory for
-        # easy UI testing.
-        #
-        class Stub < Proxy
-          def retrieve_resource(url)
-            uri = URI(url)
-            path = File.dirname(__FILE__) + "/../../../../spec/documents#{uri.path}.json"
-            File.read(path)
-          end
-        end
       end
     end
   end

data/lib/useless/doc/rack/retriever.rb

@@ -0,0 +1,42 @@
+module Useless
+  module Doc
+    module Rack
+
+      # +Doc::Rack::Retriever+ sets an appropriate retriever for the current
+      # RACK_ENV. In production it uses the +Standard+ retriever which makes
+      # real HTTP calls. Elsewhere, it uses +Stub+ which servers corresponding
+      # files from the spec/documents directory.
+      #
+      class Retriever
+        def initialize(app)
+          @app = app
+        end
+
+        def call(env)
+          if ENV['RACK_ENV'] == 'production'
+            env['useless.doc.retriever'] = Standard
+          else
+            env['useless.doc.retriever'] = Stub
+          end
+
+          @app.call(env)
+        end
+
+        module Standard
+          def self.retrieve(url)
+            response = Typhoeus.options url, headers: { 'Accept' => 'application/json' }
+            response.response_body
+          end
+        end
+
+        class Stub
+          def self.retrieve(url)
+            uri = URI(url)
+            path = File.dirname(__FILE__) + "/../../../../spec/documents#{uri.path}.json"
+            File.read(path)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/useless/doc/rack/stylesheet.rb

@@ -12,6 +12,10 @@ module Useless
         end
 
         def call(env)
+          unless env['useless.doc.ui']
+            raise 'No UI specified.'
+          end
+
           if env["PATH_INFO"].to_s == '/doc.css'
             [200, {'Content-Type' => 'text/css'}, [env['useless.doc.ui'].css]]
           else

data/lib/useless/doc/rack/transform.rb

@@ -16,12 +16,17 @@ module Useless
         end
 
         def call(env)
+          unless env['useless.doc.ui']
+            raise 'No UI specified.'
+          end
+
           response = @app.call(env)
 
-          if response[0] == 200 and response[1]['Content-Type'] == 'application/json'
+          if response[0] == 200
             begin
               resource = Serialization::Load.resource(response[2].first)
-              [200, {'Content-Type' => 'text/html'}, [env['useless.doc.ui'].html(resource)]]
+              html = env['useless.doc.ui'].html(resource)
+              [200, {'Content-Type' => 'text/html'}, [html]]
             rescue Oj::ParseError
               [502, {'Content-Type' => 'text/plain'}, ['Documentation JSON is malformed.']]
             end

data/lib/useless/doc/version.rb

@@ -1,5 +1,5 @@
 module Useless
   module Doc
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
   end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../lib/useless/doc'
+ENV['RACK_ENV'] == 'test'
 
 RSpec.configure do |config|
   config.order = :rand

data/spec/useless/doc/rack/application_spec.rb

@@ -0,0 +1,37 @@
+require File.dirname(__FILE__) + '/../../../spec_helper'
+
+require 'rack/test'
+require 'useless/doc/rack/application'
+require 'useless/doc/rack/retriever'
+
+describe Useless::Doc::Rack::Application do
+  include Rack::Test::Methods
+
+  def app
+    @app ||= Useless::Doc::Rack::Application.new('some-api')
+  end
+
+  it 'should return a 404 if the JSON cannot be retrieved' do
+    Useless::Doc::Rack::Retriever::Stub.should_receive(:retrieve).
+      with('http://some-api.useless.io/some/non-existant/resource').
+      and_return(nil)
+
+    get 'http://some-api.doc.useless.io/some/non-existant/resource'
+    last_response.should be_not_found
+  end
+
+  it 'should return a 404 if the subdomain is unknown' do
+    get 'http://some-other-api.doc.useless.io/some/non-existant/resource'
+    last_response.should be_not_found
+  end
+
+  it 'should return HTML if proper JSON is retrieved' do
+    Useless::Doc::Rack::Retriever::Stub.should_receive(:retrieve).
+      with('http://some-api.useless.io/some/resource').
+      and_return(load_document('twonk.json'))
+
+    get 'http://some-api.doc.useless.io/some/resource'
+    last_response.should be_ok
+    last_response.body.should =~ /<h1>\/twonks\/:id<\/h1>/
+  end
+end

data/spec/useless/doc/rack/proxy_spec.rb

@@ -0,0 +1,56 @@
+require File.dirname(__FILE__) + '/../../../spec_helper'
+
+require 'rack/test'
+require 'useless/doc/rack/proxy'
+
+describe Useless::Doc::Rack::Proxy do
+  include Rack::Test::Methods
+
+  def app
+    @app ||= lambda do |env|
+      env['useless.doc.retriever'] = Useless::Doc::Rack::Retriever::Stub
+      Useless::Doc::Rack::Proxy.new('some-api').call(env)
+    end
+  end
+
+  it 'should proxy GET requests as an OPTIONS request to the corresponding API resource.' do
+    Useless::Doc::Rack::Retriever::Stub.should_receive(:retrieve).
+      with('http://some-api.granmal.com/some/resource').
+      and_return('{ "some": "response" }')
+
+    get 'http://some-api.doc.granmal.com/some/resource'
+    last_response.should be_ok
+  end
+
+  it 'should return a 404 if the proxy call returns nothing' do
+    Useless::Doc::Rack::Retriever::Stub.should_receive(:retrieve).
+      with('http://some-api.granmal.com/some/non-existant/resource').
+      and_return(nil)
+
+    get 'http://some-api.doc.granmal.com/some/non-existant/resource'
+    last_response.should be_not_found
+  end
+
+  it 'should return a 404 if the subdomain is unknown' do
+    get 'http://some-other-api.doc.granmal.com/some/non-existant/resource'
+    last_response.should be_not_found
+  end
+
+  it 'should raise an error if a retriever is not specified' do
+    app = Useless::Doc::Rack::Proxy.new('some-api')
+    request = Rack::MockRequest.new(app)
+    lambda { request.get('http://some-api.granmal.com/some/non-existant/resource') }.should raise_error(RuntimeError, 'No retriever specified.')
+  end
+
+  describe '.transform_url' do
+    it 'should drop the \'doc\' subdomain from the url for the \'io\' TLD' do
+      url = Useless::Doc::Rack::Proxy.transform_url 'http://some-api.doc.useless.io/some/resource'
+      url.should == 'http://some-api.useless.io/some/resource'
+    end
+
+    it 'should drop the \'doc\' subdomain from the url for the \'dev\' TLD' do
+      url = Useless::Doc::Rack::Proxy.transform_url 'http://some-api.doc.useless.dev/some/resource'
+      url.should == 'http://some-api.useless.dev/some/resource'
+    end
+  end
+end

data/spec/useless/doc/rack/retriever_spec.rb

@@ -0,0 +1,55 @@
+require File.dirname(__FILE__) + '/../../../spec_helper'
+
+require 'rack/test'
+require 'useless/doc/rack/retriever'
+
+describe Useless::Doc::Rack::Retriever do
+  include Rack::Test::Methods
+
+  def app
+    @app ||= begin
+      base_app = lambda do |env|
+        [200, {'Content-Type' => 'text/plain'}, [env['useless.doc.retriever'].name]]
+      end
+
+      Useless::Doc::Rack::Retriever.new(base_app)
+    end
+  end
+
+  it 'should set \'useless.doc.retriever\' to an instance of `Rack::Retriever::Standard` if the RACK_ENV is production' do
+    begin
+      ENV['RACK_ENV'] = 'production'
+      get 'http://some-api.doc.granmal.com/some/resource'
+      last_response.body.should == 'Useless::Doc::Rack::Retriever::Standard'
+    ensure
+      ENV['RACK_ENV'] = 'test'
+    end
+  end
+
+  it 'should set \'useless.doc.retriever\' to an instance of `Rack::Retriever::Stub` if the RACK_ENV is development' do
+    begin
+      ENV['RACK_ENV'] = 'development'
+      get 'http://some-api.doc.granmal.com/some/resource'
+      last_response.body.should == 'Useless::Doc::Rack::Retriever::Stub'
+    ensure
+      ENV['RACK_ENV'] = 'test'
+    end
+  end
+
+  it 'should set \'useless.doc.retriever\' to an instance of `Rack::Retriever::Stub` if the RACK_ENV is test' do
+    get 'http://some-api.doc.granmal.com/some/resource'
+    last_response.body.should == 'Useless::Doc::Rack::Retriever::Stub'
+  end
+
+  describe Useless::Doc::Rack::Retriever::Standard do
+    it 'should respond to `retrieve`' do
+      Useless::Doc::Rack::Retriever::Standard.should respond_to(:retrieve)
+    end
+  end
+
+  describe Useless::Doc::Rack::Retriever::Stub do
+    it 'should respond to `retrieve`' do
+      Useless::Doc::Rack::Retriever::Stub.should respond_to(:retrieve)
+    end
+  end
+end

data/spec/useless/doc/rack/stylesheet_spec.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + '/../../../spec_helper'
+
+require 'rack/test'
+require 'useless/doc/rack/stylesheet'
+require 'useless/doc/ui/godel'
+
+describe Useless::Doc::Rack::Stylesheet do
+  include Rack::Test::Methods
+
+  def base_app
+    @base_app ||= lambda do |env|
+      [200, {'Content-Type' => 'text/plain'}, ['Not a stylesheet request.']]
+    end
+  end
+
+  def app
+    @app ||= lambda do |env|
+      env['useless.doc.ui'] = Useless::Doc::UI::Godel
+      Useless::Doc::Rack::Stylesheet.new(base_app).call(env)
+    end
+  end
+
+  it 'should raise an error if a UI is not specified' do
+    app = Useless::Doc::Rack::Stylesheet.new(base_app)
+    request = Rack::MockRequest.new(app)
+    lambda { request.get('http://some-api.granmal.com/doc.css') }.should raise_error(RuntimeError, 'No UI specified.')
+  end
+
+  it 'should proxy requests if the path is not doc.css' do
+    get 'http://some-api.granmal.com/not/doc.css'
+    last_response.body.should == 'Not a stylesheet request.'
+  end
+
+  it 'should return the UI\'s CSS if the path is doc.css' do
+    Useless::Doc::UI::Godel.should_receive(:css).and_return('some css')
+    get 'http://some-api.granmal.com/doc.css'
+    last_response.body.should == 'some css'
+    last_response['Content-Type'].should == 'text/css'
+  end
+end

data/spec/useless/doc/rack/transform_spec.rb

@@ -0,0 +1,44 @@
+require File.dirname(__FILE__) + '/../../../spec_helper'
+
+require 'useless/doc/rack/transform'
+require 'useless/doc/ui/godel'
+
+describe Useless::Doc::Rack::Transform do
+  def good_base
+    @good_base ||= lambda do |env|
+      [200, {'Content-Type' => 'application/json'}, [load_document('twonk.json')]]
+    end
+  end
+
+  def app(base = nil)
+    lambda do |env|
+      env['useless.doc.ui'] = Useless::Doc::UI::Godel
+      Useless::Doc::Rack::Transform.new(base).call(env)
+    end
+  end
+
+  it 'should raise an error if a UI is not specified' do
+    app = Useless::Doc::Rack::Transform.new(good_base)
+    request = Rack::MockRequest.new(app)
+    lambda { request.get('http://some-api.doc.granmal.com/some/resource') }.should raise_error(RuntimeError, 'No UI specified.')
+  end
+
+  it 'should return a 502 if the returned JSON cannot be parsed' do
+    bad_base = lambda { |env| [200, {'Content-Type' => 'application/json'}, ['invalid-json']] }
+    response = Rack::MockRequest.new(app(bad_base)).get('http://some-api.doc.granmal.com/some/resource')
+    response.status.should == 502
+  end
+
+  it 'should proxy through if the downstream app returns a non-200 response' do
+    bad_base = lambda { |env| [404, {'Content-Type' => 'text/plain'}, ['Not Found.']] }
+    response = Rack::MockRequest.new(app(bad_base)).get('http://some-api.doc.granmal.com/some/resource')
+    response.status.should == 404
+    response.body.should == 'Not Found.'
+  end
+
+  it 'should transform the JSON returned by the downstream app to HTML' do
+    response = Rack::MockRequest.new(app(good_base)).get('http://some-api.doc.granmal.com/some/resource')
+    response['Content-Type'].should == 'text/html'
+    response.body.should =~ /<h1>\/twonks\/:id<\/h1>/
+  end
+end

data/spec/useless/doc/rack/ui_spec.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/../../../spec_helper'
+
+require 'rack/test'
+require 'useless/doc/rack/ui'
+
+describe Useless::Doc::Rack::UI do
+  include Rack::Test::Methods
+
+  def app
+    @app ||= begin
+      base_app = lambda do |env|
+        [200, {'Content-Type' => 'text/plain'}, [env['useless.doc.ui'].name]]
+      end
+
+      Useless::Doc::Rack::UI.new(base_app)
+    end
+  end
+
+  it 'should always return `UI::Godel`' do
+    get 'http://some-api.doc.granmal.com/some/resource'
+    last_response.body.should == 'Useless::Doc::UI::Godel'
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: useless-doc
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-03 00:00:00.000000000 Z
+date: 2013-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -158,6 +158,7 @@ files:
 - lib/useless/doc/header.rb
 - lib/useless/doc/rack/application.rb
 - lib/useless/doc/rack/proxy.rb
+- lib/useless/doc/rack/retriever.rb
 - lib/useless/doc/rack/stylesheet.rb
 - lib/useless/doc/rack/transform.rb
 - lib/useless/doc/rack/ui.rb
@@ -177,7 +178,12 @@ files:
 - spec/documents/twonk.json
 - spec/spec_helper.rb
 - spec/useless/doc/dsl_spec.rb
-- spec/useless/doc/proxy_spec.rb
+- spec/useless/doc/rack/application_spec.rb
+- spec/useless/doc/rack/proxy_spec.rb
+- spec/useless/doc/rack/retriever_spec.rb
+- spec/useless/doc/rack/stylesheet_spec.rb
+- spec/useless/doc/rack/transform_spec.rb
+- spec/useless/doc/rack/ui_spec.rb
 - spec/useless/doc/serialization/dump_spec.rb
 - spec/useless/doc/serialization/load_spec.rb
 - spec/useless/doc/sinatra_spec.rb
@@ -210,7 +216,12 @@ test_files:
 - spec/documents/twonk.json
 - spec/spec_helper.rb
 - spec/useless/doc/dsl_spec.rb
-- spec/useless/doc/proxy_spec.rb
+- spec/useless/doc/rack/application_spec.rb
+- spec/useless/doc/rack/proxy_spec.rb
+- spec/useless/doc/rack/retriever_spec.rb
+- spec/useless/doc/rack/stylesheet_spec.rb
+- spec/useless/doc/rack/transform_spec.rb
+- spec/useless/doc/rack/ui_spec.rb
 - spec/useless/doc/serialization/dump_spec.rb
 - spec/useless/doc/serialization/load_spec.rb
 - spec/useless/doc/sinatra_spec.rb

data/spec/useless/doc/proxy_spec.rb

@@ -1,48 +0,0 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
-
-require 'rack/test'
-require 'useless/doc/proxy'
-require 'useless/doc/ui/godel'
-
-describe Useless::Doc::Proxy do
-  include Rack::Test::Methods
-
-  def app
-    @app ||= begin
-      ui = Useless::Doc::UI::Godel
-      Useless::Doc::Proxy.new(ui)
-    end
-  end
-
-  describe 'as a Rack application' do
-    it 'should proxy GET requests as an OPTIONS request to the corresponding API resource.' do
-      app.should_receive(:retrieve_resource).
-        with('http://some-api.granmal.com/some/resource').
-        and_return('{ "some": "response" }')
-
-      get 'http://some-api.doc.granmal.com/some/resource'
-      last_response.should be_ok
-    end
-
-    it 'should return a 404 if the proxy call returns nothing' do
-      app.should_receive(:retrieve_resource).
-        with('http://some-api.granmal.com/some/non-existant/resource').
-        and_return(nil)
-
-      get 'http://some-api.doc.granmal.com/some/non-existant/resource'
-      last_response.should be_not_found
-    end
-  end
-
-  describe '.transform_url' do
-    it 'should drop the \'doc\' subdomain from the url for the \'io\' TLD' do
-      url = Useless::Doc::Proxy.transform_url 'http://some-api.doc.useless.io/some/resource'
-      url.should == 'http://some-api.useless.io/some/resource'
-    end
-
-    it 'should drop the \'doc\' subdomain from the url for the \'dev\' TLD' do
-      url = Useless::Doc::Proxy.transform_url 'http://some-api.doc.useless.dev/some/resource'
-      url.should == 'http://some-api.useless.dev/some/resource'
-    end
-  end
-end