td-client 0.8.65 → 0.8.66

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    OWU5OGRlNzY1MWVjOTk3YzY2OTMyNzg2Nzc2ZmIzMTgwNjM3NmRiOA==
-  data.tar.gz: !binary |-
-    MjEzZDA5YzUzYmRmNWFjNzA4Y2JmZDA3ZTc5OTc5YmI1YTI5NTg5Nw==
+SHA1:
+  metadata.gz: 68f45b7f8ac2b35437c0c67488cccc901b244efa
+  data.tar.gz: e15152f3edc04a66e74579f2fb31afa161fe87e0
 SHA512:
-  metadata.gz: !binary |-
-    ZWZhZTI2Mjc1NzRjZDQ4YmVjODRiMGMxZWYwNzE2MzA1MjFjZmFiY2E0Zjdh
-    NzFlM2Q5NDU1ZTVlMjFmNzM5MjI0ZGIzYmMwZDg5YWJjYTM5OTI3NTg2NGI0
-    NzBlY2EyNTYzYWRlNzFhNzI5NjFhYzY4ZGUwNzI2OTIzMzZkZTY=
-  data.tar.gz: !binary |-
-    YTQ1NzFjYmZhZWY5OTM5MmFhNjdiNzJmMjUxMzhmNzc3ZGZjMjNhYjg1YjMy
-    ZTFiNjNmODljOWI4NzQ4M2EzNDU1MDNhYjg0NmU1Njg1YWFmZTM4ZDcwY2Zk
-    NzkzNjQ1YjJhZTRkOTJjZTFhM2JjZDFjY2VhZGVjZGM4ZTJmMDE=
+  metadata.gz: 889a0f5ec860113c7afc442915e4ef3d6d8a43b79d9bb3839874976354488ecedc8282bdc798788fbeffa74242e31d1d9ccf2c9b50b4753766991264bf20ef4d
+  data.tar.gz: 492c0632ffbcd8d9c0cb8b6e7f02228a47d5f73c9500d1cd74104ee70e680dc024060dd201a9abff7fce857d3910bfa2fb73ad0e2e60d1ba0020069cda0a1d6e

data/lib/td/client.rb

@@ -359,7 +359,7 @@ class Client
 
   # => true
   def remove_apikey(user, apikey)
-    @api.remove_apikey(user, g)
+    @api.remove_apikey(user, apikey)
   end
 
   # => true

data/lib/td/client/api.rb

@@ -54,6 +54,7 @@ class API
     @read_timeout = opts[:read_timeout] || 600
     @send_timeout = opts[:send_timeout] || 600
     @retry_post_requests = opts[:retry_post_requests] || false
+    @max_cumul_retry_delay = opts[:max_cumul_retry_delay] || 600
 
     case uri.scheme
     when 'http', 'https'
@@ -962,7 +963,7 @@ class API
       raise_error("Import failed", res)
     end
     js = checked_json(body, %w[])
-    time = js['time'].to_f
+    time = js['elapsed_time'].to_f
     return time
   end
 
@@ -1189,6 +1190,10 @@ class API
     return status
   end
 
+  def ssl_ca_file=(ssl_ca_file)
+    @ssl_ca_file = ssl_ca_file
+  end
+
   private
   module DeflateReadBodyMixin
     attr_accessor :gzip
@@ -1217,6 +1222,12 @@ class API
   end
 
   def get(url, params=nil, &block)
+    guard_no_sslv3 do
+      do_get(url, params, &block)
+    end
+  end
+
+  def do_get(url, params=nil, &block)
     http, header = new_http
 
     path = @base_path + url
@@ -1238,7 +1249,6 @@ class API
 
     # up to 7 retries with exponential (base 2) back-off starting at 'retry_delay'
     retry_delay = 5
-    max_cumul_retry_delay = 600
     cumul_retry_delay = 0
 
     # for both exceptions and 500+ errors retrying is enabled by default.
@@ -1256,7 +1266,7 @@ class API
 
         status = response.code.to_i
         # retry if the HTTP error code is 500 or higher and we did not run out of retrying attempts
-        if !block_given? && status >= 500 && cumul_retry_delay <= max_cumul_retry_delay
+        if !block_given? && status >= 500 && cumul_retry_delay <= @max_cumul_retry_delay
           $stderr.puts "Error #{status}: #{get_error(response)}. Retrying after #{retry_delay} seconds..."
           sleep retry_delay
           cumul_retry_delay += retry_delay
@@ -1268,14 +1278,14 @@ class API
           raise e
         end
         $stderr.print "#{e.class}: #{e.message}. "
-        if cumul_retry_delay <= max_cumul_retry_delay
+        if cumul_retry_delay <= @max_cumul_retry_delay
           $stderr.puts "Retrying after #{retry_delay} seconds..."
           sleep retry_delay
           cumul_retry_delay += retry_delay
           retry_delay *= 2
           retry
         else
-          $stderr.puts "Retrying stopped after #{max_cumul_retry_delay} seconds."
+          $stderr.puts "Retrying stopped after #{@max_cumul_retry_delay} seconds."
           raise e
         end
       rescue => e
@@ -1311,6 +1321,12 @@ class API
   end
 
   def post(url, params=nil)
+    guard_no_sslv3 do
+      do_post(url, params)
+    end
+  end
+
+  def do_post(url, params=nil)
     http, header = new_http
 
     path = @base_path + url
@@ -1332,7 +1348,6 @@ class API
 
     # up to 7 retries with exponential (base 2) back-off starting at 'retry_delay'
     retry_delay = 5
-    max_cumul_retry_delay = 600
     cumul_retry_delay = 0
 
     # for both exceptions and 500+ errors retrying can be enabled by initialization
@@ -1346,7 +1361,7 @@ class API
         # if the HTTP error code is 500 or higher and the user requested retrying
         # on post request, attempt a retry
         status = response.code.to_i
-        if @retry_post_requests && status >= 500 && cumul_retry_delay <= max_cumul_retry_delay
+        if @retry_post_requests && status >= 500 && cumul_retry_delay <= @max_cumul_retry_delay
           $stderr.puts "Error #{status}: #{get_error(response)}. Retrying after #{retry_delay} seconds..."
           sleep retry_delay
           cumul_retry_delay += retry_delay
@@ -1355,14 +1370,14 @@ class API
         end
       rescue Errno::ECONNREFUSED, Errno::ECONNRESET, Timeout::Error, EOFError, OpenSSL::SSL::SSLError, SocketError => e
         $stderr.print "#{e.class}: #{e.message}. "
-        if @retry_post_requests && cumul_retry_delay <= max_cumul_retry_delay
+        if @retry_post_requests && cumul_retry_delay <= @max_cumul_retry_delay
           $stderr.puts "Retrying after #{retry_delay} seconds..."
           sleep retry_delay
           cumul_retry_delay += retry_delay
           retry_delay *= 2
           retry
         else
-          $stderr.puts "Retrying stopped after #{max_cumul_retry_delay} seconds."
+          $stderr.puts "Retrying stopped after #{@max_cumul_retry_delay} seconds."
           raise e
         end
       rescue => e
@@ -1419,6 +1434,19 @@ class API
     "#{schema}://#{host}:#{@port}/#{@base_path + url}"
   end
 
+  def guard_no_sslv3
+    key = :SET_SSL_OP_NO_SSLv3
+    backup = Thread.current[key]
+    begin
+      # Disable SSLv3 connection: See Net::HTTP hack at the bottom
+      Thread.current[key] = true
+      yield
+    ensure
+      # backup could be nil, but assigning nil to TLS means 'delete'
+      Thread.current[key] = backup
+    end
+  end
+
   def new_http(opts = {})
     host = opts[:host] || @host
     http = @http_class.new(host, @port)
@@ -1429,6 +1457,12 @@ class API
       #store = OpenSSL::X509::Store.new
       #http.cert_store = store
       http.ca_file = File.join(ssl_ca_file)
+      # Disable SSLv3 connection in favor of POODLE Attack protection
+      # ruby 1.8.7 uses own @ssl_context instead of calling
+      # SSLContext#set_params.
+      if ctx = http.instance_eval { @ssl_context }
+        ctx.options = OpenSSL::SSL::OP_ALL | OpenSSL::SSL::OP_NO_SSLv3
+      end
     end
 
     header = {}
@@ -1450,6 +1484,8 @@ class API
     if @ssl
       client.ssl_config.add_trust_ca(ssl_ca_file)
       client.ssl_config.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      # Disable SSLv3 connection in favor of POODLE Attack protection
+      client.ssl_config.options |= OpenSSL::SSL::OP_NO_SSLv3
     end
 
     header = {}
@@ -1529,3 +1565,22 @@ class API
 end
 
 end # module TreasureData
+
+require 'openssl'
+module OpenSSL
+  module SSL
+    class SSLContext
+
+      # For disabling SSLv3 connection in favor of POODLE Attack protection
+      #
+      # Allow 'options' customize through Thread local storage since
+      # Net::HTTP does not support 'options' configuration.
+      #
+      alias original_set_params set_params
+      def set_params(params={})
+        original_set_params(params)
+        self.options |= OP_NO_SSLv3 if Thread.current[:SET_SSL_OP_NO_SSLv3]
+      end
+    end
+  end
+end

data/lib/td/client/version.rb

@@ -1,5 +1,5 @@
 module TreasureData
   class Client
-    VERSION = '0.8.65'
+    VERSION = '0.8.66'
   end
 end

data/spec/spec_helper.rb

@@ -8,6 +8,7 @@ end
 
 require 'rspec'
 require 'webmock/rspec'
+WebMock.disable_net_connect!(:allow_localhost => true)
 
 include WebMock::API
 
@@ -24,12 +25,12 @@ shared_context 'common helper' do
   end
 
   let :headers do
-    {'Accept' => '*/*', 'Accept-Encoding' => 'deflate, gzip', 'Date' => /.*/, 'User-Agent' => 'Ruby'}
+    {'Accept' => '*/*', 'Accept-Encoding' => /gzip/, 'Date' => /.*/, 'User-Agent' => /Ruby/}
   end
 
   def stub_api_request(method, path, opts = nil)
     scheme = 'http'
-    with_opts = {:header => headers}
+    with_opts = {:headers => headers}
     if opts
       scheme = 'https' if opts[:ssl]
       with_opts[:query] = opts[:query] if opts[:query]

data/spec/td/client/api_ssl_connection_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+require 'td/client/api'
+require 'logger'
+require 'webrick'
+require 'webrick/https'
+
+describe 'API SSL connection' do
+  DIR = File.dirname(File.expand_path(__FILE__))
+
+  after :each do
+    @server.shutdown
+  end
+
+  it 'should fail to connect SSLv3 only server' do
+    @server = setup_server(:SSLv3)
+    api = API.new(nil, :endpoint => "https://localhost:#{@serverport}", :retry_post_requests => false)
+    api.ssl_ca_file = File.join(DIR, 'ca-all.cert')
+    expect {
+      api.delete_database('no_such_database')
+    }.to raise_error OpenSSL::SSL::SSLError
+  end
+
+  it 'should success to connect TLSv1 only server' do
+    @server = setup_server(:TLSv1)
+    api = API.new(nil, :endpoint => "https://localhost:#{@serverport}", :retry_post_requests => false)
+    api.ssl_ca_file = File.join(DIR, 'ca-all.cert')
+    expect {
+      api.delete_database('no_such_database')
+    }.to raise_error TreasureData::NotFoundError
+  end
+
+  def setup_server(ssl_version)
+    logger = Logger.new(STDERR)
+    logger.level = Logger::Severity::FATAL  # avoid logging SSLError (ERROR level)
+    @server = WEBrick::HTTPServer.new(
+      :BindAddress => "localhost",
+      :Logger => logger,
+      :Port => 0,
+      :AccessLog => [],
+      :DocumentRoot => '.',
+      :SSLEnable => true,
+      :SSLCACertificateFile => File.join(DIR, 'ca.cert'),
+      :SSLCertificate => cert('server.cert'),
+      :SSLPrivateKey => key('server.key')
+    )
+    @serverport = @server.config[:Port]
+    @server.mount(
+      '/hello',
+      WEBrick::HTTPServlet::ProcHandler.new(method(:do_hello).to_proc)
+    )
+    @server.ssl_context.ssl_version = ssl_version
+    @server_thread = start_server_thread(@server)
+    return @server
+  end
+
+  def do_hello(req, res)
+    res['content-type'] = 'text/html'
+    res.body = "hello"
+  end
+
+  def start_server_thread(server)
+    t = Thread.new {
+      Thread.current.abort_on_exception = true
+      server.start
+    }
+    while server.status != :Running
+      sleep 0.1
+      unless t.alive?
+        t.join
+        raise
+      end
+    end
+    t
+  end
+
+  def cert(filename)
+    OpenSSL::X509::Certificate.new(File.read(File.join(DIR, filename)))
+  end
+
+  def key(filename)
+    OpenSSL::PKey::RSA.new(File.read(File.join(DIR, filename)))
+  end
+end

data/spec/td/client/db_api_spec.rb

@@ -18,7 +18,7 @@ describe 'Database API' do
       stub_api_request(:post, "/v3/database/create/#{e(db_name)}")
         .to_return(:body => {'database' => db_name}.to_json)
 
-      api.create_database(db_name).should be_true
+      api.create_database(db_name).should be true
     end
 
     it 'should return 400 error with invalid name' do

data/spec/td/client/job_api_spec.rb

@@ -10,11 +10,14 @@ describe 'Job API' do
     API.new(nil)
   end
 
+  let :api_with_short_retry do
+    API.new(nil, {:max_cumul_retry_delay => 10})
+  end
+
   describe 'list_jobs' do
     it 'should returns 20 jobs by default' do
       stub_api_request(:get, "/v3/job/list", :query => {'from' => '0'}).to_return(:body => {'jobs' => raw_jobs}.to_json)
       jobs = api.list_jobs
-      puts jobs.size
       jobs.size.should == 20
     end
 
@@ -102,7 +105,7 @@ describe 'Job API' do
       stub_api_request(:get, "/v3/job/show/#{e(invalid_id)}").to_return(:status => 500, :body => body.to_json)
 
       expect {
-        api.show_job(invalid_id)
+        api_with_short_retry.show_job(invalid_id)
       }.to raise_error(TreasureData::APIError, /'job_id' parameter is required but missing/)
     end
   end

data/spec/td/client/result_api_spec.rb

@@ -14,7 +14,7 @@ describe 'Result API' do
       params = {'url' => result_url}
       stub_api_request(:post, "/v3/result/create/#{e(result_name)}").with(:body => params).to_return(:body => {'result' => result_name})
 
-      api.create_result(result_name, result_url).should be_true
+      api.create_result(result_name, result_url).should be true
     end
 
     it 'should return 422 error with invalid name' do

data/spec/td/client/sched_api_spec.rb

@@ -17,21 +17,21 @@ describe 'Schedule API' do
     it 'should create a new schedule' do
       start = Time.now
       stub_api_request(:post, "/v3/schedule/create/#{e(sched_name)}")
-        .with(opts.merge('type' => 'hive'))
+        .with(:body => opts.merge('type' => 'hive'))
         .to_return(:body => {'name' => sched_name, 'start' => start.to_s}.to_json)
 
-      api.create_schedule(sched_name, opts).should == start.to_s
+      api.create_schedule(sched_name, opts.merge('type' => 'hive')).should == start.to_s
     end
 
     it 'should return 422 error with invalid name' do
       name = '1'
       err_msg = "Validation failed: Name is too short" # " (minimum is 3 characters)"
       stub_api_request(:post, "/v3/schedule/create/#{e(name)}")
-        .with(opts.merge('type' => 'hive'))
+        .with(:body => opts.merge('type' => 'hive'))
         .to_return(:status => 422, :body => {'message' => err_msg}.to_json)
 
       expect {
-        api.create_schedule(name, opts)
+        api.create_schedule(name, opts.merge('type' => 'hive'))
       }.to raise_error(TreasureData::APIError, /#{err_msg}/)
     end
   end
@@ -46,18 +46,17 @@ describe 'Schedule API' do
 
     it 'should not return 414 even if the query text is very long' do
       stub_api_request(:post, "/v3/schedule/update/#{e(sched_name)}")
-        .with(opts.merge('type' => 'pig'))
+        .with(:body => opts.merge('type' => 'pig'))
         .to_return(:body => {'name' => sched_name, 'query' => pig_query}.to_json)
 
-      err_msg = "Update schedule failed: Request-URI Too Long"
       expect {
-        api.update_schedule(sched_name, opts)
+        api.update_schedule(sched_name, opts.merge('type' => 'pig'))
       }.not_to raise_error
     end
 
     it 'should update the schedule with the new query' do
       stub_api_request(:post, "/v3/schedule/update/#{e(sched_name)}")
-        .with(opts.merge('type' => 'pig'))
+        .with(:body => opts.merge('type' => 'pig'))
         .to_return(:body => {'name' => sched_name, 'query' => pig_query}.to_json)
 
       stub_api_request(:get, "/v3/schedule/list")

data/spec/td/client/table_api_spec.rb

@@ -27,7 +27,7 @@ describe 'Table API' do
     it 'should create a new table if the database exists' do
       stub_api_request(:post, "/v3/table/create/#{e db_name}/#{e(table_name)}/log")
         .to_return(:body => {'database' => db_name, 'table' => table_name, 'type' => 'log'}.to_json)
-      api.create_log_table(db_name, table_name).should be_true
+      api.create_log_table(db_name, table_name).should be true
     end
 
     it 'should return 400 error with invalid name' do

metadata

@@ -1,141 +1,141 @@
 --- !ruby/object:Gem::Specification
 name: td-client
 version: !ruby/object:Gem::Version
-  version: 0.8.65
+  version: 0.8.66
 platform: ruby
 authors:
 - Treasure Data, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-15 00:00:00.000000000 Z
+date: 2014-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.4
-    - - ! '!='
+    - - "!="
       - !ruby/object:Gem::Version
         version: 0.5.0
-    - - ! '!='
+    - - "!="
       - !ruby/object:Gem::Version
         version: 0.5.1
-    - - ! '!='
+    - - "!="
       - !ruby/object:Gem::Version
         version: 0.5.2
-    - - ! '!='
+    - - "!="
       - !ruby/object:Gem::Version
         version: 0.5.3
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.4
-    - - ! '!='
+    - - "!="
       - !ruby/object:Gem::Version
         version: 0.5.0
-    - - ! '!='
+    - - "!="
       - !ruby/object:Gem::Version
         version: 0.5.1
-    - - ! '!='
+    - - "!="
       - !ruby/object:Gem::Version
         version: 0.5.2
-    - - ! '!='
+    - - "!="
       - !ruby/object:Gem::Version
         version: 0.5.3
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.7.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.7.6
 - !ruby/object:Gem::Dependency
   name: httpclient
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.8'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Treasure Data API library for Ruby
@@ -153,6 +153,7 @@ files:
 - lib/td/client/version.rb
 - spec/spec_helper.rb
 - spec/td/client/api_spec.rb
+- spec/td/client/api_ssl_connection_spec.rb
 - spec/td/client/bulk_import_spec.rb
 - spec/td/client/db_api_spec.rb
 - spec/td/client/export_api_spec.rb
@@ -171,12 +172,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -187,6 +188,7 @@ specification_version: 4
 summary: Treasure Data API library for Ruby
 test_files:
 - spec/td/client/api_spec.rb
+- spec/td/client/api_ssl_connection_spec.rb
 - spec/td/client/bulk_import_spec.rb
 - spec/td/client/db_api_spec.rb
 - spec/td/client/export_api_spec.rb