aliyun_open_search 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 390f7780854a7d2530f8bd7c8081f5d9d4030346
-  data.tar.gz: c12684f02f84a8431d80e6a87499066723bd64c4
+  metadata.gz: cd711e537ab1099eb436c4aba83776bc980a797b
+  data.tar.gz: 4058e157e170c2c151b3e1d10a0e427f5813ebbb
 SHA512:
-  metadata.gz: a12335e502c1508d68edb4f7e8e028623c64059f7b4760f4b26ea4cf86cf8bde338c879de441cac444514a30631b3ba5cf9b1340bf5e42691302b82858e7cb16
-  data.tar.gz: 6b16fec3c5710ee7768568511df3ae075bcadfbfce1f2baae59f29d13ec0cd749790fa85328a49e98ad6231d2fb73fda8caf634f0e8289f1db6f891ed2c74fcc
+  metadata.gz: e64d13027ac1abda9c8644eb886fbd7ca983035fe858301f850efe4dd090ed2b07af0b514a2a5c7766a12f326fd86de8f788d7562b56fcc393fbb41df1779e6c
+  data.tar.gz: a86f711a1476486297dc2b541c347b491fa5b16d69d8502bf191d85e664d9c618baa6918ae5fdd20dbaf2d668da2b5e17c4498a6a2611c50272c07e1de961d8f

data/README.md

@@ -65,6 +65,12 @@ params =  {
                   "styl_name": "baoma",
                   "acquirer_id": "1"
                 }
+              },
+              {
+                "cmd": "delete",
+                "fields": {
+                  "id": "3"
+                }
               }
             ]
           }
@@ -90,6 +96,7 @@ params =  {
           }
 # 更多例子
 
+# 1. 
 # params = {
 #   query: [
 #     [
@@ -107,6 +114,25 @@ params =  {
 #   fetch_fields: :id
 # }
 
+# 2. 
+# start = per_page * (current_page - 1)
+# query = [
+#   "default:'#{@value}'",
+#   "configuration:'#{@value}'",
+#   "user_info:'#{@value}'",
+#   "authority_roles:'#{@value}'"
+# ].join(" OR ")
+
+# query = "query=(" + query + ") AND cars_company_id:'#{@company_id}'"
+
+# params = {
+#   query: [
+#     query,
+#     "config=start:#{start},hit:#{@per_page}"
+#   ],
+#   fetch_fields: :id
+# }
+
 AliyunOpenSearch::Search.new("test", "test2", "test3").execute(params)
 
 ```
@@ -136,11 +162,42 @@ AliyunOpenSearch::Search.new("test", "test2", "test3").execute(params)
   }
 
   AliyunOpenSearch::Base.signature(
-    AliyunOpenSearch::Base.new.basic_params.merge!(custom_params)
+    AliyunOpenSearch::Base.basic_params.merge!(custom_params)
   )
 
 ```
 
+### 检索
+
+```ruby
+require "aliyun_open_search"
+
+scan_service = AliyunOpenSearch::Scan.new("test")
+scan_service = AliyunOpenSearch::Scan.new(["test", "test2"])
+
+# AliyunOpenSearch::Scan.new(
+#   ["test", "test2"], 
+
+# 配置: 
+#   query: "query=default:'abc'", # 默认所有
+#   hit: "400", # 默认500, 范围 0~500
+#   scroll: "1w", 
+#   # 用来表示scroll请求的有效期，默认时间单位为ms, 也可以用1m表示1min
+#   # 支持的时间单位包括：w=Week, d=Day, h=Hour, m=minute, s=second
+#   format: "xml" # 默认 JSON
+# )
+
+scan_service.execute # 获取第一页
+scan_service.result # 获取结果
+
+# 下一页
+scan_service.execute # 获取第二页
+scan_service.result # 获取结果
+
+
+```
+
+
 ### 测试
 ##### 大部分时候, 我们并不需要真正的发出请求, 需要mock掉
 

data/lib/aliyun_open_search/base.rb

@@ -10,14 +10,9 @@ module AliyunOpenSearch
     end
 
     def initialize
-      @basic_params = {
-        "Version" => "v2",
-        "AccessKeyId" => ENV.fetch("ACCESS_KEY_ID"),
-        "SignatureMethod" => "HMAC-SHA1",
-        "Timestamp" => Time.now.utc.iso8601,
-        "SignatureVersion" => "1.0",
-        "SignatureNonce" => signature_nonce
-      }
+      @basic_params = Base.basic_params
+
+      @base_url = "#{ENV["OPEN_SEARCH_HOST"]}/search"
     end
 
     def uri(special_base_url = nil, params)
@@ -56,18 +51,27 @@ module AliyunOpenSearch
       ).strip
     end
 
-    private
+    def self.basic_params
+      {
+        "Version" => "v2",
+        "AccessKeyId" => ENV.fetch("ACCESS_KEY_ID"),
+        "SignatureMethod" => "HMAC-SHA1",
+        "Timestamp" => Time.now.utc.iso8601,
+        "SignatureVersion" => "1.0",
+        "SignatureNonce" => signature_nonce
+      }
+    end
 
-    def signature_nonce
+    def self.signature_nonce
       # 用户在不同请求间要使用不同的随机数值，建议使用13位毫秒时间戳+4位随机数
       (Time.now.to_f.round(3) * 1000).to_i.to_s + (1000..9999).to_a.sample.to_s
     end
 
-    def self.format_params(params)
+    def self.format_params(method = :get, params)
       {}.tap do |hash|
         params.map do |key, value|
           hash[key.to_s] =  if value.is_a?(Array)
-                              value.join("&&")
+                              method == :get ? value.join("&&") : JSON.generate(value)
                             else
                               value.to_s
                             end
@@ -77,12 +81,12 @@ module AliyunOpenSearch
 
     def self.escape(str)
       CGI.escape(str).gsub(/\!/, "%21")
-                     .gsub(/\'/, "%27")
-                     .gsub(/\(/, "%28")
-                     .gsub(/\)/, "%29")
-                     .gsub(/\*/, "%2A")
-                     .gsub(/\+/, "%20")
-                     .gsub(/%7E/, "~")
+        .gsub(/\'/, "%27")
+        .gsub(/\(/, "%28")
+        .gsub(/\)/, "%29")
+        .gsub(/\*/, "%2A")
+        .gsub(/\+/, "%20")
+        .gsub(/%7E/, "~")
     end
   end
 end

data/lib/aliyun_open_search/scan.rb

@@ -0,0 +1,65 @@
+module AliyunOpenSearch
+  class Scan < Base
+    attr_reader :request_id, :scroll_id, :scroll_id, :custom_params, :result
+
+    def initialize(index_names, options = {})
+      super()
+
+      @index_names = index_names.is_a?(Array) ? index_names.join(";") : index_names
+      @scroll = options[:scroll] || "1m"
+
+      @custom_params = {
+        query: [
+          options[:query] || "query=''",
+          "config=hit:#{options[:hit] || 500},format:#{options[:format] || "json"}"
+        ]
+      }
+
+      setup
+    end
+
+    def setup
+      params = basic_params.merge(
+        Base.format_params(
+          custom_params.merge(
+            "index_name" => @index_names,
+            # "config" => "config=hit:#{@hit},format:#{@format}",
+            "scroll" => @scroll,
+            "search_type" => "scan"
+          )
+        )
+      )
+
+      send_request(params)
+    end
+
+    def execute
+      params = Base.new.basic_params.merge(
+        Base.format_params(
+          custom_params.merge(
+            "index_name" => @index_names,
+            # "config" => "config=hit:#{@hit},format:#{@format}",
+            "scroll" => @scroll,
+            "scroll_id" => @scroll_id
+          )
+        )
+      )
+
+      send_request(params)
+    end
+
+    private
+
+    def send_request(params)
+      @result = Net::HTTP.get(uri(params.merge("Signature" => Search.signature(params))))
+      # 为了保持与其他方法返回值一致
+
+      result = JSON.parse(@result)
+
+      @request_id = result["request_id"]
+      @scroll_id = result["result"]["scroll_id"]
+
+      self
+    end
+  end
+end

data/lib/aliyun_open_search/search.rb

@@ -6,7 +6,6 @@ module AliyunOpenSearch
       super()
 
       @index_names = index_names.join(";")
-      @base_url = "#{ENV["OPEN_SEARCH_HOST"]}/search"
     end
 
     def execute(custom_params)

data/lib/aliyun_open_search/syncs.rb

@@ -11,7 +11,7 @@ module AliyunOpenSearch
     end
 
     def execute(custom_params)
-      formatted_custom_params = Base.format_params(custom_params)
+      formatted_custom_params = Base.format_params(:post, custom_params)
 
       params_with_signature = basic_params.merge(
         "Signature" => Syncs.signature(basic_params.merge(formatted_custom_params))

data/lib/aliyun_open_search/version.rb

@@ -1,3 +1,3 @@
 module AliyunOpenSearch
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/aliyun_open_search.rb

@@ -2,6 +2,7 @@ require "aliyun_open_search/version"
 require "aliyun_open_search/base"
 require "aliyun_open_search/syncs"
 require "aliyun_open_search/search"
+require "aliyun_open_search/scan"
 
 module AliyunOpenSearch
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aliyun_open_search
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - lcp
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-12 00:00:00.000000000 Z
+date: 2015-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,6 +103,7 @@ files:
 - config/application.example.yml
 - lib/aliyun_open_search.rb
 - lib/aliyun_open_search/base.rb
+- lib/aliyun_open_search/scan.rb
 - lib/aliyun_open_search/search.rb
 - lib/aliyun_open_search/syncs.rb
 - lib/aliyun_open_search/version.rb