tls-sig-api-v2 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 817ef55aa08fea91ec70cb744a54e25923ee75f9499dbb7f82f90b23f6fca799
+  data.tar.gz: f8c7e51650ad047cb196b78105003daf5a1e7aafe4488261131829e9c8c023eb
+SHA512:
+  metadata.gz: 032cd9aef4540baec5097b5c5c365569b2dc3a2e3abf4e4278416febdd3cdce4b830f828489af7ad7fa77237ef2773c8bdd175fdce25dfc7ac7e3573933adbea
+  data.tar.gz: aea68dc98e3bb813695d06fd686c2c4e6d1f671956d42acc010c2aeac0d82dd365938e15a870b731a758b191c31706e34a45f302c3e624c7609aa17d012d6fbc

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.1

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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in tls-sig-api-v2.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    tls-sig-api-v2 (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  tls-sig-api-v2!
+
+BUNDLED WITH
+   2.0.1

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,58 @@
+# Tls::Sig::Api::V2
+
+Tencent IM UserSig for Ruby
+
+## Reference
+
+* [tencent IM UserSig document](https://cloud.tencent.com/document/product/269/32688)
+
+* [node genSig code](https://github.com/tencentyun/tls-sig-api-v2-node)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tls-sig-api-v2'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tls-sig-api-v2
+
+## Usage
+
+    $ irb
+    $ require 'tls/sig/api/v2'
+
+
+```ruby
+    # 初始化 server = Tls::Sig::Api::V2::Server.new("sdkappid","xxxkey") 
+    server = Tls::Sig::Api::V2::Server.new(1400000000, "5bd2850fff3ecb11d7c805251c51ee463a25727bddc2385f3fa8bfee1bb93b5e")
+    sig = server.gen_sig("xiaojun", 86400*180)
+
+```    
+
+
+
+## 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]/tls-sig-api-v2. 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).
+
+## Code of Conduct
+
+Everyone interacting in the Tls::Sig::Api::V2 project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/tls-sig-api-v2/blob/master/CODE_OF_CONDUCT.md).

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 "tls/sig/api/v2"
+
+# 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/tls/sig/api/v2.rb

@@ -0,0 +1,86 @@
+require "tls/sig/api/v2/version"
+require 'json'
+require 'base64'
+require 'openssl'
+require "zlib"
+# require 'digest/md5'
+require 'time'
+
+module Tls
+  module Sig
+    module Api
+      module V2
+        # class Error < StandardError; end
+        # Your code goes here...
+        class Server
+          attr_accessor :sdkappid, :key
+    
+          def initialize(sdkappid, key)
+            @sdkappid = sdkappid
+            @key = key
+          end
+
+        #  /**
+        #   * 生成 usersig
+        #   * @param identifier 用户账号
+        #   * @param expire 有效期，单位秒
+        #   * @returns {string} 返回的 sig 值
+        #   */
+          def gen_sig( identifier,  expire) 
+             gen_sig_with_userbuf(identifier, expire, nil);
+          end
+    
+          # /**
+          # * 生成带 userbuf 的 usersig
+          # * @param identifier  用户账号
+          # * @param expire 有效期，单位秒
+          # * @param userBuf 用户数据
+          # * @returns {string} 返回的 sig 值
+          # */
+          def gen_sig_with_userbuf(  identifier,   expire,   userbuf)
+            currTime = Time.now.to_i
+            sigDoc = {
+              "TLS.ver": "2.0",
+              "TLS.identifier": identifier,
+              "TLS.sdkappid": sdkappid ,
+              "TLS.expire": expire ,
+              "TLS.time": currTime
+            }
+            base64UserBuf = nil
+            if userbuf != nil 
+              base64UserBuf = Base64.strict_encode64(userbuf)
+              sigDoc["TLS.userbuf"] = base64UserBuf
+            end
+            sig = hmacsha256(identifier, currTime, expire, base64UserBuf);
+            if sig == ""
+              return "";
+            end       
+            sigDoc["TLS.sig"] = sig
+            json = sigDoc.to_json
+            data_compressed = Zlib::Deflate.deflate(json)
+            base64str = Base64.strict_encode64(data_compressed) 
+            escape(base64str)
+          end
+
+          protected
+
+          def hmacsha256(  identifier,   currTime,   expire,   base64Userbuf)
+            contentToBeSigned = "TLS.identifier:#{identifier}\n" + "TLS.sdkappid:#{sdkappid}\n" + "TLS.time:#{currTime}\n" + "TLS.expire:#{expire}\n";
+           if base64Userbuf != nil 
+               contentToBeSigned += "TLS.userbuf:" + base64Userbuf + "\n";
+           end
+           res = OpenSSL::HMAC.digest("sha256", key, contentToBeSigned)
+           res = Base64.strict_encode64(res) 
+           res
+         end
+
+
+         def escape(str)
+           str.gsub(/\+/, '*').gsub(/\//, '-').gsub(/=/, '_')
+         end
+
+        end
+      end
+    end
+  end
+end

data/lib/tls/sig/api/v2/version.rb

@@ -0,0 +1,9 @@
+module Tls
+  module Sig
+    module Api
+      module V2
+        VERSION = "0.1.1"
+      end
+    end
+  end
+end

data/tls-sig-api-v2.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "tls/sig/api/v2/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "tls-sig-api-v2"
+  spec.version       = Tls::Sig::Api::V2::VERSION
+  spec.authors       = ["lewis"]
+  spec.email         = ["lewislinlin@gmail.com"]
+
+  spec.summary       = %q{tls-sig-api-v2-ruby}
+  spec.description   = %q{https://cloud.tencent.com/document/product/269/32688}
+  spec.homepage      = "https://github.com/cs-cj/tls-sig-api-v2"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/cs-cj/tls-sig-api-v2"
+    # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: tls-sig-api-v2
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- lewis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-26 00:00:00.000000000 Z
+dependencies:
+- !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: https://cloud.tencent.com/document/product/269/32688
+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
+- bin/console
+- bin/setup
+- lib/tls/sig/api/v2.rb
+- lib/tls/sig/api/v2/version.rb
+- tls-sig-api-v2.gemspec
+homepage: https://github.com/cs-cj/tls-sig-api-v2
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/cs-cj/tls-sig-api-v2
+  source_code_uri: https://github.com/cs-cj/tls-sig-api-v2
+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: tls-sig-api-v2-ruby
+test_files: []