tembin 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eeef0f33ab745308739346211e755ae16f534f95
+  data.tar.gz: 4d2083cc57d110314cfa4d1fb7fbc45c689c28b3
+SHA512:
+  metadata.gz: ed8b72437c1e67d058c9b4c7d1b7036b5453d6c22c99786e6eb68fa98e450d2ceeb677cac2ac30dde32e39bee0ff70ea8e626adbc415865e298858a839622b5d
+  data.tar.gz: 9dc17e0d4e683995c0ce64527073a737ebfbad2051d311d21dec1cb4abbd499915a811ed084aa8ffb1372e49d6cb1cef186b4de9074798e98dafc00eb874906d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tembin.gemspec
+gemspec

data/README.md

@@ -0,0 +1,52 @@
+# Tembin
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tembin`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tembin', '0.1.0.alpha2'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tembin --pre
+
+## Usage
+
+### redash.yml
+
+```
+host: 'https://your.redash.host'
+api_key: <%= ENV['REDASH_API_KEY'] %>
+authorized_user_email: 'your-account@email.com'
+```
+
+### Export
+
+```shell
+$ tembin export --dir /path/to/sql/store/directory/tembin --redash_config ~/redash.yml
+```
+
+### Apply
+
+```shell
+$ tembin apply --file /path/to/entry_point_script/tembin.rb --redash_config ~/redash.yml
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tembin.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tembin"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/tembin

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+$: << File.expand_path('../../lib', __FILE__)
+require 'tembin'
+Tembin::CLI.start(ARGV)

data/lib/tembin.rb

@@ -0,0 +1,6 @@
+require 'tembin/version'
+require 'tembin/redash'
+require 'tembin/element_parser'
+require 'tembin/applyer'
+require 'tembin/exporter'
+require 'tembin/cli'

data/lib/tembin/applyer.rb

@@ -0,0 +1,78 @@
+require 'diffy'
+require 'highline'
+
+class Tembin::Applyer
+  def self.run(elements, dry_run: true, out: STDOUT)
+    new(elements, out: out, dry_run: dry_run).run
+  end
+
+  def initialize(elements, out: STDOUT, dry_run: true)
+    @elements = elements
+    @dry_run = dry_run
+    @out = out
+  end
+
+  def run
+    remote_queries = Tembin::Redash::Query.created_by_me
+    remote_queries.each do |remote_query|
+      @out.puts(h.color("#{remote_query.name}", :green))
+
+      update_query(
+        remote_query,
+        @elements.find{ |e| e.name == remote_query.name },
+      )
+    end
+
+    remote_query_names = remote_queries.map(&:name)
+    @elements.reject { |local|
+      remote_query_names.include?(local.name)
+    }.each { |element|
+      create_new_query(element)
+    }
+  end
+
+  private
+
+  def create_new_query(local)
+    @out.puts(h.color("#{local.name}", :green))
+    if @dry_run
+      @out.puts(h.color("   --> will be created.", :yellow))
+    else
+      Tembin::Redash::Query.create(local.name, local.attributes[:sql])
+      @out.puts(h.color("   --> create.", :yellow))
+    end
+  end
+
+  def update_query(remote, local)
+    if local.nil?
+      if @dry_run
+        @out.puts(h.color("   --> will be deleted.", :red))
+      else
+        @out.puts(h.color("   --> delete.", :red))
+        remote.delete!
+      end
+
+      @out.puts
+      return
+    end
+
+    if remote.changed?(local.attributes[:sql])
+      @out.puts(h.color("   --> has changed.", :yellow))
+
+      if @dry_run
+        @out.puts(Diffy::Diff.new(remote.sql, local.attributes[:sql]).to_s(:color))
+      else
+        remote.update!(element.attributes[:sql])
+        @out.puts(h.color("   --> updated.", :green))
+      end
+    else
+      @out.puts(h.color("   --> already up to date.", :cyan))
+    end
+
+    @out.puts
+  end
+
+  def h
+    @h ||= HighLine.new
+  end
+end

data/lib/tembin/cli.rb

@@ -0,0 +1,61 @@
+require 'thor'
+require 'yaml'
+require 'erb'
+
+class Tembin::CLI < Thor
+  package_name :Tembin
+
+  desc 'apply', 'apply re:dash files'
+  option :file, type: :string, aliases: :f, banner: 'entry file path'
+  option :apply, type: :boolean, aliases: :a, banner: 'apply flag(default dry run)'
+  option :redash_config, type: :string, aliases: :c, banner: 'redash config file path'
+  def apply
+    load_redash_credentials
+
+    Tembin::Applyer.run(
+      Tembin::ElementParser.parse(dsl_file),
+      dry_run: !options[:apply]
+    )
+  end
+
+  desc 'export', 'export re:dash files'
+  option :dir, type: :string, aliases: :d, required: true, banner: 'export file store directory'
+  option :redash_config, type: :string, aliases: :c, banner: 'redash config file path'
+  option :disable_split_sql, type: :boolean, banner: 'disable sqlfile split mode'
+  option :split_file, type: :boolean, banner: 'disable split file mode'
+  def export
+    load_redash_credentials
+
+    Tembin::Exporter.run(
+      Pathname.new(options[:dir]),
+      split_sql: !options[:disable_split_sql],
+      split_file: options[:split_file],
+    )
+  end
+
+  private
+
+  def dsl_file
+    Pathname.new(options[:file] || 'Redashfile')
+  end
+
+  def redash_config_path
+    Pathname.new(options[:redash_config] || 'redash.yml')
+  end
+
+  def load_redash_credentials
+    Tembin::Redash.config = YAML.load(
+      ERB.new(
+        open(redash_config_path).read
+      ).result(binding)
+    )
+
+    if Tembin::Redash.config['api_key'].nil?
+      raise ArgumentError, "Re:dash api key is empty. Please set Tembin::Redash.config['api_key']"
+    end
+
+    if Tembin::Redash.config['authorized_user_email'].nil?
+      raise ArgumentError, "Re:dash user login email is empty. Please set Tembin::Redash.config['authorized_user_email']"
+    end
+  end
+end

data/lib/tembin/element.rb

@@ -0,0 +1,4 @@
+require 'tembin/element/base'
+require 'tembin/element/alert'
+require 'tembin/element/dashboard'
+require 'tembin/element/query'

data/lib/tembin/element/alert.rb

@@ -0,0 +1,2 @@
+class Tembin::Element::Alert < Tembin::Element::Base
+end

data/lib/tembin/element/base.rb

@@ -0,0 +1,44 @@
+module Tembin::Element
+  module FieldDefinationMacros
+    AVAILABLE_TYPES = [
+      :string, :element, :numeric, :array, :boolean, :time
+    ].freeze
+
+    def field(key, type, options = {})
+      raise ArgumentError, "Unknown element field type. #{key}, #{type}, #{options}" if !AVAILABLE_TYPES.include?(type)
+      define_method(key) do |*args, &block|
+        case type
+        when :string, :numeric, :boolean
+          @attributes[key] = args.first
+        when :element
+          @attributes[key] = options[:class].build(*args, &block)
+        end
+      end
+    end
+  end
+
+  class Base
+    extend FieldDefinationMacros
+
+    def self.build(*args, &block)
+      new(*args, &block).build
+    end
+
+    attr_reader :name, :attributes
+
+    def initialize(*args, &block)
+      @name = args[0]
+      @block = block
+      @attributes = {}
+    end
+
+    def build
+      instance_exec(&@block)
+      self
+    end
+
+    def to_params
+      raise NotImplementedError
+    end
+  end
+end

data/lib/tembin/element/dashboard.rb

@@ -0,0 +1,2 @@
+class Tembin::Element::Dashboard < Tembin::Element::Base
+end

data/lib/tembin/element/query.rb

@@ -0,0 +1,8 @@
+require 'tembin/element/visualizations'
+
+class Tembin::Element::Query < Tembin::Element::Base
+  field :data_source, :string
+  field :schedule, :time
+  field :sql, :string
+  field :visualizations, :element, class: Tembin::Element::Visualizations
+end

data/lib/tembin/element/visualizations.rb

@@ -0,0 +1,32 @@
+class Tembin::Element::Visualizations < Tembin::Element::Base
+  class Chart < Tembin::Element::Base
+    class XAxis < Tembin::Element::Base
+      field :scale, :string, only: ['Datetime', 'Linear', 'Logarithmic', 'Category']
+      field :name, :string
+      field :sort, :boolean
+      field :labels, :boolean
+      field :height, :numeric
+    end
+
+    class YAxis < Tembin::Element::Base
+      class Value < Tembin::Element::Base
+        field :scale, :string, only: ['Datetime', 'Linear', 'Logarithmic']
+        field :name, :string
+      end
+
+      field :left, :element, class: Chart::YAxis::Value
+      field :right, :element, class: Chart::YAxis::Value
+    end
+
+    field :type, :string, only: ['Line', 'Bar', 'Area', 'Pie', 'Scatter']
+    field :x_column, :string
+    field :y_columns, :array
+    field :group_by, :string
+    field :show_legend, :boolean
+    field :stacking, :string
+    field :x_axis, :element, class: Chart::XAxis
+    field :y_axis, :element, class: Chart::YAxis
+  end
+
+  field :chart, :element, class: Chart
+end

data/lib/tembin/element_parser.rb

@@ -0,0 +1,30 @@
+require 'tembin/element'
+
+class Tembin::ElementParser
+  def self.parse(dsl_filepath)
+    new(dsl_filepath).elements
+  end
+
+  def initialize(dsl)
+    @elements = []
+    instance_eval(dsl.read, dsl.to_path, 1)
+  end
+
+  def elements
+    @elements
+  end
+
+  private
+
+  def query(name, &block)
+    @elements << Tembin::Element::Query.build(name, &block)
+  end
+
+  def dashboard(name, &block)
+    @elements << Tembin::Element::Dashboard.build(name, &block)
+  end
+
+  def alert(name, &block)
+    @elements << Tembin::Element::Alert.build(name, &block)
+  end
+end

data/lib/tembin/exporter.rb

@@ -0,0 +1,69 @@
+class Tembin::Exporter
+  def self.run(out_dir, split_sql: true, split_file: true, out: STDOUT)
+    new(out_dir, split_sql: split_sql, split_file: split_file, out: STDOUT).run
+  end
+
+  def initialize(out_dir, split_sql: true, split_file: true, out: STDOUT)
+    @out_dir = out_dir
+    @split_sql_mode = split_sql
+    @split_file_mode = split_file
+    @out = out
+  end
+
+  def run
+    FileUtils.rm_f(@out_dir.join('tembin.rb')) if File.exist?(@out_dir.join('tembin.rb'))
+
+    export_head_file if @split_file_mode
+
+    Tembin::Redash::Query.created_by_me.each do |query|
+      @out.puts(h.color("export #{query.name}", :green))
+
+      file =
+        if @split_file_mode
+          File.open(@out_dir.join("#{query.filename}.rb"), "w")
+        else
+          File.open(@out_dir.join("tembin.rb"), "a")
+        end
+
+      @out.puts(h.color("   redash query file --> #{file.path}", :yellow))
+
+      sql =
+        if @split_sql_mode
+          path = @out_dir.join("#{query.filename}.sql")
+          File.write(path, query.sql)
+          @out.puts(h.color("   sql --> #{path}", :yellow))
+          "open(File.join(__dir__, '#{query.filename}.sql')).read"
+        else
+          "%(#{query.sql})"
+        end
+
+      file.puts(<<EOS)
+query "#{query.name}" do
+  sql #{sql}
+end\n
+EOS
+      file.close
+
+      @out.puts
+    end
+  end
+
+  private
+
+  def export_head_file
+    File.open(@out_dir.join('tembin.rb'), "w") do |file|
+      @out.puts(h.color("export head file --> #{file.path}", :green))
+
+      file.puts(<<EOS)
+Dir.glob(File.join(__dir__, "*.rb")) do |file|
+  next if File.expand_path(file) == File.expand_path('#{file.path}')
+  instance_eval(open(file).read, file, 1)
+end
+EOS
+    end
+  end
+
+  def h
+    @h ||= HighLine.new
+  end
+end

data/lib/tembin/redash.rb

@@ -0,0 +1,16 @@
+module Tembin::Redash
+  def self.config=(value)
+    @config = value
+  end
+
+  def self.config
+    @config ||= {
+      api_key:               nil,
+      host:                  nil,
+      authorized_user_email: nil,
+    }
+  end
+end
+
+require 'tembin/redash/client'
+require 'tembin/redash/query'

data/lib/tembin/redash/client.rb

@@ -0,0 +1,47 @@
+require 'faraday'
+
+module Tembin::Redash
+  class Client
+    class RequestNotSucceedError < StandardError; end
+
+    def self.current
+      Thread.current[:__tembin__redash_client__] ||= new(Tembin::Redash.config['api_key'], authorized_user_email: Tembin::Redash.config['authorized_user_email'])
+    end
+
+    def initialize(api_key, authorized_user_email: nil)
+      @api_key = api_key
+      @authorized_user_email = authorized_user_email
+    end
+
+    def get(path, params: {})
+      response = connection.get(path, { api_key: @api_key }.merge(params))
+      raise RequestNotSucceedError, response.body if !response.success?
+      response
+    end
+
+    def post(path, body: {}, params: {})
+      response = connection.post do |req|
+        req.url(path)
+        req.params = params.merge(api_key: @api_key)
+        req.body = body.to_json
+        req
+      end
+
+      raise RequestNotSucceedError, response.body if !response.success?
+
+      response
+    end
+
+    def delete(path, params: {})
+      response = connection.delete(path, { api_key: @api_key }.merge(params))
+      raise RequestNotSucceedError, response.body if !response.success?
+      response
+    end
+
+    private
+
+    def connection
+      @connection ||= Faraday.new(url: Tembin::Redash.config['host'])
+    end
+  end
+end

data/lib/tembin/redash/query.rb

@@ -0,0 +1,57 @@
+require 'json'
+require 'diffy'
+
+module Tembin::Redash
+  class Query
+    def self.all
+      response = Tembin::Redash::Client.current.get('/api/queries')
+      raise RequestNotSucceedError, response.body if !response.success?
+      JSON.parse(response.body)['results'].map { |j| self.new(j) }
+    end
+
+    def self.created_by_me
+      all.select { |q| q.author_email == Tembin::Redash.config['authorized_user_email'] }
+    end
+
+    INITIAL_DATA_SOURCE_ID = 1
+    def self.create(name, sql)
+      Tembin::Redash::Client.current.post("/api/queries", body: { name: name, query: sql, data_source_id: INITIAL_DATA_SOURCE_ID })
+    end
+
+    def initialize(attributes)
+      @attributes = attributes
+    end
+
+    def id
+      @attributes['id']
+    end
+
+    def name
+      @attributes['name']
+    end
+
+    def author_email
+      @attributes['user'] && @attributes['user']['email']
+    end
+
+    def sql
+      @attributes['query']
+    end
+
+    def filename
+      "#{@attributes['id']}_#{@attributes['name'].gsub(/(\/|-|\s)/, '_')}"
+    end
+
+    def changed?(query)
+      Diffy::Diff.new(sql, query).to_s.length != 0
+    end
+
+    def update!(query)
+      Tembin::Redash::Client.current.post("/api/queries/#{id}", body: { query: query })
+    end
+
+    def delete!
+      Tembin::Redash::Client.current.delete("/api/queries/#{id}")
+    end
+  end
+end

data/lib/tembin/version.rb

@@ -0,0 +1,3 @@
+module Tembin
+  VERSION = "0.0.1"
+end

data/tembin.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tembin/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tembin"
+  spec.version       = Tembin::VERSION
+  spec.authors       = ["Takatoshi Maeda"]
+  spec.email         = ["me@tmd.tw"]
+
+  spec.summary       = %q{Codenized Re:dash configurations}
+  spec.homepage      = "https://github.com/TakatoshiMaeda/tembin"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "thor"
+  spec.add_runtime_dependency "diffy"
+  spec.add_runtime_dependency "highline"
+  spec.add_runtime_dependency "faraday"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.5.0"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: tembin
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Takatoshi Maeda
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: diffy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- me@tmd.tw
+executables:
+- tembin
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/tembin
+- lib/tembin.rb
+- lib/tembin/applyer.rb
+- lib/tembin/cli.rb
+- lib/tembin/element.rb
+- lib/tembin/element/alert.rb
+- lib/tembin/element/base.rb
+- lib/tembin/element/dashboard.rb
+- lib/tembin/element/query.rb
+- lib/tembin/element/visualizations.rb
+- lib/tembin/element_parser.rb
+- lib/tembin/exporter.rb
+- lib/tembin/redash.rb
+- lib/tembin/redash/client.rb
+- lib/tembin/redash/query.rb
+- lib/tembin/version.rb
+- tembin.gemspec
+homepage: https://github.com/TakatoshiMaeda/tembin
+licenses: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Codenized Re:dash configurations
+test_files: []