From e337e775a52f644f023b4b7a36c2b49b6a8177bd Mon Sep 17 00:00:00 2001 From: Brian Hogan Date: Fri, 31 Aug 2018 00:06:15 -0500 Subject: [PATCH] initial commit of 0.1.0 --- .gitignore | 4 + LICENSE | 202 +++++++++++++++++++++++++++++++++ Makefile | 28 +++++ README.md | 52 +++++++++ app.go | 278 ++++++++++++++++++++++++++++++++++++++++++++++ data.json.example | 13 +++ 6 files changed, 577 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 Makefile create mode 100644 README.md create mode 100644 app.go create mode 100644 data.json.example diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..79a1a61 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +dist +gin-bin +data.json +.DS_Store diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..2ff852f --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + 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 Brian P. Hogan + + 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. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..f3bb56c --- /dev/null +++ b/Makefile @@ -0,0 +1,28 @@ +version = 0.1.0 + +mac: + mkdir -p dist/mac + cp data.json.example dist/mac/data.json + cp README.md dist/mac/README + cp LICENSE dist/mac/LICENSE + env GOOS=darwin GOARCH=amd64 go build -o dist/mac/demo-api + cd dist/mac; zip -9 demo-api-macos-${version}.zip data.json demo-api README LICENSE + +linux: + mkdir -p dist/linux + cp README.md dist/linux/README + cp LICENSE dist/linux/LICENSE + cp data.json.example dist/linux/data.json + env GOOS=linux GOARCH=amd64 go build -o dist/linux/demo-api + cd dist/linux; zip -9 demo-api-linux-${version}.zip data.json demo-api README LICENSE + +windows: + mkdir -p dist/windows + cp README.md dist/windows/README + cp LICENSE dist/windows/LICENSE + cp data.json.example dist/windows/data.json + env GOOS=windows GOARCH=amd64 go build -o dist/windows/demo-api.exe + cd dist/windows; zip -9 demo-api-windows-${version}.zip data.json demo-api.exe README LICENSE + +clean: + rm -rf dist/ diff --git a/README.md b/README.md new file mode 100644 index 0000000..9ebcc99 --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +# demo-api + +A simple command-line JSON server. If you need to stub out an API locally, this is the tool you need. It's lightweight, works on Mac, Windows, and Linux, and requires no setup. + +Create a JSON file called `data.json`: + +```json +{ + "notes" : [ + { + "id" : 1, + "title" : "Hello World" + }, + { + "id" : 2, + "title" : "The second note" + } + ] +} +``` + +Then run `demo-api`. + +Visit `http://localhost:8080` in the browser to see the file served as JSON. + +In addition, since the JSON file is structured like a typical REST API data structure, the following will work: + +* `GET http://localhost:8080/notes` - retrive all "notes" +* `GET http://localhost:8080/notes/1` - retrive the note with the `id` of `1` +* `POST http://localhost:8080/notes/` - Create a new note. This modifies the `data.json` file. +* `DELETE http://localhost:8080/notes/1` - Delete the note with the `id` of `1`. This modifies the `data.json` file. + +## Installation + +To install, download the latest release to your system and copy the executable to a location on your path. Then launch it in a directory containing `data.json`. + + +## Roadmap + +* `PUT/PATCH` support +* tests +* refactoring +* help switch +* version notice + +## Contributing + +Please contribute. Fork, create a PR. + +## License + +Apache 2. See LICENSE file. diff --git a/app.go b/app.go new file mode 100644 index 0000000..4abc309 --- /dev/null +++ b/app.go @@ -0,0 +1,278 @@ +package main + +import ( + "fmt" + "io/ioutil" + "os" + "strconv" +) + +import "github.com/gin-gonic/gin" + +import "github.com/Jeffail/gabs" + +// TODO: command line option? +var dataFile = "./data.json" + +func main() { + // turn off that noisy notice from Gin + gin.SetMode(gin.ReleaseMode) + + r := gin.Default() + + // attach Handler functions + r.Use(Cors()) + + // define API routes + r.GET("/", getJSON) + r.GET("/:name", getAll) + r.GET("/:name/:id", getById) + r.POST("/:name", create) + r.DELETE("/:name/:id", deleteById) + + // routes for js and cors + r.OPTIONS("/:name", accessControlHeaders) + r.OPTIONS("/:name/:id", accessControlHeaders) + + r.Run() +} + +// CORS support handler +func Cors() gin.HandlerFunc { + return func(c *gin.Context) { + c.Writer.Header().Add("Access-Control-Allow-Origin", "*") + c.Next() + } +} + +// ---- handlers + +// GET / +// This displays the serialized JSON from the file. It's a sanity check +// so the user knows all the data imported properly from the file. We +// parse it and then print it back out. +func getJSON(c *gin.Context) { + jsonParsed := getData() + c.Writer.Header().Set("Content-Type", "application/json") + c.String(200, jsonParsed.String()) +} + +// GET /:name +// Displays the json records for the resource +func getAll(c *gin.Context) { + jsonParsed := getData() + name := c.Params.ByName("name") + result := jsonParsed.S(name).String() + c.Writer.Header().Set("Content-Type", "application/json") + c.String(200, result) +} + +func toFloat(id string) (float64, error) { + return strconv.ParseFloat(id, 64) +} + +// GET /:name/:id +// Displays the json record for the given id +func getById(c *gin.Context) { + name := c.Params.ByName("name") + id := c.Params.ByName("id") + result := "{}" + code := 200 + + c.Writer.Header().Set("Content-Type", "application/json") + + record, err := findById(name, id) + + if err != nil { + code = 404 + } + + result = record.String() + + c.String(code, result) +} + +// DELETE /:name/:id +// Displays the json record for the given id +func deleteById(c *gin.Context) { + name := c.Params.ByName("name") + id := c.Params.ByName("id") + result := "{}" + code := 200 + + record, err := removeById(name, id) + + if err != nil { + code = 422 + fmt.Print(err) + } else { + result = record.String() + code = 200 + } + + c.Writer.Header().Set("Content-Type", "application/json") + c.String(code, result) +} + +// POST /:name +// Create a new resource and persist it +func create(c *gin.Context) { + + collectionName := c.Params.ByName("name") + + // Read data from body and parse it out + body, _ := ioutil.ReadAll(c.Request.Body) + + newRecord, err := gabs.ParseJSON([]byte(body)) + if err != nil { + fmt.Print(err) + } + + // give data from user an id + id := getNextId(collectionName) + newRecord.Set(id, "id") + + // update our overall collection + jsonParsed := getData() + jsonParsed.ArrayAppend(newRecord.Data(), collectionName) + saveData(jsonParsed) + + c.String(201, newRecord.String()) + +} + +// OPTIONS /:name +// OPTIONS /:name/:id +// Set OPTIONS header response for javascript + CORS via .fetch or .xHTTPrequest +func accessControlHeaders(c *gin.Context) { + c.Writer.Header().Set("Access-Control-Allow-Methods", "DELETE, POST, PUT, PATCH") + c.Writer.Header().Set("Access-Control-Allow-Headers", "Content-Type") + c.Next() +} + +// --- Helpers + +// getNextID - simulates the auto-incrementing key feature an API would have. +func getNextId(collection string) float64 { + // I recognize this implementation is terrible - + // Read the json, find all ids, find max one, adds one to result. + // Not really something you can rely on for scaling, and TOTALLY + // not concurrent. There will probably be a race condition between the time we + // get this id and the time we add the new record. + max := 0.0 + jsonParsed := getData() + records, _ := jsonParsed.S(collection).Children() + for _, record := range records { + value := record.S("id").Data().(float64) + if value > max { + max = value + } + } + + return max + 1 +} + +// Takes a collection and finds the record with the id. collection and id are +// strings +func findById(name string, idString string) (*gabs.Container, error) { + var result *gabs.Container + + id, err := toFloat(idString) + + if err != nil { + return result, err + } else { + + jsonParsed := getData() + collection := jsonParsed.S(name) + children, _ := collection.Children() + for _, child := range children { + if child.S("id").Data().(float64) == id { + result = child + break + } + } + + // if the result is an empty string we didn't find anything. + // I bet there's a better way. But the gabs.Container always + // returns an empty JSON string if it doesn't match. So this works + // for now. + if result.String() == "" { + return result, fmt.Errorf("json: no record found for id %g", id) + } + + return result, nil + } + +} + +func removeById(name string, idString string) (*gabs.Container, error) { + var result *gabs.Container + indexToDelete := -1 + + id, err := toFloat(idString) + + if err != nil { + return result, err + } else { + + jsonParsed := getData() + collection := jsonParsed.S(name) + children, _ := collection.Children() + + // find the index of the record we have to delete + for index, child := range children { + + // if we find it.... + if child.S("id").Data().(float64) == id { + // save the record we found as the result along with the index + result = child + indexToDelete = index + break + } + } + + // if we didn't find the record.... + if indexToDelete == -1 { + return result, fmt.Errorf("json: no record found for id %g", id) + } else { + + // remove the index we found from the array + err = jsonParsed.ArrayRemove(indexToDelete, name) + + if err == nil { + saveData(jsonParsed) + } + } + + return result, err + } + +} + +// Load the json from the file +func getData() *gabs.Container { + + // TODO: probably not super efficient to read the file all the time but + // I don't know another way to make this global right now. + + // TODO: I bet gabs can read json right from a file. I should explore that + data, err := ioutil.ReadFile(dataFile) + if err != nil { + fmt.Print("No data.json file found. Exiting.\n") + os.Exit(1) + } + + jsonParsed, err := gabs.ParseJSON([]byte(data)) + if err != nil { + fmt.Print(err) + } + + return jsonParsed +} + +// save json back to file. +func saveData(json *gabs.Container) error { + data := []byte(json.String()) + return ioutil.WriteFile(dataFile, data, 0644) +} diff --git a/data.json.example b/data.json.example new file mode 100644 index 0000000..c82477f --- /dev/null +++ b/data.json.example @@ -0,0 +1,13 @@ +{ + "notes" : [ + { + "id" : 1, + "title" : "Hello World" + }, + { + "id" : 2, + "title" : "The second note" + } + ] + +}