dbhero 1.0.0

data/app/views/dbhero/dataclips/_form.html.slim

@@ -0,0 +1,32 @@
+= javascript_include_tag "https://cdnjs.cloudflare.com/ajax/libs/ace/1.1.8/ace.js"
+= form_for @dataclip do |f|
+  - if @dataclip.errors.any?
+    .section
+      .card-panel.deep-orange.darken-4
+        .card-content.white-text
+          ul
+            - @dataclip.errors.full_messages.each do |message|
+              li
+                i class='mdi-alert-error left'
+                = message
+
+  .row.style-text-field
+    .input-field
+      = f.text_area :description, class: "materialize-textarea", placeholder: "describe this clip, first line should be title..."
+  .row
+    .input-field
+      = f.text_area :raw_query, class: 'editor-style z-depth-1'
+  .row
+    .col.s5
+      .input-field
+        .switch
+          label
+            i style="margin-top: -20px; float: left" class="small mdi-action-lock-open tooltipped" data-position="right" data-delay="50" data-tooltip="Everyone with the public link can see the results"
+            = f.check_box :private
+            span.lever style='float: left;'
+            i style="margin-top: -20px; float: left" class="small mdi-action-lock-outline tooltipped" data-position="right" data-delay="50" data-tooltip="Only users that same role as you can see the clip"
+    .col.s7.right-align
+      .input-field
+        button class="btn waves-effect waves-light blue darken-3" type="submit" name="action"
+          | Save
+          i class="mdi-action-done-all left"

data/app/views/dbhero/dataclips/edit.html.slim

@@ -0,0 +1,6 @@
+.container
+  == render 'form'
+- if @dataclip.valid? && @dataclip.q_result
+  .section
+    .row
+      == render 'clip_table', show_public_link: true

data/app/views/dbhero/dataclips/index.html.slim

@@ -0,0 +1,25 @@
+.container
+  .section
+    .row.style-text-field 
+      .input-field.col.s12
+        = form_tag dataclips_path, method: :get do
+          input#icon_prefix.validate name='search' type="text" value=params[:search] /
+          label for="icon_prefix" 
+            | search on all clips
+          i.mdi-action-search.prefix
+        
+    .row
+      .col.s2.center-align.right
+        span style='font-size: 16px; color: #9e9e9e;' updated at
+      .col.s12
+        ul.collection.z-depth-1
+          - @dataclips.each do |dataclip|
+            li.collection-item
+              .row style='margin-bottom: 0;'
+                .col.s12
+                  = link_to dataclip.title, edit_dataclip_path(dataclip)
+                  - if dataclip.user
+                    span style='font-size: 13px; font-weight: light; color: #607d8b;'
+                      |   by #{dataclip.user}
+                  span.right style='font-size: 12px; font-weight: bold; color: #607d8b;'= distance_of_time_in_words(dataclip.updated_at, DateTime.now)
+

data/app/views/dbhero/dataclips/new.html.slim

@@ -0,0 +1,2 @@
+.container
+  == render 'form'

data/app/views/dbhero/dataclips/show.html.slim

@@ -0,0 +1,18 @@
+.section.bottom-bord.grey.lighten-4
+  .container
+    .row
+      .col.s12.center-align
+        h5.clip-title=simple_format(@dataclip.title)
+        p=simple_format(@dataclip.description_without_title)
+
+
+.container
+  - if params[:gdrive_file_url].present?
+    .card-panel.teal.up.green.lighten-1
+      .card-content.white-text.center-align style='text-transform: uppercase;'
+        | DATACLIP EXPORTED! 
+        strong
+          = link_to 'CLICK HERE TO VIEW IT', params[:gdrive_file_url], style: 'color: #33691e;'
+
+
+== render 'clip_table'

data/app/views/layouts/dbhero/application.html.slim

@@ -0,0 +1,24 @@
+doctype html
+html.grey.lighten-3
+  head
+    title DBHero
+    = stylesheet_link_tag    "dbhero/application", "https://cdnjs.cloudflare.com/ajax/libs/materialize/0.95.3/css/materialize.min.css", media: "all"
+    = javascript_include_tag "dbhero/application", "https://cdnjs.cloudflare.com/ajax/libs/materialize/0.95.3/js/materialize.min.js"
+    = csrf_meta_tags
+  body
+    - unless action_name == 'show'
+      header.grey.lighten-5
+        .row
+          .col.s2
+            = link_to dataclips_path do
+              h1 
+                | db
+                strong hero
+          .col.s10.right-align
+            .btn-group
+              = link_to 'clips', dataclips_path, class: 'btn blue darken-1 waves-effect waves-light'
+              | 
+              = link_to 'new clip', new_dataclip_path, class: 'btn blue darken-1 waves-effect waves-light'
+          
+    = yield
+

data/config/routes.rb

@@ -0,0 +1,6 @@
+Dbhero::Engine.routes.draw do
+  root to: "dataclips#index"
+  resources :dataclips do
+    get :drive, on: :collection
+  end
+end

data/lib/dbhero.rb

@@ -0,0 +1,7 @@
+require "dbhero/engine"
+require "dbhero/configuration"
+require "dbhero/gdrive_exporter"
+
+module Dbhero
+  extend Configuration
+end

data/lib/dbhero/configuration.rb

@@ -0,0 +1,39 @@
+module Dbhero
+  module Configuration
+    VALID_CONFIG_KEYS    = [:authenticate, :current_user_method, :custom_user_auth_condition,
+                            :user_representation, :google_api_id, :google_api_secret].freeze
+
+    DEFAULT_AUTHENTICATE = true
+    DEFAULT_CURRENT_USER_METHOD = :current_user
+    DEFAULT_GOOGLE_API_ID = ''
+    DEFAULT_GOOGLE_API_SECRET = ''
+    DEFAULT_USER_PRESENTATION = :email
+    DEFAULT_CUSTOM_USER_AUTH_CONDITION = nil
+
+    attr_accessor *VALID_CONFIG_KEYS
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def configure
+      yield self if block_given?
+    end
+
+    def options
+      Hash[ * VALID_CONFIG_KEYS.map { |key| [key, send(key)] }.flatten ]
+    end
+
+    def reset
+      self.authenticate = DEFAULT_AUTHENTICATE
+      self.current_user_method = DEFAULT_CURRENT_USER_METHOD
+      self.user_representation = DEFAULT_USER_PRESENTATION
+      self.google_api_id = DEFAULT_GOOGLE_API_ID
+      self.google_api_secret = DEFAULT_GOOGLE_API_SECRET
+      self.custom_user_auth_condition = DEFAULT_CUSTOM_USER_AUTH_CONDITION
+    end
+
+  end
+end
+
+

data/lib/dbhero/engine.rb

@@ -0,0 +1,9 @@
+module Dbhero
+  class Engine < ::Rails::Engine
+    isolate_namespace Dbhero
+
+    config.generators do |g|
+      g.template_engine :slim
+    end
+  end
+end

data/lib/dbhero/gdrive_exporter.rb

@@ -0,0 +1,56 @@
+module Dbhero
+  class GdriveExporter
+    attr_accessor :options
+    attr_reader :client, :auth, :session,
+      :dataclip, :uploaded_file, :exported_file_url
+
+    def initialize options = {}
+      @client ||= ::Google::APIClient.new
+      @options = options
+
+      @auth = @client.authorization
+      @auth.client_id = Dbhero.google_api_id
+      @auth.client_secret = Dbhero.google_api_secret
+      @auth.scope =
+        "https://www.googleapis.com/auth/drive " +
+        "https://spreadsheets.google.com/feeds/"
+
+      @auth.redirect_uri = options[:redirect_uri]
+    end
+
+    def fetch_access_token! code
+      @auth.code = code
+      @auth.fetch_access_token!
+      @session ||= GoogleDrive.login_with_oauth(@auth.access_token)
+    end
+
+    def export_clip_by_token token
+      @dataclip ||= Dataclip.find_by token: token
+      raise 'unable to find dataclip' unless @dataclip
+
+      exported_file = find_or_create_spreadsheet!
+      @exported_file_url = exported_file.human_url
+    end
+
+    private
+
+    def find_or_create_spreadsheet!
+      file_title = "DBHero - #{@dataclip.title}"
+
+      spreadsheet = @session.spreadsheet_by_title(file_title)
+
+      worksheet = (spreadsheet || upload_from_string(file_title)).worksheets[0]
+      worksheet[1,1] = "=importData('#{@options[:import_data_url]}')"
+      worksheet.save
+
+      spreadsheet || @uploaded_file
+    end
+
+    def upload_from_string file_title
+      @uploaded_file ||= @session.upload_from_string(
+        @dataclip.csv_string,
+        file_title,
+        content_type: 'text/csv')
+    end
+  end
+end

data/lib/dbhero/router_constraint.rb

@@ -0,0 +1,43 @@
+module Dbhero
+  class RouterConstraint
+    @@routes = Dbhero::Engine.routes
+
+    def self.matches? request, options = {}
+      _ = new(request, options)
+      _.match?
+    end
+
+    def initialize(request, options)
+      @request = request
+      @options = options
+      @devise_mapping = options[:devise_mapping] || :user
+      @devise_auth = options[:devise_auth] || false
+      @enable_public_clip = options[:enable_public_clip] || false
+    end
+
+    def match?
+      return ((@enable_public_clip && check_if_is_public_dataclip) ||
+              (@devise_auth && authenticate_warden && check_custom_condition))
+    end
+
+    private
+
+    def check_if_is_public_dataclip
+      if @request.path.match(/\/dataclips\/([\w\-]{36}+)(\.[\w]{1,6})?$/)
+        return Dbhero::Dataclip.where(token: $1).exists?
+      end
+    end
+
+    def authenticate_warden
+      @request.env['warden'].send(:authenticate!, scope: @devise_mapping)
+    end
+
+    def check_custom_condition
+      auth_condition.is_a?(Proc) && auth_condition.call( @request.env['warden'].user(@devise_mapping) )
+    end
+
+    def auth_condition
+      @options[:custom_auth_condition]
+    end
+  end
+end

data/lib/dbhero/version.rb

@@ -0,0 +1,3 @@
+module Dbhero
+  VERSION = "1.0.0"
+end

data/lib/generators/dbhero/install/install_generator.rb

@@ -0,0 +1,29 @@
+module Dbhero
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      desc "Installs DBHero and generate migrations"
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      def copy_initializer
+        template 'dbhero.rb', 'config/initializers/dbhero.rb'
+      end
+
+      def create_migrations
+        migration_template "migrations/create_dbhero_dataclips.rb", "db/migrate/create_dbhero_dataclips.rb"
+      end
+
+      # for migration generation
+      def self.next_migration_number(path)
+        unless @prev_migration_nr
+          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        else
+          @prev_migration_nr += 1
+        end
+        @prev_migration_nr.to_s
+      end
+    end
+  end
+end
+

data/lib/generators/dbhero/install/templates/dbhero.rb

@@ -0,0 +1,26 @@
+Dbhero.configure do |config|
+  # if you are using devise you can keep the "authenticate_user!"
+  config.authenticate = true
+
+  # Method to get the current user authenticated on your app
+  # if you are using devise you can keep the "current_user"
+  config.current_user_method = :current_user
+
+  # uncomment to use custom user auth
+  # config.custom_user_auth_condition = lambda do |user|
+  #   user.admin?
+  # end
+
+  # String representation for user
+  # when creating a dataclip just save on user field
+  config.user_representation = :email
+
+  # Google drive integration, uncomment to use ;)
+  # you can get you google api credentials here:
+  # https://developers.google.com/drive/web/auth/web-server
+  #
+  # config.google_api_id = 'GOOGLE_API_ID'
+  # config.google_api_secret = 'GOOGLE_API_SECRET'
+end
+
+

data/lib/generators/dbhero/install/templates/migrations/create_dbhero_dataclips.rb

@@ -0,0 +1,17 @@
+class CreateDbheroDataclips < ActiveRecord::Migration
+  def change
+    create_table :dbhero_dataclips do |t|
+      t.text :description, null: false
+      t.text :raw_query, null: false
+      t.text :token, null: false
+      t.text :user
+      t.boolean :private, default: false, null: false
+
+      t.timestamps null: false
+    end
+
+    add_index :dbhero_dataclips, :token, unique: true
+    add_index :dbhero_dataclips, :user
+  end
+end
+

data/lib/tasks/dbhero_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :dbhero do
+#   # Task goes here
+# end

data/spec/controllers/dbhero/dataclips_controller_spec.rb

@@ -0,0 +1,293 @@
+require 'rails_helper'
+
+RSpec.shared_examples "user not authenticated" do
+  let(:method_name) { :get }
+  let(:options) { nil }
+
+  before do
+    allow(Dbhero).to receive(:authenticate).and_return(true)
+    allow(controller).to receive(:_current_user).and_return(nil)
+  end
+
+  it "should raise forbidden error" do
+    expect {
+      send(method_name, *options)
+    }.to raise_error(ActionController::RoutingError, 'Forbidden')
+  end
+end
+
+RSpec.shared_examples "user authenticated" do
+  let(:method_name) { :get }
+  let(:options) { nil }
+  let(:expect_method) { :be_success }
+
+  before do
+    current_user = double()
+    allow(current_user).to receive(:email).and_return('foo@bar.com')
+    allow(controller).to receive(:_current_user).and_return(current_user)
+    allow(Dbhero).to receive(:authenticate).and_return(true)
+
+    send(method_name, *options)
+  end
+
+  it("response should be success") { expect(response).to send(expect_method) }
+end
+
+RSpec.shared_examples "user authenticated match for custom role" do
+  let(:method_name) { :get }
+  let(:options) { nil }
+  let(:expect_method) { :be_success }
+
+  before do
+    current_user = double()
+    allow(current_user).to receive(:email).and_return('foo@bar.com')
+    allow(current_user).to receive(:admin?).and_return(true)
+    allow(controller).to receive(:_current_user).and_return(current_user)
+    allow(Dbhero).to receive(:authenticate).and_return(true)
+    allow(Dbhero).to receive(:custom_user_auth_condition).and_return(->(u){u.admin?})
+
+    send(method_name, *options)
+  end
+
+  it("response should be success") { expect(response).to send(expect_method) }
+end
+
+RSpec.shared_examples "user authenticated don't match for custom role" do
+  let(:method_name) { :get }
+  let(:options) { nil }
+
+  before do
+    current_user = double()
+    allow(current_user).to receive(:email).and_return('foo@bar.com')
+    allow(current_user).to receive(:admin?).and_return(false)
+    allow(controller).to receive(:_current_user).and_return(current_user)
+    allow(Dbhero).to receive(:authenticate).and_return(true)
+    allow(Dbhero).to receive(:custom_user_auth_condition).and_return(->(u){u.admin?})
+  end
+
+  it "should raise forbidden error" do
+    expect {
+      send(method_name, *options)
+    }.to raise_error(ActionController::RoutingError, 'Forbidden')
+  end
+end
+
+RSpec.shared_examples "disabled auth" do
+  let(:method_name) { :get }
+  let(:options) { nil }
+  let(:expect_method) { :be_success }
+
+  before do
+    allow(Dbhero).to receive(:authenticate).and_return(false)
+    allow(controller).to receive(:_current_user).and_return(nil)
+    send(method_name, *options)
+  end
+
+  it("response should be success") { expect(response).to send(expect_method) }
+end
+
+RSpec.describe Dbhero::DataclipsController, type: :controller do
+  routes { Dbhero::Engine.routes }
+
+  describe "GET index" do
+    describe "with enabled auth" do
+      it_should_behave_like "user not authenticated" do
+        let(:options) { :index }
+      end
+
+      it_should_behave_like "user authenticated" do
+        let(:options) { :index }
+      end
+
+      it_should_behave_like "user authenticated match for custom role" do
+        let(:options) { :index }
+      end
+
+      it_should_behave_like "user authenticated don't match for custom role" do
+        let(:options) { :index }
+      end
+    end
+
+    describe "with disabled auth" do
+      it_should_behave_like "disabled auth" do
+        let(:options) { :index }
+      end
+    end
+  end
+
+  describe "GET new" do
+    describe "with enabled auth" do
+      it_should_behave_like "user not authenticated" do
+        let(:options) { :new }
+      end
+
+      it_should_behave_like "user authenticated" do
+        let(:options) { :new }
+      end
+
+      it_should_behave_like "user authenticated match for custom role" do
+        let(:options) { :new }
+      end
+
+      it_should_behave_like "user authenticated don't match for custom role" do
+        let(:options) { :new }
+      end
+    end
+
+    describe "with disabled auth" do
+      it_should_behave_like "disabled auth" do
+        let(:options) { :new }
+      end
+    end
+  end
+
+  describe "POST create" do
+    describe "with enabled auth" do
+      it_should_behave_like "user not authenticated" do
+        let(:method_name) { :post }
+        let(:options) { [:create, { dataclip: { description: "foo bar", raw_query: "select 'foo' as bar" } }] }
+      end
+
+      it_should_behave_like "user authenticated" do
+        let(:method_name) { :post }
+        let(:options) { [:create, { dataclip: { description: "foo bar", raw_query: "select 'foo' as bar" } }] }
+        let(:expect_method) { :be_redirect }
+
+        it { expect(Dbhero::Dataclip.find_by(description: 'foo bar')).not_to be_nil }
+      end
+
+      it_should_behave_like "user authenticated match for custom role" do
+        let(:method_name) { :post }
+        let(:options) { [:create, { dataclip: { description: "foo bar", raw_query: "select 'foo' as bar" } }] }
+        let(:expect_method) { :be_redirect }
+
+        it "find dataclip" do
+          clip = Dbhero::Dataclip.find_by(description: 'foo bar')
+
+          expect(clip.user).to eq(controller._current_user.email)
+          expect(clip.description).to eq("foo bar")
+          expect(clip.raw_query).to eq("select 'foo' as bar")
+        end
+      end
+
+      it_should_behave_like "user authenticated don't match for custom role" do
+        let(:method_name) { :post }
+        let(:options) { [:create, { dataclip: { description: "foo bar", raw_query: "select 'foo' as bar" } }] }
+      end
+    end
+
+    describe "with disabled auth" do
+      it_should_behave_like "disabled auth" do
+        let(:method_name) { :post }
+        let(:options) { [:create, { dataclip: { description: "foo bar disabled", raw_query: "select 'foo' as bar" } }] }
+        let(:expect_method) { :be_redirect }
+
+        it "find dataclip" do
+          clip = Dbhero::Dataclip.find_by(description: 'foo bar disabled')
+
+          expect(clip.user).to be_nil
+          expect(clip.description).to eq("foo bar disabled")
+          expect(clip.raw_query).to eq("select 'foo' as bar")
+        end
+      end
+    end
+  end
+
+
+  describe "GET edit" do
+    describe "with enabled auth" do
+      it_should_behave_like "user not authenticated" do
+        let(:dataclip) { create(:dataclip) }
+        let(:options) { [:edit, { id: dataclip.token}] }
+      end
+
+      it_should_behave_like "user authenticated" do
+        let(:dataclip) { create(:dataclip) }
+        let(:options) { [:edit, { id: dataclip.token}] }
+      end
+
+      it_should_behave_like "user authenticated match for custom role" do
+        let(:dataclip) { create(:dataclip) }
+        let(:options) { [:edit, { id: dataclip.token}] }
+      end
+
+      it_should_behave_like "user authenticated don't match for custom role" do
+        let(:dataclip) { create(:dataclip) }
+        let(:options) { [:edit, { id: dataclip.token}] }
+      end
+    end
+
+    describe "with disabled auth" do
+      it_should_behave_like "disabled auth" do
+        let(:dataclip) { create(:dataclip) }
+        let(:options) { [:edit, { id: dataclip.token}] }
+      end
+    end
+  end
+
+  describe "PUT update" do
+    describe "with enabled auth" do
+      it_should_behave_like "user not authenticated" do
+        let(:method_name) { :post }
+        let(:options) { [:create, { dataclip: { description: "foo bar", raw_query: "select 'foo' as bar" } }] }
+      end
+
+      it_should_behave_like "user authenticated" do
+        let(:method_name) { :put }
+        let(:dataclip) { create(:dataclip, {description: "foo bar", raw_query: "select 'foo' as bar"}) }
+        let(:options) { [:update, id: dataclip.token, dataclip: { description: "updated" } ] }
+        let(:expect_method) { :be_redirect }
+
+        it "find dataclip" do
+          clip = Dbhero::Dataclip.find_by(description: 'updated')
+
+          expect(clip.description).to eq("updated")
+          expect(clip.raw_query).to eq("select 'foo' as bar")
+        end
+      end
+
+      it_should_behave_like "user authenticated match for custom role" do
+        let(:method_name) { :put }
+        let(:dataclip) { create(:dataclip, {description: "foo bar", raw_query: "select 'foo' as bar"}) }
+        let(:options) { [:update, id: dataclip.token, dataclip: { description: "updated" }] }
+        let(:expect_method) { :be_redirect }
+
+        it "find dataclip" do
+          clip = Dbhero::Dataclip.find_by(description: 'updated')
+
+          expect(clip.description).to eq("updated")
+          expect(clip.raw_query).to eq("select 'foo' as bar")
+        end
+      end
+
+      it_should_behave_like "user authenticated don't match for custom role" do
+        let(:method_name) { :put }
+        let(:dataclip) { create(:dataclip, {description: "foo bar", raw_query: "select 'foo' as bar"}) }
+        let(:options) { [:update, id: dataclip.token, dataclip: { description: "updated" }] }
+        let(:expect_method) { :be_redirect }
+
+        it "not update dataclip" do
+          clip = Dbhero::Dataclip.find dataclip.id
+
+          expect(clip.description).to eq("foo bar")
+        end
+      end
+    end
+
+    describe "with disabled auth" do
+      it_should_behave_like "disabled auth" do
+        let(:method_name) { :put }
+        let(:dataclip) { create(:dataclip, {description: "foo bar", raw_query: "select 'foo' as bar"}) }
+        let(:options) { [:update, id: dataclip.token, dataclip: { description: "updated" }] }
+        let(:expect_method) { :be_redirect }
+
+        it "find dataclip" do
+          clip = Dbhero::Dataclip.find_by(description: 'updated')
+
+          expect(clip.description).to eq("updated")
+          expect(clip.raw_query).to eq("select 'foo' as bar")
+        end
+      end
+    end
+  end
+end