embulk-input-zendesk 0.3.4 → 0.3.5

data/src/test/resources/data/user_event_multiple.json

@@ -0,0 +1,33 @@
+{
+  "data": [
+    {
+      "id": "5c7f31aef8df240001e60bbf",
+      "type": "remove_from_cart",
+      "source": "shopify",
+      "description": "",
+      "authenticated": true,
+      "created_at": "2019-03-06T02:34:22Z",
+      "received_at": "2019-03-06T02:34:22Z",
+      "properties": {
+        "model": 221,
+        "size": 6
+      },
+      "user_id": "123123121232"
+    },
+    {
+      "id": "5c7f31aef8df240001e60b3f",
+      "type": "remove_from_cart2",
+      "source": "shopify",
+      "description": "",
+      "authenticated": true,
+      "created_at": "2019-03-06T02:34:30Z",
+      "received_at": "2019-03-06T02:34:30Z",
+      "properties": {
+        "model": 221,
+        "size": 6
+      },
+      "user_id": "123123121232"
+    }
+  ],
+  "links": null
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: embulk-input-zendesk
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - hieu.duong
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-04-11 00:00:00.000000000 Z
+date: 2019-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -59,45 +59,86 @@ files:
 - gradlew.bat
 - lib/embulk/guess/zendesk.rb
 - lib/embulk/input/zendesk.rb
+- src/main/java/org/embulk/input/zendesk/RecordImporter.java
 - src/main/java/org/embulk/input/zendesk/ZendeskInputPlugin.java
 - src/main/java/org/embulk/input/zendesk/clients/ZendeskRestClient.java
 - src/main/java/org/embulk/input/zendesk/models/AuthenticationMethod.java
 - src/main/java/org/embulk/input/zendesk/models/Target.java
 - src/main/java/org/embulk/input/zendesk/models/ZendeskException.java
+- src/main/java/org/embulk/input/zendesk/services/ZendeskCustomObjectService.java
+- src/main/java/org/embulk/input/zendesk/services/ZendeskNPSService.java
+- src/main/java/org/embulk/input/zendesk/services/ZendeskNormalServices.java
+- src/main/java/org/embulk/input/zendesk/services/ZendeskService.java
 - src/main/java/org/embulk/input/zendesk/services/ZendeskSupportAPIService.java
+- src/main/java/org/embulk/input/zendesk/services/ZendeskUserEventService.java
+- src/main/java/org/embulk/input/zendesk/stream/PagingSpliterator.java
+- src/main/java/org/embulk/input/zendesk/stream/paginator/sunshine/CustomObjectSpliterator.java
+- src/main/java/org/embulk/input/zendesk/stream/paginator/sunshine/SunshineSpliterator.java
+- src/main/java/org/embulk/input/zendesk/stream/paginator/sunshine/UserEventSpliterator.java
+- src/main/java/org/embulk/input/zendesk/stream/paginator/support/OrganizationSpliterator.java
+- src/main/java/org/embulk/input/zendesk/stream/paginator/support/SupportSpliterator.java
+- src/main/java/org/embulk/input/zendesk/stream/paginator/support/UserSpliterator.java
 - src/main/java/org/embulk/input/zendesk/utils/ZendeskConstants.java
 - src/main/java/org/embulk/input/zendesk/utils/ZendeskDateUtils.java
 - src/main/java/org/embulk/input/zendesk/utils/ZendeskUtils.java
-- src/main/java/org/embulk/input/zendesk/utils/ZendeskValidatorUtils.java
+- src/test/java/org/embulk/input/zendesk/TestRecordImporter.java
 - src/test/java/org/embulk/input/zendesk/TestZendeskInputPlugin.java
 - src/test/java/org/embulk/input/zendesk/clients/TestZendeskRestClient.java
+- src/test/java/org/embulk/input/zendesk/services/TestZendeskCustomObjectService.java
+- src/test/java/org/embulk/input/zendesk/services/TestZendeskNPSService.java
+- src/test/java/org/embulk/input/zendesk/services/TestZendeskNormalService.java
 - src/test/java/org/embulk/input/zendesk/services/TestZendeskSupportAPIService.java
+- src/test/java/org/embulk/input/zendesk/services/TestZendeskUserEventService.java
 - src/test/java/org/embulk/input/zendesk/utils/TestZendeskDateUtils.java
 - src/test/java/org/embulk/input/zendesk/utils/TestZendeskUtil.java
-- src/test/java/org/embulk/input/zendesk/utils/TestZendeskValidatorUtils.java
 - src/test/java/org/embulk/input/zendesk/utils/ZendeskPluginTestRuntime.java
 - src/test/java/org/embulk/input/zendesk/utils/ZendeskTestHelper.java
 - src/test/resources/config/base.yml
 - src/test/resources/config/base_validator.yml
 - src/test/resources/config/incremental.yml
 - src/test/resources/config/non-incremental.yml
+- src/test/resources/config/nps.yml
+- src/test/resources/config/object_records.yml
+- src/test/resources/config/relationship_records.yml
+- src/test/resources/config/user_events.yml
 - src/test/resources/config/util.yml
 - src/test/resources/data/client.json
+- src/test/resources/data/duplicate_user.json
+- src/test/resources/data/empty_result.json
 - src/test/resources/data/error_data.json
 - src/test/resources/data/expected/ticket_column.json
 - src/test/resources/data/expected/ticket_column_with_related_objects.json
 - src/test/resources/data/expected/ticket_fields_column.json
 - src/test/resources/data/expected/ticket_metrics_column.json
+- src/test/resources/data/expected/user_events_column.json
+- src/test/resources/data/object_records.json
+- src/test/resources/data/organization.json
+- src/test/resources/data/relationship_records.json
+- src/test/resources/data/scores.json
+- src/test/resources/data/scores_share_same_time_with_next_page.json
+- src/test/resources/data/scores_share_same_time_without_next_page.json
+- src/test/resources/data/simple_organization.json
+- src/test/resources/data/simple_user.json
+- src/test/resources/data/simple_user_event.json
+- src/test/resources/data/ticket_events_share_same_time_with_next_page.json
+- src/test/resources/data/ticket_events_share_same_time_without_next_page.json
+- src/test/resources/data/ticket_events_updated_by_system_records.json
 - src/test/resources/data/ticket_fields.json
 - src/test/resources/data/ticket_metrics.json
+- src/test/resources/data/ticket_share_same_time_with_next_page.json
+- src/test/resources/data/ticket_share_same_time_without_next_page.json
 - src/test/resources/data/ticket_with_related_objects.json
+- src/test/resources/data/ticket_with_updated_by_system_records.json
 - src/test/resources/data/tickets.json
 - src/test/resources/data/tickets_continue.json
+- src/test/resources/data/user_event.json
+- src/test/resources/data/user_event_contain_latter_create_at.json
+- src/test/resources/data/user_event_multiple.json
 - src/test/resources/data/util.json
 - src/test/resources/data/util_page.json
 - classpath/commons-logging-1.2.jar
-- classpath/embulk-input-zendesk-0.3.4.jar
 - classpath/httpcore-4.4.10.jar
+- classpath/embulk-input-zendesk-0.3.5.jar
 - classpath/httpclient-4.5.6.jar
 - classpath/commons-codec-1.10.jar
 homepage: https://github.com/treasure-data/embulk-input-zendesk

data/src/main/java/org/embulk/input/zendesk/utils/ZendeskValidatorUtils.java

@@ -1,79 +0,0 @@
-package org.embulk.input.zendesk.utils;
-
-import org.embulk.config.ConfigException;
-import org.embulk.input.zendesk.ZendeskInputPlugin;
-import org.embulk.input.zendesk.services.ZendeskSupportAPIService;
-import org.embulk.spi.Exec;
-import org.slf4j.Logger;
-
-public class ZendeskValidatorUtils
-{
-    private ZendeskValidatorUtils(){}
-
-    private static final Logger logger = Exec.getLogger(ZendeskValidatorUtils.class);
-
-    public static void validateInputTask(final ZendeskInputPlugin.PluginTask task, final ZendeskSupportAPIService zendeskSupportAPIService)
-    {
-        validateAppMarketPlace(task.getAppMarketPlaceIntegrationName().isPresent(),
-                task.getAppMarketPlaceAppId().isPresent(),
-                task.getAppMarketPlaceOrgId().isPresent());
-        validateCredentials(task);
-        validateIncremental(task);
-    }
-
-    private static void validateCredentials(final ZendeskInputPlugin.PluginTask task)
-    {
-        switch (task.getAuthenticationMethod()) {
-            case OAUTH:
-                if (!task.getAccessToken().isPresent()) {
-                    throw new ConfigException(String.format("access_token is required for authentication method '%s'",
-                            task.getAuthenticationMethod().name().toLowerCase()));
-                }
-                break;
-            case TOKEN:
-                if (!task.getUsername().isPresent() || !task.getToken().isPresent()) {
-                    throw new ConfigException(String.format("username and token are required for authentication method '%s'",
-                            task.getAuthenticationMethod().name().toLowerCase()));
-                }
-                break;
-            case BASIC:
-                if (!task.getUsername().isPresent() || !task.getPassword().isPresent()) {
-                    throw new ConfigException(String.format("username and password are required for authentication method '%s'",
-                            task.getAuthenticationMethod().name().toLowerCase()));
-                }
-                break;
-            default:
-                throw new ConfigException("Unknown authentication method");
-        }
-    }
-
-    private static void validateAppMarketPlace(final boolean isAppMarketIntegrationNamePresent,
-                                        final boolean isAppMarketAppIdPresent,
-                                        final boolean isAppMarketOrgIdPresent)
-    {
-        final boolean isAllAvailable =
-                isAppMarketIntegrationNamePresent && isAppMarketAppIdPresent && isAppMarketOrgIdPresent;
-        final boolean isAllUnAvailable =
-                !isAppMarketIntegrationNamePresent && !isAppMarketAppIdPresent && !isAppMarketOrgIdPresent;
-        // All or nothing needed
-        if (!(isAllAvailable || isAllUnAvailable)) {
-            throw new ConfigException("All of app_marketplace_integration_name, app_marketplace_org_id, " +
-                    "app_marketplace_app_id " +
-                    "are required to fill out for Apps Marketplace API header");
-        }
-    }
-
-    private static void validateIncremental(final ZendeskInputPlugin.PluginTask task)
-    {
-        if (task.getIncremental()) {
-            if (!task.getDedup()) {
-                logger.warn("You've selected to skip de-duplicating records, result may contain duplicated data");
-            }
-
-            if (!ZendeskUtils.isSupportAPIIncremental(task.getTarget()) && task.getStartTime().isPresent()) {
-                logger.warn(String.format("Target: '%s' doesn't support incremental export API. Will be ignored start_time option",
-                        task.getTarget()));
-            }
-        }
-    }
-}

data/src/test/java/org/embulk/input/zendesk/utils/TestZendeskValidatorUtils.java

@@ -1,130 +0,0 @@
-package org.embulk.input.zendesk.utils;
-
-import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
-import org.embulk.config.ConfigSource;
-
-import org.embulk.input.zendesk.ZendeskInputPlugin;
-import org.embulk.input.zendesk.services.ZendeskSupportAPIService;
-
-import org.embulk.spi.InputPlugin;
-import org.embulk.test.TestingEmbulk;
-
-import org.junit.Before;
-import org.junit.Rule;
-import org.junit.Test;
-import org.junit.rules.ExpectedException;
-import org.junit.rules.RuleChain;
-import org.junit.rules.TestRule;
-
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.fail;
-
-import static org.mockito.Mockito.mock;
-
-import java.util.Collections;
-
-public class TestZendeskValidatorUtils
-{
-    private final ExpectedException thrown = ExpectedException.none();
-    private final TestingEmbulk embulk = TestingEmbulk.builder()
-            .registerPlugin(InputPlugin.class, "zendesk", ZendeskInputPlugin.class)
-            .build();
-    public ZendeskPluginTestRuntime runtime = new ZendeskPluginTestRuntime();
-    ConfigSource configSource;
-
-    @Rule
-    @SuppressFBWarnings("URF_UNREAD_PUBLIC_OR_PROTECTED_FIELD")
-    public TestRule chain = RuleChain.outerRule(embulk).around(runtime).around(thrown);
-
-    private ZendeskSupportAPIService zendeskSupportAPIService = mock(ZendeskSupportAPIService.class);
-
-    @Before
-    public void prepare()
-    {
-        configSource = getBaseConfigSource();
-    }
-
-    @Test
-    public void validateCredentialOauthShouldThrowException()
-    {
-        configSource.set("auth_method", "oauth");
-        configSource.remove("access_token");
-        final ZendeskInputPlugin.PluginTask task = configSource.loadConfig(ZendeskInputPlugin.PluginTask.class);
-        assertValidation(task, "access_token is required for authentication method 'oauth'");
-    }
-
-    @Test
-    public void validateCredentialBasicShouldThrowException()
-    {
-        configSource.set("auth_method", "basic");
-        configSource.remove("username");
-        ZendeskInputPlugin.PluginTask task = configSource.loadConfig(ZendeskInputPlugin.PluginTask.class);
-        assertValidation(task, "username and password are required for authentication method 'basic'");
-
-        configSource.set("username", "");
-        configSource.remove("password");
-        task = configSource.loadConfig(ZendeskInputPlugin.PluginTask.class);
-        assertValidation(task, "username and password are required for authentication method 'basic'");
-    }
-
-    @Test
-    public void validateCredentialTokenShouldThrowException()
-    {
-        configSource.set("auth_method", "token");
-        configSource.remove("token");
-        ZendeskInputPlugin.PluginTask task = configSource.loadConfig(ZendeskInputPlugin.PluginTask.class);
-        assertValidation(task, "username and token are required for authentication method 'token'");
-
-        configSource.set("token", "");
-        configSource.remove("username");
-        task = configSource.loadConfig(ZendeskInputPlugin.PluginTask.class);
-        assertValidation(task, "username and token are required for authentication method 'token'");
-    }
-
-    @Test
-    public void validateAppMarketPlaceShouldThrowException()
-    {
-        configSource.remove("app_marketplace_integration_name");
-        ZendeskInputPlugin.PluginTask task = configSource.loadConfig(ZendeskInputPlugin.PluginTask.class);
-        assertValidation(task, "All of app_marketplace_integration_name, app_marketplace_org_id, " +
-                "app_marketplace_app_id " +
-                "are required to fill out for Apps Marketplace API header");
-    }
-
-    @Test
-    public void validateInclude()
-    {
-        configSource.set("target", "ticket_fields");
-        configSource.set("includes", Collections.singletonList("organizations"));
-        final ZendeskInputPlugin.PluginTask task = configSource.loadConfig(ZendeskInputPlugin.PluginTask.class);
-        ZendeskValidatorUtils.validateInputTask(task, zendeskSupportAPIService);
-    }
-
-    @Test
-    public void validateIncremental()
-    {
-        configSource.set("target", "ticket_fields");
-        configSource.set("incremental", true);
-        configSource.set("dedup", false);
-        configSource.set(ZendeskConstants.Field.START_TIME, "");
-
-        final ZendeskInputPlugin.PluginTask task = configSource.loadConfig(ZendeskInputPlugin.PluginTask.class);
-        ZendeskValidatorUtils.validateInputTask(task, zendeskSupportAPIService);
-    }
-
-    private static ConfigSource getBaseConfigSource()
-    {
-        return ZendeskTestHelper.getConfigSource("base_validator.yml");
-    }
-
-    private void assertValidation(final ZendeskInputPlugin.PluginTask task, final String message)
-    {
-        try {
-            ZendeskValidatorUtils.validateInputTask(task, zendeskSupportAPIService);
-            fail("Should not reach here");
-        }
-        catch (final Exception e) {
-            assertEquals(message, e.getMessage());
-        }
-    }
-}