Merge pull request #90 from ed7coyne/modem-impl3

Implement modem (attempt 3)

Author: proppy

.gitmodules

@@ -0,0 +1,6 @@
+[submodule "test/googletest"]
+	path = test/googletest
+	url = https://github.com/google/googletest.git
+[submodule "test/arduino-mock"]
+	path = test/arduino-mock
+	url = https://github.com/ed7coyne/arduino-mock.git

examples/FirebasePush_ESP8266/FirebasePush_ESP8266.ino

@@ -17,6 +17,8 @@
 // FirebasePush_ESP8266 is a sample that push a new timestamp to firebase
 // on each reset.
 
+#include <ESP8266WiFi.h>
+
 #include <Firebase.h>
 
 // create firebase client.

examples/FirebaseStream_ESP8266/FirebaseStream_ESP8266.ino

@@ -18,6 +18,7 @@
 // public Firebase and optionally display them on a OLED i2c screen.
 
 #include <Firebase.h>
+#include <ESP8266WiFi.h>
 #include <Adafruit_GFX.h>
 #include <Adafruit_SSD1306.h>
 #include <ArduinoJson.h>

examples/Firebase_ESP8266_LEDs/Firebase_ESP8266_Neopixel/Firebase_ESP8266_Neopixel.ino

@@ -18,6 +18,7 @@
 // to set pixel data using a firebase stream.
 #include <Firebase.h>
 #include <ArduinoJson.h>
+#include <ESP8266WiFi.h>
 
 #include <Adafruit_NeoPixel.h>
 #include "colors_ext.h"

src/Firebase.cpp

@@ -15,17 +15,9 @@
 //
 #include "Firebase.h"
 
-// Detect whether stable version of HTTP library is installed instead of
-// master branch and patch in missing status and methods.
-#ifndef HTTP_CODE_TEMPORARY_REDIRECT
-#define HTTP_CODE_TEMPORARY_REDIRECT 307
-#define USE_ESP_ARDUINO_CORE_2_0_0
-#endif
+using std::unique_ptr;
 
 namespace {
-const char* kFirebaseFingerprint = "7A 54 06 9B DC 7A 25 B3 86 8D 66 53 48 2C 0B 96 42 C7 B3 0A";
-const uint16_t kFirebasePort = 443;
-
 String makeFirebaseURL(const String& path, const String& auth) {
   String url;
   if (path[0] != '/') {
@@ -41,40 +33,70 @@ String makeFirebaseURL(const String& path, const String& auth) {
 }  // namespace
 
 Firebase::Firebase(const String& host, const String& auth) : host_(host), auth_(auth) {
-  http_.setReuse(true);
+  http_.reset(FirebaseHttpClient::create());
+  http_->setReuseConnection(true);
+}
+
+const String& Firebase::auth() const {
+  return auth_;
 }
 
 FirebaseGet Firebase::get(const String& path) {
-  return FirebaseGet(host_, auth_, path, &http_);
+  return FirebaseGet(host_, auth_, path, http_.get());
+}
+
+unique_ptr<FirebaseGet> Firebase::getPtr(const String& path) {
+  return unique_ptr<FirebaseGet>(new FirebaseGet(host_, auth_, path, http_.get()));
 }
 
 FirebaseSet Firebase::set(const String& path, const String& value) {
-  return FirebaseSet(host_, auth_, path, value, &http_);
+  return FirebaseSet(host_, auth_, path, value, http_.get());
+}
+
+unique_ptr<FirebaseSet> Firebase::setPtr(const String& path,
+                                         const String& value) {
+  return unique_ptr<FirebaseSet>(
+      new FirebaseSet(host_, auth_, path, value, http_.get()));
 }
 
 FirebasePush Firebase::push(const String& path, const String& value) {
-  return FirebasePush(host_, auth_, path, value, &http_);
+  return FirebasePush(host_, auth_, path, value, http_.get());
+}
+unique_ptr<FirebasePush> Firebase::pushPtr(const String& path, const String& value) {
+  return unique_ptr<FirebasePush>(
+      new FirebasePush(host_, auth_, path, value, http_.get()));
 }
 
 FirebaseRemove Firebase::remove(const String& path) {
-  return FirebaseRemove(host_, auth_, path, &http_);
+  return FirebaseRemove(host_, auth_, path, http_.get());
+}
+
+unique_ptr<FirebaseRemove> Firebase::removePtr(const String& path) {
+  return unique_ptr<FirebaseRemove>(
+      new FirebaseRemove(host_, auth_, path, http_.get()));
 }
 
 FirebaseStream Firebase::stream(const String& path) {
   // TODO: create new client dedicated to stream.
-  return FirebaseStream(host_, auth_, path, &http_);
+  return FirebaseStream(host_, auth_, path, http_.get());
+}
+
+unique_ptr<FirebaseStream> Firebase::streamPtr(const String& path) {
+  // TODO: create new client dedicated to stream.
+  return unique_ptr<FirebaseStream>(
+      new FirebaseStream(host_, auth_, path, http_.get()));
 }
 
 // FirebaseCall
 FirebaseCall::FirebaseCall(const String& host, const String& auth,
                            const char* method, const String& path,
-                           const String& data, HTTPClient* http) : http_(http) {
-  String url = makeFirebaseURL(path, auth);
-  http_->setReuse(true);
-  http_->begin(host, kFirebasePort, url, true, kFirebaseFingerprint);
+                           const String& data, FirebaseHttpClient* http) : http_(http) {
+  String path_with_auth = makeFirebaseURL(path, auth);
+  http_->setReuseConnection(true);
+  http_->begin(host, path_with_auth);
 
   bool followRedirect = false;
-  if (method == "STREAM") {
+  if (String(method) == "STREAM") {
     method = "GET";
     http_->addHeader("Accept", "text/event-stream");
     followRedirect = true;
@@ -85,26 +107,24 @@ FirebaseCall::FirebaseCall(const String& host, const String& auth,
     http_->collectHeaders(headers, 1);
   }
 
-  int status = http_->sendRequest(method, (uint8_t*)data.c_str(), data.length());
+  int status = http_->sendRequest(method, data);
 
   // TODO: Add a max redirect check
   if (followRedirect) {
-    while (status == HTTP_CODE_TEMPORARY_REDIRECT) {
+    while (status == HttpStatus::TEMPORARY_REDIRECT) {
       String location = http_->header("Location");
-      http_->setReuse(false);
+      http_->setReuseConnection(false);
       http_->end();
-      http_->setReuse(true);
-      http_->begin(location, kFirebaseFingerprint);
-      status = http_->sendRequest("GET", (uint8_t*)NULL, 0);
+      http_->setReuseConnection(true);
+      http_->begin(location);
+      status = http_->sendRequest("GET", String());
     }
   }
 
   if (status != 200) {
-#ifdef USE_ESP_ARDUINO_CORE_2_0_0
-    error_ = FirebaseError(status, String(method) + " " + url + ": " + status);
-#else
-    error_ = FirebaseError(status, String(method) + " " + url + ": " + HTTPClient::errorToString(status));
-#endif
+    error_ = FirebaseError(status,
+                           String(method) + " " + path_with_auth +
+                              ": " + http_->errorToString(status));
   }
 
   // if not streaming.
@@ -123,14 +143,14 @@ const JsonObject& FirebaseCall::json() {
 // FirebaseGet
 FirebaseGet::FirebaseGet(const String& host, const String& auth,
                          const String& path,
-                         HTTPClient* http)
+                         FirebaseHttpClient* http)
   : FirebaseCall(host, auth, "GET", path, "", http) {
 }
 
 // FirebaseSet
 FirebaseSet::FirebaseSet(const String& host, const String& auth,
        const String& path, const String& value,
-       HTTPClient* http)
+       FirebaseHttpClient* http)
   : FirebaseCall(host, auth, "PUT", path, value, http) {
   if (!error()) {
     // TODO: parse json
@@ -140,7 +160,7 @@ FirebaseSet::FirebaseSet(const String& host, const String& auth,
 // FirebasePush
 FirebasePush::FirebasePush(const String& host, const String& auth,
                            const String& path, const String& value,
-                           HTTPClient* http)
+                           FirebaseHttpClient* http)
   : FirebaseCall(host, auth, "POST", path, value, http) {
   if (!error()) {
     name_ = json()["name"].as<const char*>();
@@ -150,14 +170,14 @@ FirebasePush::FirebasePush(const String& host, const String& auth,
 // FirebasePush
 FirebaseRemove::FirebaseRemove(const String& host, const String& auth,
                                const String& path,
-                               HTTPClient* http)
+                               FirebaseHttpClient* http)
   : FirebaseCall(host, auth, "DELETE", path, "", http) {
 }
 
 // FirebaseStream
 FirebaseStream::FirebaseStream(const String& host, const String& auth,
                                const String& path,
-                               HTTPClient* http)
+                               FirebaseHttpClient* http)
   : FirebaseCall(host, auth, "STREAM", path, "", http) {
 }
 

src/Firebase.h

@@ -21,9 +21,11 @@
 #define firebase_h
 
 #include <Arduino.h>
-#include <ESP8266WiFi.h>
-#include <WiFiClientSecure.h>
-#include <ESP8266HTTPClient.h>
+#include <memory>
+#include "FirebaseHttpClient.h"
+// TODO(edcoyne): move this into our mock_arduino fork where we actually do the
+// override.
+#define ARDUINO_STRING_OVERRIDE
 #include "third-party/arduino-json-5.1.1/include/ArduinoJson.h"
 
 class FirebaseGet;
@@ -37,23 +39,34 @@ class Firebase {
  public:
   Firebase(const String& host, const String& auth = "");
 
+  const String& auth() const;
+
   // Fetch json encoded `value` at `path`.
   FirebaseGet get(const String& path);
+  virtual std::unique_ptr<FirebaseGet> getPtr(const String& path);
 
   // Set json encoded `value` at `path`.
   FirebaseSet set(const String& path, const String& json);
+  virtual std::unique_ptr<FirebaseSet> setPtr(const String& path, const String& json);
 
   // Add new json encoded `value` to list at `path`.
   FirebasePush push(const String& path, const String& json);
+  virtual std::unique_ptr<FirebasePush> pushPtr(const String& path, const String& json);
 
   // Delete value at `path`.
   FirebaseRemove remove(const String& path);
+  virtual std::unique_ptr<FirebaseRemove> removePtr(const String& path);
 
   // Start a stream of events that affect value at `path`.
   FirebaseStream stream(const String& path);
+  virtual std::unique_ptr<FirebaseStream> streamPtr(const String& path);
+
+ protected:
+  // Used for testing.
+  Firebase() {}
 
  private:
-  HTTPClient http_;
+  std::unique_ptr<FirebaseHttpClient> http_;
   String host_;
   String auth_;
 };
@@ -76,20 +89,20 @@ class FirebaseCall {
   FirebaseCall() {}
   FirebaseCall(const String& host, const String& auth,
                const char* method, const String& path,
-               const String& data = "",        
-               HTTPClient* http = NULL);
-  const FirebaseError& error() const {
+               const String& data = "",
+               FirebaseHttpClient* http = NULL);
+  virtual const FirebaseError& error() const {
     return error_;
   }
 
-  const String& response() {
+  virtual const String& response() {
     return response_;
   }
 
   const JsonObject& json();
 
  protected:
-  HTTPClient* http_;
+  FirebaseHttpClient* http_;
   FirebaseError error_;
   String response_;
   DynamicJsonBuffer buffer_;
@@ -99,7 +112,7 @@ class FirebaseGet : public FirebaseCall {
  public:
   FirebaseGet() {}
   FirebaseGet(const String& host, const String& auth,
-              const String& path, HTTPClient* http = NULL);
+              const String& path, FirebaseHttpClient* http = NULL);
 
  private:
   String json_;
@@ -109,7 +122,8 @@ class FirebaseSet: public FirebaseCall {
  public:
   FirebaseSet() {}
   FirebaseSet(const String& host, const String& auth,
-	      const String& path, const String& value, HTTPClient* http = NULL);
+              const String& path, const String& value, FirebaseHttpClient* http = NULL);
+
 
  private:
   String json_;
@@ -119,9 +133,9 @@ class FirebasePush : public FirebaseCall {
  public:
   FirebasePush() {}
   FirebasePush(const String& host, const String& auth,
-               const String& path, const String& value, HTTPClient* http = NULL);
+               const String& path, const String& value, FirebaseHttpClient* http = NULL);
 
-  const String& name() const {
+  virtual const String& name() const {
     return name_;
   }
 
@@ -133,18 +147,18 @@ class FirebaseRemove : public FirebaseCall {
  public:
   FirebaseRemove() {}
   FirebaseRemove(const String& host, const String& auth,
-                 const String& path, HTTPClient* http = NULL);
+                 const String& path, FirebaseHttpClient* http = NULL);
 };
 
 
 class FirebaseStream : public FirebaseCall {
  public:
   FirebaseStream() {}
   FirebaseStream(const String& host, const String& auth,
-                 const String& path, HTTPClient* http = NULL);
+                 const String& path, FirebaseHttpClient* http = NULL);
 
   // Return if there is any event available to read.
-  bool available();
+  virtual bool available();
 
   // Event type.
   enum Event {
@@ -153,8 +167,21 @@ class FirebaseStream : public FirebaseCall {
     PATCH
   };
 
+  static inline String EventToName(Event event) {
+    switch(event)  {
+      case UNKNOWN:
+        return "UNKNOWN";
+      case PUT:
+        return "PUT";
+      case PATCH:
+        return "PATCH";
+      default:
+        return "INVALID_EVENT_" + event;
+    }
+  }
+
   // Read next json encoded `event` from stream.
-  Event read(String& event);  
+  virtual Event read(String& event);
 
   const FirebaseError& error() const {
     return _error;