td-client 0.8.82 → 0.8.83

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf42a2c04e997054b7071bd6dc6038738a8857a6
-  data.tar.gz: 360933ff5ee21f22dbb9fce7b5acab14a23006f4
+  metadata.gz: d3662e5e2dfaa4e0eef6afb81bee1ba5eda81b2f
+  data.tar.gz: 4863761d3f0b4851a94348f776a09d923cec2e85
 SHA512:
-  metadata.gz: ab861c2082d0eb19039a928c59e18414f64d31b15303ab4e11144f3290eeb9b29bacbd26ec721d2eb85f25b8935c571c3b0a27ae660885454756fddfae37fbdc
-  data.tar.gz: d562b950d3c9c09d2bf25cef45d2397212a5ea654fc7ca6bf002c403dd9cc76022a0a8db6203f9218ccf40457bfd4fe8c7134592d71875993a5c40181db1e6b4
+  metadata.gz: 4c40f28abe243f4ad108595155324da7c93f56e57ac81564ffcc7dfba6f310a3a22abae62ae8447eb5a9753e0abdad3cfc0611410606d8ba485e9e173f44d2eb
+  data.tar.gz: d5a1d2e957400ab340b0a5ba91634575f08d27029eb363bc8c9d57ba41a55cbf64b2b87e3846a6f200ea846d99371c8b9a9f80dff513a854c584eac050e455fa

data/lib/td/client.rb

@@ -574,9 +574,9 @@ class Client
     @api.bulk_load_show(name)
   end
 
-  # name: String, job: BulkLoad -> BulkLoad
-  def bulk_load_update(name, job)
-    @api.bulk_load_update(name, job)
+  # name: String, settings: Hash -> BulkLoad
+  def bulk_load_update(name, settings)
+    @api.bulk_load_update(name, settings)
   end
 
   # name: String -> BulkLoad

data/lib/td/client/api.rb

@@ -174,7 +174,26 @@ class API
 
   # @param [String] name
   def self.validate_column_name(name)
-    validate_name("column", 1, 255, name)
+    target = 'column'
+    min_len = 1
+    max_len = 128
+    name = name.to_s
+    if name.empty?
+      raise ParameterValidationError,
+            "Empty #{target} name is not allowed"
+    end
+    if name.length < min_len || name.length > max_len
+      raise ParameterValidationError,
+            "#{target.capitalize} name must be between #{min_len} and #{max_len} characters long. Got #{name.length} " +
+            (name.length == 1 ? "character" : "characters") + "."
+    end
+
+    name
+  end
+
+  # @param [String] name
+  def self.validate_sql_alias_name(name)
+    validate_name("sql_alias", 1, 128, name)
   end
 
   # @param [String] name
@@ -199,25 +218,6 @@ class API
     normalize_database_name(name)
   end
 
-  # TODO support array types
-  # @param [String] name
-  def self.normalize_type_name(name)
-    case name
-    when /int/i, /integer/i
-      "int"
-    when /long/i, /bigint/i
-      "long"
-    when /string/i
-      "string"
-    when /float/i
-      "float"
-    when /double/i
-      "double"
-    else
-      raise "Type name must either of int, long, string float or double"
-    end
-  end
-
   # for fluent-plugin-td / td command to check table existence with import onlt user
   # @return [String]
   def self.create_empty_gz_data

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

@@ -116,10 +116,10 @@ module BulkLoad
     JSON.load(res.body)
   end
 
-  # name: String, job: Hash -> Hash
-  def bulk_load_update(name, job)
+  # name: String, settings: Hash -> Hash
+  def bulk_load_update(name, settings)
     path = session_path(name)
-    res = api { put(path, job.to_json) }
+    res = api { put(path, settings.to_json) }
     unless res.ok?
       raise_error("BulkLoadSession: #{name} update failed", res)
     end

data/lib/td/client/model.rb

@@ -269,36 +269,62 @@ class Table < Model
   def update_database!
     @database = @client.database(@db_name)
   end
+
+  # @return [String]
+  def inspect
+    %[#<%s:%#0#{1.size*2}x @db_name="%s" @table_name="%s">] %
+    [self.class.name, self.__id__*2, @db_name, @table_name]
+  end
 end
 
 class Schema
   class Field
     # @param [String] name
     # @param [String] type
-    def initialize(name, type)
+    # @param [String] sql_alias
+    def initialize(name, type, sql_alias=nil)
+      if name == 'v' || name == 'time'
+        raise ParameterValidationError, "Column name '#{name}' is reserved."
+      end
+      API.validate_column_name(name)
+      API.validate_sql_alias_name(sql_alias) if sql_alias
       @name = name
       @type = type
+      @sql_alias = sql_alias
     end
 
     # @!attribute [r] name
     # @!attribute [r] type
     attr_reader :name
     attr_reader :type
+    attr_reader :sql_alias
   end
 
-  # @param [String] cols
+  # @param [String] columns
   # @return [Schema]
-  def self.parse(cols)
-    fields = cols.split(',').map {|col|
-      name, type, *_ = col.split(':')
-      Field.new(name, type)
+  def self.parse(columns)
+    schema = Schema.new
+    columns.each {|column|
+      unless /\A(?<name>.*)(?::(?<type>[^:]+))(?:@(?<sql_alias>[^:@]+))?\z/ =~ column
+        raise ParameterValidationError, "type must be specified"
+      end
+      schema.add_field(name, type, sql_alias)
     }
-    Schema.new(fields)
+    schema
   end
 
   # @param [Array] fields
   def initialize(fields=[])
     @fields = fields
+    @names = {}
+    @fields.each do |f|
+      raise ArgumentError, "Column name '#{f.name}' is duplicated." if @names.key?(f.name)
+      @names[f.name] = true
+      if f.sql_alias
+        raise ArgumentError, "SQL Column alias '#{f.sql_alias}' is duplicated." if @names.key?(f.sql_alias)
+        @names[f.sql_alias] = true
+      end
+    end
   end
 
   # @!attribute [r] fields
@@ -307,8 +333,16 @@ class Schema
   # @param [String] name
   # @param [String] type
   # @return [Array]
-  def add_field(name, type)
-    @fields << Field.new(name, type)
+  def add_field(name, type, sql_alias=nil)
+    if @names.key?(name)
+      raise ParameterValidationError, "Column name '#{name}' is duplicated."
+    end
+    @names[name] = true
+    if sql_alias && @names.key?(sql_alias)
+      raise ParameterValidationError, "SQL Column alias '#{sql_alias}' is duplicated."
+    end
+    @names[sql_alias] = true
+    @fields << Field.new(name, type, sql_alias)
   end
 
   # @param [Schema] schema
@@ -327,14 +361,14 @@ class Schema
 
   # @return [Array<Field>]
   def to_json(*args)
-    @fields.map {|f| [f.name, f.type] }.to_json(*args)
+    @fields.map {|f| f.sql_alias ? [f.name, f.type, f.sql_alias] : [f.name, f.type] }.to_json(*args)
   end
 
   # @param [Object] obj
   # @return [self]
   def from_json(obj)
     @fields = obj.map {|f|
-      Field.new(f[0], f[1])
+      Field.new(*f)
     }
     self
   end
@@ -416,7 +450,7 @@ class Job < Model
         d = t - t1
         t1 = t
         timeout -= d if d > 0
-        raise ::TimeoutError, "timeout=#{orig_timeout} wait_interval=#{wait_interval}" if timeout <= 0
+        raise Timeout::Error, "timeout=#{orig_timeout} wait_interval=#{wait_interval}" if timeout <= 0
       end
       sleep wait_interval
       yield self if block_given?

data/lib/td/client/version.rb

@@ -1,5 +1,5 @@
 module TreasureData
   class Client
-    VERSION = '0.8.82'
+    VERSION = '0.8.83'
   end
 end

data/spec/td/client/api_spec.rb

@@ -126,7 +126,7 @@ describe API do
 
     describe "'validate_column_name'" do
       it 'should raise a ParameterValidationError exception' do
-        ['/', '', 'D'].each { |ng|
+        ['', 'a'*129].each { |ng|
           expect {
             API.validate_column_name(ng)
           }.to raise_error(ParameterValidationError)
@@ -137,14 +137,40 @@ describe API do
         VALID_NAMES.each {|ok|
           expect(API.validate_column_name(ok)).to eq(ok)
         }
-        # columns can be as short as 2 characters
-        expect(API.validate_column_name('ab')).to eq('ab')
+        ['a', 'a'*128].each {|ok|
+          expect(API.validate_column_name(ok)).to eq(ok)
+        }
       end
     end
 
+    describe "'validate_sql_alias_name'" do
+      it 'should raise a ParameterValidationError exception' do
+        ['', 'a'*129].each { |ng|
+          expect{API.validate_sql_alias_name(ng)}.to raise_error(ParameterValidationError)
+        }
+        valid = ("a".."z").to_a.join<<("0".."9").to_a.join<<"_"
+        ("\x00".."\x7F").each { |ng|
+          next if valid.include?(ng)
+          expect{API.validate_sql_alias_name(ng)}.to raise_error(ParameterValidationError)
+        }
+      end
+
+      it 'should return valid data' do
+        VALID_NAMES.each {|ok|
+          expect(API.validate_sql_alias_name(ok)).to eq(ok)
+        }
+        ['a', '_a', 'a_', 'a'*128].each {|ok|
+          expect(API.validate_sql_alias_name(ok)).to eq(ok)
+        }
+      end
+    end
 
     describe "'generic validate_name'" do
       it 'should raise a ParameterValidationError exception' do
+        # wrong target
+        expect {
+          API.validate_name("", 3, 256, '')
+        }.to raise_error(ParameterValidationError)
         INVALID_NAMES.each_pair {|ng,ok|
           expect {
             API.validate_name("generic", 3, 256, ng)

data/spec/td/client/bulk_load_spec.rb

@@ -336,6 +336,31 @@ describe 'BulkImport API' do
         bulk_load_session
       )).to eq(bulk_load_session)
     end
+
+    it 'returns updated bulk_load_session' do
+      updated_bulk_load_session = bulk_load_session.merge({'timezone' => 'America/Los Angeles'})
+      stub_api_request(:put, '/v3/bulk_loads/nahi_test_1').
+        with(:body => updated_bulk_load_session.to_json).
+        to_return(:body => updated_bulk_load_session.to_json)
+      expect(api.bulk_load_update(
+        'nahi_test_1',
+        updated_bulk_load_session
+      )).to eq updated_bulk_load_session
+    end
+
+    it 'can remove the cron schedule ' do
+      updated_bulk_load_session = bulk_load_session.merge({'cron' => ''})
+      # NOTE: currently the API just ignores an empty 'cron' specification update
+      # I am assuming that once fixed, the API will return a nil for cron if unscheduled.
+      expected_bulk_load_session = (bulk_load_session['cron'] = nil)
+      stub_api_request(:put, '/v3/bulk_loads/nahi_test_1').
+        with(:body => updated_bulk_load_session.to_json).
+        to_return(:body => expected_bulk_load_session.to_json)
+      expect(api.bulk_load_update(
+        'nahi_test_1',
+        updated_bulk_load_session
+      )).to eq expected_bulk_load_session
+    end
   end
 
   describe 'delete' do

data/spec/td/client/model_job_spec.rb

@@ -97,7 +97,7 @@ describe 'Job Model' do
             }
             sleep 0.3
             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,10 +108,10 @@ describe 'Job Model' do
 
     context 'with timeout' do
       context 'the job running time is too long' do
-        it 'raise ::TimeoutError' do
+        it 'raise Timeout::Error' do
           expect {
             job.wait(0.1)
-          }.to raise_error(::TimeoutError)
+          }.to raise_error(Timeout::Error)
         end
       end
 
@@ -121,7 +121,7 @@ describe 'Job Model' do
             thread = Thread.start {
               job.wait(0.3, 0.1, &b)
             }
-            expect{ thread.value }.to raise_error(::TimeoutError)
+            expect{ thread.value }.to raise_error(Timeout::Error)
             expect(thread).to be_stop
           ensure
             thread.kill # just in case

data/spec/td/client/table_api_spec.rb

@@ -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' => [

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: td-client
 version: !ruby/object:Gem::Version
-  version: 0.8.82
+  version: 0.8.83
 platform: ruby
 authors:
 - Treasure Data, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-11 00:00:00.000000000 Z
+date: 2016-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -257,7 +257,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.7
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -291,4 +291,3 @@ test_files:
 - spec/td/client/user_api_spec.rb
 - spec/td/client_sched_spec.rb
 - spec/td/client_spec.rb
-has_rdoc: false