useless-doc 0.4.0 → 0.5.0

data/lib/useless/doc/{rack → proxy}/css.rb

@@ -1,8 +1,8 @@
 module Useless
   module Doc
-    class Rack
+    class Proxy
 
-      # +Doc::Rack::CSS+ serves the stylesheet for the current +Doc::UI+
+      # +Doc::Proxy::CSS+ serves the stylesheet for the current +Doc::UI+
       # iff the request path is '/doc.css'. Otherwise, it passes the request
       # down the stack.
       # 

data/lib/useless/doc/{rack → proxy}/html.rb

@@ -1,8 +1,8 @@
 module Useless
   module Doc
-    class Rack
+    class Proxy
 
-      # +Doc::Rack::HTML+ is the base application for +Useless::Doc::Rack+.
+      # +Doc::Proxy::HTML+ is the base application for +Useless::Doc::Proxy+.
       # It expects a +Doc::UI+ instance to be set as 'useless.doc.ui', and a
       # +Doc::Core+ entity to be set as 'useless.doc.subject', and then simply
       # passes the latter to the former's +#html+ method.

data/lib/useless/doc/{rack → proxy}/subject.rb

@@ -2,9 +2,9 @@ require 'useless/doc/client'
 
 module Useless
   module Doc
-    class Rack
+    class Proxy
 
-      # +Doc::Rack::Subject+ retrieves a +Doc::Core+ entity based upon
+      # +Doc::Proxy::Subject+ retrieves a +Doc::Core+ entity based upon
       # 'useless.doc.url', from a environment-appropriate +Doc::Client+,
       # and sets it to 'useless.doc.subject'.
       #

data/lib/useless/doc/{rack → proxy}/ui.rb

@@ -3,9 +3,9 @@ require 'useless/doc/ui/godel'
 
 module Useless
   module Doc
-    class Rack
+    class Proxy
 
-      # +Doc::Rack::UI+ chooses which UI should be used to render the
+      # +Doc::Proxy::UI+ chooses which UI should be used to render the
       # documentation and sets it to 'useless.doc.ui'.
       #
       # It could theoretically be chosen via the 'ui' parameter,

data/lib/useless/doc/{rack → proxy}/url.rb

@@ -2,9 +2,9 @@ require 'rack/request'
 
 module Useless
   module Doc
-    class Rack
+    class Proxy
 
-      # +Doc::Rack::URL+ translates the request URL into the corresponding
+      # +Doc::Proxy::URL+ translates the request URL into the corresponding
       # API URL using the specified 'useless.doc.router'.
       #
       class URL

data/lib/useless/doc/{rack.rb → proxy.rb}

@@ -6,15 +6,15 @@ require 'low/rack/log_level'
 require 'low/rack/request_logger'
 
 require 'useless/doc/router'
-require 'useless/doc/rack/ui'
-require 'useless/doc/rack/css'
-require 'useless/doc/rack/url'
-require 'useless/doc/rack/subject'
-require 'useless/doc/rack/html'
+require 'useless/doc/proxy/ui'
+require 'useless/doc/proxy/css'
+require 'useless/doc/proxy/url'
+require 'useless/doc/proxy/subject'
+require 'useless/doc/proxy/html'
 
 module Useless
   module Doc
-    class Rack
+    class Proxy
       def initialize(router = nil)
         @router = router || Useless::Doc::Router.default
       end
@@ -35,11 +35,11 @@ module Useless
             use Low::Rack::RequestLogger, key: 'useless.doc.logger'
             use ::Rack::CommonLogger
 
-            use Useless::Doc::Rack::UI
-            use Useless::Doc::Rack::CSS
-            use Useless::Doc::Rack::URL
-            use Useless::Doc::Rack::Subject
-            run Useless::Doc::Rack::HTML
+            use UI
+            use CSS
+            use URL
+            use Subject
+            run HTML
           end
         end
       end

data/lib/useless/doc/server/sinatra.rb

@@ -0,0 +1,85 @@
+require 'sinatra'
+
+require 'useless/doc/dsl'
+require 'useless/doc/serialization/dump'
+
+module Useless
+  module Doc
+      module Server
+
+      # Provides access to the +Doc::DSL+ via the +.doc+ method. The JSON of the
+      # API doc that is built will be served via an OPTIONS request to the root.
+      # Resource documentation is similarly served via an OPTIONS request to the
+      # corresponding path.
+      #
+      # @example
+      #   class ResourceApp < Sinatra::Base
+      #     register Useless::Doc::Sinatra
+      #
+      #     doc 'Resouces API' do
+      #       url 'resources.useless.io'
+      #       description 'A place with resources'
+      #     end
+      #
+      #     doc.get '/some-resources' do
+      #       description 'Get all of these resources'
+      #
+      #       request do
+      #         parameter 'page', 'The page of resources to return.'
+      #       end
+      #
+      #       response do
+      #         body do
+      #           attribute 'name', 'The name of the resource.'
+      #         end
+      #       end
+      #     end
+      #
+      #     ...
+      #
+      #   end
+      #
+      module Sinatra
+        def doc=(doc)
+          @doc = doc
+        end
+
+        def doc(name = nil, &block)
+          @dsl ||= Useless::Doc::DSL::API.new(name: name)
+          @dsl.instance_eval(&block) if block_given?
+          @dsl
+        end
+
+        def generated_doc
+          @doc ||= @dsl.generate if @dsl
+        end
+
+        def self.registered(app)
+          app.options '/' do
+            if api = self.class.generated_doc
+              last_modified api.timestamp
+              Useless::Doc::Serialization::Dump.api(api)
+            end
+          end
+
+          app.options '/*' do
+            if api = self.class.generated_doc
+              resource = api.resources.find do |resource|
+                resource.path == "/#{params[:splat].first}"
+              end
+
+              if resource
+                last_modified api.timestamp
+                return Useless::Doc::Serialization::Dump.resource(resource)
+              end
+            end
+
+            pass
+          end
+        end
+      end
+    end
+  end
+end
+
+Sinatra.register Useless::Doc::Server::Sinatra

data/lib/useless/doc/version.rb

@@ -1,5 +1,5 @@
 module Useless
   module Doc
-    VERSION = '0.4.0'
+    VERSION = '0.5.0'
   end
 end

data/spec/config.ru

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'uri'
 require 'useless/doc/router'
-require 'useless/doc/rack'
+require 'useless/doc/proxy'
 
 class TestRouter
   include Useless::Doc::Router
@@ -16,4 +16,4 @@ class TestRouter
   end
 end
 
-run Useless::Doc::Rack.new(TestRouter.new)
+run Useless::Doc::Proxy.new(TestRouter.new)

data/spec/useless/doc/client_spec.rb

@@ -11,7 +11,7 @@ describe Useless::Doc::Client::Standard do
   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: load_document('twonk.json').read))
+      and_return(mock(:response, response_code: 200, response_body: load_document('resource.json').read))
 
     resource = @client.get('http://some-api.granmal.com/some/resource')
     resource.path.should == '/twonks/:id'
@@ -32,7 +32,7 @@ describe Useless::Doc::Client::Standard do
 
     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: load_document('twonk.json').read))
+      and_return(mock(:response, response_code: 200, response_body: load_document('resource.json').read))
 
     Typhoeus.should_receive(:options).once.
       with('http://some-api.granmal.com/some/resource', headers: { 'Accept' => 'application/json', 'If-Modified-Since' => now.httpdate}).
@@ -47,7 +47,7 @@ end
 describe Useless::Doc::Client::Stub do
   it 'should serve files from the spec/documents directory' do
     client = Useless::Doc::Client.stub
-    resource = client.get('http://anything.useless.io/twonk')
+    resource = client.get('http://anything.useless.io/resource')
     resource.path.should == '/twonks/:id'
   end
 

data/spec/useless/doc/{rack → proxy}/css_spec.rb

@@ -1,10 +1,10 @@
 require File.dirname(__FILE__) + '/../../../spec_helper'
 
 require 'rack/test'
-require 'useless/doc/rack/css'
+require 'useless/doc/proxy/css'
 require 'useless/doc/ui/godel'
 
-describe Useless::Doc::Rack::CSS do
+describe Useless::Doc::Proxy::CSS do
   include Rack::Test::Methods
 
   def base_app
@@ -16,7 +16,7 @@ describe Useless::Doc::Rack::CSS do
   def app
     @app ||= lambda do |env|
       env['useless.doc.ui'] = Useless::Doc::UI::Godel
-      Useless::Doc::Rack::CSS.new(base_app).call(env)
+      Useless::Doc::Proxy::CSS.new(base_app).call(env)
     end
   end
 

data/spec/useless/doc/{rack → proxy}/html_spec.rb

@@ -3,9 +3,9 @@ require File.dirname(__FILE__) + '/../../../spec_helper'
 require 'rack/test'
 require 'useless/doc/ui/godel'
 require 'useless/doc/core/api'
-require 'useless/doc/rack/html'
+require 'useless/doc/proxy/html'
 
-describe Useless::Doc::Rack::HTML do
+describe Useless::Doc::Proxy::HTML do
   include Rack::Test::Methods
 
   before(:all) do
@@ -18,7 +18,7 @@ describe Useless::Doc::Rack::HTML do
       env['useless.doc.ui'] = @ui
       env['useless.doc.subject'] = @subject
 
-      Useless::Doc::Rack::HTML.call(env)
+      Useless::Doc::Proxy::HTML.call(env)
     end
   end
 

data/spec/useless/doc/{rack → proxy}/subject_spec.rb

@@ -1,9 +1,9 @@
 require File.dirname(__FILE__) + '/../../../spec_helper'
 
 require 'rack/test'
-require 'useless/doc/rack/subject'
+require 'useless/doc/proxy/subject'
 
-describe Useless::Doc::Rack::Subject do
+describe Useless::Doc::Proxy::Subject do
   include Rack::Test::Methods
 
   def app
@@ -13,7 +13,7 @@ describe Useless::Doc::Rack::Subject do
       end
 
       env['useless.doc.url'] = 'some.api.com'
-      Useless::Doc::Rack::Subject.new(base_app).call(env)
+      Useless::Doc::Proxy::Subject.new(base_app).call(env)
     end
   end
 

data/spec/useless/doc/{rack → proxy}/ui_spec.rb

@@ -1,9 +1,9 @@
 require File.dirname(__FILE__) + '/../../../spec_helper'
 
 require 'rack/test'
-require 'useless/doc/rack/ui'
+require 'useless/doc/proxy/ui'
 
-describe Useless::Doc::Rack::UI do
+describe Useless::Doc::Proxy::UI do
   include Rack::Test::Methods
 
   def app
@@ -12,7 +12,7 @@ describe Useless::Doc::Rack::UI do
         [200, {'Content-Type' => 'text/plain'}, [env['useless.doc.ui'].class.name]]
       end
 
-      Useless::Doc::Rack::UI.new(base_app)
+      Useless::Doc::Proxy::UI.new(base_app)
     end
   end
 

data/spec/useless/doc/{rack → proxy}/url_spec.rb

@@ -2,9 +2,9 @@ require File.dirname(__FILE__) + '/../../../spec_helper'
 
 require 'rack/test'
 require 'useless/doc/router'
-require 'useless/doc/rack/url'
+require 'useless/doc/proxy/url'
 
-describe Useless::Doc::Rack::URL do
+describe Useless::Doc::Proxy::URL do
   include Rack::Test::Methods
 
   def app
@@ -14,7 +14,7 @@ describe Useless::Doc::Rack::URL do
       end
 
       env['useless.doc.router'] = Useless::Doc::Router.default
-      Useless::Doc::Rack::URL.new(base_app).call(env)
+      Useless::Doc::Proxy::URL.new(base_app).call(env)
     end
   end
 

data/spec/useless/doc/{rack_spec.rb → proxy_spec.rb}

@@ -2,14 +2,14 @@ require File.dirname(__FILE__) + '/../../spec_helper'
 
 require 'rack/test'
 require 'useless/doc'
-require 'useless/doc/rack'
+require 'useless/doc/proxy'
 require 'useless/doc/client'
 
-describe Useless::Doc::Rack do
+describe Useless::Doc::Proxy do
   include Rack::Test::Methods
 
   def app
-    Useless::Doc::Rack.new
+    Useless::Doc::Proxy.new
   end
 
   it 'should return a 404 if the JSON cannot be retrieved' do
@@ -49,7 +49,7 @@ describe Useless::Doc::Rack do
   it 'should return resource HTML if proper JSON is retrieved' do
     Useless::Doc::Client.stub.should_receive(:get).
       with('http://some-api.useless.io/some/resource').
-      and_return(Useless::Doc.load.resource(load_document('twonk.json').read))
+      and_return(Useless::Doc.load.resource(load_document('resource.json').read))
 
     get 'http://some-api.doc.useless.io/some/resource'
     last_response.should be_ok

data/spec/useless/doc/serialization/load_spec.rb

@@ -33,7 +33,7 @@ describe Useless::Doc::Serialization::Load do
     end
 
     it 'should return a Resource instance if resource JSON is provided' do
-      document = load_document('twonk.json')
+      document = load_document('resource.json')
       resource = Useless::Doc::Serialization::Load.load document.read
       resource.should be_an_instance_of(Useless::Doc::Core::Resource)
     end
@@ -68,7 +68,7 @@ describe Useless::Doc::Serialization::Load do
 
   describe '.resource' do
     it 'should parse the specified JSON into a model hierarchy' do
-      document = load_document('twonk.json')
+      document = load_document('resource.json')
       resource = Useless::Doc::Serialization::Load.resource document.read
 
       resource.should be_a Useless::Doc::Core::Resource

data/spec/useless/doc/{sinatra_spec.rb → server/sinatra_spec.rb}

@@ -1,13 +1,13 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
+require File.dirname(__FILE__) + '/../../../spec_helper'
 
 require 'rack/test'
 require 'sinatra/base'
-require 'useless/doc/sinatra'
+require 'useless/doc/server/sinatra'
 require 'useless/doc/serialization/load'
 
-describe Useless::Doc::Sinatra do
+describe Useless::Doc::Server::Sinatra do
   class DocApp < Sinatra::Base
-    register Useless::Doc::Sinatra
+    register Useless::Doc::Server::Sinatra
 
     doc 'Resoruce API' do
       url 'resource.useless.io'

data/spec/useless/doc/ui/godel_spec.rb

@@ -118,7 +118,7 @@ describe Useless::Doc::UI::Godel do
 
     context 'for a Core::Resource instance' do
       before(:each) do
-        json = load_document('twonk.json').read
+        json = load_document('resource.json').read
         router = Useless::Doc::Router.default
         resource = Useless::Doc.load.resource json
         result = Useless::Doc::UI::Godel.new(router).html(resource)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: useless-doc
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-07 00:00:00.000000000 Z
+date: 2013-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -193,16 +193,16 @@ files:
 - lib/useless/doc/core/resource.rb
 - lib/useless/doc/core/response.rb
 - lib/useless/doc/dsl.rb
-- lib/useless/doc/rack.rb
-- lib/useless/doc/rack/css.rb
-- lib/useless/doc/rack/html.rb
-- lib/useless/doc/rack/subject.rb
-- lib/useless/doc/rack/ui.rb
-- lib/useless/doc/rack/url.rb
+- lib/useless/doc/proxy.rb
+- lib/useless/doc/proxy/css.rb
+- lib/useless/doc/proxy/html.rb
+- lib/useless/doc/proxy/subject.rb
+- lib/useless/doc/proxy/ui.rb
+- lib/useless/doc/proxy/url.rb
 - lib/useless/doc/router.rb
 - lib/useless/doc/serialization/dump.rb
 - lib/useless/doc/serialization/load.rb
-- lib/useless/doc/sinatra.rb
+- lib/useless/doc/server/sinatra.rb
 - lib/useless/doc/ui.rb
 - lib/useless/doc/ui/godel.rb
 - lib/useless/doc/ui/godel/api.mustache
@@ -213,20 +213,20 @@ files:
 - spec/config.ru
 - spec/documents/api.json
 - spec/documents/domain.json
-- spec/documents/twonk.json
+- spec/documents/resource.json
 - spec/spec_helper.rb
 - spec/useless/doc/client_spec.rb
 - spec/useless/doc/dsl_spec.rb
-- spec/useless/doc/rack/css_spec.rb
-- spec/useless/doc/rack/html_spec.rb
-- spec/useless/doc/rack/subject_spec.rb
-- spec/useless/doc/rack/ui_spec.rb
-- spec/useless/doc/rack/url_spec.rb
-- spec/useless/doc/rack_spec.rb
+- spec/useless/doc/proxy/css_spec.rb
+- spec/useless/doc/proxy/html_spec.rb
+- spec/useless/doc/proxy/subject_spec.rb
+- spec/useless/doc/proxy/ui_spec.rb
+- spec/useless/doc/proxy/url_spec.rb
+- spec/useless/doc/proxy_spec.rb
 - spec/useless/doc/router_spec.rb
 - spec/useless/doc/serialization/dump_spec.rb
 - spec/useless/doc/serialization/load_spec.rb
-- spec/useless/doc/sinatra_spec.rb
+- spec/useless/doc/server/sinatra_spec.rb
 - spec/useless/doc/ui/godel_spec.rb
 - useless-doc.gemspec
 homepage: 
@@ -257,18 +257,18 @@ test_files:
 - spec/config.ru
 - spec/documents/api.json
 - spec/documents/domain.json
-- spec/documents/twonk.json
+- spec/documents/resource.json
 - spec/spec_helper.rb
 - spec/useless/doc/client_spec.rb
 - spec/useless/doc/dsl_spec.rb
-- spec/useless/doc/rack/css_spec.rb
-- spec/useless/doc/rack/html_spec.rb
-- spec/useless/doc/rack/subject_spec.rb
-- spec/useless/doc/rack/ui_spec.rb
-- spec/useless/doc/rack/url_spec.rb
-- spec/useless/doc/rack_spec.rb
+- spec/useless/doc/proxy/css_spec.rb
+- spec/useless/doc/proxy/html_spec.rb
+- spec/useless/doc/proxy/subject_spec.rb
+- spec/useless/doc/proxy/ui_spec.rb
+- spec/useless/doc/proxy/url_spec.rb
+- spec/useless/doc/proxy_spec.rb
 - spec/useless/doc/router_spec.rb
 - spec/useless/doc/serialization/dump_spec.rb
 - spec/useless/doc/serialization/load_spec.rb
-- spec/useless/doc/sinatra_spec.rb
+- spec/useless/doc/server/sinatra_spec.rb
 - spec/useless/doc/ui/godel_spec.rb

data/lib/useless/doc/sinatra.rb

@@ -1,83 +0,0 @@
-require 'sinatra'
-
-require 'useless/doc/dsl'
-require 'useless/doc/serialization/dump'
-
-module Useless
-  module Doc
-
-    # Provides access to the +Doc::DSL+ via the +.doc+ method. The JSON of the
-    # API doc that is built will be served via an OPTIONS request to the root.
-    # Resource documentation is similarly served via an OPTIONS request to the
-    # corresponding path.
-    #
-    # @example
-    #   class ResourceApp < Sinatra::Base
-    #     register Useless::Doc::Sinatra
-    #
-    #     doc 'Resouces API' do
-    #       url 'resources.useless.io'
-    #       description 'A place with resources'
-    #     end
-    #
-    #     doc.get '/some-resources' do
-    #       description 'Get all of these resources'
-    #
-    #       request do
-    #         parameter 'page', 'The page of resources to return.'
-    #       end
-    #
-    #       response do
-    #         body do
-    #           attribute 'name', 'The name of the resource.'
-    #         end
-    #       end
-    #     end
-    #
-    #     ...
-    #
-    #   end
-    #
-    module Sinatra
-      def doc=(doc)
-        @doc = doc
-      end
-
-      def doc(name = nil, &block)
-        @dsl ||= Useless::Doc::DSL::API.new(name: name)
-        @dsl.instance_eval(&block) if block_given?
-        @dsl
-      end
-
-      def generated_doc
-        @doc ||= @dsl.generate if @dsl
-      end
-
-      def self.registered(app)
-        app.options '/' do
-          if api = self.class.generated_doc
-            last_modified api.timestamp
-            Useless::Doc::Serialization::Dump.api(api)
-          end
-        end
-
-        app.options '/*' do
-          if api = self.class.generated_doc
-            resource = api.resources.find do |resource|
-              resource.path == "/#{params[:splat].first}"
-            end
-
-            if resource
-              last_modified api.timestamp
-              return Useless::Doc::Serialization::Dump.resource(resource)
-            end
-          end
-
-          pass
-        end
-      end
-    end
-  end
-end
-
-Sinatra.register Useless::Doc::Sinatra