Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/circa10a/go-aws-news
Go app + library to fetch what's new from AWS
https://github.com/circa10a/go-aws-news
aws aws-news go go-library hacktoberfest notifications
Last synced: 13 days ago
JSON representation
Go app + library to fetch what's new from AWS
- Host: GitHub
- URL: https://github.com/circa10a/go-aws-news
- Owner: circa10a
- License: mit
- Created: 2020-01-08T00:59:39.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-06-21T00:06:03.000Z (5 months ago)
- Last Synced: 2024-10-09T17:41:49.860Z (about 1 month ago)
- Topics: aws, aws-news, go, go-library, hacktoberfest, notifications
- Language: Go
- Homepage: https://caleblemoine.dev/go-aws-news/
- Size: 260 KB
- Stars: 17
- Watchers: 4
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: news/announcements.go
- License: LICENSE
Awesome Lists containing this project
- awesome-go - go-aws-news - Go application and library to fetch what's new from AWS. (Third-party APIs / Utility/Miscellaneous)
- awesome-go-extra - go-aws-news - 01-08T00:59:39Z|2022-07-10T16:01:57Z| (Third-party APIs / Fail injection)
README
# go-aws-news
Fetch what's new from AWS and send out notifications on social sites.
[](https://pkg.go.dev/github.com/circa10a/go-aws-news/news?tab=doc)
[](https://goreportcard.com/report/github.com/circa10a/go-aws-news)
[](https://codecov.io/gh/circa10a/go-aws-news)
- [App Install](#app-install)
- [Notification Providers](#notification-providers)
- [Install Options](#install-options)
- [Install With Crontab](#install-with-crontab)
- [Install As Kubernetes CronJob](#install-as-kubernetes-cronjob)
- [Install As AWS Lambda](#install-as-aws-lambda)
- [Module Install](#module-install)
- [Module Usage](#module-usage)
- [Get Today's news](#get-todays-news)
- [Get Yesterday's news](#get-yesterdays-news)
- [Get all news for the month](#get-all-news-for-the-month)
- [Get from a previous month](#get-from-a-previous-month)
- [Get from a previous year](#get-from-a-previous-year)
- [Print out announcements](#print-out-announcements)
- [Loop over news data](#loop-over-news-data)
- [Limit news results count](#limit-news-results-count)
- [Get news as JSON](#get-news-as-json)
- [Get news as HTML](#get-news-as-html)
- [Get news about a specific product](#get-news-about-a-specific-product)
- [Google Assistant](#google-assistant)
- [Development](#development)
- [Test](#test)
## App Install
`go-aws-news` can be executed as an application that sends out notifications to social sites like
[Discord]. To configure providers, modify the [config.yaml](config.yaml) file to __enable__ a
provider.
`go-aws-news` is designed to be run on a schedule, once a day (displaying the previous day's AWS
News). See the [install options](#install-options) for examples on how to install and run.
### Notification Providers
Currently supported providers:
- [Discord](providers/discord/README.md)
- [Rocket.Chat](providers/rocketchat/README.md)
- [Slack](providers/slack/README.md)
- [SMTP (email)](providers/smtp/README.md)
- [Yammer](providers/yammer/README.md)
### Install Options
#### Install With Crontab
The simplest way to run `go-aws-news` is via [crontab](http://man7.org/linux/man-pages/man5/crontab.5.html).
Type `crontab -e` on Mac or Linux and add a line:
```shell
# Binary
0 2 * * * /path/to/go-aws-news-binary
# Docker
0 14 * * * docker run -d --rm --name aws-news \
-v your_config.yaml:/config.yaml \
circa10a/go-aws-news
```
>The above example will execute `go-aws-news` at `2PM UTC` (8AM CST) each day.
#### Install As Kubernetes CronJob
`go-aws-news` can be run as a [CronJob][k8s-cronjob] in a Kubernetes cluster.
Example `cronjob.yaml`:
```yaml
apiVersion: batch/v1beta1
kind: CronJob
metadata:
name: go-aws-news
spec:
schedule: "0 14 * * *"
jobTemplate:
spec:
template:
spec:
containers:
- name: go-aws-news
image: circa10a/go-aws-news
volumeMounts:
- name: config
mountPath: /config.yaml
subPath: config.yaml
volumes:
- name: config
configMap:
name: awsnews-config
restartPolicy: OnFailure
```
The [ConfigMap] can be created from the [config.yaml](/config.yaml) file itself:
```shell
kubectl create configmap awsnews-config --from-file=config.yaml
```
To apply the `cronjob.yaml` example above:
```shell
kubectl apply -f cronjob.yaml
```
#### Install As AWS Lambda
1. Setup provider config in AWS SSM Parameter Store:
```shell
aws ssm put-parameter --type SecureString --name go-aws-news-config --value "$(cat config.yaml)"
```
>**Note:** Overriding the name `go-aws-news-config` will require an environment variable on
the lambda function: `GO_AWS_NEWS_CONFIG_NAME`.
1. Create the Lambda execution role and add permissions:
```shell
aws iam create-role --role-name go-aws-news-lambda-ex --assume-role-policy-document '{"Version": "2012-10-17","Statement": [{ "Effect": "Allow", "Principal": {"Service": "lambda.amazonaws.com"}, "Action": "sts:AssumeRole"}]}'
aws iam attach-role-policy --role-name go-aws-news-lambda-ex --policy-arn arn:aws:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole
aws iam attach-role-policy --role-name go-aws-news-lambda-ex --policy-arn arn:aws:iam::aws:policy/AmazonSSMReadOnlyAccess
```
1. Create the lambda function:
```shell
make lambda-package
aws lambda create-function --function-name go-aws-news --zip-file fileb://bin/lambda.zip --runtime go1.x --handler awsnews \
--role $(aws iam get-role --role-name go-aws-news-lambda-ex --query Role.Arn --output text)
```
1. Create a schedule for the lambda:
```shell
aws events put-rule --schedule-expression "cron(0 14 * * ? *)" --name go-aws-news-cron
LAMBDA_ARN=$(aws lambda get-function --function-name go-aws-news --query Configuration.FunctionArn)
aws events put-targets --rule go-aws-news-cron --targets "Id"="1","Arn"=$LAMBDA_ARN
```
1. Allow the lambda function to be invoked by the schedule rule:
```shell
EVENT_ARN=$(aws events describe-rule --name go-aws-news-cron --query Arn --output text)
aws lambda add-permission --function-name go-aws-news --statement-id eventbridge-cron \
--action 'lambda:InvokeFunction' --principal events.amazonaws.com --source-arn $EVENT_ARN
```
## Module Install
`go-aws-news` can be installed as a module for use in other Go applications:
```shell
go get -u "github.com/circa10a/go-aws-news/news"
```
## Module Usage
Methods return a slice of structs which include the announcement title, a link, and the date it was posted as well an error. This allows you to manipulate the data in whichever way you please, or simply use `Print()` to print a nice ASCII table to the console.
### Get Today's news
```go
package main
import (
awsnews "github.com/circa10a/go-aws-news/news"
)
func main() {
news, err := awsnews.Today()
if err != nil {
// Handle error
}
news.Print()
}
```
### Get Yesterday's news
```go
news, _ := awsnews.Yesterday()
```
### Get all news for the month
```go
news, _ := awsnews.ThisMonth()
```
### Get from a previous month
```go
// Custom timeframe(June 2019)
news, err := awsnews.Fetch(2019, 06)
```
### Get from a previous year
```go
// Custom timeframe(2017)
news, err := awsnews.FetchYear(2017)
```
### Print out announcements
```go
news, _ := awsnews.ThisMonth()
news.Print()
// Console output
// +--------------------------------+--------------+
// | ANNOUNCEMENT | DATE |
// +--------------------------------+--------------+
// | Amazon Cognito now supports | Jan 10, 2020 |
// | CloudWatch Usage Metrics | |
// +--------------------------------+--------------+
// | Introducing Workload Shares in | Jan 10, 2020 |
// | AWS Well-Architected Tool | |
// +--------------------------------+--------------+
//
```
### Loop over news data
```go
// Loop slice of stucts of announcements
// For your own data manipulation
news, _ := awsnews.Fetch(time.Now().Year(), int(time.Now().Month()))
for _, v := range news {
fmt.Printf("Title: %v\n", v.Title)
fmt.Printf("Link: %v\n", v.Link)
fmt.Printf("Date: %v\n", v.PostDate)
}
```
### Limit news results count
```go
news, _ := awsnews.ThisMonth()
// Last 10 news items of the month
news.Last(10).Print()
```
### Get news as JSON
```go
news, _ := awsnews.ThisMonth()
json, jsonErr := news.JSON()
if jsonErr != nil {
log.Fatal(err)
}
fmt.Println(string(json))
```
### Get news as HTML
```go
news, _ := awsnews.ThisMonth()
html := news.HTML()
fmt.Println(html)
```
### Get news about a specific product
```go
news, err := awsnews.Fetch(2019, 12)
if err != nil {
fmt.Println(err)
} else {
news.Filter([]string{"EKS", "ECS"}).Print()
}
```
## Google Assistant
* [Source Code](https://github.com/circa10a/google-home-aws-news)
## Development
### Test
```shell
# Unit/Integration tests
make
# Get code coverage
make coverage
```
[discord]:https://discordapp.com/
[k8s-cronjob]:https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/
[configmap]:https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/