embulk-input-zendesk_guide 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2a556a287bc7d20ad2d86839c23d4a921db47d22
+  data.tar.gz: 38c8f19a1b2df84fbdd33e72a7e64791531d1728
+SHA512:
+  metadata.gz: d6449a444dfc0ef9028daf4fd56d7dbf9e7e6f56b9a591cfcb3392d0a147177c7cab45377db966711550ea6cef02a6cae5489327ce6d19e6545da4dcbcb59dc6
+  data.tar.gz: 245b6695e77b9791aa7dffbbba81be4b4e048890f1824d4ce82d320022a759a6983e2319237bea890d39451e3c6e7a8b6a7fa594e38b4d7f0ef85e4563938c1c

data/.gitignore

@@ -0,0 +1,6 @@
+*~
+/pkg/
+/tmp/
+/.bundle/
+/Gemfile.lock
+config.yml

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,35 @@
+# Zendesk Guide input plugin for Embulk
+
+Embulk input plugin of [Zendesk Guide](https://developer.zendesk.com/rest_api/docs/help_center/introduction) (Help Center).
+
+## Overview
+
+* **Plugin type**: input
+* **Resume supported**: no
+* **Cleanup supported**: no
+* **Guess supported**: no
+
+## Configuration
+
+- **url**: URL for Zendesk Guide API (string, required)
+- **username**: username to use api (string, required)
+- **token**: Token (string, required)
+
+## Example
+
+```yaml
+in:
+  type: zendesk_guide
+  url: https://support.example.com/api/v2
+  username: user@example.com
+  token: xxx
+out:
+  type: stdout
+```
+
+
+## Build
+
+```
+$ rake
+```

data/Rakefile

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

data/embulk-input-zendesk_guide.gemspec

@@ -0,0 +1,20 @@
+
+Gem::Specification.new do |spec|
+  spec.name          = "embulk-input-zendesk_guide"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Yasuhisa Yoshida"]
+  spec.summary       = "Zendesk Guide input plugin for Embulk"
+  spec.description   = "Loads records from Zendesk Guide."
+  spec.email         = ["syou6162@gmail.com"]
+  spec.licenses      = ["MIT"]
+  spec.homepage      = "https://github.com/syou6162/embulk-input-zendesk_guide"
+
+  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_dependency 'YOUR_GEM_DEPENDENCY', ['~> YOUR_GEM_DEPENDENCY_VERSION']
+  spec.add_development_dependency 'embulk', ['>= 0.9.23']
+  spec.add_development_dependency 'bundler', ['>= 1.10.6']
+  spec.add_development_dependency 'rake', ['>= 10.0']
+end

data/lib/embulk/input/zendesk_guide.rb

@@ -0,0 +1,57 @@
+require "net/http"
+require 'date'
+require 'json'
+
+require_relative 'zendesk_guide/articles'
+
+module Embulk
+  module Input
+    class ZendeskGuide < InputPlugin
+      Plugin.register_input("zendesk_guide", self)
+
+      def self.transaction(config, &control)
+        # configuration code:
+        task = {
+          "url" => config.param("url", :string),
+          "username" => config.param("username", :string),
+          "token" => config.param("token", :string),
+        }
+        columns = Articles.columns
+        resume(task, columns, 1, &control)
+      end
+
+      def self.resume(task, columns, count, &control)
+        task_reports = yield(task, columns, count)
+
+        next_config_diff = {}
+        return next_config_diff
+      end
+
+      # TODO
+      # def self.guess(config)
+      #   sample_records = [
+      #     {"example"=>"a", "column"=>1, "value"=>0.1},
+      #     {"example"=>"a", "column"=>2, "value"=>0.2},
+      #   ]
+      #   columns = Guess::SchemaGuess.from_hash_records(sample_records)
+      #   return {"columns" => columns}
+      # end
+
+      def init
+        @articles = Articles.new(task["url"], task["username"], task["token"])
+      end
+
+      def run
+        @articles.get.each {|article|
+          page_builder.add(article)
+        }
+
+        page_builder.finish
+
+        task_report = {}
+        return task_report
+      end
+    end
+
+  end
+end

data/lib/embulk/input/zendesk_guide/articles.rb

@@ -0,0 +1,75 @@
+require 'embulk/column'
+
+class Articles
+  def initialize(url, username, token)
+    @url = url
+    @username = username
+    @token = token
+  end
+  
+  def self.columns
+    [
+      Embulk::Column.new(0, "id", :long),
+      Embulk::Column.new(1, "url", :string),
+      Embulk::Column.new(2, "html_url", :string),
+      Embulk::Column.new(3, "title", :string),
+      Embulk::Column.new(4, "body", :string),
+      Embulk::Column.new(5, "locale", :string),
+      Embulk::Column.new(6, "source_locale", :string),
+      Embulk::Column.new(7, "author_id", :long),
+      Embulk::Column.new(8, "comments_disabled", :boolean),
+      Embulk::Column.new(9, "outdated_locales", :string),
+      Embulk::Column.new(10, "outdated", :boolean),
+      Embulk::Column.new(11, "label_names", :string),
+      Embulk::Column.new(12, "draft", :boolean),
+      Embulk::Column.new(13, "promoted", :boolean),
+      Embulk::Column.new(14, "position", :long),
+      Embulk::Column.new(15, "vote_sum", :long),
+      Embulk::Column.new(16, "vote_count", :long),
+      Embulk::Column.new(17, "section_id", :long),
+      Embulk::Column.new(18, "user_segment_id", :long),
+      Embulk::Column.new(19, "permission_group_id", :long),
+      Embulk::Column.new(20, "created_at", :timestamp),
+      Embulk::Column.new(21, "edited_at", :timestamp),
+      Embulk::Column.new(22, "updated_at", :timestamp),
+    ]
+  end
+
+  def get
+    uri = URI.parse("#@url/help_center/ja/articles.json")
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = uri.scheme === "https"
+
+    req = Net::HTTP::Get.new(uri.path)
+    req.basic_auth(@username, @token)
+    response = http.request(req)
+    JSON.parse(response.body)["articles"].map {|article|
+      [
+        article["id"],
+        article["url"],
+        article["html_url"],
+        article["title"],
+        article["body"],
+        article["locale"],
+        article["source_locale"],
+        article["author_id"],
+        article["comments_disabled"],
+        article["outdated_locales"],
+        article["outdated"],
+        article["label_names"],
+        article["draft"],
+        article["promoted"],
+        article["position"],
+        article["vote_sum"],
+        article["vote_count"],
+        article["section_id"],
+        article["user_segment_id"],
+        article["permission_group_id"],
+        Date.parse(article["created_at"]).to_time,
+        Date.parse(article["edited_at"]).to_time,
+        Date.parse(article["updated_at"]).to_time,
+      ]
+    }
+  end
+
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: embulk-input-zendesk_guide
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yasuhisa Yoshida
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.23
+  name: embulk
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.23
+- !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'
+description: Loads records from Zendesk Guide.
+email:
+- syou6162@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- embulk-input-zendesk_guide.gemspec
+- lib/embulk/input/zendesk_guide.rb
+- lib/embulk/input/zendesk_guide/articles.rb
+homepage: https://github.com/syou6162/embulk-input-zendesk_guide
+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.14
+signing_key:
+specification_version: 4
+summary: Zendesk Guide input plugin for Embulk
+test_files: []