Merge pull request #14 from proppy/firebase-lib

libraries: add wip Firebase client library

Author: proppy

libraries/Firebase/Firebase.cpp

@@ -0,0 +1,86 @@
+//
+// Copyright 2015 Google Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+#include "Firebase.h"
+
+const char* firebaseFingerprint = "C1 56 CD D8 49 A3 7D D2 1D 49 60 7E 0D 59 A7 7C C1 0E 58 D2";
+const uint16_t firebasePort = 443;
+
+FirebaseRoot Firebase;
+
+FirebaseRef::FirebaseRef(FirebaseRoot& root, const String& path) : _root(root), _path(path) {
+}
+
+FirebaseRef& FirebaseRef::root()  {
+  return _root;
+}
+
+String FirebaseRef::set(const String& value) {
+  return _root.buildRequest("PUT", _path, value);
+}
+
+String FirebaseRef::push(const String& value) {
+  return _root.buildRequest("POST", _path, value);
+}
+
+FirebaseRef FirebaseRef::child(const String& key) {
+  return FirebaseRef(_root, _path + "/" + key);
+}
+
+FirebaseRoot::FirebaseRoot() : FirebaseRef(*this, "") {
+}
+
+void FirebaseRoot::begin(const String& host) {
+  _host = host;
+}
+
+void FirebaseRoot::auth(const String& token) {
+  _token = token;
+}
+
+FirebaseRef FirebaseRoot::child(const String& key) {
+  return FirebaseRef(*this, key);
+}
+
+String FirebaseRoot::buildRequest(const String& method, const String& path, const String& data) {
+  String req;
+  req += method + " /" + path + ".json";
+  if (_token.length() > 0) {
+    req += "?auth=" + _token;
+  }
+  req += " HTTP/1.1\r\n";
+  req += "Host: " + _host + "\r\n";
+  req += "User-Agent: Arduino\r\n";
+  req += "Connection: close\r\n";
+  if (data.length()) {
+    req += "Content-Length: ";
+    req += data.length();
+    req += "\r\n\r\n";
+    req += data;
+  }
+  return req;
+}
+
+const char* FirebaseRoot::host() const {
+  return _host.c_str();
+}
+
+uint16_t FirebaseRoot::port() const {
+  return firebasePort;
+}
+
+const char* FirebaseRoot::fingerprint() const {
+  return firebaseFingerprint;
+}

libraries/Firebase/Firebase.h

@@ -0,0 +1,69 @@
+//
+// Copyright 2015 Google Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+// Firebase is an helper library for building Firebase request.
+// TODO(proppy): add value() method for GET.
+// TODO(proppy): add update() method for PATCH.
+// TODO(proppy): add remove() method for DELETE.
+// TODO(proppy): add helper for decoding response.
+#ifndef firebase_h
+#define firebase_h
+
+#include "Arduino.h"
+
+class Client;
+class FirebaseRoot;
+
+// FirebaseRef is a reference in the firebase hierarchy.
+//
+// Methods `set()` and `push()` returns the HTTP request as a raw
+// `String`, the requests then need be sent using an Arduino Wifi,
+// Ethernet or GSM `Client`.
+class FirebaseRef {
+ public:
+  FirebaseRef(FirebaseRoot& root, const String& path);
+  FirebaseRef& root();
+  String set(const String& value);
+  String push(const String& value);
+  FirebaseRef child(const String& key);
+ private:
+  FirebaseRoot& _root;
+  String _path;  
+};
+
+// FirebaseRoot is a root of firebase hierarchy.
+//
+// A global `Firebase` instance is available for convenience, and need
+// to be initialized with the `begin()` and `auth()` methods.
+class FirebaseRoot : public FirebaseRef {
+  friend FirebaseRef;
+ public:
+  FirebaseRoot();
+  void begin(const String& host);
+  void auth(const String& token);
+  const char* host() const;
+  uint16_t port() const;
+  const char* fingerprint() const;
+  FirebaseRef child(const String& key);  
+ private:
+  String buildRequest(const String& method, const String& path, const String& data);
+  String _host;
+  String _token;
+};
+
+extern FirebaseRoot Firebase;
+
+#endif // firebase_h

libraries/Firebase/examples/FirebasePush_ESP8266/FirebasePush_ESP8266.ino

@@ -0,0 +1,48 @@
+// FirebasePush_ESP8266 is a sample that write a timestamp to a firebase
+// everytime it is powered on.
+
+#include <ESP8266WiFi.h>
+#include <WiFiClientSecure.h>
+
+#include <Firebase.h>
+
+#define WIFI_SSID "..."
+#define WIFI_PASSWORD "..."
+#define FIREBASE_HOST "..."
+#define FIREBASE_TOKEN "..."
+
+void setup() {
+  Serial.begin(9600);
+  
+  WiFi.begin(WIFI_SSID, WIFI_PASSWORD);
+  while (WiFi.status() != WL_CONNECTED) {
+    delay(500);
+  }
+  Serial.println(WiFi.localIP());
+
+  Firebase.begin(FIREBASE_HOST);
+  Firebase.auth(FIREBASE_TOKEN);
+
+  WiFiClientSecure wifiClient;
+  if (!wifiClient.connect(Firebase.host(), Firebase.port())) {
+    Serial.print("connected failed");
+  }
+  if (!wifiClient.verify(Firebase.fingerprint(), Firebase.host())) {
+    Serial.println("certificate verification failed");
+    return;
+  }
+
+  String req = Firebase.child("logs").push("{\".sv\": \"timestamp\"}");
+  Serial.println("request:");
+  Serial.println(req);
+  wifiClient.print(req);
+
+  Serial.println("response:");
+  while(wifiClient.connected() || wifiClient.available() > 0) {
+    String data = wifiClient.readStringUntil('\n');
+    Serial.println(data);
+  }  
+}
+
+void loop() {
+}