diff --git a/.travis.yml b/.travis.yml index 18fad04..aa6ae99 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,18 +1,21 @@ language: go + go: -- 1.x -- '1.8' -- 1.10.x -- master + - 1.x + +before_install: + - curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh + install: -- curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh -- dep ensure -- go get golang.org/x/tools/cmd/cover -- go get github.com/mattn/goveralls + - dep ensure -v + - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter + - chmod +x ./cc-test-reporter + +before_script: + - ./cc-test-reporter before-build + script: -- go test -v -covermode=count -coverprofile=coverage.out -- "$HOME/gopath/bin/goveralls -coverprofile=coverage.out -service=travis-ci -repotoken - $COVERALLS_TOKEN" -env: - global: - secure: ZQwEmXhn/whrpwJAeSBi2FduujLN/fmoyHzExOaeIK19jf0zd7HDGU/aIaBLzxCmPnBtvayeHwPqtJncqkpKYD1VKiVd2uEIj/2y2GwNTQrea8rDMKNPv38rBoFwBJv7xAygki79JrjXZ9s0EdoSZC8U4osYJksMpEJpbHTnOXxR5Ci0nAjEOpNfUmetLTK6Er2Vy+XKMMZdnwbrVbp9WNluVLC4ISiuV3SfpEmZjtktIgqoHbrEKyejzXWE8G6Ax6QptHagB3ZgltDAu2pV4w55JoI3O1dGaHtIerVjlM85BWHpQZXA/nON9KglPlDRx0wNIhWj30WdsjKUUUmjldhCwXCpMueFC3ttvPQmKAT6HjnJUcYA5Q/hVMp0NV/AFSdpKz9/jJ9nZCO73OZZVENZOo6kYq7qyz3gNwSjGuuov+hjq8tlzYmGlblvZMMT2Nw0aIXMLNEcAvaK3vl6PsBTc9JCj3xtxSVULhOZoN8vceltC1+0upi4KwoMzBfZBAMtW86LUpl2iYokVj6jzGwKCGNAI9H5c+3G/ItAwTM+E2uyCEzXGFUl8dB2Iwz2qU98XWX2aO2KLB2EexFxXuWXwJQL/kxdzRx+VfHPG00I+mDkJNOkA5Vy43hAWULnDM/Ov8c/Rx+1j5KQGvXxxKvsdy7q6dV2GOYr4/oq+3Y= + - go test -v -coverprofile=c.out ./... + +after_script: + - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT diff --git a/Gopkg.lock b/Gopkg.lock index 95b28b8..9d3fce4 100644 --- a/Gopkg.lock +++ b/Gopkg.lock @@ -2,52 +2,67 @@ [[projects]] - branch = "master" - name = "github.com/armon/go-radix" - packages = ["."] - revision = "1fca145dffbcaa8fe914309b1ec0cfc67500fe61" - -[[projects]] + digest = "1:95fd14230b48a74765db94f7064f0b5617f52739a164f6d41e5b57bec5b3ff9b" name = "github.com/aws/aws-lambda-go" - packages = ["events"] - revision = "4d30d0ff60440c2d0480a15747c96ee71c3c53d4" - version = "v1.2.0" + packages = [ + "events", + "lambda", + "lambda/handlertrace", + "lambda/messages", + "lambdacontext", + ] + pruneopts = "UT" + revision = "08d251dc58f204411d79012fd6f1beefb7107fea" + version = "v1.10.0" [[projects]] - branch = "master" - name = "github.com/gopherjs/gopherjs" - packages = ["js"] - revision = "0892b62f0d9fb5857760c3cfca837207185117ee" + digest = "1:ffe9824d294da03b391f44e1ae8281281b4afc1bdaa9588c9097785e3af10cec" + name = "github.com/davecgh/go-spew" + packages = ["spew"] + pruneopts = "UT" + revision = "8991bc29aa16c548c550c7ff78260e27b9ab7c73" + version = "v1.1.1" [[projects]] - name = "github.com/jtolds/gls" + digest = "1:2be5a35f0c5b35162c41bb24971e5dcf6ce825403296ee435429cdcc4e1e847e" + name = "github.com/hashicorp/go-immutable-radix" packages = ["."] - revision = "77f18212c9c7edc9bd6a33d383a7b545ce62f064" - version = "v4.2.1" + pruneopts = "UT" + revision = "27df80928bb34bb1b0d6d0e01b9e679902e7a6b5" + version = "v1.0.0" [[projects]] - name = "github.com/smartystreets/assertions" - packages = [ - ".", - "internal/go-render/render", - "internal/oglematchers" - ] - revision = "7678a5452ebea5b7090a6b163f844c133f523da2" - version = "1.8.3" + digest = "1:67474f760e9ac3799f740db2c489e6423a4cde45520673ec123ac831ad849cb8" + name = "github.com/hashicorp/golang-lru" + packages = ["simplelru"] + pruneopts = "UT" + revision = "7087cb70de9f7a8bc0a10c375cb0d2280a8edf9c" + version = "v0.5.1" [[projects]] - name = "github.com/smartystreets/goconvey" - packages = [ - "convey", - "convey/gotest", - "convey/reporting" - ] - revision = "9e8dc3f972df6c8fcc0375ef492c24d0bb204857" - version = "1.6.3" + digest = "1:0028cb19b2e4c3112225cd871870f2d9cf49b9b4276531f03438a88e94be86fe" + name = "github.com/pmezard/go-difflib" + packages = ["difflib"] + pruneopts = "UT" + revision = "792786c7400a136282c1664665ae0a8db921c6c2" + version = "v1.0.0" + +[[projects]] + digest = "1:972c2427413d41a1e06ca4897e8528e5a1622894050e2f527b38ddf0f343f759" + name = "github.com/stretchr/testify" + packages = ["assert"] + pruneopts = "UT" + revision = "ffdc059bfe9ce6a4e144ba849dbedead332c6053" + version = "v1.3.0" [solve-meta] analyzer-name = "dep" analyzer-version = 1 - inputs-digest = "751d4fc4b7be23b18796aed082f5e83d9ba309c184255d4c63d8225cc0048152" + input-imports = [ + "github.com/aws/aws-lambda-go/events", + "github.com/aws/aws-lambda-go/lambda", + "github.com/hashicorp/go-immutable-radix", + "github.com/stretchr/testify/assert", + ] solver-name = "gps-cdcl" solver-version = 1 diff --git a/Gopkg.toml b/Gopkg.toml index 5a78b31..59d17d5 100644 --- a/Gopkg.toml +++ b/Gopkg.toml @@ -24,14 +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" + version = "1.x" [prune] go-tests = true diff --git a/LICENSE b/LICENSE index 307a4a0..7f09bc2 100644 --- a/LICENSE +++ b/LICENSE @@ -1,201 +1,25 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ +BSD 2-Clause License - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION +Copyright (c) 2019, The Lambdarouter Author(s) +All rights reserved. - 1. Definitions. +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright 2018 Mitchell Simon - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md index 5e0469c..f3447e2 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,28 @@ -# lambdarouter [![GoDoc Reference](https://godoc.org/github.com/mitchelljfs/lambdarouter?status.svg)](https://godoc.org/github.com/mitchelljfs/lambdarouter) [![Build Status](https://travis-ci.org/mitchelljfs/lambdarouter.svg?branch=master)](https://travis-ci.org/mitchelljfs/lambdarouter) [![Coverage Status](https://coveralls.io/repos/github/mitchelljfs/lambdarouter/badge.svg?branch=master)](https://coveralls.io/github/mitchelljfs/lambdarouter?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/mitchelljfs/lambdarouter)](https://goreportcard.com/report/github.com/mitchelljfs/lambdarouter) -This package will become a fully featured AWS Lambda function router, able to respond to HTTP, Schedule, Cognito, and SNS events. It will also support middleware interfacing. +# 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/mitchell/lambdarouter)](https://goreportcard.com/report/github.com/mitchell/lambdarouter) -So far it includes functionality for API Gateway. 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. diff --git a/examples/hello-world/.gitignore b/examples/hello-world/.gitignore new file mode 100644 index 0000000..f5b4c36 --- /dev/null +++ b/examples/hello-world/.gitignore @@ -0,0 +1,5 @@ +# Serverless directories +.serverless + +# golang output binary directory +bin \ No newline at end of file diff --git a/examples/hello-world/Makefile b/examples/hello-world/Makefile new file mode 100644 index 0000000..d50679e --- /dev/null +++ b/examples/hello-world/Makefile @@ -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 diff --git a/examples/hello-world/main.go b/examples/hello-world/main.go new file mode 100644 index 0000000..1ddc7fb --- /dev/null +++ b/examples/hello-world/main.go @@ -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) +} diff --git a/examples/hello-world/serverless.yml b/examples/hello-world/serverless.yml new file mode 100644 index 0000000..9c4fb5a --- /dev/null +++ b/examples/hello-world/serverless.yml @@ -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: diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..76920db --- /dev/null +++ b/go.mod @@ -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 +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..75abf98 --- /dev/null +++ b/go.sum @@ -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= diff --git a/router.go b/router.go index b7f871c..8e1fcf6 100644 --- a/router.go +++ b/router.go @@ -1,183 +1,154 @@ package lambdarouter import ( + "context" "encoding/json" + "fmt" "net/http" "strings" - radix "github.com/armon/go-radix" "github.com/aws/aws-lambda-go/events" + "github.com/aws/aws-lambda-go/lambda" + iradix "github.com/hashicorp/go-immutable-radix" ) -const ( - post = http.MethodPost - get = http.MethodGet - put = http.MethodPut - patch = http.MethodPatch - delete = http.MethodDelete -) - -// APIGRequest is used as the input of handler functions. -// The Claims, Path, and QryStr will be populated by the the APIGatewayProxyRequest. -// The Request itself is also passed through if you need further access. -type APIGRequest struct { - Body string - Claims map[string]interface{} - Path map[string]string - QryStr map[string]string - Request *events.APIGatewayProxyRequest +// Router holds the defined routes for use upon invocation. +type Router struct { + events *iradix.Tree + prefix string } -// APIGResponse is used as the output of handler functions. -// Populate Status and Body with your http response or populate Err with your error. -type APIGResponse struct { - Status int - Body []byte - Err error -} - -// APIGHandler is the interface a handler function must implement to be used -// with Get, Post, Put, Patch, and Delete. -type APIGHandler func(req *APIGRequest, res *APIGResponse) - -// APIGRouter is the object that handlers build upon and is used in the end to respond. -type APIGRouter struct { - request *events.APIGatewayProxyRequest - endpoints map[string]*radix.Tree - params map[string]string - svcprefix string -} - -// NOTE: Begin router methods. - -// NewAPIGRouter creates a new router using the request and a prefix to strip from your incoming requests. -func NewAPIGRouter(r *events.APIGatewayProxyRequest, svcprefix string) *APIGRouter { - return &APIGRouter{ - request: r, - endpoints: map[string]*radix.Tree{ - post: radix.New(), - get: radix.New(), - put: radix.New(), - patch: radix.New(), - delete: radix.New(), - }, - params: map[string]string{}, - svcprefix: svcprefix, - } -} - -// Get creates a new get endpoint. -func (r *APIGRouter) Get(route string, handlers ...APIGHandler) { - r.addEndpoint(get, route, handlers) -} - -// Post creates a new post endpoint. -func (r *APIGRouter) Post(route string, handlers ...APIGHandler) { - r.addEndpoint(post, route, handlers) -} - -// Put creates a new put endpoint. -func (r *APIGRouter) Put(route string, handlers ...APIGHandler) { - r.addEndpoint(put, route, handlers) -} - -// Patch creates a new patch endpoint -func (r *APIGRouter) Patch(route string, handlers ...APIGHandler) { - r.addEndpoint(patch, route, handlers) -} - -// Delete creates a new delete endpoint. -func (r *APIGRouter) Delete(route string, handlers ...APIGHandler) { - r.addEndpoint(delete, route, handlers) -} - -// Respond returns an APIGatewayProxyResponse to respond to the lambda request. -func (r *APIGRouter) Respond() events.APIGatewayProxyResponse { - var ( - handlersInterface interface{} - ok bool - status int - respbody []byte - err error - - endpointTree = r.endpoints[r.request.HTTPMethod] - path = strings.TrimPrefix(r.request.Path, "/"+r.svcprefix) - response = events.APIGatewayProxyResponse{} - ) - - for k := range r.params { - p := strings.TrimPrefix(k, "{") - p = strings.TrimSuffix(p, "}") - if r.request.PathParameters[p] != "" { - path = strings.Replace(path, r.request.PathParameters[p], k, -1) +// New initializes an empty router. The prefix parameter may be of any length. +func New(prefix string) Router { + if len(prefix) > 0 { + if prefix[0] != '/' { + prefix = "/" + prefix + } + if prefix[len(prefix)-1] != '/' { + prefix += "/" } } - if handlersInterface, ok = endpointTree.Get(path); !ok { - respbody, _ := json.Marshal(map[string]string{"error": "no route matching path found"}) - - response.StatusCode = http.StatusNotFound - response.Body = string(respbody) - return response + return Router{ + events: iradix.New(), + prefix: prefix, } - - handlers := handlersInterface.([]APIGHandler) - - for _, handler := range handlers { - req := &APIGRequest{ - Body: r.request.Body, - Path: r.request.PathParameters, - QryStr: r.request.QueryStringParameters, - Request: r.request, - } - if r.request.RequestContext.Authorizer["claims"] != nil { - req.Claims = r.request.RequestContext.Authorizer["claims"].(map[string]interface{}) - } - res := &APIGResponse{} - - handler(req, res) - status, respbody, err = res.deconstruct() - - if err != nil { - respbody, _ := json.Marshal(map[string]string{"error": err.Error()}) - if strings.Contains(err.Error(), "record not found") { - status = 204 - } else if status < 400 { - status = 400 - } - - response.StatusCode = status - response.Body = string(respbody) - return response - } - } - - response.StatusCode = status - response.Body = string(respbody) - return response } -// NOTE: Begin helper functions. -func stripSlashesAndSplit(s string) []string { - s = strings.TrimPrefix(s, "/") - s = strings.TrimSuffix(s, "/") - return strings.Split(s, "/") +// Get adds a new GET method route to the router. The path parameter is the route path you wish to +// define. The handler parameter is a lambda.Handler to invoke if an incoming path matches the +// route. +func (r *Router) Get(path string, handler lambda.Handler) { + r.addEvent(prepPath(http.MethodGet, r.prefix, path), event{h: handler}) } -func (res *APIGResponse) deconstruct() (int, []byte, error) { - return res.Status, res.Body, res.Err +// Post adds a new POST method route to the router. The path parameter is the route path you wish to +// define. The handler parameter is a lambda.Handler to invoke if an incoming path matches the +// route. +func (r *Router) Post(path string, handler lambda.Handler) { + r.addEvent(prepPath(http.MethodPost, r.prefix, path), event{h: handler}) } -func (r *APIGRouter) addEndpoint(method string, route string, handlers []APIGHandler) { - if _, overwrite := r.endpoints[method].Insert(route, handlers); overwrite { - panic("endpoint already existent") +// Put adds a new PUT method route to the router. The path parameter is the route path you wish to +// define. The handler parameter is a lambda.Handler to invoke if an incoming path matches the +// route. +func (r *Router) Put(path string, handler lambda.Handler) { + r.addEvent(prepPath(http.MethodPut, r.prefix, path), event{h: handler}) +} + +// Patch adds a new PATCH method route to the router. The path parameter is the route path you wish +// to define. The handler parameter is a lambda.Handler to invoke if an incoming path matches the +// route. +func (r *Router) Patch(path string, handler lambda.Handler) { + r.addEvent(prepPath(http.MethodPatch, r.prefix, path), event{h: handler}) +} + +// Delete adds a new DELETE method route to the router. The path parameter is the route path you +// wish to define. The handler parameter is a lambda.Handler to invoke if an incoming path matches +// the route. +func (r *Router) Delete(path string, handler lambda.Handler) { + r.addEvent(prepPath(http.MethodDelete, r.prefix, path), event{h: handler}) +} + +// Invoke implements the lambda.Handler interface for the Router type. +func (r Router) Invoke(ctx context.Context, payload []byte) ([]byte, error) { + var req events.APIGatewayProxyRequest + + if err := json.Unmarshal(payload, &req); err != nil { + return nil, err } - rtearr := stripSlashesAndSplit(route) - for _, v := range rtearr { - if strings.HasPrefix(v, "{") { - r.params[v] = "" // adding params as keys with {brackets} - } + path := req.Path + + for param, value := range req.PathParameters { + path = strings.Replace(path, value, "{"+param+"}", -1) } + i, found := r.events.Get([]byte(req.HTTPMethod + path)) + + if !found { + return json.Marshal(events.APIGatewayProxyResponse{ + StatusCode: http.StatusNotFound, + Body: "not found", + }) + } + + e := i.(event) + return e.h.Invoke(ctx, payload) +} + +// Group allows you to define many routes with the same prefix. The prefix parameter will be applied +// to all routes defined in the function. The fn parameter is a function in which the grouped +// routes should be defined. +func (r *Router) Group(prefix string, fn func(r *Router)) { + validatePathPart(prefix) + + if prefix[0] == '/' { + prefix = prefix[1:] + } + if prefix[len(prefix)-1] != '/' { + prefix += "/" + } + + original := r.prefix + r.prefix += prefix + fn(r) + r.prefix = original +} + +type event struct { + h lambda.Handler +} + +func (r *Router) addEvent(key string, e event) { + if r.events == nil { + panic("router not initialized") + } + + routes, _, overwrite := r.events.Insert([]byte(key), e) + + if overwrite { + panic(fmt.Sprintf("event '%s' already exists", key)) + } + + r.events = routes +} + +func prepPath(method, prefix, path string) string { + validatePathPart(path) + + if path[0] == '/' { + path = path[1:] + } + if path[len(path)-1] == '/' { + path = path[:len(path)-1] + } + + return method + prefix + path +} + +func validatePathPart(part string) { + if len(part) == 0 { + panic("path was empty") + } } diff --git a/router_test.go b/router_test.go index 723a7c5..7896967 100644 --- a/router_test.go +++ b/router_test.go @@ -1,166 +1,106 @@ package lambdarouter import ( - "errors" + "context" + "encoding/json" + "fmt" "net/http" "testing" "github.com/aws/aws-lambda-go/events" - . "github.com/smartystreets/goconvey/convey" + "github.com/aws/aws-lambda-go/lambda" + "github.com/stretchr/testify/assert" ) -func TestRouterSpec(t *testing.T) { +func TestRouter(t *testing.T) { + a := assert.New(t) - Convey("Given an instantiated router", t, func() { - request := events.APIGatewayProxyRequest{} - rtr := NewAPIGRouter(&request, "shipping") - - Convey("When the handler func does NOT return an error", func() { - hdlrfunc := func(req *APIGRequest, res *APIGResponse) { - res.Status = http.StatusOK - res.Body = []byte("hello") - res.Err = nil - } - - Convey("And a Get handler expecting the pattern /orders/filter/by_user/{id} is defined", func() { - rtr.Get("/orders/filter/by_user/{id}", hdlrfunc) - rtr.Post("/orders", func(req *APIGRequest, res *APIGResponse) {}) - rtr.Put("/orders", func(req *APIGRequest, res *APIGResponse) {}) - rtr.Patch("/orders", func(req *APIGRequest, res *APIGResponse) {}) - rtr.Delete("/orders/{id}", func(req *APIGRequest, res *APIGResponse) {}) - - Convey("And the request matches the pattern and the path params are filled", func() { - request.HTTPMethod = http.MethodGet - request.Path = "/shipping/orders/filter/by_user/4d50ff90-66e3-4047-bf37-0ca25837e41d" - request.PathParameters = map[string]string{ - "id": "4d50ff90-66e3-4047-bf37-0ca25837e41d", - } - request.RequestContext.Authorizer = map[string]interface{}{ - "claims": map[string]interface{}{ - "cognito:username": "mitchell", - }, - } - - Convey("The router will return the expected status and body", func() { - response := rtr.Respond() - - So(response.StatusCode, ShouldEqual, http.StatusOK) - So(response.Body, ShouldEqual, "hello") - }) - }) - - Convey("And the request does NOT match the pattern", func() { - request.HTTPMethod = http.MethodGet - request.Path = "/orders/filter" - - Convey("The router will return an error body and a status not found", func() { - response := rtr.Respond() - - So(response.StatusCode, ShouldEqual, http.StatusNotFound) - So(response.Body, ShouldEqual, "{\"error\":\"no route matching path found\"}") - }) - }) - - Convey("And a Get handler expecting the pattern /orders/filter/by_user/{id} is defined AGAIN", func() { - So(func() { - rtr.Get("/orders/filter/by_user/{id}", hdlrfunc) - }, ShouldPanicWith, "endpoint already existent") - }) - - Convey("And a Get handler expecting the pattern /orders/filter", func() { - rtr.Get("/orders/filter", hdlrfunc) - - Convey("And the request matches the pattern and the path params are filled", func() { - request.HTTPMethod = http.MethodGet - request.Path = "/shipping/orders/filter" - - Convey("The router will return the expected status and body", func() { - response := rtr.Respond() - - So(response.StatusCode, ShouldEqual, http.StatusOK) - So(response.Body, ShouldEqual, "hello") - }) - }) - - Convey("And the request does NOT match either of the patterns", func() { - request.HTTPMethod = http.MethodGet - request.Path = "/shipping/orders/filter/by_user" - - Convey("The router will return an error body and a status not found", func() { - response := rtr.Respond() - - So(response.StatusCode, ShouldEqual, http.StatusNotFound) - So(response.Body, ShouldEqual, "{\"error\":\"no route matching path found\"}") - }) - }) - }) - }) + desc(t, 0, "Intialize Router and") + r := New("prefix") + handler := lambda.NewHandler(handler) + ctx := context.Background() + desc(t, 2, "Get|Post|Put|Patch|Delete method should") + { + desc(t, 4, "insert a new route succesfully") + a.NotPanics(func() { + r.Get("thing/{id}", handler) + r.Delete("/thing/{id}/", handler) + r.Put("thing", handler) }) - Convey("When the handler func does return a record not found", func() { - hdlrfunc := func(req *APIGRequest, res *APIGResponse) { - res.Status = http.StatusBadRequest - res.Body = []byte("hello") - res.Err = errors.New("record not found") - - } - - Convey("And a Get handler expecting the pattern /orders/filter/by_user/{id} is defined", func() { - rtr.Get("/orders/filter/by_user/{id}", hdlrfunc) - - Convey("And the request matches the pattern and the path params are filled", func() { - request.HTTPMethod = http.MethodGet - request.Path = "/shipping/orders/filter/by_user/4d50ff90-66e3-4047-bf37-0ca25837e41d" - request.PathParameters = map[string]string{ - "id": "4d50ff90-66e3-4047-bf37-0ca25837e41d", - } - - Convey("The router will return the expected status and body", func() { - response := rtr.Respond() - - So(response.StatusCode, ShouldEqual, http.StatusNoContent) - So(response.Body, ShouldEqual, "{\"error\":\"record not found\"}") - }) - }) - }) + desc(t, 4, "panic when inserting the same route") + a.Panics(func() { + r.Put("thing", handler) }) - Convey("When the handler func does return a status < 400", func() { - middlefunc1 := func(req *APIGRequest, res *APIGResponse) { - res.Status = http.StatusOK - res.Body = []byte("hello") - res.Err = nil - } - middlefunc2 := func(req *APIGRequest, res *APIGResponse) { - res.Status = http.StatusOK - res.Body = []byte("hello") - res.Err = errors.New("bad request") - } - hdlrfunc := func(req *APIGRequest, res *APIGResponse) { - res.Status = http.StatusOK - res.Body = []byte("hello") - res.Err = nil - } - - Convey("And a Get handler expecting the pattern /orders/filter/by_user/{id} is defined", func() { - rtr.Get("/orders/filter/by_user/{id}", middlefunc1, middlefunc2, hdlrfunc) - - Convey("And the request matches the pattern and the path params are filled", func() { - request.HTTPMethod = http.MethodGet - request.Path = "/shipping/orders/filter/by_user/4d50ff90-66e3-4047-bf37-0ca25837e41d" - request.PathParameters = map[string]string{ - "id": "4d50ff90-66e3-4047-bf37-0ca25837e41d", - } - - Convey("The router will return the expected status and body", func() { - response := rtr.Respond() - - So(response.StatusCode, ShouldEqual, http.StatusBadRequest) - So(response.Body, ShouldEqual, "{\"error\":\"bad request\"}") - }) - }) - }) + desc(t, 4, "panic when router is uninitalized") + var r2 Router + a.Panics(func() { + r2.Patch("panic", handler) }) - }) + + desc(t, 4, "panic when when given an empty path") + a.Panics(func() { + r.Post("", handler) + }) + } + + desc(t, 2, "PrefixGroup method should") + { + desc(t, 4, "insert routes with the specified prefix succesfully") + r.Group("/ding", func(r *Router) { + r.Post("dong/{door}", handler) + }) + } + + desc(t, 2, "Invoke method should") + { + e := events.APIGatewayProxyRequest{ + Path: "/prefix/ding/dong/mitchell", + HTTPMethod: http.MethodPost, + PathParameters: map[string]string{"door": "mitchell"}, + } + + desc(t, 4, "should succesfully route and invoke a defined route") + ejson, _ := json.Marshal(e) + + res, err := r.Invoke(ctx, ejson) + + a.NoError(err) + a.Exactly("null", string(res)) + + desc(t, 4, "return the expected response when a route is not found") + e.Path = "thing" + e.PathParameters = nil + ejson2, _ := json.Marshal(e) + eres := events.APIGatewayProxyResponse{ + StatusCode: http.StatusNotFound, + Body: "not found", + } + eresjson, _ := json.Marshal(eres) + + res, err = r.Invoke(ctx, ejson2) + + a.NoError(err) + a.ElementsMatch(eresjson, res) + + desc(t, 4, "return an error when the there is an issue with the incoming event") + _, err = r.Invoke(ctx, nil) + + a.Error(err) + } + +} + +func handler() error { + return nil +} + +func desc(t *testing.T, depth int, str string, args ...interface{}) { + for i := 0; i < depth; i++ { + str = " " + str + } + + t.Log(fmt.Sprintf(str, args...)) }