improve documentation

Author: timsolov

README.md

@@ -1,6 +1,8 @@
 # Query Parser for REST
 Query Parser is a library for easy building dynamic SQL queries to Database. It provides a simple API for web-applications which needs to do some filtering throught GET queries. It is a connector between the HTTP handler and the DB engine, and manages validations and translations for user inputs.
 
+[![GoDoc](https://godoc.org/github.com/timsolov/rest-query-parser?status.png)](https://godoc.org/github.com/timsolov/rest-query-parser)
+
 ## Installation
  go get -u github.com/timsolov/rest-query-parser
 
@@ -50,9 +52,9 @@ See cmd/main.go and tests for more examples.
 ```
 
 ## Top level fields:
-* `fields` - fields for SELECT clause separated by comma (",") Eg. `&fields=id,name`. If nothing provided use "\*" by default. Attention! If you want to use this filter you have to defaine validation func for it. Use `rqp.In()` func for limit fields for your query.
+* `fields` - fields for SELECT clause separated by comma (",") Eg. `&fields=id,name`. If nothing provided will use "\*" by default. Attention! If you want to use this filter you have to define validation func for it. Use `rqp.In("id", "name")` func for limit fields for your query.
 * `sort` - sorting fields list separated by comma (","). Must be validated too. Could include prefix +/- which means ASC/DESC sorting. Eg. `&sort=+id,-name` will print `ORDER BY id, name DESC`. You have to filter fields in this parameter by adding `rqp.In("id", "name")`.
-* `limit` - is limit for LIMIT clause. Should be greater then 0 by default. Definition of the validation for `limit` is not required.
+* `limit` - is limit for LIMIT clause. Should be greater then 0 by default. Definition of the validation for `limit` is not required. But you may use `rqp.Max(100)` to limit top threshold.
 * `offset` - is offset for OFFSET clause. Should be greater then or equal to 0 by default. Definition of the validation for `offset` is not required.
 
 ## Validation modificators:
@@ -61,7 +63,7 @@ See cmd/main.go and tests for more examples.
 * `:bool` - parameter must be convertable to bool type. Raise error if not.
 
 ## Supported types
-- `strings` - the default type for all provided filters if not specified another. Could be compared by `eq, ne, like, ilkie, in` methods.
+- `string` - the default type for all provided filters if not specified another. Could be compared by `eq, ne, like, ilike, in` methods.
 - `int` - integer type. Must be specified with tag ":int". Could be compared by `eq, ne, gt, lt, gte, lte, in` methods.
 - `bool` - boolean type. Must be specified with tag ":bool". Could be compared by `eq` method.
 

errors.go

@@ -1,5 +1,6 @@
 package rqp
 
+// Error special rqp.Error type
 type Error struct {
 s string
 }
@@ -8,10 +9,12 @@ func (e *Error) Error() string {
 return e.s
 }
 
+// NewError constructor for internal errors
 func NewError(msg string) *Error {
 return &Error{msg}
 }
 
+// Errors list:
 var (
 ErrRequired = NewError("required")
 ErrBadFormat = NewError("bad format")

filter.go

@@ -142,7 +142,7 @@ func (f *Filter) parseKey(key string) error {
 
 if epos-spos > 0 {
 f.Method = Method(strings.ToUpper(string(key[spos:epos])))
-if _, ok := TranslateMethods[f.Method]; !ok {
+if _, ok := translateMethods[f.Method]; !ok {
 return ErrUnknownMethod
 }
 }
@@ -192,16 +192,16 @@ func (f *Filter) Where() (string, error) {
 
 switch f.Method {
 case EQ, NE, GT, LT, GTE, LTE, LIKE, ILIKE:
-exp = fmt.Sprintf("%s %s ?", f.Name, TranslateMethods[f.Method])
+exp = fmt.Sprintf("%s %s ?", f.Name, translateMethods[f.Method])
 return exp, nil
 case NOT:
 if f.Value == NULL {
-exp = fmt.Sprintf("%s %s NULL", f.Name, TranslateMethods[f.Method])
+exp = fmt.Sprintf("%s %s NULL", f.Name, translateMethods[f.Method])
 return exp, nil
 }
 return exp, ErrUnknownMethod
 case IN:
-exp = fmt.Sprintf("%s %s (?)", f.Name, TranslateMethods[f.Method])
+exp = fmt.Sprintf("%s %s (?)", f.Name, translateMethods[f.Method])
 exp, _, _ = in(exp, f.Value)
 return exp, nil
 default:

go.mod

@@ -3,7 +3,6 @@ module github.com/timsolov/rest-query-parser
 go 1.13
 
 require (
-github.com/jmoiron/sqlx v1.2.0 // indirect
 github.com/pkg/errors v0.9.1
-github.com/stretchr/testify v1.4.0
+github.com/stretchr/testify v1.5.1
 )

go.sum

@@ -1,17 +1,14 @@
 github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
-github.com/go-sql-driver/mysql v1.4.0/go.mod h1:zAC/RDZ24gD3HViQzih4MyKcchzm+sOG5ZlKdlhCg5w=
-github.com/jmoiron/sqlx v1.2.0 h1:41Ip0zITnmWNR/vHV+S4m+VoUivnWY5E4OJfLZjCJMA=
-github.com/jmoiron/sqlx v1.2.0/go.mod h1:1FEQNm3xlJgrMD+FBdI9+xvCksHtbpVBBw5dYhBSsks=
-github.com/lib/pq v1.0.0/go.mod h1:5WUZQaWbwv1U+lTReE5YruASi9Al49XbQIvNi/34Woo=
-github.com/mattn/go-sqlite3 v1.9.0/go.mod h1:FPy6KqzDD04eiIsT53CuJW3U88zkxoIYsOqkbpncsNc=
 github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
 github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.4.0 h1:2E4SXV/wtOkTonXsotYi4li6zVWxYlZuYNCXe9XRJyk=
 github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
+github.com/stretchr/testify v1.5.1 h1:nOGnQDM7FYENwehXlg/kFVnos3rEvtKTjRvOWSzb6H4=
+github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw=