Dark-Alex-17/kapow
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
779 Commits 1 Branch 0 Tags
a724a35bdc874e771051223e8454cafb86c7340a
Commit Graph
100 Commits
This Branch
This Branch
All Branches
Author SHA1 Message Date
pancho horrillo a724a35bdc docs: release notes: bump go release used to produce artifacts 2019-12-13 20:14:19 +01:00
pancho horrillo c1c42982e2 docs: move release notes into docs/release-notes 2019-12-13 19:53:59 +01:00
pancho horrillo 3c05e3b580 doc: drop already resolved todo block 2019-12-13 16:09:52 +01:00
pancho horrillo 24f0597c95 doc: add link 2019-12-13 16:07:47 +01:00
pancho horrillo 3149554ff1 doc: add links and style fixes 2019-12-13 16:03:49 +01:00
pancho horrillo 74d9129d27 doc: add link 2019-12-13 15:43:51 +01:00
pancho horrillo 66eda3c6bd doc: drop stale todo block 2019-12-13 15:36:41 +01:00
pancho horrillo b32d670251 doc: style fix 2019-12-13 15:35:20 +01:00
pancho horrillo 04ec4f2c41 doc: style fixes 2019-12-13 15:33:17 +01:00
pancho horrillo b0d0c12981 doc: add links and roles 2019-12-13 15:27:21 +01:00
pancho horrillo 3bb0205ad1 doc: style fixes 2019-12-13 15:14:35 +01:00
pancho horrillo 2847073519 doc: drop explicit :tech: role 2019-12-13 15:10:17 +01:00
pancho horrillo dea72cbe3a doc: style fixes and links 2019-12-13 15:08:02 +01:00
pancho horrillo 08086ee66e doc: style fixes 2019-12-13 12:37:12 +01:00
pancho horrillo 45de5a55e8 doc: style fixes 2019-12-13 12:35:48 +01:00
pancho horrillo 7b61c182f0 doc: style fixes 2019-12-13 12:33:14 +01:00
pancho horrillo 7f9e9de1d2 doc: add missing links and roles 2019-12-13 12:24:36 +01:00
pancho horrilloandRoberto Abdelkader Martínez Pérez b9f42bc458 doc: fix code style in titles 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 18:18:05 +01:00
pancho horrilloandRoberto Abdelkader Martínez Pérez f57df90347 doc: fix broken link 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 18:17:46 +01:00
pancho horrilloandRoberto Abdelkader Martínez Pérez 5a18f84f9e doc: fix style 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 18:10:29 +01:00
pancho horrilloandRoberto Abdelkader Martínez Pérez e78af66c12 doc: markup ping as command role, not program role 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 17:56:28 +01:00
pancho horrilloandRoberto Abdelkader Martínez Pérez 10cccca55d doc: add links and polish the_project/* 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 17:45:01 +01:00
pancho horrilloandRoberto Abdelkader Martínez Pérez 0fd3cfb665 doc: add internal links 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 17:44:10 +01:00
pancho horrilloandRoberto Abdelkader Martínez Pérez ecaea23d40 doc: markup stdin as tech role 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 16:05:55 +01:00
pancho horrilloandRoberto Abdelkader Martínez Pérez cc6816faf9 doc: markup :option: role as :nref-option: role to prevent sphinx warnings 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 16:02:49 +01:00
pancho horrilloandRoberto Abdelkader Martínez Pérez ab615e2276 doc: markup :any: role as default role, which is now :tech: (custom) 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 15:59:27 +01:00
pancho horrilloandRoberto Abdelkader Martínez Pérez e84681d828 doc: markup find as command role 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 15:24:36 +01:00
pancho horrillo 0a0dd9d416 Revert "Set Sphinx default_role to allow single backslash to be render as 'option' role." 
This reverts commit 2de227e59c.

This does not fix the issue we are having with :any: roles.
 2019-12-11 15:24:36 +01:00
pancho horrilloandRoberto Abdelkader Martínez Pérez cb5ba7db43 doc: markup {User,Control,Data} HTTP Interface as role any 
Also markup localhost:8080 as code, for consistency.

Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 14:41:14 +01:00
pancho horrilloandRoberto Abdelkader Martínez Pérez bd1ea8f746 doc: markup 'kapow server' as code 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 14:32:12 +01:00
pancho horrilloandRoberto Abdelkader Martínez Pérez b7ec9815aa doc: markup cat as command role 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 14:20:57 +01:00
pancho horrilloandRoberto Abdelkader Martínez Pérez 578e4c3b30 doc: markup envvars as such, HANDLER_ID as variable 
HANDLER_ID represents a variable name in this case, and the docs¹, first Note,
suggest using the default role (`content`) for variable names.

¹: https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html

Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 13:29:18 +01:00
pancho horrilloandRoberto Abdelkader Martínez Pérez 11383d456a doc: markup JSON as any role (part II) 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 13:17:55 +01:00
pancho horrillo 8b3417000d doc: style fix 2019-12-11 13:16:46 +01:00
pancho horrilloandRoberto Abdelkader Martínez Pérez 90f97f63fa doc: markup Docker{,file} as any role 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 13:15:45 +01:00
pancho horrilloandRoberto Abdelkader Martínez Pérez 09e842f199 doc: markup JSON and HTTP API as any role 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 13:05:39 +01:00
pancho horrilloandRoberto Abdelkader Martínez Pérez 4102834167 doc: italizice Kapow! in title 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 12:51:58 +01:00
pancho horrilloandRoberto Abdelkader Martínez Pérez 5fa3a2489a doc: markup Go as any role 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 12:50:45 +01:00
pancho horrilloandRoberto Abdelkader Martínez Pérez d69e7b90e7 doc: markup ping.pow as file role 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 12:46:50 +01:00
pancho horrilloandRoberto Abdelkader Martínez Pérez 171f8c0410 doc: markup kapow as program role 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 12:41:18 +01:00
pancho horrilloandRoberto Abdelkader Martínez Pérez 1cb328646e doc: markup ping as program role 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 12:16:41 +01:00
pancho horrilloandRoberto Abdelkader Martínez Pérez 8742ee9667 doc: markup ls as command role 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 11:44:32 +01:00
pancho horrilloandRoberto Abdelkader Martínez Pérez 45de867b2d doc: markup jq as program role 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 11:43:04 +01:00
pancho horrilloandRoberto Abdelkader Martínez Pérez 4d2f0af941 doc: markup curl as program role 
See ¹.

¹: https://www.sphinx-doc.org/en/1.5/markup/inline.html#role-program

Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-11 11:43:04 +01:00
pancho horrilloandRoberto Abdelkader Martínez Pérez 3bed9924d5 doc: make example script downloadable 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@bbva.com>
 2019-12-11 10:45:48 +01:00
pancho horrillo 375cf7e912 doc: fix title 2019-12-11 03:37:19 +01:00
pancho horrillo ec4143393a doc: tweak code-block language to activate syntax highlighting 2019-12-11 03:35:12 +01:00
pancho horrillo b1d0e9c92f doc: use valid language in code-blocks 
See ¹ for the valid values.

¹: https://www.sphinx-doc.org/en/1.5/markup/code.html#directive-code-block
 2019-12-11 03:23:56 +01:00
pancho horrillo 9436548d7b doc: normalize code-block type 2019-12-11 03:13:28 +01:00
pancho horrillo c974e7787e doc: tweak code-block to fix render glitch at readthedocks.io 2019-12-11 03:10:55 +01:00
pancho horrillo deceadcc49 doc: misc fixes 2019-12-11 02:49:37 +01:00
pancho horrillo e6cb0f1fa6 doc: fix typo and rst style fixes 
As per the official docs¹, we should use ``code`` instead of :samp:`code`,
since we are not enhancing variables inside.

:samp:
A piece of literal text, such as code. Within the contents, you can use curly
braces to indicate a “variable” part, as in file. For example, in :samp:`print
1+{variable}`, the part variable would be emphasized.

If you don’t need the “variable part” indication, use the standard ``code``
instead.

¹: https://www.sphinx-doc.org/en/1.5/markup/inline.html#role-samp
 2019-12-11 02:37:56 +01:00
pancho horrillo 16639ba44b doc: style fixes 2019-12-11 02:32:52 +01:00
pancho horrillo 37025211b1 doc: style fixes 2019-12-11 02:06:31 +01:00
pancho horrillo 68efc98964 doc: consistent naming of pow files 2019-12-11 02:04:11 +01:00
pancho horrillo ef838c4a25 doc: style fix 2019-12-10 18:23:23 +01:00
pancho horrillo ba6006fdf5 doc: fix typo 2019-12-10 18:15:29 +01:00
pancho horrillo a9328fe706 doc: consistent naming of pow files 2019-12-10 18:10:31 +01:00
pancho horrillo ae68cf8fed doc: tutorial style fixes 2019-12-10 18:01:54 +01:00
pancho horrillo 99167e8627 doc: tutorial background story fixes 2019-12-10 16:19:06 +01:00
pancho horrillo cbacacf8e1 doc: tutorial background story fixes 2019-12-10 16:15:40 +01:00
pancho horrillo b4bc08f491 doc: typos and style fixes 2019-12-10 16:09:35 +01:00
pancho horrilloandRoberto Abdelkader Martínez Pérez bb4aa1a00f doc: normalize style of Kapow!, to be shown italicized 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-10 10:34:39 +01:00
pancho horrilloandRoberto Abdelkader Martínez Pérez 166c767317 doc: add section on security and misc fixes 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-12-05 18:30:35 +01:00
pancho horrilloandLuis Saiz 8248627f04 doc: misc fixes 
Co-authored-by: Luis Saiz <luis.saiz@bbva.com>
 2019-11-29 12:57:45 +01:00
pancho horrillo 2e1455cb61 Revert "Update quickstart.rst" 
This reverts commit 7fab8ae529.
 2019-11-29 10:20:40 +01:00
pancho horrillo f1bdc99267 doc: drop dangling link 2019-11-28 10:44:53 +01:00
pancho horrillo 34a5960b3c doc: fix wording 2019-11-27 16:13:32 +01:00
pancho horrillo 53b326cb7b doc: style fixes, example code fixes and clarifications 2019-11-27 16:07:23 +01:00
pancho horrillo 530fad17c9 doc: fix typo 2019-11-27 07:53:56 +01:00
pancho horrilloandHector Hurtado d08c6c72e7 doc: more work on _brainstorming.rst 
Co-authored-by: Hector Hurtado <hector.hurtado@bbva.com>
 2019-11-25 18:05:50 +01:00
pancho horrillo 6b2e2dfb28 RELEASE-v0.3.0.md: fix title 2019-11-22 17:03:54 +01:00
pancho horrillo 235375c199 RELEASE-v0.3.0.md: fix title 2019-11-22 16:51:19 +01:00
pancho horrillo 2f70938dc4 RELEASE-v0.3.0.md: fix link format and main title 2019-11-22 15:42:56 +01:00
pancho horrillo 07c6c42b73 Add release notes for v0.3.0 2019-11-22 15:39:19 +01:00
pancho horrillo ce83cac13e README.md: minor style fixes 2019-11-22 14:20:10 +01:00
pancho horrillo 0b0defd132 README.md: misc style fixes 2019-11-22 14:15:24 +01:00
pancho horrilloandRoberto Abdelkader Martínez Pérez 26145cba79 doc: updates to route_matching section 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-11-22 12:13:25 +01:00
pancho horrilloandRoberto Abdelkader Martínez Pérez f9867fb269 doc: add sections on theory/{routes,route_matching} 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-11-22 12:04:49 +01:00
pancho horrillo 8474f31747 doc: update request_life_cycle.rst 2019-11-22 09:20:29 +01:00
pancho horrilloandRoberto Abdelkader Martínez Pérez 24cc530a0e doc: add missing quotes in example 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-11-21 13:12:19 +01:00
pancho horrillo 8f876ba7db doc: fix a couple of typos and drop spurious whitespace 2019-11-21 10:36:46 +01:00
pancho horrilloandRoberto Abdelkader Martínez Pérez ae0c8b58a1 Misc doc updates 
Co-Authored-By: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-11-20 16:37:00 +01:00
pancho horrillo 25d9f1c1ef Delete placeholder 2019-11-20 16:16:32 +01:00
pancho horrillo e5e8da551e docs/philosophy.rst: style fixes 2019-11-20 14:30:28 +01:00
pancho horrilloandRoberto Abdelkader Martínez Pérez 5ee8353cba WIP on docs/theory 
Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
 2019-11-20 12:54:29 +01:00
pancho horrillo 206aac5747 Rename package srverrors to httperror 
- Package names are preferred to be in singular form¹.
- Since errors are just for HTTP and not generic, I changed the base name to
'http'.
- I didn't name it simply 'error', because it would then conflict with the
- standard 'error' interface.

¹: https://rakyll.org/style-packages/
 2019-11-20 07:54:45 +01:00
pancho horrillo 0d66fe9963 Rename WriteErrorResponse() to simply ErrorJSON() and reorder arguments 
This way we better mimic net/http.Error()

https://pkg.go.dev/net/http?tab=doc#Error
 2019-11-20 07:37:35 +01:00
pancho horrillo 7ea43048bc Add missing comments 2019-11-20 07:14:00 +01:00
pancho horrillo d81ef278da Update Makefile to make use of -trimpath build option 
This option makes go build/install removes the absolute paths
within the produced executable, enabling more reproducible builds.

See ¹ for more details.

¹: https://golang.org/doc/go1.13?ref=hvper.com#go-command
 2019-11-20 06:43:40 +01:00
pancho horrillo 75b0908b16 Rename GetReasonFromBody() to simply Reason() 
See ¹ for the customary idiomatic way of naming getters in Go.

¹: https://golang.org/doc/effective_go.html#Getters
 2019-11-20 05:04:10 +01:00
pancho horrillo 3a47b34bc1 Drop stale GetReason() and associated tests 2019-11-20 04:54:07 +01:00
pancho horrillo b40f73115f Add missing comment to GetReasonFromBody() 2019-11-20 04:51:29 +01:00
pancho horrillo b130cfdec7 Add some examples 
Note that the example on redirecting a URL is BROKEN.  Possibly a bug in Kapow!
 2019-11-19 21:52:10 +01:00
pancho horrillo 81c677c3be internal/http/request.go: replace GetReason() with GetReasonFromBody() 
Update tests to inject the required JSON error body with reason.
 2019-11-19 21:17:49 +01:00
pancho horrillo e7619238ae Add GetReasonFromBody() that extracts reason from JSON 2019-11-19 21:17:34 +01:00
pancho horrillo 28f4b969f9 Update go.{mod,sum} recreating them from scratch 
$ rm go.{mod,sum}; go mod init github.com/BBVA/kapow
go: creating new go.mod: module github.com/BBVA/kapow
$ go mod tidy -v
go: finding github.com/google/shlex latest

With this, we've gotten rid an unneeded dep (github.com/spf13/pflag @ v1.0.5).
 2019-11-19 17:50:16 +01:00
pancho horrillo 806905c49c Update go.{mod,sum} 
Set base version to go 1.13

and run:

$ go mod tidy -v
unused github.com/gogo/protobuf
unused github.com/golangci/gocyclo
unused github.com/golangci/golangci-lint
unused github.com/golangci/revgrep
unused github.com/gostaticanalysis/analysisutil
unused github.com/konsorten/go-windows-terminal-sequences
unused github.com/magiconair/properties
unused github.com/mattn/go-isatty
unused github.com/pelletier/go-toml
unused github.com/securego/gosec
unused github.com/spf13/afero
unused github.com/spf13/jwalterweatherman
unused github.com/uudashr/gocognit
unused golang.org/x/sys
unused golang.org/x/tools
unused mvdan.cc/unparam
unused sourcegraph.com/sqs/pbtypes
 2019-11-19 17:32:28 +01:00
pancho horrillo 83e4523dc7 Simplify files via gofmt -s (thanks, Go Report Card!) 2019-11-19 14:14:55 +01:00
pancho horrillo 92fbb72735 Fix typos catched via misspell (thanks Go Report Card!) 2019-11-19 14:07:58 +01:00