README.md

@@ -7,6 +7,11 @@ Go driven rpc code generation tool for right now.
 - Generate server and client code
 - Production ready templates (or copy and modify)
 
+## Who's using Oto?
+
+* [Pace.dev](https://pace.dev/docs/) - Oto came out of the Pace project
+* [Firesearch.dev](https://firesearch.dev/docs/api) - Firesearch uses Oto to offer full-text services to the web, mobile, and the backend
+
 ## Templates
 
 These templates are already being used in production.

otohttp/templates/client.py.plush

@@ -0,0 +1,85 @@
+# Code generated by oto; DO NOT EDIT.
+
+import requests
+import json
+
+class Client:
+	"""Client provides access to the Firesearch API."""
+
+	def __init__(self, endpoint="http://localhost:8888/api", apiKey=""):
+		self.endpoint = endpoint
+		self.apiKey = apiKey
+		if self.endpoint == "":
+			raise FieldError(field="endpoint", message="endpoint missing")
+		if self.apiKey == "":
+			raise FieldError(field="apiKey", message="apiKey missing")
+
+<%= for (service) in def.Services { %>class <%= service.Name %>:
+	"""<%= format_comment_line(service.Comment) %>"""
+
+	def __init__(self, client):
+		self.client = client
+	<%= for (method) in service.Methods { %>
+	def <%= method.NameLowerCamel %>(<%= method.InputObject.ObjectNameLowerCamel %>):
+		"""<%= format_comment_line(method.Comment) %>"""
+		url = "{}/<%= service.Name %>.<%= method.Name %>".format(self.client.endpoint)
+		headers = {
+			'Accept': 'application/json; charset=utf8',
+			'Content-Type': 'application/json; charset=utf8',
+			'X-API-Key': self.client.apiKey,
+		}
+		r = requests.post(url, json=<%= method.InputObject.ObjectNameLowerCamel %>, headers=headers)
+		if r.status_code != 200:
+			raise OtoError(message="status code: {}".format(r.status_code))
+		j = r.json()
+		if j.error != "":
+			raise OtoError(message=j.error)
+		return j
+	<% } %>
+<% } %>
+
+<%= for (object) in def.Objects { %>
+class <%= object.Name %>:
+	"""<%= format_comment_line(object.Comment) %>
+	Attributes
+	----------
+	<%= for (field) in object.Fields {  %>
+	<%= field.NameLowerCamel %>
+		<%= format_comment_line(field.Comment) %>
+	<% } %>
+	"""
+
+	def __init__(self):
+		<%= for (field) in object.Fields { %>self.<%= field.NameLowerCamel %> = None
+		<% } %>	
+	def json():
+		""""get a JSON representation of this object"""
+		return json.dumps(self)
+
+<% } %>
+
+class Error(Exception):
+	"""Base class for exceptions in this module."""
+	pass
+
+class OtoError(Error):
+	"""Exception raised for an error making the request.
+
+	Attributes:
+		message -- explanation of the error
+	"""
+
+	def __init__(self, message):
+		self.message = message
+
+class FieldError(Error):
+	"""Exception raised for missing fields.
+
+	Attributes:
+		field -- field which the error occurred
+		message -- explanation of the error
+	"""
+
+	def __init__(self, field, message):
+		self.field = field
+		self.message = message

render/render.go

@@ -5,6 +5,7 @@ import (
 	"encoding/json"
 	"go/doc"
 	"html/template"
+	"strings"
 
 	"github.com/fatih/structtag"
 	"github.com/gobuffalo/plush"
@@ -22,6 +23,7 @@ func Render(template string, def parser.Definition, params map[string]interface{
 	ctx.Set("def", def)
 	ctx.Set("params", params)
 	ctx.Set("json", toJSONHelper)
+	ctx.Set("format_comment_line", formatCommentLine)
 	ctx.Set("format_comment_text", formatCommentText)
 	ctx.Set("format_comment_html", formatCommentHTML)
 	ctx.Set("format_tags", formatTags)
@@ -40,6 +42,13 @@ func toJSONHelper(v interface{}) (template.HTML, error) {
 	return template.HTML(b), nil
 }
 
+func formatCommentLine(s string) template.HTML {
+	var buf bytes.Buffer
+	doc.ToText(&buf, s, "", "", 2000)
+	s = strings.TrimSpace(buf.String())
+	return template.HTML(s)
+}
+
 func formatCommentText(s string) template.HTML {
 	var buf bytes.Buffer
 	doc.ToText(&buf, s, "// ", "", 80)

render/render_test.go

@@ -108,4 +108,19 @@ func TestFormatCommentText(t *testing.T) {
 	actual = strings.TrimSpace(string(formatCommentText(`What happens if I use "quotes"?`)))
 	is.Equal(actual, `// What happens if I use "quotes"?`)
 
+	actual = strings.TrimSpace(string(formatCommentText("What about\nnew lines?")))
+	is.Equal(actual, `// What about new lines?`)
+
+}
+
+func TestFormatComment(t *testing.T) {
+	is := is.New(t)
+
+	longComment := `This is a long comment that will end up spanning
+multiple lines so we get to test the indent string option
+in formatComment.`
+	actual := strings.TrimSpace(string(formatComment(longComment, "\t\t")))
+	is.Equal(actual, `This is a long comment that will end up spanning multiple lines so we get to
+		test the indent string option in formatComment.`)
+
 }