Merge pull request #38 from circa10a/fix-news-year-parsing

Fix news year parsing

Author: nickshine

Makefile

@@ -2,7 +2,7 @@ GOCMD=go
 BINARY=awsnews
 BUILD_FLAGS=-ldflags="-s -w"
 PROJECT=circa10a/go-aws-news
-VERSION=0.3.2
+VERSION=0.4.0
 
 # First target for travis ci
 test:

README.md

@@ -20,9 +20,11 @@ Fetch what's new from AWS and send out notifications on social sites.
       - [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)
-      - [Gets from a previous month](#gets-from-a-previous-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)
@@ -150,13 +152,20 @@ news, _ := awsnews.Yesterday()
 news, _ := awsnews.ThisMonth()
 ```
 
-#### Gets from a previous month
+#### 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
@@ -188,6 +197,14 @@ for _, v := range news {
 }
 ```
 
+#### 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/announcements.go

@@ -39,42 +39,44 @@ func (n newsDoc) GetAnnouncements() (Announcements, error) {
 	return announcements, nil
 }
 
-// Fetch Fetches all of the announcements for the specified year/month that was input.
+// Fetch gets all of the announcements for the specified year/month that was input.
 func Fetch(year int, month int) (Announcements, error) {
-	doc, err := getNewsDoc(year, month)
+	doc, err := getNewsDocMonth(year, month)
 	if err != nil {
 		return Announcements{}, err
 	}
 	return newsDoc{doc}.GetAnnouncements()
 }
 
-// Extract date from amazon's format
-// Input: Posted on: Jan 7, 2020
-// Output: Jan 7, 2020
-// parseDate Extracts a standarized date format from the AWS html document.
-func parseDate(postDate string) string {
-	r, _ := regexp.Compile("[A-Z][a-z]{2}\\s[0-9]{1,2},\\s[0-9]{4}")
-	// AWS sometimes doesn't have a post date
-	if len(r.FindStringSubmatch(postDate)) > 0 {
-		return r.FindStringSubmatch(postDate)[0]
+// FetchYear gets all of the announcements for the specified year that was input.
+func FetchYear(year int) (Announcements, error) {
+	doc, err := getNewsDocYear(year)
+	if err != nil {
+		return Announcements{}, err
 	}
-	return "No posted date"
+	return newsDoc{doc}.GetAnnouncements()
 }
 
 // ThisMonth gets the current month's AWS announcements.
 func ThisMonth() (Announcements, error) {
+	var thisMonthsAnnouncements Announcements
 	currentTime := time.Now()
-	news, err := Fetch(currentTime.Year(), int(currentTime.Month()))
+	news, err := FetchYear(currentTime.Year())
+	for _, announcement := range news {
+		if announcement.PostDate[:3] == currentTime.Month().String()[:3] {
+			thisMonthsAnnouncements = append(thisMonthsAnnouncements, announcement)
+		}
+	}
 	if err != nil {
 		return news, err
 	}
-	return news, nil
+	return thisMonthsAnnouncements, nil
 }
 
 // Today gets today's AWS announcements.
 func Today() (Announcements, error) {
 	var todaysAnnouncements Announcements
-	news, err := ThisMonth()
+	news, err := FetchYear(time.Now().Year())
 	if err != nil {
 		return news, err
 	}
@@ -90,7 +92,7 @@ func Today() (Announcements, error) {
 // Yesterday gets yesterday's AWS announcments.
 func Yesterday() (Announcements, error) {
 	var yesterdaysAnnouncements Announcements
-	news, err := ThisMonth()
+	news, err := FetchYear(time.Now().Year())
 	if err != nil {
 		return news, err
 	}
@@ -103,6 +105,19 @@ func Yesterday() (Announcements, error) {
 	return yesterdaysAnnouncements, nil
 }
 
+// Extract date from amazon's format
+// Input: Posted on: Jan 7, 2020
+// Output: Jan 7, 2020
+// parseDate Extracts a standarized date format from the AWS html document.
+func parseDate(postDate string) string {
+	r, _ := regexp.Compile("[A-Z][a-z]{2}\\s[0-9]{1,2},\\s[0-9]{4}")
+	// AWS sometimes doesn't have a post date
+	if len(r.FindStringSubmatch(postDate)) > 0 {
+		return r.FindStringSubmatch(postDate)[0]
+	}
+	return "No posted date"
+}
+
 // Print Prints out an ASCII table of your selection of AWS announcements.
 func (a Announcements) Print() {
 	data := [][]string{}
@@ -122,6 +137,14 @@ func (a Announcements) Print() {
 	table.Render()
 }
 
+// Last returns a set number of news items you specify
+func (a Announcements) Last(n int) Announcements {
+	if len(a) > n {
+		return a[:n]
+	}
+	return a
+}
+
 // JSON Converts Announcements to JSON.
 func (a Announcements) JSON() ([]byte, error) {
 	json, err := json.Marshal(a)

news/announcements_test.go

@@ -15,6 +15,13 @@ func TestFetch(t *testing.T) {
 	assert.Equal(t, len(news), 100)
 }
 
+// Integration test
+func TestFetchYear(t *testing.T) {
+	news, err := FetchYear(2020)
+	assert.NoError(t, err)
+	assert.Greater(t, len(news), 0)
+}
+
 func TestParseDate(t *testing.T) {
 	assert.Equal(t, "Jan 1, 2020", parseDate("Posted on: Jan 1, 2020"))
 }
@@ -53,22 +60,28 @@ func TestYesterday(t *testing.T) {
 	}
 }
 
+func TestLast(t *testing.T) {
+	news, err := newsDoc{monthTestDoc}.GetAnnouncements()
+	news = news.Last(5)
+	assert.NoError(t, err)
+	assert.Equal(t, len(news), 5)
+}
 func TestJSON(t *testing.T) {
-	news, err := newsDoc{testDoc}.GetAnnouncements()
+	news, err := newsDoc{monthTestDoc}.GetAnnouncements()
 	assert.NoError(t, err)
 	_, jsonErr := news.JSON()
 	assert.NoError(t, jsonErr)
 }
 
 func TestHTML(t *testing.T) {
-	news, err := newsDoc{testDoc}.GetAnnouncements()
+	news, err := newsDoc{monthTestDoc}.GetAnnouncements()
 	assert.NoError(t, err)
 	data := []byte(news.HTML())
 	assert.True(t, xml.Unmarshal(data, new(interface{})) == nil)
 }
 
 func TestFilter(t *testing.T) {
-	news, _ := newsDoc{testDoc}.GetAnnouncements()
+	news, _ := newsDoc{monthTestDoc}.GetAnnouncements()
 	filteredNews := news.Filter([]string{"EKS", "ECS"})
 	assert.Equal(t, len(filteredNews), 6)
 }

news/examples_test.go

@@ -10,6 +10,14 @@ func ExampleFetch() {
 	news.Print()
 }
 
+func ExampleFetchYear() {
+	news, err := FetchYear(2020)
+	if err != nil {
+		// Handle error
+	}
+	news.Print()
+}
+
 func ExampleThisMonth() {
 	news, err := ThisMonth()
 	if err != nil {
@@ -36,6 +44,15 @@ func ExampleYesterday() {
 	fmt.Println(news)
 }
 
+func (a Announcements) ExampleLast() {
+	news, err := ThisMonth()
+	if err != nil {
+		// Handle error
+	}
+	// Show last 10 news items of the month
+	news.Last(10).Print()
+}
+
 func (a Announcements) ExampleJSON() {
 	news, err := ThisMonth()
 	if err != nil {

news/newsdoc.go

@@ -6,8 +6,18 @@ import (
 	"github.com/PuerkitoBio/goquery"
 )
 
-// getNewsDoc Fetches html from AWS depending on the year/month specified.
-func getNewsDoc(year int, month int) (*goquery.Document, error) {
+// getNewsDocYear Fetches html from AWS depending on the year/month specified.
+func getNewsDocYear(year int) (*goquery.Document, error) {
+	url := fmt.Sprintf("https://aws.amazon.com/about-aws/whats-new/%d", year)
+	doc, err := goquery.NewDocument(url)
+	if err != nil {
+		return doc, err
+	}
+	return doc, nil
+}
+
+// getNewsDocMonth Fetches html from AWS depending on the year/month specified.
+func getNewsDocMonth(year int, month int) (*goquery.Document, error) {
 	url := fmt.Sprintf("https://aws.amazon.com/about-aws/whats-new/%v/%02d/", year, month)
 	doc, err := goquery.NewDocument(url)
 	if err != nil {

news/newsdoc_test.go

@@ -9,45 +9,66 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
-// Reusable html document
-var testDoc *goquery.Document
+// Reusable html documents
+var monthTestDoc *goquery.Document
+var yearTestDoc *goquery.Document
 
 func init() {
 	// create from a file
-	f, err := os.Open("./resources/aws-news-2019-12.html")
+	// Monthly Testing
+	monthFile, err := os.Open("./resources/aws-news-2019-12.html")
 	if err != nil {
 		log.Fatal(err)
 	}
-	defer f.Close()
-	doc, err := goquery.NewDocumentFromReader(f)
+	defer monthFile.Close()
+	monthDoc, err := goquery.NewDocumentFromReader(monthFile)
 	if err != nil {
 		log.Fatal(err)
 	}
-	testDoc = doc
+	monthTestDoc = monthDoc
+
+	// create from a file
+	// yearly Testing
+	yearFile, err := os.Open("./resources/aws-news-2020.html")
+	if err != nil {
+		log.Fatal(err)
+	}
+	defer yearFile.Close()
+	yearDoc, err := goquery.NewDocumentFromReader(yearFile)
+	if err != nil {
+		log.Fatal(err)
+	}
+	yearTestDoc = yearDoc
 }
 
 // Integration test
-func TestGetNewsDoc(t *testing.T) {
-	_, err := getNewsDoc(2019, 12)
+func TestGetNewsDocMonth(t *testing.T) {
+	_, err := getNewsDocMonth(2019, 12)
+	assert.NoError(t, err)
+}
+
+// Integration
+func TestGetNewsDocYear(t *testing.T) {
+	_, err := getNewsDocYear(2020)
 	assert.NoError(t, err)
 }
 
 func TestGetSelectionItems(t *testing.T) {
-	news := newsDoc{testDoc}
+	news := newsDoc{monthTestDoc}
 	assert.Equal(t, news.getSelectionItems().Length(), 100)
 }
 
 func TestGetSelectionTitle(t *testing.T) {
-	news := newsDoc{testDoc}
+	news := newsDoc{monthTestDoc}
 	assert.Equal(t, news.getSelectionTitle(news.getSelectionItems().First()), "Amazon EKS Announces Beta Release of Amazon FSx for Lustre CSI Driver")
 }
 
 func TestGetSelectionLink(t *testing.T) {
-	news := newsDoc{testDoc}
+	news := newsDoc{monthTestDoc}
 	assert.Equal(t, news.getSelectionItemLink(news.getSelectionItems().First()), "https://aws.amazon.com/about-aws/whats-new/2019/12/amazon-eks-announces-beta-release-amazon-fsx-lustre-csi-driver/")
 }
 
 func TestGetSelectionDate(t *testing.T) {
-	news := newsDoc{testDoc}
+	news := newsDoc{monthTestDoc}
 	assert.Equal(t, news.getSelectionItemDate(news.getSelectionItems().First()), "\n              Posted On: Dec 23, 2019 \n            ")
 }