aliyun-opensearch-client 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fecc8af0c41528c9deedd1a8164541e7dcf5391f99a21101a29c63ac8a75a06d
+  data.tar.gz: 16d08793ea28f0596062694fa89f534b2b04d193d26d75b8031bd622e27bc961
+SHA512:
+  metadata.gz: d4595ccb2fa168a10055469017b5e1a260f7eb0e3300b5c8e8697d71343823fd81ffdf20fd7d34d1c12693d2c42e9ebe48f5f22bd1e29165bf870bd1f70bc7ed
+  data.tar.gz: 2b866f11590a288634ad4eec0b6d337433f68f3c4ea9e5296c540acc2211254ab02c218ed9598eb2f72f0d0bcbdfbc52b75ac44cc2c9280065ad0accdb0a029d

data/.gitignore

@@ -0,0 +1,21 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# ruby version
+.ruby-gemset
+.ruby-version
+
+# test sample
+bin/sample
+
+# ignore generate gem
+aliyun-openseach-client*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,52 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2022-06-29 03:29:43 UTC using RuboCop version 1.31.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+
+AllCops:
+  Exclude:
+    - 'spec/**/*'
+  NewCops: enable
+  SuggestExtensions: false
+
+Gemspec/RequiredRubyVersion:
+  Include:
+    - 2.1.4
+
+Layout/LineLength:
+  Max: 333
+
+Metrics/AbcSize:
+  Enabled: true
+  Max: 50
+
+Metrics/MethodLength:
+  Max: 50
+
+Style/RedundantSelf:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/RedundantBegin:
+  Enabled: false
+
+Style/AccessorGrouping:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/FormatStringToken:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.3
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+### 0.1.1
+* Added 完善客户端 - shawn.han
+
+### 0.1.0
+* Init 初始化项目 - shawn.han

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at shawn.han@rccchina.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in aliyun-opensearch-client.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+
+gem 'ripper-tags', '~> 0.9.1'
+
+gem 'pry'

data/Gemfile.lock

@@ -0,0 +1,102 @@
+PATH
+  remote: .
+  specs:
+    aliyun-opensearch-client (0.1.1)
+      faraday (>= 0.10.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    faraday (2.3.0)
+      faraday-net_http (~> 2.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (2.0.3)
+    hashdiff (1.0.1)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.16.2)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.7)
+    rainbow (3.1.1)
+    rake (12.3.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    ripper-tags (0.9.1)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.31.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  aliyun-opensearch-client!
+  pry
+  rake (~> 12.0)
+  ripper-tags (~> 0.9.1)
+  rspec
+  rubocop
+  simplecov
+  webmock
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 shawn.han
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+# Aliyun::Opensearch::Client 🧯
+
+本项目是阿里云Opensearch服务的ruby sdk, 定位类似[rsolr](https://github.com/rsolr/rsolr)之于solr  
+会根据[官方文档](https://help.aliyun.com/document_detail/54237.html)生成流量API的签名, 并发送请求  
+该gem最低支持的ruby版本为2.1.4
+
+## Install
+
+安装gem
+
+```ruby
+gem install 'aliyun-opensearch-client'
+```
+
+## Usage
+
+```ruby
+# 1. 添加配置
+Aliyun::Opensearch::Configuration.endpoint = 'opensearch-cn-hangzhou.aliyuncs.com'
+Aliyun::Opensearch::Configuration.access_key_id = 'A*****************z'
+Aliyun::Opensearch::Configuration.access_key_secret = 'z*********************A'
+
+# 2. 创建客户端实例
+client = Aliyun::Opensearch::Client.new('your_app_name')
+
+# 3. 发送请求
+# 插入
+puts client.insert('your_table', [ { id: 1, title: 'Cien años de soledad' }, { id: 2, title: 'Les Misérables' } ]) # true
+puts client.insert('your_table', { id: 3, title: 'The Metamorphosis' }) # true
+
+# 更新
+puts client.update('your_table', [ { id: 1, title: 'Book - 百年孤独' }, { id: 2, title: 'Book - 悲惨世界' } ]) # true
+puts client.update('your_table', { id: 3, title: 'Book - 变形记' }) # true
+
+# 搜索
+puts client.search({query: "query=default:'Book'"})
+# {"searchtime"=>0.102566, "total"=>3, "num"=>3, "viewtotal"=>3, "compute_cost"=>[{"index_name"=>"your_app_name", "value"=>0.355}], "items"=>[{"id"=>"2", "index_name"=>"your_app_name"}, {"id"=>"1", "index_name"=>"your_app_name"}, {"id"=>"3", "index_name"=>"your_app_name"}], "facet"=>[]}
+
+# 删除
+puts client.delete('your_table', { id: 1 }) # true
+puts client.delete('your_table', [{ id: 2 }, { id: 3 }]) # true
+
+# 自定义接口请求
+response = client.call(:get, '/v3/openapi/apps/your_app_name/suggest/your_suggest_name/search', { query: '...' })
+```
+
+## Feature
+- 流量API签名认证
+- 封装流量API的 数据处理 / 搜索处理 接口
+- 兼容请求未封装的流量API接口
+
+## RoadMap
+- request日志追踪
+- 支持流量API的 推送采集数据 / 下拉提示 / 热搜和底纹 接口
+- 支持管控API (可以临时用Aliyun官方的OpenAPI解决问题)
+- 支持STS认证
+
+## 开源协议
+
+[MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/aliyun-opensearch-client.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'lib/aliyun/opensearch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'aliyun-opensearch-client'
+  spec.version       = Aliyun::Opensearch::VERSION
+  spec.authors       = ['shawn.han']
+  spec.email         = ['shawn.han@rccchina.com']
+
+  spec.summary       = 'Aliyun Opensearch 服务客户端'
+  spec.description   = '对接Aliyun Opensearch 的流量API HTTP接口, 生成签名并发送请求'
+  spec.homepage      = 'https://github.com/rccgroup/aliyun-opensearch-client'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.1.4')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/rccgroup/aliyun-opensearch-client'
+  spec.metadata['changelog_uri'] = 'https://github.com/rccgroup/aliyun-opensearch-client/blob/master/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday', '>= 0.10.0'
+
+  spec.add_development_dependency 'activesupport'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'webmock'
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'aliyun/opensearch'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/aliyun/opensearch/client.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+# require client_ext folder ruby file
+%w[traffic].each do |file|
+  require File.join(File.dirname(__FILE__), 'client_ext', file)
+end
+
+module Aliyun
+  module Opensearch
+    #
+    # Opensearch客户端
+    #
+    # @author shawn.han <shawn.han@rccchina.com>
+    #
+    class Client
+      include ClientExt::Traffic::Behavior
+
+      # 允许请求的action
+      REQUEST_METHODS = [:get, :post].freeze
+
+      # 应用名称
+      attr_reader :app
+
+      #
+      # 客户端初始化
+      #
+      # @author shawn.han <shawn.han@rccchina.com>
+      #
+      # @param [String] app 应用名称, 即要访问的Opensearch应用的名称, 在实例管理里可以看到
+      #
+      def initialize(app)
+        @app = app
+        @connection = Faraday.new(url: Configuration.opensearch_url) do |faraday|
+          faraday.response :raise_error
+        end
+      end
+
+      #
+      # 发送请求
+      #
+      # @author shawn.han <shawn.han@rccchina.com>
+      #
+      # @param [String|Symbol] method 接口请求方法
+      # @param [String] path 接口地址
+      # @param [Hash] params 接口参数
+      #
+      # @return [Hash] 请求结果
+      #
+      def call(method, path, params)
+        raise ArgumentError, "Not Allow Request Method #{method}; Only Allowed #{REQUEST_METHODS}" unless REQUEST_METHODS.map { |e| [e, e.to_s, e.to_s.upcase] }.flatten.include?(method)
+
+        response = @connection.send(method.downcase, path, params) do |request|
+          api_params = (request.http_method == :get ? request.params : request.body)
+          request.headers = ClientExt::Traffic::Header.new(request.http_method, request.path, api_params: api_params).generate
+        end
+        body = response.body.empty? ? {} : JSON.parse(response.body)
+
+        valid_response(response, body)
+        body
+      rescue Error::AliyunService, Error::InvalidResponseBody => e
+        raise e
+      rescue Faraday::Error => e
+        raise Error::HttpBase, e
+      end
+
+      #
+      # 返回结果校验
+      #
+      # @author shawn.han <shawn.han@rccchina.com>
+      #
+      def valid_response(response, body)
+        raise Error::InvalidResponseBody, response if body.empty? || !body.keys.include?('status')
+        raise Error::AliyunService, response if body['status'] != 'OK'
+      end
+    end
+  end
+end

data/lib/aliyun/opensearch/client_ext/traffic/behavior.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+module Aliyun
+  module Opensearch
+    module ClientExt
+      module Traffic
+        #
+        # 各种接口行为
+        #
+        # @author shawn.han <shwan.han@rccchina.com>
+        #
+        module Behavior
+          API_SEARCH = '/v3/openapi/apps/%{app_name}/search'
+          API_ACTION = '/v3/openapi/apps/%{app_name}/%{table_name}/actions/bulk'
+
+          ACTION_CMD_KEY = 'cmd'
+          ACTION_CMD_INSERT = 'add'
+          ACTION_CMD_UPDATE = 'update'
+          ACTION_CMD_DELETE = 'delete'
+
+          #
+          # 搜索接口
+          #
+          # @author shawn.han <shawn.han@rccchina.com>
+          #
+          # @param [Hash] params 参数
+          # @see https://help.aliyun.com/document_detail/57155.html
+          #
+          # @return [Hash] 查询结果
+          #
+          def search(params)
+            raise Error::EmptyParam if params.nil? || params.empty?
+
+            self.call(:get, complete_path(API_SEARCH), params)['result']
+          end
+
+          #
+          # 插入操作
+          #
+          # @author shawn.han <shawn.han@rccchina.com>
+          #
+          # @param [String] table_name 操作对象的表名
+          # @param [Hash] params 参数
+          # @see https://help.aliyun.com/document_detail/57154.html
+          #
+          # @return [Boolean] 处理结果
+          #
+          def insert(table_name, params)
+            action(table_name, ACTION_CMD_INSERT, params)
+          end
+
+          #
+          # 更新操作
+          #
+          # @author shawn.han <shawn.han@rccchina.com>
+          #
+          # @param [String] table_name 操作对象的表名
+          # @param [Hash] params 参数
+          # @see https://help.aliyun.com/document_detail/57154.html
+          #
+          # @return [Boolean] 处理结果
+          #
+          def update(table_name, params)
+            action(table_name, ACTION_CMD_UPDATE, params)
+          end
+
+          #
+          # 删除操作
+          #
+          # @author shawn.han <shawn.han@rccchina.com>
+          #
+          # @param [String] table_name 操作对象的表名
+          # @param [Hash] params 参数
+          # @see https://help.aliyun.com/document_detail/57154.html
+          #
+          # @return [Boolean] 处理结果
+          #
+          def delete(table_name, params)
+            action(table_name, ACTION_CMD_DELETE, params)
+          end
+
+          #
+          # 操作接口
+          # @note 操作接口的几个注意点(此为Aliyun Opensearch服务内部的处理)
+          #   1. add操作时, 如果数据已经存在, 会直接更新这条数据, 也不会报错
+          #   2. update操作时, 如果数据不存在, 不会直接新建数据, 也不会报错
+          #   3. delete操作时, 如果数据不存在, 不会进行操作, 也不会报错
+          #
+          # @author shawn.han <shawn.han@rccchina.com>
+          #
+          # @param [String] table_name 操作对象的表名
+          # @param [String] action 操作类型
+          # @param [Array|Hash] params 参数
+          #
+          # @return [Boolean] 处理结果
+          #
+          def action(table_name, action, params)
+            raise Error::EmptyParam if params.nil? || params.empty?
+
+            self.call(:post, complete_path(API_ACTION, table_name: table_name), JSON.generate(complete_action_params(params, action)))['result']
+          end
+
+          private
+
+          #
+          # 返回完整的接口路径
+          #
+          # @author shawn.han <shawn.han@rccchina.com>
+          #
+          # @param [String] path 接口路径
+          # @param [String] table_name 表名
+          #
+          # @return [String] 完整的接口路径
+          #
+          def complete_path(path, table_name: nil)
+            options = { app_name: self.app }
+            options.merge!(table_name: table_name) unless table_name.nil?
+
+            format(path, options)
+          end
+
+          #
+          # 返回完整的参数
+          #
+          # @author shawn.han <shawn.han@rccchina.com>
+          #
+          # @param [Array|Hash] params 参数
+          # @param [String] action 操作类型
+          #
+          # @return [Array<Hash>] 完整的参数
+          #
+          def complete_action_params(params, action)
+            # 判断是否需要补充fields字段
+            need_cmplete_fields_key = proc { |param| (['fields', :fields] & param.keys).empty? || (!param['fields'].is_a?(Hash) && !param[:fields].is_a?(Hash)) }
+
+            # 添加操作类型
+            if params.is_a?(Array)
+              params = params.map do |e|
+                e = { 'fields' => e } if need_cmplete_fields_key.call(e)
+                e.merge(ACTION_CMD_KEY => action)
+              end
+            else
+              params = { 'fields' => params } if need_cmplete_fields_key.call(params)
+              params = [params.merge(ACTION_CMD_KEY => action)]
+            end
+
+            params
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aliyun/opensearch/client_ext/traffic/header/credentials.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Aliyun
+  module Opensearch
+    module ClientExt
+      module Traffic
+        class Header
+          #
+          # HTTP请求header - 请求认证模块
+          #
+          # @author shawn.han <shawn.han@rccchina.com>
+          #
+          module Credentials
+            SIGN_PREFIX = 'OPENSEARCH'
+
+            def authorization
+              "#{SIGN_PREFIX} #{@access_key_id}:#{signature}"
+            end
+
+            def signature
+              @signature ||= begin
+                sign_body = [@request_method, self.content_md5, self.content_type, self.date, canonicalized_open_search_headers, canonicalized_resource].join("\n")
+
+                Base64.encode64(
+                  OpenSSL::HMAC.digest(
+                    OpenSSL::Digest.new('sha1'),
+                    @access_key_secret,
+                    sign_body
+                  )
+                )
+              end
+            end
+
+            #
+            # 生成 CanonicalizedOpenSearchHeaders
+            #
+            # @author shawn.han <shawn.han@rccchina.com>
+            #
+            # @see https://help.aliyun.com/document_detail/54237.html#section-92h-jsb-rlu
+            #
+            # @return [String] CanonicalizedOpenSearchHeaders
+            #
+            def canonicalized_open_search_headers
+              @canonicalized_open_search_headers ||= self.x_opensearch_headers.to_a.sort { |x, y| x[0] <=> y[0] }.map do |e|
+                "#{e[0].downcase}:#{e[1]}"
+              end.join("\n")
+            end
+
+            #
+            # 生成 CanonicalizedResource
+            #
+            # @author shawn.han <shawn.han@rccchina.com>
+            #
+            # @see https://help.aliyun.com/document_detail/54237.htm
+            #
+            # @return [String] CanonicalizedResource
+            #
+            def canonicalized_resource
+              path = @path
+              query = nil
+
+              if @request_method == 'GET'
+                # 按照阿里云文档生成query, see: https://help.aliyun.com/document_detail/54237.htm#section-ni9-hgi-tal
+                query = @api_params.to_a.sort { |x, y| x[0] <=> y[0] }.map do |e|
+                  unless e[1].nil?
+                    [e[0], (e[1].to_s == '' ? nil : e[1].to_s)]
+                  end
+                end.compact
+
+                # encode_www_form方法文档中描述一些字符不会转移, 这里手动进行处理
+                # This method doesn't convert *, -, ., 0-9, A-Z, _, a-z, but does convert SP (ASCII space) to + and converts others to %XX.
+                query = URI.encode_www_form(query).gsub('+', '%20').gsub('*', '%2A')
+              end
+
+              [path, query].compact.reject(&:empty?).join('?')
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aliyun/opensearch/client_ext/traffic/header.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+# require header folder ruby file
+%w[credentials].each do |file|
+  require File.join(File.dirname(__FILE__), 'header', file)
+end
+
+module Aliyun
+  module Opensearch
+    module ClientExt
+      module Traffic
+        #
+        # 流量API HTTP请求header
+        #
+        # @author shawn.han <shawn.han@rccchina.com>
+        #
+        class Header
+          # 默认 conten-type
+          DEFAULT_CONTENT_TYPE = 'application/json'
+          # 默认 user-agent, 内容参考阿里云官方openapi sdk: https://github.com/aliyun/openapi-core-ruby-sdk/blob/master/lib/aliyunsdkcore.rb
+          DEFAULT_UA = "AlibabaCloud (#{Gem::Platform.local.os}; #{Gem::Platform.local.cpu}) Ruby/#{RUBY_VERSION} Core/ALiyunOpensearchClient-#{Aliyun::Opensearch::VERSION}"
+
+          # nonce后缀最小长度
+          NONCE_SUFFIX_MIN = 100_000
+          # nonce后缀最大长度
+          NONCE_SUFFIX_MAX = 999_999
+
+          include Credentials # 签名认证模块
+
+          #
+          # 创建实例
+          #
+          # @author shawn.han <shawn.han@rccchina.com>
+          #
+          # @param [String] request_method 接口请求方法(GET POST...)
+          # @param [String] path 请求资源路径
+          # @param [Hash] api_params 请求接口参数
+          # @param [String] access_key_id 阿里云 AccessKeyId
+          # @param [String] access_key_secret 阿里云 AccessKeySecret
+          #
+          def initialize(request_method, path, api_params: nil, access_key_id: nil, access_key_secret: nil)
+            @request_method = request_method.to_s.upcase
+            @path = path
+
+            @api_params = api_params
+
+            @access_key_id = access_key_id || Configuration.access_key_id
+            @access_key_secret = access_key_secret || Configuration.access_key_secret
+          end
+
+          #
+          # 生成Header的Hash结构
+          #
+          # @author shawn.han <shawn.han@rccchina.com>
+          #
+          # @return [Hash] 请求用到的所有Header内容
+          #
+          def generate
+            result = {
+              'User-Agent' => DEFAULT_UA,
+              'Content-Type' => content_type,
+              'Date' => date,
+            }.merge(x_opensearch_headers)
+            result.merge!('Content-Md5' => content_md5) if content_md5
+            result.merge!('Authorization' => authorization)
+            result
+          end
+
+          #
+          # 以X-Opensearch开头的header
+          #
+          # @author shawn.han <shawn.han@rccchina.com>
+          #
+          # @return [Hash] 以X-Opensearch开头的header
+          #
+          def x_opensearch_headers
+            {
+              'X-Opensearch-Nonce' => x_opensearch_nonce,
+            }
+          end
+
+          #
+          # hearder中 Content-Type的值
+          #
+          # @author shawn.han <shawn.han@rccchina.com>
+          #
+          # @return [String] Content-Type的值
+          #
+          def content_type
+            @content_type ||= DEFAULT_CONTENT_TYPE
+          end
+
+          #
+          # 生成 header中 X-Opensearch-Nonce的值
+          #
+          # @author shawn.han <shawn.han@rccchina.com>
+          #
+          # @see https://help.aliyun.com/document_detail/54237.html#section-92h-jsb-rlu
+          #
+          # @return [String] X-Opensearch-Nonce的值
+          #
+          def x_opensearch_nonce
+            @x_opensearch_nonce ||= "#{time_now.to_i}#{rand(NONCE_SUFFIX_MIN..NONCE_SUFFIX_MAX)}"
+          end
+
+          #
+          # 生成 header中 Date的值
+          #
+          # @author shawn.han <shawn.han@rccchina.com>
+          #
+          # @return [String] Date的值
+          #
+          def date
+            @date ||= time_now.utc.strftime('%Y-%m-%dT%H:%M:%SZ')
+          end
+
+          #
+          # 生成 header中 Content-MD5的值
+          #
+          # @author shawn.han <shawn.han@rccchina.com>
+          #
+          # @return [String] Content-MD5的值
+          #
+          def content_md5
+            Digest::MD5.hexdigest(@api_params.to_json) if @request_method == 'POST' && @api_params
+          end
+
+          private
+
+          #
+          # 当前时间
+          #
+          # @author shawn.han <shawn.han@rccchina.com>
+          #
+          # @return [Time] 当前时间
+          #
+          def time_now
+            @time_now ||= Time.now
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aliyun/opensearch/client_ext/traffic.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# require traffic folder ruby file
+%w[header behavior].each do |file|
+  require File.join(File.dirname(__FILE__), 'traffic', file)
+end

data/lib/aliyun/opensearch/configuration.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Aliyun
+  module Opensearch
+    #
+    # 服务配置
+    #
+    # @author shawn.han <shawn.han@rccchina.com>
+    #
+    class Configuration
+      class << self
+        attr_accessor :endpoint # Opensearch服务地址
+        attr_accessor :access_key_id # 阿里云申请的ak
+        attr_accessor :access_key_secret # 阿里云申请的ak secret
+
+        #
+        # 根据设置的endpoint获取服务的url, 如果没有协议头默认设置为https
+        #
+        # @author shawn.han <shawn.han@rccchina.com>
+        #
+        # @return [String] 服务url
+        #
+        def opensearch_url
+          endpoint =~ /^https?:\/\// ? endpoint : "https://#{endpoint}"
+        end
+      end
+    end
+  end
+end

data/lib/aliyun/opensearch/error.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Aliyun
+  module Opensearch
+    #
+    # 异常模块
+    #
+    # @author shawn.han <shawn.han@rccchina.com>
+    #
+    module Error
+      #
+      # 请求异常基类
+      #
+      # @author shawn.han <shawn.han@rccchina.com>
+      #
+      class HttpBase < Faraday::Error
+      end
+
+      #
+      # 阿里云异常基类
+      #
+      # @author shawn.han <shawn.han@rccchina.com>
+      #
+      class AliyunService < HttpBase
+        ERRCODE_ALIYUN_SYS = (1000..1999).freeze # 系统级别（1000-1999）
+        ERRCODE_ALIYUN_APP = (2000..2999).freeze # 应用相关（2000-2999）
+        ERRCODE_ALIYUN_DOC = (3000..3999).freeze # 文档相关（3000-3999）
+        ERRCODE_ALIYUN_AUTH = (4000..4999).freeze # 授权相关（4000-4999）
+        ERRCODE_ALIYUN_USER = (5000..5999).freeze # 用户相关（5000-5999）
+        ERRCODE_ALIYUN_SEARCH = (6000..6999).freeze # 搜索相关（6000-6999）
+        ERRCODE_ALIYUN_CMD = (7000..7999).freeze # 数据处理相关（7000-7999）
+        ERRCODE_ALIYUN_COMMON = (8000..8999).freeze # 文档错误内部通知（8000-8999）
+        ERRCODE_ALIYUN_TEMPLETE = (9000..9999).freeze # 模板相关（9000-9999）
+        ERRCODE_ALIYUN_SYNC = (10_000..).freeze # 数据同步相关（10000-）
+
+        attr_reader :response
+
+        #
+        # 初始化
+        #
+        # @author shawn.han <shawn.han@rccchina.com>
+        #
+        # @param [Faraday::Response] response 接口返回结果
+        #
+        def initialize(response)
+          @response = response
+          @body = JSON.parse(response.body)
+
+          super("RequestId:#{@body['request_id']} Message:#{errors_message}", response)
+        end
+
+        #
+        # 获取错误信息
+        #
+        # @author shawn.han <shawn.han@rccchina.com>
+        #
+        # @return [String] 错误消息
+        #
+        def errors_message
+          @body['errors'].map do |error|
+            "[#{error['code']}] #{error['message']}"
+          end.join("\n")
+        end
+      end
+
+      #
+      # 空参数异常
+      #
+      # @author shawn.han <shawn.han@rccchina.com>
+      #
+      class EmptyParam < ArgumentError
+        #
+        # 初始化
+        #
+        # @author shawn.han <shawn.han@rccchina.com>
+        #
+        def initialize
+          super('Param Can Not Be Empty')
+        end
+      end
+
+      #
+      # 无效返回结果异常
+      #
+      # @author shawn.han <shawn.han@rccchina.com>
+      #
+      class InvalidResponseBody < HttpBase
+        #
+        # 初始化
+        #
+        # @author shawn.han <shawn.han@rccchina.com>
+        #
+        def initialize(response)
+          super('Response Body is Invalid', response)
+        end
+      end
+    end
+  end
+end

data/lib/aliyun/opensearch/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Aliyun
+  module Opensearch
+    VERSION = '0.1.1'
+  end
+end

data/lib/aliyun/opensearch.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'base64'
+require 'digest'
+require 'faraday'
+require 'json'
+require 'openssl'
+
+require 'aliyun/opensearch/client'
+require 'aliyun/opensearch/configuration'
+require 'aliyun/opensearch/error'
+require 'aliyun/opensearch/version'
+
+module Aliyun
+  #
+  # Aliyun Opensearch SDK
+  #
+  # @author shawn.han <shawn.han@rccchina.coms>
+  #
+  module Opensearch
+  end
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: aliyun-opensearch-client
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- shawn.han
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 对接Aliyun Opensearch 的流量API HTTP接口, 生成签名并发送请求
+email:
+- shawn.han@rccchina.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- aliyun-opensearch-client.gemspec
+- bin/console
+- bin/setup
+- lib/aliyun/opensearch.rb
+- lib/aliyun/opensearch/client.rb
+- lib/aliyun/opensearch/client_ext/management/.keep
+- lib/aliyun/opensearch/client_ext/traffic.rb
+- lib/aliyun/opensearch/client_ext/traffic/behavior.rb
+- lib/aliyun/opensearch/client_ext/traffic/header.rb
+- lib/aliyun/opensearch/client_ext/traffic/header/credentials.rb
+- lib/aliyun/opensearch/configuration.rb
+- lib/aliyun/opensearch/error.rb
+- lib/aliyun/opensearch/version.rb
+homepage: https://github.com/rccgroup/aliyun-opensearch-client
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/rccgroup/aliyun-opensearch-client
+  source_code_uri: https://github.com/rccgroup/aliyun-opensearch-client
+  changelog_uri: https://github.com/rccgroup/aliyun-opensearch-client/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.4
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Aliyun Opensearch 服务客户端
+test_files: []