rack-queries 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6b814a164ac9b628c813e68cc1ee655d866591bdfda12d4133cf5cf0928ea33b
+  data.tar.gz: ac90a00122cbc69bb2fd41b459dafa815975953d4adc4d62d972e06745ca8aca
+SHA512:
+  metadata.gz: c2f9e59e66e9b4aeb541751e79081219631cfa1858764979407a1e5487c2881accdcec62df67a98a4be9f3fc08a20df357db1d11e86645c4ecac8d2b0f472d91
+  data.tar.gz: 7b17913fb90f412d78c89bd7b1aa17cda8f0d800409d8ec77c83fc112b9ff6cd190d403ca3b0c68cf93ad2d209d9236ab0f51ae56dd7b35f9cc0a34612dade2c

data/.babelrc

@@ -0,0 +1,13 @@
+{
+  "presets": [
+    "@babel/preset-env",
+    "@babel/preset-react"
+  ],
+  "env": {
+    "test": {
+      "presets": [
+        ["@babel/preset-env", { "targets": { "node": "current" } }]
+      ]
+    }
+  }
+}

data/.eslintignore

@@ -0,0 +1,2 @@
+/coverage/
+/lib/rack/queries/static/

data/.eslintrc.json

@@ -0,0 +1,8 @@
+{
+  "extends": "@culturehq",
+  "env": {
+    "browser": true,
+    "jest": true,
+    "node": true
+  }
+}

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/yarn-error.log
+/coverage/
+/doc/
+/node_modules/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  TargetRubyVersion: 2.6
+  Exclude:
+  - 'node_modules/**/*'
+  - 'vendor/**/*'
+
+Style/Documentation:
+  Enabled: false
+
+Style/PerlBackrefs:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+rvm: 2.6.1
+branches:
+  only: master
+before_install:
+- gem update --system
+- gem install bundler
+install:
+- bundle install --jobs=3 --retry=3 --deployment
+- yarn install
+script:
+- bundle exec rake
+- bundle exec rubocop
+- yarn test
+- yarn lint
+cache:
+- bundler
+- yarn

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    rack-queries (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    docile (1.3.1)
+    jaro_winkler (1.5.2)
+    json (2.2.0)
+    minitest (5.11.3)
+    parallel (1.14.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    psych (3.1.0)
+    rack (2.0.6)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rainbow (3.0.0)
+    rake (12.3.2)
+    rubocop (0.65.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sqlite3 (1.4.0)
+    unicode-display_width (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  minitest (~> 5.0)
+  rack (~> 2.0)
+  rack-queries!
+  rack-test (~> 1.1)
+  rake (~> 12.0)
+  rubocop (~> 0.65)
+  simplecov (~> 0.16)
+  sqlite3 (~> 1.4)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Kevin Deisz
+
+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,86 @@
+# Rack::Queries
+
+This gem provides a page in your rack-based (e.g., `Rails`, `Sinatra`) application that allows quick execution of pre-built queries. The goal is to allow quick insights into the state of your application without needing to update the main UI. Consider it a backdoor admin page that you can use before you decide to truly expose query results.
+
+## Usage
+
+First, add `rack-queries` to your Gemfile and `bundle install`. Then, mount the `Rack::Queries::App` application within your app.
+
+Within Rails, that will look like (within `config/routes.rb`):
+
+```ruby
+Rails.application.routes.draw do
+  mount Rack::Queries::App, at: '/queries'
+end
+```
+
+Then, you can go to `/queries` within your application to view the empty queries page.
+
+Second, define the queries that you want included on your query page. Queries are classes that respond to `run(opts)`. The `run` method should return either a single value or an array of arrays (in the UI it will either display one value or a table). The following example returns an overall count:
+
+```ruby
+class UserCountQuery
+  def run(_opts)
+    User.count
+  end
+end
+```
+
+If you want your queries to have arguments (say for instance that users can be scoped to organizations), you define public instance methods on your query class:
+
+```ruby
+class UserPerOrgCountQuery
+  def org
+    Org.order(:name).pluck(:name)
+  end
+
+  def run(opts)
+    Org.where(name: opts['name']).users.count
+  end
+end
+```
+
+Each public instance method is expected to return an array of options (they get transformed into `select` tags in the UI). They are then given to the `run` method through the `opts` hash which contains the value within a string key corresponding to the method name.
+
+Finally, inform `rack-queries` that you want to include the query on your query page by adding it to the list:
+
+```ruby
+Rack::Queries.add(
+  UserCountQuery,
+  UserPerOrgCountQuery
+)
+```
+
+### Middleware
+
+Since `Rack::Queries` is a rack application, you can add whatever middleware you like into its stack before the request hits the application. For instance, to integrate HTTP basic auth around it to protect the query results, you can use the `Rack::Queries::App::use` method as in:
+
+```ruby
+Rack::Queries::App.use(Rack::Auth::Basic) do |username, password|
+  compare = lambda { |left, right|
+    ActiveSupport::SecurityUtils.secure_compare(
+      ::Digest::SHA256.hexdigest(left),
+      ::Digest::SHA256.hexdigest(right)
+    )
+  }
+
+  credentials = Rails.application.credentials
+
+  compare[username, credentials.rack_queries_username] &
+    compare[password, credentials.rack_queries_password]
+end
+```
+
+## 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/CultureHQ/rack-queries.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+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: :test

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'rack/queries'
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/example

@@ -0,0 +1,168 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'forwardable'
+require 'rack'
+require 'sqlite3'
+
+$LOAD_PATH.unshift(File.expand_path(File.join('..', 'lib', 'rack'), __dir__))
+require 'queries'
+
+class Database
+  class IncomprehensibleReturnValueError < ArgumentError
+    def initialize(*)
+      super('SQLite3 return value not understood')
+    end
+  end
+
+  attr_reader :db
+
+  def initialize
+    @db = SQLite3::Database.new(':memory:')
+
+    DATA.read.split(';')[0...-1].each do |query|
+      db.execute(query)
+    end
+  end
+
+  def value_from(query, binds = [])
+    results = execute(query, binds)
+
+    case results
+    when Array
+      results[0][0]
+    when SQLite3::ResultSet
+      results.next[0]
+    else
+      raise IncomprehensibleReturnValueError
+    end
+  end
+
+  def values_from(query, binds = [])
+    execute(query, binds).map(&:first)
+  end
+
+  def rows_from(query, binds = [])
+    execute(query, binds)
+  end
+
+  class << self
+    def instance
+      @instance ||= new
+    end
+
+    extend Forwardable
+    def_delegators :instance, :value_from, :values_from, :rows_from
+  end
+
+  private
+
+  def execute(query, binds)
+    return db.execute(query) if binds.empty?
+
+    stmt = db.prepare(query)
+    stmt.execute(binds)
+  end
+end
+
+module Queries
+  class OrgCountQuery
+    def run(_opts)
+      Database.value_from('SELECT COUNT(*) FROM orgs')
+    end
+  end
+
+  class OrgUsersCountQuery
+    def org_name
+      Database.values_from('SELECT name FROM orgs')
+    end
+
+    def run(opts)
+      query = <<~SQL
+        SELECT COUNT(*) FROM users
+        WHERE org_id = (SELECT id FROM orgs WHERE name = :org_name)
+      SQL
+
+      Database.value_from(query, opts)
+    end
+  end
+
+  class OrgActiveUsersCountQuery
+    def org_name
+      Database.values_from('SELECT name FROM orgs')
+    end
+
+    def run(opts)
+      query = <<~SQL
+        SELECT COUNT(*) FROM users
+        WHERE org_id = (SELECT id FROM orgs WHERE name = :org_name)
+        AND active = 1
+      SQL
+
+      Database.value_from(query, opts)
+    end
+  end
+
+  class UserCountQuery
+    def run(_opts)
+      Database.value_from('SELECT COUNT(*) FROM users')
+    end
+  end
+
+  class UsersQuery
+    def run(_opts)
+      [%w[id org_id active name]] +
+        Database.rows_from('SELECT id, org_id, active, name FROM users')
+    end
+  end
+end
+
+Rack::Queries.add(
+  Queries::OrgCountQuery,
+  Queries::OrgUsersCountQuery,
+  Queries::OrgActiveUsersCountQuery,
+  Queries::UserCountQuery,
+  Queries::UsersQuery
+)
+
+Rack::Server.start(app: Rack::Queries::App, server: 'webrick')
+
+__END__
+CREATE TABLE orgs (
+  id INTEGER,
+  name VARCHAR(255),
+  PRIMARY KEY(id)
+);
+
+CREATE TABLE users (
+  id INTEGER,
+  org_id INTEGER,
+  active BOOLEAN NOT NULL,
+  name VARCHAR(255),
+  PRIMARY KEY(id)
+);
+
+INSERT INTO orgs(name) VALUES
+  ("Parks and Recreation"),
+  ("Dunder Mifflin");
+
+INSERT INTO users(org_id, active, name) VALUES
+  (1, 1, "Leslie Knope"),
+  (1, 1, "Ron Swanson"),
+  (1, 1, "April Ludgate"),
+  (1, 1, "Andy Dwyer"),
+  (1, 1, "Ben Wyatt"),
+  (1, 1, "Tom Haverford"),
+  (1, 1, "Donna Meagle"),
+  (1, 0, "Jerry Gergich"),
+  (2, 1, "Michael Scott"),
+  (2, 1, "Pam Beesley"),
+  (2, 1, "Jim Halpert"),
+  (2, 1, "Dwight Schrute"),
+  (2, 1, "Angela Martin"),
+  (2, 1, "Andy Bernard"),
+  (2, 1, "Kevin Malone"),
+  (2, 0, "Roy Anderson"),
+  (2, 1, "Kelly Kapoor"),
+  (2, 1, "Ryan Howard");