embulk-output-zendesk_users 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0873d6bf232b9dfa45747aed32d75f83e7cd20b3
-  data.tar.gz: 68564239188fcf5396db3a8020fd5da3f3cea84c
+SHA256:
+  metadata.gz: ddb25855cc9023d896bd2b08d884c58eb1de28f55cf9c9deb9bbf4b04eb1c6ac
+  data.tar.gz: de73d44634aa174733b1f9b042938c0ec336d7df08458d1bb75b7337d8e1e2ae
 SHA512:
-  metadata.gz: 7f420cdc0c576b4470242e503715cbef48df33372eb83bf907e159e910ed21a874532d1a344e25e1bdb4061e2cc3e4e68acc958a9454059ea48b5379f527afc4
-  data.tar.gz: 9b0fbd4a4260987b3f7a557be0d69fac2e126d53c0fd55e4833ee04e2572d39aaac9279224e48f71a6ffe1b3808a95b91f8e0b0d9b3b318c94854e37335c77f2
+  metadata.gz: 32c1447aeddf68642eed0da165451fddd061cab05ff1d5462801a4b8cbcbc93c47665bd344e1fff32d06c36ac35a7951e55c12e06f343e85c23d1cd48c472632
+  data.tar.gz: 6ea42ef98d5bbc219436f58e531d9d02ade48e2cb8f4bb1f7cc4973c9d1f2c9a5f777384479ab748d4353c4b2b7de2219c4ccd2d4eb8ded1387acf706d103532

data/.ruby-version

@@ -1 +1 @@
-jruby-9.1.5.0
+2.7.1

data/CHANGELOG.md

@@ -1,4 +1,7 @@
 # Change Log
+## 0.0.5 - 2020-10-07
+- [New Feature] Support UPSERT method (#6)
+
 ## 0.0.2 - 2017-12-19
 - [Bugfix] Remove a broken log line
 

data/README.md

@@ -18,10 +18,18 @@ This plugin's feature is limited, which allows you to update Zendesk User's tags
 - **username**: Zendesk Username (string, required)
 - **token**: Zendesk API Token (string, required if auth_method is token)
 - **method**:  control whether to update the existing user or create new user(not supported) (string, default: `update`)
-- **id_column**: column name for user's email (long, default: `id`)
+- **id_column**: column name for user's id (long, default: `id`)
 - **tags_column**: column name for tags. Each tag is separated by comma (`string`, optional, default: `null`, overwrote)
 - **user_fields_column**: column name for Values of custom fields in the user's profile. (json, optional, default: `null`)
 
+The following fields are supported at only `upsert` method
+
+- **name_column**: column name for user's name (`string`, default: `""`)
+- **phone_column**: column name for user's phone number (string, default: `null`)
+- **email_column**: column name for user's email (`string`, default: `null`)
+- **external_id_column**: column name for external_id (`long`, default: `null`)
+- **role_column**: column name for user's role (`long`, default: `null`)
+
 ## Example
 
 ### Config
@@ -40,7 +48,7 @@ out:
   type: zendesk_users
   login_url: https://obscura.zendesk.com
   auth_method: token
-  username: test@test.com
+  username: test@example.com
   token: xxxxxxxxxx
   method: update
   id_column: id
@@ -48,6 +56,38 @@ out:
   user_fields_column: user_fields
 ```
 
+``` yaml
+in:
+  type: config
+  columns:
+  - {name: id, type: long}
+  - {name: tags, type: json}
+  - {name: user_fields, type: json}
+  - {name: name, type: string}
+  - {name: phone, type: string}
+  - {name: email, type: string }
+  - {name: external_id, type: long}
+  - {name: role, type: long}
+  values:
+  - - [ 9811482788, ["tag1", "tag2"], { "xxxx": "Support description", "date": "2013-02-27T20:35:55Z" }, 'name testing', '000-000-000', 'toru+3@xxxxx-data.com', 111, 2859697]
+    - [ 0001010, ["tag3"], { "xxxx": "Support description" }, 'name testing2', '000-0000001', 'toru+4@xxxxx-data.com', 113, 2859707]
+out:
+  type: zendesk_users
+  login_url: https://xxxx.zendesk.com
+  auth_method: token
+  username: xxxx
+  token: xxxxx
+  method: upsert
+  id_column: id
+  tags_column: tags
+  user_fields_column: user_fields
+  name_column: name
+  phone_column: phone
+  email_column: email
+  external_id_column: external_id
+  role_column: role
+```
+
 ### Data
 
 - tags_column requires string data containing terms which separated by comma; Ex. `attention,attack,test`

data/embulk-output-zendesk_users.gemspec

@@ -1,7 +1,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "embulk-output-zendesk_users"
-  spec.version       = "0.0.4"
+  spec.version       = "0.0.5"
   spec.authors       = ["Toru Takahashi"]
   spec.summary       = "Zendesk Users output plugin for Embulk"
   spec.description   = "Update Zendesk User's segments"

data/lib/embulk/output/zendesk_users.rb

@@ -17,6 +17,11 @@ module Embulk
           "id_column" => config.param("id_column", :string, default: "id"),
           "tags_column" => config.param("tags_column", :string, default: nil),
           "user_fields_column" => config.param("user_fields_column", :string, default: nil),
+          "name_column" => config.param("name_column", :string, default: ""),
+          "phone_column" => config.param("phone_column", :string, default: nil),
+          "email_column" => config.param("email_column", :string, default: nil),
+          "external_id_column" => config.param("external_id_column", :string, default: nil),
+          "role_column" => config.param("role_column", :string, default: nil),
           "timeout" => config.param("timeout", :integer, default: 5),
           "open_timeout" => config.param("open_timeout", :integer, default: 2)
         }
@@ -56,12 +61,17 @@ module Embulk
           raise "'token' is required"
         end
         @method = task["method"]
-        unless @method == "update"
-          raise "Only 'update' is supporeted in method"
+        unless ["update", "upsert"].include?(@method)
+          raise "Supports 'update' and 'upert' methods."
         end
         @id_column = task["id_column"]
         @tags_column = task["tags_column"]
         @user_fields_column = task["user_fields_column"]
+        @name_column = task["name_column"]
+        @phone_column = task["phone_column"]
+        @email_column = task["email_column"]
+        @external_id_column = task["external_id_column"]
+        @role_column = task["role_column"]
         @timeout = task["timeout"]
         @open_timeout = task["open_timeout"]
 
@@ -90,30 +100,24 @@ module Embulk
             Embulk.logger.info { "Uploading #{records.size} records" }
             update_users(records)
           end
+        elsif @method == "upsert" then
+          # Batch Update updates up to 100 users.
+          page.each_slice(100).with_index do |records, index|
+            Embulk.logger.info { "Uploading #{records.size} records" }
+            upsert_users(records)
+          end
         end
       end
 
-      def update_users(records)
-        requests = Array.new
-        records.each do |record|
-           data = Hash[schema.names.zip(record)]
-           # Choose only target columns
-           temp = {}
-           temp.store("id", data["#{@id_column}"])
-           temp.store("tags", data["#{@tags_column}"]) if @tags_column
-           temp.store("user_fields", data["#{@user_fields_column}"]) if @user_fields_column
-           Embulk.logger.debug {"Uploading data: #{temp}"}
-           requests << temp
-        end
-
+      def call_many_api(&block)
         begin
-          job_status = @client.users.update_many!(requests)
+          job_status = block.call
         rescue ZendeskAPI::Error::NetworkError => e
           Embulk.logger.warn {"#{e}"}
           Embulk.logger.warn {"Retrying..."}
-          retry              
+          retry
         end
-        
+
         # https://github.com/zendesk/zendesk_api_client_rb#apps-api
         # Note: job statuses are currently not supported, so you must manually poll the job status API for app creation.
         body = {}
@@ -123,7 +127,7 @@ module Embulk
           rescue ZendeskAPI::Error::NetworkError => e
             Embulk.logger.warn {"#{e}"}
             Embulk.logger.warn {"Retrying..."}
-            retry              
+            retry
           end
           job_status = response.body['job_status']
           sleep(1)
@@ -134,6 +138,42 @@ module Embulk
         end
       end
 
+      def update_users(records)
+        requests = Array.new
+        records.each do |record|
+           data = Hash[schema.names.zip(record)]
+           # Choose only target columns
+           temp = {}
+           temp.store("id", data["#{@id_column}"])
+           temp.store("tags", data["#{@tags_column}"]) if @tags_column
+           temp.store("user_fields", data["#{@user_fields_column}"]) if @user_fields_column
+           Embulk.logger.debug {"Uploading data: #{temp}"}
+           requests << temp
+        end
+
+        call_many_api { @client.users.update_many!(requests) }
+      end
+
+      def upsert_users(records)
+        requests = Array.new
+        records.each do |record|
+           data = Hash[schema.names.zip(record)]
+           # Choose only target columns
+           temp = {}
+           temp.store("name", data["#{@name_column}"])
+           temp.store("phone", data["#{@phone_column}"]) if @phone_column
+           temp.store("tags", data["#{@tags_column}"]) if @tags_column
+           temp.store("user_fields", data["#{@user_fields_column}"]) if @user_fields_column
+           temp.store("email", data["#{@email_column}"]) if @email_column
+           temp.store("external_id", data["#{@external_id_column}"]) if @external_id_column
+           temp.store("role", data["#{@role_column}"]) if @role_column
+           Embulk.logger.debug {"Uploading data: #{temp}"}
+           requests << temp
+        end
+
+        call_many_api { ZendeskAPI::User.create_or_update_many!(@client, requests) }
+      end
+
       def finish
       end
 

metadata

@@ -1,66 +1,66 @@
 --- !ruby/object:Gem::Specification
 name: embulk-output-zendesk_users
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Toru Takahashi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-12-19 00:00:00.000000000 Z
+date: 2020-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: embulk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.30
-  name: embulk
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.30
 - !ruby/object:Gem::Dependency
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.10.6
-  name: bundler
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.10.6
 - !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
-  name: rake
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
+  name: zendesk_api
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.16.0
-  name: zendesk_api
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -101,8 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.6.6
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: Zendesk Users output plugin for Embulk