First iteration of v1 lambdarouter, full API change

Author: mitchell

.travis.yml

@@ -4,12 +4,12 @@ go:
   - 1.x
 
 before_install:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
   - curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh
 
 install:
+  - dep ensure -v
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
   - chmod +x ./cc-test-reporter
-  - dep ensure
 
 before_script:
   - ./cc-test-reporter before-build

Gopkg.lock

@@ -24,18 +24,9 @@
 #   go-tests = true
 #   unused-packages = true
 
-
-[[constraint]]
-  branch = "master"
-  name = "github.com/armon/go-radix"
-
 [[constraint]]
   name = "github.com/aws/aws-lambda-go"
-  version = "1.2.0"
-
-[[constraint]]
-  name = "github.com/smartystreets/goconvey"
-  version = "1.6.3"
+  version = "1.x"
 
 [prune]
   go-tests = true

Gopkg.toml

@@ -1,8 +1,28 @@
 # lambdarouter
-[![GoDoc Reference](https://godoc.org/github.com/mitchelljfs/lambdarouter?status.svg)](https://godoc.org/github.com/mitchelljfs/lambdarouter)
+[![GoDoc Reference](https://godoc.org/github.com/mitchell/lambdarouter?status.svg)](https://godoc.org/github.com/mitchell/lambdarouter)
 [![Build Status](https://travis-ci.org/mitchell/lambdarouter.svg?branch=master)](https://travis-ci.org/mitchell/lambdarouter)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/7270c6c4017b36d07360/test_coverage)](https://codeclimate.com/github/mitchelljfs/lambdarouter/test_coverage)
 [![Maintainability](https://api.codeclimate.com/v1/badges/7270c6c4017b36d07360/maintainability)](https://codeclimate.com/github/mitchelljfs/lambdarouter/maintainability)
-[![Go Report Card](https://goreportcard.com/badge/github.com/mitchelljfs/lambdarouter)](https://goreportcard.com/report/github.com/mitchelljfs/lambdarouter)
+[![Go Report Card](https://goreportcard.com/badge/github.com/mitchell/lambdarouter)](https://goreportcard.com/report/github.com/mitchell/lambdarouter)
 
-So far this package can create a router and routes whose execution utilizes a middleware context pattern, all in one Golang Lambda function. It has full test coverage, and is currently deployed in numerous services where I am employed. Check out the GoDoc Reference to see how to instantiate a router and create endpoints.
+This package contains a router capable of routing many AWS Lambda API gateway requests to anything
+that implements the aws-lambda-go/lambda.Handler interface, all in one Lambda function. It plays
+especially well with go-kit's awslambda transport package. Get started by reading below and visiting
+the [GoDoc reference](https://godoc.org/github.com/mitchell/lambdarouter).
+
+## Initializing a Router
+```
+r := lambdarouter.New("prefix/")
+
+r.Get("hello/{name}", helloHandler)
+r.Post("hello/server", helloHandler)
+r.Delete("hello", lambda.NewHandler(func() (events.APIGatewayProxyResponse, error) {
+        return events.APIGatewayProxyResponse{
+                Body: "nothing to delete",
+        }, nil
+}))
+
+lambda.StartHandler(r)
+```
+
+Check out the `examples/` folder for more fleshed out examples in the proper context.

README.md

@@ -0,0 +1,5 @@
+# Serverless directories
+.serverless
+
+# golang output binary directory
+bin

examples/hello-world/.gitignore

@@ -0,0 +1,10 @@
+.PHONY: all build clean deploy test
+
+build:
+	env GOOS=linux go build -ldflags="-s -w" -o ./bin/hello ./main.go
+
+clean:
+	rm -rf ./bin
+
+deploy: clean build
+	sls deploy --verbose

examples/hello-world/Makefile

@@ -0,0 +1,47 @@
+package main
+
+import (
+	"net/http"
+
+	"github.com/aws/aws-lambda-go/events"
+	"github.com/aws/aws-lambda-go/lambda"
+	"github.com/mitchell/lambdarouter"
+)
+
+var r = lambdarouter.New("hellosrv")
+
+func init() {
+	r.Post("hello", lambda.NewHandler(func() (events.APIGatewayProxyResponse, error) {
+		return events.APIGatewayProxyResponse{
+			StatusCode: http.StatusCreated,
+			Body:       "hello world",
+		}, nil
+	}))
+
+	r.Group("hello", func(r *lambdarouter.Router) {
+		r.Get("{name}", lambda.NewHandler(func(req events.APIGatewayProxyRequest) (events.APIGatewayProxyResponse, error) {
+			return events.APIGatewayProxyResponse{
+				StatusCode: http.StatusOK,
+				Body:       "hello " + req.PathParameters["name"],
+			}, nil
+		}))
+
+		r.Put("french", lambda.NewHandler(func() (events.APIGatewayProxyResponse, error) {
+			return events.APIGatewayProxyResponse{
+				StatusCode: http.StatusOK,
+				Body:       "bonjour le monde",
+			}, nil
+		}))
+
+		r.Get("french/{prenom}", lambda.NewHandler(func(req events.APIGatewayProxyRequest) (events.APIGatewayProxyResponse, error) {
+			return events.APIGatewayProxyResponse{
+				StatusCode: http.StatusOK,
+				Body:       "bonjour " + req.PathParameters["prenom"],
+			}, nil
+		}))
+	})
+}
+
+func main() {
+	lambda.StartHandler(r)
+}

examples/hello-world/main.go

@@ -0,0 +1,42 @@
+service: lambdarouter-hello-world
+frameworkVersion: ">=1.28.0 <2.0.0"
+
+provider:
+  name: aws
+  runtime: go1.x
+  stage: ${opt:stage, 'dev'}
+  region: us-west-2
+#  iamRoleStatements:
+#  environment:
+
+package:
+  exclude:
+    - ./**
+  include:
+    - ./bin/**
+
+functions:
+  hello:
+    handler: bin/hello
+    events:
+      - http:
+          path: hellosrv/hello
+          method: post
+      - http:
+          path: hellosrv/hello/{name}
+          method: get
+          request:
+            parameters:
+              path:
+                name: true
+      - http:
+          path: hellosrv/hello/french
+          method: put
+      - http:
+          path: hellosrv/hello/french/{prenom}
+          method: get
+          request:
+            parameters:
+              path:
+                prenom: true
+#resources:

examples/hello-world/serverless.yml

@@ -0,0 +1,9 @@
+module github.com/mitchell/lambdarouter
+
+require (
+	github.com/aws/aws-lambda-go v1.10.0
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/hashicorp/go-immutable-radix v1.0.0
+	github.com/hashicorp/golang-lru v0.5.1 // indirect
+	github.com/stretchr/testify v1.3.0
+)

go.mod

@@ -0,0 +1,17 @@
+github.com/aws/aws-lambda-go v1.10.0 h1:uafgdfYGQD0UeT7d2uKdyWW8j/ZYRifRPIdmeqLzLCk=
+github.com/aws/aws-lambda-go v1.10.0/go.mod h1:zUsUQhAUjYzR8AuduJPCfhBuKWUaDbQiPOG+ouzmE1A=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/hashicorp/go-immutable-radix v1.0.0 h1:AKDB1HM5PWEA7i4nhcpwOrO2byshxBjXVn/J/3+z5/0=
+github.com/hashicorp/go-immutable-radix v1.0.0/go.mod h1:0y9vanUI8NX6FsYoO3zeMjhV/C5i9g4Q3DwcSNZ4P60=
+github.com/hashicorp/go-uuid v1.0.0 h1:RS8zrF7PhGwyNPOtxSClXXj9HA8feRnJzgnI1RJCSnM=
+github.com/hashicorp/go-uuid v1.0.0/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro=
+github.com/hashicorp/golang-lru v0.5.0/go.mod h1:/m3WP610KZHVQ1SGc6re/UDhFvYD7pJ4Ao+sR/qLZy8=
+github.com/hashicorp/golang-lru v0.5.1 h1:0hERBMJE1eitiLkihrMvRVBYAkpHzc/J3QdDN+dAcgU=
+github.com/hashicorp/golang-lru v0.5.1/go.mod h1:/m3WP610KZHVQ1SGc6re/UDhFvYD7pJ4Ao+sR/qLZy8=
+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.3.0 h1:TivCn/peBQ7UY8ooIcPgZFpTNSz0Q2U6UrFlUfqbe0Q=
+github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=