ali_ots 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8172fa691d991156c6d158a1213d8a6d7589f8aa
+  data.tar.gz: bb245a29a197ae6a62ffc848249c158cc98185f2
+SHA512:
+  metadata.gz: f1391e81b061da8aa5dc0bcd618debc5c49e492e4be2d0b99ef6158d4e4ddb067c2cea4658e40e7a212c5bc8f0a8a033470f250414fd99d53f014e89ff2d06c6
+  data.tar.gz: 0b4d76743dc888383116c86fbfbfef6a64e6be01f51c7d1742f222a3b4e159f9f96c7a21a17e48b7891e8d7e3174d6616a3f8b9f21357adfb1cb940c5e4d50aa

data/lib/ali_ots.rb

@@ -0,0 +1,127 @@
+require 'logger'
+require 'protobuf'
+require 'faraday'
+require 'addressable/uri'
+
+require 'ali_ots/client'
+require 'ali_ots/connection'
+require 'ali_ots/version'
+require 'ali_ots/metas/enums/column_type'
+require 'ali_ots/metas/enums/direction'
+require 'ali_ots/metas/enums/operation_type'
+require 'ali_ots/metas/enums/row_existence_expectation'
+require 'ali_ots/metas/error'
+require 'ali_ots/metas/condition'
+require 'ali_ots/metas/column_schema'
+require 'ali_ots/metas/column_value'
+require 'ali_ots/metas/column_update'
+require 'ali_ots/metas/column'
+require 'ali_ots/metas/table_meta'
+require 'ali_ots/metas/row_in_batch_get_row_request'
+require 'ali_ots/metas/table_in_batch_get_row_request'
+require 'ali_ots/metas/batch_get_row_request'
+require 'ali_ots/metas/capacity_unit'
+require 'ali_ots/metas/consumed_capacity'
+require 'ali_ots/metas/row'
+require 'ali_ots/metas/row_in_batch_get_row_response'
+require 'ali_ots/metas/table_in_batch_get_row_response'
+require 'ali_ots/metas/batch_get_row_response'
+require 'ali_ots/metas/put_row_in_batch_write_row_request'
+require 'ali_ots/metas/put_row_request'
+require 'ali_ots/metas/put_row_response'
+require 'ali_ots/metas/delete_row_in_batch_write_row_request'
+require 'ali_ots/metas/update_row_in_batch_write_row_request'
+require 'ali_ots/metas/table_in_batch_write_row_request'
+require 'ali_ots/metas/row_in_batch_write_row_response'
+require 'ali_ots/metas/table_in_batch_write_row_response'
+require 'ali_ots/metas/batch_write_row_request'
+require 'ali_ots/metas/batch_write_row_response'
+require 'ali_ots/metas/reserved_throughput'
+require 'ali_ots/metas/reserved_throughput_details'
+require 'ali_ots/metas/create_table_request'
+require 'ali_ots/metas/delete_row_request'
+require 'ali_ots/metas/delete_row_response'
+require 'ali_ots/metas/delete_table_request'
+require 'ali_ots/metas/describe_table_request'
+require 'ali_ots/metas/describe_table_response'
+require 'ali_ots/metas/get_range_request'
+require 'ali_ots/metas/get_range_response'
+require 'ali_ots/metas/get_row_request'
+require 'ali_ots/metas/get_row_response'
+require 'ali_ots/metas/list_table_request'
+require 'ali_ots/metas/list_table_response'
+require 'ali_ots/metas/table_primary_key'
+require 'ali_ots/metas/update_row_request'
+require 'ali_ots/metas/update_row_response'
+require 'ali_ots/metas/update_table_request'
+require 'ali_ots/metas/update_table_response'
+
+
+module AliOts
+  
+  AliOts::CONFIG = {
+    DEBUG_LEVEL: ::Logger::DEBUG,
+    END_POSITION: nil,
+    ACCESS_ID: nil,
+    ACCESS_KEY: nil,
+    INSTANCE_NAME: nil, 
+    APIVERSION: "2014-08-08"
+  }
+  
+  extend self
+  def configure
+    yield(AliOts::CONFIG)
+  end
+  
+end
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

data/lib/ali_ots/client.rb

@@ -0,0 +1,183 @@
+module AliOts
+  class Client
+    attr_accessor :conn
+    
+    def initialize
+      self.conn = AliOts::Connection.new
+    end
+    
+    # 创建表
+    # example:
+    #   schema_of_primary_keys = [AliOts::Metas::ColumnSchema.new(name: 'id', type: AliOts::Metas::Enums::ColumnType::INTEGER)]
+    #
+    #   client.create_table("myTable", schema_of_primary_keys, 9, 9)
+    def create_table(table_name, schema_of_primary_keys, capacity_read, capacity_write)
+      reserved_throughput_meta = ::AliOts::Metas::ReservedThroughput.new(capacity_unit: ::AliOts::Metas::CapacityUnit.new(read: capacity_read, write: capacity_write))
+      table_meta = AliOts::Metas::TableMeta.new(table_name: table_name, primary_key: schema_of_primary_keys)
+      request_meta = AliOts::Metas::CreateTableRequest.new(table_meta: table_meta, reserved_throughput: reserved_throughput_meta)
+      
+      self.conn.request("CreateTable", request_meta)
+    end
+    
+    # 删除
+    # example:
+    #   client.delete_table("myTable")
+    def delete_table(table_name)
+      request_meta = AliOts::Metas::DeleteTableRequest.new(table_name: table_name)
+      
+      self.conn.request("DeleteTable", request_meta)
+    end
+    
+    # 列出所有表
+    # example:
+    #   client.list_table()
+    def list_table
+      request_meta = AliOts::Metas::ListTableRequest.new()
+      
+      status, body, response_status = self.conn.request("ListTable", request_meta)
+      body = AliOts::Metas::ListTableResponse.decode(body) if status == "OK"
+      return status, body, response_status
+    end
+    
+    # 更新表
+    # example:
+    #   schema_of_primary_keys = [AliOts::Metas::ColumnSchema.new(name: 'id', type: AliOts::Metas::Enums::ColumnType::INTEGER)]
+    #
+    #   client.update_table("myTable", 9, 9)
+    def update_table(table_name, capacity_read, capacity_write)
+      reserved_throughput_meta = ::AliOts::Metas::ReservedThroughput.new(capacity_unit: ::AliOts::Metas::CapacityUnit.new(read: capacity_read, write: capacity_write))
+      request_meta = AliOts::Metas::UpdateTableRequest.new(table_name: table_name, reserved_throughput: reserved_throughput_meta)
+      
+      status, body, response_status = self.conn.request("UpdateTable", request_meta)
+      body = AliOts::Metas::UpdateTableResponse.decode(body) if status == "OK"
+      return status, body, response_status
+    end
+    
+    # 查询指定表的结构信息和预留读写吞吐量设置信息
+    # example:
+    #   client.describe_table("myTable")
+    def describe_table(table_name)
+      request_meta = AliOts::Metas::DescribeTableRequest.new(table_name: table_name)
+      
+      status, body, response_status = self.conn.request("DescribeTable", request_meta)
+      body = AliOts::Metas::DescribeTableResponse.decode(body) if status == "OK"
+      return status, body, response_status
+    end
+    
+    # 插入数据到指定的行，如果该行不存在，则新增一行；若该行存在，则覆盖原有行
+    # example:
+    #   #IGNORE 表示不做行存在性检查。 EXPECT_EXIST 表示期待该行存在。 EXPECT_NOT_EXIST 表示期待该行不存在。
+    #   condition_type = AliOts::Metas::Enums::RowExistenceExpectation::EXPECT_NOT_EXIST
+    #   primary_keys = [AliOts::Metas::Column.new(name: "id", value: AliOts::Metas::ColumnValue.new(type: AliOts::Metas::Enums::ColumnType::INTEGER, v_int: 1))]
+    #   user_name_column = AliOts::Metas::Column.new(name: "user_name", value: AliOts::Metas::ColumnValue.new(type: AliOts::Metas::Enums::ColumnType::STRING, v_string: "zhao"))
+    #   age_column = AliOts::Metas::Column.new(name: "age", value: AliOts::Metas::ColumnValue.new(type: AliOts::Metas::Enums::ColumnType::INTEGER, v_int: 27))
+    #   attribute_columns = [user_name_column, age_column]
+    #
+    #   client.put_row("myTable", condition_type, primary_keys, attribute_columns)
+    def put_row(table_name, condition_type, primary_keys, attribute_columns = [])
+      return ["ERROR", "primary_keys is empty", 0] unless primary_keys.present?
+      condition = AliOts::Metas::Condition.new(row_existence: condition_type)
+      request_meta = AliOts::Metas::PutRowRequest.new(table_name: table_name, condition: condition, primary_key: primary_keys, attribute_columns: attribute_columns)
+      
+      status, body, response_status = self.conn.request("PutRow", request_meta)
+      body = AliOts::Metas::PutRowResponse.decode(body) if status == "OK"
+      return status, body, response_status
+    end
+    
+    # 根据给定的主键读取单行数据。
+    # example:
+    #   primary_keys = [AliOts::Metas::Column.new(name: "id", value: AliOts::Metas::ColumnValue.new(type: AliOts::Metas::Enums::ColumnType::INTEGER, v_int: 1))]
+    #   columns = ["user_name", "age"]
+    #   
+    #   client.get_row("myTable", primary_keys, columns)
+    def get_row(table_name, primary_keys, columns = [])
+      request_meta = AliOts::Metas::GetRowRequest.new(table_name: table_name, primary_key: primary_keys, columns_to_get: columns)
+      
+      status, body, response_status = self.conn.request("GetRow", request_meta)
+      body = AliOts::Metas::GetRowResponse.decode(body) if status == "OK"
+      return status, body, response_status
+    end
+    
+    # 更新指定行的数据，如果该行不存在，则新增一行；若该行存在，则根据请求的内容在这一行中新增、修改或者删除指定列的值。
+    # example:
+    #   condition_type = AliOts::Metas::Enums::RowExistenceExpectation::IGNORE
+    #   primary_keys = [AliOts::Metas::Column.new(name: "id", value: AliOts::Metas::ColumnValue.new(type: AliOts::Metas::Enums::ColumnType::INTEGER, v_int: 1))]
+    #   user_name_column = AliOts::Metas::Column.new(name: "user_name", value: AliOts::Metas::ColumnValue.new(type: AliOts::Metas::Enums::ColumnType::STRING, v_string: "zhao"))
+    #   age_column = AliOts::Metas::Column.new(name: "age", value: AliOts::Metas::ColumnValue.new(type: AliOts::Metas::Enums::ColumnType::INTEGER, v_int: 27))
+    #   attribute_columns = [user_name_column, age_column]
+    #
+    #   client.update_row("myTable", condition_type, primary_keys, attribute_columns)
+    def update_row(table_name, condition_type, primary_keys, attribute_columns = [])
+      condition = AliOts::Metas::Condition.new(row_existence: condition_type)
+      request_meta = AliOts::Metas::UpdateRowRequest.new(table_name: table_name, conditon: condition, primary_key: primary_keys, attribute_columns: attribute_columns)
+      
+      status, body, response_status = self.conn.request("UpdateRow", request_meta)
+      body = AliOts::Metas::UpdateRowResponse.decode(body) if status == "OK"
+      return status, body, response_status
+    end
+    
+    # 删除一行数据
+    # example:
+    #   condition_type = AliOts::Metas::Enums::RowExistenceExpectation::IGNORE
+    #   primary_keys = [AliOts::Metas::Column.new(name: "id", value: AliOts::Metas::ColumnValue.new(type: AliOts::Metas::Enums::ColumnType::INTEGER, v_int: 1))]
+    #
+    #   client.delete_row("myTable", condition_type, primary_keys)
+    def delete_row(table_name, condition_type, primary_keys = [])
+      return ["ERROR", "primary_keys is empty", 0] unless primary_keys.present?
+      condition = AliOts::Metas::Condition.new(row_existence: condition_type)
+      request_meta = AliOts::Metas::DeleteRowRequest.new(table_name: table_name, condition: condition, primary_key: primary_keys)
+      
+      status, body, response_status = self.conn.request("DeleteRow", request_meta)
+      body = AliOts::Metas::DeleteRowResponse.decode(body) if status == "OK"
+      return status, body, response_status
+    end
+    
+    # 读取指定主键范围内的数据
+    # example:
+    #   direction = AliOts::Metas::Enums::Direction::FORWARD #FORWARD 表示此次查询按照主键由小到大的顺序进行, BACKWARD 表示此次查询按照主键由大到小的顺序进行
+    #   inclusive_start_primary_keys = [AliOts::Metas::Column.new(name: "id", value: AliOts::Metas::ColumnValue.new(type: AliOts::Metas::Enums::ColumnType::INTEGER, v_int: 1))]
+    #   exclusive_end_primary_keys = [AliOts::Metas::Column.new(name: "id", value: AliOts::Metas::ColumnValue.new(type: AliOts::Metas::Enums::ColumnType::INTEGER, v_int: 999))]
+    #
+    #   client.get_range("myTable", direction, inclusive_start_primary_keys, exclusive_end_primary_keys)
+    def get_range(table_name, inclusive_start_primary_keys, exclusive_end_primary_keys, direction = AliOts::Metas::Enums::Direction::FORWARD, columns = [], limit = nil)
+      request_meta = AliOts::Metas::GetRangeRequest.new(table_name: table_name, direction: direction, inclusive_start_primary_key: inclusive_start_primary_keys, exclusive_end_primary_key: exclusive_end_primary_keys, columns_to_get: columns, limit: limit)
+      
+      status, body, response_status = self.conn.request("GetRange", request_meta)
+      body = AliOts::Metas::GetRangeResponse.decode(body) if status == "OK"
+      return status, body, response_status
+    end
+    
+    # 批量读取一个或多个表中的若干行数据
+    # example:
+    #   primary_keys = [AliOts::Metas::Column.new(name: "id", value: AliOts::Metas::ColumnValue.new(type: AliOts::Metas::Enums::ColumnType::INTEGER, v_int: 1))]
+    #   row1 = AliOts::Metas::RowInBatchGetRowRequest.new(primary_key: primary_keys)
+    #   rows = [row]
+    #   table1 = AliOts::Metas::TableInBatchGetRowRequest.new(table_name: "myTable", rows: rows, columns_to_get: ['name', 'age'])
+    #   tables = [table1]
+    #   client.batch_get_row(tables)
+    def batch_get_row(tables)
+      request_meta = AliOts::Metas::BatchGetRowRequest.new(tables: tables)
+      
+      status, body, response_status = self.conn.request("BatchGetRow", request_meta)
+      body = AliOts::Metas::BatchGetRowResponse.decode(body) if status == "OK"
+      return status, body, response_status
+    end
+    
+    # 批量插入，修改或删除一个或多个表中的若干行数据。
+    # example:
+    #   condition = AliOts::Metas::Condition.new(row_existence: AliOts::Metas::Enums::RowExistenceExpectation::EXPECT_NOT_EXIST)
+    #   primary_keys = [AliOts::Metas::Column.new(name: "id", value: AliOts::Metas::ColumnValue.new(type: AliOts::Metas::Enums::ColumnType::INTEGER, v_int: 100))]
+    #   columns = [AliOts::Metas::Column.new(name: "name", value: AliOts::Metas::ColumnValue.new(type: AliOts::Metas::Enums::ColumnType::STRING, v_string: 'liu')), AliOts::Metas::Column.new(name: "age", value: AliOts::Metas::ColumnValue.new(type: AliOts::Metas::Enums::ColumnType::INTEGER, v_int: 93))]
+    #   row1 = AliOts::Metas::PutRowInBatchWriteRowRequest.new(condition: condition, primary_key: primary_keys, attribute_columns: columns)
+    #   rows = [row1]
+    #   tables = [AliOts::Metas::TableInBatchWriteRowRequest.new(table_name: 'myTable', put_rows: rows)]
+    #   client.batch_write_row(tables)
+    def batch_write_row(tables)
+      request_meta = AliOts::Metas::BatchWriteRowRequest.new(tables: tables)
+      
+      status, body, response_status = self.conn.request("BatchWriteRow", request_meta)
+      body = AliOts::Metas::BatchWriteRowResponse.decode(body) if status == "OK"
+      return status, body, response_status
+    end
+  end
+end

data/lib/ali_ots/connection.rb

@@ -0,0 +1,118 @@
+module AliOts
+  class Connection
+    attr_accessor :conn
+    attr_accessor :logger
+    
+    def initialize(base_url = AliOts::CONFIG[:END_POSITION])
+      self.conn = Faraday.new(:url => base_url) do |faraday|
+        faraday.request  :url_encoded             # form-encode POST params
+        faraday.response :logger                  # log requests to STDOUT
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
+      self.logger = Logger.new(STDOUT)
+      self.logger.level = AliOts::CONFIG[:DEBUG_LEVEL]
+    end
+    
+    def request(action, body, headers = {})
+      self.logger.info "body:==========================================================="
+      self.logger.info body.to_json
+      
+      headers ||= {}
+      url = AliOts::END_POSITION + "/" + action
+      serialize_body = body.serialize_to_string
+      ots_headers = make_headers(url, serialize_body)
+      headers.merge!(ots_headers)
+      
+      response = conn.post do |req|
+        req.url action
+        req.headers.merge!(headers)
+        req.body = serialize_body
+      end
+      
+      self.logger.info "response:==========================================================="
+      self.logger.info response
+      
+      return parse_response(response.status, response.headers, response.body)
+    end
+    
+    def make_headers(query, body)
+      md5 = Base64.encode64(Digest::MD5.digest(body)).gsub("\n", "")
+      date = Time.now.gmtime.strftime('%a, %d %b %Y %H:%M:%S GMT')
+      
+      headers = {
+          'x-ots-date' => date,
+          'x-ots-apiversion' => AliOts::CONFIG[:APIVERSION],
+          'x-ots-accesskeyid' => AliOts::CONFIG[:ACCESS_ID],
+          'x-ots-instancename' => AliOts::CONFIG[:INSTANCE_NAME],
+          'x-ots-contentmd5' => md5,
+      }
+
+      signature = make_request_signature(query, headers)
+      headers['x-ots-signature'] = signature
+
+      return headers
+    end
+    
+    def make_request_signature(query, headers)
+      require "addressable/uri"
+      uri = URI.parse(query)
+      path = uri.path
+      query_string = uri.query
+
+      addr_uri = Addressable::URI.new
+      addr_uri.query = query_string
+      addr_uri.query_values = addr_uri.query_values.sort_by{|q| q[0]} rescue {}
+      sorted_query = addr_uri.query
+      signature_string = path + "\n" + 'POST' + "\n" + sorted_query + "\n"
+
+      headers_string = make_headers_string(headers)
+      signature_string += headers_string + "\n"
+      
+      signature = call_signature_method(signature_string)
+      return signature
+    end
+    
+    def make_headers_string(headers)
+      headers.sort_by{|k,v| k}.map{|k,v| "#{k}:#{v}"}.join("\n")
+    end
+    
+    def call_signature_method(signature_string)
+      digest = OpenSSL::Digest.new('sha1')
+      hmac = OpenSSL::HMAC.digest(digest, AliOts::CONFIG[:ACCESS_KEY], signature_string)
+      Base64.encode64(hmac).gsub("\n", "")
+    end
+    
+    def parse_response(status, headers, body)
+      check_headers(headers, body)
+      
+      return ["OK", body, status] if status >= 200 && status < 300
+      return ["ERR", body, status]
+    end
+    
+    def check_headers(headers, body)      
+      # 1, check headers
+      header_names = [
+        'x-ots-contentmd5', 
+        'x-ots-requestid', 
+        'x-ots-date', 
+        'x-ots-contenttype',
+      ]
+      raise AliOts::Exceptions::ResponseException.new("Missing Parameter: #{(header_names-headers.symbolize_keys.keys).join(", ")}") unless header_names == header_names&&headers.symbolize_keys.keys
+      
+      # 2, check md5
+      md5 = Base64.encode64(Digest::MD5.digest(body)).gsub("\n", "")
+      raise AliOts::Exceptions::ResponseException.new("MD5 mismatch in response") unless md5 == headers['x-ots-contentmd5']
+
+      # 3, check date 
+      raise AliOts::Exceptions::ResponseException.new("Invalid date format in response") unless server_time = (Time.parse(headers['x-ots-date']) rescue nil)
+      
+      # 4, check date range
+      raise AliOts::Exceptions::ResponseException.new("The difference between date in response and system time is more than 15 minutes") unless (Time.now - server_time).abs < 15.minute
+    end
+  end
+end
+
+
+
+
+

data/lib/ali_ots/metas/batch_get_row_request.rb

@@ -0,0 +1,17 @@
+module AliOts
+  module Metas
+    #批量读取一个或多个表中的若干行数据。
+    class BatchGetRowRequest < ::Protobuf::Message
+      repeated AliOts::Metas::TableInBatchGetRowRequest, :tables, 1
+    end
+  end
+end
+
+
+
+=begin
+message BatchGetRowRequest {
+    repeated TableInBatchGetRowRequest tables = 1;
+}
+
+=end