├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── backend ├── app.yaml └── posts.go ├── dispatch.yaml └── frontend ├── app.yaml └── static ├── elements ├── post-card.html ├── post-form.html ├── post-list.html └── post-service.html └── index.html /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | Want to contribute? Great! First, read this page (including the small print at the end). 2 | 3 | ### Before you contribute 4 | 5 | Before we can use your code, you must sign the 6 | [Google Individual Contributor License Agreement](https://developers.google.com/open-source/cla/individual?csw=1) 7 | (CLA), which you can do online. The CLA is necessary mainly because you own the 8 | copyright to your changes, even after your contribution becomes part of our 9 | codebase, so we need your permission to use and distribute your code. We also 10 | need to be sure of various other things—for instance that you'll tell us if you 11 | know that your code infringes on other people's patents. You don't have to sign 12 | the CLA until after you've submitted your code for review and a member has 13 | approved it, but you must do it before we can put your code into our codebase. 14 | Before you start working on a larger contribution, you should get in touch with 15 | us first through the issue tracker with your idea so that we can help out and 16 | possibly guide you. Coordinating up front makes it much easier to avoid 17 | frustration later on. 18 | 19 | ### Code reviews 20 | 21 | All submissions, including submissions by project members, require review. We 22 | use Github pull requests for this purpose. 23 | 24 | ### The small print 25 | 26 | Contributions made by corporations are covered by a different agreement than 27 | the one above, the Software Grant and Corporate Contributor License Agreement. 28 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Polymer Gopher 2 | ============== 3 | 4 | This project is a sample web application hosted on [App Engine][1] composed of 5 | two [App Engine modules][2]: 6 | 7 | - a frontend written using [Polymer][3] 8 | - a backend written in [Go][4] 9 | 10 | ## Running locally 11 | 12 | To run this application locally install the [Go App Engine SDK][7] and then execute: 13 | 14 | ``` 15 | $ goapp serve dispatch.yaml frontend/app.yaml backend/app.yaml 16 | ``` 17 | 18 | ## Deploying the app on the cloud 19 | 20 | And to deploy it: 21 | 22 | - Create a new Google Cloud project on the [Google Cloud Console][8] 23 | 24 | - Write your project id in every single `yaml` file: 25 | 26 | ```yaml 27 | application: your-application-id 28 | ``` 29 | 30 | - Then execute 31 | 32 | ``` 33 | $ goapp deploy backend/app.yaml 34 | $ goapp deploy frontend/app.yaml 35 | $ appcfg.py update_dispatch . 36 | ``` 37 | 38 | Then visiting http://your-project-id.appspot.com should show you the application 39 | running on the cloud. 40 | 41 | The documentation generated for the Go backend is available on [godoc.org][10]. 42 | 43 | [1]: https://cloud.google.com/appengine/docs 44 | [2]: https://cloud.google.com/appengine/docs/go/modules 45 | [3]: https://www.polymer-project.org 46 | [4]: https://golang.org 47 | [7]: https://cloud.google.com/appengine/downloads 48 | [8]: https://console.developers.google.com 49 | [9]: https://console.developers.google.com 50 | [10]: http://godoc.org/github.com/googlesamples/cloud-polymer-go/backend 51 | 52 | ### Disclaimer 53 | 54 | This is not an official Google product (experimental or otherwise), it is just 55 | code that happens to be owned by Google. 56 | -------------------------------------------------------------------------------- /backend/app.yaml: -------------------------------------------------------------------------------- 1 | # Copyright 2015 Google Inc. All rights reserved. 2 | # Licensed under the Apache License, Version 2.0 (the "License"); 3 | # you may not use this file except in compliance with the License. 4 | # You may obtain a copy of the License at 5 | # http:#www.apache.org/licenses/LICENSE-2.0 6 | # 7 | # Unless required by applicable law or agreed to writing, software distributed 8 | # under the License is distributed on a "AS IS" BASIS, WITHOUT WARRANTIES OR 9 | # CONDITIONS OF ANY KIND, either express or implied. 10 | # 11 | # See the License for the specific language governing permissions and 12 | # limitations under the License. 13 | 14 | module: default 15 | runtime: go 16 | api_version: go1 17 | 18 | handlers: 19 | - url: /_ah/spi/.* 20 | script: _go_app 21 | secure: always 22 | -------------------------------------------------------------------------------- /backend/posts.go: -------------------------------------------------------------------------------- 1 | // Copyright 2015 Google Inc. All rights reserved. 2 | // 3 | // Licensed under the Apache License, Version 2.0 (the "License"); 4 | // you may not use this file except in compliance with the License. 5 | // You may obtain a copy of the License at 6 | // http:#www.apache.org/licenses/LICENSE-2.0 7 | // 8 | // Unless required by applicable law or agreed to writing, software distributed 9 | // under the License is distributed on a "AS IS" BASIS, WITHOUT WARRANTIES OR 10 | // CONDITIONS OF ANY KIND, either express or implied. 11 | // 12 | // See the License for the specific language governing permissions and 13 | // limitations under the License. 14 | 15 | // Package backend exposes a REST API to manage posts stored in the Google 16 | // Cloud Datastore using the Cloud Endpoints feature of App Engine. 17 | package backend 18 | 19 | import ( 20 | "net/url" 21 | 22 | "google.golang.org/appengine" 23 | "google.golang.org/appengine/datastore" 24 | "google.golang.org/appengine/log" 25 | 26 | "golang.org/x/net/context" 27 | 28 | "github.com/GoogleCloudPlatform/go-endpoints/endpoints" 29 | ) 30 | 31 | // PostsAPI defines all the endpoints of the posts API. 32 | type PostsAPI struct{} 33 | 34 | // A Post contains all the information related to a post. 35 | type Post struct { 36 | UID *datastore.Key `json:"uid" datastore:"-"` 37 | Text string `json:"text"` 38 | Username string `json:"username"` 39 | Avatar string `json:"avatar"` 40 | Favorite bool `json:"favorite"` 41 | } 42 | 43 | // Posts contains a slice of posts. This type is needed because go-endpoints 44 | // only supports pointers to structs as input and output types. 45 | type Posts struct { 46 | Posts []Post `json:"posts"` 47 | } 48 | 49 | // List returns a list of all the existing posts. 50 | func (PostsAPI) List(c context.Context) (*Posts, error) { 51 | if err := checkReferer(c); err != nil { 52 | return nil, err 53 | } 54 | 55 | posts := []Post{} 56 | keys, err := datastore.NewQuery("Post").GetAll(c, &posts) 57 | if err != nil { 58 | return nil, err 59 | } 60 | for i, k := range keys { 61 | posts[i].UID = k 62 | } 63 | return &Posts{posts}, nil 64 | } 65 | 66 | // AddRequest contains all the fields needed to create a new Post. 67 | type AddRequest struct { 68 | Text string 69 | Username string 70 | Avatar string 71 | } 72 | 73 | // Add creates a new post given the fields in AddRequest, stores it in the 74 | // datastore, and returns it. 75 | func (PostsAPI) Add(c context.Context, r *AddRequest) (*Post, error) { 76 | if err := checkReferer(c); err != nil { 77 | return nil, err 78 | } 79 | 80 | k := datastore.NewIncompleteKey(c, "Post", nil) 81 | t := &Post{Text: r.Text, Username: r.Username, Avatar: r.Avatar} 82 | k, err := datastore.Put(c, k, t) 83 | if err != nil { 84 | return nil, err 85 | } 86 | t.UID = k 87 | return t, nil 88 | } 89 | 90 | // SetFavoriteRequest contains the information needed to change the favorite 91 | // status of a post. 92 | type SetFavoriteRequest struct { 93 | UID *datastore.Key 94 | Favorite bool 95 | } 96 | 97 | // SetFavorite changes the favorite status of a post given its UID. 98 | func (PostsAPI) SetFavorite(c context.Context, r *SetFavoriteRequest) error { 99 | if err := checkReferer(c); err != nil { 100 | return err 101 | } 102 | 103 | return datastore.RunInTransaction(c, func(c context.Context) error { 104 | var p Post 105 | if err := datastore.Get(c, r.UID, &p); err == datastore.ErrNoSuchEntity { 106 | return endpoints.NewNotFoundError("post not found") 107 | } else if err != nil { 108 | return err 109 | } 110 | p.Favorite = r.Favorite 111 | _, err := datastore.Put(c, r.UID, &p) 112 | return err 113 | }, nil) 114 | } 115 | 116 | // checkReferer returns an error if the referer of the HTTP request in the 117 | // given context is not allowed. 118 | // 119 | // The allowed referer is the appspot domain for the application, such as: 120 | // my-project-id.appspot.com 121 | // and all domains are accepted when running locally on dev app server. 122 | func checkReferer(c context.Context) error { 123 | if appengine.IsDevAppServer() { 124 | return nil 125 | } 126 | 127 | r := endpoints.HTTPRequest(c).Referer() 128 | u, err := url.Parse(r) 129 | if err != nil { 130 | log.Infof(c, "malformed referer detected: %q", r) 131 | return endpoints.NewUnauthorizedError("couldn't extract domain from referer") 132 | } 133 | 134 | if u.Host != appengine.AppID(c)+".appspot.com" { 135 | log.Infof(c, "unauthorized referer detected: %q", r) 136 | return endpoints.NewUnauthorizedError("referer unauthorized") 137 | } 138 | return nil 139 | } 140 | 141 | func init() { 142 | // register the posts API with cloud endpoints. 143 | api, err := endpoints.RegisterService(PostsAPI{}, "posts", "v1", "posts api", true) 144 | if err != nil { 145 | panic(err) 146 | } 147 | 148 | // adapt the name, method, and path for each method. 149 | info := api.MethodByName("List").Info() 150 | info.Name, info.HTTPMethod, info.Path = "getPosts", "GET", "posts" 151 | 152 | info = api.MethodByName("SetFavorite").Info() 153 | info.Name, info.HTTPMethod, info.Path = "setFavorite", "PUT", "posts" 154 | 155 | info = api.MethodByName("Add").Info() 156 | info.Name, info.HTTPMethod, info.Path = "addPost", "POST", "posts" 157 | 158 | // start handling cloud endpoint requests. 159 | endpoints.HandleHTTP() 160 | } 161 | -------------------------------------------------------------------------------- /dispatch.yaml: -------------------------------------------------------------------------------- 1 | # Copyright 2015 Google Inc. All rights reserved. 2 | # Licensed under the Apache License, Version 2.0 (the "License"); 3 | # you may not use this file except in compliance with the License. 4 | # You may obtain a copy of the License at 5 | # http:#www.apache.org/licenses/LICENSE-2.0 6 | # 7 | # Unless required by applicable law or agreed to writing, software distributed 8 | # under the License is distributed on a "AS IS" BASIS, WITHOUT WARRANTIES OR 9 | # CONDITIONS OF ANY KIND, either express or implied. 10 | # 11 | # See the License for the specific language governing permissions and 12 | # limitations under the License. 13 | 14 | dispatch: 15 | - url: "*/_ah/spi/*" 16 | module: default 17 | 18 | - url: "*/*" 19 | module: frontend 20 | -------------------------------------------------------------------------------- /frontend/app.yaml: -------------------------------------------------------------------------------- 1 | # Copyright 2015 Google Inc. All rights reserved. 2 | 3 | # Licensed under the Apache License, Version 2.0 (the "License"); 4 | # you may not use this file except in compliance with the License. 5 | # You may obtain a copy of the License at 6 | # http:#www.apache.org/licenses/LICENSE-2.0 7 | 8 | # Unless required by applicable law or agreed to writing, software distributed 9 | # under the License is distributed on a "AS IS" BASIS, WITHOUT WARRANTIES OR 10 | # CONDITIONS OF ANY KIND, either express or implied. 11 | 12 | # See the License for the specific language governing permissions and 13 | # limitations under the License. 14 | 15 | module: frontend 16 | api_version: 1 17 | runtime: python27 18 | threadsafe: yes 19 | 20 | handlers: 21 | - url: / 22 | static_files: static/index.html 23 | upload: static/index.html 24 | - url: / 25 | static_dir: static 26 | -------------------------------------------------------------------------------- /frontend/static/elements/post-card.html: -------------------------------------------------------------------------------- 1 | 16 | 17 | 18 | 19 | 74 | 88 | -------------------------------------------------------------------------------- /frontend/static/elements/post-form.html: -------------------------------------------------------------------------------- 1 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 38 | 61 | -------------------------------------------------------------------------------- /frontend/static/elements/post-list.html: -------------------------------------------------------------------------------- 1 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 57 | 71 | -------------------------------------------------------------------------------- /frontend/static/elements/post-service.html: -------------------------------------------------------------------------------- 1 | 16 | 34 | 35 | 36 | 37 | 41 | 66 | -------------------------------------------------------------------------------- /frontend/static/index.html: -------------------------------------------------------------------------------- 1 | 2 | 17 | 18 | 19 | 20 | Note manager 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | All 80 | Favorites 81 | 82 | 83 |
84 | 85 |
86 | 87 | 95 | 96 | 97 | --------------------------------------------------------------------------------