td-client 0.9.0dev2 → 1.0.0

data/spec/td/client/model_job_spec.rb

@@ -26,7 +26,7 @@ describe 'Job Model' do
         'job_id', 'type', 'query', 'status', 'url', 'debug',
         'start_at', 'end_at', 'cpu_time', 'result_size', 'result', 'result_url',
         'hive_result_schema', 'priority', 'retry_limit', 'org_name', 'db_name',
-        'duration'
+        'duration', 'num_records'
       ].map {|name| job_attributes[name]}
     end
 
@@ -43,20 +43,20 @@ describe 'Job Model' do
     let(:io)     { StringIO.new }
 
     context 'not finished?' do
-      before { job.stub(:finished?) { false } }
+      before { allow(job).to receive(:finished?) { false } }
 
       it 'do not call #job_result_raw' do
-        client.should_not_receive(:job_result_raw)
+        expect(client).not_to receive(:job_result_raw)
 
         expect(job.result_raw(format, io)).to_not be
       end
     end
 
     context 'finished?' do
-      before { job.stub(:finished?) { true } }
+      before { allow(job).to receive(:finished?) { true } }
 
       it 'call #job_result_raw' do
-        client.should_receive(:job_result_raw).with(job_id, format, io)
+        expect(client).to receive(:job_result_raw).with(job_id, format, io)
 
         job.result_raw(format, io)
       end
@@ -90,14 +90,17 @@ describe 'Job Model' do
       end
 
       it 'calls a given block in every wait_interval second' do
+        now = 1_400_000_000
+        allow(self).to receive(:sleep){|arg| now += arg }
+        allow(Process).to receive(:clock_gettime){ now }
         expect { |b|
           begin
             thread = Thread.start {
-              job.wait(nil, 0.1, &b)
+              job.wait(nil, 2, &b)
             }
-            sleep 0.3
+            sleep 6
             change_job_status(Job::STATUS_SUCCESS)
-            thread.join(0.5)
+            thread.join(1)
             expect(thread).to be_stop
           ensure
             thread.kill # just in case
@@ -108,12 +111,26 @@ describe 'Job Model' do
 
     context 'with timeout' do
       context 'the job running time is too long' do
-        it 'raise TreasureData::Job::TimeoutError' do
+        it 'raise Timeout::Error' do
           expect {
             job.wait(0.1)
-          }.to raise_error(Job::TimeoutError)
+          }.to raise_error(Timeout::Error)
         end
       end
+
+      it 'calls a given block in every wait_interval second, and timeout' do
+        expect { |b|
+          begin
+            thread = Thread.start {
+              job.wait(0.3, 0.1, &b)
+            }
+            expect{ thread.value }.to raise_error(Timeout::Error)
+            expect(thread).to be_stop
+          ensure
+            thread.kill # just in case
+          end
+        }.to yield_control.at_least(2).times
+      end
     end
   end
 end

data/spec/td/client/model_schedule_spec.rb

@@ -14,11 +14,11 @@ describe 'Schedule Model' do
     let(:num) { 1 }
 
     before do
-      API.stub(:new).with(api_key, {}).and_return(api)
+      allow(API).to receive(:new).with(api_key, {}).and_return(api)
     end
 
     it 'success call api' do
-      api.should_receive(:run_schedule).with(name, time, num).and_return([])
+      expect(api).to receive(:run_schedule).with(name, time, num).and_return([])
 
       schedule.run(time, num)
     end

data/spec/td/client/model_schema_spec.rb

@@ -0,0 +1,134 @@
+require 'spec_helper'
+require 'td/client/spec_resources'
+
+describe 'TreasureData::Schema::Field' do
+  describe '.new' do
+    context 'name="v"' do
+      it 'raises ParameterValidationError' do
+        expect{ Schema::Field.new('v', 'int') }.to raise_error(ParameterValidationError)
+      end
+    end
+    context 'name="time"' do
+      it 'raises ParameterValidationError' do
+        expect{ Schema::Field.new('time', 'int') }.to raise_error(ParameterValidationError)
+      end
+    end
+    context 'name with UTF-8' do
+      it 'works' do
+        name = "\u3042\u3044\u3046"
+        f = Schema::Field.new(name, 'int')
+        expect(f.name).to eq name
+        expect(f.type).to eq 'int'
+        expect(f.sql_alias).to be_nil
+      end
+    end
+    context 'with sql_alias' do
+      it 'raises' do
+        f = Schema::Field.new('t:t', 'int', 'alice')
+        expect(f.name).to eq 't:t'
+        expect(f.type).to eq 'int'
+        expect(f.sql_alias).to eq 'alice'
+      end
+    end
+    context 'with invalid sql_alias' do
+      it 'raises' do
+        expect{ Schema::Field.new('t:t', 'int', 't:t') }.to raise_error(ParameterValidationError)
+      end
+    end
+  end
+end
+
+describe 'TreasureData::Schema' do
+  describe '.parse' do
+    let(:columns){ ["foo:int", "BAR\u3070\u30FC:string@bar", "baz:baz!:array<double>@baz"] }
+    it do
+      sc = Schema.parse(columns)
+      expect(sc.fields.size).to eq 3
+      expect(sc.fields[0].name).to eq 'foo'
+      expect(sc.fields[0].type).to eq 'int'
+      expect(sc.fields[0].sql_alias).to be_nil
+      expect(sc.fields[1].name).to eq "BAR\u3070\u30FC"
+      expect(sc.fields[1].type).to eq 'string'
+      expect(sc.fields[1].sql_alias).to eq 'bar'
+      expect(sc.fields[2].name).to eq 'baz:baz!'
+      expect(sc.fields[2].type).to eq 'array<double>'
+      expect(sc.fields[2].sql_alias).to eq 'baz'
+    end
+  end
+
+  describe '.new' do
+    it do
+      f = Schema::Field.new('a', 'int')
+      sc = Schema.new([f])
+      expect(sc.fields[0]).to eq f
+    end
+  end
+
+  describe '#fields' do
+    it do
+      f = Schema::Field.new('a', 'int')
+      sc = Schema.new([f])
+      expect(sc.fields[0]).to eq f
+    end
+  end
+
+  describe '#add_field' do
+    it do
+      f = Schema::Field.new('a', 'int')
+      sc = Schema.new([f])
+      sc.add_field('b', 'double', 'bb')
+      expect(sc.fields[1].name).to eq 'b'
+    end
+    it 'raises ParameterValidationError if name is duplicated' do
+      f = Schema::Field.new('a', 'int')
+      sc = Schema.new([f])
+      expect{ sc.add_field('a', 'double') }.to raise_error(ParameterValidationError)
+    end
+    it 'raises ParameterValidationError if sql_alias is duplicated' do
+      f = Schema::Field.new('a', 'int')
+      sc = Schema.new([f])
+      expect{ sc.add_field('abc', 'double', 'a') }.to raise_error(ParameterValidationError)
+    end
+  end
+
+  describe '#merge' do
+    it do
+      sc1 = Schema.parse(['foo:int', 'bar:float'])
+      sc2 = Schema.parse(['bar:double', 'baz:string'])
+      sc3 = sc1.merge(sc2)
+      expect(sc3.fields.size).to eq 3
+      expect(sc3.fields[0].name).to eq 'foo'
+      expect(sc3.fields[0].type).to eq 'int'
+      expect(sc3.fields[1].name).to eq 'bar'
+      expect(sc3.fields[1].type).to eq 'double'
+      expect(sc3.fields[2].name).to eq 'baz'
+      expect(sc3.fields[2].type).to eq 'string'
+    end
+    it do
+      sc1 = Schema.parse(['foo:int', 'bar:float'])
+      sc2 = Schema.parse(['bar:double@foo'])
+      expect{ sc1.merge(sc2) }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe '#to_json' do
+    it do
+      sc = Schema.parse(['foo:int', 'bar:float@baz'])
+      expect(sc.to_json).to eq '[["foo","int"],["bar","float","baz"]]'
+    end
+  end
+
+  describe '#from_json' do
+    it do
+      sc = Schema.new
+      sc.from_json [["foo","int"],["bar","float","baz"]]
+      expect(sc.fields.size).to eq 2
+      expect(sc.fields[0].name).to eq 'foo'
+      expect(sc.fields[0].type).to eq 'int'
+      expect(sc.fields[0].sql_alias).to be_nil
+      expect(sc.fields[1].name).to eq 'bar'
+      expect(sc.fields[1].type).to eq 'float'
+      expect(sc.fields[1].sql_alias).to eq 'baz'
+    end
+  end
+end

data/spec/td/client/partial_delete_api_spec.rb

@@ -27,7 +27,7 @@ describe 'PartialDelete API' do
       stub_api_request(:post, "/v3/table/partialdelete/#{e(db_name)}/#{e(table_name)}").with(:body => from_to).
         to_return(:body => {'database' => db_name, 'table' => table_name, 'job_id' => '1'}.to_json)
 
-      api.partial_delete(db_name, table_name, to, from).should == '1'
+      expect(api.partial_delete(db_name, table_name, to, from)).to eq('1')
     end
 
     it 'should return 404 error with non exist database name' do

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}.to_json)
 
-      api.create_result(result_name, result_url).should be true
+      expect(api.create_result(result_name, result_url)).to be true
     end
 
     it 'should return 422 error with invalid name' do
@@ -56,14 +56,14 @@ describe 'Result API' do
     it 'should return name and url' do
       stub_api_request(:get, '/v3/result/list').
         to_return(:body => {'results' => [{'name' => 'name', 'url' => 'url'}]}.to_json)
-      api.list_result.should == [['name', 'url', nil]]
+      expect(api.list_result).to eq([['name', 'url', nil]])
     end
   end
 
   describe 'delete_result' do
     it 'should delete the result' do
       stub_api_request(:post, "/v3/result/delete/#{e(result_name)}")
-      api.delete_result(result_name).should == true
+      expect(api.delete_result(result_name)).to eq(true)
     end
 
     it 'should raise error' do

data/spec/td/client/sched_api_spec.rb

@@ -20,7 +20,15 @@ describe 'Schedule API' do
         with(:body => opts.merge('type' => 'hive')).
         to_return(:body => {'name' => sched_name, 'start' => start.to_s}.to_json)
 
-      api.create_schedule(sched_name, opts.merge('type' => 'hive')).should == start.to_s
+      expect(api.create_schedule(sched_name, opts.merge('type' => 'hive'))).to eq(start.to_s)
+    end
+
+    it 'should create a dummy schedule' do
+      stub_api_request(:post, "/v3/schedule/create/#{e(sched_name)}").
+        with(:body => opts.merge('type' => 'hive')).
+        to_return(:body => {'name' => sched_name, 'start' => nil}.to_json)
+
+      expect(api.create_schedule(sched_name, opts.merge('type' => 'hive'))).to be_nil
     end
 
     it 'should return 422 error with invalid name' do
@@ -40,7 +48,7 @@ describe 'Schedule API' do
     it 'should delete the schedule' do
       stub_api_request(:post, "/v3/schedule/delete/#{e(sched_name)}").
         to_return(:body => {'cron' => 'cron', 'query' => 'query'}.to_json)
-      api.delete_schedule(sched_name).should == ['cron', 'query']
+      expect(api.delete_schedule(sched_name)).to eq(['cron', 'query'])
     end
   end
 
@@ -86,7 +94,7 @@ describe 'Schedule API' do
       stub_api_request(:get, "/v3/schedule/history/#{e(sched_name)}").
         with(:query => {'from' => 0, 'to' => 100}).
         to_return(:body => {'history' => [history]}.to_json)
-        api.history(sched_name, 0, 100).should == [[nil, 'job_id', :type, 'status', 'query', 'start_at', 'end_at', 'result', 'priority', 'database']]
+        expect(api.history(sched_name, 0, 100)).to eq([[nil, 'job_id', :type, 'status', 'query', 'start_at', 'end_at', 'result', 'priority', 'database']])
     end
   end
 
@@ -95,7 +103,7 @@ describe 'Schedule API' do
       stub_api_request(:post, "/v3/schedule/run/#{e(sched_name)}/123456789").
         with(:body => {'num' => '5'}).
         to_return(:body => {'jobs' => [{'job_id' => 'job_id', 'scheduled_at' => 'scheduled_at', 'type' => 'type'}]}.to_json)
-        api.run_schedule(sched_name, 123456789, 5).should == [['job_id', :type, 'scheduled_at']]
+        expect(api.run_schedule(sched_name, 123456789, 5)).to eq([['job_id', :type, 'scheduled_at']])
     end
   end
 end

data/spec/td/client/server_status_api_spec.rb

@@ -13,13 +13,13 @@ describe 'ServerStatus API' do
     it 'returns status' do
       stub_api_request(:get, '/v3/system/server_status').
         to_return(:body => {'status' => 'OK'}.to_json)
-      api.server_status.should == 'OK'
+      expect(api.server_status).to eq('OK')
     end
 
     it 'returns error description' do
       stub_api_request(:get, '/v3/system/server_status').
         to_return(:status => 500)
-      api.server_status.should == 'Server is down (500)'
+      expect(api.server_status).to eq('Server is down (500)')
     end
   end
 end

data/spec/td/client/spec_resources.rb

@@ -86,6 +86,7 @@ shared_context 'job resources' do
         "result_size"        => i * 1000,
         'retry_limit'        => 10,
         "duration"           => i,
+        "num_records"        => i * 1000,
         'organization'       => nil,
         'hive_result_schema' => nil,
         'debug' => {

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
+      expect(api.create_log_table(db_name, table_name)).to be true
     end
 
     it 'should return 400 error with invalid name' do
@@ -82,10 +82,10 @@ describe 'Table API' do
   describe "'tables' Client API" do
     it 'should return an array of Table objects' do
       tables = [
-        ["table_1", "item", "[[\"time\",\"long\"],[\"value\",\"string\"]]", 111, "2013-01-21 01:51:41 UTC", "2014-01-21 01:51:41 UTC"],
-        ["table_2", "log",  "[[\"time\",\"long\"],[\"value\",\"long\"]]",   222, "2013-02-22 02:52:42 UTC", "2014-02-22 02:52:42 UTC"],
-        ["table_3", "item", "[[\"time\",\"long\"],[\"value\",\"string\"]]", 333, "2013-03-23 03:53:43 UTC", "2014-03-23 03:53:43 UTC"],
-        ["table_4", "log",  "[[\"time\",\"long\"],[\"value\",\"long\"]]",   444, "2013-04-24 04:54:44 UTC", "2014-04-24 04:54:44 UTC"]
+        ["table_1", "item", "[[\"value\",\"string\"]]", 111, "2013-01-21 01:51:41 UTC", "2014-01-21 01:51:41 UTC"],
+        ["table_2", "log",  "[[\"value\",\"long\"]]",   222, "2013-02-22 02:52:42 UTC", "2014-02-22 02:52:42 UTC"],
+        ["table_3", "item", "[[\"value\",\"string\"]]", 333, "2013-03-23 03:53:43 UTC", "2014-03-23 03:53:43 UTC"],
+        ["table_4", "log",  "[[\"value\",\"long\"]]",   444, "2013-04-24 04:54:44 UTC", "2014-04-24 04:54:44 UTC"]
       ]
       stub_api_request(:get, "/v3/table/list/#{e db_name}").
         to_return(:body => {'tables' => [
@@ -138,10 +138,10 @@ describe 'Table API' do
   describe "'table' Client API" do
     it 'should return the Table object corresponding to the name' do
       tables = [
-        ["table_1", "item", "[[\"time\",\"long\"],[\"value\",\"string\"]]", 111, "2013-01-21 01:51:41 UTC", "2014-01-21 01:51:41 UTC"],
-        ["table_2", "log",  "[[\"time\",\"long\"],[\"value\",\"long\"]]",   222, "2013-02-22 02:52:42 UTC", "2014-02-22 02:52:42 UTC"],
-        ["table_3", "item", "[[\"time\",\"long\"],[\"value\",\"string\"]]", 333, "2013-03-23 03:53:43 UTC", "2014-03-23 03:53:43 UTC"],
-        ["table_4", "log",  "[[\"time\",\"long\"],[\"value\",\"long\"]]",   444, "2013-04-24 04:54:44 UTC", "2014-04-24 04:54:44 UTC"]
+        ["table_1", "item", "[[\"value\",\"string\"]]", 111, "2013-01-21 01:51:41 UTC", "2014-01-21 01:51:41 UTC"],
+        ["table_2", "log",  "[[\"value\",\"long\"]]",   222, "2013-02-22 02:52:42 UTC", "2014-02-22 02:52:42 UTC"],
+        ["table_3", "item", "[[\"value\",\"string\"]]", 333, "2013-03-23 03:53:43 UTC", "2014-03-23 03:53:43 UTC"],
+        ["table_4", "log",  "[[\"value\",\"long\"]]",   444, "2013-04-24 04:54:44 UTC", "2014-04-24 04:54:44 UTC"]
       ]
       stub_api_request(:get, "/v3/table/list/#{e db_name}").
         to_return(:body => {'tables' => [
@@ -166,7 +166,7 @@ describe 'Table API' do
   describe 'swap_table' do
     it 'should swap tables' do
       stub_api_request(:post, '/v3/table/swap/db/table1/table2')
-      api.swap_table('db', 'table1', 'table2').should == true
+      expect(api.swap_table('db', 'table1', 'table2')).to eq(true)
     end
   end
 
@@ -175,7 +175,7 @@ describe 'Table API' do
       stub_api_request(:post, '/v3/table/update/db/table').
         with(:body => {'expire_days' => '5'}).
         to_return(:body => {'type' => 'type'}.to_json)
-      api.update_expire('db', 'table', 5).should == true
+      expect(api.update_expire('db', 'table', 5)).to eq(true)
     end
   end
 
@@ -197,14 +197,14 @@ describe 'Table API' do
       api.tail('db', 'table', 10) do |row|
         result << row
       end
-      result.should == [[1, 2, 3], [4, 5, 6]]
+      expect(result).to eq([[1, 2, 3], [4, 5, 6]])
     end
 
     it 'returns rows' do
       stub_api_request(:get, '/v3/table/tail/db/table').
         with(:query => {'format' => 'msgpack', 'count' => '10'}).
         to_return(:body => packed)
-      api.tail('db', 'table', 10).should == [[1, 2, 3], [4, 5, 6]]
+      expect(api.tail('db', 'table', 10)).to eq([[1, 2, 3], [4, 5, 6]])
     end
 
     it 'shows deprecated warning for from and to' do
@@ -220,7 +220,7 @@ describe 'Table API' do
         $stderr.reopen(backup)
         w.close
       end
-      r.read.should == %Q(parameter "to" and "from" no longer work\n)
+      expect(r.read).to eq(%Q(parameter "to" and "from" no longer work\n))
     end
   end
 end

data/spec/td/client/user_api_spec.rb

@@ -14,7 +14,7 @@ describe 'User API' do
     it 'returns apikey' do
       stub_api_request(:post, "/v3/user/authenticate").
         to_return(:body => {'apikey' => 'apikey'}.to_json)
-      api.authenticate('user', 'password').should == 'apikey'
+      expect(api.authenticate('user', 'password')).to eq('apikey')
     end
 
     it 'raises AuthError for authentication failure' do
@@ -38,30 +38,30 @@ describe 'User API' do
     it 'returns users' do
       stub_api_request(:get, "/v3/user/list").
         to_return(:body => {'users' => [{'name' => 'name1', 'email' => 'email1'}, {'name' => 'name2', 'email' => 'email2'}]}.to_json)
-      api.list_users.should == [
+      expect(api.list_users).to eq([
         ['name1', nil, nil, 'email1'],
         ['name2', nil, nil, 'email2'],
-      ]
+      ])
     end
   end
 
   describe 'add_user' do
     it 'runs' do
       stub_api_request(:post, "/v3/user/add/name").to_return(:body => {}.to_json)
-      api.add_user('name', "org", 'name+suffix@example.com', 'password').should == true
+      expect(api.add_user('name', "org", 'name+suffix@example.com', 'password')).to eq(true)
     end
 
     # TODO
     it 'does not escape sp but it must be a bug' do
       stub_api_request(:post, "/v3/user/add/!%20%20%20%20@%23$%25%5E&*()_%2B%7C~%2Ecom").to_return(:body => {}.to_json)
-      api.add_user('!    @#$%^&*()_+|~.com', "org", 'name+suffix@example.com', 'password').should == true
+      expect(api.add_user('!    @#$%^&*()_+|~.com', "org", 'name+suffix@example.com', 'password')).to eq(true)
     end
   end
 
   describe 'remove_user' do
     it 'runs' do
       stub_api_request(:post, "/v3/user/remove/name").to_return(:body => {}.to_json)
-      api.remove_user('name').should == true
+      expect(api.remove_user('name')).to eq(true)
     end
   end
 
@@ -70,7 +70,7 @@ describe 'User API' do
       stub_api_request(:post, "/v3/user/email/change/name").
         with(:body => {'email' => 'new@email.com'}).
         to_return(:body => {}.to_json)
-      api.change_email('name', 'new@email.com').should == true
+      expect(api.change_email('name', 'new@email.com')).to eq(true)
     end
   end
 
@@ -78,7 +78,7 @@ describe 'User API' do
     it 'runs' do
       stub_api_request(:get, "/v3/user/apikey/list/name").
         to_return(:body => {'apikeys' => ['key1', 'key2']}.to_json)
-      api.list_apikeys('name').should == ['key1', 'key2']
+      expect(api.list_apikeys('name')).to eq(['key1', 'key2'])
     end
   end
 
@@ -86,7 +86,7 @@ describe 'User API' do
     it 'does not return the generated apikey because you can list apikey afterwards' do
       stub_api_request(:post, "/v3/user/apikey/add/name").
         to_return(:body => {'apikey' => 'apikey'}.to_json)
-      api.add_apikey('name').should == true
+      expect(api.add_apikey('name')).to eq(true)
     end
   end
 
@@ -94,7 +94,7 @@ describe 'User API' do
     it 'runs' do
       stub_api_request(:post, "/v3/user/apikey/remove/name").
         to_return(:body => {}.to_json)
-      api.remove_apikey('name', 'apikey').should == true
+      expect(api.remove_apikey('name', 'apikey')).to eq(true)
     end
   end
 
@@ -103,7 +103,7 @@ describe 'User API' do
       stub_api_request(:post, "/v3/user/password/change/name").
         with(:body => {'password' => 'password'}).
         to_return(:body => {}.to_json)
-      api.change_password('name', 'password').should == true
+      expect(api.change_password('name', 'password')).to eq(true)
     end
   end
 
@@ -112,7 +112,7 @@ describe 'User API' do
       stub_api_request(:post, "/v3/user/password/change").
         with(:body => {'old_password' => 'old_password', 'password' => 'password'}).
         to_return(:body => {}.to_json)
-      api.change_my_password('old_password', 'password').should == true
+      expect(api.change_my_password('old_password', 'password')).to eq(true)
     end
   end
 end