embulk-input-zendesk 0.2.9 → 0.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64f55acf87cf55a85fcb254b2f894dc1ff87df89
-  data.tar.gz: 6212020f5b1b5e2b9b7bbc989eaad0cc45b275e7
+  metadata.gz: a0187b06702508e3aa734155601f2ac61bfa9456
+  data.tar.gz: 0978a2745e336986fc17c57796a77f271439ba4a
 SHA512:
-  metadata.gz: c340a0cbda23f8ffdd7b2ea8c68cdc5c1db63d9b045b5b4fe034830e5fd2b020791075cea69f526b6c425ce73e338d4ad7267c1beeb30dbfb326ce3e36d09e9d
-  data.tar.gz: 44fb974d6c961580ee72cba9baa3792a780719696ab72cf2980235944ba807f1ac16bd03e7a1b86d86ae9f3ec37fe1ec0f1996cb7f275fa7be54255866fd3697
+  metadata.gz: 5b19b4372816708a26d2110a823a3fba165fd066ab650f85002d3751ae9efb3f3b3e6eb9163f2a1eca976f9c31ccae00edf760da7216a6c017d8f78a775abb79
+  data.tar.gz: 374a88e38e1ab5469f66500aab6fd2be1f9fead2ea21358698ad8458d5ea26df88eea4ae4f7fdfffe9cedb4b7e8f0b7cedc91bbe930691ebc666414c559c902e

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.2.10 - 2018-03-26
+* [enhancement] Add Zendesk market place header
+
 ## 0.2.9 - 2017-08-03
 * [fixed] `start_time` is not merged to `query`, causing infinite loop [#42](https://github.com/treasure-data/embulk-input-zendesk/pull/42)
 

data/README.md

@@ -32,7 +32,10 @@ Required Embulk version >= 0.8.1.
 - **retry_limit**: Try to retry this times (integer, default: 5)
 - **retry_initial_wait_sec**: Wait seconds for exponential backoff initial value (integer, default: 4)
 - **incremental**:  If false, `start_time` in next.yml would not be updated that means you always fetch all of data from Zendesk with statically conditions. If true, `start_time` would be updated in next.yml. (bool, default: true)
-
+- **app_marketplace_integration_name**: Invisible to user, only requires to be a part of the Zendesk Apps Marketplace. This should be used to name of the integration.
+- **app_marketplace_org_id**: Invisible to user, only requires to be a part of the Zendesk Apps Marketplace. This should be the Organization ID for your organization from the new developer portal.
+- **app_marketplace_app_id**: Invisible to user, only requires to be a part of the Zendesk Apps Marketplace. This is the “App ID” that will be assigned to you when you submit your app.
+  
 ## Example
 
 ```yaml

data/embulk-input-zendesk.gemspec

@@ -1,7 +1,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "embulk-input-zendesk"
-  spec.version       = "0.2.9"
+  spec.version       = "0.2.10"
   spec.authors       = ["uu59", "muga", "sakama"]
   spec.summary       = "Zendesk input plugin for Embulk"
   spec.description   = "Loads records from Zendesk."

data/lib/embulk/input/zendesk/client.rb

@@ -43,6 +43,7 @@ module Embulk
         def validate_config
           validate_credentials
           validate_target
+          validate_app_marketplace
         end
 
         def validate_credentials
@@ -68,6 +69,15 @@ module Embulk
           end
         end
 
+        def validate_app_marketplace
+          valid = config[:app_marketplace_integration_name] && config[:app_marketplace_org_id] && config[:app_marketplace_app_id]
+          valid = valid || (!config[:app_marketplace_integration_name] && !config[:app_marketplace_org_id] && !config[:app_marketplace_app_id])
+
+          unless valid
+             raise Embulk::ConfigError.new("All of app_marketplace_integration_name, app_marketplace_org_id, app_marketplace_app_id are required to fill out for Apps Marketplace API header")
+          end
+        end
+
         # they have both Incremental API and non-incremental API
         # 170717: `ticket_events` can use standard endpoint format now, ie. `<target>.json`
         %w(tickets ticket_events users organizations).each do |target|
@@ -255,9 +265,18 @@ module Embulk
           u = URI.parse(config[:login_url])
           u.path = path
 
+          # https://help.zendesk.com/hc/en-us/articles/115010249348-Announcing-Updated-Apps-Marketplace-API-Header-Requirementsmerg
+          extheader = {}
+
+          if config[:app_marketplace_integration_name] && config[:app_marketplace_org_id] && config[:app_marketplace_app_id]
+            extheader = {"X-Zendesk-Marketplace-Name" => config[:app_marketplace_integration_name],
+                         "X-Zendesk-Marketplace-Organization-Id" => config[:app_marketplace_org_id],
+                         "X-Zendesk-Marketplace-App-Id" => config[:app_marketplace_app_id]}
+          end
+
           retryer.with_retry do
             Embulk.logger.debug "Fetching #{u.to_s}"
-            response = httpclient.get(u.to_s, query, follow_redirect: true)
+            response = httpclient.get(u.to_s, query, extheader)
 
             handle_response(response.status, response.headers, response.body)
             response
@@ -271,11 +290,20 @@ module Embulk
           u = URI.parse(config[:login_url])
           u.path = path
 
+          # https://help.zendesk.com/hc/en-us/articles/115010249348-Announcing-Updated-Apps-Marketplace-API-Header-Requirementsmerg
+          extheader = {}
+
+          if config[:app_marketplace_integration_name] && config[:app_marketplace_org_id] && config[:app_marketplace_app_id]
+            extheader = {"X-Zendesk-Marketplace-Name" => config[:app_marketplace_integration_name],
+                         "X-Zendesk-Marketplace-Organization-Id" => config[:app_marketplace_org_id],
+                         "X-Zendesk-Marketplace-App-Id" => config[:app_marketplace_app_id]}
+          end
+
           retryer.with_retry do
             Embulk.logger.debug "Fetching #{u.to_s}"
             buf = ""
             auth_retry = 0
-            httpclient.get(u.to_s, query, follow_redirect: true) do |message, chunk|
+            httpclient.get(u.to_s, query, extheader) do |message, chunk|
               if message.status == 401
                 # First request will fail by 401 because not included credentials.
                 # HTTPClient will retry request with credentials.

data/lib/embulk/input/zendesk/plugin.rb

@@ -96,6 +96,9 @@ module Embulk
             incremental: config.param("incremental", :bool, default: true),
             schema: config.param(:columns, :array, default: []),
             includes: config.param(:includes, :array, default: []),
+            app_marketplace_integration_name: config.param("app_marketplace_integration_name", :string, default: nil),
+            app_marketplace_org_id: config.param("app_marketplace_org_id", :string, default: nil),
+            app_marketplace_app_id: config.param("app_marketplace_app_id", :string, default: nil)
           }
         end
 

data/test/embulk/input/zendesk/test_plugin.rb

@@ -50,6 +50,26 @@ module Embulk
               run_with("invalid_lack_username.yml")
             end
           end
+
+          test "run with valid.yml (app_marketplace) contains three properties" do
+            assert_nothing_raised do
+              run_with("valid_app_marketplace.yml")
+            end
+          end
+
+          test "run with invalid lack one of app marketplace properties" do
+            # NOTE: will be raised Java::OrgEmbulkExec::PartialExecutionException, not ConfigError. It is Embulk internally exception handling matter.
+            assert_raise do
+              run_with("invalid_app_marketplace_lack_one_property.yml")
+            end
+          end
+
+          test "run with invalid lack two of app marketplace properties" do
+            # NOTE: will be raised Java::OrgEmbulkExec::PartialExecutionException, not ConfigError. It is Embulk internally exception handling matter.
+            assert_raise do
+              run_with("invalid_app_marketplace_lack_two_property.yml")
+            end
+          end
         end
 
         sub_test_case ".transaction" do

data/test/fixtures/invalid_app_marketplace_lack_one_property.yml

@@ -0,0 +1,13 @@
+in:
+  type: zendesk
+  login_url: "https://example.zendesk.com/"
+  auth_method: basic
+  target: tickets
+  username: foo@example.com
+  password: password
+  app_marketplace_integration_name: App Name for Zendesk
+  app_marketplace_org_id: 12345
+  columns:
+    - {name: id, type: string}
+out:
+  type: "null"

data/test/fixtures/invalid_app_marketplace_lack_two_property.yml

@@ -0,0 +1,12 @@
+in:
+  type: zendesk
+  login_url: "https://example.zendesk.com/"
+  auth_method: basic
+  target: tickets
+  username: foo@example.com
+  password: password
+  app_marketplace_integration_name: App Name for Zendesk
+  columns:
+    - {name: id, type: string}
+out:
+  type: "null"

data/test/fixtures/valid_app_marketplace.yml

@@ -0,0 +1,14 @@
+in:
+  type: zendesk
+  login_url: "https://example.zendesk.com/"
+  auth_method: basic
+  target: tickets
+  username: foo@example.com
+  password: password
+  app_marketplace_integration_name: App Name for Zendesk
+  app_marketplace_org_id: 12345
+  app_marketplace_app_id: 99999
+  columns:
+    - {name: id, type: string}
+out:
+  type: "null"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: embulk-input-zendesk
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.2.10
 platform: ruby
 authors:
 - uu59
@@ -224,9 +224,12 @@ files:
 - test/embulk/input/zendesk/test_client.rb
 - test/embulk/input/zendesk/test_plugin.rb
 - test/fixture_helper.rb
+- test/fixtures/invalid_app_marketplace_lack_one_property.yml
+- test/fixtures/invalid_app_marketplace_lack_two_property.yml
 - test/fixtures/invalid_lack_username.yml
 - test/fixtures/invalid_unknown_auth.yml
 - test/fixtures/tickets.json
+- test/fixtures/valid_app_marketplace.yml
 - test/fixtures/valid_auth_basic.yml
 - test/fixtures/valid_auth_oauth.yml
 - test/fixtures/valid_auth_token.yml
@@ -261,9 +264,12 @@ test_files:
 - test/embulk/input/zendesk/test_client.rb
 - test/embulk/input/zendesk/test_plugin.rb
 - test/fixture_helper.rb
+- test/fixtures/invalid_app_marketplace_lack_one_property.yml
+- test/fixtures/invalid_app_marketplace_lack_two_property.yml
 - test/fixtures/invalid_lack_username.yml
 - test/fixtures/invalid_unknown_auth.yml
 - test/fixtures/tickets.json
+- test/fixtures/valid_app_marketplace.yml
 - test/fixtures/valid_auth_basic.yml
 - test/fixtures/valid_auth_oauth.yml
 - test/fixtures/valid_auth_token.yml