Core functionality

Author: dgrinenko

docs/SendGrid-batchsource.md

@@ -2,21 +2,22 @@
 
 Description
 -----------
-This plugin used to query SendGrid v3 API.
-
+Plugin fetches data from SendGrid. SendGrid is a cloud-based service that assists businesses with email delivery. For 
+the end user SendGrid provides information about existing Marketing Campaigns, Email Analytics, Bounces, Spam Reports.
+ 
 Properties
 ----------
 ### General
 
 **Reference Name:** Name used to uniquely identify this source for lineage, annotating metadata, etc.
 
-**Authentication type:** The way, how user would like to be authenticated to the SendGrid acoount
+**Authentication type:** The way, how user would like to be authenticated to the SendGrid account
 
 **API Key:** The SendGrid API Key taken from the SendGrid account
 
-**Username:** Login name for SendGrid
+**Username:** Login name for the SendGrid account
 
-**Password:** Login password for the username specified above
+**Password:** Password for the SendGrid account
 
 **Data Source Types:** List of data source groups
 
@@ -25,7 +26,7 @@ Available:
 - Stats Fields
 - Suppressions Fields
 
-**Data Source:** One of the above sources picked from list
+**Data Source:**  SendGrid source object
 
 Available:
 - Marketing Campaigns Fields
@@ -42,7 +43,18 @@ Available:
   - Bounces
   - Global Unsubscribes
   - Group Unsubscribes
-**Data Source Fields:** 
+  
+**Data Source Fields:** The list of fields available for the retrieval
+
+- *Automation:* id, name, status, type, message_count, created_at, updated_at, live_at
+- *SingleSends:* id, name, status, created_at, updated_at,
+- *Senders:* id, nickname, address, address_2, city, country, state, zip, locked, created_at, updated_at, from(email, name), verified(status, reason), reply_to(name, email)
+- *Contacts:* id, first_name, last_name, list_ids, created_at, updated_at, email, Segments, id, name, parent_list_id, created_at, updated_at, sample_updated_at, contacts_count
+- *GlobalStats:* date ,blocks ,bounce_drops ,bounces ,clicks ,deferred ,invalid_emails ,opens ,processed ,requests ,spam_report_drops ,spam_reports ,unique_clicks ,unique_opens ,unsubscribe_drops ,unsubscribes
+- *CategoryStats:* name, type, date, blocks, bounce_drops, bounces, clicks, deferred, delivered, invalid_emails, opens, processed, requests, spam_report_drops, spam_reports, unique_clicks, unique_opens, unsubscribe_drops, unsubscribes
+- *AdvancedStats:* name, type, date, clicks, opens, unique_clicks, unique_opens
+- *Bounces:* created, email, reason, status
+- *GroupUnsubscribes:* id ,name ,description ,is_default ,last_email_send_at ,unsubscribes
 
 **Start Date:** The date in format YYYY-MM-DD, starting from which the data is requested
 

pom.xml

@@ -28,13 +28,29 @@
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <cdap.version>6.1.0-SNAPSHOT</cdap.version>
-        <cdap.plugin.version>2.2.0-SNAPSHOT</cdap.plugin.version>
-        <hadoop.version>2.3.0</hadoop.version>
-        <hydrator.version>2.2.0</hydrator.version>
+        <hadoop.version>2.8.0</hadoop.version>
+        <hydrator.version>2.3.0-SNAPSHOT</hydrator.version>
         <gson.version>2.2.4</gson.version>
         <common.logging.version>1.2</common.logging.version>
     </properties>
 
+    <repositories>
+        <repository>
+            <id>sonatype</id>
+            <url>https://oss.sonatype.org/content/groups/public</url>
+        </repository>
+        <repository>
+            <id>sonatype-snapshots</id>
+            <url>https://oss.sonatype.org/content/repositories/snapshots</url>
+        </repository>
+    </repositories>
+    <pluginRepositories>
+        <pluginRepository>
+            <id>sonatype</id>
+            <url>https://oss.sonatype.org/content/groups/public/</url>
+        </pluginRepository>
+    </pluginRepositories>
+
 
     <dependencies>
         <dependency>
@@ -84,7 +100,7 @@
         <dependency>
             <groupId>io.cdap.plugin</groupId>
             <artifactId>hydrator-common</artifactId>
-            <version>${cdap.plugin.version}</version>
+            <version>${hydrator.version}</version>
         </dependency>
         <dependency>
             <groupId>org.apache.hadoop</groupId>
@@ -213,11 +229,7 @@
                <extensions>true</extensions>
                <configuration>
                    <instructions>
-                       <_exportcontents>
-                           io.cdap.plugin.*;
-                           org.apache.commons.lang;
-                           org.apache.commons.logging.*;
-                       </_exportcontents>
+                       <_exportcontents>io.cdap.plugin.sendgrid.*</_exportcontents>
                        <Embed-Dependency>*;inline=false;scope=compile</Embed-Dependency>
                        <Embed-Transitive>true</Embed-Transitive>
                        <Embed-Directory>lib</Embed-Directory>

src/main/java/io/cdap/plugin/sendgrid/common/APIResponseType.java

@@ -0,0 +1,38 @@
+/*
+ * Copyright © 2019 Cask Data, 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.
+ */
+
+package io.cdap.plugin.sendgrid.common;
+
+/**
+ * The way, how SendGrid API return the objects
+ *
+ */
+public enum APIResponseType {
+  /**
+   * Objects come to the response as part of the list
+   */
+  LIST,
+
+  /**
+   * Objects come as part of wrapper, which consists from the metadata and the result
+   */
+  RESULT,
+
+  /**
+   * Same as {@link APIResponseType#RESULT}
+   */
+  RESULTS
+}