pinot 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fa42f97735f850dc0f870866e7d6da882227a998533b3aaa94f7c6a320d20ec
-  data.tar.gz: '019daf46b029bdac3a7c196d0a5f2927234f63ba513873318c5e0f6d48e1d3c6'
+  metadata.gz: dc12c931af8cd247929cbab2185c0ccd69a7d241e750211ba95287af996e3914
+  data.tar.gz: 3682d27b5db1c615f1084af77ef1d64496859a6db92a21a4bdf4d45761f8b741
 SHA512:
-  metadata.gz: 03e285bd5884bae307bd58797738d478f96cf97466ec0e6992dba0de6ab5120f935fba9245c4c5f1466794cf83da4a42dcc30b6819289e736c40cc374a054639
-  data.tar.gz: 07345f9e2e93442855887c208d586d98a0922bc346e19cac7bc58efbea1b4a79aadafaf9abd70692957890211583b2202502fe92996278f7e87f28a503fcfd88
+  metadata.gz: f9a4464727f662abe8c7cace2952076e45ea08802d1380a09568b9c60f4d2b58b6f8bd501f29216e59525a2d54f131bd66d19de12dbb7a5880780dc1bab06831
+  data.tar.gz: 890d0696eb36c2059873a9d8330f584fdd3b6ff13870567f5eee7d69a7fd286f895b9143f6ecc387a150fce460f27e3c7db4b063fb1500d9d849a7403d3c3468

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [0.1.2] - 2024-05-29
+
+- feature: support socks5
+- feature: support authentication bearer token
+
+## [0.1.1] - 2024-05-16
+
+- feature: Add support for controller host
+- fix: handle nil column names
+
 ## [0.1.0] - 2024-01-16
 
 - Initial release

data/README.md

@@ -1,24 +1,71 @@
 # Pinot
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/pinot`. To experiment with that code, run `bin/console` for an interactive prompt.
-
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add pinot
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install pinot
 
 ## Usage
 
-TODO: Write usage instructions here
+To configure our client, we must have some data about our pinot cluster, its broken and controller host, and which port/protocol both services are using. After having this information, we can setup the client to use it.
+
+```ruby
+host = "localhost"
+controller_host = "localhost"
+client = Pinot::Client.new(host: host, port: 443, protocol: :https, controller_host: controller_host, controller_port: 443)
+```
+
+After setting up your client, we can start using it to query the cluster.
+
+```ruby
+client.execute("select * from table;")
+```
+
+After querying, it returns a `HTTPX::ErrorResponse` in case of any HTTP error, like a timeout, or connection refused, we are returning the client's error to make easier to troubleshoot any problem and handle it accordingly.
+
+In case of success, it returns a `Pinot::Response`, an enumerable where you can interact over the returned rows.
+
+Each row is an array with row's values.
+
+```ruby
+result = client.execute("select id, name, age from people;")
+result.each do |row|
+  puts row[0] # id
+  puts row[1] # name
+  puts row[2] # age
+end
+```
+
+If the column names and types are needed, can call `columns` method on the response.
+
+```ruby
+result = client.execute("select count(*) from people;")
+resp.columns
+# {"count(*)"=>"LONG"}
+```
+
+It's not on the public API, but the instance variable `@payload` contains all information returned from the Pinot cluster in case can help with troubleshooting
+
+### Authentication
+
+In case your pinot cluster is using authentication bearer token, you can specify it on the client constructor
+
+```ruby
+client = Pinot::Client.new(bearer_token: "my-secret", **client_args)
+```
+
+### Socks5
+
+Using Pinot cluster inside a VPC and need to jump through a bastion host using socks5? We got your back!
+
+```ruby
+client = Pinot::Client.new(socks5_uri: "socks5://localhost:80", **client_args)
+```
 
 ## Development
 
@@ -28,8 +75,8 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pinot. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/pinot/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/clickfunnels2/pinot. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/clickfunnels2/pinot/blob/main/CODE_OF_CONDUCT.md).
 
 ## Code of Conduct
 
-Everyone interacting in the Pinot project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/pinot/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Pinot project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/clickfunnels2/pinot/blob/main/CODE_OF_CONDUCT.md).

data/lib/pinot/client.rb

@@ -1,17 +1,21 @@
 module Pinot
   class Client
-    attr_reader :host, :port, :controller_host, :controller_port, :protocol
+    attr_reader :host, :port, :controller_host, :controller_port, :protocol, :socks5_uri, :bearer_token
 
-    def initialize(host:, port:, controller_port:, controller_host: nil, protocol: :http)
+    def initialize(host:, port:, controller_port:, controller_host: nil, protocol: :http, socks5_uri: nil, bearer_token: nil)
       @host = host
       @port = port
       @controller_port = controller_port
       @controller_host = controller_host || host
       @protocol = protocol
+      @socks5_uri = socks5_uri
+      @bearer_token = bearer_token
     end
 
     def execute(sql)
-      Response.new(JSON.parse(http.post(query_sql_uri, json: {sql: sql})))
+      response = http.post(query_sql_uri, json: {sql: sql})
+      return response if response.is_a?(HTTPX::ErrorResponse)
+      Response.new(JSON.parse(response))
     end
 
     def schema(name)
@@ -63,7 +67,14 @@ module Pinot
     end
 
     def http(content_type: "application/json")
-      HTTPX.with(headers: {"Content-Type" => content_type})
+      return @http if !@http.nil?
+      default_headers = {"Content-Type" => content_type}
+      default_headers["Authorization"] = "Bearer #{bearer_token}" if bearer_token
+      @http = HTTPX.with(headers: default_headers, timeout: { connect_timeout: 5 })
+      if socks5_uri
+        @http = @http.plugin(:proxy).with_proxy(uri: socks5_uri) if socks5_uri
+      end
+      @http
     end
 
     def uri

data/lib/pinot/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pinot
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pinot
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Celso Fernandes
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-16 00:00:00.000000000 Z
+date: 2024-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpx