useless-doc 0.2.3 → 0.3.0

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

@@ -1,56 +0,0 @@
-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

@@ -1,82 +0,0 @@
-require File.dirname(__FILE__) + '/../../../spec_helper'
-
-require 'time'
-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
-    before(:each) do
-      Useless::Doc::Rack::Retriever::Standard.instance_variable_set(:@cache, {})
-    end
-
-    it 'should make a normal request if the cache is empty.' do
-      Typhoeus.should_receive(:options).
-        with('http://some-api.granmal.com/some/resource', headers: { 'Accept' => 'application/json' }).
-        and_return(mock(:response, response_code: 200, response_body: '{ "some": "json" }'))
-
-      response = Useless::Doc::Rack::Retriever::Standard.retrieve('http://some-api.granmal.com/some/resource')
-      response.should == '{ "some": "json" }'
-    end
-
-    it 'should make a request with a cache control header if there is a cache hit.' do
-      now = Time.now
-      Time.should_receive(:now).once.and_return(now)
-
-      Typhoeus.should_receive(:options).once.
-        with('http://some-api.granmal.com/some/resource', headers: { 'Accept' => 'application/json' }).
-        and_return(mock(:response, response_code: 200, response_body: '{ "some": "json" }'))
-
-      Typhoeus.should_receive(:options).once.
-        with('http://some-api.granmal.com/some/resource', headers: { 'Accept' => 'application/json', 'If-Modified-Since' => now.httpdate}).
-        and_return(mock(:response, response_code: 304, response_body: ''))
-
-      Useless::Doc::Rack::Retriever::Standard.retrieve('http://some-api.granmal.com/some/resource')
-      response = Useless::Doc::Rack::Retriever::Standard.retrieve('http://some-api.granmal.com/some/resource')
-      response.should == '{ "some": "json" }'
-    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/transform_spec.rb

@@ -1,57 +0,0 @@
-require File.dirname(__FILE__) + '/../../../spec_helper'
-
-require 'rack'
-require 'useless/doc/rack/transform'
-require 'useless/doc/ui/godel'
-
-describe Useless::Doc::Rack::Transform do
-  def api_base
-    @api_base ||= lambda do |env|
-      [200, {'Content-Type' => 'application/json'}, [load_document('api.json')]]
-    end
-  end
-
-  def resource_base
-    @resource_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(resource_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 API JSON returned by the downstream app to HTML, if the request path is root' do
-    response = Rack::MockRequest.new(app(api_base)).get('http://twonk.useless.io/')
-    response['Content-Type'].should == 'text/html'
-    response.body.should =~ /<h1>twonk\.useless\.io<\/h1>/
-  end
-
-  it 'should transform the resource JSON returned by the downstream app to HTML' do
-    response = Rack::MockRequest.new(app(resource_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