td-client 1.0.0-java

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

@@ -0,0 +1,74 @@
+class TreasureData::API
+module AccessControl
+
+  ####
+  ## Access Control API
+  ##
+
+  # @param [String] subject
+  # @param [String] action
+  # @param [String] scope
+  # @param [Array] grant_option
+  # @return [true]
+  def grant_access_control(subject, action, scope, grant_option)
+    params = {'subject'=>subject, 'action'=>action, 'scope'=>scope, 'grant_option'=>grant_option.to_s}
+    code, body, res = post("/v3/acl/grant", params)
+    if code != "200"
+      raise_error("Granting access control failed", res)
+    end
+    return true
+  end
+
+  # @param [String] subject
+  # @param [String] action
+  # @param [String] scope
+  # @return [true]
+  def revoke_access_control(subject, action, scope)
+    params = {'subject'=>subject, 'action'=>action, 'scope'=>scope}
+    code, body, res = post("/v3/acl/revoke", params)
+    if code != "200"
+      raise_error("Revoking access control failed", res)
+    end
+    return true
+  end
+
+  # @param [String] user
+  # @param [String] action
+  # @param [String] scope
+  # @return [Array]
+  def test_access_control(user, action, scope)
+    params = {'user'=>user, 'action'=>action, 'scope'=>scope}
+    code, body, res = get("/v3/acl/test", params)
+    if code != "200"
+      raise_error("Testing access control failed", res)
+    end
+    js = checked_json(body, %w[permission access_controls])
+    perm = js["permission"]
+    acl = js["access_controls"].map {|roleinfo|
+      subject = roleinfo['subject']
+      action = roleinfo['action']
+      scope = roleinfo['scope']
+      [name, action, scope]
+    }
+    return perm, acl
+  end
+
+  # @return [Array]
+  def list_access_controls
+    code, body, res = get("/v3/acl/list")
+    if code != "200"
+      raise_error("Listing access control failed", res)
+    end
+    js = checked_json(body, %w[access_controls])
+    acl = js["access_controls"].map {|roleinfo|
+      subject = roleinfo['subject']
+      action = roleinfo['action']
+      scope = roleinfo['scope']
+      grant_option = roleinfo['grant_option']
+      [subject, action, scope, grant_option]
+    }
+    return acl
+  end
+
+end
+end

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

@@ -0,0 +1,45 @@
+class TreasureData::API
+module Account
+
+  ####
+  ## Account API
+  ##
+
+  # @return [Array]
+  def show_account
+    code, body, res = get("/v3/account/show")
+    if code != "200"
+      raise_error("Show account failed", res)
+    end
+    js = checked_json(body, %w[account])
+    a = js["account"]
+    account_id = a['id'].to_i
+    plan = a['plan'].to_i
+    storage_size = a['storage_size'].to_i
+    guaranteed_cores = a['guaranteed_cores'].to_i
+    maximum_cores = a['maximum_cores'].to_i
+    created_at = a['created_at']
+    return [account_id, plan, storage_size, guaranteed_cores, maximum_cores, created_at]
+  end
+
+  # @param [Fixnum] from
+  # @param [Fixnum] to
+  # @return [Array]
+  def account_core_utilization(from, to)
+    params = { }
+    params['from'] = from.to_s if from
+    params['to'] = to.to_s if to
+    code, body, res = get("/v3/account/core_utilization", params)
+    if code != "200"
+      raise_error("Show account failed", res)
+    end
+    js = checked_json(body, %w[from to interval history])
+    from = Time.parse(js['from']).utc
+    to = Time.parse(js['to']).utc
+    interval = js['interval'].to_i
+    history = js['history']
+    return [from, to, interval, history]
+  end
+
+end
+end

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

@@ -0,0 +1,184 @@
+class TreasureData::API
+module BulkImport
+
+  ####
+  ## Bulk import API
+  ##
+
+  # @param [String] name
+  # @param [String] db
+  # @param [String] table
+  # @param [Hash] opts
+  # @return [nil]
+  def create_bulk_import(name, db, table, opts={})
+    params = opts.dup
+    code, body, res = post("/v3/bulk_import/create/#{e name}/#{e db}/#{e table}", params)
+    if code != "200"
+      raise_error("Create bulk import failed", res)
+    end
+    return nil
+  end
+
+  # @param [String] name
+  # @param [Hash] opts
+  # @return [nil]
+  def delete_bulk_import(name, opts={})
+    params = opts.dup
+    code, body, res = post("/v3/bulk_import/delete/#{e name}", params)
+    if code != "200"
+      raise_error("Delete bulk import failed", res)
+    end
+    return nil
+  end
+
+  # @param [String] name
+  # @return [Hash]
+  def show_bulk_import(name)
+    code, body, res = get("/v3/bulk_import/show/#{name}")
+    if code != "200"
+      raise_error("Show bulk import failed", res)
+    end
+    js = checked_json(body, %w[status])
+    return js
+  end
+
+  # @param [Hash] opts
+  # @return [Hash]
+  def list_bulk_imports(opts={})
+    params = opts.dup
+    code, body, res = get("/v3/bulk_import/list", params)
+    if code != "200"
+      raise_error("List bulk imports failed", res)
+    end
+    js = checked_json(body, %w[bulk_imports])
+    return js['bulk_imports']
+  end
+
+  # @param [String] name
+  # @param [Hash] opts
+  # @return [nil]
+  def list_bulk_import_parts(name, opts={})
+    params = opts.dup
+    code, body, res = get("/v3/bulk_import/list_parts/#{e name}", params)
+    if code != "200"
+      raise_error("List bulk import parts failed", res)
+    end
+    js = checked_json(body, %w[parts])
+    return js['parts']
+  end
+
+  # @param [String] name
+  # @param [String] part_name
+  # @param [String, StringIO] stream
+  # @param [Fixnum] size
+  # @param [Hash] opts
+  # @return [nil]
+  def bulk_import_upload_part(name, part_name, stream, size, opts={})
+    code, body, res = put("/v3/bulk_import/upload_part/#{e name}/#{e part_name}", stream, size)
+    if code[0] != ?2
+      raise_error("Upload a part failed", res)
+    end
+    return nil
+  end
+
+  # @param [String] name
+  # @param [String] part_name
+  # @param [Hash] opts
+  # @return [nil]
+  def bulk_import_delete_part(name, part_name, opts={})
+    params = opts.dup
+    code, body, res = post("/v3/bulk_import/delete_part/#{e name}/#{e part_name}", params)
+    if code[0] != ?2
+      raise_error("Delete a part failed", res)
+    end
+    return nil
+  end
+
+  # @param [String] name
+  # @param [Hash] opts
+  # @return [nil]
+  def freeze_bulk_import(name, opts={})
+    params = opts.dup
+    code, body, res = post("/v3/bulk_import/freeze/#{e name}", params)
+    if code != "200"
+      raise_error("Freeze bulk import failed", res)
+    end
+    return nil
+  end
+
+  # @param [String] name
+  # @param [Hash] opts
+  # @return [nil]
+  def unfreeze_bulk_import(name, opts={})
+    params = opts.dup
+    code, body, res = post("/v3/bulk_import/unfreeze/#{e name}", params)
+    if code != "200"
+      raise_error("Unfreeze bulk import failed", res)
+    end
+    return nil
+  end
+
+  # @param [String] name
+  # @param [Hash] opts
+  # @return [String] job_id
+  def perform_bulk_import(name, opts={})
+    params = opts.dup
+    code, body, res = post("/v3/bulk_import/perform/#{e name}", params)
+    if code != "200"
+      raise_error("Perform bulk import failed", res)
+    end
+    js = checked_json(body, %w[job_id])
+    return js['job_id'].to_s
+  end
+
+  # @param [String] name
+  # @param [Hash] opts
+  # @return [nil]
+  def commit_bulk_import(name, opts={})
+    params = opts.dup
+    code, body, res = post("/v3/bulk_import/commit/#{e name}", params)
+    if code != "200"
+      raise_error("Commit bulk import failed", res)
+    end
+    return nil
+  end
+
+  # @param [String] name
+  # @param [Hash] opts
+  # @param [Proc] block
+  # @return [Array]
+  def bulk_import_error_records(name, opts={}, &block)
+    params = opts.dup
+    code, body, res = get("/v3/bulk_import/error_records/#{e name}", params)
+    if code != "200"
+      raise_error("Failed to get bulk import error records", res)
+    end
+    if body.nil? || body.empty?
+      if block
+        return nil
+      else
+        return []
+      end
+    end
+    require File.expand_path('../compat_gzip_reader', File.dirname(__FILE__))
+    u = MessagePack::Unpacker.new(Zlib::GzipReader.new(StringIO.new(body)))
+    if block
+      begin
+        u.each(&block)
+      rescue EOFError
+      end
+      nil
+    else
+      result = []
+      begin
+        u.each {|row|
+          result << row
+        }
+      rescue EOFError
+      end
+      return result
+    end
+  end
+
+end
+end

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

@@ -0,0 +1,172 @@
+class TreasureData::API
+module BulkLoad
+
+  ####
+  ## BulkLoad (Server-side Bulk loader) API
+  ##
+
+  #  1. POST   /v3/bulk_loads/guess          - stateless non REST API to return guess result as BulkLoadSession [NEW]
+  #  2. POST   /v3/bulk_loads/preview        - stateless non REST API to return preview result as BulkLoadSession [NEW]
+  #
+  #  3. POST   /v3/job/issue/:type/:database - create a job resource to run BulkLoadSession [EXTENDED]
+  #  4. POST   /v3/job/kill/:id              - kill the job [ALREADY EXISTS]
+  #  5. GET    /v3/job/show/:id              - get status of the job [ALREADY EXISTS]
+  #  6. GET    /v3/job/result/:id            - get result of the job [NOT NEEDED IN Q4] ... because backend feature is not yet implemented
+  #
+  #  7. GET    /v3/bulk_loads                - list BulkLoadSession resources [NEW]
+  #  8. POST   /v3/bulk_loads                - create BulkLoadSession [NEW]
+  #  9. GET    /v3/bulk_loads/:name          - get BulkLoadSession [NEW]
+  # 10. PUT    /v3/bulk_loads/:name          - update BulkLoadSession [NEW]
+  # 11. DELETE /v3/bulk_loads/:name          - delete BulkLoadSession [NEW]
+  # 12. GET    /v3/bulk_loads/:name/jobs     - list BulkLoadSession job history [NEW]
+  # 13. POST   /v3/bulk_loads/:name/jobs     - run BulkLoadSession [NEW]
+
+  # The 'BulkLoadSession' resource in td-api is as follows;
+  # {
+  #   "config": {
+  #     "type": "s3",
+  #     "access_key_id": s3 access key id,
+  #     "secret_access_key": s3 secret key,
+  #     "endpoint": s3 endpoint name,
+  #     "bucket": s3 bucket name,
+  #     "path_prefix": "a/prefix/of/files",
+  #     "decoders": []
+  #   },
+  #   "name": account_wide_unique_name,
+  #   "cron": cron_string,
+  #   "timezone": timezone_string,
+  #   "delay": delay_seconds,
+  #   "database": database_name,
+  #   "table": table_name
+  # }
+
+  LIST = '/v3/bulk_loads'
+  SESSION = LIST +     '/%s'
+  JOB = SESSION +         '/jobs'
+
+  # job: Hash -> Hash
+  def bulk_load_guess(job)
+    # retry_request = true
+    path = LIST + '/guess'
+    res = api { post(path, job.to_json) }
+    unless res.ok?
+      raise_error('BulkLoad configuration guess failed', res)
+    end
+    JSON.load(res.body)
+  end
+
+  # job: Hash -> Hash
+  def bulk_load_preview(job)
+    # retry_request = true
+    path = LIST + '/preview'
+    res = api { post(path, job.to_json) }
+    unless res.ok?
+      raise_error('BulkLoad job preview failed', res)
+    end
+    JSON.load(res.body)
+  end
+
+  # job: Hash -> String (job_id)
+  def bulk_load_issue(database, table, job)
+    type = 'bulkload'
+    job = job.dup
+    job['database'] = database
+    job['table'] = table
+    path = "/v3/job/issue/#{e type}/#{e database}"
+    res = api { post(path, job.to_json) }
+    unless res.ok?
+      raise_error('BulkLoad job issuing failed', res)
+    end
+    js = checked_json(res.body)
+    js['job_id'].to_s
+  end
+
+  # nil -> [Hash]
+  def bulk_load_list
+    res = api { get(LIST) }
+    unless res.ok?
+      raise_error("BulkLoadSession list retrieve failed", res)
+    end
+    JSON.load(res.body)
+  end
+
+  # name: String, database: String, table: String, job: Hash -> Hash
+  def bulk_load_create(name, database, table, job, opts = {})
+    job = job.dup
+    job['name'] = name
+    [:cron, :timezone, :delay, :time_column].each do |prop|
+      job[prop.to_s] = opts[prop] if opts.key?(prop)
+    end
+    job['database'] = database
+    job['table'] = table
+    res = api { post(LIST, job.to_json) }
+    unless res.ok?
+      raise_error("BulkLoadSession: #{name} create failed", res)
+    end
+    JSON.load(res.body)
+  end
+
+  # name: String -> Hash
+  def bulk_load_show(name)
+    path = session_path(name)
+    res = api { get(path) }
+    unless res.ok?
+      raise_error("BulkLoadSession: #{name} retrieve failed", res)
+    end
+    JSON.load(res.body)
+  end
+
+  # name: String, settings: Hash -> Hash
+  def bulk_load_update(name, settings)
+    path = session_path(name)
+    res = api { put(path, settings.to_json) }
+    unless res.ok?
+      raise_error("BulkLoadSession: #{name} update failed", res)
+    end
+    JSON.load(res.body)
+  end
+
+  # name: String -> Hash
+  def bulk_load_delete(name)
+    path = session_path(name)
+    res = api { delete(path) }
+    unless res.ok?
+      raise_error("BulkLoadSession: #{name} delete failed", res)
+    end
+    JSON.load(res.body)
+  end
+
+  # name: String -> [Hash]
+  def bulk_load_history(name)
+    path = job_path(name)
+    res = api { get(path) }
+    unless res.ok?
+      raise_error("history of BulkLoadSession: #{name} retrieve failed", res)
+    end
+    JSON.load(res.body)
+  end
+
+  def bulk_load_run(name, scheduled_time = nil)
+    path = job_path(name)
+    opts = {}
+    opts[:scheduled_time] = scheduled_time.to_s unless scheduled_time.nil?
+    res = api { post(path, opts.to_json) }
+    unless res.ok?
+      raise_error("BulkLoadSession: #{name} job create failed", res)
+    end
+    js = checked_json(res.body)
+    js['job_id'].to_s
+  end
+
+private
+
+  def session_path(name)
+    SESSION % e(name)
+  end
+
+  def job_path(name)
+    JOB % e(name)
+  end
+
+end
+end