aliyun_chatbot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b8c30d81d5200a1823517cf7098abc965ff4757c8cf5336878e213a553bd057c
+  data.tar.gz: e578abb09305ec50a54614a718eb54266f8ea94cafd0e8324d3623ad8bd57560
+SHA512:
+  metadata.gz: 819ce0cd503b2a339013b27f29f1b4efff5f96af0ca8596f4a8dbf1c9485c7d360fb84761ad35bcc1bfc017268e245f11a67389116c082ad406f6f4e9c5e382e
+  data.tar.gz: 1e31b57bd0adac34f246e122dbe4adc85be7cada1609d50f6dd00594298fe71c1e10dbd44a3acb7c252ee56804d29559b72843b7229fa51bda16ef1aba153ffa

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 2.0.2

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 lewislinlin@gmail.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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://gems.ruby-china.com"
+
+# Specify your gem's dependencies in aliyun_chatbot.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    aliyun_chatbot (0.1.0)
+      http (~> 2.2)
+
+GEM
+  remote: https://gems.ruby-china.com/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    diff-lcs (1.3)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    http (2.2.2)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 1.0.1)
+      http_parser.rb (~> 0.6.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (1.0.3)
+    http_parser.rb (0.6.0)
+    public_suffix (4.0.1)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aliyun_chatbot!
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 lewis
+
+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,57 @@
+# AliyunChatbot
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/aliyun_chatbot`. To experiment with that code, run `bin/console` for an interactive prompt.
+[ruby sdk for aliyun chatbot](https://help.aliyun.com/document_detail/60762.html?spm=a2c4g.11186623.6.593.81035929ZxOJur)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'aliyun_chatbot'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install aliyun_chatbot
+
+## Usage
+
+```ruby
+
+#config/initialize/AliyunChatbot.rb
+AliyunChatbot.configure do |c|
+    c.ak_id = 'xx'
+    c.ak_secret = 'xx'
+end
+# rails c
+client = AliyunChatbot::Client.new
+
+
+# or
+client = AliyunChatbot::Client.new(ak_id, ak_secret)
+# instance_id from chatbot infos
+client.send_message("instance_id" , "message")
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/aliyun_chatbot. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/aliyun_chatbot.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "aliyun_chatbot/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "aliyun_chatbot"
+  spec.version       = AliyunChatbot::VERSION
+  spec.authors       = ["lewis"]
+  spec.email         = ["lewislinlin@gmail.com"]
+
+  spec.summary       = %q{aliyun chatbot sdk}
+  spec.description   = %q{aliyun chatbot sdk}
+  spec.homepage      = "https://help.aliyun.com/document_detail/60762.html"
+  spec.license       = "MIT"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/cs-cj/aliyun_chatbot"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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('..', __FILE__)) 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 'http', '~> 2.2'
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "aliyun_chatbot"
+
+# 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_chatbot.rb

@@ -0,0 +1,14 @@
+require "aliyun_chatbot/version"
+require 'securerandom'
+require 'json'
+require "http"
+require 'base64'
+require 'digest/md5'
+require 'aliyun_chatbot/config'
+require 'aliyun_chatbot/api'
+require 'aliyun_chatbot/client'
+
+module AliyunChatbot
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/aliyun_chatbot/api.rb

@@ -0,0 +1,58 @@
+# Dir["#{File.dirname(__FILE__)}/api/*.rb"].each do |path|
+#   require path
+# end
+module AliyunChatbot
+  module Api
+
+    URL_BASE = "chatbot.cn-shanghai.aliyuncs.com"
+
+    def public_params
+      uuid = SecureRandom.uuid
+      {
+        Format: 'json', #	String 	否	返回值的类型，支持 JSON 与 XML。默认为 XML。
+        Version: '2017-10-11', #	String	是	API 版本号，为日期形式：YYYY-MM-DD，本版本对应为2017-10-11。
+        AccessKeyId: ak_id,	# String	是	阿里云颁发给用户的访问服务所用的密钥 ID。
+        # Signature	String	是	签名结果串，关于签名的计算方法，请参见签名机制。
+        SignatureMethod: 'HMAC-SHA1', #	String	是	签名方式，目前支持 HMAC-SHA1。
+        Timestamp: Time.now.utc.iso8601, #	String	是	请求的时间戳。日期格式按照 ISO8601 标准表示，并需要使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ，例如 2017-10-11T12:00:00Z （为北京时间 2017 年 10 月 11 日 20 点 0 分 0 秒）。
+        SignatureVersion: 1.0, #	String	是	签名算法版本，目前版本是 1.0。
+        SignatureNonce: uuid #,	String
+      }
+    end
+    # module Some
+    # end
+
+    def chat_params( instance_id, utterance, session_id, knowledge_id)
+      required =   {
+        Action: 'Chat', #	String	是	系统规定参数，取值：Chat
+        InstanceId: instance_id, #		String	是	机器人实例ID。登录云小蜜控制台，左侧面板选择开发者->基本配置，查看机器人示例信息，可获得该实例ID。
+        Utterance: utterance, #		String	是	机器人访问者的输入
+      }
+      
+      # String	否	
+      # 会话ID，用于标识一个访问者的会话和保持上下文信息。
+      # 对于一个新的访问者，首次调用Chat接口时无需传递此字段，机器人会开启一个会话，并在Chat接口的响应中返回该会话的SessionId。
+      # 对于该访问者的后续轮次的会话，调用Chat接口时传递当前会话的SessionId，机器人即可基于SessionId继续该轮次会话。
+      required.merge!({SessionId: session_id }) if session_id.to_s != ''
+      
+      #String	否	知识库词条的关联问题的ID。若指定此ID，那么机器人会直接返回指定的关联问题的答案
+      required.merge!({KnowledgeId: knowledge_id }) if knowledge_id.to_s != ''
+      
+      # Perspective.1	String	否	视角编码，用于调用同一知识标题下不同视角的答案。在拼装请求参数时，需要以Perspective.1={视角编码}的格式传递参数。如：&Perspective.1=FZJBY3raWr。使用SDK时以SDK中定义的参数为准。目前仅支持一个视角答案的调用。
+      required
+    end
+
+    def sender_params(sender_id, sender_nick, tag)
+      optional = {
+
+      }
+      #	String	否	访问者ID。用于识别当前会话中的用户
+      optional.merge!({SenderId: sender_id }) if sender_id.to_s != ''
+      #		String	否	当前会话中访问的昵称
+      optional.merge!({SenderNick: sender_nick }) if sender_nick.to_s != ''
+      #		String	否	可以传递任何内容参数，该参数将会直接在返回结果中透传回来。
+      optional.merge!({Tag: tag }) if tag.to_s != ''
+      optional
+    end
+  end
+end

data/lib/aliyun_chatbot/client.rb

@@ -0,0 +1,61 @@
+require "cgi"
+module AliyunChatbot
+  class Client
+    include AliyunChatbot::Api
+    # include AliyunChatbot::Config
+
+    attr_accessor :ak_id, :ak_secret
+
+    def initialize ak_id = nil, ak_secret = nil
+      @ak_id = ak_id || AliyunChatbot.ak_id
+      @ak_secret = ak_secret || AliyunChatbot.ak_secret
+    end
+
+    def send_message  instance_id, utterance, session_id = nil, knowledge_id = nil, sender_id = nil, sender_nick = nil, tag = nil
+      whole_params = public_params.merge chat_params(instance_id, utterance, session_id, knowledge_id)
+      whole_params.merge! sender_params(sender_id, sender_nick, tag)
+      
+      signature = signature(whole_params)
+      whole_params.merge!({Signature: signature})
+
+      puts "whole_params"
+      puts whole_params
+
+      scheme = 'https'
+      url = scheme + "://" + URL_BASE + "?" + params_to_query_string(whole_params)
+      puts "Final Get URL : " + url
+      response = HTTP.get(url)
+      # {"SessionId"=>"xxx", "Messages"=>[{"Text"=>{"Content"=>"", "AnswerSource"=>"NO_ANSWER"}, "Type"=>"Text", "Knowledge"=>{}}], "MessageId"=>"xxx", "RequestId"=>"xxx"}
+      JSON.parse(response) rescue nil
+    end
+
+    # todo module
+    def params_to_query_string(params)
+      query = params.sort.map do |k, v|
+        "#{percent_cncode(k)}=#{percent_cncode(v)}" if v.to_s != ''
+      end.compact.join('&')
+      # puts "URL before sign"
+      # puts query
+      query
+    end
+
+    # 注意：一般支持 URL 编码的库（比如 Java 中的 java.net.URLEncoder）都是按照“application/x-www-form-urlencoded”的 MIME 类型的规则进行编码的。实现时可以直接使用这类方式进行编码，把编码后的字符串中的加号“+”替换成“%20”、星号“*”替换成“%2A”、“%7E”替换回波浪号“~”，即可得到上述规则描述的编码字符串。
+    def percent_cncode(str)
+      CGI.escape(str.to_s).gsub("+", "%20").gsub("*", "%2A").gsub("%7E", "~")
+    end
+
+    def signature(params)
+      string_to_sign = "GET" + "&" + "%2F" + "&"+ percent_cncode(params_to_query_string(params))
+      # puts "StringToSign"
+      # puts string_to_sign 
+      signature = Base64.strict_encode64(OpenSSL::HMAC.digest('sha1', hmac_key, string_to_sign))
+      signature
+    end
+
+    def hmac_key
+      "#{ak_secret}&"
+    end
+
+  end
+
+end

data/lib/aliyun_chatbot/config.rb

@@ -0,0 +1,31 @@
+module AliyunChatbot
+
+  class << self
+
+    attr_accessor :config
+
+    def configure
+      yield self.config ||= Config.new
+      config.instance_variables.each do |var_sym|
+        singleton_class.define_method var_sym.to_s.gsub(/^@/, '').to_sym do
+          config.instance_variable_get var_sym
+        end
+      end
+
+    end
+
+
+  end
+
+  class Config
+    attr_accessor :ak_id, :ak_secret
+    # config/initialize/aliyun_chatbot.rb
+    # AliyunChatbot.configure do |config|
+    #   config.ak_id = ak_id from aliyun
+    #   config.ak_secret = ak_secret from aliyun
+    # end
+  end
+
+
+
+end

data/lib/aliyun_chatbot/version.rb

@@ -0,0 +1,3 @@
+module AliyunChatbot
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: aliyun_chatbot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- lewis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: aliyun chatbot sdk
+email:
+- lewislinlin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- aliyun_chatbot.gemspec
+- bin/console
+- bin/setup
+- lib/aliyun_chatbot.rb
+- lib/aliyun_chatbot/api.rb
+- lib/aliyun_chatbot/client.rb
+- lib/aliyun_chatbot/config.rb
+- lib/aliyun_chatbot/version.rb
+homepage: https://help.aliyun.com/document_detail/60762.html
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://help.aliyun.com/document_detail/60762.html
+  source_code_uri: https://github.com/cs-cj/aliyun_chatbot
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: aliyun chatbot sdk
+test_files: []