td-client 0.8.67 → 0.8.68

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

@@ -0,0 +1,21 @@
+class TreasureData::API
+module PartialDelete
+
+  ####
+  ## Partial delete API
+  ##
+
+  def partial_delete(db, table, to, from, opts={})
+    params = opts.dup
+    params['to'] = to.to_s
+    params['from'] = from.to_s
+    code, body, res = post("/v3/table/partialdelete/#{e db}/#{e table}", params)
+    if code != "200"
+      raise_error("Partial delete failed", res)
+    end
+    js = checked_json(body, %w[job_id])
+    return js['job_id'].to_s
+  end
+
+end
+end

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

@@ -0,0 +1,41 @@
+class TreasureData::API
+module Result
+
+  ####
+  ## Result API
+  ##
+
+  def list_result
+    code, body, res = get("/v3/result/list")
+    if code != "200"
+      raise_error("List result table failed", res)
+    end
+    js = checked_json(body, %w[results])
+    result = []
+    js['results'].map {|m|
+      result << [m['name'], m['url'], nil] # same as database
+    }
+    return result
+  end
+
+  # => true
+  def create_result(name, url, opts={})
+    params = {'url'=>url}.merge(opts)
+    code, body, res = post("/v3/result/create/#{e name}", params)
+    if code != "200"
+      raise_error("Create result table failed", res)
+    end
+    return true
+  end
+
+  # => true
+  def delete_result(name)
+    code, body, res = post("/v3/result/delete/#{e name}")
+    if code != "200"
+      raise_error("Delete result table failed", res)
+    end
+    return true
+  end
+
+end
+end

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

@@ -0,0 +1,106 @@
+class TreasureData::API
+module Schedule
+
+  ####
+  ## Schedule API
+  ##
+
+  # => start:String
+  def create_schedule(name, opts)
+    params = opts.update({:type=> opts[:type] || opts['type'] || 'hive'})
+    code, body, res = post("/v3/schedule/create/#{e name}", params)
+    if code != "200"
+      raise_error("Create schedule failed", res)
+    end
+    js = checked_json(body, %w[start])
+    return js['start']
+  end
+
+  # => cron:String, query:String
+  def delete_schedule(name)
+    code, body, res = post("/v3/schedule/delete/#{e name}")
+    if code != "200"
+      raise_error("Delete schedule failed", res)
+    end
+    js = checked_json(body, %w[])
+    return js['cron'], js["query"]
+  end
+
+  # => [(name:String, cron:String, query:String, database:String, result_url:String)]
+  def list_schedules
+    code, body, res = get("/v3/schedule/list")
+    if code != "200"
+      raise_error("List schedules failed", res)
+    end
+    js = checked_json(body, %w[schedules])
+    result = []
+    js['schedules'].each {|m|
+      name = m['name']
+      cron = m['cron']
+      query = m['query']
+      database = m['database']
+      result_url = m['result']
+      timezone = m['timezone']
+      delay = m['delay']
+      next_time = m['next_time']
+      priority = m['priority']
+      retry_limit = m['retry_limit']
+      result << [name, cron, query, database, result_url, timezone, delay, next_time, priority, retry_limit, nil] # same as database
+    }
+    return result
+  end
+
+  def update_schedule(name, params)
+    code, body, res = post("/v3/schedule/update/#{e name}", params)
+    if code != "200"
+      raise_error("Update schedule failed", res)
+    end
+    return nil
+  end
+
+  def history(name, from=0, to=nil)
+    params = {}
+    params['from'] = from.to_s if from
+    params['to'] = to.to_s if to
+    code, body, res = get("/v3/schedule/history/#{e name}", params)
+    if code != "200"
+      raise_error("List history failed", res)
+    end
+    js = checked_json(body, %w[history])
+    result = []
+    js['history'].each {|m|
+      job_id = m['job_id']
+      type = (m['type'] || '?').to_sym
+      database = m['database']
+      status = m['status']
+      query = m['query']
+      start_at = m['start_at']
+      end_at = m['end_at']
+      scheduled_at = m['scheduled_at']
+      result_url = m['result']
+      priority = m['priority']
+      result << [scheduled_at, job_id, type, status, query, start_at, end_at, result_url, priority, database]
+    }
+    return result
+  end
+
+  def run_schedule(name, time, num)
+    params = {}
+    params = {'num' => num} if num
+    code, body, res = post("/v3/schedule/run/#{e name}/#{e time}", params)
+    if code != "200"
+      raise_error("Run schedule failed", res)
+    end
+    js = checked_json(body, %w[jobs])
+    result = []
+    js['jobs'].each {|m|
+      job_id = m['job_id']
+      scheduled_at = m['scheduled_at']
+      type = (m['type'] || '?').to_sym
+      result << [job_id, type, scheduled_at]
+    }
+    return result
+  end
+
+end
+end

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

@@ -0,0 +1,20 @@
+class TreasureData::API
+module ServerStatus
+
+  ####
+  ## Server Status API
+  ##
+
+  # => status:String
+  def server_status
+    code, body, res = get('/v3/system/server_status')
+    if code != "200"
+      return "Server is down (#{code})"
+    end
+    js = checked_json(body, %w[status])
+    status = js['status']
+    return status
+  end
+
+end
+end

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

@@ -0,0 +1,123 @@
+class TreasureData::API
+module Table
+
+  ####
+  ## Table API
+  ##
+
+  # => {name:String => [type:Symbol, count:Integer]}
+  def list_tables(db)
+    code, body, res = get("/v3/table/list/#{e db}")
+    if code != "200"
+      raise_error("List tables failed", res)
+    end
+    js = checked_json(body, %w[tables])
+    result = {}
+    js["tables"].map {|m|
+      name = m['name']
+      type = (m['type'] || '?').to_sym
+      count = (m['count'] || 0).to_i  # TODO?
+      created_at = m['created_at']
+      updated_at = m['updated_at']
+      last_import = m['counter_updated_at']
+      last_log_timestamp = m['last_log_timestamp']
+      estimated_storage_size = m['estimated_storage_size'].to_i
+      schema = JSON.parse(m['schema'] || '[]')
+      expire_days = m['expire_days']
+      primary_key = m['primary_key']
+      primary_key_type = m['primary_key_type']
+      result[name] = [type, schema, count, created_at, updated_at, estimated_storage_size, last_import, last_log_timestamp, expire_days, primary_key, primary_key_type]
+    }
+    return result
+  end
+
+  def create_log_or_item_table(db, table, type)
+    code, body, res = post("/v3/table/create/#{e db}/#{e table}/#{type}")
+    if code != "200"
+      raise_error("Create #{type} table failed", res)
+    end
+    return true
+  end
+  private :create_log_or_item_table
+
+  # => true
+  def create_log_table(db, table)
+    create_table(db, table, :log)
+  end
+
+  # => true
+  def create_item_table(db, table, primary_key, primary_key_type)
+    params = {'primary_key' => primary_key, 'primary_key_type' => primary_key_type}
+    create_table(db, table, :item, params)
+  end
+
+  def create_table(db, table, type, params={})
+    schema = schema.to_s
+    code, body, res = post("/v3/table/create/#{e db}/#{e table}/#{type}", params)
+    if code != "200"
+      raise_error("Create #{type} table failed", res)
+    end
+    return true
+  end
+  private :create_table
+
+  # => true
+  def swap_table(db, table1, table2)
+    code, body, res = post("/v3/table/swap/#{e db}/#{e table1}/#{e table2}")
+    if code != "200"
+      raise_error("Swap tables failed", res)
+    end
+    return true
+  end
+
+  # => true
+  def update_schema(db, table, schema_json)
+    code, body, res = post("/v3/table/update-schema/#{e db}/#{e table}", {'schema'=>schema_json})
+    if code != "200"
+      raise_error("Create schema table failed", res)
+    end
+    return true
+  end
+
+  def update_expire(db, table, expire_days)
+    code, body, res = post("/v3/table/update/#{e db}/#{e table}", {'expire_days'=>expire_days})
+    if code != "200"
+      raise_error("Update table expiration failed", res)
+    end
+    return true
+  end
+
+  # => type:Symbol
+  def delete_table(db, table)
+    code, body, res = post("/v3/table/delete/#{e db}/#{e table}")
+    if code != "200"
+      raise_error("Delete table failed", res)
+    end
+    js = checked_json(body, %w[])
+    type = (js['type'] || '?').to_sym
+    return type
+  end
+
+  def tail(db, table, count, to, from, &block)
+    params = {'format' => 'msgpack'}
+    params['count'] = count.to_s if count
+    params['to'] = to.to_s if to
+    params['from'] = from.to_s if from
+    code, body, res = get("/v3/table/tail/#{e db}/#{e table}", params)
+    if code != "200"
+      raise_error("Tail table failed", res)
+    end
+    if block
+      MessagePack::Unpacker.new.feed_each(body, &block)
+      nil
+    else
+      result = []
+      MessagePack::Unpacker.new.feed_each(body) {|row|
+        result << row
+      }
+      return result
+    end
+  end
+
+end
+end

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

@@ -0,0 +1,117 @@
+class TreasureData::API
+module User
+
+  ####
+  ## User API
+  ##
+
+  # apikey:String
+  def authenticate(user, password)
+    code, body, res = post("/v3/user/authenticate", {'user'=>user, 'password'=>password})
+    if code != "200"
+      if code == "400"
+        raise_error("Authentication failed", res, AuthError)
+      else
+        raise_error("Authentication failed", res)
+      end
+    end
+    js = checked_json(body, %w[apikey])
+    apikey = js['apikey']
+    return apikey
+  end
+
+  # => [[name:String,organization:String,[user:String]]
+  def list_users
+    code, body, res = get("/v3/user/list")
+    if code != "200"
+      raise_error("List users failed", res)
+    end
+    js = checked_json(body, %w[users])
+    result = js["users"].map {|roleinfo|
+      name = roleinfo['name']
+      email = roleinfo['email']
+      [name, nil, nil, email] # set nil to org and role for API compatibility
+    }
+    return result
+  end
+
+  # => true
+  def add_user(name, org, email, password)
+    params = {'organization'=>org, :email=>email, :password=>password}
+    code, body, res = post("/v3/user/add/#{e name}", params)
+    if code != "200"
+      raise_error("Adding user failed", res)
+    end
+    return true
+  end
+
+  # => true
+  def remove_user(user)
+    code, body, res = post("/v3/user/remove/#{e user}")
+    if code != "200"
+      raise_error("Removing user failed", res)
+    end
+    return true
+  end
+
+  # => true
+  def change_email(user, email)
+    params = {'email' => email}
+    code, body, res = post("/v3/user/email/change/#{e user}", params)
+    if code != "200"
+      raise_error("Changing email failed", res)
+    end
+    return true
+  end
+
+  # => [apikey:String]
+  def list_apikeys(user)
+    code, body, res = get("/v3/user/apikey/list/#{e user}")
+    if code != "200"
+      raise_error("List API keys failed", res)
+    end
+    js = checked_json(body, %w[apikeys])
+    return js['apikeys']
+  end
+
+  # => true
+  def add_apikey(user)
+    code, body, res = post("/v3/user/apikey/add/#{e user}")
+    if code != "200"
+      raise_error("Adding API key failed", res)
+    end
+    return true
+  end
+
+  # => true
+  def remove_apikey(user, apikey)
+    params = {'apikey' => apikey}
+    code, body, res = post("/v3/user/apikey/remove/#{e user}", params)
+    if code != "200"
+      raise_error("Removing API key failed", res)
+    end
+    return true
+  end
+
+  # => true
+  def change_password(user, password)
+    params = {'password' => password}
+    code, body, res = post("/v3/user/password/change/#{e user}", params)
+    if code != "200"
+      raise_error("Changing password failed", res)
+    end
+    return true
+  end
+
+  # => true
+  def change_my_password(old_password, password)
+    params = {'old_password' => old_password, 'password' => password}
+    code, body, res = post("/v3/user/password/change", params)
+    if code != "200"
+      raise_error("Changing password failed", res)
+    end
+    return true
+  end
+
+end
+end

data/lib/td/client/api_error.rb

@@ -0,0 +1,26 @@
+module TreasureData
+
+class ParameterValidationError < StandardError
+end
+
+# Generic API error
+class APIError < StandardError
+end
+
+# 401 API errors
+class AuthError < APIError
+end
+
+# 403 API errors, used for database permissions
+class ForbiddenError < APIError
+end
+
+# 409 API errors
+class AlreadyExistsError < APIError
+end
+
+# 404 API errors
+class NotFoundError < APIError
+end
+
+end