From 368bd244aed0709c8b1bb05464d44f4d0cca07a4 Mon Sep 17 00:00:00 2001 From: Christine Dodrill Date: Thu, 21 Mar 2019 07:55:32 -0700 Subject: [PATCH] vendor some dependencies --- cmd/site/html.go | 26 +- cmd/site/main.go | 4 +- cmd/site/rss.go | 4 +- go.mod | 7 +- go.sum | 9 +- internal/front/LICENSE | 19 ++ internal/front/front.go | 24 ++ internal/jsonfeed/.travis.yml | 17 ++ internal/jsonfeed/LICENSE | 363 +++++++++++++++++++++++++++ internal/jsonfeed/README.md | 8 + internal/jsonfeed/jsonfeed.go | 73 ++++++ internal/jsonfeed/jsonfeed_test.go | 43 ++++ internal/jsonfeed/testdata/feed.json | 21 ++ 13 files changed, 581 insertions(+), 37 deletions(-) create mode 100644 internal/front/LICENSE create mode 100644 internal/front/front.go create mode 100644 internal/jsonfeed/.travis.yml create mode 100644 internal/jsonfeed/LICENSE create mode 100644 internal/jsonfeed/README.md create mode 100644 internal/jsonfeed/jsonfeed.go create mode 100644 internal/jsonfeed/jsonfeed_test.go create mode 100644 internal/jsonfeed/testdata/feed.json diff --git a/cmd/site/html.go b/cmd/site/html.go index fe8d190..afb0790 100644 --- a/cmd/site/html.go +++ b/cmd/site/html.go @@ -19,7 +19,7 @@ func (s *Site) renderTemplatePage(templateFname string, data interface{}) http.H return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { fetag := "W/" + Hash(templateFname, etag) + "-1" - f := ln.F{"etag": fetag, "if-none-match": r.Header.Get("If-None.Match")} + f := ln.F{"etag": fetag, "if_none_match": r.Header.Get("If-None-Match")} if r.Header.Get("If-None-Match") == fetag { http.Error(w, "Cached data OK", http.StatusNotModified) @@ -28,29 +28,15 @@ func (s *Site) renderTemplatePage(templateFname string, data interface{}) http.H } defer logTemplateTime(templateFname, f, time.Now()) - s.tlock.RLock() - defer s.tlock.RUnlock() var t *template.Template var err error - if s.templates[templateFname] == nil { - t, err = template.ParseFiles("templates/base.html", "templates/"+templateFname) - if err != nil { - w.WriteHeader(http.StatusInternalServerError) - ln.Error(context.Background(), err, ln.F{"action": "renderTemplatePage", "page": templateFname}) - fmt.Fprintf(w, "error: %v", err) - } - - ln.Log(context.Background(), ln.F{"action": "loaded_new_template", "fname": templateFname}) - - s.tlock.RUnlock() - s.tlock.Lock() - s.templates[templateFname] = t - s.tlock.Unlock() - s.tlock.RLock() - } else { - t = s.templates[templateFname] + t, err = template.ParseFiles("templates/base.html", "templates/"+templateFname) + if err != nil { + w.WriteHeader(http.StatusInternalServerError) + ln.Error(context.Background(), err, ln.F{"action": "renderTemplatePage", "page": templateFname}) + fmt.Fprintf(w, "error: %v", err) } w.Header().Set("ETag", fetag) diff --git a/cmd/site/main.go b/cmd/site/main.go index 1690842..60619c7 100644 --- a/cmd/site/main.go +++ b/cmd/site/main.go @@ -12,13 +12,13 @@ import ( "sync" "time" - "github.com/Xe/jsonfeed" + "christine.website/internal/front" + "christine.website/internal/jsonfeed" "github.com/gorilla/feeds" "github.com/povilasv/prommod" "github.com/prometheus/client_golang/prometheus" "github.com/prometheus/client_golang/prometheus/promhttp" blackfriday "github.com/russross/blackfriday" - "github.com/tj/front" "within.website/ln" ) diff --git a/cmd/site/rss.go b/cmd/site/rss.go index 935749f..2f319b2 100644 --- a/cmd/site/rss.go +++ b/cmd/site/rss.go @@ -16,7 +16,7 @@ const IncrediblySecureSalt = "hunter2" func (s *Site) createFeed(w http.ResponseWriter, r *http.Request) { w.Header().Set("Content-Type", "application/rss+xml") - w.Header().Set("ETag", Hash(bootTime.String(), IncrediblySecureSalt)) + w.Header().Set("ETag", "W/"+Hash(bootTime.String(), IncrediblySecureSalt)) err := s.rssFeed.WriteRss(w) if err != nil { @@ -32,7 +32,7 @@ func (s *Site) createFeed(w http.ResponseWriter, r *http.Request) { func (s *Site) createAtom(w http.ResponseWriter, r *http.Request) { w.Header().Set("Content-Type", "application/atom+xml") - w.Header().Set("ETag", Hash(bootTime.String(), IncrediblySecureSalt)) + w.Header().Set("ETag", "W/"+Hash(bootTime.String(), IncrediblySecureSalt)) err := s.rssFeed.WriteAtom(w) if err != nil { diff --git a/go.mod b/go.mod index fffb7fd..0886618 100644 --- a/go.mod +++ b/go.mod @@ -1,7 +1,6 @@ module christine.website require ( - github.com/Xe/jsonfeed v0.0.0-20170520170432-e21591505612 github.com/golang/protobuf v1.3.1 // indirect github.com/gorilla/feeds v1.1.0 github.com/kr/pretty v0.1.0 // indirect @@ -13,10 +12,8 @@ require ( github.com/prometheus/procfs v0.0.0-20190319124303-40f3c57fb198 // indirect github.com/russross/blackfriday v2.0.0+incompatible github.com/shurcooL/sanitized_anchor_name v1.0.0 // indirect - github.com/st3fan/jsonfeed v0.0.0-20170519104842-498b2850d26b // indirect - github.com/stretchr/testify v1.3.0 // indirect - github.com/tj/front v0.0.0-20170212063142-739be213b0a1 + github.com/stretchr/testify v1.3.0 gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 // indirect - gopkg.in/yaml.v1 v1.0.0-20140924161607-9f9df34309c0 // indirect + gopkg.in/yaml.v2 v2.2.1 within.website/ln v0.5.2 ) diff --git a/go.sum b/go.sum index 1cedc19..1ce1b69 100644 --- a/go.sum +++ b/go.sum @@ -1,5 +1,3 @@ -github.com/Xe/jsonfeed v0.0.0-20170520170432-e21591505612 h1:5cPld6YTMozzm3lK9VCnOErgoFbADM2hZc4KDu0YNKs= -github.com/Xe/jsonfeed v0.0.0-20170520170432-e21591505612/go.mod h1:UKXAbYA/G9yE+cPbpfiP7FlT6Kr3N2mbEjQEJ9hT004= github.com/alecthomas/template v0.0.0-20160405071501-a0175ee3bccc/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc= github.com/alecthomas/units v0.0.0-20151022065526-2efee857e7cf/go.mod h1:ybxpYRFXyAe+OPACYpWeL0wqObRcbAqCMya13uyzqw0= github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973 h1:xJ4a3vCFaGF/jqvzLMYoU8P317H5OQ+Via4RmuPwCS0= @@ -57,16 +55,12 @@ github.com/russross/blackfriday v2.0.0+incompatible/go.mod h1:JO/DiYxRf+HjHt06Oy github.com/shurcooL/sanitized_anchor_name v1.0.0 h1:PdmoCO6wvbs+7yrJyMORt4/BmY5IYyJwS/kOiWx8mHo= github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc= github.com/sirupsen/logrus v1.2.0/go.mod h1:LxeOpSwHxABJmUn/MG1IvRgCAasNZTLOkJPxbbu5VWo= -github.com/st3fan/jsonfeed v0.0.0-20170519104842-498b2850d26b h1:i9Wk9W2bjrMvUf59rJKX4/lvZXy3L3lcX7g18c8AveU= -github.com/st3fan/jsonfeed v0.0.0-20170519104842-498b2850d26b/go.mod h1:czFrYpD7aNT5ZhBQWKEGOhCOl/yVZctFgs9bSxzVBbA= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= github.com/stretchr/testify v1.2.2 h1:bSDNvY7ZPG5RlJ8otE/7V6gMiyenm9RtJ7IUVIAoJ1w= github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= github.com/stretchr/testify v1.3.0 h1:TivCn/peBQ7UY8ooIcPgZFpTNSz0Q2U6UrFlUfqbe0Q= github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= -github.com/tj/front v0.0.0-20170212063142-739be213b0a1 h1:lA+aPRvltlx2fwv/BnxyYSDQo3pIeqzHgMO5GvK0T9E= -github.com/tj/front v0.0.0-20170212063142-739be213b0a1/go.mod h1:deJrtusCTptAW4EUn5vBLpl3dhNqPqUwEjWJz5UNxpQ= golang.org/x/crypto v0.0.0-20180904163835-0709b304e793/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= golang.org/x/net v0.0.0-20180811021610-c39426892332/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= golang.org/x/net v0.0.0-20181114220301-adae6a3d119a/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= @@ -79,8 +73,7 @@ gopkg.in/alecthomas/kingpin.v2 v2.2.6/go.mod h1:FMv+mEhP44yOT+4EoQTLFTRgOQ1FBLks gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY= gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= -gopkg.in/yaml.v1 v1.0.0-20140924161607-9f9df34309c0 h1:POO/ycCATvegFmVuPpQzZFJ+pGZeX22Ufu6fibxDVjU= -gopkg.in/yaml.v1 v1.0.0-20140924161607-9f9df34309c0/go.mod h1:WDnlLJ4WF5VGsH/HVa3CI79GS0ol3YnhVnKP89i0kNg= +gopkg.in/yaml.v2 v2.2.1 h1:mUhvW9EsL+naU5Q3cakzfE91YhliOondGd6ZrsDBHQE= gopkg.in/yaml.v2 v2.2.1/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= within.website/ln v0.5.2 h1:4pTM2wzpLjeZAputLf2U29HD79vcmdoEI/VPm2QEYgs= within.website/ln v0.5.2/go.mod h1:ifURKqsCJekcsdUE+hyCdcuhQqQ+9v9DfA++ZqYxZFE= diff --git a/internal/front/LICENSE b/internal/front/LICENSE new file mode 100644 index 0000000..e8152bb --- /dev/null +++ b/internal/front/LICENSE @@ -0,0 +1,19 @@ +Copyright (c) 2017 TJ Holowaychuk + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. \ No newline at end of file diff --git a/internal/front/front.go b/internal/front/front.go new file mode 100644 index 0000000..b2c7f0e --- /dev/null +++ b/internal/front/front.go @@ -0,0 +1,24 @@ +// Package front provides YAML frontmatter unmarshalling. +package front + +import ( + "bytes" + + "gopkg.in/yaml.v2" +) + +// Delimiter. +var delim = []byte("---") + +// Unmarshal parses YAML frontmatter and returns the content. When no +// frontmatter delimiters are present the original content is returned. +func Unmarshal(b []byte, v interface{}) (content []byte, err error) { + if !bytes.HasPrefix(b, delim) { + return b, nil + } + + parts := bytes.SplitN(b, delim, 3) + content = parts[2] + err = yaml.Unmarshal(parts[1], v) + return +} diff --git a/internal/jsonfeed/.travis.yml b/internal/jsonfeed/.travis.yml new file mode 100644 index 0000000..e872c60 --- /dev/null +++ b/internal/jsonfeed/.travis.yml @@ -0,0 +1,17 @@ +# This Source Code Form is subject to the terms of the Mozilla Public +# License, v. 2.0. If a copy of the MPL was not distributed with this +# file, You can obtain one at http://mozilla.org/MPL/2.0/ + +language: go + +go: + - 1.8.1 + +before_install: + - go get -t -v ./... + +script: + - go test -race -coverprofile=coverage.txt -covermode=atomic + +after_success: + - bash <(curl -s https://codecov.io/bash) diff --git a/internal/jsonfeed/LICENSE b/internal/jsonfeed/LICENSE new file mode 100644 index 0000000..e87a115 --- /dev/null +++ b/internal/jsonfeed/LICENSE @@ -0,0 +1,363 @@ +Mozilla Public License, version 2.0 + +1. Definitions + +1.1. "Contributor" + + means each individual or legal entity that creates, contributes to the + creation of, or owns Covered Software. + +1.2. "Contributor Version" + + means the combination of the Contributions of others (if any) used by a + Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + + means Source Code Form to which the initial Contributor has attached the + notice in Exhibit A, the Executable Form of such Source Code Form, and + Modifications of such Source Code Form, in each case including portions + thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + a. that the initial Contributor has attached the notice described in + Exhibit B to the Covered Software; or + + b. that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the terms of + a Secondary License. + +1.6. "Executable Form" + + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + + means a work that combines Covered Software with other material, in a + separate file or files, that is not Covered Software. + +1.8. "License" + + means this document. + +1.9. "Licensable" + + means having the right to grant, to the maximum extent possible, whether + at the time of the initial grant or subsequently, any and all of the + rights conveyed by this License. + +1.10. "Modifications" + + means any of the following: + + a. any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered Software; or + + b. any new file in Source Code Form that contains any Covered Software. + +1.11. "Patent Claims" of a Contributor + + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the License, + by the making, using, selling, offering for sale, having made, import, + or transfer of either its Contributions or its Contributor Version. + +1.12. "Secondary License" + + means either the GNU General Public License, Version 2.0, the GNU Lesser + General Public License, Version 2.1, the GNU Affero General Public + License, Version 3.0, or any later versions of those licenses. + +1.13. "Source Code Form" + + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that controls, is + controlled by, or is under common control with You. For purposes of this + definition, "control" means (a) the power, direct or indirect, to cause + the direction or management of such entity, whether by contract or + otherwise, or (b) ownership of more than fifty percent (50%) of the + outstanding shares or beneficial ownership of such entity. + + +2. License Grants and Conditions + +2.1. Grants + + Each Contributor hereby grants You a world-wide, royalty-free, + non-exclusive license: + + a. under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + + b. under Patent Claims of such Contributor to make, use, sell, offer for + sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + + The licenses granted in Section 2.1 with respect to any Contribution + become effective for each Contribution on the date the Contributor first + distributes such Contribution. + +2.3. Limitations on Grant Scope + + The licenses granted in this Section 2 are the only rights granted under + this License. No additional rights or licenses will be implied from the + distribution or licensing of Covered Software under this License. + Notwithstanding Section 2.1(b) above, no patent license is granted by a + Contributor: + + a. for any code that a Contributor has removed from Covered Software; or + + b. for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + + c. under Patent Claims infringed by Covered Software in the absence of + its Contributions. + + This License does not grant any rights in the trademarks, service marks, + or logos of any Contributor (except as may be necessary to comply with + the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + + No Contributor makes additional grants as a result of Your choice to + distribute the Covered Software under a subsequent version of this + License (see Section 10.2) or under the terms of a Secondary License (if + permitted under the terms of Section 3.3). + +2.5. Representation + + Each Contributor represents that the Contributor believes its + Contributions are its original creation(s) or it has sufficient rights to + grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + + This License is not intended to limit any rights You have under + applicable copyright doctrines of fair use, fair dealing, or other + equivalents. + +2.7. Conditions + + Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in + Section 2.1. + + +3. Responsibilities + +3.1. Distribution of Source Form + + All distribution of Covered Software in Source Code Form, including any + Modifications that You create or to which You contribute, must be under + the terms of this License. You must inform recipients that the Source + Code Form of the Covered Software is governed by the terms of this + License, and how they can obtain a copy of this License. You may not + attempt to alter or restrict the recipients' rights in the Source Code + Form. + +3.2. Distribution of Executable Form + + If You distribute Covered Software in Executable Form then: + + a. such Covered Software must also be made available in Source Code Form, + as described in Section 3.1, and You must inform recipients of the + Executable Form how they can obtain a copy of such Source Code Form by + reasonable means in a timely manner, at a charge no more than the cost + of distribution to the recipient; and + + b. You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter the + recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + + You may create and distribute a Larger Work under terms of Your choice, + provided that You also comply with the requirements of this License for + the Covered Software. If the Larger Work is a combination of Covered + Software with a work governed by one or more Secondary Licenses, and the + Covered Software is not Incompatible With Secondary Licenses, this + License permits You to additionally distribute such Covered Software + under the terms of such Secondary License(s), so that the recipient of + the Larger Work may, at their option, further distribute the Covered + Software under the terms of either this License or such Secondary + License(s). + +3.4. Notices + + You may not remove or alter the substance of any license notices + (including copyright notices, patent notices, disclaimers of warranty, or + limitations of liability) contained within the Source Code Form of the + Covered Software, except that You may alter any license notices to the + extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + + You may choose to offer, and to charge a fee for, warranty, support, + indemnity or liability obligations to one or more recipients of Covered + Software. However, You may do so only on Your own behalf, and not on + behalf of any Contributor. You must make it absolutely clear that any + such warranty, support, indemnity, or liability obligation is offered by + You alone, and You hereby agree to indemnify every Contributor for any + liability incurred by such Contributor as a result of warranty, support, + indemnity or liability terms You offer. You may include additional + disclaimers of warranty and limitations of liability specific to any + jurisdiction. + +4. Inability to Comply Due to Statute or Regulation + + If it is impossible for You to comply with any of the terms of this License + with respect to some or all of the Covered Software due to statute, + judicial order, or regulation then You must: (a) comply with the terms of + this License to the maximum extent possible; and (b) describe the + limitations and the code they affect. Such description must be placed in a + text file included with all distributions of the Covered Software under + this License. Except to the extent prohibited by statute or regulation, + such description must be sufficiently detailed for a recipient of ordinary + skill to be able to understand it. + +5. Termination + +5.1. The rights granted under this License will terminate automatically if You + fail to comply with any of its terms. However, if You become compliant, + then the rights granted under this License from a particular Contributor + are reinstated (a) provisionally, unless and until such Contributor + explicitly and finally terminates Your grants, and (b) on an ongoing + basis, if such Contributor fails to notify You of the non-compliance by + some reasonable means prior to 60 days after You have come back into + compliance. Moreover, Your grants from a particular Contributor are + reinstated on an ongoing basis if such Contributor notifies You of the + non-compliance by some reasonable means, this is the first time You have + received notice of non-compliance with this License from such + Contributor, and You become compliant prior to 30 days after Your receipt + of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent + infringement claim (excluding declaratory judgment actions, + counter-claims, and cross-claims) alleging that a Contributor Version + directly or indirectly infringes any patent, then the rights granted to + You by any and all Contributors for the Covered Software under Section + 2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user + license agreements (excluding distributors and resellers) which have been + validly granted by You or Your distributors under this License prior to + termination shall survive termination. + +6. Disclaimer of Warranty + + Covered Software is provided under this License on an "as is" basis, + without warranty of any kind, either expressed, implied, or statutory, + including, without limitation, warranties that the Covered Software is free + of defects, merchantable, fit for a particular purpose or non-infringing. + The entire risk as to the quality and performance of the Covered Software + is with You. Should any Covered Software prove defective in any respect, + You (not any Contributor) assume the cost of any necessary servicing, + repair, or correction. This disclaimer of warranty constitutes an essential + part of this License. No use of any Covered Software is authorized under + this License except under this disclaimer. + +7. Limitation of Liability + + Under no circumstances and under no legal theory, whether tort (including + negligence), contract, or otherwise, shall any Contributor, or anyone who + distributes Covered Software as permitted above, be liable to You for any + direct, indirect, special, incidental, or consequential damages of any + character including, without limitation, damages for lost profits, loss of + goodwill, work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses, even if such party shall have been + informed of the possibility of such damages. This limitation of liability + shall not apply to liability for death or personal injury resulting from + such party's negligence to the extent applicable law prohibits such + limitation. Some jurisdictions do not allow the exclusion or limitation of + incidental or consequential damages, so this exclusion and limitation may + not apply to You. + +8. Litigation + + Any litigation relating to this License may be brought only in the courts + of a jurisdiction where the defendant maintains its principal place of + business and such litigation shall be governed by laws of that + jurisdiction, without reference to its conflict-of-law provisions. Nothing + in this Section shall prevent a party's ability to bring cross-claims or + counter-claims. + +9. Miscellaneous + + This License represents the complete agreement concerning the subject + matter hereof. If any provision of this License is held to be + unenforceable, such provision shall be reformed only to the extent + necessary to make it enforceable. Any law or regulation which provides that + the language of a contract shall be construed against the drafter shall not + be used to construe this License against a Contributor. + + +10. Versions of the License + +10.1. New Versions + + Mozilla Foundation is the license steward. Except as provided in Section + 10.3, no one other than the license steward has the right to modify or + publish new versions of this License. Each version will be given a + distinguishing version number. + +10.2. Effect of New Versions + + You may distribute the Covered Software under the terms of the version + of the License under which You originally received the Covered Software, + or under the terms of any subsequent version published by the license + steward. + +10.3. Modified Versions + + If you create software not governed by this License, and you want to + create a new license for such software, you may create and use a + modified version of this License if you rename the license and remove + any references to the name of the license steward (except to note that + such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary + Licenses If You choose to distribute Source Code Form that is + Incompatible With Secondary Licenses under the terms of this version of + the License, the notice described in Exhibit B of this License must be + attached. + +Exhibit A - Source Code Form License Notice + + This Source Code Form is subject to the + terms of the Mozilla Public License, v. + 2.0. If a copy of the MPL was not + distributed with this file, You can + obtain one at + http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular file, +then You may include the notice in a location (such as a LICENSE file in a +relevant directory) where a recipient would be likely to look for such a +notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice + + This Source Code Form is "Incompatible + With Secondary Licenses", as defined by + the Mozilla Public License, v. 2.0. + diff --git a/internal/jsonfeed/README.md b/internal/jsonfeed/README.md new file mode 100644 index 0000000..27f7cb5 --- /dev/null +++ b/internal/jsonfeed/README.md @@ -0,0 +1,8 @@ +# JSONFeed - Go Package to parse JSON Feed streams + +[![Build Status](https://travis-ci.org/st3fan/jsonfeed.svg?branch=master)](https://travis-ci.org/st3fan/jsonfeed) [![Go Report Card](https://goreportcard.com/badge/github.com/st3fan/jsonfeed)](https://goreportcard.com/report/github.com/st3fan/jsonfeed) [![codecov](https://codecov.io/gh/st3fan/jsonfeed/branch/master/graph/badge.svg)](https://codecov.io/gh/st3fan/jsonfeed) + + +*Stefan Arentz, May 2017* + +Work in progress. Minimal package to parse JSON Feed streams. Please file feature requests. diff --git a/internal/jsonfeed/jsonfeed.go b/internal/jsonfeed/jsonfeed.go new file mode 100644 index 0000000..913880d --- /dev/null +++ b/internal/jsonfeed/jsonfeed.go @@ -0,0 +1,73 @@ +// This Source Code Form is subject to the terms of the Mozilla Public +// License, v. 2.0. If a copy of the MPL was not distributed with this +// file, You can obtain one at http://mozilla.org/MPL/2.0/ + +package jsonfeed + +import ( + "encoding/json" + "io" + "time" +) + +const CurrentVersion = "https://jsonfeed.org/version/1" + +type Item struct { + ID string `json:"id"` + URL string `json:"url"` + ExternalURL string `json:"external_url"` + Title string `json:"title"` + ContentHTML string `json:"content_html"` + ContentText string `json:"content_text"` + Summary string `json:"summary"` + Image string `json:"image"` + BannerImage string `json:"banner_image"` + DatePublished time.Time `json:"date_published"` + DateModified time.Time `json:"date_modified"` + Author Author `json:"author"` + Tags []string `json:"tags"` +} + +type Author struct { + Name string `json:"name"` + URL string `json:"url"` + Avatar string `json:"avatar"` +} + +type Hub struct { + Type string `json:"type"` + URL string `json:"url"` +} + +type Attachment struct { + URL string `json:"url"` + MIMEType string `json:"mime_type"` + Title string `json:"title"` + SizeInBytes int64 `json:"size_in_bytes"` + DurationInSeconds int64 `json:"duration_in_seconds"` +} + +type Feed struct { + Version string `json:"version"` + Title string `json:"title"` + HomePageURL string `json:"home_page_url"` + FeedURL string `json:"feed_url"` + Description string `json:"description"` + UserComment string `json:"user_comment"` + NextURL string `json:"next_url"` + Icon string `json:"icon"` + Favicon string `json:"favicon"` + Author Author `json:"author"` + Expired bool `json:"expired"` + Hubs []Hub `json:"hubs"` + Items []Item `json:"items"` +} + +func Parse(r io.Reader) (Feed, error) { + var feed Feed + decoder := json.NewDecoder(r) + if err := decoder.Decode(&feed); err != nil { + return Feed{}, err + } + return feed, nil +} diff --git a/internal/jsonfeed/jsonfeed_test.go b/internal/jsonfeed/jsonfeed_test.go new file mode 100644 index 0000000..da8cb04 --- /dev/null +++ b/internal/jsonfeed/jsonfeed_test.go @@ -0,0 +1,43 @@ +// This Source Code Form is subject to the terms of the Mozilla Public +// License, v. 2.0. If a copy of the MPL was not distributed with this +// file, You can obtain one at http://mozilla.org/MPL/2.0/ + +package jsonfeed_test + +import ( + "os" + "testing" + "time" + + "christine.website/internal/jsonfeed" + "github.com/stretchr/testify/assert" +) + +func Test_ParseSimple(t *testing.T) { + r, err := os.Open("testdata/feed.json") + assert.NoError(t, err, "Could not open testdata/feed.json") + + feed, err := jsonfeed.Parse(r) + assert.NoError(t, err, "Could not parse testdata/feed.json") + + assert.Equal(t, "https://jsonfeed.org/version/1", feed.Version) + assert.Equal(t, "JSON Feed", feed.Title) + assert.Equal(t, "JSON Feed is a ...", feed.Description) + assert.Equal(t, "https://jsonfeed.org/", feed.HomePageURL) + assert.Equal(t, "https://jsonfeed.org/feed.json", feed.FeedURL) + assert.Equal(t, "This feed allows ...", feed.UserComment) + assert.Equal(t, "https://jsonfeed.org/graphics/icon.png", feed.Favicon) + assert.Equal(t, "Brent Simmons and Manton Reece", feed.Author.Name) + + assert.Equal(t, 1, len(feed.Items)) + + assert.Equal(t, "https://jsonfeed.org/2017/05/17/announcing_json_feed", feed.Items[0].ID) + assert.Equal(t, "https://jsonfeed.org/2017/05/17/announcing_json_feed", feed.Items[0].URL) + assert.Equal(t, "Announcing JSON Feed", feed.Items[0].Title) + assert.Equal(t, "

We ...", feed.Items[0].ContentHTML) + + datePublished, err := time.Parse("2006-01-02T15:04:05-07:00", "2017-05-17T08:02:12-07:00") + assert.NoError(t, err, "Could not parse timestamp") + + assert.Equal(t, datePublished, feed.Items[0].DatePublished) +} diff --git a/internal/jsonfeed/testdata/feed.json b/internal/jsonfeed/testdata/feed.json new file mode 100644 index 0000000..ad4bbe1 --- /dev/null +++ b/internal/jsonfeed/testdata/feed.json @@ -0,0 +1,21 @@ +{ + "version": "https://jsonfeed.org/version/1", + "title": "JSON Feed", + "description": "JSON Feed is a ...", + "home_page_url": "https://jsonfeed.org/", + "feed_url": "https://jsonfeed.org/feed.json", + "user_comment": "This feed allows ...", + "favicon": "https://jsonfeed.org/graphics/icon.png", + "author": { + "name": "Brent Simmons and Manton Reece" + }, + "items": [ + { + "id": "https://jsonfeed.org/2017/05/17/announcing_json_feed", + "url": "https://jsonfeed.org/2017/05/17/announcing_json_feed", + "title": "Announcing JSON Feed", + "content_html": "

We ...", + "date_published": "2017-05-17T08:02:12-07:00" + } + ] +}