aliyun_open_search 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0c0771214d13524facc8c7d13c3ab9dd62717c6
-  data.tar.gz: 6bd2f5956ff22f8beb516f37d631f6f4b3622098
+  metadata.gz: c5e99bfcdbe6afc31c2e970c7dcc681a49211bcf
+  data.tar.gz: 794c9d72dc9440532f1024f153e785841d74d1ad
 SHA512:
-  metadata.gz: f9e0a17537e36e8924e3f11a958461ef660375a3013d7ad477914c60013492d9de43b0c81c17ae522088f1657c77e6a1fabc6eb8a15b21fcb075a1173b3e2a0f
-  data.tar.gz: 89745ede0e5ec6bc1c5c4059bd0b52315f03ba2b74188cacf32c8e7ddffc77b1527e408b5bbf2e3255d1b256825a16c7977b70ec8cfda7ff7507efb17b8c37b9
+  metadata.gz: f4206fb509144123bcbdfd40fba83d0646e75009da0b457152192fe386e29bb4890377c9d3c7a3f94826b2b546d0899f55822f2caaa79ff216bbafbe03b9080d
+  data.tar.gz: 1cf54b4c7c1b94b8864e08d5d874d3461b5bc29275207b1e3e356a021ccba0611b83f30a1ff7aa64ae0a60bf9265679a2dddfdaae109998b64d0d485c7917b05

data/README.md

@@ -7,7 +7,11 @@
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'aliyun_open_search', github: "LcpMarvel/aliyun_open_search", require: false
+gem 'aliyun_open_search'
+
+# or
+
+gem 'aliyun_open_search', github: "LcpMarvel/aliyun_open_search"
 
 ```
 
@@ -35,7 +39,7 @@ OPEN_SEARCH_HOST: "http://opensearch-cn-hangzhou.aliyuncs.com"
 
 ### 数据处理API
 
-```
+```ruby
 # app_name 是阿里云 应用名称
 # params 的内容按照阿里云文档中的约定组织
 require "aliyun_open_search"
@@ -89,6 +93,36 @@ AliyunOpenSearch::Search.new("test", "test2", "test3").execute(params)
 
 ```
 
+### 签名
+##### 你可以直接使用封装好的方法进行签名(文档读得好累)
+
+```ruby
+  
+  AliyunOpenSearch.request_method = "POST" # 默认是 GET, 大写
+
+  # custom_params 的内容按照阿里云文档中的约定组织
+  custom_params = {
+    "action" => "push",
+    "table_name" => "cars",
+    "items" => [
+      {
+        "cmd": "update",
+        "timestamp": 1_420_070_400_010,
+        "fields": {
+          "id": "121139313135",
+          "styl_name": "aodi",
+          "acquirer_id": "1"
+        }
+      }
+    ].to_json
+  }
+
+  AliyunOpenSearch::Base.signature(
+    AliyunOpenSearch::Base.new.basic_params.merge!(custom_params)
+  )
+
+```
+
 
 ## Development
 

data/lib/aliyun_open_search/base.rb

@@ -5,6 +5,10 @@ module AliyunOpenSearch
   class Base
     attr_reader :basic_params, :base_url
 
+    class << self
+      attr_accessor :request_method
+    end
+
     def initialize
       @basic_params = {
         "Version" => "v2",
@@ -25,7 +29,7 @@ module AliyunOpenSearch
     end
 
     def self.request_method
-      "GET"
+      @request_method ||= "GET"
     end
 
     def self.signature(params)

data/lib/aliyun_open_search/search.rb

@@ -4,17 +4,18 @@ module AliyunOpenSearch
 
     def initialize(*index_names)
       super()
+
       @index_names = index_names.join(";")
       @base_url = "#{ENV["OPEN_SEARCH_HOST"]}/search"
     end
 
     def execute(custom_params)
       params = basic_params.merge(
-        self.class.format_params(custom_params.merge("index_name" => index_names))
+        Base.format_params(custom_params.merge("index_name" => index_names))
       )
 
       Net::HTTP.get(
-        uri(params.merge("Signature" => self.class.signature(params)))
+        uri(params.merge("Signature" => Search.signature(params)))
       )
     end
   end

data/lib/aliyun_open_search/syncs.rb

@@ -11,19 +11,10 @@ module AliyunOpenSearch
     end
 
     def execute(custom_params)
-      formatted_custom_params = {}.tap do |hash|
-        custom_params.map do |key, value|
-          hash[key.to_s] =  if value.is_a?(Array)
-                              JSON.generate(value)
-                            else
-                              value.to_s
-                            end
-        end
-      end
+      formatted_custom_params = Base.format_params(custom_params)
 
       params_with_signature = basic_params.merge(
-        "Signature" =>  self.class
-                            .signature(basic_params.merge(formatted_custom_params))
+        "Signature" => Syncs.signature(basic_params.merge(formatted_custom_params))
       )
 
       Net::HTTP.post_form(uri(params_with_signature), formatted_custom_params)

data/lib/aliyun_open_search/version.rb

@@ -1,3 +1,3 @@
 module AliyunOpenSearch
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aliyun_open_search
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - lcp