v5.0.0: Initial public commit

.gitignore

@@ -0,0 +1,7 @@
+*.test
+/bin
+
+clientcompat/pycompat/ENV
+*.pyc
+
+build

CONTRIBUTING.md

@@ -0,0 +1,62 @@
+# Contributing #
+
+Thanks for helping make Twirp better! This is great!
+
+First, if you have run into a bug, please file an issue. We try to get back to
+issue reporters within a day or two. We might be able to help you right away.
+
+If you'd rather not publicly discuss the issue, please email [email protected]
+and/or [email protected].
+
+Issues are also a good place to present experience reports or requests for new
+features.
+
+If you'd like to make changes to Twirp, read on:
+
+## Setup Requirements ##
+
+You will need git, Go 1.9+, and Python 2.7 installed and on your system's path.
+Install them however you feel.
+
+We work on a branch called `develop`. We periodically release this branch as a
+new version, then accumulate more changes on the develop branch until the next
+release. Use `develop` as the base for your branches.
+
+## Developer Loop ##
+
+Generally you want to make changes and run `make`, which will install all
+dependencies we know about, build the core, and run all of the tests that we
+have against all of the languages we support.
+
+Most tests of the Go server are in `internal/twirptest/service_test.go`. Tests
+of cross-language clients are in the [clientcompat](./clientcompat) directory.
+
+## Contributing Code ##
+
+Twirp uses github pull requests. Fork a branch from `develop`, hack away at your
+changes, run the test suite with `make`, and submit a PR.
+
+## Releasing Versions ##
+
+Releasing versions is the responsibility of the core maintainers. Most people
+don't need to know this stuff.
+
+Twirp uses [Semantic versioning](http://semver.org/): `v<major>.<minor>.<patch>`.
+
+ * Increment major if you're making a backwards-incompatible change.
+ * Increment minor if you're adding a feature that's backwards-compatible.
+ * Increment patch if you're making a bugfix.
+
+To make a release, remember to update the version number in
+[internal/gen/version.go](./internal/gen/version.go).
+
+Twirp uses Github releases. To make a new release:
+ 1. Merge all changes that should be included in the release into the master
+    branch.
+ 2. Add a new commit to master with a message like "Version vX.X.X release".
+ 3. Tag the commit you just made: `git tag <version number>` and `git push
+    origin --tags`
+ 3. Go to Github https://github.com/twitchtv/twirp/releases and
+    "Draft a new release".
+ 4. Make sure to document changes, specially when upgrade instructions are
+    needed.

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "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 Twitch Interactive, Inc.
+
+   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.

Makefile

@@ -0,0 +1,51 @@
+RETOOL=$(CURDIR)/_tools/bin/retool
+PATH := ${PWD}/bin:${PWD}/ENV/bin:${PATH}
+.DEFAULT_GOAL := all
+
+all: setup test_all
+
+.PHONY: test test_all test_core test_clients test_go_client test_python_client generate
+
+# Phony commands:
+generate:
+	PATH=$(CURDIR)/_tools/bin:$(PATH) GOBIN="${PWD}/bin" go install -v ./protoc-gen-...
+	$(RETOOL) do go generate ./...
+
+test_all: setup test_core test_clients
+
+test_core: generate
+	$(RETOOL) do errcheck -blank ./internal/twirptest
+	go test -race $(shell go list ./... | grep -v /vendor/ | grep -v /_tools/)
+
+test_clients: test_go_client test_python_client
+
+test_go_client: generate build/clientcompat build/gocompat
+	./build/clientcompat -client ./build/gocompat
+
+test_python_client: generate build/clientcompat build/pycompat
+	./build/clientcompat -client ./build/pycompat
+
+setup:
+	./install_proto.bash
+	GOPATH=$(CURDIR)/_tools go install github.com/twitchtv/retool/...
+	$(RETOOL) build
+
+# Actual files for testing clients:
+./build:
+	mkdir build
+
+./build/gocompat: ./build
+	go build -o build/gocompat ./clientcompat/gocompat
+
+./build/clientcompat: ./build
+	go build -o build/clientcompat ./clientcompat
+
+./build/venv: ./build
+	virtualenv ./build/venv
+
+./build/venv/bin/pycompat.py: ./build/venv
+	./build/venv/bin/pip install --upgrade ./clientcompat/pycompat
+
+./build/pycompat: ./build/venv/bin/pycompat.py
+	cp ./clientcompat/pycompat/pycompat.sh ./build/pycompat
+	chmod +x ./build/pycompat

README.md

@@ -0,0 +1,34 @@
+![Twirp Logo](./logo.png)
+
+---
+
+Twirp is a framework for service-to-service communication emphasizing simplicity
+and minimalism. It generates routing and serialization from API definition files
+and lets you focus on your application's logic instead of thinking about
+folderol like HTTP methods and paths and JSON.
+
+Define your service in a
+[Protobuf](https://developers.google.com/protocol-buffers/docs/proto3) file and
+then Twirp autogenerates Go code with a server interface and fully functional
+clients. It's similar to [gRPC](http://www.grpc.io/), but without the custom
+HTTP server and transport implementations: it runs on the standard library's
+extremely-well-tested-and-high-performance `net/http` Server. It can run on HTTP
+1.1, not just http/2, and supports JSON clients for easy integrations across
+languages
+
+Twirp handles routing and serialization for you in a well-tested, standardized,
+thoughtful way so you don't have to. Serialization and deserialization code is
+error-prone and tricky, and you shouldn't be wasting your time deciding whether
+it should be "POST /friends/:id/new" or "POST /:id/friend" or whatever. Just
+get to the real work of building services!
+
+Along the way, you get an autogenerated client and a simple, smart framework for
+passing error messages. Nice!
+
+### Releases
+Twirp follows semantic versioning through git tags, and uses Github Releases for
+release notes and upgrade guides:
+[Twirp Releases](https://github.com/twitchtv/twirp/releases)
+
+### Contributing
+Check out [CONTRIBUTING.md](./CONTRIBUTING.md) for notes on making contributions.

_tools/.gitignore

@@ -0,0 +1,3 @@
+/bin/
+/pkg/
+/manifest.json