brief 1.3.2 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec9ccb7e1861ffc357e84038673da7f6505023b0
-  data.tar.gz: c54d945e486627df421b55e4b1bbccba9f9deb41
+  metadata.gz: c9072da715286e14af1d9bacfa63da385030de95
+  data.tar.gz: 1e46844b92f38e9ef77db154599e29c2e20f2d24
 SHA512:
-  metadata.gz: afc280b0d00cb5ad6bbcecd7b739d8b9f6bb74ed0c18cf03de02bef8b625d16ffccedd62f3a2f067ae0ec3971be80e6911e6350614ba984414de4f2d87b45d5c
-  data.tar.gz: d49a83e4d1afb37afa9c4ece0b1a741329399b2449acfd4212a251cd2f92f70802f6e06844f31a8dd056b2b544d1dd6fe4571758ee56030e140cdb8625f693c0
+  metadata.gz: 86022dbd77d0576533595a4f1e7538a3c9761e93bc4039f9b2dba559b9c243b802bce6ff2ce48f82cc6d7b66adc7106dec1b74f4d5c77d22590db725e444f5a7
+  data.tar.gz: 3446758f09912e6f91679584233b92a6a87b642bc4237d27d51500c5c75980c82a9cb2c39a01e974d12ee425dac9cd05b7107c31ef6e81a5152ecb3342861235

data/CHANGELOG.md

@@ -111,3 +111,9 @@ attributes.
 
 - Various performance fixes
 - Model package loading system foundation
+
+### 1.4.0
+
+- Brief::Server provides a REST interface to a briefcase
+- Brief::Server::Gateway provdies a REST wrapper around a folder of
+  briefcases

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    brief (1.3.1)
+    brief (1.4.1)
       activemodel
       activesupport
       commander
@@ -33,7 +33,7 @@ GEM
     coderay (1.1.0)
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)
-    commander (4.2.1)
+    commander (4.3.0)
       highline (~> 1.6.11)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
@@ -66,6 +66,8 @@ GEM
     pry-nav (0.2.4)
       pry (>= 0.9.10, < 0.11.0)
     rack (1.6.0)
+    rack-test (0.6.3)
+      rack (>= 1.0)
     rake (10.4.2)
     redcarpet (3.2.2)
     rspec (3.1.0)
@@ -101,5 +103,6 @@ DEPENDENCIES
   bundler (~> 1.3)
   pry
   pry-nav
+  rack-test
   rake
   rspec

data/brief.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry"
   spec.add_development_dependency "pry-nav"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rack-test"
 
 end
 

data/lib/brief/briefcase.rb

@@ -30,6 +30,14 @@ module Brief
       Brief::Configuration.instance
     end
 
+    def server(options={})
+      @server ||= Brief::Server.new(self, options)
+    end
+
+    def folder_name
+      root.basename
+    end
+
     # Loads the configuration for this briefcase, either from the current working directory
     # or the configured path for the configuration file.
     def load_configuration
@@ -37,6 +45,10 @@ module Brief
         root.join('brief.rb')
       end
 
+      if config_path.is_a?(String)
+        config_path = root.join(config_path)
+      end
+
       if uses_app?
         instance_eval(app_path.join("config.rb").read)
       end

data/lib/brief/document/front_matter.rb

@@ -3,8 +3,18 @@ module Brief
     module FrontMatter
       extend ActiveSupport::Concern
 
+      def frontmatter= attributes
+        @frontmatter = attributes
+      end
+
+      def data= attributes
+        self.frontmatter= attributes
+      end
+
       def frontmatter
-        @frontmatter || load_frontmatter
+        (@frontmatter || load_frontmatter).tap do |d|
+          d[:type] ||= parent_folder_name && parent_folder_name.to_s.singularize if parent_folder_name && parent_folder_name.length > 0
+        end
       end
 
       def frontmatter_line_count
@@ -19,6 +29,8 @@ module Brief
           @frontmatter_line_count = Regexp.last_match[1].lines.size
           @raw_frontmatter = Regexp.last_match[1]
           @frontmatter = YAML.load(Regexp.last_match[1]).to_mash
+        else
+          @frontmatter = {}.to_mash
         end
       end
     end

data/lib/brief/document.rb

@@ -25,10 +25,32 @@ module Brief
       model_class.try(:models).try(:<<, to_model) unless model_instance_registered?
     end
 
+    def save
+      path.open('w') {|fh| fh.write(combined_data_and_content) }
+    end
+
+    def save!
+      path.open('w+') {|fh| fh.write(combined_data_and_content) }
+    end
+
+    def combined_data_and_content
+      return content if data.nil? || data.empty?
+      frontmatter.to_hash.to_yaml + "---\n\n#{ content }"
+    end
+
     def data
       frontmatter
     end
 
+    def in_briefcase(briefcase)
+      @briefcase = briefcase
+      self
+    end
+
+    def briefcase
+      @briefcase || Brief.case
+    end
+
     def sections
       mappings = model_class.section_mappings
 
@@ -42,6 +64,10 @@ module Brief
       @sections
     end
 
+    def content= value
+      @content = value
+    end
+
     def content
       @content || generate_content
     end
@@ -88,11 +114,34 @@ module Brief
     end
 
     def to_model
-      model_class.new(data.to_hash.merge(path: path, document: self)) if model_class
+      model_class.new((data || {}).to_hash.merge(path: path, document: self)) if model_class
+    end
+
+    def exist?
+      path && path.exist?
     end
 
     def model_class
-      @model_class || ((data && data.type) && Brief::Model.for_type(data.type))
+      case
+      when @model_class
+        @model_class
+      when data && data.type
+        Brief::Model.for_type(data.type)
+      when parent_folder_name.length > 0
+        Brief::Model.for_folder_name(parent_folder_name)
+      else
+        raise 'Could not determine the model class to use for this document. Specify the type, or put it in a folder that maps to the correct type.'
+      end
+    end
+
+    def document_type
+      existing = data && data.type
+      return existing if existing
+      parent_folder_name.try(:singularize)
+    end
+
+    def parent_folder_name
+      path.parent.basename.to_s.downcase
     end
 
     # Each model class tracks the instances of the models created
@@ -105,7 +154,7 @@ module Brief
     end
 
     def respond_to?(method)
-      super || data.respond_to?(method) || data.key?(method)
+      super || (data && data.respond_to?(method)) || (data && data.key?(method))
     end
 
     def structure

data/lib/brief/model/serializers.rb

@@ -0,0 +1,19 @@
+module Brief::Model::Serializers
+  def as_json
+    {
+      data: data,
+      path: path.to_s,
+      type: type,
+      actions: self.class.defined_actions,
+      urls: {
+        view_content_url: "/view/content/#{ path }",
+        view_rendered_url: "/view/rendered/#{ path }",
+        view_details_url: "/view/details/#{ path }",
+        update_url: "/update/#{ path }",
+        remove_url: "/remove/#{ path }",
+        schema_url: "/schema/#{ type }",
+        actions_url: "/actions/:action/#{ path }"
+      }
+    }
+  end
+end

data/lib/brief/model.rb

@@ -12,6 +12,7 @@ module Brief
       include Initializers
       include AccessorMethods
       include Persistence
+      include Serializers
 
       class_attribute :models, :after_initialization_hooks
 
@@ -45,7 +46,7 @@ module Brief
           if document.respond_to?(meth)
             document.send(meth)
           else
-            document.data.key?(meth) ? data[meth] : extracted.send(meth)
+            document.data && document.data.key?(meth) ? data[meth] : extracted.send(meth)
           end
         else
           super
@@ -63,10 +64,19 @@ module Brief
       end
     end
 
+    def self.lookup(type_alias)
+      for_type(type_alias) || for_folder_name(type_alias) || for_type(type_alias.singularize)
+    end
+
     def self.for_type(type_alias)
       table[type_alias]
     end
 
+    def self.for_folder_name(folder_name=nil)
+      folder_name = folder_name.to_s.downcase
+      table[folder_name.singularize] || table[folder_name]
+    end
+
     def self.lookup_class_from_args(args = [])
       args = Array(args)
 
@@ -89,6 +99,16 @@ module Brief
     end
 
     module ClassMethods
+      def to_schema
+        {
+          content: definition.content_schema,
+          metadata: definition.metadata_schema,
+          class_name: to_s,
+          type_alias: type_alias,
+          name: name
+        }
+      end
+
       def has_actions?
         definition.has_actions?
       end

data/lib/brief/repository.rb

@@ -16,6 +16,31 @@ module Brief
       load_documents
     end
 
+    def document_at(path)
+      path = normalize_path(path)
+      Brief::Document.new(path)
+    end
+
+    def documents_at!(*paths)
+      documents_at(*paths).select {|doc| doc.path.exist? }
+    end
+
+    def normalize_path(p)
+      docs_path.join(p)
+    end
+
+    def documents_at(*paths)
+      paths.compact!
+
+      paths.map! {|p| normalize_path(p) }
+
+      paths.map {|p| p && Brief::Document.new(p)}
+    end
+
+    def models_at(*paths)
+      documents_at(*paths).map(&:to_model)
+    end
+
     def documents
       return @documents if @documents
       load_documents
@@ -33,9 +58,13 @@ module Brief
       briefcase.root
     end
 
+    def docs_path
+      briefcase.docs_path
+    end
+
     def load_documents
       @documents = document_paths.map do |path|
-        Brief::Document.new(path)
+        Brief::Document.new(path).in_briefcase(briefcase)
       end
     end
 

data/lib/brief/server/gateway.rb

@@ -0,0 +1,36 @@
+class Brief::Server::Gateway
+  attr_reader :root
+
+  def initialize(options={})
+    @root = options.fetch(:root)
+    @briefcases = {}
+    @briefcase_options = options.fetch(:briefcase_options, {})
+    load_briefcases
+  end
+
+  def briefcase_options
+    (@briefcase_options || {})
+  end
+
+  def load_briefcases
+    config_path = briefcase_options.fetch(:config_path, "brief.rb")
+
+    root.children.select(&:directory?).each do |dir|
+      if dir.join(config_path).exist?
+        slug = dir.basename.to_s.parameterize
+        @briefcases[slug] ||= Brief::Briefcase.new(briefcase_options.merge(root: dir))
+      end
+    end
+  end
+
+  def call(env)
+    request = Rack::Request.new(env)
+    name    = request.path.match(/\/\w+\/(\w+)/)[1] rescue nil
+
+    if name && @briefcases[name]
+      @briefcases[name].server.call(env)
+    else
+      [404, {}, ["Not found: #{ name } -- #{ request.path }"]]
+    end
+  end
+end

data/lib/brief/server/handlers/action.rb

@@ -0,0 +1,28 @@
+module Brief::Server::Handlers
+  class Action
+    def self.handle(path_args, briefcase, options={})
+      parts = path_args.split("/")
+      action = parts.shift
+      path = parts.join("/")
+
+      document = briefcase.document_at(path)
+
+      headers = {
+        "Content-Type" => "application/json"
+      }
+
+      if !document
+        return [404,headers,{error:"Could not find a document at this path"}]
+      end
+
+      model = document.to_model
+
+      if !model.class.defined_actions.include?(action.to_sym)
+        [400, headers, {error:"Invalid action: #{ action }"}]
+      else
+        model.send(action)
+        [200, headers, model.as_json]
+      end
+    end
+  end
+end

data/lib/brief/server/handlers/browse.rb

@@ -0,0 +1,8 @@
+module Brief::Server::Handlers
+  class Browse
+    def self.handle(path_args, briefcase, options={})
+      models = Array((briefcase.send(path_args) rescue nil))
+      [200, {"Content-Type"=>"application/json"}, models.map(&:as_json)]
+    end
+  end
+end

data/lib/brief/server/handlers/info.rb

@@ -0,0 +1,7 @@
+module Brief::Server::Handlers
+  class Info
+    def self.handle(*args)
+      [200, {}, {}]
+    end
+  end
+end

data/lib/brief/server/handlers/modify.rb

@@ -0,0 +1,101 @@
+module Brief::Server::Handlers
+  class Modify
+    def self.handle(path_args, briefcase, options={})
+      action = options.fetch(:action)
+      request = options.fetch(:request)
+
+      writer = Writer.new(briefcase, path_args, request.params.symbolize_keys)
+
+      headers = {"Content-Type"=>"application/json"}
+
+      response = writer.run(action)
+
+      if writer.has_errors?
+        [500, headers, {errors: writer.errors, path: path_args}]
+      else
+        [200, headers, response]
+      end
+    end
+
+    class Writer
+      attr_accessor :briefcase, :params, :path
+
+      def initialize(briefcase, path_args, params)
+        @params = params
+        @briefcase = briefcase
+        @errors = {}
+        @path = briefcase.normalize_path(path_args)
+
+        raise "Invalid path for document write" unless @path
+      end
+
+      def run(action)
+        if !respond_to?(action)
+          @errors[:action] = "invalid"
+          return @errors
+        end
+
+        send(action)
+      end
+
+      def ok?
+        @errors.empty?
+      end
+
+      def has_errors?
+        not ok?
+      end
+
+      def create
+        data      = params[:data]
+        contents  = params[:contents]
+
+        if path && path.exist?
+          @errors[:path] = "Path already exists"
+          return @errors
+        end
+
+        doc = Brief::Document.new(path).tap do |document|
+          document.content = contents if contents.to_s.length > 0
+          document.data = data if data && !data.empty?
+          document.save!
+        end
+
+        doc.to_model
+      end
+
+      def remove
+        doc = Brief::Document.new(path)
+        doc.path.unlink rescue nil
+
+        {
+          success: ok?,
+          path: path
+        }
+      end
+
+      def update
+        document = Brief::Document.new(path)
+
+        if document.nil? || !document.exist?
+          @errors[:document] = "No document was found at #{ path_args }"
+          @errors
+        else
+          document.contents = params[:contents] if params[:contents]
+          document.data = (document.data || {}).merge(params[:data]) if params[:data].is_a?(Hash)
+          document.save
+
+          document.to_model
+        end
+      end
+
+      def delete
+        remove
+      end
+
+      def errors
+        @errors || {}
+      end
+    end
+  end
+end

data/lib/brief/server/handlers/schema.rb

@@ -0,0 +1,21 @@
+module Brief::Server::Handlers
+  class Schema
+    def self.handle(path_args, briefcase, options)
+      request = options.fetch(:request)
+
+      headers = {"Content-Type"=>"application/json"}
+
+      if request.path == "/schema"
+        [200, headers, Brief::Model.classes.map(&:to_schema)]
+      elsif request.path.match(/^\/schema\/(.+)$/)
+        requested = request.path.split("/").last
+
+        if model = Brief::Model.lookup(requested)
+          [200, headers, model.to_schema]
+        else
+          [404, headers, {error: "Can not find model class matching #{ requested }"}]
+        end
+      end
+    end
+  end
+end

data/lib/brief/server/handlers/show.rb

@@ -0,0 +1,35 @@
+module Brief::Server::Handlers
+  class Show
+    def self.handle(path_args, briefcase, options={})
+      action    = options.fetch(:action)
+      request   = options.fetch(:request)
+      parts     = path_args.split("/")
+      view      = parts.shift.to_s.downcase
+      path      = parts.join("/")
+
+      document = briefcase.document_at(path) rescue nil
+
+      code          = 200
+      content_type  = "application/json"
+
+      case
+      when document.nil?
+        code = 404
+        body = {error: "Not found"}
+      when !%w(content rendered details).include?(view)
+        code = 400
+        body = {error: "Invalid view: must be content, rendered, details" }
+      when document && view == "content"
+        body = document.combined_data_and_content
+        content_type = "text/plain"
+      when document && view == "rendered"
+        body = document.to_html
+        content_type = "text/html"
+      when document && view == "details"
+        body = document.to_model.as_json
+      end
+
+      [code, {"Content-Type"=>content_type}, body]
+    end
+  end
+end

data/lib/brief/server/route.rb

@@ -0,0 +1,75 @@
+class Brief::Server::Route
+  attr_reader :env, :request, :briefcase, :prefix
+  attr_accessor :code, :headers, :body
+
+  def initialize(env, briefcase, options={})
+    @env = env
+    @request = Rack::Request.new(env)
+    @briefcase = briefcase
+    @prefix = options.fetch(:prefix) {"/briefcases/#{ briefcase.folder_name.to_s.parameterize }"}
+    @code = 400
+    @headers = {}
+    @body = {}
+  end
+
+  def respond
+    status, headers, body = response_data
+    [status, headers, body]
+  end
+
+  private
+
+    def response_data
+      resp = handler.handle(path_args, briefcase, request: request, action: path_action)
+
+      self.code = resp[0]
+      self.headers.merge(resp[1])
+      self.body = resp[2]
+
+      [code, headers, body]
+    end
+
+    def handlers
+      Brief::Server::Handlers
+    end
+
+    def handler
+      case
+      when request.path.match(/^\/schema/)
+        handlers.const_get(:Schema)
+      when path_action == "browse"
+        handlers.const_get(:Browse)
+      when %w(create update delete remove).include?(path_action)
+        handlers.const_get(:Modify)
+      when path_action == "actions"
+        handlers.const_get(:Action)
+      when path_action == "view"
+        handlers.const_get(:Show)
+      else
+        handlers.const_get(:Info)
+      end
+    end
+
+    def format
+      "application/json"
+    end
+
+    def without_prefix
+      request.path.gsub(prefix, '')
+    end
+
+    def path_action
+      without_prefix[/^\/(\w+)\/(.+)$/, 1].to_s.downcase
+    end
+
+    def path_args
+      without_prefix[/^\/(\w+)\/(.+)$/, 2]
+    end
+end
+
+require "brief/server/handlers/action"
+require "brief/server/handlers/info"
+require "brief/server/handlers/browse"
+require "brief/server/handlers/modify"
+require "brief/server/handlers/schema"
+require "brief/server/handlers/show"

data/lib/brief/server.rb

@@ -0,0 +1,25 @@
+class Brief::Server
+  attr_reader :options, :briefcase
+
+  def initialize(briefcase, options={})
+    @briefcase = briefcase
+    @options = options
+  end
+
+  def call(env)
+    request = Brief::Server::Route.new(env, briefcase, options)
+    status, headers, body = request.respond()
+
+    body = body.to_json if body.is_a?(Hash)
+    body = body.to_json if body.is_a?(Array)
+    body = "" if body.nil?
+
+    headers["Content-Length"]                 = Rack::Utils.bytesize(body)
+    headers["Access-Control-Allow-Origin"]    = "*"
+    headers["Access-Control-Allow-Methods"]   = "GET, POST, PUT"
+
+    [status, headers, [body]]
+  end
+end
+
+require 'brief/server/route'

data/lib/brief/version.rb

@@ -1,3 +1,3 @@
 module Brief
-  VERSION = '1.3.2'
+  VERSION = '1.4.1'
 end

data/lib/brief.rb

@@ -80,5 +80,7 @@ require 'brief/repository'
 require 'brief/model'
 require 'brief/model/definition'
 require 'brief/model/persistence'
+require 'brief/model/serializers'
 require 'brief/dsl'
+require 'brief/server'
 require 'brief/briefcase'

data/spec/acceptance/browsing_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+describe "Browsing a Briefcase REST Interface", :type => :request do
+  it "responds to requests" do
+    get "/"
+    expect(last_response.status).to eq(200)
+  end
+
+  it "shows me all of the documents for the requested type" do
+    get "/browse/epics"
+    expect(json).to be_a(Array)
+    expect(json.first).to be_a(Hash)
+    expect(last_response.status).to eq(200)
+  end
+end

data/spec/acceptance/modifying_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+describe "Modifying Documents", :type => :request do
+  it "lets me create new documents" do
+    post "/create/epics/newly-created-epic.html.md", contents: "# Epic Title"
+  end
+
+  it "lets me update existing documents" do
+    needle = rand(36**36).to_s(36)
+    post "/update/concept.html.md", contents: "# Modified Content #{ needle }"
+    expect(last_response.status).to eq(200)
+  end
+
+  it "lets me update just the metadata for an existing document" do
+    needle = rand(36**36).to_s(36)
+    post "/update/concept.html.md", data: {needle: needle}
+    expect(last_response.status).to eq(200)
+  end
+
+  it "lets me remove documents" do
+    post "/remove/epics/newly-created-epic.html.md"
+    expect(last_response.status).to eq(200)
+  end
+
+  it "lets me run actions on documents" do
+    post "/actions/custom_action/epics/epic.html.md"
+    expect(last_response.status).to eq(200)
+  end
+end

data/spec/acceptance/schema_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+describe "Briefcase Document Schema", :type => :request do
+  it "gives me information about the schema" do
+    get("/schema")
+    expect(last_response.status).to eq(200)
+  end
+
+  it "gives me information about a document type" do
+    get("/schema/epic")
+    expect(last_response.status).to eq(200)
+  end
+end

data/spec/acceptance/showing_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+
+describe "Viewing a Briefcase Document", :type => :request do
+  it "shows the document content" do
+    get("/view/content/epics/epic.html.md")
+    expect(last_response.status).to eq(200)
+  end
+
+  it "shows the rendered version of the document" do
+    get("/view/rendered/epics/epic.html.md")
+    expect(last_response.status).to eq(200)
+  end
+
+  it "shows the rendered version of the document json" do
+    get("/view/details/epics/epic.html.md")
+    expect(last_response.status).to eq(200)
+  end
+end

data/spec/fixtures/example/docs/concept.html.md

@@ -1,5 +1,8 @@
 ---
 type: concept
 title: Blueprint Concept Example
-subheading: A key concept to the domain model 
+subheading: A key concept to the domain model
+contents: "# Modified Content 6sq2t5qtwxij7o06183sgfzrpar4bz38kam5"
+needle: b6w280kygg5axjfxsyi8gwtjvox2y6u9k785
 ---
+

data/spec/lib/brief/document_spec.rb

@@ -2,8 +2,21 @@ require "spec_helper"
 
 describe "The Brief Document" do
   let(:sample) do
-    path = Brief.example_path.join("docs","epic.html.md")
-    Brief::Document.new(path)
+    Brief.example_document
+  end
+
+  it "creates a new doc if the path doesn't exist" do
+    begin
+      new_path = Brief.testcase.docs_path.join("newly-created.html.md")
+      doc = Brief::Document.new(new_path)
+      doc.data= {}
+      doc.content= "sup"
+      doc.save!
+
+      expect(doc).to be_exist
+    ensure
+      FileUtils.rm_rf(new_path)
+    end
   end
 
   it "renders html" do
@@ -14,11 +27,18 @@ describe "The Brief Document" do
     expect(sample.css("h1").length).to eq(2)
   end
 
-
   it "deserializes YAML frontmatter into attributes" do
     expect(sample.frontmatter.type).to eq("epic")
   end
 
+  it "references the parent folder name" do
+    expect(sample.parent_folder_name).to eq("epics")
+  end
+
+  it "can resolve the model type using the parent folder name if possible" do
+    expect(Brief::Model.for_folder_name(sample.parent_folder_name)).to eq(Brief::Epic)
+  end
+
   context "Content Extraction" do
     it "extracts content from a css selector" do
       extracted = sample.extract_content(:args => ["h1:first-of-type"])

data/spec/lib/brief/model_spec.rb

@@ -5,6 +5,10 @@ describe "The Brief Model" do
   let(:epic) { briefcase.epics.first }
   let(:user_story) { briefcase.user_stories.first }
 
+  it "exposes information about its schema" do
+    expect(epic.class.to_schema.keys).to include(:content, :metadata, :name, :class_name, :type_alias)
+  end
+
   context "DSL Style Declarations" do
     it "picks up a definition of 'User Story'" do
       expect(briefcase.model("User Story")).to be_present

data/spec/lib/brief/rendering_spec.rb

@@ -2,12 +2,11 @@ require "spec_helper"
 
 describe "Brief HTML Rendering" do
   let(:sample) do
-    path = Brief.example_path.join("docs","epic.html.md")
-    Brief::Document.new(path)
+    Brief.example_document
   end
 
   it "wraps the document with some identifying details" do
-    expect(sample.to_html).to include("docs/epic.html.md")
+    expect(sample.to_html).to include("docs/epics/epic.html.md")
   end
 
   it "wraps the higher level headings under section elements" do

data/spec/lib/brief/repository_spec.rb

@@ -7,6 +7,12 @@ describe "The Brief Document Repository" do
     expect(repository.documents).not_to be_empty
   end
 
+  it "gives me the document models for paths" do
+    paths = ["./concept.html.md", "wireframe.html.md", "epics/epic.html.md", Brief.example_document.path.realpath]
+
+    docs = repository.documents_at(*paths)
+  end
+
   context "querying api" do
     it "finds the first document matching a query" do
       query = repository.where(state:"active")

data/spec/lib/brief/server/gateway_spec.rb

@@ -0,0 +1,18 @@
+require "brief/server/gateway"
+require "spec_helper"
+
+describe "Briefcase Server Gateway" do
+  let(:gateway) do
+    Brief::Server::Gateway.new(root: Brief.spec_root.join("fixtures"))
+  end
+
+  it "routes requests to briefcase projects inside a folder" do
+    response = gateway.call(env_for("/briefcases/example/browse/epics"))
+    status, headers, body = response
+    json = JSON.parse(response.last.first)
+
+    expect(status).to eq(200)
+    expect(headers["Access-Control-Allow-Origin"]).to eq("*")
+    expect(json.length).to eq(2)
+  end
+end

data/spec/lib/brief/server/route_spec.rb

@@ -0,0 +1,44 @@
+require "spec_helper"
+
+describe Brief::Server::Route do
+
+  it "routes to the browse handler" do
+    expect(handler_for("/browse/epics")).to eq(Brief::Server::Handlers::Browse)
+  end
+
+  it "routes to the create handler" do
+    expect(handler_for("/create/epics/new.html.md")).to eq(Brief::Server::Handlers::Modify)
+  end
+
+  it "routes to the update handler" do
+    expect(handler_for("/update/epics/new.html.md")).to eq(Brief::Server::Handlers::Modify)
+  end
+
+  it "routes to the remove handler" do
+    expect(handler_for("/remove/epics/new.html.md")).to eq(Brief::Server::Handlers::Modify)
+  end
+
+  it "routes to the actions handler" do
+    expect(handler_for("/actions/custom_action/epics/epic.html.md")).to eq(Brief::Server::Handlers::Action)
+  end
+
+  it "routes to the schema browse handler" do
+    expect(handler_for("/schema")).to eq(Brief::Server::Handlers::Schema)
+  end
+
+  it "routes to the schema details handler" do
+    expect(handler_for("/schema/epic")).to eq(Brief::Server::Handlers::Schema)
+  end
+
+  it "routes to the view content handler" do
+    expect(handler_for("/view/content/epics/epic.html.md")).to eq(Brief::Server::Handlers::Show)
+  end
+
+  it "routes to the view rendered handler" do
+    expect(handler_for("/view/rendered/epics/epic.html.md")).to eq(Brief::Server::Handlers::Show)
+  end
+
+  it "routes to the view details handler" do
+    expect(handler_for("/view/details/epics/epic.html.md")).to eq(Brief::Server::Handlers::Show)
+  end
+end

data/spec/lib/brief/structure_spec.rb

@@ -2,8 +2,7 @@ require "spec_helper"
 
 describe "Document Structure Information" do
   let(:sample) do
-    path = Brief.example_path.join("docs","epic.html.md")
-    Brief::Document.new(path)
+    Brief.example_document
   end
 
   let(:one) do

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require 'pry'
+require 'rack/test'
 require 'brief'
 
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
@@ -12,6 +13,11 @@ module Brief
     testcase.root
   end
 
+  def self.example_document
+    path = Brief.example_path.join("docs","epics","epic.html.md")
+    Brief::Document.new(path)
+  end
+
   def self.testcase
     @example ||= Brief::Briefcase.new(root:spec_root.join("fixtures","example"))
   end
@@ -19,5 +25,6 @@ end
 
 RSpec.configure do |config|
   config.mock_with :rspec
-  #config.order = "random"
+  config.include Rack::Test::Methods
+  config.include TestHelpers
 end

data/spec/support/test_helpers.rb

@@ -0,0 +1,22 @@
+module TestHelpers
+  def app
+    Brief.testcase.server
+  end
+
+  def json
+    @json ||= JSON.parse(last_response.body)
+  end
+
+  def env_for(*args)
+    Rack::MockRequest.send(:env_for, *args)
+  end
+
+  def route_for(*args)
+    env = env_for(*args)
+    Brief::Server::Route.new(env, Brief.testcase)
+  end
+
+  def handler_for(*args)
+    route_for(*args).send(:handler)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brief
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.1
 platform: ruby
 authors:
 - Jonathan Soeder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-05 00:00:00.000000000 Z
+date: 2015-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -206,6 +206,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Brief is a library for developing applications whose primary interface
   is the text editor
 email:
@@ -250,12 +264,26 @@ files:
 - lib/brief/model.rb
 - lib/brief/model/definition.rb
 - lib/brief/model/persistence.rb
+- lib/brief/model/serializers.rb
 - lib/brief/repository.rb
+- lib/brief/server.rb
+- lib/brief/server/gateway.rb
+- lib/brief/server/handlers/action.rb
+- lib/brief/server/handlers/browse.rb
+- lib/brief/server/handlers/info.rb
+- lib/brief/server/handlers/modify.rb
+- lib/brief/server/handlers/schema.rb
+- lib/brief/server/handlers/show.rb
+- lib/brief/server/route.rb
 - lib/brief/util.rb
 - lib/brief/version.rb
+- spec/acceptance/browsing_spec.rb
+- spec/acceptance/modifying_spec.rb
+- spec/acceptance/schema_spec.rb
+- spec/acceptance/showing_spec.rb
 - spec/fixtures/example/brief.rb
 - spec/fixtures/example/docs/concept.html.md
-- spec/fixtures/example/docs/epic.html.md
+- spec/fixtures/example/docs/epics/epic.html.md
 - spec/fixtures/example/docs/persona.html.md
 - spec/fixtures/example/docs/release.html.md
 - spec/fixtures/example/docs/resource.html.md
@@ -274,6 +302,8 @@ files:
 - spec/lib/brief/rendering_spec.rb
 - spec/lib/brief/repository_spec.rb
 - spec/lib/brief/section_builder_spec.rb
+- spec/lib/brief/server/gateway_spec.rb
+- spec/lib/brief/server/route_spec.rb
 - spec/lib/brief/structure_spec.rb
 - spec/lib/brief/template_spec.rb
 - spec/spec_helper.rb
@@ -304,9 +334,13 @@ signing_key:
 specification_version: 4
 summary: Brief makes writing more powerful
 test_files:
+- spec/acceptance/browsing_spec.rb
+- spec/acceptance/modifying_spec.rb
+- spec/acceptance/schema_spec.rb
+- spec/acceptance/showing_spec.rb
 - spec/fixtures/example/brief.rb
 - spec/fixtures/example/docs/concept.html.md
-- spec/fixtures/example/docs/epic.html.md
+- spec/fixtures/example/docs/epics/epic.html.md
 - spec/fixtures/example/docs/persona.html.md
 - spec/fixtures/example/docs/release.html.md
 - spec/fixtures/example/docs/resource.html.md
@@ -325,6 +359,8 @@ test_files:
 - spec/lib/brief/rendering_spec.rb
 - spec/lib/brief/repository_spec.rb
 - spec/lib/brief/section_builder_spec.rb
+- spec/lib/brief/server/gateway_spec.rb
+- spec/lib/brief/server/route_spec.rb
 - spec/lib/brief/structure_spec.rb
 - spec/lib/brief/template_spec.rb
 - spec/spec_helper.rb