td-client 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10f1e7ce3ea3f8b94d5c2d2cce131ef2968c534f
-  data.tar.gz: 24fa95fd8ebb8751ba502265a7d15942e6f5a978
+  metadata.gz: 0a5a7d5958d73f2f32f21250831184d6da0f4ea2
+  data.tar.gz: '049a6d49493d8fdee00e30b6c28fef7c3657ea81'
 SHA512:
-  metadata.gz: e3dce86a68061a523fd51215e1fb37d6f0b654660dbc4c2fd87420d0b155bf8bd5de084b8b0aa4b2a932f130012bf7d7ee49214bcb589fa2d3d4463ba72f8439
-  data.tar.gz: 16ab57b46b6d3c208bcbeb690c1578b30e64d2643ff518f57889ca20c9980be6e387846d2d308b8dbcbdee63c3d25fea768d9c84dcfb3427c1ea63a0d4652e74
+  metadata.gz: eb17173daa47cd38d36555a4d4a5f05e92642d6eaec7724dd45e17ac3890c860f58bf62e907a7628e6ecf8a765b9f68807f1e19c5bae625376c4aa1b8b266f95
+  data.tar.gz: cbd7a86745ae12a10112556418013a74b4734d2e17b44a7661933b5fb7f81db5c2701ab55bbdd865cec0fe62e4af475f3336315eb1c2bb4a3d5835ee73b96e98

data/lib/td/client.rb

@@ -88,9 +88,14 @@ class Client
     raise NotFoundError, "Database '#{db_name}' does not exist"
   end
 
+  # @param [String] db
+  # @param [String] table
+  # @option params [Fixnum] :expire_days days to expire table
+  # @option params [Boolean] :include_v (true) include v column on Hive
+  # @option params [Boolean] :detect_schema (true) detect schema on import
   # @return [true]
-  def create_log_table(db_name, table_name)
-    @api.create_log_table(db_name, table_name)
+  def create_log_table(db_name, table_name, params={})
+    @api.create_log_table(db_name, table_name, params)
   end
 
   # Swap table names
@@ -111,6 +116,16 @@ class Client
     @api.update_schema(db_name, table_name, schema.to_json)
   end
 
+  # @param [String] db
+  # @param [String] table
+  # @option params [Fixnum] :expire_days days to expire table
+  # @option params [Boolean] :include_v (true) include v column on Hive
+  # @option params [Boolean] :detect_schema (true) detect schema on import
+  # @return [true]
+  def update_table(db_name, table_name, params={})
+    @api.update_table(db_name, table_name, params)
+  end
+
   # @param [String] db_name
   # @param [String] table_name
   # @param [Fixnum] expire_days
@@ -130,10 +145,10 @@ class Client
   # @return [Array] Tables
   def tables(db_name)
     m = @api.list_tables(db_name)
-    m.map {|table_name, (type, schema, count, created_at, updated_at, estimated_storage_size, last_import, last_log_timestamp, expire_days)|
+    m.map {|table_name, (type, schema, count, created_at, updated_at, estimated_storage_size, last_import, last_log_timestamp, expire_days, include_v)|
       schema = Schema.new.from_json(schema)
       Table.new(self, db_name, table_name, type, schema, count, created_at, updated_at,
-        estimated_storage_size, last_import, last_log_timestamp, expire_days)
+        estimated_storage_size, last_import, last_log_timestamp, expire_days, include_v)
     }
   end
 

data/lib/td/client/api/job.rb

@@ -6,7 +6,7 @@ module Job
   ##
 
   # @param [Fixnum] from
-  # @param [Fixnum] to
+  # @param [Fixnum] to (to is inclusive)
   # @param [String] status
   # @param [Hash] conditions
   # @return [Array]

data/lib/td/client/api/schedule.rb

@@ -66,7 +66,7 @@ module Schedule
 
   # @param [String] name
   # @param [Fixnum] from
-  # @param [Fixnum] to
+  # @param [Fixnum] to (to is exclusive)
   # @return [Array]
   def history(name, from=0, to=nil)
     params = {}

data/lib/td/client/api/table.rb

@@ -25,16 +25,18 @@ module Table
       estimated_storage_size = m['estimated_storage_size'].to_i
       schema = JSON.parse(m['schema'] || '[]')
       expire_days = m['expire_days']
-      result[name] = [type, schema, count, created_at, updated_at, estimated_storage_size, last_import, last_log_timestamp, expire_days]
+      include_v = m['include_v']
+      result[name] = [type, schema, count, created_at, updated_at, estimated_storage_size, last_import, last_log_timestamp, expire_days, include_v]
     }
     return result
   end
 
   # @param [String] db
   # @param [String] table
+  # @param [Hash] params
   # @return [true]
-  def create_log_table(db, table)
-    create_table(db, table, :log)
+  def create_log_table(db, table, params={})
+    create_table(db, table, :log, params)
   end
 
   # @param [String] db
@@ -81,9 +83,19 @@ module Table
   # @param [Fixnum] expire_days
   # @return [true]
   def update_expire(db, table, expire_days)
-    code, body, res = post("/v3/table/update/#{e db}/#{e table}", {'expire_days'=>expire_days})
+    update_table(db, table, {:expire_days=>expire_days})
+  end
+
+  # @param [String] db
+  # @param [String] table
+  # @option params [Fixnum] :expire_days days to expire table
+  # @option params [Boolean] :include_v (true) include v column on Hive
+  # @option params [Boolean] :detect_schema (true) detect schema on import
+  # @return [true]
+  def update_table(db, table, params={})
+    code, body, res = post("/v3/table/update/#{e db}/#{e table}", params)
     if code != "200"
-      raise_error("Update table expiration failed", res)
+      raise_error("Update table failed", res)
     end
     return true
   end

data/lib/td/client/model.rb

@@ -153,7 +153,7 @@ class Table < Model
   # @param [String] last_import
   # @param [String] last_log_timestamp
   # @param [Fixnum, String] expire_days
-  def initialize(client, db_name, table_name, type, schema, count, created_at=nil, updated_at=nil, estimated_storage_size=nil, last_import=nil, last_log_timestamp=nil, expire_days=nil)
+  def initialize(client, db_name, table_name, type, schema, count, created_at=nil, updated_at=nil, estimated_storage_size=nil, last_import=nil, last_log_timestamp=nil, expire_days=nil, include_v=false)
     super(client)
     @database = nil
     @db_name = db_name
@@ -167,6 +167,7 @@ class Table < Model
     @last_import = last_import
     @last_log_timestamp = last_log_timestamp
     @expire_days = expire_days
+    @include_v = include_v
   end
 
   # @!attribute [r] type
@@ -175,7 +176,7 @@ class Table < Model
   # @!attribute [r] schema
   # @!attribute [r] count
   # @!attribute [r] estimated_storage_size
-  attr_reader :type, :db_name, :table_name, :schema, :count, :estimated_storage_size
+  attr_reader :type, :db_name, :table_name, :schema, :count, :estimated_storage_size, :include_v
 
   alias database_name db_name
   alias name table_name
@@ -425,6 +426,7 @@ class Job < Model
     @db_name = db_name
     @duration = duration
     @num_records = num_records
+    @auto_update_status = true
   end
 
   # @!attribute [r] job_id
@@ -440,6 +442,16 @@ class Job < Model
   attr_reader :priority, :retry_limit, :org_name, :db_name
   attr_reader :duration, :num_records
 
+  # whether it update status if the job is not finished yet or not
+  def auto_update_status?
+    @auto_update_status
+  end
+
+  # set whether it update status if the job is not finished yet or not
+  def auto_update_status=(bool)
+    @auto_update_status = bool ? true : false
+  end
+
   # @option timeout [Integer,nil] timeout in second
   # @option wait_interval [Integer,nil] interval in second of polling the job status
   # @param detail [Boolean] update job detail or not
@@ -478,55 +490,55 @@ class Job < Model
 
   # @return [String]
   def query
-    update_status! unless @query || finished?
+    update_status! unless @query || !@auto_update_status || finished?
     @query
   end
 
   # @return [String]
   def status
-    update_status! unless @status || finished?
+    update_status! unless @status || !@auto_update_status || finished?
     @status
   end
 
   # @return [String]
   def url
-    update_status! unless @url || finished?
+    update_status! unless @url || !@auto_update_status || finished?
     @url
   end
 
   # @return [Boolean]
   def debug
-    update_status! unless @debug || finished?
+    update_status! unless @debug || !@auto_update_status || finished?
     @debug
   end
 
   # @return [Time, nil]
   def start_at
-    update_status! unless @start_at || finished?
+    update_status! unless @start_at || !@auto_update_status || finished?
     @start_at && !@start_at.empty? ? Time.parse(@start_at) : nil
   end
 
   # @return [Time, nil]
   def end_at
-    update_status! unless @end_at || finished?
+    update_status! unless @end_at || !@auto_update_status || finished?
     @end_at && !@end_at.empty? ? Time.parse(@end_at) : nil
   end
 
   # @return [String]
   def cpu_time
-    update_status! unless @cpu_time || finished?
+    update_status! unless @cpu_time || !@auto_update_status || finished?
     @cpu_time
   end
 
   # @return [Array]
   def hive_result_schema
-    update_status! unless @hive_result_schema.instance_of? Array || finished?
+    update_status! unless @hive_result_schema.instance_of?(Array) || !@auto_update_status || finished?
     @hive_result_schema
   end
 
   # @return [String]
   def result_size
-    update_status! unless @result_size || finished?
+    update_status! unless @result_size || !@auto_update_status || finished?
     @result_size
   end
 

data/lib/td/client/version.rb

@@ -1,5 +1,5 @@
 module TreasureData
   class Client
-    VERSION = '1.0.4'
+    VERSION = '1.0.5'
   end
 end

data/spec/td/client/model_job_spec.rb

@@ -35,6 +35,56 @@ describe 'Job Model' do
     end
   end
 
+  describe '#auto_update_status' do
+    let(:client) { Client.authenticate('user', 'password') }
+    let(:job_id) { 12345678 }
+    let(:job)    { Job.new(client, job_id, nil, nil) }
+    let(:format) { 'json' }
+    let(:io)     { StringIO.new }
+    before { allow(job).to receive(:finished?) { false } }
+
+    it 'can set' do
+      expect(job.auto_update_status?).to eq true
+      job.auto_update_status = false
+      expect(job.auto_update_status?).to eq false
+      job.auto_update_status = true
+      expect(job.auto_update_status?).to eq true
+    end
+
+    it 'calls API if auto_update_status=true' do
+      job.auto_update_status = true
+      result_job = {
+        'job_id' => job_id,
+        'status' => 'queued',
+        'created_at' => Time.now,
+      }
+      stub_request(:get, "https://api.treasuredata.com/v3/job/show/#{job_id}").
+        to_return(:body => result_job.to_json)
+      expect(job.query).to be_nil
+      expect(job.status).to eq "queued"
+      expect(job.url).to be_nil
+      expect(job.debug).to be_nil
+      expect(job.start_at).to be_nil
+      expect(job.end_at).to be_nil
+      expect(job.cpu_time).to be_nil
+      expect(job.hive_result_schema).to be_nil
+      expect(job.result_size).to be_nil
+    end
+
+    it "doesn't call API if auto_update_status=false" do
+      job.auto_update_status = false
+      expect(job.query).to be_nil
+      expect(job.status).to be_nil
+      expect(job.url).to be_nil
+      expect(job.debug).to be_nil
+      expect(job.start_at).to be_nil
+      expect(job.end_at).to be_nil
+      expect(job.cpu_time).to be_nil
+      expect(job.hive_result_schema).to be_nil
+      expect(job.result_size).to be_nil
+    end
+  end
+
   describe '#result_raw' do
     let(:client) { Client.authenticate('user', 'password') }
     let(:job_id) { 12345678 }

data/spec/td/client/table_api_spec.rb

@@ -30,6 +30,13 @@ describe 'Table API' do
       expect(api.create_log_table(db_name, table_name)).to be true
     end
 
+    it 'should create a new table with params' do
+      stub_api_request(:post, "/v3/table/create/#{e db_name}/#{e(table_name)}/log").
+        with(:body => {'include_v' => 'false'}).
+        to_return(:body => {'database' => db_name, 'table' => table_name, 'type' => 'log', 'include_v' => 'false'}.to_json)
+      expect(api.create_log_table(db_name, table_name, include_v: false)).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}'"
@@ -52,6 +59,52 @@ describe 'Table API' do
     end
   end
 
+  describe "'create_log_table' client 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 {
+        client.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(client.create_log_table(db_name, table_name)).to be true
+    end
+
+    it 'should create a new table with params' do
+      stub_api_request(:post, "/v3/table/create/#{e db_name}/#{e(table_name)}/log").
+        with(:body => {'include_v' => 'false'}).
+        to_return(:body => {'database' => db_name, 'table' => table_name, 'type' => 'log', 'include_v' => 'false'}.to_json)
+      expect(client.create_log_table(db_name, table_name, include_v: false)).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 {
+        client.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 {
+        client.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 = [
@@ -179,6 +232,31 @@ describe 'Table API' do
     end
   end
 
+  describe 'handle include_v' do
+    it 'should set/unset include_v flag' do
+      stub_api_request(:get, '/v3/table/list/db').
+        to_return(:body => {'tables' => [
+          {'name' => 'table', 'type' => 'log', 'include_v' => true},
+        ]}.to_json)
+
+      table = client.table('db', 'table')
+      expect(table.include_v).to eq true
+
+      stub_api_request(:get, '/v3/table/list/db').
+        to_return(:body => {'tables' => [
+          {'name' => 'table', 'type' => 'log', 'include_v' => false},
+        ]}.to_json)
+
+      stub_api_request(:post, '/v3/table/update/db/table').
+        with(:body => {'include_v' => "false"}).
+        to_return(:body => {"database"=>"db","table"=>"table","type"=>"log"}.to_json)
+      api.update_table('db', 'table', include_v: "false")
+
+      table = client.table('db', 'table')
+      expect(table.include_v).to eq false
+    end
+  end
+
   describe 'tail' do
     let :packed do
       s = StringIO.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: td-client
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Treasure Data, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-21 00:00:00.000000000 Z
+date: 2018-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack