Make usage of refactored HttpHandler, cleanup code

Moritz W
1 parent ee78d8b4
Showing 8 changed files with 90 additions and 59 deletions
hueplusplus/HttpHandler.cpp
hueplusplus/Hue.cpp
hueplusplus/HueLight.cpp
hueplusplus/UPnP.cpp
hueplusplus/include/HttpHandler.h
hueplusplus/include/Hue.h
hueplusplus/include/HueLight.h
hueplusplus/include/UPnP.h
@@ -18,18 +18,19 @@
 **/
 #include "include/HttpHandler.h"
+
+#include <chrono>
+#include <netinet/in.h> // struct sockaddr_in, struct sockaddr
+#include <arpa/inet.h>
 #include <iostream>
 #include <memory>
-#include <stdexcept>
-#include <stdio.h>		// printf, sprintf
-#include <stdlib.h>		// exit
-#include <unistd.h>		// read, write, close
+#include <netdb.h>			// struct hostent, gethostbyname
 #include <sys/socket.h> // socket, connect
-#include <netinet/in.h> // struct sockaddr_in, struct sockaddr
-#include <arpa/inet.h>
-#include <netdb.h>		// struct hostent, gethostbyname
-#include <string.h>
-#include <chrono>
+#include <stdexcept>
+#include <stdio.h>			// printf, sprintf
+#include <stdlib.h>			// exit
+#include <string.h>			// functions for C style null-terminated strings
+#include <unistd.h>			// read, write, close
 class SocketCloser {
 	public: SocketCloser(int sockFd) :s(sockFd) {}
@@ -18,28 +18,28 @@
 **/
 #include "include/Hue.h"
-#include "include/HueLight.h"
-#include "include/SimpleBrightnessStrategy.h"
-#include "include/SimpleColorHueStrategy.h"
-#include "include/ExtendedColorHueStrategy.h"
-#include "include/SimpleColorTemperatureStrategy.h"
-#include "include/ExtendedColorTemperatureStrategy.h"
-
-#include "include/HttpHandler.h"
-#include "include/UPnP.h"
 #include <chrono>
 #include <iostream>
-#include <memory>
 #include <regex>
 #include <stdexcept>
 #include <thread>
+#include "include/ExtendedColorHueStrategy.h"
+#include "include/ExtendedColorTemperatureStrategy.h"
+#include "include/SimpleBrightnessStrategy.h"
+#include "include/SimpleColorHueStrategy.h"
+#include "include/SimpleColorTemperatureStrategy.h"
+
+#include "include/UPnP.h"
+
+HueFinder::HueFinder(std::shared_ptr<const IHttpHandler> handler) : http_handler(std::move(handler))
+{}
 std::vector<HueFinder::HueIdentification> HueFinder::FindBridges() const
 {
 	UPnP uplug;
-	std::vector<std::pair<std::string, std::string>> foundDevices = uplug.getDevices();
+	std::vector<std::pair<std::string, std::string>> foundDevices = uplug.getDevices(http_handler);
 	//Does not work
 	std::regex manufRegex("<manufacturer>Royal Philips Electronics</manufacturer>");
@@ -56,7 +56,7 @@ std::vector&lt;HueFinder::HueIdentification&gt; HueFinder::FindBridges() const
 			unsigned int start = p.first.find("//") + 2;
 			unsigned int length = p.first.find(":", start) - start;
 			bridge.ip = p.first.substr(start, length);
-			std::string desc = HttpHandler().GETString("/description.xml", "application/xml", "", bridge.ip);
+			std::string desc = http_handler->GETString("/description.xml", "application/xml", "", bridge.ip);
 			std::smatch matchResult;
 			if (std::regex_search(desc, manufRegex) && std::regex_search(desc, manURLRegex) && std::regex_search(desc, modelRegex) && std::regex_search(desc, matchResult, serialRegex))
 			{
@@ -93,7 +93,7 @@ Hue HueFinder::GetBridge(const HueIdentification&amp; identification)
 			AddUsername(identification.mac, username);
 		}
 	}
-	return Hue(identification.ip, username);
+	return Hue(identification.ip, username, http_handler);
 }
 void HueFinder::AddUsername(const std::string& mac, const std::string& username)
@@ -122,7 +122,7 @@ std::string HueFinder::RequestUsername(const std::string &amp; ip) const
 		if (std::chrono::steady_clock::now() - lastCheck > std::chrono::seconds(1))
 		{
 			lastCheck = std::chrono::steady_clock::now();
-			answer = HttpHandler().GETJson("/api", request, ip);
+			answer = http_handler->GETJson("/api", request, ip);
 			if (answer[0]["success"] != Json::nullValue)
 			{
@@ -141,9 +141,10 @@ std::string HueFinder::RequestUsername(const std::string &amp; ip) const
 }
-Hue::Hue(const std::string& ip, const std::string& username) :
+Hue::Hue(const std::string& ip, const std::string& username, std::shared_ptr<const IHttpHandler> handler) :
 ip(ip),
-username(username)
+username(username),
+http_handler(std::move(handler))
 {
 	simpleBrightnessStrategy = std::make_shared<SimpleBrightnessStrategy>();
 	simpleColorHueStrategy = std::make_shared<SimpleColorHueStrategy>();
@@ -172,7 +173,8 @@ void Hue::requestUsername(const std::string&amp; ip)
 		if (std::chrono::steady_clock::now() - lastCheck > std::chrono::seconds(1))
 		{
 			lastCheck = std::chrono::steady_clock::now();
-			answer = HttpHandler().GETJson("/api", request, ip);
+			answer = http_handler->GETJson("/api", request, ip);
+
 			if (answer[0]["success"] != Json::nullValue)
 			{
 				// [{"success":{"username": "<username>"}}]
@@ -218,7 +220,7 @@ HueLight&amp; Hue::getLight(int id)
 	if (type == "LCT001" || type == "LCT002" || type == "LCT003" || type == "LCT007" || type == "LLM001")
 	{
 		// HueExtendedColorLight Gamut B
-		HueLight light = HueLight(ip, username, id, simpleBrightnessStrategy, extendedColorTemperatureStrategy, extendedColorHueStrategy);
+		HueLight light = HueLight(ip, username, id, simpleBrightnessStrategy, extendedColorTemperatureStrategy, extendedColorHueStrategy, http_handler);
 		light.colorType = ColorType::GAMUT_B;
 		lights.emplace(id, light);
 		return lights.find(id)->second;
@@ -226,7 +228,7 @@ HueLight&amp; Hue::getLight(int id)
 	else if (type == "LCT010" || type == "LCT011" || type == "LCT014" || type == "LLC020" || type == "LST002")
 	{
 		// HueExtendedColorLight Gamut C
-		HueLight light = HueLight(ip, username, id, simpleBrightnessStrategy, extendedColorTemperatureStrategy, extendedColorHueStrategy);
+		HueLight light = HueLight(ip, username, id, simpleBrightnessStrategy, extendedColorTemperatureStrategy, extendedColorHueStrategy, http_handler);
 		light.colorType = ColorType::GAMUT_C;
 		lights.emplace(id, light);
 		return lights.find(id)->second;
@@ -234,7 +236,7 @@ HueLight&amp; Hue::getLight(int id)
 	else if (type == "LST001" || type == "LLC006" || type == "LLC007" || type == "LLC010" || type == "LLC011" || type == "LLC012" || type == "LLC013")
 	{
 		// HueColorLight Gamut A
-		HueLight light = HueLight(ip, username, id, simpleBrightnessStrategy, simpleColorTemperatureStrategy, simpleColorHueStrategy);
+		HueLight light = HueLight(ip, username, id, simpleBrightnessStrategy, simpleColorTemperatureStrategy, simpleColorHueStrategy, http_handler);
 		light.colorType = ColorType::GAMUT_A;
 		lights.emplace(id, light);
 		return lights.find(id)->second;
@@ -242,7 +244,7 @@ HueLight&amp; Hue::getLight(int id)
 	else if (type == "LWB004" || type == "LWB006" || type == "LWB007" || type == "LWB010" || type == "LWB014")
 	{
 		// HueDimmableLight No Color Type
-		HueLight light = HueLight(ip, username, id, simpleBrightnessStrategy, nullptr, nullptr);
+		HueLight light = HueLight(ip, username, id, simpleBrightnessStrategy, nullptr, nullptr, http_handler);
 		light.colorType = ColorType::NONE;
 		lights.emplace(id, light);
 		return lights.find(id)->second;
@@ -250,7 +252,7 @@ HueLight&amp; Hue::getLight(int id)
 	else if (type == "LLM010" || type == "LLM011" || type == "LLM012" || type == "LTW001" || type == "LTW004" || type == "LTW013" || type == "LTW014")
 	{
 		// HueTemperatureLight
-		HueLight light = HueLight(ip, username, id, simpleBrightnessStrategy, simpleColorTemperatureStrategy, nullptr);
+		HueLight light = HueLight(ip, username, id, simpleBrightnessStrategy, simpleColorTemperatureStrategy, nullptr, http_handler);
 		light.colorType = ColorType::TEMPERATURE;
 		lights.emplace(id, light);
 		return lights.find(id)->second;
@@ -284,13 +286,13 @@ void Hue::refreshState()
 	{
 		return;
 	}
-	Json::Value answer = HttpHandler().GETJson("/api/"+username, Json::objectValue, ip);
+	Json::Value answer = http_handler->GETJson("/api/"+username, Json::objectValue, ip);
 	if (answer.isObject() && answer.isMember("lights"))
 	{
 		state = answer;
 	}
 	else
 	{
-		std::cout << "Answer in Hue::refreshState of HttpHandler().GETJson(...) is not expected!\n";
+		std::cout << "Answer in Hue::refreshState of http_handler->GETJson(...) is not expected!\n";
 	}
 }
@@ -19,13 +19,12 @@
 #include "include/HueLight.h"
-#include "include/HttpHandler.h"
-#include "include/json/json.h"
-
 #include <cmath>
 #include <iostream>
 #include <thread>
+#include "include/json/json.h"
+
 bool HueLight::On(uint8_t transition)
 {
 	std::cout << "Turning lamp with id: " << id << " on\n";
@@ -78,17 +77,18 @@ bool HueLight::alert()
 	return false;
 }
-HueLight::HueLight(const std::string& ip, const std::string& username, int id)
-	: HueLight(ip,  username, id, nullptr, nullptr, nullptr)
+HueLight::HueLight(const std::string& ip, const std::string& username, int id, std::shared_ptr<const IHttpHandler> handler)
+	: HueLight(ip,  username, id, nullptr, nullptr, nullptr, handler)
 {}
-HueLight::HueLight(const std::string& ip, const std::string& username, int id, std::shared_ptr<const BrightnessStrategy> brightnessStrategy, std::shared_ptr<const ColorTemperatureStrategy> colorTempStrategy, std::shared_ptr<const ColorHueStrategy> colorHueStrategy)
+HueLight::HueLight(const std::string& ip, const std::string& username, int id, std::shared_ptr<const BrightnessStrategy> brightnessStrategy, std::shared_ptr<const ColorTemperatureStrategy> colorTempStrategy, std::shared_ptr<const ColorHueStrategy> colorHueStrategy, std::shared_ptr<const IHttpHandler> handler)
 	: ip(ip),
 	username(username),
 	id(id),
 	brightnessStrategy(std::move(brightnessStrategy)),
 	colorTemperatureStrategy(std::move(colorTempStrategy)),
-	colorHueStrategy(std::move(colorHueStrategy))
+	colorHueStrategy(std::move(colorHueStrategy)),
+	http_handler(std::move(handler))
 {
 	refreshState();
 }
@@ -173,7 +173,7 @@ bool HueLight::OffNoRefresh(uint8_t transition)
 Json::Value HueLight::SendPutRequest(const Json::Value& request)
 {
-	return HttpHandler().PUTJson("/api/"+username+"/lights/"+std::to_string(id)+"/state", request, ip);
+	return http_handler->PUTJson("/api/"+username+"/lights/"+std::to_string(id)+"/state", request, ip);
 }
 void HueLight::refreshState()
@@ -181,7 +181,7 @@ void HueLight::refreshState()
 	std::chrono::steady_clock::time_point start = std::chrono::steady_clock::now();
 	std::cout << "\tRefreshing lampstate of lamp with id: " << id << ", ip: " << ip << "\n";
-	state = HttpHandler().GETJson("/api/"+username+"/lights/"+std::to_string(id), Json::objectValue, ip);
+	state = http_handler->GETJson("/api/"+username+"/lights/"+std::to_string(id), Json::objectValue, ip);
 	//! \todo check whether getAnswer is containing right information
 	std::cout << "\tRefresh state took: " << std::chrono::duration_cast<std::chrono::milliseconds>(std::chrono::steady_clock::now() - start).count() << "ms" << std::endl;
@@ -18,14 +18,14 @@
 **/
 #include "include/UPnP.h"
-#include "include/HttpHandler.h"
+
 #include <algorithm>
 #include <iostream>
-std::vector<std::pair<std::string, std::string>> UPnP::getDevices()
+std::vector<std::pair<std::string, std::string>> UPnP::getDevices(std::shared_ptr<const IHttpHandler> handler)
 {
 	// send UPnP M-Search request
-	std::vector<std::string> foundDevices =  HttpHandler().sendMulticast("M-SEARCH * HTTP/1.1\r\nHOST: 239.255.255.250:1900\r\nMAN: \"ssdp:discover\"\r\nMX: 5\r\nST: ssdp:all\r\n\r\n", "239.255.255.250", 1900, 5);
+	std::vector<std::string> foundDevices =  handler->sendMulticast("M-SEARCH * HTTP/1.1\r\nHOST: 239.255.255.250:1900\r\nMAN: \"ssdp:discover\"\r\nMX: 5\r\nST: ssdp:all\r\n\r\n", "239.255.255.250", 1900, 5);
 	std::vector<std::pair<std::string, std::string>> devices;
@@ -23,9 +23,10 @@
 #include <string>
 #include <vector>
-#include "json/json.h"
 #include "IHttpHandler.h"
+#include "json/json.h"
+
 //! Class to handle http requests and multicast requests
 class HttpHandler : public IHttpHandler
 {
@@ -20,19 +20,20 @@
 #ifndef _HUE_H
 #define _HUE_H
-#include "HueLight.h"
-#include "BrightnessStrategy.h"
-#include "ColorHueStrategy.h"
-#include "ColorTemperatureStrategy.h"
-
-#include "json/json.h"
-
 #include <map>
 #include <memory>
 #include <string>
 #include <utility>
 #include <vector>
+#include "BrightnessStrategy.h"
+#include "ColorHueStrategy.h"
+#include "ColorTemperatureStrategy.h"
+#include "HueLight.h"
+#include "IHttpHandler.h"
+
+#include "json/json.h"
+
 // forward declarations
 class Hue;
@@ -47,7 +48,14 @@ public:
 		std::string ip;
 		std::string mac;
 	};
+
 public:
+
+	//! \brief Constructor of HueFinder class
+	//!
+	//! \param handler HttpHandler of type \ref IHttpHandler for communication with the bridge
+	HueFinder(std::shared_ptr<const IHttpHandler> handler);
+
 	//! \brief Function that finds all bridges in the network and returns them.
 	//!
 	//! The user should be given the opportunity to select the correct one based on the mac address.
@@ -68,9 +76,10 @@ public:
 	//! \brief Function that returns a map of mac addresses and usernames.
 	//!
-	//! These should be saved at the end and re-loaded next time, so only one username is generated per bridge.
+	//! Note these should be saved at the end and re-loaded with \ref AddUsername next time, so only one username is generated per bridge.
 	//! \returns A map mapping mac address to username for every bridge
 	const std::map<std::string, std::string>& GetAllUsernames() const;
+
 private:
 	//! \brief Function that sends a username request to the Hue bridge.
 	//!
@@ -82,6 +91,7 @@ private:
 private:
 	std::map<std::string, std::string> usernames;		//!< Maps all macs to usernames added by \ref HueFinder::AddUsername
+	std::shared_ptr<const IHttpHandler> http_handler;
 };
 //! Hue class
@@ -92,7 +102,8 @@ public:
 	//!
 	//! \param ip String that specifies the ip address of the Hue bridge in dotted decimal notation like "192.168.2.1"
 	//! \param username String that specifies the username that is used to control the bridge. This needs to be acquired in \ref requestUsername
-	Hue(const std::string& ip, const std::string& username);
+	//! \param handler HttpHandler of type \ref IHttpHandler for communication with the bridge
+	Hue(const std::string& ip, const std::string& username, std::shared_ptr<const IHttpHandler> handler);
 	//! \brief Function to get the ip address of the hue bridge
 	//!
@@ -149,6 +160,7 @@ private:
 	std::shared_ptr<ColorHueStrategy>			extendedColorHueStrategy;							//!< Strategy that is used for controlling the color of lights
 	std::shared_ptr<ColorTemperatureStrategy>	simpleColorTemperatureStrategy;		//!< Strategy that is used for controlling the color temperature of lights
 	std::shared_ptr<ColorTemperatureStrategy>	extendedColorTemperatureStrategy;	//!< Strategy that is used for controlling the color temperature of lights
+	std::shared_ptr<const IHttpHandler> http_handler;
 };
 #endif
@@ -22,10 +22,12 @@
 #include <memory>
-#include "json/json.h"
 #include "BrightnessStrategy.h"
 #include "ColorHueStrategy.h"
 #include "ColorTemperatureStrategy.h"
+#include "IHttpHandler.h"
+
+#include "json/json.h"
 /*enum ModelType
 {
@@ -341,9 +343,10 @@ protected:
 	//! \param ip String that specifies the ip of the Hue bridge
 	//! \param username String that specifies the username used to control the bridge
 	//! \param id Integer that specifies the id of this light
+	//! \param handler HttpHandler of type \ref IHttpHandler for communication with the bridge
 	//!
 	//! leaves strategies unset
-	HueLight(const std::string& ip, const std::string& username, int id);
+	HueLight(const std::string& ip, const std::string& username, int id, std::shared_ptr<const IHttpHandler> handler);
 	//! \brief Protected ctor that is used by \ref Hue class, also sets strategies.
 	//!
@@ -353,7 +356,8 @@ protected:
 	//! \param brightnessStrategy Strategy for brightness. May be nullptr.
 	//! \param colorTempStrategy Strategy for color temperature. May be nullptr.
 	//! \param colorHueStrategy Strategy for color hue/saturation. May be nullptr.
-	HueLight(const std::string& ip, const std::string& username, int id, std::shared_ptr<const BrightnessStrategy> brightnessStrategy, std::shared_ptr<const ColorTemperatureStrategy> colorTempStrategy, std::shared_ptr<const ColorHueStrategy> colorHueStrategy);
+	//! \param handler HttpHandler of type \ref IHttpHandler for communication with the bridge
+	HueLight(const std::string& ip, const std::string& username, int id, std::shared_ptr<const BrightnessStrategy> brightnessStrategy, std::shared_ptr<const ColorTemperatureStrategy> colorTempStrategy, std::shared_ptr<const ColorHueStrategy> colorHueStrategy, std::shared_ptr<const IHttpHandler> handler);
 	//! \brief Protected function that sets the brightness strategy.
 	//!
@@ -373,6 +377,12 @@ protected:
 	//! \param strat a strategy of type \ref ColorHueStrategy
 	void setColorHueStrategy(std::shared_ptr<const ColorHueStrategy> strat)  { colorHueStrategy = std::move(strat); };
+	//! \brief Protected function that sets the HttpHandler.
+	//!
+	//! The HttpHandler defines how specific commands that deal with bridge communication are executed
+	//! \param handler a HttpHandler of type \ref IHttpHandler
+	void setHttpHandler(std::shared_ptr<const IHttpHandler> handler)  { http_handler = std::move(handler); };
+
 	//! \brief Function that turns the light on without refreshing its state.
 	//!
 	//! \param transition Optional parameter to set the transition from current state to new standard is 4 = 400ms
@@ -404,6 +414,7 @@ protected:
 	std::shared_ptr<const BrightnessStrategy>		brightnessStrategy;			//!< holds a reference to the strategy that handles brightness commands
 	std::shared_ptr<const ColorTemperatureStrategy> colorTemperatureStrategy;	//!< holds a reference to the strategy that handles colortemperature commands
 	std::shared_ptr<const ColorHueStrategy>			colorHueStrategy;			//!< holds a reference to the strategy that handles all color commands
+	std::shared_ptr<const IHttpHandler> http_handler;
 };
 #endif
@@ -20,9 +20,12 @@
 #ifndef _UPNP_H
 #define _UPNP_H
+#include <memory>
 #include <string>
 #include <vector>
+#include "IHttpHandler.h"
+
 //! Class that looks for UPnP devices using an m-search package
 class UPnP
 {
@@ -31,8 +34,9 @@ public:
 	//!
 	//! It does it by sending an m-search packet and waits for all responses.
 	//! Since responses can be received multiple times this function conveniently removes all duplicates.
+	//! \param handler HttpHandler of type \ref IHttpHandler for communication with the bridge
 	//! \return A vector containing pairs of address and name of all found devices
-	std::vector<std::pair<std::string, std::string>> getDevices();
+	std::vector<std::pair<std::string, std::string>> getDevices(std::shared_ptr<const IHttpHandler> handler);
 };
 #endif