td-client 1.0.0-java

data/spec/td/client/server_status_api_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require 'td/client/spec_resources'
+
+describe 'ServerStatus API' do
+  include_context 'spec symbols'
+  include_context 'common helper'
+
+  let :api do
+    API.new(nil, {:max_cumul_retry_delay => -1})
+  end
+
+  describe 'server_status' do
+    it 'returns status' do
+      stub_api_request(:get, '/v3/system/server_status').
+        to_return(:body => {'status' => 'OK'}.to_json)
+      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)
+      expect(api.server_status).to eq('Server is down (500)')
+    end
+  end
+end

data/spec/td/client/spec_resources.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+require 'td/client/model'
+
+shared_context 'spec symbols' do
+  let :apikey do
+    '1/0123456789ABCDEFG'
+  end
+
+  let :db_name do
+    'db_test'
+  end
+
+  let :table_name do
+    'table_test'
+  end
+
+  let :sched_name do
+    'sched test'
+  end
+
+  let :result_name do
+    'test'
+  end
+
+  let :bi_name do
+    'bi_test'
+  end
+
+  let :cron do
+    '* * * * *'
+  end
+
+  let :query do
+    'select 1'
+  end
+  let :result_url do
+    'td://@/test/table'
+  end
+end
+
+shared_context 'database resources' do
+  include_context 'common helper'
+
+  let :db_names do
+    [
+      'cloud', 'yuffie', 'vincent', 'cid'
+    ]
+  end
+end
+
+shared_context 'job resources' do
+  include_context 'database resources'
+
+  MAX_JOB ||= 20
+
+  let :job_types do
+    [
+      ['HiveJob', 'hive'],
+      ['ExportJob', 'export'],
+      ['BulkImportJob', 'bulk_import'],
+      ['PartialDeleteJob', 'partialdelete']
+    ]
+  end
+
+  let :raw_jobs do
+    created_at = Time.at(1356966000)
+    types = job_types
+    dbs = db_names
+    (0...MAX_JOB).map { |i|
+      job_type = types[i % types.size]
+      status = i.odd? ? 'success' : 'error'
+      {
+        "job_id"             => i,
+        "url"                => "https://console.treasure-data.com/jobs/#{i.to_s}?target=query",
+        "database"           => dbs[i % dbs.size].to_s,
+        "status"             => status,
+        "type"               => job_type[0].to_sym,
+        "query"              => "select #{i}",
+        "priority"           => i % 3,
+        "result"             => nil,
+        "created_at"         => created_at.to_s,
+        "updated_at"         => (created_at + (i * 10)).to_s,
+        "start_at"           => (created_at + (i * 10 * 60)).to_s,
+        "end_at"             => (created_at + (i * 10 * 3600)).to_s,
+        "cpu_time"           => i * 100 + i,
+        "result_size"        => i * 1000,
+        'retry_limit'        => 10,
+        "duration"           => i,
+        "num_records"        => i * 1000,
+        'organization'       => nil,
+        'hive_result_schema' => nil,
+        'debug' => {
+          'stderr' => "job #{i} #{status}",
+          'cmdout' => "job #{i} command",
+        }
+      }
+    }
+  end
+end

data/spec/td/client/table_api_spec.rb

@@ -0,0 +1,226 @@
+require 'spec_helper'
+require 'td/client/spec_resources'
+
+describe 'Table API' do
+  include_context 'spec symbols'
+  include_context 'common helper'
+
+  let :api do
+    API.new(nil)
+  end
+
+  let :client do
+    Client.new(apikey)
+  end
+
+  describe "'create_log_table' API" do
+    it 'should return 404 error if the database does not exist' do
+      err_msg = "Create log table failed: Couldn't find UserDatabase with name = #{db_name}"
+      stub_api_request(:post, "/v3/table/create/#{e db_name}/#{e(table_name)}/log").
+        to_return(:status => 404, :body => {'message' => err_msg}.to_json)
+
+      expect {
+        api.create_log_table(db_name, table_name)
+      }.to raise_error(TreasureData::NotFoundError, /#{err_msg}/)
+    end
+
+    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)
+      expect(api.create_log_table(db_name, table_name)).to be true
+    end
+
+    it 'should return 400 error with invalid name' do
+      invalid_name = 'a'
+      err_msg = "Name must be 3 to 256 characters, got #{invalid_name.length} characters. name = '#{invalid_name}'"
+      stub_api_request(:post, "/v3/table/create/#{e db_name}/#{e invalid_name}/log").
+        to_return(:status => 400, :body => {'message' => err_msg}.to_json)
+
+      expect {
+        api.create_log_table(db_name, invalid_name)
+      }.to raise_error(TreasureData::APIError, /#{err_msg}/)
+    end
+
+    it 'should return 409 error with duplicated name' do
+      err_msg = "Table #{table_name} already exists"
+      stub_api_request(:post, "/v3/table/create/#{e db_name}/#{e table_name}/log").
+        to_return(:status => 409, :body => {'message' => err_msg}.to_json)
+
+      expect {
+        api.create_log_table(db_name, table_name)
+      }.to raise_error(TreasureData::AlreadyExistsError, /#{err_msg}/)
+    end
+  end
+
+  describe "'list_tables' API" do
+    it 'should list the tables in a Hash whose values include type, count, created_at, updated_at, schema, ...' 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"]
+      ]
+      stub_api_request(:get, "/v3/table/list/#{e db_name}").
+        to_return(:body => {'tables' => [
+          {'name' => tables[0][0], 'type' => tables[0][1], 'schema' => tables[0][2], 'count' => tables[0][3], 'created_at' => tables[0][4], 'updated_at' => tables[0][5]},
+          {'name' => tables[1][0], 'type' => tables[1][1], 'schema' => tables[1][2], 'count' => tables[1][3], 'created_at' => tables[1][4], 'updated_at' => tables[1][5]},
+          {'name' => tables[2][0], 'type' => tables[2][1], 'schema' => tables[2][2], 'count' => tables[2][3], 'created_at' => tables[2][4], 'updated_at' => tables[2][5]},
+          {'name' => tables[3][0], 'type' => tables[3][1], 'schema' => tables[3][2], 'count' => tables[3][3], 'created_at' => tables[3][4], 'updated_at' => tables[3][5]}
+        ]}.to_json)
+
+      table_list = api.list_tables(db_name)
+      tables.each {|table|
+        expect(table_list[table[0]][0]).to eq(table[1].to_sym)
+        expect(table_list[table[0]][1]).to eq(JSON.parse(table[2]))
+        expect(table_list[table[0]][2]).to eq(table[3])
+        expect(table_list[table[0]][3]).to eq(table[4])
+        expect(table_list[table[0]][4]).to eq(table[5])
+      }
+    end
+  end
+
+  describe "'tables' Client API" do
+    it 'should return an array of Table objects' do
+      tables = [
+        ["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' => [
+          {'name' => tables[0][0], 'type' => tables[0][1], 'schema' => tables[0][2], 'count' => tables[0][3], 'created_at' => tables[0][4], 'updated_at' => tables[0][5]},
+          {'name' => tables[1][0], 'type' => tables[1][1], 'schema' => tables[1][2], 'count' => tables[1][3], 'created_at' => tables[1][4], 'updated_at' => tables[1][5]},
+          {'name' => tables[2][0], 'type' => tables[2][1], 'schema' => tables[2][2], 'count' => tables[2][3], 'created_at' => tables[2][4], 'updated_at' => tables[2][5]},
+          {'name' => tables[3][0], 'type' => tables[3][1], 'schema' => tables[3][2], 'count' => tables[3][3], 'created_at' => tables[3][4], 'updated_at' => tables[3][5]}
+        ]}.to_json)
+
+      table_list = client.tables(db_name).sort_by { |e| e.name }
+
+      db_count = 0
+      tables.each {|table|
+        db_count += table[3]
+      }
+
+      # REST API call to fetch the database permission
+      stub_api_request(:get, "/v3/database/list").
+        to_return(:body => {'databases' => [
+          {'name' => db_name, 'count' => db_count, 'created_at' => tables[0][4], 'updated_at' => tables[0][5], 'permission' => 'full_access'}
+        ]}.to_json)
+
+      tables.length.times {|i|
+        expect(table_list[i].db_name).to        eq(db_name)
+        expect(table_list[i].name).to           eq(tables[i][0])
+        expect(table_list[i].type).to           eq(tables[i][1].to_sym)
+        expect(table_list[i].schema.to_json).to eq(eval(tables[i][2]).to_json)
+        expect(table_list[i].count).to          eq(tables[i][3])
+        expect(table_list[i].created_at).to     eq(Time.parse(tables[i][4]))
+        expect(table_list[i].updated_at).to     eq(Time.parse(tables[i][5]))
+
+        # REST API call to fetch the database permission
+        stub_api_request(:get, "/v3/database/list").
+          to_return(:body => {'databases' => [
+            {'name' => db_name, 'count' => db_count, 'created_at' => tables[0][4], 'updated_at' => tables[0][5], 'permission' => 'full_access'}
+          ]}.to_json)
+        expect(table_list[i].permission).to eq(:full_access)
+
+        # set up a trap to check this call never happens
+        # - if it did, the next assertion on the count would fail
+        stub_api_request(:get, "/v3/database/list").
+          to_return(:body => {'databases' => [
+            {'name' => db_name, 'count' => db_count + 100, 'created_at' => tables[0][4], 'updated_at' => tables[0][5], 'permission' => 'full_access'}
+          ]}.to_json)
+        expect(table_list[i].database.count).to eq(db_count)
+      }
+    end
+  end
+
+  describe "'table' Client API" do
+    it 'should return the Table object corresponding to the name' do
+      tables = [
+        ["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' => [
+          {'name' => tables[0][0], 'type' => tables[0][1], 'schema' => tables[0][2], 'count' => tables[0][3], 'created_at' => tables[0][4], 'updated_at' => tables[0][5]},
+          {'name' => tables[1][0], 'type' => tables[1][1], 'schema' => tables[1][2], 'count' => tables[1][3], 'created_at' => tables[1][4], 'updated_at' => tables[1][5]},
+          {'name' => tables[2][0], 'type' => tables[2][1], 'schema' => tables[2][2], 'count' => tables[2][3], 'created_at' => tables[2][4], 'updated_at' => tables[2][5]},
+          {'name' => tables[3][0], 'type' => tables[3][1], 'schema' => tables[3][2], 'count' => tables[3][3], 'created_at' => tables[3][4], 'updated_at' => tables[3][5]}
+        ]}.to_json)
+
+      i = 1
+      table = client.table(db_name, tables[i][0])
+
+      expect(table.name).to           eq(tables[i][0])
+      expect(table.type).to           eq(tables[i][1].to_sym)
+      expect(table.schema.to_json).to eq(eval(tables[i][2]).to_json)
+      expect(table.count).to          eq(tables[i][3])
+      expect(table.created_at).to     eq(Time.parse(tables[i][4]))
+      expect(table.updated_at).to     eq(Time.parse(tables[i][5]))
+    end
+  end
+
+  describe 'swap_table' do
+    it 'should swap tables' do
+      stub_api_request(:post, '/v3/table/swap/db/table1/table2')
+      expect(api.swap_table('db', 'table1', 'table2')).to eq(true)
+    end
+  end
+
+  describe 'update_expire' do
+    it 'should update expiry days' do
+      stub_api_request(:post, '/v3/table/update/db/table').
+        with(:body => {'expire_days' => '5'}).
+        to_return(:body => {'type' => 'type'}.to_json)
+      expect(api.update_expire('db', 'table', 5)).to eq(true)
+    end
+  end
+
+  describe 'tail' do
+    let :packed do
+      s = StringIO.new
+      pk = MessagePack::Packer.new(s)
+      pk.write([1, 2, 3])
+      pk.write([4, 5, 6])
+      pk.flush
+      s.string
+    end
+
+    it 'yields row if block given' do
+      stub_api_request(:get, '/v3/table/tail/db/table').
+        with(:query => {'format' => 'msgpack', 'count' => '10'}).
+        to_return(:body => packed)
+      result = []
+      api.tail('db', 'table', 10) do |row|
+        result << row
+      end
+      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)
+      expect(api.tail('db', 'table', 10)).to eq([[1, 2, 3], [4, 5, 6]])
+    end
+
+    it 'shows deprecated warning for from and to' do
+      stub_api_request(:get, '/v3/table/tail/db/table').
+        with(:query => {'format' => 'msgpack', 'count' => '10'}).
+        to_return(:body => packed)
+      r, w = IO.pipe
+      begin
+        backup = $stderr.dup
+        $stderr.reopen(w)
+        api.tail('db', 'table', 10, 100, 0)
+      ensure
+        $stderr.reopen(backup)
+        w.close
+      end
+      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

@@ -0,0 +1,118 @@
+require 'spec_helper'
+require 'td/client/spec_resources'
+require 'json'
+
+describe 'User API' do
+  include_context 'spec symbols'
+  include_context 'common helper'
+
+  let :api do
+    API.new(nil)
+  end
+
+  describe 'authenticate' do
+    it 'returns apikey' do
+      stub_api_request(:post, "/v3/user/authenticate").
+        to_return(:body => {'apikey' => 'apikey'}.to_json)
+      expect(api.authenticate('user', 'password')).to eq('apikey')
+    end
+
+    it 'raises AuthError for authentication failure' do
+      stub_api_request(:post, "/v3/user/authenticate").
+        to_return(:status => 400, :body => {'apikey' => 'apikey'}.to_json)
+      expect {
+        api.authenticate('user', 'password')
+      }.to raise_error(TreasureData::AuthError)
+    end
+
+    it 'raises APIError for other error' do
+      stub_api_request(:post, "/v3/user/authenticate").
+        to_return(:status => 500, :body => {'apikey' => 'apikey'}.to_json)
+      expect {
+        api.authenticate('user', 'password')
+      }.to raise_error(TreasureData::APIError)
+    end
+  end
+
+  describe 'list_users' 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)
+      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)
+      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)
+      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)
+      expect(api.remove_user('name')).to eq(true)
+    end
+  end
+
+  describe 'change_email' do
+    it 'runs' do
+      stub_api_request(:post, "/v3/user/email/change/name").
+        with(:body => {'email' => 'new@email.com'}).
+        to_return(:body => {}.to_json)
+      expect(api.change_email('name', 'new@email.com')).to eq(true)
+    end
+  end
+
+  describe 'list_apikeys' do
+    it 'runs' do
+      stub_api_request(:get, "/v3/user/apikey/list/name").
+        to_return(:body => {'apikeys' => ['key1', 'key2']}.to_json)
+      expect(api.list_apikeys('name')).to eq(['key1', 'key2'])
+    end
+  end
+
+  describe 'add_apikey' 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)
+      expect(api.add_apikey('name')).to eq(true)
+    end
+  end
+
+  describe 'remove_apikey' do
+    it 'runs' do
+      stub_api_request(:post, "/v3/user/apikey/remove/name").
+        to_return(:body => {}.to_json)
+      expect(api.remove_apikey('name', 'apikey')).to eq(true)
+    end
+  end
+
+  describe 'change password' do
+    it 'runs' do
+      stub_api_request(:post, "/v3/user/password/change/name").
+        with(:body => {'password' => 'password'}).
+        to_return(:body => {}.to_json)
+      expect(api.change_password('name', 'password')).to eq(true)
+    end
+  end
+
+  describe 'change my password' do
+    it 'runs' do
+      stub_api_request(:post, "/v3/user/password/change").
+        with(:body => {'old_password' => 'old_password', 'password' => 'password'}).
+        to_return(:body => {}.to_json)
+      expect(api.change_my_password('old_password', 'password')).to eq(true)
+    end
+  end
+end