Merge pull request #2 from emailjs-com/EJS-424-sdk-v4

SDK v4

Author: xr0master

.gitignore

@@ -29,3 +29,5 @@ migrate_working_dir/
 .packages
 build/
 coverage/
+.flutter-*
+CRIB.md

CHANGELOG.md

@@ -1,29 +1,42 @@
+## 4.0.0
+
+- The flutter version of the SDK packages has been adjusted to global version 4. The SDK has been completely refactored. New data validation has been added to avoid wasting quota. A set of new tests has been added. Improved test code coverage.
+
+- Added [blockList option](https://www.emailjs.com/docs/sdk/options/#blocklist) to block requests for unwanted variable values
+- Added [limitrate option](https://www.emailjs.com/docs/sdk/options/#limitrate) to install the throttle. For persistence, the shared_preferences package is used.
+
 ## 1.3.0
-* Fix closed client [issue #1](https://github.com/emailjs-com/emailjs-flutter/issues/1)
+
+- Fix closed client [issue #1](https://github.com/emailjs-com/emailjs-flutter/issues/1)
 
 ## 1.2.1
-* Fix the environment SDK version
+
+- Fix the environment SDK version
 
 ## 1.2.0
-* Update packages
+
+- Update packages
 
 ## 1.1.0
-* Improve README.md
+
+- Improve README.md
 
 ## 1.0.0
-* Add support for the private key
-* Instead of the public key argument, the settings object is passed, where the public and private keys can be set.
-Check out the documentation and examples.
+
+- Add support for the private key
+- Instead of the public key argument, the settings object is passed, where the public and private keys can be set.
+  Check out the documentation and examples.
 
 ## 0.0.3
-* re-format examples code
+
+- re-format examples code
 
 ## 0.0.2
 
-* Score fixes
-* Added examples
-* Dart formatter
+- Score fixes
+- Added examples
+- Dart formatter
 
 ## 0.0.1
 
-* Official EmailJS SDK for Flutter
+- Official EmailJS SDK for Flutter

README.md

@@ -9,6 +9,7 @@ Use you EmailJS account for sending emails.
 This is a flutter-only version, otherwise use
 - [Browser SDK](https://www.npmjs.com/package/@emailjs/browser)
 - [Node.js SDK](https://www.npmjs.com/package/@emailjs/nodejs)
+- [React Native SDK](https://www.npmjs.com/package/@emailjs/react-native)
 - [REST API](https://www.emailjs.com/docs/rest-api/send/)
 
 ## Links
@@ -18,7 +19,7 @@ This is a flutter-only version, otherwise use
 ## Intro
 
 EmailJS helps to send emails directly from your code.
-No large knowledge is required – just connect EmailJS to one of the supported
+No server is required – just connect EmailJS to one of the supported
 email services, create an email template, and use our SDK
 to trigger an email.
 
@@ -44,47 +45,47 @@ through [Account:Security](https://dashboard.emailjs.com/admin/account/security)
 **send email**
 
 ```dart 
-import package:emailjs/emailjs.dart
+import package:emailjs/emailjs.dart as emailjs
 
 Map<String, dynamic> templateParams = {
   'name': 'James',
   'notes': 'Check this out!'
 };
 
 try {
-  await EmailJS.send(
-    '<YOUR_SERVICE_ID>',
-    '<YOUR_TEMPLATE_ID>',
+  await emailjs.send(
+    'YOUR_SERVICE_ID',
+    'YOUR_TEMPLATE_ID',
     templateParams,
-    const Options(
-      publicKey: '<YOUR_PUBLIC_KEY>',
-      privateKey: '<YOUR_PRIVATE_KEY>',
+    const emailjs.Options(
+      publicKey: 'YOUR_PUBLIC_KEY',
+      privateKey: 'YOUR_PRIVATE_KEY',
     ),
   );
   print('SUCCESS!');
 } catch (error) {
-  print(error.toString());
+  print('$error');
 }
 ```
 
 **init (optional)**
 ```dart 
-import package:emailjs/emailjs.dart
+import package:emailjs/emailjs.dart as emailjs
 
 // set Public Key as global settings
-EmailJS.init(const Options(
-  publicKey: '<YOUR_PUBLIC_KEY>',
-  privateKey: '<YOUR_PRIVATE_KEY>',
+emailjs.init(const emailjs.Options(
+  publicKey: 'YOUR_PUBLIC_KEY',
+  privateKey: 'YOUR_PRIVATE_KEY',
 ));
 
 try {
   // send the email without dynamic variables
-  await EmailJS.send(
-    '<YOUR_SERVICE_ID>',
-    '<YOUR_TEMPLATE_ID>',
+  await emailjs.send(
+    'YOUR_SERVICE_ID',
+    'YOUR_TEMPLATE_ID',
   );
   print('SUCCESS!');
 } catch (error) {
-  print(error.toString());
+  print('$error');
 }
 ```

example/lib/main.dart

@@ -1,5 +1,5 @@
 import 'package:flutter/material.dart';
-import 'package:emailjs/emailjs.dart';
+import 'package:emailjs/emailjs.dart' as emailjs;
 
 void main() {
   runApp(const App());
@@ -31,22 +31,25 @@ class HomePage extends StatefulWidget {
 class _HomePageState extends State<HomePage> {
   void _sendEmail() async {
     try {
-      await EmailJS.send(
-        '<YOUR_SERVICE_ID>',
-        '<YOUR_TEMPLATE_ID>',
+      await emailjs.send(
+        'YOUR_SERVICE_ID',
+        'YOUR_TEMPLATE_ID',
         {
-          'user_email': 'hi@example.com',
+          'to_email': 'hi@example.com',
           'message': 'Hi',
         },
-        const Options(
-          publicKey: '<YOUR_PUBLIC_KEY>',
-          privateKey: '<YOUR_PRIVATE_KEY>',
-        ),
+        const emailjs.Options(
+            publicKey: 'YOUR_PUBLIC_KEY',
+            privateKey: 'YOUR_PRIVATE_KEY',
+            limitRate: const emailjs.LimitRate(
+              id: 'app',
+              throttle: 10000,
+            )),
       );
       print('SUCCESS!');
     } catch (error) {
-      if (error is EmailJSResponseStatus) {
-        print('ERROR... ${error.status}: ${error.text}');
+      if (error is emailjs.EmailJSResponseStatus) {
+        print('ERROR... $error');
       }
       print(error.toString());
     }

lib/emailjs.dart

@@ -1,71 +1,9 @@
 library emailjs;
 
-import 'dart:convert';
-import 'package:http/http.dart' as http;
-
-import 'src/models/emailjs_response_status.dart';
-import 'src/utils/validate_params.dart';
-import 'src/api/send_json.dart';
-import 'src/models/options.dart';
-
 export 'src/models/emailjs_response_status.dart';
+export 'src/models/storage_provider.dart';
 export 'src/models/options.dart';
-
-class EmailJS {
-  /// Public Key specified in the [init] method
-  static String _publicKey = '';
-
-  /// Private Key specified in the [init] method
-  static String? _privateKey;
-
-  /// API host specified in the [init] method
-  static String _host = 'api.emailjs.com';
-
-  /// HTTP Client specified in the [init] method
-  static http.Client? _httpClient;
-
-  /// Global configuration for EmailJS
-  ///
-  /// Sets globally the EmailJS [options]
-  static void init(
-    Options options, [
-    String? host,
-    http.Client? customHttpClient,
-  ]) {
-    EmailJS._publicKey = options.publicKey;
-    EmailJS._privateKey = options.privateKey;
-    EmailJS._host = host ?? 'api.emailjs.com';
-    EmailJS._httpClient = customHttpClient;
-  }
-
-  /// Sends the email through the [serviceID] using the ready-made [templateID].
-  ///
-  /// It's possible to pass [templatePrams] dynamic variables,
-  /// and set the [options] for this call.
-  static Future<EmailJSResponseStatus> send(
-    String serviceID,
-    String templateID, [
-    Map<String, dynamic>? templatePrams,
-    Options? options,
-  ]) async {
-    final pubKey = options?.publicKey ?? EmailJS._publicKey;
-    final prKey = options?.privateKey ?? EmailJS._privateKey;
-
-    validateParams(pubKey, serviceID, templateID);
-
-    final Map<String, dynamic> params = {
-      'lib_version': '1.3.0',
-      'user_id': pubKey,
-      'accessToken': prKey,
-      'service_id': serviceID,
-      'template_id': templateID,
-      'template_params': templatePrams,
-    };
-
-    return await sendJSON(
-      Uri.https(EmailJS._host, 'api/v1.0/email/send'),
-      json.encode(params),
-      EmailJS._httpClient,
-    );
-  }
-}
+export 'src/models/block_list.dart';
+export 'src/models/limit_rate.dart';
+export 'src/methods/init.dart';
+export 'src/methods/send.dart';

lib/src/api/send_json.dart

@@ -0,0 +1,35 @@
+import 'package:http/http.dart';
+import '../store/store.dart';
+import '../models/emailjs_response_status.dart';
+
+/// sends JSON object via HTTPS POST
+Future<EmailJSResponseStatus> sendPost(
+  String url,
+  String data, [
+  Client? client,
+]) async {
+  client ??= Client();
+
+  try {
+    final response = await client.post(
+      Uri.https(store.host, url),
+      headers: {
+        'Content-Type': 'application/json',
+      },
+      body: data,
+    );
+
+    final responseStatus = EmailJSResponseStatus(
+      status: response.statusCode,
+      text: response.body,
+    );
+
+    if (response.statusCode == 200) {
+      return responseStatus;
+    } else {
+      throw responseStatus;
+    }
+  } finally {
+    client.close();
+  }
+}

lib/src/api/send_post.dart

@@ -0,0 +1,8 @@
+import '../models/emailjs_response_status.dart';
+
+EmailJSResponseStatus blockedEmailError() {
+  return const EmailJSResponseStatus(
+    status: 403,
+    text: 'Forbidden',
+  );
+}

lib/src/errors/blocked_email_error.dart

@@ -0,0 +1,8 @@
+import '../models/emailjs_response_status.dart';
+
+EmailJSResponseStatus limitRateError() {
+  return const EmailJSResponseStatus(
+    status: 429,
+    text: 'Too Many Requests',
+  );
+}

lib/src/errors/limit_rate_error.dart

@@ -0,0 +1,18 @@
+import 'package:http/http.dart';
+import '../models/options.dart';
+import '../store/store.dart';
+
+/// Global configuration for EmailJS
+///
+/// Sets globally the EmailJS [options]
+void init(Options options, [Client? client]) {
+  store.publicKey = options.publicKey;
+  store.privateKey = options.privateKey;
+  store.blockList = options.blockList;
+  store.limitRate = options.limitRate;
+  store.storageProvider = options.storageProvider;
+  store.origin = options.origin;
+
+  // for testing porpose
+  store.client = client;
+}