embulk-output-zendesk_users 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: deed5db6a5136a657abfd55cf8585e8bfd41868b
+  data.tar.gz: 584f8205fb14250ad86355d0c4a0f43c36959f0a
+SHA512:
+  metadata.gz: a036e52085074881300aef91af102a32586803b0f16555ba3997cf94476962323163a642283e2888c83fb59fe882340555d0459e71d6772c18b48bea01f9dd60
+  data.tar.gz: 33c76a9f3e1f1ff21f14e6f51eac1d2a65bb320ab72b83ae2849101c91a9be8b80afd74f188aba1b0538a31e23b5e57b980e7c222dc2455c47824ad9d1e3bb89

data/.gitignore

@@ -0,0 +1,5 @@
+*~
+/pkg/
+/tmp/
+/.bundle/
+/Gemfile.lock

data/.ruby-version

@@ -0,0 +1 @@
+jruby-9.1.5.0

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org/'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+# Zendesk Users output plugin for Embulk
+
+Embulk output plugin for Zendesk to update Zendesk User infomation. Fro more details, see https://developer.zendesk.com/rest_api/docs/core/users#content
+
+This plugin's feature is limited, which allows you to update Zendesk User's tags and user_fileds.
+
+## Overview
+
+* **Plugin type**: output
+* **Load all or nothing**: no
+* **Resume supported**: no
+* **Cleanup supported**: no
+
+## Configuration
+
+- **login_url**: Login URL for Zendesk (string, required)
+- **auth_method**: Zendesk auth method (string, default: `token`)
+- **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`)
+- **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`)
+
+## Example
+
+### Config
+
+```yaml
+in:
+  type: config
+  columns:
+  - {name: id, type: long}
+  - {name: tags, type: json}
+  - {name: user_fields, type: json}
+  values:
+  - - [ 1194094257, ["tag1", "tag2"], { "field0": "Support description", "field01": "2013-02-27T20:35:55Z" } ]
+    - [ 9811482788, ["tag3"], { "field0": "Support description" } ]
+out:
+  type: zendesk_users
+  login_url: https://obscura.zendesk.com
+  auth_method: token
+  username: test@test.com
+  token: xxxxxxxxxx
+  method: update
+  id_column: id
+  tags_column: tags
+  user_fields_column: user_fields
+```
+
+### Data
+
+- tags_column requires string data containing terms which separated by comma; Ex. `attention,attack,test`
+- user_fields_column requires JSON data. For more details about available keys, See https://developer.zendesk.com/rest_api/docs/core/user_fields#json-format
+
+## Build
+
+```
+$ rake
+```

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+
+task default: :build

data/embulk-output-zendesk_users.gemspec

@@ -0,0 +1,20 @@
+
+Gem::Specification.new do |spec|
+  spec.name          = "embulk-output-zendesk_users"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Toru Takahashi"]
+  spec.summary       = "Zendesk Users output plugin for Embulk"
+  spec.description   = "Update Zendesk User's segments"
+  spec.email         = ["torutakahashi.ayashi@gmail.com"]
+  spec.licenses      = ["MIT"]
+  spec.homepage      = "https://github.com/torutakahashi.ayashi/embulk-output-zendesk_users"
+
+  spec.files         = `git ls-files`.split("\n") + Dir["classpath/*.jar"]
+  spec.test_files    = spec.files.grep(%r{^(test|spec)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'embulk', ['>= 0.8.30']
+  spec.add_development_dependency 'bundler', ['>= 1.10.6']
+  spec.add_development_dependency 'rake', ['>= 10.0']
+  spec.add_dependency 'zendesk_api', ['>=1.16.0']
+end

data/lib/embulk/output/zendesk_users.rb

@@ -0,0 +1,139 @@
+require 'zendesk_api'
+
+module Embulk
+  module Output
+
+    class ZendeskUsers < OutputPlugin
+      Plugin.register_output("zendesk_users", self)
+
+      def self.transaction(config, schema, count, &control)
+        # configuration code:
+        task = {
+          "login_url" => config.param("login_url", :string, default: nil),
+          "auth_method" => config.param("auth_method", :string, default: "token"),
+          "username" => config.param("username", :string, default: nil),
+          "token" => config.param("token", :string, default: nil),
+          "method" => config.param("method", :string, default: "update"),
+          "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),
+          "timeout" => config.param("timeout", :integer, default: 5),
+          "open_timeout" => config.param("open_timeout", :integer, default: 2)
+        }
+
+        # resumable output:
+        # resume(task, schema, count, &control)
+
+        # non-resumable output:
+        task_reports = yield(task)
+        next_config_diff = {}
+        return next_config_diff
+      end
+
+      # def self.resume(task, schema, count, &control)
+      #   task_reports = yield(task)
+      #
+      #   next_config_diff = {}
+      #   return next_config_diff
+      # end
+
+      def init
+        # initialization code:
+        @login_url = task["login_url"]
+        unless @login_url
+          raise "'login_url' is required."
+        end
+        @auth_method = task["auth_method"]
+        unless @auth_method == "token"
+          raise "Only 'token' is supported in auth_method"
+        end
+        @username = task["username"]
+        unless @username
+          raise "username is required"
+        end
+        @token = task["token"]
+        unless @username
+          raise "'token' is required"
+        end
+        @method = task["method"]
+        unless @method == "update"
+          raise "Only 'update' is supporeted in method"
+        end
+        @id_column = task["id_column"]
+        @tags_column = task["tags_column"]
+        @user_fields_column = task["user_fields_column"]
+        @timeout = task["timeout"]
+        @open_timeout = task["open_timeout"]
+
+        @client = ZendeskAPI::Client.new do |config|
+          config.url = @login_url + "/api/v2"
+          config.retry = true
+          config.username = @username
+          config.token = @token
+          config.client_options = {
+            :request => {
+              :timeout => @timeout,
+              :open_timeout => @open_timeout
+            }
+          }
+        end
+      end
+
+      def close
+      end
+
+      def add(page)
+        Embulk.logger.info { "Connecting to #{@login_url}" }
+        Embulk.logger.info { "Start to upload #{page.size} records" }
+        if @method == "update" then 
+          # Batch Update updates up to 100 users.
+          page.each_slice(100).with_index do |records, index|
+            Embulk.logger.info { "Uploading #{records.size} records" }
+            update_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
+
+        job_status = @client.users.update_many!(requests)
+        
+        # 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 = {}
+        until %w{failed completed}.include?(job_status['status'])
+          response = @client.connection.get(job_status['url'])
+          job_status = response.body['job_status']
+          sleep(1)
+        end
+        
+        job_status['results'].each do |result|
+          Embulk.logger.warn { "ID:#{result['id']}, Error:#{result['error']}" } unless result['success']
+        end
+      end
+
+      def finish
+      end
+
+      def abort
+      end
+
+      def commit
+        task_report = {}
+        return task_report
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: embulk-output-zendesk_users
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Toru Takahashi
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2017-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.30
+  name: embulk
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.30
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.6
+  name: bundler
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.6
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.0
+  name: zendesk_api
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.0
+description: Update Zendesk User's segments
+email:
+- torutakahashi.ayashi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- embulk-output-zendesk_users.gemspec
+- lib/embulk/output/zendesk_users.rb
+homepage: https://github.com/torutakahashi.ayashi/embulk-output-zendesk_users
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.6.6
+signing_key:
+specification_version: 4
+summary: Zendesk Users output plugin for Embulk
+test_files: []