embulk-output-pixela 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 507efa03da3737fd343016adf03358dab1873bbf
+  data.tar.gz: 9c380f7a076fe6d7038e689051de9539617d275d
+SHA512:
+  metadata.gz: ef43de9c7d44b5ddc288bbc786e7d885b02c03cceb7d5dd8f1b7621fa2aca7297a32cdc62431f8f041eb9a5d96f2ce9f219284bd8328d1d653319dcafa43a88e
+  data.tar.gz: 15b69927465c44e7a88108106a6b5b29468692479fc70359ca328340d30aa8fb2ad9ae4105513859e5dd4e7b767e8b64d82568cd9748e2f60685f3bd04d776c9

data/.gitignore

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

data/.ruby-version

@@ -0,0 +1 @@
+jruby-9.1.15.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,109 @@
+# Pixela output plugin for Embulk
+
+Embulk Output plugin for [Pixela](https://pixe.la/) to store your historical records
+
+## Overview
+
+* **Plugin type**: output
+* **Load all or nothing**: no
+* **Resume supported**: no
+* **Cleanup supported**: yes
+
+## Limitations
+
+This plugin supports only recoring your historical data to an existing graph.
+Create user and Create graph are not supported.
+Rerun the following commands in order to do them.
+
+## Configuration
+
+- **name**: Your Username (string, required)
+- **token**: Your Token (string, required)
+- **graph_id**: Your Graph ID (String, required)
+- **quantity_float_column**: Column name to indicate a quantity as float type (quantity_float_column or quantity_int_column are required) (string)
+- **quantity_int_column**: Column name to indicate a quantity as int type (quantity_float_column or quantity_int_column are required) (string)
+- **date_column**: Column name to indicate date of a quantity (string, required)
+
+## Before you use this plugin
+
+```
+$ gem install pixela
+
+$ irb
+require "pixela"
+client = Pixela::Client.new(username: "xxxx", token: "yyyy")
+client.create_user(agree_terms_of_service: true, not_minor: true)
+client.create_graph(graph_id: "zzzz", name: "hhhh", unit: "commit", type: "int", color: "shibafu")
+```
+
+More example is [here](https://pixe.la/)
+
+## Example
+
+You already have the following graph.
+
+![](https://t.gyazo.com/teams/treasure-data/ab4a4c6ee2d56d4cbe2b34b997c15e24.png)
+
+Th example CSV file is below.
+
+```csv
+point,date
+0,2018/10/01
+1,2018/10/02
+2,2018/10/03
+3,2018/10/04
+4,2018/10/05
+5,2018/10/06
+6,2018/10/07
+7,2018/10/08
+8,2018/10/09
+9,2018/10/10
+10,2018/10/11
+11,2018/10/12
+12,2018/10/13
+13,2018/10/14
+14,2018/10/15
+```
+
+You can submit this csv file to Pixela by th following command with this yml file
+
+```yaml
+in:
+  type: file
+  path_prefix: test.csv
+  parser:
+    charset: UTF-8
+    newline: CRLF
+    type: csv
+    delimiter: ','
+    quote: '"'
+    escape: '"'
+    trim_if_not_quoted: false
+    skip_header_lines: 1
+    allow_extra_columns: false
+    allow_optional_columns: false
+    columns:
+    - {name: point, type: long}
+    - {name: date, type: timestamp, format: '%Y/%m/%d'}
+out:
+  type: pixela
+  name: torut
+  token: xxxx
+  graph_id: embulk-test
+  quantity_int_column: point
+  date_column: date
+```
+
+```
+$ embulk run example.yml
+```
+
+After this steps are completed, you'll see the following.
+
+![](https://t.gyazo.com/teams/treasure-data/1d3032ad08e5b7d62ae612d84dd4cf4b.png)
+
+## Build
+
+```
+$ rake
+```

data/Rakefile

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

data/embulk-output-pixela.gemspec

@@ -0,0 +1,21 @@
+
+Gem::Specification.new do |spec|
+  spec.name          = "embulk-output-pixela"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Toru Takahashi"]
+  spec.summary       = "Pixela output plugin for Embulk"
+  spec.description   = "Dumps records to Pixela."
+  spec.email         = ["torutakahashi.ayashi@gmail.com"]
+  spec.licenses      = ["MIT"]
+  spec.homepage      = "https://github.com/torutakahashi.ayashi/embulk-output-pixela"
+
+  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.8']
+  spec.add_development_dependency 'bundler', ['>= 1.10.6']
+  spec.add_development_dependency 'rake', ['>= 10.0']
+  spec.add_dependency 'pixela', ['>=0.1.0']
+end

data/lib/embulk/output/pixela.rb

@@ -0,0 +1,96 @@
+require 'pixela'
+require 'time'
+
+module Embulk
+  module Output
+
+    class PixelaOut < OutputPlugin
+      Plugin.register_output("pixela", self)
+
+      def self.transaction(config, schema, count, &control)
+        # configuration code:
+        task = {
+          "name" => config.param("name", :string),
+          "token" => config.param("token", :string),
+          "graph_id" => config.param("graph_id", :string),
+          "quantity_float_column" => config.param("quantity_float_column", :string, default: nil),
+          "quantity_int_column" => config.param("quantity_int_column", :string, default: nil),
+          "date_column" => config.param("date_column", :string),
+        }
+
+        # 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:
+        @name = task["name"]
+        unless @name
+          raise "'name' is required."
+        end
+        @token = task["token"]
+        unless @token
+          raise "'token' is required."
+        end
+        @graph_id = task["graph_id"]
+        unless @graph_id
+          raise "'graph_id' is required."
+        end
+        @quantity_float_column = task["quantity_float_column"]
+        @quantity_int_column = task["quantity_int_column"]
+        unless @quantity_float_column || @quantity_int_column
+          raise "Choose 'quantity_int_column' or 'float_column'."
+        end
+        @date_column = task["date_column"]
+        unless @date_column
+          raise "'date_column' is required."
+        end
+
+        @client = Pixela::Client.new(username: @name, token: @token)
+      end
+
+      def close
+      end
+
+      def add(page)
+        Embulk.logger.info { "Connecting to https://pixe.la/v1/users/#{@client.username}/graphs/#{@graph_id}" }
+        page.each do |record|
+          data = Hash[schema.names.zip(record)]
+          # Choose only target columns
+          quantity = data["#{@quantity_float_column}"] if @quantity_float_column
+          quantity = data["#{@quantity_int_column}"] if @quantity_int_column
+          d        = data["#{@date_column}"]
+          begin
+            @client.create_pixel(graph_id: @graph_id, date: d, quantity: quantity)
+          rescue Pixela::PixelaError => e
+            Embulk.logger.warn {"#{d}: #{e}"}              
+          end
+        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-pixela
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Toru Takahashi
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2018-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.8
+  name: embulk
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.8
+- !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: 0.1.0
+  name: pixela
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: Dumps records to Pixela.
+email:
+- torutakahashi.ayashi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- embulk-output-pixela.gemspec
+- lib/embulk/output/pixela.rb
+homepage: https://github.com/torutakahashi.ayashi/embulk-output-pixela
+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: Pixela output plugin for Embulk
+test_files: []