Add connection option :ssl for all-defaults SSL connection

Author: sodabrew

README.md

@@ -203,11 +203,13 @@ your MySQL client library and server have been compiled with SSL support.
 MySQL client library defaults will be used for any parameters that are left out
 or set to nil. Relative paths are allowed, and may be required by managed
 hosting providers such as Heroku. Set `:sslverify => true` to require that the
-server presents a valid certificate.
+server presents a valid certificate. Set `:ssl => true` to enable SSL using all
+default values.
 
 ``` ruby
 Mysql2::Client.new(
   # ...options as above...,
+  :ssl => true,
   :sslkey => '/path/to/client-key.pem',
   :sslcert => '/path/to/client-cert.pem',
   :sslca => '/path/to/ca-cert.pem',

lib/mysql2/client.rb

@@ -41,8 +41,11 @@ def initialize(opts = {})
       # force the encoding to utf8
       self.charset_name = opts[:encoding] || 'utf8'
 
+      # Enable SSL if any of the options are configured, or:
+      # :ssl => true requests an all-defaults SSL connection
+      # :ssl => false disables SSL even if configured by the other :ssl* options
       ssl_options = opts.values_at(:sslkey, :sslcert, :sslca, :sslcapath, :sslcipher)
-      ssl_set(*ssl_options) if ssl_options.any?
+      ssl_set(*ssl_options) if ssl_options.any? || (opts[:ssl] && opts[:ssl] != false)
 
       # SSL verify is a connection flag rather than a mysql_ssl_set option
       flags = 0

spec/mysql2/client_spec.rb

@@ -115,6 +115,28 @@ def connect *args
     expect(Mysql2::Client).to respond_to(:default_query_options)
   end
 
+  it "should be able to connect via SSL defaults" do
+    ssl = @client.query "SHOW VARIABLES LIKE 'have_ssl'"
+    ssl_uncompiled = ssl.any? {|x| x['Value'] == 'OFF'}
+    pending("DON'T WORRY, THIS TEST PASSES - but SSL is not compiled into your MySQL daemon.") if ssl_uncompiled
+    ssl_disabled = ssl.any? {|x| x['Value'] == 'DISABLED'}
+    pending("DON'T WORRY, THIS TEST PASSES - but SSL is not enabled in your MySQL daemon.") if ssl_disabled
+
+    ssl_client = nil
+    expect {
+      ssl_client = Mysql2::Client.new(
+        DatabaseCredentials['root'].merge(
+          :ssl       => true
+        )
+      )
+    }.not_to raise_error
+
+    results = Hash[ ssl_client.query('SHOW STATUS WHERE Variable_name LIKE "Ssl_%"').map{ |x| x.values_at('Variable_name', 'Value') } ]
+    expect(results['Ssl_cipher']).not_to be_empty
+    expect(results['Ssl_version']).not_to be_empty
+    ssl_client.close
+  end
+
   it "should be able to connect via SSL options" do
     ssl = @client.query "SHOW VARIABLES LIKE 'have_ssl'"
     ssl_uncompiled = ssl.any? {|x| x['Value'] == 'OFF'}
@@ -137,17 +159,9 @@ def connect *args
       )
     }.not_to raise_error
 
-    results = ssl_client.query("SHOW STATUS WHERE Variable_name = \"Ssl_version\" OR Variable_name = \"Ssl_cipher\"").to_a
-    expect(results[0]['Variable_name']).to eql('Ssl_cipher')
-    expect(results[0]['Value']).not_to be_nil
-    expect(results[0]['Value']).to be_kind_of(String)
-    expect(results[0]['Value']).not_to be_empty
-
-    expect(results[1]['Variable_name']).to eql('Ssl_version')
-    expect(results[1]['Value']).not_to be_nil
-    expect(results[1]['Value']).to be_kind_of(String)
-    expect(results[1]['Value']).not_to be_empty
-
+    results = Hash[ ssl_client.query('SHOW STATUS WHERE Variable_name LIKE "Ssl_%"').map{ |x| x.values_at('Variable_name', 'Value') } ]
+    expect(results['Ssl_cipher']).not_to be_empty
+    expect(results['Ssl_version']).not_to be_empty
     ssl_client.close
   end