reorganizes fundamental structure of an api-blueprint doc and all of its components

Author: s-mang

.gitignore

@@ -25,3 +25,7 @@ _cgo_export.*
 *.exe
 *.test
 *.prof
+
+# Images
+*.jpg
+

apiary.apib

@@ -4,7 +4,7 @@ HOST: http://gist.github.com
 # Github Gists
 The best place to host your code snippits!
 
-# Group Gists
+# ResourceGroup Gists
 A Gist is a simple way to share snippets and pastes with others. All gists are Git repositories, so they are automatically versioned, forkable and usable from Git.
 
 + Request 
@@ -76,7 +76,7 @@ A Gist is a simple way to share snippets and pastes with others. All gists are G
 				}
 			]
 
-# Group Repos
+# ResourceGroup Repos
 A Repo is an on-disk data structure which stores metadata for a set of files and/or directory structure.
 
 + Request 

blueprint/main.go renamed to blueprint/_main.go

@@ -32,11 +32,11 @@ func main() {
 						Description: "A specific weather-foo.com account-holder",
 						Parameters: []*Parameter{
 							&Parameter{
-								Name:         "id",
-								ExampleValue: "1",
-								Type:         Number,
-								IsRequired:   true,
-								Description:  "user account identifier",
+								Name:        "id",
+								Value:       "1",
+								Type:        Number,
+								IsRequired:  true,
+								Description: "user account identifier",
 							},
 						},
 						Actions: []*Action{

blueprint/action.go

@@ -1,103 +1,14 @@
 package blueprint
 
-import (
-	"bytes"
-	"io"
-	"io/ioutil"
-	"net/http"
-	"net/http/httptest"
-	"net/url"
-)
-
 type Action struct {
-	HTTPMethod string
-	URI        *url.URL
-	Parameters []*Parameter
-	Requests   []*Request
-
-	// Todo:
-	// - Relation
-	// - Attributes
-	// - Schema
-}
-
-func NewAction(uri *url.URL, httpMethod string) *Action {
-	return &Action{
-		HTTPMethod: httpMethod,
-		URI:        uri,
-	}
-}
-
-type httpIO struct {
 	Name        string
 	Description string
-	Header      http.Header
-	ContentType string
-	Body        *bytes.Buffer
+	Parameters  []*api.Parameter
+	Requests    []*api.Request
+	Responses   []*api.Response
 
 	// Todo:
-	// - Schema
-	// - Attributes
-}
-
-type Request struct {
-	httpIO
-	Responses []*Response
-}
-
-func NewRequest(name, description string, req *http.Request) (breq *Request, err error) {
-	var body *bytes.Buffer
-
-	body, err = copyBody(req.Body)
-	if err != nil {
-		return
-	}
-
-	return &Request{
-		httpIO{
-			Name:        name,
-			Description: description,
-			Header:      req.Header,
-			ContentType: req.Header.Get("Content-Type"),
-			Body:        body,
-		},
-		nil,
-	}, nil
-}
-
-type Response struct {
-	StatusCode int
-	httpIO
-}
-
-func NewResponse(name, description string, w httptest.ResponseRecorder) (resp *Response, err error) {
-	var body *bytes.Buffer
-
-	body, err = copyBody(w.Body)
-	if err != nil {
-		return
-	}
-
-	return &Response{
-		w.Code,
-		httpIO{
-			Name:        name,
-			Description: description,
-			Header:      w.Header(),
-			ContentType: w.Header().Get("Content-Type"),
-			Body:        body,
-		},
-	}, nil
-}
-
-func copyBody(r io.Reader) (buf *bytes.Buffer, err error) {
-	body, err := ioutil.ReadAll(r)
-	if err != nil {
-		return buf, err
-	}
-
-	buf = bytes.NewBuffer(body)
-	r = bytes.NewBuffer(body)
-
-	return
+	// Relation
+	// Attributes
+	// Schema
 }

blueprint/api/parameter.go

@@ -0,0 +1,20 @@
+package blueprint
+
+type ParameterType int
+
+const (
+	Number ParameterType = iota
+	String
+	Boolean
+)
+
+type Parameter struct {
+	Name        string
+	Description string
+	Value       string
+	Type        ParameterType
+	IsRequired  bool
+
+	// Todo:
+	// DefaultValue
+}

blueprint/api/request.go

@@ -0,0 +1,37 @@
+package blueprint
+
+import (
+	"bytes"
+	"net/http"
+)
+
+type Request struct {
+	Name        string
+	Description string
+	Headers     http.Header
+	Body        *bytes.Buffer
+
+	// Todo:
+	// Attributes
+	// Schema
+}
+
+func NewRequest(name, description string, req *http.Request) (breq *Request, err error) {
+	var body *bytes.Buffer
+
+	body, err = copyBody(req.Body)
+	if err != nil {
+		return
+	}
+
+	return &Request{
+		httpIO{
+			Name:        name,
+			Description: description,
+			Header:      req.Header,
+			ContentType: req.Header.Get("Content-Type"),
+			Body:        body,
+		},
+		nil,
+	}, nil
+}

blueprint/api/response.go

@@ -0,0 +1,38 @@
+package blueprint
+
+import (
+	"bytes"
+	"net/http"
+	"net/http/httptest"
+)
+
+type Response struct {
+	StatusCode  int
+	Description string
+	Headers     http.Header
+	Body        *bytes.Buffer
+
+	// Todo:
+	// Attributes
+	// Schema
+}
+
+func NewResponse(name, description string, w httptest.ResponseRecorder) (resp *Response, err error) {
+	var body *bytes.Buffer
+
+	body, err = copyBody(w.Body)
+	if err != nil {
+		return
+	}
+
+	return &Response{
+		w.Code,
+		httpIO{
+			Name:        name,
+			Description: description,
+			Header:      w.Header(),
+			ContentType: w.Header().Get("Content-Type"),
+			Body:        body,
+		},
+	}, nil
+}

blueprint/api/uri.go

@@ -0,0 +1,19 @@
+package blueprint
+
+type URI struct {
+	Raw        string
+	Tmpl       string
+	Parameters []*Parameter
+}
+
+// type ParamMatcherFn func(str string) []*Parameter
+
+// var ParamMatcher = defaultParamMatcherFn
+
+// // paramRegexp is for gorilla/mux-like uri parameters
+// // eg. "/articles/{category}/{id:[0-9]+}"
+// var defaultParamRegexp = regexp.MustCompile(`\{[^\:\}]+(\:[^\}]+)?\}`)
+
+// func defaultParamMatcherFn(str string) []*Parameter {
+
+// }

blueprint/api/util.go

@@ -0,0 +1,19 @@
+package blueprint
+
+import (
+	"bytes"
+	"io"
+	"io/ioutil"
+)
+
+func copyBody(r io.Reader) (buf *bytes.Buffer, err error) {
+	body, err := ioutil.ReadAll(r)
+	if err != nil {
+		return buf, err
+	}
+
+	buf = bytes.NewBuffer(body)
+	r = bytes.NewBuffer(body)
+
+	return
+}

blueprint/blueprint.go

@@ -0,0 +1,20 @@
+package blueprint
+
+const (
+	FORMAT = "1A"
+)
+
+type APIBlueprint struct {
+	Name           string
+	Description    string
+	Metadata       *Metadata
+	ResourceGroups []*ResourceGroup
+
+	// Todo:
+	// DataStructures
+}
+
+type Metadata struct {
+	Format string
+	Host   string
+}