Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/p1ass/feeder
📮 RSS, Atom, and JSON feed generator from multiple RSS, Atom, and any entries you want.
https://github.com/p1ass/feeder
Last synced: 3 months ago
JSON representation
📮 RSS, Atom, and JSON feed generator from multiple RSS, Atom, and any entries you want.
- Host: GitHub
- URL: https://github.com/p1ass/feeder
- Owner: p1ass
- License: bsd-2-clause
- Created: 2019-03-21T14:17:02.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-05T01:57:39.000Z (over 1 year ago)
- Last Synced: 2024-02-17T09:36:55.599Z (9 months ago)
- Language: Go
- Homepage:
- Size: 202 KB
- Stars: 33
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
`feeder` is the RSS, Atom and JSON feed generator from multiple RSS, Atom, and any entries you want.
## Getting started
### Install
```bash
go get -u github.com/p1ass/feeder
```
### Examples
```go
package main
import (
"github.com/p1ass/feeder"
"time"
)
func crawl(){
rss1 := feeder.NewRSSCrawler("https://example.com/rss1")
rss2 := feeder.NewRSSCrawler("https://example.com/rss2")
items, err := feeder.Crawl(rss1, rss2)
feed := &feeder.Feed{
Title: "My feeds",
Link: &feeder.Link{Href: "https://example.com/feed"},
Description: "My feeds.",
Author: &feeder.Author{
Name: "p1ass",
Email: "[email protected]"},
Created: time.Now(),
Items: items,
}
json, err := feed.ToJSON() // json is string
rss, err := feed.ToRSS() // rss is string
atom, err := feed.ToAtom() // atom is string
jsonReader, err := feed.ToJSONReader() // jsonReader is a io.Reader
rssReader, err := feed.ToRSSReader() // jsonReader is a io.Reader
atomReader, err := feed.ToAtomReader() // jsonReader is a io.Reader
}
```
## Advanced usages
### Implement original `Crawler`
You can create a original crawler by implementing `feeder.Crawler`.
```go
type Crawler interface {
Crawl() ([]*Item, error)
}
```
This is an example of Qiita API(`GET /api/v2/users/:user_id/items`).
[Qiita API v2 documentation - Qiita:Developer](https://qiita.com/api/v2/docs)
```go
type qiitaResponse struct {
CreatedAt *time.Time `json:"created_at"`
Title string `json:"title"`
URL string `json:"url"`
Body string `json:"body"`
ID string `json:"id"`
User *qiitaUser `json:"user"`
}
type qiitaUser struct {
ID string `json:"id"`
}
type qiitaCrawler struct {
URL string
}
func (crawler *qiitaCrawler) Fetch() ([]*feeder.Item, error) {
resp, err := http.Get(crawler.URL)
if err != nil {
return nil, errors.Wrap(err, "failed to get response from qiita.")
}
var qiita []*qiitaResponse
err = json.NewDecoder(resp.Body).Decode(&qiita)
if err != nil {
return nil, errors.Wrap(err, "failed to decode response body.")
}
items := []*feeder.Item{}
for _, i := range qiita {
items = append(items, convertQiitaToItem(i))
}
return items, nil
}
func convertQiitaToItem(q *qiitaResponse) *feeder.Item {
i := &feeder.Item{
Title: q.Title,
Link: &feeder.Link{Href: q.URL},
Created: q.CreatedAt,
Id: q.ID,
Description: q.Body,
}
if q.User != nil {
i.Author = &feeder.Author{
Name: q.User.ID,
}
}
return i
}
```