Integration of Confirmations into Brave Core

* Resolved cpplint issues * Resolved mock build error * Resolved issue with uninitialized vectors * Resolved issue with last page classification not being retained after browser restart * Improved error handling * various cosmetic edits README - include synopsis of stand-alone build instructions event_type_load.h - include tab classification in structure ads_impl.{h,cc} - - move load event to classifier method to get accurate log entries - add GetRegion method for use with brave-core/ui - more logging in classifier method - make adsPerDay a no-op until design/product decides what to do with that feature - more logging for onTimer to see why it fires bundle.cc - fix hierarchy typo mock_ads_client.cc - s/result/status to avoid double definition issue note that client_->GetLastPageClassification is no longer needed * Fixed cpplint issues * Exposed GetRegion * Integration of Confirmations with brave-core
brave-intl · Jan 18, 2019 · 48ad087 · 48ad087
1 parent e44c3e3
commit 48ad087
Show file tree

Hide file tree

Showing 43 changed files with 652 additions and 231 deletions.
diff --git a/BUILD.gn b/BUILD.gn
@@ -71,13 +71,16 @@ source_set("ads") {
     "src/client.cc",
     "src/client_state.cc",
     "src/math_helper.cc",
+    "src/error_helper.cc",
     "src/locale_helper.cc",
     "src/search_providers.cc",
     "src/string_helper.cc",
     "src/time_helper.cc",
     "src/json_helper.cc",
     "src/uri_helper.cc",
     "src/bat/ads/ad_info.cc",
+    "src/bat/ads/issuer_info.cc",
+    "src/bat/ads/issuers_info.cc",
     "src/bat/ads/notification_info.cc",
     "src/bat/ads/client_info.cc",
     "src/bat/ads/url_components.cc",

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -56,7 +56,7 @@ message(STATUS "URI Parser dependency")
 FetchContent_Declare(
   URIParserProject
   GIT_REPOSITORY [email protected]:uriparser/uriparser.git
-  GIT_TAG        master
+  GIT_TAG        uriparser-0.9.0
 )
 
 FetchContent_GetProperties(URIParserProject)
@@ -92,6 +92,8 @@ message(STATUS "BAT Native Ads")
 set(SOURCES
   "${PROJECT_SOURCE_DIR}/src/bat/ads/ad_info.cc"
   "${PROJECT_SOURCE_DIR}/src/bat/ads/client_info.cc"
+  "${PROJECT_SOURCE_DIR}/src/bat/ads/issuer_info.cc"
+  "${PROJECT_SOURCE_DIR}/src/bat/ads/issuers_info.cc"
   "${PROJECT_SOURCE_DIR}/src/bat/ads/notification_info.cc"
   "${PROJECT_SOURCE_DIR}/src/bat/ads/url_components.cc"
   "${PROJECT_SOURCE_DIR}/src/ads.cc"
@@ -105,6 +107,7 @@ set(SOURCES
   "${PROJECT_SOURCE_DIR}/src/client_state.cc"
   "${PROJECT_SOURCE_DIR}/src/json_helper.cc"
   "${PROJECT_SOURCE_DIR}/src/math_helper.cc"
+  "${PROJECT_SOURCE_DIR}/src/error_helper.cc"
   "${PROJECT_SOURCE_DIR}/src/locale_helper.cc"
   "${PROJECT_SOURCE_DIR}/src/search_providers.cc"
   "${PROJECT_SOURCE_DIR}/src/string_helper.cc"

diff --git a/README.md b/README.md
@@ -20,6 +20,12 @@ bundle-schema.json
 
 `catalog-schema.json` and `bundle-schema.json` are JSON Schemas which specify the JSON-based format to define the structure of the JSON data for validation, documentation, and interaction control. It provides the contract for the JSON data and how that data can be modified.
 
+## Build
+
+    mkdir -p build && cd build
+    cmake ..
+    make
+
 ## API
 
 ### Native
@@ -68,7 +74,7 @@ void TabUpdated(
     const int32_t tab_id,
     const std::string& url,
     const bool is_active,
-    const bool is_incognito);
+    const bool is_incognito)
 ```
 
 `TabClosed` should be called to record when a browser tab is closed
@@ -175,11 +181,6 @@ void LoadUserModelForLocale(
 const std::string GenerateUUID() const
 ```
 
-`GetSSID` should return the network SSID or an empty string if not available
-```
-const std::string GetSSID() const
-```
-
 `IsForeground` should return `true` if the browser is in the foreground otherwise returns `false`
 ```
 bool IsForeground() const
@@ -195,14 +196,19 @@ bool IsNotificationsAvailable() const
 void ShowNotification(std::unique_ptr<NotificationInfo> info)
 ```
 
-`CanShowAd` should return `true` if Confirmations is ready to show the ad otherwise returns `false`
+`SetCatalogIssuers` should notify that the catalog issuers have changed
 ```
-bool CanShowAd(const AdInfo& ad_info)
+  void SetCatalogIssuers(std::unique_ptr<IssuersInfo> info)
+```
+
+`IsConfirmationsReadyToShowAds` should return `true` if Confirmations is ready to show ads otherwise returns `false`
+```
+bool IsConfirmationsReadyToShowAds()
 ```
 
 `AdSustained` should be called to inform Confirmations that an ad was sustained
 ```
-void AdSustained(const AdInfo& ad_info)
+void AdSustained(std::unique_ptr<NotificationInfo> info)
 ```
 
 `SetTimer` should create a timer to trigger after the time offset specified in seconds. If the timer was created successfully a unique identifier should be returned, otherwise returns `0`
@@ -215,12 +221,6 @@ uint32_t SetTimer(const uint64_t time_offset)
 void KillTimer(uint32_t timer_id)
 ```
 
-`OnCatalogIssuersChanged` should notify that the catalog issuers have changed
-```
-  void OnCatalogIssuersChanged(
-      const std::vector<IssuerInfo>& issuers);
-```
-
 `URLRequest` should start a URL request
 ```
 void URLRequest(

diff --git a/include/bat/ads/ad_info.h b/include/bat/ads/ad_info.h
@@ -9,6 +9,7 @@
 #include <vector>
 
 #include "bat/ads/export.h"
+#include "bat/ads/result.h"
 
 namespace ads {
 
@@ -18,7 +19,9 @@ struct ADS_EXPORT AdInfo {
   ~AdInfo();
 
   const std::string ToJson() const;
-  bool FromJson(const std::string& json);
+  Result FromJson(
+      const std::string& json,
+      std::string* error_description = nullptr);
 
   std::string creative_set_id;
   std::string campaign_id;

diff --git a/include/bat/ads/ads.h b/include/bat/ads/ads.h
@@ -75,6 +75,9 @@ class ADS_EXPORT Ads {
   // Should be called to remove all cached history
   virtual void RemoveAllHistory() = 0;
 
+  // Should be called to get the region, i.e. US
+  virtual std::string GetRegion() = 0;
+
   // Should be called when the user changes the operating system's locale, i.e.
   // en, en_US or en_GB.UTF-8 unless the operating system restarts the app
   virtual void ChangeLocale(const std::string& locale) = 0;

diff --git a/include/bat/ads/ads_client.h b/include/bat/ads/ads_client.h
@@ -14,12 +14,13 @@
 #include <functional>
 
 #include "bat/ads/ad_info.h"
-#include "bat/ads/issuer_info.h"
+#include "bat/ads/issuers_info.h"
 #include "bat/ads/bundle_state.h"
 #include "bat/ads/client_info.h"
 #include "bat/ads/export.h"
 #include "bat/ads/notification_info.h"
 #include "bat/ads/url_components.h"
+#include "bat/ads/result.h"
 
 namespace ads {
 
@@ -35,11 +36,6 @@ enum ADS_EXPORT URLRequestMethod {
   POST = 2
 };
 
-enum ADS_EXPORT Result {
-  SUCCESS,
-  FAILED
-};
-
 class ADS_EXPORT LogStream {
  public:
   virtual ~LogStream() = default;
@@ -110,12 +106,15 @@ class ADS_EXPORT AdsClient {
   // Should show a notification
   virtual void ShowNotification(std::unique_ptr<NotificationInfo> info) = 0;
 
+  // Should notify that the catalog issuers have changed
+  virtual void SetCatalogIssuers(std::unique_ptr<IssuersInfo> info) = 0;
+
   // Should return true if Confirmations is ready to show ad otherwise returns
   // false
-  virtual bool CanShowAd(const AdInfo& ad_info) = 0;
+  virtual bool IsConfirmationsReadyToShowAds() = 0;
 
   // Should be called to inform Confirmations that an ad was sustained
-  virtual void AdSustained(const NotificationInfo& info) = 0;
+  virtual void AdSustained(std::unique_ptr<NotificationInfo> info) = 0;
 
   // Should create a timer to trigger after the time offset specified in
   // seconds. If the timer was created successfully a unique identifier should
@@ -125,10 +124,6 @@ class ADS_EXPORT AdsClient {
   // Should destroy the timer associated with the specified timer identifier
   virtual void KillTimer(uint32_t timer_id) = 0;
 
-  // Should notify that the catalog issuers have changed
-  virtual void OnCatalogIssuersChanged(
-      const std::vector<IssuerInfo>& issuers) = 0;
-
   // Should start a URL request
   virtual void URLRequest(
       const std::string& url,

diff --git a/include/bat/ads/bundle_state.h b/include/bat/ads/bundle_state.h
@@ -19,7 +19,10 @@ struct BundleState {
   ~BundleState();
 
   const std::string ToJson() const;
-  bool FromJson(const std::string& json, const std::string& jsonSchema);
+  Result FromJson(
+      const std::string& json,
+      const std::string& json_schema,
+      std::string* error_description = nullptr);
 
   std::string catalog_id;
   uint64_t catalog_version;

diff --git a/include/bat/ads/client_info.h b/include/bat/ads/client_info.h
@@ -9,6 +9,7 @@
 
 #include "bat/ads/export.h"
 #include "bat/ads/client_info_platform_type.h"
+#include "bat/ads/result.h"
 
 namespace ads {
 
@@ -18,7 +19,9 @@ struct ADS_EXPORT ClientInfo {
   ~ClientInfo();
 
   const std::string ToJson() const;
-  bool FromJson(const std::string& json);
+  Result FromJson(
+      const std::string& json,
+      std::string* error_description = nullptr);
 
   const std::string GetPlatformName() const;
 

diff --git a/include/bat/ads/issuer_info.h b/include/bat/ads/issuer_info.h
@@ -7,22 +7,14 @@
 
 #include <string>
 
-namespace ads {
-
-struct IssuerInfo {
-  IssuerInfo() :
-      name(""),
-      public_key("") {}
+#include "bat/ads/export.h"
 
-  explicit IssuerInfo(const std::string& public_key) :
-      name(""),
-      public_key(public_key) {}
-
-  IssuerInfo(const IssuerInfo& info) :
-      name(info.name),
-      public_key(info.public_key) {}
+namespace ads {
 
-  ~IssuerInfo() {}
+struct ADS_EXPORT IssuerInfo {
+  IssuerInfo();
+  IssuerInfo(const IssuerInfo& info);
+  ~IssuerInfo();
 
   std::string name;
   std::string public_key;

diff --git a/include/bat/ads/issuers_info.h b/include/bat/ads/issuers_info.h
@@ -0,0 +1,33 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#ifndef BAT_ADS_ISSUERS_INFO_H_
+#define BAT_ADS_ISSUERS_INFO_H_
+
+#include <string>
+#include <vector>
+
+#include "bat/ads/export.h"
+#include "bat/ads/issuer_info.h"
+#include "bat/ads/result.h"
+
+namespace ads {
+
+struct ADS_EXPORT IssuersInfo {
+  IssuersInfo();
+  IssuersInfo(const IssuersInfo& info);
+  ~IssuersInfo();
+
+  const std::string ToJson() const;
+  Result FromJson(
+      const std::string& json,
+      std::string* error_description = nullptr);
+
+  std::string public_key;
+  std::vector<IssuerInfo> issuers;
+};
+
+}  // namespace ads
+
+#endif  // BAT_ADS_ISSUERS_INFO_H_
diff --git a/include/bat/ads/notification_info.h b/include/bat/ads/notification_info.h
@@ -8,6 +8,7 @@
 #include <string>
 
 #include "bat/ads/export.h"
+#include "bat/ads/result.h"
 
 namespace ads {
 
@@ -17,7 +18,9 @@ struct ADS_EXPORT NotificationInfo {
   ~NotificationInfo();
 
   const std::string ToJson() const;
-  bool FromJson(const std::string& json);
+  Result FromJson(
+      const std::string& json,
+      std::string* error_description = nullptr);
 
   std::string creative_set_id;
   std::string category;

diff --git a/include/bat/ads/result.h b/include/bat/ads/result.h
@@ -0,0 +1,19 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#ifndef BAT_ADS_RESULT_H_
+#define BAT_ADS_RESULT_H_
+
+#include "bat/ads/export.h"
+
+namespace ads {
+
+enum ADS_EXPORT Result {
+  SUCCESS,
+  FAILED
+};
+
+}  // namespace ads
+
+#endif  // BAT_ADS_RESULT_H_
diff --git a/include/bat/ads/url_components.h b/include/bat/ads/url_components.h
@@ -8,6 +8,7 @@
 #include <string>
 
 #include "bat/ads/export.h"
+#include "bat/ads/result.h"
 
 namespace ads {
 
@@ -17,7 +18,9 @@ struct ADS_EXPORT UrlComponents {
   ~UrlComponents();
 
   const std::string ToJson() const;
-  bool FromJson(const std::string& json);
+  Result FromJson(
+      const std::string& json,
+      std::string* error_description = nullptr);
 
   std::string url;
   std::string scheme;