Migrate to Firebase SDK

JoinfluxFirebaseRemoteConfig.podspec

@@ -0,0 +1,18 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(File.dirname(__FILE__), 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'JoinfluxFirebaseRemoteConfig'
+  s.version = package['version']
+  s.summary = package['description']
+  s.license = package['license']
+  s.homepage = package['repository']['url']
+  s.author = package['author']
+  s.source = { :git => package['repository']['url'], :tag => s.version.to_s }
+  s.source_files = 'ios/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}'
+  s.ios.deployment_target  = '11.0'
+  s.dependency 'Capacitor'
+  s.static_framework = true
+  s.dependency 'Firebase/RemoteConfig'
+end

README.md

@@ -1,27 +1,19 @@
 # Capacitor Firebase Remote Config Plugin
 
-Capacitory community plugin for firebase remote config.
-
-## Maintainers
-
-| Maintainer    | GitHub                                      | Social                                           | Sponsoring Company |
-| ------------- | ------------------------------------------- | ------------------------------------------------ | ------------------ |
-| Priyank Patel | [priyankpat](https://github.com/priyankpat) | [@priyankpat\_](https://twitter.com/priyankpat_) | Ionic              |
-
-Mainteinance Status: Actively Maintained
+Capacitor community plugin for firebase remote config.
 
 ## Installation
 
 To use npm
 
 ```bash
-npm install @capacitor-community/firebase-remote-config
+npm install @joinflux/firebase-remote-config
 ```
 
 To use yarn
 
 ```bash
-yarn add @capacitor-community/firebase-remote-config
+yarn add @joinflux/firebase-remote-config
 ```
 
 Sync native files
@@ -61,51 +53,43 @@ public class MainActivity extends BridgeActivity {
 
 ## Configuration
 
-Download appropriate google-services.json or GoogleService-Info.plist and place it in the correct platform app directory.
+Download appropriate google-services.json or GoogleService-Info.plist and place
+it in the correct platform app directory.
 
 **For Android**: /android/app
 
 **For iOS**: /ios/App/App
 
-## Examples
-
-[Click here](https://github.com/priyankpat/capacitor-plugins-example/tree/firebase-remote-config) for example on how to implement this plugin
-
-You can also clone the repository
-
-```bash
-git clone https://github.com/priyankpat/capacitor-plugins-example
-git checkout -b firebase-remote-config
-```
-
 ## Supported methods
 
-| Name                | Android | iOS | Web |
-| :------------------ | :------ | :-- | :-- |
-| initializeFirebase  | ❌      | ❌  | ✅  |
-| setDefaultWebConfig | ❌      | ❌  | ✅  |
-| initialize          | ✅      | ✅  | ✅  |
-| fetch               | ✅      | ✅  | ✅  |
-| activate            | ✅      | ✅  | ✅  |
-| fetchAndActivate    | ✅      | ✅  | ✅  |
-| getBoolean          | ✅      | ✅  | ✅  |
-| getByteArray        | ✅      | ✅  | ✅  |
-| getNumber           | ✅      | ✅  | ✅  |
-| getString           | ✅      | ✅  | ✅  |
+| Name               | Android | iOS | Web |
+| :----------------- | :------ | :-- | :-- |
+| initializeFirebase | ✅      | ✅  | ✅  |
+| setDefaultConfig   | ✅      | ✅  | ✅  |
+| initialize         | ✅      | ✅  | ✅  |
+| fetch              | ✅      | ✅  | ✅  |
+| activate           | ✅      | ✅  | ✅  |
+| fetchAndActivate   | ✅      | ✅  | ✅  |
+| getBoolean         | ✅      | ✅  | ✅  |
+| getByteArray       | ✅      | ✅  | ✅  |
+| getNumber          | ✅      | ✅  | ✅  |
+| getString          | ✅      | ✅  | ✅  |
 
 ## Usage
 
 ```typescript
 // Must import the package once to make sure the web support initializes
-import "@capacitor-community/firebase-remote-config";
+import "@joinflux/firebase-remote-config";
 
 import { Plugins } from "@capacitor/core";
 
 const { FirebaseRemoteConfig } = Plugins;
 
 /**
- * NOTE: Web Platform only!
- * This method will initialize firebase app if not yet initialized.
+ * This method will initialize firebase app if not yet initialized. Note that it
+ * is safe to call but does nothing in iOS or Android as initialization is
+ * automatic on load.
+ *
  * @param firebase configs - from google-service.json or GoogleService-Info.plist
  * @returns void
  */
@@ -121,18 +105,22 @@ FirebaseRemoteConfig.initializeFirebase({
 });
 
 /**
- * NOTE: Web Platform only!
- * This method will set default remote config values.
+ * This method will set default remote config values. On Web, it will read from
+ * the parameters give. On Android and iOS it will use the build in mechanisms
+ * and ignore any parameters supplied.
+ *
  * @param options - key/value params with default values
  * @returns void
  */
-FirebaseRemoteConfig.setDefaultWebConfig({
+FirebaseRemoteConfig.setDefaultConfig({
   has_sale: false,
   event_name: "clearance_event",
 });
 
 /**
- * This method will configure remote config object instance and set the minimum fetch interval to allow for frequest refreshes.
+ * This method will configure remote config object instance and set the minimum
+ * fetch interval to allow for frequest refreshes.
+ *
  * @param minimumFetchIntervalInSeconds - interval in seconds (default: 3600)
  * @returns void
  */
@@ -149,13 +137,16 @@ FirebaseRemoteConfig.fetch();
 
 /**
  * This method will activate the fetched values making it available for your app
+ *
  * @param none
  * @returns void
  */
 FirebaseRemoteConfig.activate();
 
 /**
- * This method will fetch and activate the values making it available for your app
+ * This method will fetch and activate the values making it available for your
+ * app
+ *
  * @param none
  * @returns void
  */

android/src/main/java/com/getcapacitor/community/firebaserc/FirebaseRemoteConfig.java

@@ -33,22 +33,6 @@ public void load() {
 
     this.mFirebaseRemoteConfig =
       com.google.firebase.remoteconfig.FirebaseRemoteConfig.getInstance();
-
-    String fileName = bridge
-      .getActivity()
-      .getPreferences(Context.MODE_PRIVATE)
-      .getString("FirebaseRemoteConfigDefaults", "");
-    if (fileName.isEmpty()) {
-      this.mFirebaseRemoteConfig.setDefaultsAsync(
-          Collections.<String, Object>emptyMap()
-        );
-    } else {
-      Context context = bridge.getActivity().getApplicationContext();
-      int resourceId = context
-        .getResources()
-        .getIdentifier(fileName, "xml", context.getPackageName());
-      this.mFirebaseRemoteConfig.setDefaultsAsync(resourceId);
-    }
   }
 
   @PluginMethod
@@ -72,9 +56,9 @@ public void onComplete(@NonNull Task<Void> task) {
             if (task.isSuccessful()) {
               call.success();
             } else if (task.isCanceled()) {
-              call.error(task.getException().getMessage());
+              call.reject(task.getException().getMessage());
             } else {
-              call.error(task.getException().getMessage());
+              call.reject(task.getException().getMessage());
             }
           }
         }
@@ -93,9 +77,9 @@ public void onComplete(@NonNull Task<Boolean> task) {
             if (task.isSuccessful()) {
               call.success();
             } else if (task.isCanceled()) {
-              call.error(task.getException().getMessage());
+              call.reject(task.getException().getMessage());
             } else {
-              call.error(task.getException().getMessage());
+              call.reject(task.getException().getMessage());
             }
           }
         }
@@ -114,9 +98,9 @@ public void onComplete(@NonNull Task<Boolean> task) {
             if (task.isSuccessful()) {
               call.success();
             } else if (task.isCanceled()) {
-              call.error(task.getException().getMessage());
+              call.reject(task.getException().getMessage());
             } else {
-              call.error(task.getException().getMessage());
+              call.reject(task.getException().getMessage());
             }
           }
         }
@@ -126,7 +110,7 @@ public void onComplete(@NonNull Task<Boolean> task) {
 
           @Override
           public void onFailure(@NonNull Exception e) {
-            call.error(e.getLocalizedMessage());
+            call.reject(e.getLocalizedMessage());
           }
         }
       );
@@ -142,7 +126,7 @@ public void getBoolean(PluginCall call) {
       result.put("source", getFirebaseRCValue(key).getSource());
       call.success(result);
     } else {
-      call.error(ERROR_MISSING_KEY);
+      call.reject(ERROR_MISSING_KEY);
     }
   }
 
@@ -156,7 +140,7 @@ public void getByteArray(PluginCall call) {
       result.put("source", getFirebaseRCValue(key).getSource());
       call.success(result);
     } else {
-      call.error(ERROR_MISSING_KEY);
+      call.reject(ERROR_MISSING_KEY);
     }
   }
 
@@ -170,7 +154,7 @@ public void getNumber(PluginCall call) {
       result.put("source", getFirebaseRCValue(key).getSource());
       call.success(result);
     } else {
-      call.error(ERROR_MISSING_KEY);
+      call.reject(ERROR_MISSING_KEY);
     }
   }
 
@@ -184,10 +168,37 @@ public void getString(PluginCall call) {
       result.put("source", getFirebaseRCValue(key).getSource());
       call.success(result);
     } else {
-      call.error(ERROR_MISSING_KEY);
+      call.reject(ERROR_MISSING_KEY);
     }
   }
 
+  @PluginMethod
+  public void initializeFirebase(PluginCall call) {
+    call.success();
+  }
+
+  @PluginMethod
+  public void setDefaultConfig(PluginCall call) {
+    String fileName = bridge
+      .getActivity()
+      .getPreferences(Context.MODE_PRIVATE)
+      .getString("FirebaseRemoteConfigDefaults", "");
+
+    if (fileName.isEmpty()) {
+      this.mFirebaseRemoteConfig.setDefaultsAsync(
+          Collections.<String, Object>emptyMap()
+        );
+    } else {
+      Context context = bridge.getActivity().getApplicationContext();
+      int resourceId = context
+        .getResources()
+        .getIdentifier(fileName, "xml", context.getPackageName());
+      this.mFirebaseRemoteConfig.setDefaultsAsync(resourceId);
+    }
+
+    call.success();
+  }
+
   private FirebaseRemoteConfigValue getFirebaseRCValue(String key) {
     return this.mFirebaseRemoteConfig.getValue(key);
   }

ios/Plugin/Plugin.m

@@ -6,10 +6,12 @@
 CAP_PLUGIN(FirebaseRemoteConfig, "FirebaseRemoteConfig",
            CAP_PLUGIN_METHOD(initialize, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(fetch, CAPPluginReturnPromise);
-           CAP_PLUGIN_METHOD(active, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(activate, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(fetchAndActivate, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(getBoolean, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(getString, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(getNumber, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(getByteArray, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(setDefaultConfig, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(initializeFirebase, CAPPluginReturnPromise);
 )