tim_sdk 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 120fff55b1cbf6d06d3f90863e1c2ef6a5ce41df228e539b3299f7ee60252a20
+  data.tar.gz: 1fe795963ff30c17d5eea55b812cdd50094d5978e4d548409adfbf4d6fdce70e
+SHA512:
+  metadata.gz: 6a087161ed2a58f0da8baee2c7d4fb183ff37070eec59a187d54213adf37b8e04257bdda5effc792787c97785dce7b7ba10f3ac12090d2cc2545237678fc1359
+  data.tar.gz: 01dcf8d334714d6742c37cf6e7d56e4ca009281501c0f5243385135dccfe16462b2eb1bd75034b030afaa9e6840edcb379e6de1afad449bd9fc7c6a0bfd243b4

data/.gitignore

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

data/.rakeTasks

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Settings><!--This file was automatically generated by Ruby plugin.
+You are allowed to: 
+1. Remove rake task
+2. Add existing rake tasks
+To add existing rake tasks automatically delete this file and reload the project.
+--><RakeGroup description="" fullCmd="" taksId="rake" /></Settings>

data/.rspec

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

data/.travis.yml

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

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 vincent4502237@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 [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,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tim_sdk.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'faraday', '~> 1.0', '>= 1.0.1'

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    tim_sdk (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    multipart-post (2.1.1)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  faraday (~> 1.0, >= 1.0.1)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  tim_sdk!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 JiangYongKang
+
+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 @@
+# TimSdk

data/Rakefile

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

data/bin/console

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

@@ -0,0 +1,130 @@
+require 'faraday'
+
+module TimSdk
+  class Api
+
+    def self.connection
+      @connection ||= Faraday.new('https://console.tim.qq.com', params: {
+          sdkappid:    TimSdk.configuration.app_id,
+          identifier:  TimSdk.configuration.admin_account,
+          usersig:     TimSdk::Sign.signature(TimSdk.configuration.admin_account),
+          random:      rand(0..4294967295),
+          contenttype: :json
+      }) do |faraday|
+        faraday.response :logger
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    # 导入单个帐号
+    def self.invoke_account_import(identifier, nick = nil, face_url = nil)
+      response = connection.post('/v4/im_open_login_svc/account_import') do |request|
+        request_body = { :Identifier => identifier.to_s }
+        request_body.merge!(:Nick => nick) if nick
+        request_body.merge!(:FaceUrl => face_url) if face_url
+        request.body = request_body.to_json
+      end
+      raise TimServerError, "Response Status: #{response.status}" unless response.success?
+      JSON.parse(response.body, symbolize_names: true) if response.success?
+    end
+
+    # 导入多个账号
+    def self.invoke_multi_account_import(accounts)
+      response = connection.post('/v4/im_open_login_svc/multiaccount_import') do |request|
+        request.body = {
+            :Accounts => accounts.map(&:to_s)
+        }.to_json
+      end
+      raise TimServerError, "Response Status: #{response.status}" unless response.success?
+      JSON.parse(response.body, symbolize_names: true) if response.success?
+    end
+
+    # 删除账号
+    def self.invoke_account_delete(accounts)
+      response = connection.post('/v4/im_open_login_svc/account_delete') do |request|
+        request.body = {
+            :DeleteItem => accounts.map do |account|
+              {
+                  :UserID => account.to_s
+              }
+            end
+        }.to_json
+      end
+      raise TimServerError, "Response Status: #{response.status}" unless response.success?
+      JSON.parse(response.body, symbolize_names: true) if response.success?
+    end
+
+    # 查询账号
+    def self.invoke_account_check(accounts)
+      response = connection.post('/v4/im_open_login_svc/account_check') do |request|
+        request.body = {
+            :CheckItem => accounts.map do |account|
+              {
+                  :UserID => account.to_s
+              }
+            end
+        }.to_json
+      end
+      raise TimServerError, "Response Status: #{response.status}" unless response.success?
+      JSON.parse(response.body, symbolize_names: true) if response.success?
+    end
+
+    # 失效帐号登录态
+    def self.invoke_kick(identifier)
+      response = connection.post('/v4/im_open_login_svc/kick') do |request|
+        request.body = {
+            :Identifier => identifier.to_s
+        }.to_json
+      end
+      raise TimServerError, "Response Status: #{response.status}" unless response.success?
+      JSON.parse(response.body, symbolize_names: true) if response.success?
+    end
+
+    # 查询帐号在线状态
+    def self.invoke_query_state(accounts, is_need_detail = 0)
+      response = connection.post('/v4/openim/querystate') do |request|
+        request.body = {
+            :To_Account   => accounts.map(&:to_s),
+            :IsNeedDetail => is_need_detail
+        }.to_json
+      end
+      raise TimServerError, "Response Status: #{response.status}" unless response.success?
+      JSON.parse(response.body, symbolize_names: true) if response.success?
+    end
+
+    # 拉取运营数据
+    def self.invoke_fetch_app_info(fields = [])
+      response = connection.post('/v4/openconfigsvr/getappinfo') do |request|
+        request.body = {
+            :RequestField => fields
+        }.to_json
+      end
+      raise TimServerError, "Response Status: #{response.status}" unless response.success?
+      JSON.parse(response.body, symbolize_names: true) if response.success?
+    end
+
+
+    # 下载消息记录
+    def self.invoke_fetch_history(chat_type, msg_time)
+      response = connection.post('/v4/open_msg_svc/get_history') do |request|
+        request.body = {
+            :ChatType => chat_type,
+            :MsgTime  => msg_time,
+        }.to_json
+      end
+      raise TimServerError, "Response Status: #{response.status}" unless response.success?
+      JSON.parse(response.body, symbolize_names: true) if response.success?
+    end
+
+
+    # 获取服务器 IP 地址
+    def self.invoke_fetch_ip_list
+      response = connection.post('/v4/ConfigSvc/GetIPList') do |request|
+        request.body = {}.to_json
+      end
+      raise TimServerError, "Response Status: #{response.status}" unless response.success?
+      JSON.parse(response.body, symbolize_names: true) if response.success?
+    end
+
+  end
+end

data/lib/tim_sdk/configuration.rb

@@ -0,0 +1,5 @@
+module TimSdk
+  class Configuration
+    attr_accessor :app_id, :app_key, :admin_account
+  end
+end

data/lib/tim_sdk/sign.rb

@@ -0,0 +1,55 @@
+require 'tim_sdk/configuration'
+require 'base64'
+require 'openssl'
+require 'json'
+require 'zlib'
+
+module TimSdk
+  class Sign
+    class << self
+
+      def signature(identifier, expire = 24 * 60 * 60)
+        do_signature(identifier, expire, nil)
+      end
+
+      def signature_with_user_buf(identifier, expire, user_buf)
+        do_signature(identifier, expire, user_buf)
+      end
+
+      private
+
+      def do_signature(identifier, expire = 180 * 86400, user_buf = nil)
+        timestamp       = Time.now.to_i
+        raw_data        = {}
+        base64_user_buf = nil
+        unless user_buf.nil?
+          base64_user_buf = Base64.encode64(user_buf)
+          raw_data.merge!('TLS.userbuf' => base64_user_buf)
+        end
+        raw_data.merge!('TLS.sig'        => hmac_sha256(identifier, timestamp, expire, base64_user_buf),
+                        'TLS.expire'     => expire.to_i,
+                        'TLS.sdkappid'   => TimSdk.configuration.app_id,
+                        'TLS.ver'        => '2.0',
+                        'TLS.time'       => timestamp,
+                        'TLS.identifier' => identifier.to_s)
+        raw_sig  = raw_data.to_json.gsub(/,/, ', ').gsub(/:/, ': ')
+        sig_zlib = Zlib::Deflate.deflate(raw_sig)
+        base64_encode(sig_zlib)
+      end
+
+      def hmac_sha256(identifier, curr_time, expire, base64_user_buf = nil)
+        data = ["TLS.identifier:#{identifier}", "TLS.sdkappid:#{TimSdk.configuration.app_id}", "TLS.time:#{curr_time}", "TLS.expire:#{expire}"]
+        data << "TLS.userbuf:#{base64_user_buf}" if base64_user_buf
+        data_string = "#{data.join("\n")}\n"
+        Base64.strict_encode64(
+            OpenSSL::HMAC.digest('sha256', TimSdk.configuration.app_key, data_string)
+        )
+      end
+
+      def base64_encode(data)
+        Base64.strict_encode64(data).gsub('+', '*').gsub('/', '-').gsub('=', '_')
+      end
+
+    end
+  end
+end

data/lib/tim_sdk/version.rb

@@ -0,0 +1,3 @@
+module TimSdk
+  VERSION = '0.1.1'
+end

data/lib/tim_sdk.rb

@@ -0,0 +1,21 @@
+require "tim_sdk/version"
+require 'tim_sdk/sign'
+require 'tim_sdk/api'
+
+module TimSdk
+
+  class TimServerError < StandardError; end
+
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+  end
+
+end

data/tim_sdk.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/tim_sdk/version'
+
+Gem::Specification.new do |spec|
+  spec.name    = 'tim_sdk'
+  spec.version = TimSdk::VERSION
+  spec.authors = ['JiangYongKang']
+  spec.email   = ['vincent4502237@gmail.com']
+
+  spec.summary               = 'tencent tim sdk for ruby'
+  spec.description           = 'a ruby program to facilitate accessing tim service'
+  spec.homepage              = 'https://github.com/JiangYongKang/tim_sdk'
+  spec.license               = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri']    = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/JiangYongKang/tim_sdk'
+  spec.metadata['changelog_uri']   = 'https://github.com/JiangYongKang/tim_sdk'
+
+  # 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']
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: tim_sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- JiangYongKang
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-09-14 00:00:00.000000000 Z
+dependencies: []
+description: a ruby program to facilitate accessing tim service
+email:
+- vincent4502237@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rakeTasks"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tim_sdk.rb
+- lib/tim_sdk/api.rb
+- lib/tim_sdk/configuration.rb
+- lib/tim_sdk/sign.rb
+- lib/tim_sdk/version.rb
+- tim_sdk.gemspec
+homepage: https://github.com/JiangYongKang/tim_sdk
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/JiangYongKang/tim_sdk
+  source_code_uri: https://github.com/JiangYongKang/tim_sdk
+  changelog_uri: https://github.com/JiangYongKang/tim_sdk
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: tencent tim sdk for ruby
+test_files: []