expose_db 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2012 Doug Mayer
+
+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 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,51 @@
+ExposeDB
+========
+
+ExposeDB provides raw, read-only access to your data over an HTTP JSON API.
+It uses the excellent [Sinatra][sinatra] and [Sequel][sequel] libraries
+for all of the real work.
+
+WARNING: ExposeDB doesn't offer any secure options, and as such is expected
+         to be used only in a high-trust network!
+
+
+Usage
+-----
+ExposeDB is in a very alpha stage of development, but seems to be doing a
+rudimentary job querying for data. Output options are currently limited to
+*all* fields in a table and is only exposed via JSON.
+
+    expose-db SEQUEL_DATABASE_URI
+
+For example:
+
+    expose-db postgres://user:password@dbhost/my_db
+
+Existing endpoints:
+* `/` - Simple query interface
+* `/my_table` - Get all the records in `my_table` as JSON
+* `/my_table?q=ENCODED_QUERY&values[]=2&values[]=bob` - replace ?'s in ENCODED_QUERY with [2, 'bob']
+
+
+TODO
+----
+* Tests
+* Improve configuration options
+  * HTTP Auth and security
+  * Alternate output formats
+* Better documentation
+
+
+Contributing
+------------
+* Fork this repository
+* Make your changes and submit a pull request
+
+
+License
+-------
+Copyright (c) 2012 Doug Mayer. Distributed under the MIT License.
+See `MIT-LICENSE` for further details.
+
+[sequel]: http://sequel.rubyforge.org/
+[sinatra]: http://sinatra.restafari.org/

data/bin/expose-db

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'rubygems'
+require 'optparse'
+require 'expose_db'
+
+database_uri = nil
+load_libs = []
+server_port = 4567
+
+opts = OptionParser.new do |opts|
+  opts.banner = "ExposeDB: Expose your database as an API."
+  opts.define_head "Usage: expose-db [options] DATABASE_URI"
+  opts.separator ""
+  opts.separator "Examples:"
+  opts.separator "  expose-db postgres://user:password@localhost/my_db"
+  opts.separator ""
+  opts.separator "For more information see README.md"
+  opts.separator ""
+  opts.separator "Options:"
+
+  opts.on "-p", "--port PORT", "Specify the server port number (default: 4567)" do |arg|
+    server_port = arg.to_i
+  end
+
+  opts.on "-r", "--require LIB", "require a driver library (ie: pg, sqlite3, etc)" do |arg|
+    load_libs << arg
+  end
+
+  opts.on "-v", "--version", "Output version and quit" do
+    puts "ExposeDB version #{ExposeDB.version}"
+    exit 0
+  end
+end
+opts.parse!
+
+database_uri = ARGV.shift
+
+if database_uri.nil?
+  puts "ERROR: Please specify a database URI"
+  exit 1
+end
+
+load_libs.each { |lib| require lib }
+
+db = Sequel.connect(database_uri)
+ExposeDB::App.run!(db, port: server_port)
+
+# vim: set ft=ruby:

data/lib/expose_db/app.rb

@@ -0,0 +1,67 @@
+module ExposeDB
+  class App < Sinatra::Base
+    enable :logging
+
+    class << self
+      attr_reader :db
+
+      def run!(sequel_db, *args)
+        @db = sequel_db
+        super(*args)
+      end
+    end
+
+    not_found do
+      "Unable to find that table or record."
+    end
+
+    error do
+      "ERROR: An unhandled error occurred. Check the logs."
+    end
+
+    helpers do
+      def db
+        self.class.db
+      end
+
+      def ensure_table_exists!
+        raise Sinatra::NotFound unless db.table_exists?(table_name)
+      end
+
+      def table_name
+        @table_name ||= params[:table].to_sym
+      end
+
+      def json(obj)
+        MultiJson.dump obj
+      end
+    end
+
+    get '/' do
+      erb :index
+    end
+
+    get '/:table' do
+      ensure_table_exists!
+
+      query = params[:q]
+      values = params[:values] || []
+      dataset = db[table_name]
+
+      if query && query.length > 0
+        dataset = dataset.filter(query, *values)
+      end
+
+      json dataset.to_a
+    end
+
+    get '/:table/:id' do
+      ensure_table_exists!
+
+      id = params[:id]
+      dataset = db[table_name]
+
+      json dataset[id: id]
+    end
+  end
+end

data/lib/expose_db/version.rb

@@ -0,0 +1,11 @@
+module ExposeDB
+  MAJOR   = 0
+  MINOR   = 1
+  TINY    = 0
+
+  VERSION = [MAJOR, MINOR, TINY].join('.')
+
+  def self.version
+    VERSION
+  end
+end

data/lib/expose_db/views/index.erb

@@ -0,0 +1,55 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>ExposeDB Console</title>
+    <style>
+      th {
+        vertical-align: top;
+      }
+      input[type=text] {
+        width: 250px;
+      }
+    </style>
+  </head>
+  <body>
+    <form id="console-form" method="get" action="/">
+      <table>
+        <tbody>
+          <tr>
+            <th>Table Name:</th>
+            <td><input type="text" id="table-name" value="accounts"/></td>
+          </tr>
+          <tr>
+            <th>Query:</th>
+            <td><textarea type="text" name="q" cols="80" rows="5">name = ?</textarea></td>
+          </tr>
+          <tr>
+            <th>Values:</th>
+            <td>
+              <% 1.upto(6) do |n| %>
+                <input type="text" name="values[]" value="<%= n == 1 ? 'Rowe LLC' : '' %>"/>
+                <br/>
+              <% end %>
+            </td>
+          </tr>
+          <tr>
+            <th></th>
+            <td><input type="submit"/></td>
+          </tr>
+        </tbody>
+      </table>
+    </form>
+
+    <script>
+      (function() {
+        var form = document.getElementById('console-form'),
+            tableInput = document.getElementById('table-name');
+
+        form.onsubmit = function() {
+          form.action = "/" + tableInput.value;
+          return true;
+        };
+      })();
+    </script>
+  </body>
+</html>

data/lib/expose_db.rb

@@ -0,0 +1,6 @@
+require 'multi_json'
+require 'sequel'
+require 'sinatra/base'
+
+require 'expose_db/version'
+require 'expose_db/app'

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: expose_db
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Doug Mayer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Expose your database over an API.
+email: doxavore@gmail.com
+executables:
+- expose-db
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- bin/expose-db
+- lib/expose_db.rb
+- lib/expose_db/version.rb
+- lib/expose_db/app.rb
+- lib/expose_db/views/index.erb
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: expose_db
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Expose your database over an API.
+test_files: []