presto-client 0.4.16 → 0.4.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c24fbba9d7c847c89172174c795ee15f0a904390
-  data.tar.gz: 79c640e5a3c73c96d2b302954bca4246f2831106
+  metadata.gz: 33c1344d5c5fdbd9243609bee287ead639459b42
+  data.tar.gz: 3930795b17c3c7568f0f907fe7719aeda4552af9
 SHA512:
-  metadata.gz: b53c68da6dac166ffeffa33f4b4b02b0fea9b8febdecd4dfa7233a88ef1ff48434ad18db3255b111bc27c4b3402bf62fca41a9ddfa570e2f33cbaeea706b8b25
-  data.tar.gz: 83e0759cbf3cee85e8c8899307f2c813ecfacd225e7a83c587260bd4d21ff5dbd54af4b641206b2c11d2441763bb98224dff1aa98f8b593894ab86b878a54bb1
+  metadata.gz: 6dacfb03dc4ec93ff88db6dba2cd1d015ddd67fad92fdf25732434763e7ef52c7ab58e58186068bf6cc133e7301fea9f38d03cc0616ffdd7f498ed5c215cddb6
+  data.tar.gz: 06986f8b3bc2f52b518e3e34d0d05a9edade2aae43b3abdd65f80c5f32695eb1fd03042b99f6b0d9bc34b9aab69adea882f6ed458b13966caa27b8f6ce1eda94

data/ChangeLog

@@ -1,11 +1,18 @@
+2016-08-09 version 0.4.17:
+
+* Added support for :ssl option.
+
+
 2016-08-03 version 0.4.16:
 
 * Upgraded Presto model version to 0.151
 
+
 2016-08-03 version 0.4.15:
 
 * decode method of model classes validate Hash type
 
+
 2016-08-02 version 0.4.14:
 
 * Added support for resuming fetching query results by using new `Query.resume(next_uri, options)` method (@tetrakai++)

data/README.md

@@ -14,24 +14,28 @@ require 'presto-client'
 
 # create a client object:
 client = Presto::Client.new(
-  server: "localhost:8880",
+  server: "localhost:8880",   # required option
+  ssl: {verify: false},
   catalog: "native",
   schema: "default",
   user: "frsyuki",
-  time_zone: "US/Pacific", # optional
-  language: "English", # optional
-  properties: {"hello" => "world", "mycatalog.hello" => "world"},  # optional
-  http_proxy: "proxy.example.com:8080", # optional
+  time_zone: "US/Pacific",
+  language: "English",
+  properties: {
+    "hive.force_local_scheduling": true,
+    "raptor.reader_stream_buffer_size": "32MB"
+  },
+  http_proxy: "proxy.example.com:8080",
   http_debug: true,
 )
 
-# run a query and get results:
+# run a query and get results as an array of arrays:
 columns, rows = client.run("select * from sys.node")
 rows.each {|row|
-  p row
+  p row  # row is an array
 }
 
-# run a query and get results as a hash:
+# run a query and get results as an array of hashes:
 results = client.run_with_names("select alpha, 1 AS beta from tablename")
 results.each {|row|
   p row['alpha']   # access by name
@@ -40,32 +44,44 @@ results.each {|row|
   p row.values[1]
 }
 
-# another way to run a query and fetch results streamingly:
-# start running a query on presto
+# run a query and fetch results streamingly:
 client.query("select * from sys.node") do |q|
-  # wait for completion and get columns
+  # get columns:
   q.columns.each {|column|
     puts "column: #{column.name}.#{column.type}"
   }
 
-  # get query results
+  # get query results. it feeds more rows until
+  # query execution finishes:
   q.each_row {|row|
-    p row
+    p row  # row is an array
   }
 end
 ```
 
 ## Options
 
-* **server** sets address[:port] to a Presto coordinator
+* **server** sets address (and port) of a Presto coordinator server.
+* **ssl** enables https.
+  * Setting `true` enables SSL and verifies server certificate using system's built-in certificates.
+  * Setting `{verify: false}` enables SSL but doesn't verify server certificate.
+  * Setting a Hash object enables SSL and verify server certificate with options:
+    * **ca_file**: path of a CA certification file in PEM format
+    * **ca_path**: path of a CA certification directory containing certifications in PEM format
+    * **cert_store**: a `OpenSSL::X509::Store` object used for verification
+    * **client_cert**: a `OpenSSL::X509::Certificate` object as client certificate
+    * **client_key**: a `OpenSSL::PKey::RSA` or `OpenSSL::PKey::DSA` object used for client certificate
 * **catalog** sets catalog (connector) name of Presto such as `hive-cdh4`, `hive-hadoop1`, etc.
-* **schema** sets default schema name of Presto. You can read other schemas by qualified name like `FROM myschema.table1`.
+* **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.
 * **user** sets user name to connect to a Presto.
-* **time_zone** sets time zone of the query. Time zone affects some functions such as `format_datetime`.
-* **language** sets language of the query. Language affects some functions such as `format_datetime`.
+* **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_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
-* **http_timeout** sets timeout in seconds to read data from a server
+* **http_debug** enables debug message to STDOUT for each HTTP requests.
+* **http_open_timeout** sets timeout in seconds to open new HTTP connection.
+* **http_timeout** sets timeout in seconds to read data from a server.
+
+See [RDoc](http://www.rubydoc.info/gems/presto-client/) for the full documentation.
 

data/lib/presto/client/query.rb

@@ -35,8 +35,12 @@ module Presto::Client
         raise ArgumentError, ":server option is required"
       end
 
+      ssl = faraday_ssl_options(options)
+
+      url = "#{ssl ? "https" : "http"}://#{server}"
       proxy = options[:http_proxy] || options[:proxy]  # :proxy is obsoleted
-      faraday = Faraday.new(url: "http://#{server}", proxy: "#{proxy}") do |faraday|
+
+      faraday = Faraday.new(url: url, proxy: "#{proxy}", ssl: ssl) do |faraday|
         #faraday.request :url_encoded
         faraday.response :logger if options[:http_debug]
         faraday.adapter Faraday.default_adapter
@@ -45,7 +49,35 @@ module Presto::Client
       return faraday
     end
 
-    private_class_method :faraday_client
+    def self.faraday_ssl_options(options)
+      ssl = options[:ssl]
+
+      case ssl
+      when true
+        ssl = {verify: true}
+
+      when Hash
+        verify = ssl.fetch(:verify, true)
+        case verify
+        when true
+          # detailed SSL options. pass through to faraday
+        when nil, false
+          ssl = {verify: false}
+        else
+          raise ArgumentError, "Can't convert #{verify.class} of :verify option of :ssl option to true or false"
+        end
+
+      when nil, false
+        ssl = false
+
+      else
+        raise ArgumentError, "Can't convert #{ssl.class} of :ssl option to true, false, or Hash"
+      end
+
+      return ssl
+    end
+
+    private_class_method :faraday_client, :faraday_ssl_options
 
     def initialize(api)
       @api = api

data/lib/presto/client/version.rb

@@ -15,6 +15,6 @@
 #
 module Presto
   module Client
-    VERSION = "0.4.16"
+    VERSION = "0.4.17"
   end
 end

data/spec/statement_client_spec.rb

@@ -101,5 +101,84 @@ describe Presto::Client::StatementClient do
       })
     end.should raise_error(TypeError, /String to Hash/)
   end
+
+  describe "ssl" do
+    it "is disabled by default" do
+      f = Query.__send__(:faraday_client, {
+        server: "localhost",
+      })
+      f.url_prefix.to_s.should == "http://localhost/"
+    end
+
+    it "is enabled with ssl: true" do
+      f = Query.__send__(:faraday_client, {
+        server: "localhost",
+        ssl: true,
+      })
+      f.url_prefix.to_s.should == "https://localhost/"
+      f.ssl.verify?.should == true
+    end
+
+    it "is enabled with ssl: {verify: false}" do
+      f = Query.__send__(:faraday_client, {
+        server: "localhost",
+        ssl: {verify: false}
+      })
+      f.url_prefix.to_s.should == "https://localhost/"
+      f.ssl.verify?.should == false
+    end
+
+    it "rejects invalid ssl: verify: object" do
+      lambda do
+        f = Query.__send__(:faraday_client, {
+          server: "localhost",
+          ssl: {verify: "??"}
+        })
+      end.should raise_error(ArgumentError, /String/)
+    end
+
+    it "is enabled with ssl: Hash" do
+      require 'openssl'
+
+      ssl = {
+        ca_file: "/path/to/dummy.pem",
+        ca_path: "/path/to/pemdir",
+        cert_store: OpenSSL::X509::Store.new,
+        client_cert: OpenSSL::X509::Certificate.new,
+        client_key: OpenSSL::PKey::DSA.new,
+      }
+
+      f = Query.__send__(:faraday_client, {
+        server: "localhost",
+        ssl: ssl,
+      })
+
+      f.url_prefix.to_s.should == "https://localhost/"
+      f.ssl.verify?.should == true
+      f.ssl.ca_file.should == ssl[:ca_file]
+      f.ssl.ca_path.should == ssl[:ca_path]
+      f.ssl.cert_store.should == ssl[:cert_store]
+      f.ssl.client_cert.should == ssl[:client_cert]
+      f.ssl.client_key.should == ssl[:client_key]
+    end
+
+    it "rejects an invalid string" do
+      lambda do
+        Query.__send__(:faraday_client, {
+          server: "localhost",
+          ssl: '??',
+        })
+      end.should raise_error(ArgumentError, /String/)
+    end
+
+    it "rejects an integer" do
+      lambda do
+        Query.__send__(:faraday_client, {
+          server: "localhost",
+          ssl: 3,
+        })
+      end.should raise_error(ArgumentError, /:ssl/)
+    end
+  end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: presto-client
 version: !ruby/object:Gem::Version
-  version: 0.4.16
+  version: 0.4.17
 platform: ruby
 authors:
 - Sadayuki Furuhashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-03 00:00:00.000000000 Z
+date: 2016-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday