Adding video statistics functionality

.gitignore

@@ -367,3 +367,7 @@ vs-readme.txt
 .gcc-flags.json
 .pio/
 .vscode/
+
+# custom ignores
+src/*
+lib/secrets/*

README.md

@@ -1,9 +1,14 @@
 # Arduino YouTube API Library
-[![arduino-library-badge](https://www.ardu-badge.com/badge/YoutubeApi.svg?)](https://www.ardu-badge.com/YoutubeApi) [![Build Status](https://travis-ci.org/witnessmenow/arduino-youtube-api.svg?branch=master)](https://travis-ci.org/witnessmenow/arduino-youtube-api)
 
 A wrapper for the [YouTube API](https://developers.google.com/youtube/v3/docs/) for Arduino. Works on both ESP8266 and ESP32.
 
-![Imgur](http://i.imgur.com/FmXyW4E.png)
+### Example fetching channel information:
+
+![Imgur](https://i.imgur.com/JaZR9m9.png)
+
+### Example fetching video information:
+
+![Imgur](https://i.imgur.com/hTbtVvg.png)
 
 ### Support what I do!
 
@@ -42,16 +47,21 @@ then once you're connected to WiFi you can start requesting data from the API:
 
     #define CHANNEL_ID "UCezJOfu7OtqGzd5xrP3q6WA"
 
-    if(api.getChannelStatistics(CHANNEL_ID)) {
+    YoutubeChannel channel(CHANNEL_ID, &api);
+
+    if(channel.getChannelStatistics()) {
         Serial.print("Subscriber Count: ");
-        Serial.println(api.channelStats.subscriberCount);
+        Serial.println(channel.channelStats->subscriberCount);
     }
 
 If you don't know it, you can find your own YouTube channel ID [here](https://www.youtube.com/account_advanced). See [the examples](examples) for more details on how to use the library.
 
 ## Supported Data Methods
 
-Currently the only implemented method is getting channel statistics, but the library can be easily extended. Please raise an issue if there is a method you are looking for.
+The library is currently able to fetch:
+
+- video list:   snippet, status, statistics and contentDetails
+- channel list: snippet, statistics and content details
 
 ## License
 

examples/ChannelInformation/ChannelInformation.ino

@@ -0,0 +1,279 @@
+/*******************************************************************
+	Read YouTube Channel information from the YouTube API
+	and print them to the serial monitor
+
+	Compatible Boards:
+	* Any ESP8266 board
+	* Any ESP32 board
+
+	Recommended Board: D1 Mini ESP8266
+	http://s.click.aliexpress.com/e/uzFUnIe (affiliate)
+
+	If you find what I do useful and would like to support me,
+	please consider becoming a sponsor on Github
+	https://github.com/sponsors/witnessmenow/
+
+	Written by Brian Lough
+	YouTube: https://www.youtube.com/brianlough
+	Tindie: https://www.tindie.com/stores/brianlough/
+	Twitter: https://twitter.com/witnessmenow
+ *******************************************************************/
+
+// ----------------------------
+// Standard Libraries
+// ----------------------------
+
+#if defined(ESP8266)
+	#include <ESP8266WiFi.h>
+#elif defined(ESP32)
+	#include <WiFi.h>
+#endif
+
+#include <WiFiClientSecure.h>
+
+// ----------------------------
+// Additional Libraries - each of these will need to be installed
+// ----------------------------
+
+// Library for connecting to the YouTube API
+// https://github.com/witnessmenow/arduino-youtube-api
+// (search for "youtube" in the Arduino Library Manager)
+#include "YoutubeApi.h"
+#include "YoutubeChannel.h"
+#include "YoutubePlaylist.h"
+#include "YoutubeVideo.h"
+
+// Library used for parsing Json from the API responses
+// https://github.com/bblanchon/ArduinoJson
+// (search for "Arduino Json" in the Arduino Library Manager)
+#include <ArduinoJson.h>
+
+//------- Replace the following! ------
+const char ssid[] = "xxx";       // your network SSID (name)
+const char password[] = "yyyy";  // your network key
+#define API_KEY "zzzz"           // your Google API key
+#define CHANNEL_ID "UCezJOfu7OtqGzd5xrP3q6WA" // part of the channel url
+//------- ---------------------- ------
+
+#define channelIdLen 24
+
+#define timeBetweenRequestGroup 120 * 1000  // 120 seconds, in milliseconds 	| time between all requests
+#define timeBetweenRequests 2 * 1000       // 2 seconds, in milliseconds    	| time between single requests
+
+WiFiClientSecure client;
+YoutubeApi api(API_KEY, client);
+
+char videoId[channelIdLen + 1];
+unsigned long startTime;
+
+/**
+ * @brief Tries to read the videoId from Serial.
+ * 
+ * @return 1 on success, 0 if no data available
+ */
+int readVideoId(){
+
+	if(Serial.available() > channelIdLen - 1){
+
+			for(int i = 0; i < channelIdLen; i++){
+
+				videoId[i] = Serial.read();
+			}
+
+			videoId[channelIdLen] = '\0';
+			return 1;
+	}
+	return 0;
+}
+
+/**
+ * @brief Flushes the Serial input buffer.
+ * 
+ */
+void flushSerialBuffer(){
+	while(Serial.available()){
+		Serial.read();
+	}
+}
+
+/**
+ * @brief Prints "Yes\n" if x or "No\n" if not x 
+ * 
+ * @param x parameter
+ */
+void printYesNo(bool x){
+	if(x){
+		Serial.println("Yes");
+	}else{
+		Serial.println("No");
+	}
+}
+
+
+void setup() {
+	Serial.begin(115200);
+
+	// Set WiFi to 'station' mode and disconnect
+	// from the AP if it was previously connected
+	WiFi.mode(WIFI_STA);
+	WiFi.disconnect();
+	delay(100);
+
+	// Connect to the WiFi network
+	Serial.print("\nConnecting to WiFi: ");
+	Serial.println(ssid);
+	WiFi.begin(ssid, password);
+	while (WiFi.status() != WL_CONNECTED) {
+		Serial.print(".");
+		delay(500);
+	}
+	Serial.println("\nWiFi connected!");
+	Serial.print("IP address: ");
+	IPAddress ip = WiFi.localIP();
+	Serial.println(ip);
+
+	#ifdef ESP8266
+	// Required if you are using ESP8266 V2.5 or above
+	client.setInsecure();
+	#endif
+
+	client.setInsecure();
+
+	// Uncomment for extra debugging info
+	// api._debug = true;
+
+	flushSerialBuffer();
+	Serial.print("Enter channelId: ");
+
+	while(1){
+		if(readVideoId()){
+			flushSerialBuffer();
+			break;
+		}
+	}
+
+	Serial.println(videoId);
+}
+
+void loop() {
+
+	Serial.setTimeout(timeBetweenRequestGroup);
+
+	YoutubeChannel channel(videoId, &api);
+
+	// fetch and print information in channel.list:snippet
+	if(channel.getChannelSnippet()){
+		Serial.println("\n\nsnippet");
+
+		channelSnippet *fetchedSnip = channel.channelSnip;
+
+
+		Serial.print("|----- Channel title: ");
+		Serial.println(fetchedSnip->title);
+
+		Serial.print("|----- Channel description: ");
+		Serial.println(fetchedSnip->description);
+
+		Serial.print("|----- Channel country: ");
+		Serial.println(fetchedSnip->country);
+
+		tm channelCreation = fetchedSnip->publishedAt;
+
+		Serial.print("|----- Channel creation (d.m.y h:m:s): ");
+		Serial.print(channelCreation.tm_mday);
+        Serial.print(".");
+        Serial.print(channelCreation.tm_mon);
+        Serial.print(".");
+        Serial.print(channelCreation.tm_year + 1900);
+        Serial.print(" ");
+        Serial.print(channelCreation.tm_hour);
+        Serial.print(":");
+        Serial.print(channelCreation.tm_min);
+        Serial.print(":");
+        Serial.println(channelCreation.tm_sec);
+
+		Serial.println("-------------------------------------------------");
+	}
+
+	if(channel.getChannelStatistics()){
+		Serial.println("\n\nstatistics");
+
+		channelStatistics *fetchedStats = channel.channelStats;
+
+		Serial.print("|----- Channel views: ");
+		Serial.println(fetchedStats->viewCount);
+
+		Serial.print("|----- Channel subscriber count hidden? ");
+		printYesNo(fetchedStats->hiddenSubscriberCount);
+
+		Serial.print("|----- Channel subscribers: ");
+		Serial.println(fetchedStats->subscriberCount);
+
+		Serial.print("|----- Channel video count: ");
+		Serial.println(fetchedStats->videoCount);
+
+		Serial.println("-------------------------------------------------");
+	}
+
+	delay(timeBetweenRequests);
+
+	// fetch and print information in channel.list:contentDetails
+	if(channel.getChannelContentDetails()){
+		Serial.println("\n\ncontent details");
+
+		channelContentDetails *fetchedDetails = channel.channelContentDets;
+
+		Serial.print("|----- Liked videos playlist id: ");
+		Serial.println(fetchedDetails->relatedPlaylistsLikes);
+
+		Serial.print("|----- Uploaded videos playlist id: ");
+		Serial.println(fetchedDetails->relatedPlaylistsUploads);
+
+		Serial.println("-------------------------------------------------");
+	}
+
+	if(channel.checkChannelContentDetailsSet() && channel.checkChannelSnipSet()){
+		Serial.print("\n\nFetching last five videos of ");
+		Serial.println(channel.channelSnip->title);
+
+		YoutubePlaylist recentVideos = YoutubePlaylist(&api, channel.channelContentDets->relatedPlaylistsUploads);
+		recentVideos.getPlaylistItemsPage(0);
+
+		playlistItemsContentDetails *page = recentVideos.itemsContentDets;
+
+		for(int i = 0; i < YT_PLAYLIST_ITEM_RESULTS_PER_PAGE; i++){
+			char *videoId = page[i].videoId;
+
+			if(!strcmp("", videoId)){
+				break;
+			}	
+
+			YoutubeVideo vid = YoutubeVideo(videoId, &api);
+			if(vid.getVideoSnippet() && vid.getVideoStatistics()){
+				Serial.print("videoId: ");
+				Serial.print(videoId);
+				Serial.print(" | \"");
+				Serial.print(vid.videoSnip->title);
+				Serial.print("\" | Views: ");
+				Serial.println(vid.videoStats->viewCount);
+			}
+		}
+	}
+
+
+	Serial.print("\nRefreshing in ");
+	Serial.print(timeBetweenRequestGroup / 1000.0);
+	Serial.println(" seconds...");
+	Serial.print("Or set a new channelId: ");
+
+	startTime = millis();
+	flushSerialBuffer();
+
+	while(millis() - startTime < timeBetweenRequestGroup){
+
+		if(readVideoId()){;
+			Serial.println(videoId);
+			break;
+		}
+	}
+}