presto-client 0.5.9 → 0.5.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 778236be62b2a245780444b105de67acd22e5438
-  data.tar.gz: 227f62d8e1037f10ebfaa43b3899f9c2b9ab558a
+  metadata.gz: 9766f45b1fccb135815e0e24e710a344d3f52758
+  data.tar.gz: 8f08cf0d14c1290665806ff20f72aa0152892897
 SHA512:
-  metadata.gz: 37d25df99ebf6b395f9d2ddfb6359cb66f65437beba8436e37e04b901dfea0ebf0eff6866be4d18c82d9debf01a6860e1c6be8cae1e45cd332554366ec2a588a
-  data.tar.gz: 68e8dd6ae42a3a12be1def41eb4c94d1b467222f8dd1cea9269ba5402aacaa8c62a37b2b3ac35f5241c5429ab1ee73f7d8968bcdd4340c995ff7e56de589a85b
+  metadata.gz: 1b75b118f64cc17d459c6a15954cf785c41f9fe47fa7e3dd31352be4bfbe97b67a8e1564f1d1138d1f3a6743cb9285cea0dc2244c87fae0b8b6f95e3852ae316
+  data.tar.gz: e6237ed2c819394162fd6691e9fcf9e9902db9ea2d173bbecc6352822eaeff70448a998bf06b042c03499c44bd4c5c14f177f97cdeb324594fb6e43d54fc0717

data/ChangeLog

@@ -1,4 +1,9 @@
+2018-03-22 version 0.5.10
+
+* Added client_info, client_tags, and http_headers options.
+
 2018-03-02 version 0.5.9
+
 * Added error_name field at PrestoQueryError
 
 2017-11-13 version 0.5.8

data/README.md

@@ -87,11 +87,14 @@ $ bundle exec rake modelgen:latest
 * **catalog** sets catalog (connector) name of Presto such as `hive-cdh4`, `hive-hadoop1`, etc.
 * **schema** sets default schema name of Presto. You need to use qualified name like `FROM myschema.table1` to use non-default schemas.
 * **source** sets source name to connect to a Presto. This name is shown on Presto web interface.
+* **client_info** sets client info to queries. It can be a string to pass a raw string, or an object that can be encoded to JSON.
+* **client_tags** sets client tags to queries. It needs to be an array of strings. The tags are shown on web interface.
 * **user** sets user name to connect to a Presto.
 * **password** sets a password to connect to Presto using basic auth.
 * **time_zone** sets time zone of queries. Time zone affects some functions such as `format_datetime`.
 * **language** sets language of queries. Language affects some functions such as `format_datetime`.
 * **properties** set session properties. Session properties affect internal behavior such as `hive.force_local_scheduling: true`, `raptor.reader_stream_buffer_size: "32MB"`, etc.
+* **http_headers** sets custom HTTP headers. It must be a Hash of string to string.
 * **http_proxy** sets host:port of a HTTP proxy server.
 * **http_debug** enables debug message to STDOUT for each HTTP requests.
 * **http_open_timeout** sets timeout in seconds to open new HTTP connection.

data/lib/presto/client/faraday_client.rb

@@ -23,6 +23,8 @@ module Presto::Client
     PRESTO_TIME_ZONE = "X-Presto-Time-Zone"
     PRESTO_LANGUAGE = "X-Presto-Language"
     PRESTO_SESSION = "X-Presto-Session"
+    PRESTO_CLIENT_INFO = "X-Presto-Client-Info";
+    PRESTO_CLIENT_TAGS = "X-Presto-Client-Tags";
 
     PRESTO_CURRENT_STATE = "X-Presto-Current-State"
     PRESTO_MAX_WAIT = "X-Presto-Max-Wait"
@@ -118,6 +120,12 @@ module Presto::Client
     if v = options[:properties]
       headers[PrestoHeaders::PRESTO_SESSION] = encode_properties(v)
     end
+    if v = options[:client_info]
+      headers[PrestoHeaders::PRESTO_CLIENT_INFO] = encode_client_info(v)
+    end
+    if v = options[:client_tags]
+      headers[PrestoHeaders::PRESTO_CLIENT_TAGS] = encode_client_tags(v)
+    end
     if options[:enable_x_msgpack]
       # option name is enable_"x"_msgpack because "Accept: application/x-msgpack" header is
       # not officially supported by Presto. We can use this option only if a proxy server
@@ -125,6 +133,9 @@ module Presto::Client
       # name should be enable_msgpack, which might be slightly different behavior.
       headers['Accept'] = 'application/x-msgpack,application/json'
     end
+    if v = options[:http_headers]
+      headers.merge!(v)
+    end
     headers
   end
 
@@ -149,6 +160,18 @@ module Presto::Client
     end.join("\r\n#{PrestoHeaders::PRESTO_SESSION}: ")
   end
 
-  private_class_method :faraday_ssl_options, :optional_headers, :encode_properties
+  def self.encode_client_info(info)
+    if info.is_a?(String)
+      info
+    else
+      JSON.dump(info)
+    end
+  end
+
+  def self.encode_client_tags(tags)
+    Array(tags).join(",")
+  end
+
+  private_class_method :faraday_ssl_options, :optional_headers, :encode_properties, :encode_client_info, :encode_client_tags
 
 end

data/lib/presto/client/version.rb

@@ -15,6 +15,6 @@
 #
 module Presto
   module Client
-    VERSION = "0.5.9"
+    VERSION = "0.5.10"
   end
 end

data/spec/statement_client_spec.rb

@@ -9,7 +9,6 @@ describe Presto::Client::StatementClient do
       schema: "default",
       time_zone: "US/Pacific",
       language: "ja_JP",
-      properties: {"hello" => "world", "name"=>"value"},
       debug: true,
     }
   end
@@ -39,7 +38,6 @@ describe Presto::Client::StatementClient do
               "X-Presto-User" => options[:user],
               "X-Presto-Language" => options[:language],
               "X-Presto-Time-Zone" => options[:time_zone],
-              "X-Presto-Session" => options[:properties].map {|k,v| "#{k}=#{v}"}.join("\r\nX-Presto-Session: ")
     }).to_return(body: response_json.to_json)
 
     StatementClient.new(faraday, query, options)
@@ -64,7 +62,6 @@ describe Presto::Client::StatementClient do
               "X-Presto-User" => options[:user],
               "X-Presto-Language" => options[:language],
               "X-Presto-Time-Zone" => options[:time_zone],
-              "X-Presto-Session" => options[:properties].map {|k,v| "#{k}=#{v}"}.join("\r\nX-Presto-Session: ")
     }).to_return(body: response_json2.to_json)
 
     stub_request(:get, "localhost/v1/next_uri").
@@ -75,7 +72,6 @@ describe Presto::Client::StatementClient do
               "X-Presto-User" => options[:user],
               "X-Presto-Language" => options[:language],
               "X-Presto-Time-Zone" => options[:time_zone],
-              "X-Presto-Session" => options[:properties].map {|k,v| "#{k}=#{v}"}.join("\r\nX-Presto-Session: ")
     }).to_return(body: lambda{|req|if retry_p; response_json.to_json; else; retry_p=true; raise Timeout::Error.new("execution expired"); end })
 
     sc = StatementClient.new(faraday, query, options.merge(http_open_timeout: 1))
@@ -95,7 +91,6 @@ describe Presto::Client::StatementClient do
               "X-Presto-User" => options[:user],
               "X-Presto-Language" => options[:language],
               "X-Presto-Time-Zone" => options[:time_zone],
-              "X-Presto-Session" => options[:properties].map {|k,v| "#{k}=#{v}"}.join("\r\nX-Presto-Session: "),
               "Accept" => "application/x-msgpack,application/json"
     }).to_return(body: MessagePack.dump(response_json2), headers: {"Content-Type" => "application/x-msgpack"})
 
@@ -107,7 +102,6 @@ describe Presto::Client::StatementClient do
               "X-Presto-User" => options[:user],
               "X-Presto-Language" => options[:language],
               "X-Presto-Time-Zone" => options[:time_zone],
-              "X-Presto-Session" => options[:properties].map {|k,v| "#{k}=#{v}"}.join("\r\nX-Presto-Session: "),
               "Accept" => "application/x-msgpack,application/json"
     }).to_return(body: lambda{|req|if retry_p; MessagePack.dump(response_json); else; retry_p=true; raise Timeout::Error.new("execution expired"); end }, headers: {"Content-Type" => "application/x-msgpack"})
 
@@ -147,7 +141,6 @@ describe Presto::Client::StatementClient do
           "X-Presto-User" => options[:user],
           "X-Presto-Language" => options[:language],
           "X-Presto-Time-Zone" => options[:time_zone],
-          "X-Presto-Session" => options[:properties].map {|k,v| "#{k}=#{v}"}.join("\r\nX-Presto-Session: ")
       }
 
       stub_request(:post, "http://localhost/v1/statement").
@@ -179,13 +172,71 @@ describe Presto::Client::StatementClient do
                 "X-Presto-User" => options[:user],
                 "X-Presto-Language" => options[:language],
                 "X-Presto-Time-Zone" => options[:time_zone],
-                "X-Presto-Session" => options[:properties].map {|k,v| "#{k}=#{v}"}.join("\r\nX-Presto-Session: "),
       }).to_return(body: {}.to_json)
 
       Presto::Client.new(options).kill(query_id)
     end
   end
 
+  describe 'advanced HTTP headers' do
+    let(:headers) do
+      {
+        "User-Agent" => "presto-ruby/#{VERSION}",
+        "X-Presto-Catalog" => options[:catalog],
+        "X-Presto-Schema" => options[:schema],
+        "X-Presto-User" => options[:user],
+        "X-Presto-Language" => options[:language],
+        "X-Presto-Time-Zone" => options[:time_zone],
+      }
+    end
+
+    it "sets X-Presto-Session from properties" do
+      options[:properties] = {"hello" => "world", "name"=>"value"}
+
+      stub_request(:post, "localhost/v1/statement").
+        with(body: query,
+             headers: headers.merge({
+               "X-Presto-Session" => options[:properties].map {|k,v| "#{k}=#{v}"}.join("\r\nX-Presto-Session: ")
+             })).
+        to_return(body: response_json.to_json)
+
+      StatementClient.new(faraday, query, options)
+    end
+
+    it "sets X-Presto-Client-Info from client_info" do
+      options[:client_info] = "raw"
+
+      stub_request(:post, "localhost/v1/statement").
+        with(body: query,
+             headers: headers.merge("X-Presto-Client-Info" => "raw")).
+        to_return(body: response_json.to_json)
+
+      StatementClient.new(faraday, query, options)
+    end
+
+    it "sets X-Presto-Client-Info in JSON from client_info" do
+      options[:client_info] = {"k1" => "v1", "k2" => "v2"}
+
+      stub_request(:post, "localhost/v1/statement").
+        with(body: query,
+             headers: headers.merge("X-Presto-Client-Info" => '{"k1":"v1","k2":"v2"}')).
+        to_return(body: response_json.to_json)
+
+      StatementClient.new(faraday, query, options)
+    end
+
+    it "sets X-Presto-Client-Tags" do
+      options[:client_tags] = ["k1:v1", "k2:v2"]
+
+      stub_request(:post, "localhost/v1/statement").
+        with(body: query,
+             headers: headers.merge("X-Presto-Client-Tags" => "k1:v1,k2:v2")).
+        to_return(body: response_json.to_json)
+
+      StatementClient.new(faraday, query, options)
+    end
+  end
+
   describe 'HTTP basic auth' do
     let(:password) { 'abcd' }
 
@@ -199,7 +250,6 @@ describe Presto::Client::StatementClient do
                 "X-Presto-User" => options[:user],
                 "X-Presto-Language" => options[:language],
                 "X-Presto-Time-Zone" => options[:time_zone],
-                "X-Presto-Session" => options[:properties].map {|k,v| "#{k}=#{v}"}.join("\r\nX-Presto-Session: ")
             },
             basic_auth: [options[:user], password]
       ).to_return(body: response_json.to_json)
@@ -336,7 +386,6 @@ describe Presto::Client::StatementClient do
                  "X-Presto-User" => options[:user],
                  "X-Presto-Language" => options[:language],
                  "X-Presto-Time-Zone" => options[:time_zone],
-                 "X-Presto-Session" => options[:properties].map {|k,v| "#{k}=#{v}"}.join("\r\nX-Presto-Session: ")
              }).to_return(body: nested_json.to_json(:max_nesting => false))
 
     StatementClient.new(faraday, query, options)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: presto-client
 version: !ruby/object:Gem::Version
-  version: 0.5.9
+  version: 0.5.10
 platform: ruby
 authors:
 - Sadayuki Furuhashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-02 00:00:00.000000000 Z
+date: 2018-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -169,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Presto client library