Initial commit.

FelicianoTech · FelicianoTech · commit cfcb0f8529f4 · 2020-12-19T01:18:32.000-05:00
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -0,0 +1,49 @@
+version: 2.1
+
+orbs:
+  gor: hubci/goreleaser@1.0
+  osd: circleci/os-detect@0.3.0
+
+workflows:
+  main:
+    jobs:
+      - test
+  release:
+    jobs:
+      - test:
+          filters:
+            branches:
+              ignore: /.*/
+            tags:
+              # Simplified SemVer regex
+              only: /^v\d+\.\d+\.\d+$/
+      - gor/release:
+          version: "0.149.0"
+          go-version: "1.15.6"
+          filters:
+            branches:
+              ignore: /.*/
+            tags:
+              # Simplified SemVer regex
+              only: /^v\d+\.\d+\.\d+$/
+          context: main
+
+jobs:
+  test:
+    docker:
+      - image: cimg/go:1.15.6
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - go-mod-v1
+      - run:
+          name: "Download Dependancies"
+          command: cd jsonfeed && go mod download
+      - run:
+          name: "Run Tests"
+          command: cd jsonfeed && go test ./...
+      - save_cache:
+          key: go-mod-v1
+          paths:
+            - "/go/pkg/mod"
diff --git a/.goreleaser.yml b/.goreleaser.yml
@@ -0,0 +1,4 @@
+project_name: jfeed
+
+builds:
+  - skip: true
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright ©2020 Ricardo N Feliciano <Ricardo@Feliciano.Tech>
+
+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.
diff --git a/README.md b/README.md
@@ -0,0 +1,32 @@
+# JSON Feed Go Library [![CI Status](https://circleci.com/gh/gopherlibs/jsonfeed.svg?style=shield)](https://app.circleci.com/pipelines/github/gopherlibs/jsonfeed) [![Software License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/gopherlibs/jsonfeed/master/LICENSE)
+
+This is a library to parse and validate a JSON Feed.
+JSON Feed is a modern alternative to RSS and Atom.
+I'd recommend learning more about it at the [official website][jfeed] if you're unfamiliar.
+
+**Note: This package is pre-1.0 thus the API is still changing as I prepare it for a v1.0 release.**
+
+
+## Usage
+
+Instructions coming soon.
+For now, just look at the code.
+
+
+## Development
+
+This library is written and tested with Go v1.15+ in mind.
+`go fmt` is your friend.
+Please feel free to open Issues and PRs as you see fit.
+Any PR that requires a good amount of work or is a significant change, it would be best to open an Issue to discuss the change first.
+
+
+## License & Credits
+
+This module was written by Ricardo N Feliciano (FelicianoTech).
+This repository is licensed under the MIT license.
+This repo's license can be found [here](./LICENSE).
+
+
+
+[jfeed]: https://www.jsonfeed.org/
diff --git a/go.mod b/go.mod
@@ -0,0 +1,12 @@
+module github.com/gopherlibs/jsonfeed
+
+go 1.15
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/kr/pretty v0.1.0 // indirect
+	github.com/magefile/mage v1.10.0
+	github.com/stretchr/testify v1.4.0
+	gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 // indirect
+	gopkg.in/yaml.v2 v2.2.8 // indirect
+)
diff --git a/go.sum b/go.sum
@@ -0,0 +1,22 @@
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI=
+github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
+github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
+github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
+github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
+github.com/magefile/mage v1.10.0 h1:3HiXzCUY12kh9bIuyXShaVe529fJfyqoVM42o/uom2g=
+github.com/magefile/mage v1.10.0/go.mod h1:z5UZb/iS3GoOSn0JgWuiw7dxlurVYTu+/jHXqQg881A=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.4.0 h1:2E4SXV/wtOkTonXsotYi4li6zVWxYlZuYNCXe9XRJyk=
+github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
+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.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw=
+gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v2 v2.2.8 h1:obN1ZagJSUGI0Ek/LBmuj4SNLPfIny3KsKFopxRdj10=
+gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
diff --git a/jsonfeed/attachment.go b/jsonfeed/attachment.go
@@ -0,0 +1,9 @@
+package jsonfeed
+
+type Attachment struct {
+	URL               string `json:"url"`
+	MIMEType          string `json:"mime_type"`
+	Title             string `json:"title"`
+	SizeInBytes       uint   `json:"size_in_bytes"`
+	DurationInSeconds uint   `json:"duration_in_seconds"`
+}
diff --git a/jsonfeed/author.go b/jsonfeed/author.go
@@ -0,0 +1,7 @@
+package jsonfeed
+
+type Author struct {
+	Name   string `json:"name"`
+	URL    string `json:"url"`
+	Avatar string `json:"avatar"`
+}
diff --git a/jsonfeed/feed.go b/jsonfeed/feed.go
@@ -0,0 +1,34 @@
+package jsonfeed
+
+import "errors"
+
+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"`
+	Authors     []Author     `json:"authors"`
+	Language    string       `json:"language"`
+	Expired     bool         `json:"expired"`
+	Hubs        []Hub        `json:"hubs"`
+	Items       []Item       `json:"items"`
+	Attachments []Attachment `json:"attachments"`
+}
+
+func (this *Feed) Validate() []error {
+
+	var valErrors []error
+
+	if this.Version != "https://jsonfeed.org/version/1.1" {
+		valErrors = append(valErrors, errors.New("Invalid version."))
+
+		return valErrors
+	}
+
+	return valErrors
+}
diff --git a/jsonfeed/hub.go b/jsonfeed/hub.go
@@ -0,0 +1,6 @@
+package jsonfeed
+
+type Hub struct {
+	Type string `json:"type"`
+	URL  string `json:type"`
+}
diff --git a/jsonfeed/item.go b/jsonfeed/item.go
@@ -0,0 +1,18 @@
+package jsonfeed
+
+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 string   `json:"date_published"`
+	DateModified  string   `json:"date_modified"`
+	Authors       []Author `json:"authors"`
+	Tags          []string `json:"tags"`
+	Language      string   `json:"language"`
+}
diff --git a/jsonfeed/jsonfeed.go b/jsonfeed/jsonfeed.go
@@ -0,0 +1,19 @@
+package jsonfeed
+
+import (
+	"encoding/json"
+	"io"
+)
+
+func Parse(feed io.Reader) (*Feed, error) {
+
+	jFeed := &Feed{}
+
+	decoder := json.NewDecoder(feed)
+
+	if err := decoder.Decode(jFeed); err != nil {
+		return nil, err
+	}
+
+	return jFeed, nil
+}
diff --git a/jsonfeed/jsonfeed_test.go b/jsonfeed/jsonfeed_test.go
@@ -0,0 +1,33 @@
+package jsonfeed
+
+import (
+	"os"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestParse(t *testing.T) {
+
+	file, _ := os.Open("../testdata/test-feed-1.json")
+
+	feed, err := Parse(file)
+	if err != nil {
+		println("Failed to parse feed.")
+	}
+
+	assert.Equal(t, "https://jsonfeed.org/version/1.1", feed.Version)
+	assert.Equal(t, "Brent Simmons’s Microblog", feed.Title)
+	assert.Equal(t, "Brent Simmons", feed.Authors[0].Name)
+
+	file, _ = os.Open("../testdata/test-feed-2.json")
+
+	feed, err = Parse(file)
+	if err != nil {
+		println("Failed to parse feed.")
+	}
+
+	assert.Equal(t, "https://jsonfeed.com/version/1.1", feed.Version)
+	assert.Equal(t, "Brent Simmons’s Microblog", feed.Title)
+	assert.Equal(t, "Brent Simmons", feed.Authors[0].Name)
+}
diff --git a/jsonfeed/magefile.go b/jsonfeed/magefile.go
@@ -0,0 +1,21 @@
+//+build mage
+
+package main
+
+import (
+	"github.com/magefile/mage/sh"
+)
+
+func Install() error {
+
+	if err := sh.Run("go", "mod", "download"); err != nil {
+		return err
+	}
+
+	return sh.Run("go", "install", "./...")
+}
+
+func Remove() error {
+
+	return sh.Run("go", "clean", "-i", "github.com/gopherlibs/jsonfeed")
+}
diff --git a/testdata/test-feed-1.json b/testdata/test-feed-1.json
@@ -0,0 +1,22 @@
+{
+    "version": "https://jsonfeed.org/version/1.1",
+    "user_comment": "This is a microblog feed. You can add this to your feed reader using the following URL: https://example.org/feed.json",
+    "title": "Brent Simmons’s Microblog",
+    "home_page_url": "https://example.org/",
+    "feed_url": "https://example.org/feed.json",
+    "authors": [
+        {
+            "name": "Brent Simmons",
+            "url": "http://example.org/",
+            "avatar": "https://example.org/avatar.png"
+        }
+    ],
+    "items": [
+        {
+            "id": "2347259",
+            "url": "https://example.org/2347259",
+            "content_text": "Cats are neat. \n\nhttps://example.org/cats",
+            "date_published": "2016-02-09T14:22:00-07:00"
+        }
+    ]
+}
diff --git a/testdata/test-feed-2.json b/testdata/test-feed-2.json
@@ -0,0 +1,22 @@
+{
+    "version": "https://jsonfeed.com/version/1.1",
+    "user_comment": "This is a microblog feed. You can add this to your feed reader using the following URL: https://example.org/feed.json",
+    "title": "Brent Simmons’s Microblog",
+    "home_page_url": "https://example.org/",
+    "feed_url": "https://example.org/feed.json",
+    "authors": [
+        {
+            "name": "Brent Simmons",
+            "url": "http://example.org/",
+            "avatar": "https://example.org/avatar.png"
+        }
+    ],
+    "items": [
+        {
+            "id": "2347259",
+            "url": "https://example.org/2347259",
+            "content_text": "Cats are neat. \n\nhttps://example.org/cats",
+            "date_published": "2016-02-09T14:22:00-07:00"
+        }
+    ]
+}
diff --git a/testdata/test-feed-3.json b/testdata/test-feed-3.json
@@ -0,0 +1,22 @@
+{
+    "version": "https://jsonfeed.org/version/1.1",
+    "user_comment": "This is a microblog feed. You can add this to your feed reader using the following URL: https://example.org/feed.json",
+    "title": "Brent Simmons’s Microblog",
+    "hooome_page_url": "https://example.org/",
+    "feed_url": "https://example.org/feed.json",
+    "authors": [
+        {
+            "name": "Brent Simmons",
+            "url": "http://example.org/",
+            "avatar": "https://example.org/avatar.png"
+        }
+    ],
+    "items": [
+        {
+            "id": "2347259",
+            "url": "https://example.org/2347259",
+            "content_text": "Cats are neat. \n\nhttps://example.org/cats",
+            "date_published": "2016-02-09T14:22:00-07:00"
+        }
+    ]
+}

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +project_name: jfeed
++
 +builds:
 +  - skip: true