easemob 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b342046e707d8e8ea41d2faa6f22dce83708306
-  data.tar.gz: 58388e41f977c65347c0f81bac8afccf82e8333f
+  metadata.gz: 8468de1f0eb25f0cb4f5fd7182cd537f5a065f22
+  data.tar.gz: d9ded95865eb429592ac84d43e6bfdefa77e427f
 SHA512:
-  metadata.gz: 08f38b249d8348590cc4fd5c8dfc491d1d6877d02f0143739e51fee90ac93d754b072f445eb14df6fde63393838e7af0724fbe95b6f9e031fe7491e77876eacb
-  data.tar.gz: 1f9df96100bd62db5d9674388101792a80160b0a1fa60c6624a0851fcd2efe5d12857f438185abc86309db4b00c1ba5dd65607a04a812fb52d2476ad729cc1a8
+  metadata.gz: d2b122d07608493b2857b6baf14ae02260d00149542342954b19e5409684a178152635480d8c3eac9f9597451e85005508577d24b1df4db883d0fbf981734815
+  data.tar.gz: ad09e35e5b0f5e974e302e4b021d6406ec987c6f98d135a55de75a4eca00018a9085b276b459332a37d1b0837ee7075f40294d8fa61edf0e13c8195ca95330b5

data/.gitignore

@@ -1,3 +1,5 @@
+/.idea
+.DS_Store
 /.bundle/
 /.yardoc
 /Gemfile.lock
@@ -7,3 +9,6 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.sublime-workspace
+spec/examples.txt
+.byebug_history

data/.rubocop.yml

@@ -0,0 +1,26 @@
+AllCops:
+  TargetRubyVersion: 2.1
+
+Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 300
+
+Metrics/AbcSize:
+  Max: 57
+
+Metrics/ClassLength:
+  Max: 150
+
+Metrics/MethodLength:
+  Max: 20
+
+Style/NumericLiterals:
+  MinDigits: 7
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/ParameterLists:
+  Max: 15

data/.travis.yml

@@ -1,4 +1,5 @@
+sudo: false
 language: ruby
 rvm:
-  - 2.2.0
-before_install: gem install bundler -v 1.10.5
+  - 2.3.1
+before_install: gem install bundler -v 1.13.3

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Liu Lantao
+Copyright (c) 2016 guochunzhong
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,8 +1,6 @@
 # Easemob
 
-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/easemob`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Easemob is an unofficial easemob IM instant message gem, inspired from [huanxin](https://github.com/RobotJiang/ruby-for-huanxin) a lot.
 
 ## Installation
 
@@ -22,17 +20,26 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Config
+
+Create `config/initializers/easemob.rb` and put following configurations into it.
+
+```ruby
+Easemob.client_id     = 'app_client_id'     # 使用 APP 的 client_id
+Easemob.client_secret = 'app_client_secret'
+Easemob.org_name = 'bayetech' # 企业的唯一标识，开发者管理后台注册账号时填写的企业 ID
+Easemob.app_name = 'landlord' # 同一“企业”下“APP”唯一标识，创建应用时填写的“应用名称”
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+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]/easemob. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/bayetech/easemob. 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

data/lib/easemob.rb

@@ -1,5 +1,69 @@
-require "easemob/version"
+require 'http'
+require 'json'
+require 'connection_pool'
+require 'easemob/version'
+require 'easemob/token'
+require 'easemob/users'
 
 module Easemob
-  # Your code goes here...
+  class << self
+    attr_accessor :client_id     # 使用 APP 的 client_id
+    attr_accessor :client_secret # 和 client_secret 获取授权管理员 token
+
+    attr_writer :base_url
+    attr_writer :org_name        # 企业的唯一标识，开发者管理后台注册账号时填写的企业 ID
+    attr_writer :app_name        # 同一“企业”下“APP”唯一标识，在环信开发者管理后台创建应用时填写的“应用名称”
+
+    attr_writer :token_file_path
+    attr_writer :http_pool
+    attr_writer :http_timeout
+  end
+  @base_url = 'https://a1.easemob.com'
+  @random_generator = Random.new
+  @http_pool = 5
+  @http_timeout = 5
+
+  def self.head_url
+    "#{@base_url}/#{@org_name}/#{@app_name}"
+  end
+
+  def self.token_file_path
+    @token_file_path || "/tmp/easemob_#{@org_name}_#{@app_name}_token"
+  end
+
+  def self.httprbs
+    @httprbs ||= ConnectionPool.new(size: @http_pool, timeout: @http_timeout) { HTTP.persistent @base_url }
+  end
+
+  def self.do_post(resource, body_hash)
+    httprbs.with do |http|
+      res = do_post_request(http, resource, body_hash)
+      case res.code
+      # 401:（未授权）请求要求身份验证。对于需要 token 的接口，服务器可能返回此响应。
+      when 401, 408
+        Token.refresh
+        res = do_post_request(http, resource, body_hash)
+      # 408:（请求超时）服务器等候请求时发生超时。
+      when 408
+        res = do_post_request(http, resource, body_hash)
+      end
+      res
+    end
+  end
+
+  def self.do_post_request(http, resource, body_hash)
+    http.headers('Authorization' => "Bearer #{token}")
+        .post "#{head_url}/#{resource}", json: body_hash
+  end
+
+  def self.token
+    # Possible two worker running, one worker refresh token, other unaware, so must read every time
+    access_token, remain_life_seconds = Token.read_from_store
+    Token.refresh if remain_life_seconds < @random_generator.rand(30..3 * 60)
+    access_token
+  end
+
+  class << self
+    include Users
+  end
 end

data/lib/easemob/token.rb

@@ -0,0 +1,37 @@
+module Easemob
+  module Token
+    def self.refresh
+      res = Easemob.httprbs.with do |http|
+        http.post "#{Easemob.head_url}/token", json: { grant_type: 'client_credentials', client_id: Easemob.client_id, client_secret: Easemob.client_secret }
+      end
+      raise "Failed to refresh easemob token: #{res}" unless res.code == 200
+      write_to_store(JSON.parse(res.to_s))
+      read_from_store
+    end
+
+    def self.read_from_store
+      td = read_token
+      token_life_in_seconds = td.fetch('token_expires_in').to_i
+      got_token_at = td.fetch('got_token_at').to_i
+      access_token = td.fetch('access_token')
+      remain_life_seconds = token_life_in_seconds - (Time.now.to_i - got_token_at)
+      return [access_token, remain_life_seconds]
+    rescue JSON::ParserError, Errno::ENOENT, KeyError, TypeError
+      refresh
+    end
+
+    def self.write_to_store(token_hash)
+      token_hash['got_token_at'.freeze] = Time.now.to_i
+      token_hash['token_expires_in'.freeze] = token_hash.delete('expires_in')
+      write_token(token_hash)
+    end
+
+    def self.read_token
+      JSON.parse(File.read(Easemob.token_file_path))
+    end
+
+    def self.write_token(token_hash)
+      File.write(Easemob.token_file_path, token_hash.to_json)
+    end
+  end
+end

data/lib/easemob/users.rb

@@ -0,0 +1,7 @@
+module Easemob
+  module Users
+    def create_user(username, password, nickname = nil)
+      do_post('users', username: username, password: password, nickname: nickname)
+    end
+  end
+end

data/lib/easemob/version.rb

@@ -1,3 +1,3 @@
 module Easemob
-  VERSION = "0.0.0"
+  VERSION = '0.0.1'.freeze
 end

metadata

@@ -1,78 +1,115 @@
 --- !ruby/object:Gem::Specification
 name: easemob
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
-- Liu Lantao
+- Eric Guo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-18 00:00:00.000000000 Z
+date: 2016-10-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: 
+        version: '3.5'
+description: Helping rubyist integration with easemob IM service (环信 - 即时通讯云) easier.
 email:
-- liulantao@gmail.com
+- eric.guocz@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
-- CODE_OF_CONDUCT.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- easemob.gemspec
 - lib/easemob.rb
+- lib/easemob/token.rb
+- lib/easemob/users.rb
 - lib/easemob/version.rb
-homepage: https://github.com/easemob/ruby-client
+homepage: https://github.com/bayetech/easemob
 licenses:
 - MIT
 metadata: {}
@@ -82,9 +119,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -92,8 +129,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
-summary: easemob api client
+summary: An unofficial easemob IM instant message gem.
 test_files: []

data/CODE_OF_CONDUCT.md

@@ -1,13 +0,0 @@
-# Contributor Code of Conduct
-
-As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
-
-We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
-
-Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
-
-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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
-
-This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in easemob.gemspec
-gemspec

data/Rakefile

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

data/bin/console

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

data/bin/setup

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

data/easemob.gemspec

@@ -1,24 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'easemob/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "easemob"
-  spec.version       = Easemob::VERSION
-  spec.authors       = ["Liu Lantao"]
-  spec.email         = ["liulantao@gmail.com"]
-
-  spec.summary       = %q{easemob api client}
-  spec.homepage      = "https://github.com/easemob/ruby-client"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
-end