embulk-output-google_analytics 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 44c03abf705ee490d970a063cc0bb698957b7132dd06ce04d203064ea91d43fd
+  data.tar.gz: 447a46028d705c218892269170e775be1e2801989d438e4ef0b0b7a489e62c47
+SHA512:
+  metadata.gz: c8824a183a607745e0ad48f6c61c01d3ff9cd40060e71e0955de20c57da4879a3cf69ec70bf10340dab866f0fa28dba37bb67b6a3bca32ad48e3f2f3c84d83be
+  data.tar.gz: 52295050295aabdbb728ed0abf9da32c6b96e2cebe168ef6ce0b8a97ca2682955357fdd10e5b4dafc346486f93cddbc9e9f4e244a77965fdcecdaa7eba609dd3

data/.gitignore

@@ -0,0 +1,7 @@
+*~
+/pkg/
+/tmp/
+/.bundle/
+/Gemfile.lock
+/workspaces/
+/vendor/bundle/

data/.ruby-version

@@ -0,0 +1 @@
+jruby-9.1.13.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,41 @@
+# Google Analytics output plugin for Embulk
+This plugin performs the data import and measurement protocol into Google Analytis.
+However, Measurement Protocol feature is not implemented.
+
+## Overview
+* **Plugin type**: output
+* **Load all or nothing**: no
+* **Resume supported**: no
+* **Cleanup supported**: no
+
+## Configuration
+- **action**: "dataimport" or "measurement_protocol" (string, default: `"dataimport"`)
+- **client_id**: authentication (string, required)
+- **client_secret**: authentication (string, required)
+- **refresh_token**: authentication (string, required)
+- **account_id**: Your google analytics account id (string, required)
+- **webproperty_id**: Your google analytics Web Property id (string, required)
+- **datasource_id**: Your google analytics Data Source id (string, default: `nil`)
+- **filename**: Your upload filename (string, default: `nil`)
+
+## Example
+
+```yaml
+out:
+  type: google_analytics
+  action: dataimport
+  client_id: xxxxxxxxx.apps.googleusercontent.com
+  client_secret: yyyyyyyyyyyyyyy
+  refresh_token: 1/zzzzzzzzzzzzzzzzzzzzz
+  account_id: xyz
+  webproperty_id: UA-xyz-a
+  datasource_id: xxxxxxxxxxxxx
+  filename: "Sample Cost Data.csv"
+```
+
+
+## Build
+
+```
+$ rake
+```

data/Rakefile

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

data/embulk-output-google_analytics.gemspec

@@ -0,0 +1,21 @@
+
+Gem::Specification.new do |spec|
+  spec.name          = "embulk-output-google_analytics"
+  spec.version       = "0.1.0"
+  spec.authors       = ["ryota.yamada"]
+  spec.summary       = "Google Analytics output plugin for Embulk"
+  spec.description   = "This plugin performs the data import and measurement protocol into Google Analytics."
+  spec.email         = ["1987yama3@gmail.com"]
+  spec.licenses      = ["MIT"]
+  spec.homepage      = "https://github.com/sem-technology/embulk-output-google_analytics"
+
+  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 "signet"
+  spec.add_dependency "google-api-client", "~> 0.9.11"
+  spec.add_development_dependency 'embulk', ['>= 0.8.38']
+  spec.add_development_dependency 'bundler', ['>= 1.10.6']
+  spec.add_development_dependency 'rake', ['>= 10.0']
+end

data/example/costdata.yml

@@ -0,0 +1,26 @@
+in:
+  type:
+    name: config
+  columns:
+    - {name: "ga:date", type: string}
+    - {name: "ga:source", type: string}
+    - {name: "ga:medium", type: string}
+    - {name: "ga:adClicks", type: long}
+    - {name: "ga:impressions", type: long}
+    - {name: "ga:adCost", type: long}
+  values:
+    - - ["20171201", "yahoo", "cpc", 23, 540, 1200]
+      - ["20171202", "yahoo", "cpc", 23, 540, 1200]
+      - ["20171203", "yahoo", "cpc", 23, 540, 1200]
+      - ["20171204", "yahoo", "cpc", 23, 540, 1200]
+out:
+  type: google_analytics
+  action: dataimport
+  client_id: xxxxxxxxx.apps.googleusercontent.com
+  client_secret: yyyyyyyyyyyyyyy
+  refresh_token: 1/zzzzzzzzzzzzzzzzzzzzz
+  account_id: xyz
+  webproperty_id: UA-xyz-a
+  datasource_id: xxxxxxxxxxxxx
+  filename: "Sample Cost Data.csv"
+

data/lib/embulk/output/google_analytics.rb

@@ -0,0 +1,8 @@
+require "embulk/output/google_analytics/plugin"
+require "embulk/output/google_analytics/client"
+module Embulk
+  module Output
+    module GoogleAnalytics
+    end
+  end
+end

data/lib/embulk/output/google_analytics/client.rb

@@ -0,0 +1,49 @@
+require 'google/apis/analytics_v3'
+require 'stringio'
+module Embulk
+  module Output
+    module GoogleAnalytics
+      class Client
+        def initialize(task)
+          @task = task
+        end
+
+        def upload(rows)
+          self.service.upload_data(@task['account_id'], @task['webproperty_id'], @task['datasource_id'], {
+            upload_source: make_upload_content(rows),
+            content_type: 'application/octet-stream',
+            options: {
+              header: {
+                'x-goog-upload-file-name' => @task['filename'],
+              }
+            }
+          })
+        end
+
+        def service
+          analytics_service = ::Google::Apis::AnalyticsV3::AnalyticsService.new
+          analytics_service.authorization = Signet::OAuth2::Client.new({
+            :token_credential_uri => @task["token_credential_uri"],
+            :audience => @task["audience"],
+            :client_id => @task["client_id"],
+            :client_secret => @task["client_secret"],
+            :refresh_token => @task["refresh_token"],
+            :scope => @task["scope"],
+          })
+          analytics_service.authorization.fetch_access_token!
+          analytics_service
+        end
+
+        private
+          def make_upload_content(rows)
+            io = StringIO.new
+            io.puts(rows.first.collect{|k,v| k }.join(","))
+            rows.each do |row|
+              io.puts(row.collect{|k, v| v}.join(","))
+            end
+            io
+          end
+      end
+    end
+  end
+end

data/lib/embulk/output/google_analytics/plugin.rb

@@ -0,0 +1,79 @@
+module Embulk
+  module Output
+    module GoogleAnalytics
+      class Plugin < OutputPlugin
+        ::Embulk::Plugin.register_output("google_analytics", self)
+
+        def self.transaction(config, schema, count, &control)
+          # configuration code:
+          task = {
+            "token_credential_uri" => "https://accounts.google.com/o/oauth2/token",
+            "audience" => "https://accounts.google.com/o/oauth2/token",
+            "client_id" => config.param("client_id", :string),
+            "client_secret" => config.param("client_secret", :string),
+            "refresh_token" => config.param("refresh_token", :string),
+            "scope" => "https://www.googleapis.com/auth/analytics.edit",
+
+            "action" => config.param("action", :string, default: 'dataimport'),
+            "account_id" => config.param("account_id", :string),
+            "webproperty_id" => config.param("webproperty_id", :string),
+            "datasource_id" => config.param("datasource_id", :string, default: nil),
+            "filename" => config.param("filename", :string, default: nil),
+          }
+          task_check(task)
+
+          # resumable output:
+          # resume(task, schema, count, &control)
+
+          # non-resumable output:
+          task_reports = yield(task)
+          next_config_diff = {}
+          return next_config_diff
+        end
+
+        def self.task_check(task)
+          if task['action'] == 'dataimport'
+            if task['datasource_id'].nil?
+              Embulk.logger.error 'datasource_id is required'
+              raise 'datasource_id is required'
+            elsif task['filename'].nil?
+              Embulk.logger.error 'filename is required'
+              raise 'filenam is required'
+            end
+          elsif task['action'] == 'measurement_protocol'
+            Embulk.logger.error 'Sorry, Measurement Protocol feature is not implemented'
+            raise 'Measurement Protocol feature is not implemented'
+          else
+            Embulk.logger.error 'ACTION_ERROR'
+            raise 'ACTION_ERROR'
+          end
+        end
+
+        def init
+          @client = Client.new(@task)
+        end
+
+        def close
+        end
+
+        def add(page)
+          if task['action'] == 'dataimport'
+            rows = page.collect{|record| Hash[schema.names.zip(record)] }
+            @client.upload(rows)
+          end
+        end
+
+        def finish
+        end
+
+        def abort
+        end
+
+        def commit
+          task_report = {}
+          return task_report
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: embulk-output-google_analytics
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ryota.yamada
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2017-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: signet
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+  name: google-api-client
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.38
+  name: embulk
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.38
+- !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: This plugin performs the data import and measurement protocol into Google
+  Analytics.
+email:
+- 1987yama3@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- embulk-output-google_analytics.gemspec
+- example/costdata.yml
+- lib/embulk/output/google_analytics.rb
+- lib/embulk/output/google_analytics/client.rb
+- lib/embulk/output/google_analytics/plugin.rb
+homepage: https://github.com/sem-technology/embulk-output-google_analytics
+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.13
+signing_key:
+specification_version: 4
+summary: Google Analytics output plugin for Embulk
+test_files: []