quill-sql 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aac08db9b308774dc3af6239d16abbde87a98162806af1835e1954f5fa95828d
+  data.tar.gz: edf2c32f651d099e12cbb167a87dfff14f06d38d36dbd6bb7f19d768ed182ff1
+SHA512:
+  metadata.gz: 47933c7fe80e0e99e7116795ef81a2fd23c474bd36d2c037ff2424fd0b5a441955277d6d055b71ccbdf183de9d0ef6417722259e1e2e3d1ca06c0c397f8f3ef9
+  data.tar.gz: 34e3e84f8a818572dd5a14df6cdab81d4b3c806b40c704701509c3ce2ff606bc06945745ed8f5605a0158344d993ced6f837465f134949cd843ff2a20af04a0f

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Quill
+
+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,76 @@
+# Quill Ruby SDK
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'quill-sql'
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+## Usage Example
+
+```ruby
+require 'sinatra'
+require 'sinatra/cors'
+require 'json'
+require 'quill-sql'
+
+private_key = "pk_yourprivatekeyhere12345"
+database_type = "clickhouse"
+database_connection_string = "https://[username]:[password]@[hostname]:[port]"
+
+quill = Quill.new(
+  private_key: private_key,
+  database_type: database_type,
+  database_connection_string: database_connection_string
+)
+
+configure do
+  enable :cors
+  set :allow_origin, '*'
+  set :allow_methods, 'GET,POST,OPTIONS'
+  set :allow_headers, 'Content-Type, Authorization'
+end
+
+post '/quill' do
+  content_type :json
+  headers 'Access-Control-Allow-Origin' => '*'
+  metadata = JSON.parse(request.body.read)['metadata']
+  result = quill.query(
+    tenants: [metadata['orgId'] || '*'],
+    metadata: metadata
+  )
+  result.to_json
+end
+
+options '/quill' do
+  response.headers["Allow"] = "GET,POST,OPTIONS"
+  response.headers["Access-Control-Allow-Origin"] = "*"
+  response.headers["Access-Control-Allow-Headers"] = "Content-Type, Authorization"
+  200
+end
+```
+
+## For local testing (dev purposes only)
+
+Create a `.env` file in your project root with the following key-value pairs:
+
+```
+PRIVATE_KEY=
+DB_TYPE=
+DB_URL=
+```
+
+Use the following commands to start a locally hosted dev server:
+
+```bash
+bundle exec ruby server.rb
+```
+
+You should be able to ping your local server at `http://localhost:3007`.