wework-next 1.2.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8c4fdc61a04f5bae81bd178df0e255d8f3f176435d285b1e5c976f7a99750f2f
+  data.tar.gz: da7f4e91b91eb3c556dcf95f04c18f978bf14d9c9dd7680053f54088643523d8
+SHA512:
+  metadata.gz: 6509f750bdf7a79ac1acb10a152c2e865587b4130a2d52e350c71de37b3370759919ae39c4c9a2a4e1482e99182d700d270327245cb29096bb5113abfd13a875
+  data.tar.gz: 6ad27f6ed7bf09e6f9f24985809113e0259993c7b54ea6d2e56cafdb9a1aa7d236ccd14007a70000395d5ef56db53525b90d5f2f806bd6b6d71ff5368ce4867e

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+.DS_Store

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.13.6

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 sindon@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://rubygems.org'
+
+# Specify your gem's dependencies in wework.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 seandong
+
+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,184 @@
+# Wechat Work 「企业微信」
+
+Wework is a ruby API wrapper for wechat work「企业微信」.
+
+[企业微信 API 文档](https://work.weixin.qq.com/api/doc)
+
+[![CircleCI](https://circleci.com/gh/mycolorway/wework/tree/suite.svg?style=svg)](https://circleci.com/gh/mycolorway/wework/tree/suite)   [![Gem Version](https://badge.fury.io/rb/wework.svg)](https://badge.fury.io/rb/wework)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wework'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wework
+
+## Usage
+
+### 初始化
+
+```
+Wework.configure do |config|
+  config.redis = Redis.new(host: ENV['REDIS_HOST'], port: ENV['REDIS_PORT'], db: ENV['REDIS_CACHE_DB'])   # redis
+  config.http_timeout_options = {write: 15, read: 15, connect: 10}                                        # 请求超时
+  config.expired_shift_seconds = 180                                                                      # access token 有效期偏移量 (时间有效期 - 偏移量)
+end
+```
+
+### 第三方应用
+
+1). 初始化套件接口 [Wework::Api::Suite](https://github.com/mycolorway/wework/blob/master/lib/wework/api/suite.rb)
+
+```ruby
+$wework_suite = Wework::Api::Suite.new(
+  corp_id: ENV['WEWORK_CORPID'],                            # 应用服务商 CorpID
+  suite_id: ENV['WEWORK_SUITE_ID'],                         # SuiteID
+  encoding_aes_key: ENV['WEWORK_SUITE_ENCODING_AES_KEY'],   # EncodingAESKey
+  suite_token: ENV['WEWORK_SUITE_TOKEN'],                   # Token
+  suite_secret: ENV['WEWORK_SUITE_SECRET']                  # Secret
+)
+```
+
+
+2). 获取第三方应用接口 [Wework::Api::Agent](https://github.com/mycolorway/wework/blob/master/lib/wework/api/agent.rb)
+
+```ruby
+agent_api = $wework_suite.corp(
+              corp_id,                                      # 授权企业 CorpID
+              permanent_code                                # 永久授权码
+            ).agent(agent_id)
+```
+
+3). 第三方应用回调协议
+
+获取加密数据
+
+```ruby
+encrypt_str = if params[:xml].present?
+                params[:xml]['Encrypt']
+              else
+                Hash.from_xml(request.raw_post)['xml']['Encrypt']
+              end
+
+#首次校验接口 encrpt_str = params[:echostr]
+```
+
+消息签名
+
+```ruby
+$wework_suite.signature(timestamp, nonce, encrypt_str)
+```
+
+ 消息解密
+
+ ```ruby
+ $wework_suite.msg_decrypt(encrypt_data)
+ ```
+
+
+### 自建应用
+
+初始化接口 [Wework::Api::Agent](https://github.com/mycolorway/wework/blob/master/lib/wework/api/agent.rb)
+
+``` ruby
+$agent_api = Wework::Api::Agent.new(
+  corp_id: ENV['WEWORK_CORPID'],                            # 企业 CorpID
+  agent_id: ENV['WEWORK_APPID'],                            # AgentId
+  secret: ENV['DEMO_APP_SECRET']                            # Secret
+)
+```
+
+### 通讯录同步
+
+初始化接口 [Wework::Api::Contact](https://github.com/mycolorway/wework/blob/master/lib/wework/api/contact.rb)
+
+``` ruby
+$contact_api = Wework::Api::Contact.new(
+  corp_id: ENV['WEWORK_CORPID'],                            # 企业 CorpID
+  secret: ENV['DEMO_APP_SECRET']                            # 通讯录同步 Secret
+)
+```
+
+### 应用服务商接口
+
+初始化
+
+``` ruby
+$provider_api = Wework::Api::Provider.new(
+  corp_id: ENV['WEWORK_PROVIDER_CORPID'],                     # 应用服务商 CorpID
+  secret: ENV['WEWORK_PROVIDER_SECRET'],                      # Secret
+  token: ENV['WEWORK_PROVIDER_TOKEN'],
+  encoding_aes_key: ENV['WEWORK_PROVIDER_ENCODING_AES_KEY']
+)
+```
+
+回调接口消息加解密参考「第三方应用回调协议」
+
+
+### 小程序 encryptedData 解密
+
+```ruby
+require "openssl"
+CIPHER = 'AES-128-CBC'.freeze
+
+cipher = OpenSSL::Cipher.new(CIPHER)
+cipher.decrypt
+cipher.key = Base64.decode64(session_key)
+cipher.iv = Base64.decode64(iv)
+encrypted = Base64.decode64(encryptedData)
+data = cipher.update(encrypted) + cipher.final
+values = JSON.parse data
+```
+
+
+## 已实现接口列表
+
+[Wework::Api::Methods::Agent](https://github.com/mycolorway/wework/blob/master/lib/wework/api/methods/agent.rb)
+
+[Wework::Api::Methods::User](https://github.com/mycolorway/wework/blob/master/lib/wework/api/methods/user.rb)
+
+[Wework::Api::Methods::Tag](https://github.com/mycolorway/wework/blob/master/lib/wework/api/methods/tag.rb)
+
+[Wework::Api::Methods::Department](https://github.com/mycolorway/wework/blob/master/lib/wework/api/methods/department.rb)
+
+[Wework::Api::Methods::Message](https://github.com/mycolorway/wework/blob/master/lib/wework/api/methods/message.rb)
+
+[Wework::Api::Methods::Appchat](https://github.com/mycolorway/wework/blob/master/lib/wework/api/methods/appchat.rb)
+
+[Wework::Api::Methods::Media](https://github.com/mycolorway/wework/blob/master/lib/wework/api/methods/media.rb)
+
+[Wework::Api::Methods::Menu](https://github.com/mycolorway/wework/blob/master/lib/wework/api/methods/menu.rb)
+
+[Wework::Api::Methods::Approval](https://github.com/mycolorway/wework/blob/master/lib/wework/api/methods/approval.rb)
+
+[Wework::Api::Methods::Checkin](https://github.com/mycolorway/wework/blob/master/lib/wework/api/methods/checkin.rb)
+
+[Wework::Api::Methods::Batch](https://github.com/mycolorway/wework/blob/master/lib/wework/api/methods/batch.rb)
+
+[Wework::Api::Methods::Provider](https://github.com/mycolorway/wework/blob/master/lib/wework/api/methods/provider.rb)
+
+[Wework::Api::Methods::Service](https://github.com/mycolorway/wework/blob/master/lib/wework/api/methods/service.rb)
+
+
+## Contributing
+
+* Fork `Wework` on GitHub
+* Make your changes
+* Ensure all tests pass (`bundle exec rake`)
+* Send a pull request
+* If we like them we'll merge them
+* If we've accepted a patch, feel free to ask for commit access!
+
+## License
+
+Copyright (c) 2018 MyColorway. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

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

@@ -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/wework/api/agent.rb

@@ -0,0 +1,39 @@
+module Wework
+  module Api
+    class Agent < Base
+
+      include Methods::Agent
+      include Methods::Message
+      include Methods::Appchat
+      include Methods::Menu
+      include Methods::Checkin
+      include Methods::Approval
+
+      attr_reader :agent_id
+
+      def initialize(options={})
+        @agent_id = options.delete(:agent_id)
+        @agent_id = @agent_id.to_i if @agent_id.to_s =~ /\A\d+\Z/
+        super(options)
+      end
+
+      def jsapi_ticket
+        jsticket_store.ticket
+      end
+
+      def jsapi_agent_ticket
+        jsticket_agent_store.ticket
+      end
+
+      private
+
+      def jsticket_store
+        @jsticket_store ||= Token::JsTicket.new self
+      end
+
+      def jsticket_agent_store
+        @jsticket_agent_store ||= Token::JsAgentTicket.new self
+      end
+    end
+  end
+end

data/lib/wework/api/base.rb

@@ -0,0 +1,94 @@
+require 'wework/request'
+require 'wework/api/methods/media'
+require 'wework/api/methods/user'
+require 'wework/api/methods/agent'
+require 'wework/api/methods/department'
+require 'wework/api/methods/tag'
+require 'wework/api/methods/crm'
+require 'wework/api/methods/menu'
+require 'wework/api/methods/checkin'
+require 'wework/api/methods/message'
+require 'wework/api/methods/service'
+require 'wework/api/methods/provider'
+require 'wework/api/methods/batch'
+require 'wework/api/methods/approval'
+require 'wework/api/methods/appchat'
+require 'wework/token/base'
+require 'wework/token/app_token'
+module Wework
+  module Api
+    class Base
+
+      include Methods::Media
+      include Methods::User
+      include Methods::Department
+      include Methods::Tag
+      include Methods::Crm
+      include Methods::Batch
+
+      attr_accessor :corp_id, :secret, :options
+
+      def initialize options={}
+        @corp_id      = options.delete(:corp_id)
+        @secret       = options.delete(:secret)
+        @token_store  = options.delete(:token_store)
+        @options      = options
+      end
+
+      def request
+        @request ||= Wework::Request.new(API_ENDPOINT, true)
+      end
+
+      def valid?
+        return false if corp_id.nil?
+        token_store.token.present?
+      rescue AccessTokenExpiredError
+        false
+      rescue => e
+        Rails.logger.error "[WEWORK] (valid?) fetch access token error(#{corp_id}): #{e.inspect}" if defined?(Rails)
+        false
+      end
+
+      def get(path, headers = {})
+        with_token(headers[:params]) do |params|
+          request.get path, headers.merge(params: params)
+        end
+      end
+
+      def post(path, payload, headers = {})
+        with_token(headers[:params]) do |params|
+          request.post path, payload, headers.merge(params: params)
+        end
+      end
+
+      def post_file(path, file, headers = {})
+        with_token(headers[:params]) do |params|
+          request.post_file path, file, headers.merge(params: params)
+        end
+      end
+
+      def access_token
+        token_store.token
+      end
+
+      private
+
+      def with_token(params = {}, tries = 2)
+        params ||= {}
+        yield(params.merge(token_params))
+      rescue AccessTokenExpiredError
+        token_store.update_token
+        retry unless (tries -= 1).zero?
+      end
+
+      def token_store
+        @token_store ||= Token::AppToken.new self
+      end
+
+      def token_params
+        {access_token: access_token}
+      end
+
+    end
+  end
+end

data/lib/wework/api/contact.rb

@@ -0,0 +1,7 @@
+require 'wework/api/base'
+module Wework
+  module Api
+    class Contact < Base
+    end
+  end
+end

data/lib/wework/api/corp.rb

@@ -0,0 +1,27 @@
+module Wework
+  module Api
+    class Corp < Base
+
+      include Wework::Cipher
+
+      attr_reader :suite, :permanent_code
+
+      def initialize(options={})
+        @suite = options.delete(:suite)
+        @permanent_code = options.delete(:permanent_code)
+        super(options)
+      end
+
+      def agent(agent_id)
+        Wework::Api::Agent.new(corp_id: corp_id, agent_id: agent_id, token_store: token_store)
+      end
+
+      private
+
+      def token_store
+        @token_store ||= Token::CorpToken.new self
+      end
+
+    end
+  end
+end

data/lib/wework/api/methods/agent.rb

@@ -0,0 +1,63 @@
+require "erb"
+
+module Wework
+  module Api
+    module Methods
+      module Agent
+        def authorize_url(redirect_uri, scope="snsapi_base", state="wxwork")
+          # user agent: UA is mozilla/5.0 (iphone; cpu iphone os 10_2 like mac os x) applewebkit/602.3.12 (khtml, like gecko) mobile/14c92 wxwork/1.3.2 micromessenger/6.2
+          uri = ERB::Util.url_encode(redirect_uri)
+          "#{AUTHORIZE_ENDPOINT}?appid=#{corp_id}&redirect_uri=#{uri}&response_type=code&scope=#{scope}&agentid=#{agent_id}&state=#{state}#wechat_redirect"
+        end
+
+        def get_oauth_userinfo code
+          get 'user/getuserinfo', params: {code: code}
+        end
+
+        def get_user_detail user_ticket
+          post 'user/getuserdetail', {user_ticket: user_ticket}
+        end
+
+        def get_jssign_package url
+          timestamp = Time.now.to_i
+          noncestr = SecureRandom.hex(8)
+          str = "jsapi_ticket=#{jsapi_ticket}&noncestr=#{noncestr}&timestamp=#{timestamp}&url=#{url}"
+          {
+            "appId"     => corp_id,
+            "nonceStr"  => noncestr,
+            "timestamp" => timestamp,
+            "url"       => url,
+            "signature" => Digest::SHA1.hexdigest(str),
+            "rawString" => str
+          }
+        end
+
+        def get_agent_jssign_package url
+          timestamp = Time.now.to_i
+          noncestr = SecureRandom.hex(8)
+          str = "jsapi_ticket=#{jsapi_agent_ticket}&noncestr=#{noncestr}&timestamp=#{timestamp}&url=#{url}"
+          {
+            "appId"     => corp_id,
+            "nonceStr"  => noncestr,
+            "timestamp" => timestamp,
+            "url"       => url,
+            "signature" => Digest::SHA1.hexdigest(str),
+            "rawString" => str
+          }
+        end
+
+        def get_session_with_jscode(js_code, grant_type='authorization_code')
+          post 'miniprogram/jscode2session', {}, params: {js_code: js_code, grant_type: grant_type}
+        end
+
+        def get_agent
+          get 'agent/get', params: {agentid: agent_id}
+        end
+
+        def set_agent data={}
+          post 'agent/set', data.merge(agentid: agent_id)
+        end
+      end
+    end
+  end
+end

data/lib/wework/api/methods/appchat.rb

@@ -0,0 +1,62 @@
+require "erb"
+
+module Wework
+  module Api
+    module Methods
+      module Appchat
+
+        def appchat_create group_name, owner_id, group_user_ids, chat_id
+          post 'appchat/create',
+            name: group_name,
+            owner: owner_id,
+            userlist: group_user_ids,
+            chatid: chat_id
+        end
+
+        def appchat_update chat_id, payload={}
+          payload.merge! chatid: chat_id
+          post 'appchat/update', payload
+        end
+
+        def appchat_get chat_id
+          get 'appchat/get', { params: { chatid: chat_id } }
+        end
+
+        def text_appchat_send chat_id, content
+          appchat_send chat_id, {text: {content: content}, msgtype: 'text'}
+        end
+
+        def image_appchat_send chat_id, media_id
+          appchat_send chat_id, {image: {media_id: media_id}, msgtype: 'image'}
+        end
+
+        def voice_appchat_send chat_id, media_id
+          appchat_send chat_id, {voice: {media_id: media_id}, msgtype: 'voice'}
+        end
+
+        def file_appchat_send chat_id, media_id
+          appchat_send chat_id, {file: {media_id: media_id}, msgtype: 'file'}
+        end
+
+        def video_appchat_send chat_id, video={}
+          appchat_send chat_id, {video: video, msgtype: 'video'}
+        end
+
+        def textcard_appchat_send chat_id, textcard={}
+          appchat_send chat_id, {textcard: textcard, msgtype: 'textcard'}
+        end
+
+        def news_appchat_send chat_id, news=[]
+          appchat_send chat_id, {news: {articles: news}, msgtype: 'news'}
+        end
+
+        private
+
+        def appchat_send chat_id, payload={}
+          payload.merge!(chatid: chat_id)
+          post 'appchat/send', payload
+        end
+      end
+    end
+  end
+end

data/lib/wework/api/methods/approval.rb

@@ -0,0 +1,16 @@
+require "erb"
+
+module Wework
+  module Api
+    module Methods
+      module Approval
+        def get_approval_data start_time, end_time, next_spnum=nil
+          # https://work.weixin.qq.com/api/doc#11228
+          payload = {starttime: start_time, endtime: end_time}
+          payload[:next_spnum] = next_spnum unless next_spnum.nil?
+          post 'corp/getapprovaldata', payload
+        end
+      end
+    end
+  end
+end