redash-rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0d728b6acf6f4418e5871eaac344cccda129c705
+  data.tar.gz: 6c0b59777abd5dc46081460a4e62ad9b288cb8cd
+SHA512:
+  metadata.gz: 5a598d814ef2675cd1bc06b355347ae38502f5db981a6e66446239a2e975f5dd765aa745e7522e6d488ffb756bbcd2855e118d1c16ff06ea0faa6a9033046fb9
+  data.tar.gz: 1dc3885712561632e8902d8d764b5c702c9c523ac831872273fcb8d2a95a073f0fe0d77fcc4da6d2e821cb48b0c00aefd57ce60cd963bd8adab1f6671ec613df

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in redash-rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Kenta Murata
+
+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,78 @@
+# Redash and Rails integration
+
+This library helps you to integrate re:dash and your Rails apps.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redash-rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redash-rails
+
+## Usage
+
+### Installing rails datasource
+
+Use `redash-rails-install` command.
+
+```console
+$ redash-rails-install $REDASH_ROOT_DIR
+```
+
+### Helper library for rails queries
+
+[lib/redash.rb](lib/redash.rb) provides helper functions to write queries.
+
+The following script is an example usage of these helper functions:
+
+```ruby
+require 'redash'
+include Redash
+
+result = {}
+
+add_result_column result, 'age', 'Age', 'integer'
+add_result_column result, 'survived_count', 'Survived count', 'integer'
+add_result_column result, 'dead_count', 'Dead count', 'integer'
+
+summary = Passenger.find_each.inject({}) do |h, pas|
+  if pas.age
+    age = (pas.age % 10) * 10
+    h[age] ||= []
+    h[age][pas.survived] ||= 0
+    h[age][pas.survived] += 1
+  end
+  h
+end
+
+summary.each do |age, age_summary|
+  add_result_row(result, age: age, survived_count: age_summary[1], dead_count: age_summary[0])
+end
+
+commit_to_redash(result)
+```
+
+See [mrkn/redash_rails_demon](https://github.com/mrkn/redash_rails_demo) repository for more details.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/mrkn/redash-rails.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "redash/rails"
+
+# 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(__FILE__)

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/redash-rails-install

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'fileutils'
+
+rails_py = File.expand_path("../../python/redash_rails/query_runner/rails.py", __FILE__)
+redash_root = ARGV[0]
+
+FileUtils.install(rails_py, File.join(redash_root, 'redash/query_runner/'), mode: 0644)

data/lib/redash.rb

@@ -0,0 +1,19 @@
+require 'json'
+
+module Redash
+  module_function
+
+  def add_result_column(result, column_name, friendly_name, column_type)
+    result[:columns] ||= []
+    result[:columns] << { name: column_name, friendly_name: friendly_name, type: column_type }
+  end
+
+  def add_result_row(result, values)
+    result[:rows] ||= []
+    result[:rows] << values
+  end
+
+  def commit_to_redash(result)
+    $stdout.puts JSON.dump(result)
+  end
+end

data/lib/redash/rails.rb

@@ -0,0 +1,7 @@
+require "redash/rails/version"
+
+module Redash
+  module Rails
+    # Your code goes here...
+  end
+end

data/lib/redash/rails/version.rb

@@ -0,0 +1,5 @@
+module Redash
+  module Rails
+    VERSION = "1.0.0"
+  end
+end

data/python/redash_rails/query_runner/rails.py

@@ -0,0 +1,83 @@
+import os
+import sys
+import subprocess
+import tempfile
+
+from redash.query_runner import *
+
+
+class Rails(BaseQueryRunner):
+    @classmethod
+    def configuration_schema(cls):
+        return {
+            'type': 'object',
+            'properties': {
+                'environment': {
+                    'type': 'string',
+                    'title': 'RAILS_ENV'
+                },
+                'workdir': {
+                    'type': 'string',
+                    'title': 'Work directory'
+                }
+            },
+            'required': ['workdir']
+        }
+
+    @classmethod
+    def type(cls):
+        return "insecure_script"
+
+
+    def __init__(self, configuration):
+        super(Rails, self).__init__(configuration)
+        self.syntax = "ruby"
+
+    def test_connection(self):
+        pass
+
+    def run_query(self, query, user):
+        try:
+            prev_cwd = os.getcwd()
+            os.chdir(self.configuration['workdir'])
+
+            json_data = None
+            error = None
+
+            query = query.strip()
+            query = query.split('*/ ', 2)[1]
+            print('--- begin query ---')
+            print(query)
+            print('--- end query ---')
+
+            with tempfile.NamedTemporaryFile(delete=False, suffix='rb') as tf:
+                tf.write(query)
+                script_name = tf.name
+            output = subprocess.check_output(['bin/rails', 'runner', script_name])
+            os.unlink(script_name)
+            print('--- begin output ---')
+            print(output)
+            print('--- end output ---')
+            if output is not None:
+                output = output.strip()
+                if output != "":
+                    return output, None
+
+            error = "Error reading output"
+        except subprocess.CalledProcessError as e:
+            print('--- begin output ---')
+            print(e.output)
+            print('--- end output ---')
+            return None, str(e)
+        except KeyboardInterrupt:
+            error = "Query cancelled by user."
+            json_data = None
+        except Exception as e:
+            raise sys.exc_info()[1], None, sys.exc_info()[2]
+        finally:
+            os.chdir(prev_cwd)
+
+        return json_data, error
+
+
+register(Rails)

data/redash-rails.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "redash/rails/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "redash-rails"
+  spec.version       = Redash::Rails::VERSION
+  spec.authors       = ["Kenta Murata"]
+  spec.email         = ["mrkn@mrkn.jp"]
+
+  spec.summary       = %q{redash-rails}
+  spec.description   = %q{redash-rails}
+  spec.homepage      = "https://github.com/mrkn/redash-rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: redash-rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kenta Murata
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: redash-rails
+email:
+- mrkn@mrkn.jp
+executables:
+- redash-rails-install
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/redash-rails-install
+- lib/redash.rb
+- lib/redash/rails.rb
+- lib/redash/rails/version.rb
+- python/redash_rails/query_runner/rails.py
+- redash-rails.gemspec
+homepage: https://github.com/mrkn/redash-rails
+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.12
+signing_key: 
+specification_version: 4
+summary: redash-rails
+test_files: []