oculus 0.5.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+before_script:
+- "export DISPLAY=:99.0"
+- "sh -e /etc/init.d/xvfb start"

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Paul Rosania
+
+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,34 @@
+# Oculus
+
+![The Oculus of the Pantheon](http://upload.wikimedia.org/wikipedia/commons/1/17/Oculus_of_the_Pantheon.jpg)
+
+[![Build Status](https://secure.travis-ci.org/paulrosania/oculus.png?branch=master)](http://travis-ci.org/paulrosania/oculus)
+[![Dependency Status](https://gemnasium.com/paulrosania/oculus.png)](https://gemnasium.com/paulrosania/oculus)
+
+Oculus is a web-based logging SQL client.  It keeps a history of your queries
+and the results they returned, so your research is always at hand, easy to share
+and easy to repeat or reproduce in the future.
+
+**Oculus will not prevent you from doing stupid things! I recommend using a
+readonly MySQL account.**
+
+## Installation
+
+    $ gem install oculus
+
+## Usage
+
+Oculus is a Sinatra app. Run it from the command line, or mount `Oculus::Server`
+as middleware in your Rack application.
+
+For details on command line options, run:
+
+    oculus --help
+
+## Contributing
+
+1. Fork it
+2. Make your changes
+3. Send me a pull request
+
+If you're making a big change, please open an Issue first, so we can discuss.

data/Rakefile

@@ -0,0 +1,18 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
+
+desc 'Run RSpec tests'
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = %w[--color --format documentation]
+  task.pattern    = 'spec/*_spec.rb'
+end
+
+desc 'Run Cucumber features'
+Cucumber::Rake::Task.new(:cucumber) do |task|
+  task.cucumber_opts = 'features --format pretty'
+end
+
+task :default => [:spec, :cucumber]

data/TODO.md

@@ -0,0 +1,12 @@
+# Todo
+
+## Upcoming (pre-1.0)
+
+* Input validation
+* Data download
+
+## Eventually (1.1 or later)
+
+* Restartable queries
+* Reports/query groups
+* Processlist monitor

data/bin/oculus

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+begin
+  require 'vegas'
+rescue LoadError
+  require 'rubygems'
+  require 'vegas'
+end
+require 'oculus/server'
+
+
+Vegas::Runner.new(Oculus::Server, 'oculus') do |runner, opts, app|
+  opts.on("-h", "--host HOST", "Database server hostname") do |host|
+    Oculus.connection_options[:host] = host
+  end
+  opts.on("-P", "--port PORT", "Database server port") do |port|
+    Oculus.connection_options[:port] = port.to_i
+  end
+  opts.on("-u", "--username USER", "Database username") do |username|
+    Oculus.connection_options[:username] = username
+  end
+  opts.on("-p", "--password PASSWORD", "Database password") do |password|
+    Oculus.connection_options[:password] = password
+  end
+  opts.on("-D", "--database DATABASE", "Database to use") do |db|
+    Oculus.connection_options[:database] = db
+  end
+  opts.on("-d", "--data DIRECTORY", "Data cache path (default: tmp/data)") do |path|
+    Oculus.cache_path = path
+  end
+end

data/features/query.feature

@@ -0,0 +1,26 @@
+Feature: Users can query the database
+
+  @javascript
+  Scenario: Running a new query
+    When I execute "SELECT * FROM oculus_users"
+    Then I should see 3 rows of results
+
+  Scenario: Loading a cached query
+    Given a query is cached with results:
+      | id | users |
+      | 1  | Paul  |
+      | 2  | Amy   |
+      | 3  | Peter |
+    When I load the cached query
+    Then I should see 3 rows of results
+
+  @javascript
+  Scenario: Deleting a query
+    Given a query is cached with results:
+      | id | users |
+      | 1  | Paul  |
+      | 2  | Amy   |
+      | 3  | Peter |
+    And I am on the history page
+    When I click delete
+    Then I should not see any queries

data/features/step_definitions/query_steps.rb

@@ -0,0 +1,35 @@
+Given /^a query is cached with results:$/ do |results|
+  Oculus::Query.create(:name => "all users", :query => "SELECT * FROM oculus_users", :results => results.raw)
+end
+
+Given /^I am on the history page$/ do
+  visit '/history'
+end
+
+When /^I execute "([^"]*)"$/ do |query|
+  visit '/'
+  find('.CodeMirror :first-child :first-child').native.send_keys(query)
+  click_button 'Run'
+end
+
+When /^I load the cached query$/ do
+  visit '/history'
+  click_link 'all users'
+end
+
+When /^I click delete$/ do
+  find('.delete').click
+end
+
+Then /^I should see (\d+) rows of results$/ do |result_count|
+  page.has_css?(".results", :visible => true)
+  within('.results') do
+    all('tr').length.should == result_count.to_i
+  end
+end
+
+Then /^I should not see any queries$/ do
+  within('#history') do
+    all('li').length.should == 0
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,22 @@
+$: << File.expand_path(File.join(__FILE__, '..', '..', '..', 'lib'))
+
+require 'oculus'
+require 'oculus/server'
+require 'capybara/cucumber'
+
+Capybara.app = Oculus::Server
+
+Oculus.cache_path = 'tmp/test_cache'
+Oculus.connection_options = {
+  :host => 'localhost',
+  :username => 'root',
+  :database => 'test'
+}
+
+Before do
+  FileUtils.mkdir_p('tmp/test_cache')
+end
+
+After do
+  FileUtils.rm_r('tmp/test_cache')
+end

data/lib/oculus/connection/mysql2.rb

@@ -0,0 +1,22 @@
+require 'mysql2'
+
+module Oculus
+  module Connection
+    class Mysql2
+      def initialize(options = {})
+        @connection = ::Mysql2::Client.new(options)
+      end
+
+      def execute(sql)
+        results = @connection.query(sql)
+        [results.fields] + results.map(&:values) if results
+      rescue ::Mysql2::Error => e
+        raise Connection::Error.new(e.message)
+      end
+
+      def thread_id
+        @connection.thread_id
+      end
+    end
+  end
+end

data/lib/oculus/connection.rb

@@ -0,0 +1,7 @@
+require 'oculus/connection/mysql2'
+
+module Oculus
+  module Connection
+    class Error < StandardError; end
+  end
+end

data/lib/oculus/presenters/query_presenter.rb

@@ -0,0 +1,40 @@
+require 'delegate'
+
+module Oculus
+  module Presenters
+    class QueryPresenter < SimpleDelegator
+      def formatted_date
+        date.strftime("%Y-%m-%d %H:%M") if date
+      end
+
+      def status
+        if complete?
+          if error
+            "error"
+          else
+            "done"
+          end
+        else
+          "loading"
+        end
+      end
+
+      def description
+        if name && name != ""
+          name
+        else
+          query = self.query
+          if query && query.length > 100
+            "#{query[0..97]}..."
+          else
+            query
+          end
+        end
+      end
+
+      def named?
+        !!name
+      end
+    end
+  end
+end

data/lib/oculus/presenters.rb

@@ -0,0 +1 @@
+require 'oculus/presenters/query_presenter'

data/lib/oculus/query.rb

@@ -0,0 +1,61 @@
+module Oculus
+  class Query
+    attr_accessor :id
+    attr_accessor :name
+    attr_accessor :author
+    attr_accessor :query
+    attr_accessor :results
+    attr_accessor :error
+    attr_accessor :date
+    attr_accessor :thread_id
+
+    def initialize(attributes = {})
+      attributes.each do |attr, value|
+        send("#{attr}=", value)
+      end
+    end
+
+    def attributes
+      attrs = {
+        :name        => name,
+        :author      => author,
+        :query       => query,
+        :date        => date,
+        :thread_id   => thread_id
+      }
+      attrs[:error] = error if error
+      attrs
+    end
+
+    def execute(connection)
+      self.results = connection.execute(query)
+    rescue Connection::Error => e
+      self.error = e.message
+    end
+
+    def save
+      @date = Time.now
+      Oculus.data_store.save_query(self)
+    end
+
+    def complete?
+      !!error || (!results.nil? && !results.empty?)
+    end
+
+    def succeeded?
+      complete? && !error
+    end
+
+    class << self
+      def create(attributes)
+        query = new(attributes)
+        query.save
+        query
+      end
+
+      def find(id)
+        Oculus.data_store.load_query(id)
+      end
+    end
+  end
+end