Compare commits
No commits in common. "master" and "v1.0.0" have entirely different histories.
216
LICENSE
216
LICENSE
|
@ -1,25 +1,201 @@
|
||||||
BSD 2-Clause License
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
Copyright (c) 2019, The Lambdarouter Author(s)
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
All rights reserved.
|
|
||||||
|
|
||||||
Redistribution and use in source and binary forms, with or without
|
1. Definitions.
|
||||||
modification, are permitted provided that the following conditions are met:
|
|
||||||
|
|
||||||
1. Redistributions of source code must retain the above copyright notice, this
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
list of conditions and the following disclaimer.
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
2. Redistributions in binary form must reproduce the above copyright notice,
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
this list of conditions and the following disclaimer in the documentation
|
the copyright owner that is granting the License.
|
||||||
and/or other materials provided with the distribution.
|
|
||||||
|
|
||||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
other entities that control, are controlled by, or are under common
|
||||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
control with that entity. For the purposes of this definition,
|
||||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
direction or management of such entity, whether by contract or
|
||||||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
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
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
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.
|
||||||
|
|
44
router.go
44
router.go
|
@ -18,16 +18,14 @@ type Router struct {
|
||||||
prefix string
|
prefix string
|
||||||
}
|
}
|
||||||
|
|
||||||
// New initializes an empty router. The prefix parameter may be of any length.
|
// New initializes an empty router.
|
||||||
func New(prefix string) Router {
|
func New(prefix string) Router {
|
||||||
if len(prefix) > 0 {
|
|
||||||
if prefix[0] != '/' {
|
if prefix[0] != '/' {
|
||||||
prefix = "/" + prefix
|
prefix = "/" + prefix
|
||||||
}
|
}
|
||||||
if prefix[len(prefix)-1] != '/' {
|
if prefix[len(prefix)-1] != '/' {
|
||||||
prefix += "/"
|
prefix += "/"
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
return Router{
|
return Router{
|
||||||
events: iradix.New(),
|
events: iradix.New(),
|
||||||
|
@ -39,35 +37,40 @@ func New(prefix string) Router {
|
||||||
// define. The handler parameter is a lambda.Handler to invoke if an incoming path matches the
|
// define. The handler parameter is a lambda.Handler to invoke if an incoming path matches the
|
||||||
// route.
|
// route.
|
||||||
func (r *Router) Get(path string, handler lambda.Handler) {
|
func (r *Router) Get(path string, handler lambda.Handler) {
|
||||||
r.addEvent(prepPath(http.MethodGet, r.prefix, path), event{h: handler})
|
path = r.prefix + path
|
||||||
|
r.addEvent(http.MethodGet+path, event{h: handler})
|
||||||
}
|
}
|
||||||
|
|
||||||
// Post adds a new POST method route to the router. The path parameter is the route path you wish to
|
// 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
|
// define. The handler parameter is a lambda.Handler to invoke if an incoming path matches the
|
||||||
// route.
|
// route.
|
||||||
func (r *Router) Post(path string, handler lambda.Handler) {
|
func (r *Router) Post(path string, handler lambda.Handler) {
|
||||||
r.addEvent(prepPath(http.MethodPost, r.prefix, path), event{h: handler})
|
path = r.prefix + path
|
||||||
|
r.addEvent(http.MethodPost+path, event{h: handler})
|
||||||
}
|
}
|
||||||
|
|
||||||
// Put adds a new PUT method route to the router. The path parameter is the route path you wish to
|
// 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
|
// define. The handler parameter is a lambda.Handler to invoke if an incoming path matches the
|
||||||
// route.
|
// route.
|
||||||
func (r *Router) Put(path string, handler lambda.Handler) {
|
func (r *Router) Put(path string, handler lambda.Handler) {
|
||||||
r.addEvent(prepPath(http.MethodPut, r.prefix, path), event{h: handler})
|
path = r.prefix + path
|
||||||
|
r.addEvent(http.MethodPut+path, event{h: handler})
|
||||||
}
|
}
|
||||||
|
|
||||||
// Patch adds a new PATCH method route to the router. The path parameter is the route path you wish
|
// 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
|
// to define. The handler parameter is a lambda.Handler to invoke if an incoming path matches the
|
||||||
// route.
|
// route.
|
||||||
func (r *Router) Patch(path string, handler lambda.Handler) {
|
func (r *Router) Patch(path string, handler lambda.Handler) {
|
||||||
r.addEvent(prepPath(http.MethodPatch, r.prefix, path), event{h: handler})
|
path = r.prefix + path
|
||||||
|
r.addEvent(http.MethodPatch+path, event{h: handler})
|
||||||
}
|
}
|
||||||
|
|
||||||
// Delete adds a new DELETE method route to the router. The path parameter is the route path you
|
// 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
|
// wish to define. The handler parameter is a lambda.Handler to invoke if an incoming path matches
|
||||||
// the route.
|
// the route.
|
||||||
func (r *Router) Delete(path string, handler lambda.Handler) {
|
func (r *Router) Delete(path string, handler lambda.Handler) {
|
||||||
r.addEvent(prepPath(http.MethodDelete, r.prefix, path), event{h: handler})
|
path = r.prefix + path
|
||||||
|
r.addEvent(http.MethodDelete+path, event{h: handler})
|
||||||
}
|
}
|
||||||
|
|
||||||
// Invoke implements the lambda.Handler interface for the Router type.
|
// Invoke implements the lambda.Handler interface for the Router type.
|
||||||
|
@ -97,12 +100,10 @@ func (r Router) Invoke(ctx context.Context, payload []byte) ([]byte, error) {
|
||||||
return e.h.Invoke(ctx, payload)
|
return e.h.Invoke(ctx, payload)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Group allows you to define many routes with the same prefix. The prefix parameter will be applied
|
// Group allows you to define many routes with the same prefix. The prefix parameter will apply the
|
||||||
// to all routes defined in the function. The fn parameter is a function in which the grouped
|
// prefix to all routes defined in the function. The fn parmater is a function in which the grouped
|
||||||
// routes should be defined.
|
// routes should be defined.
|
||||||
func (r *Router) Group(prefix string, fn func(r *Router)) {
|
func (r *Router) Group(prefix string, fn func(r *Router)) {
|
||||||
validatePathPart(prefix)
|
|
||||||
|
|
||||||
if prefix[0] == '/' {
|
if prefix[0] == '/' {
|
||||||
prefix = prefix[1:]
|
prefix = prefix[1:]
|
||||||
}
|
}
|
||||||
|
@ -133,22 +134,3 @@ func (r *Router) addEvent(key string, e event) {
|
||||||
|
|
||||||
r.events = routes
|
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")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
|
@ -25,7 +25,7 @@ func TestRouter(t *testing.T) {
|
||||||
desc(t, 4, "insert a new route succesfully")
|
desc(t, 4, "insert a new route succesfully")
|
||||||
a.NotPanics(func() {
|
a.NotPanics(func() {
|
||||||
r.Get("thing/{id}", handler)
|
r.Get("thing/{id}", handler)
|
||||||
r.Delete("/thing/{id}/", handler)
|
r.Delete("thing/{id}", handler)
|
||||||
r.Put("thing", handler)
|
r.Put("thing", handler)
|
||||||
})
|
})
|
||||||
|
|
||||||
|
@ -39,11 +39,6 @@ func TestRouter(t *testing.T) {
|
||||||
a.Panics(func() {
|
a.Panics(func() {
|
||||||
r2.Patch("panic", handler)
|
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, 2, "PrefixGroup method should")
|
||||||
|
|
Loading…
Reference in New Issue