yol_qy_weixin 0.0.3 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 492bc402556844ff268a6cc561decc01273d6c625cfbe3d6fead5cd990a3c543
-  data.tar.gz: f245159f2eb8175688c586950c1ddc4e0ef20f2a1837f430ceab8898b6bf3581
+  metadata.gz: 8c3296070570a8d242429f4760872498d01b4155403847934e10e406bf91bf17
+  data.tar.gz: d251b119311c4561e461b64048d224be817a20a51c9539bca0653be959853d3d
 SHA512:
-  metadata.gz: '04889e7bf6966e97dd0b9bb3e5d68cd686216a8cd9878f616388f12915d3789ac1de792452b97fabd968a6673dd2364b1acb30fbd8dfe8893cbd28bbe2de80a0'
-  data.tar.gz: e8eb257736eff86043bfe00a2a5e98fd2135d106d825dbe472eec07b9e82d0da0a4ac0a8add84cc84a72fffebe68a4de3cb7f659bff6a03bb93817c06fcee519
+  metadata.gz: 4401f01855e21bb4663085604a075b80d5e38be6844c1d3fe0cfee8f190a00858ce1d07de239bfd32566178cd3bb8d68eb6c088eeab74247185b4a54fa44e4b0
+  data.tar.gz: 5d5e0e83e5ba92d7c0375dc7327c77b7b0f6aec0914e69955a4434efa2232df1ee05cb80d689e95a2ad31fd7da0b47fe7ffbc80cb631ad70d3ccbe994bb4aa20

data/.gitignore

@@ -54,3 +54,6 @@ build-iPhoneSimulator/
 
 # Used by RuboCop. Remote config files pulled in from inherit_from directive.
 # .rubocop-https?--*
+
+
+*.DS_Store

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    yol_qy_weixin (0.0.3)
+    yol_qy_weixin (0.0.8)
       multi_xml
       nokogiri
       roxml
@@ -16,11 +16,11 @@ GEM
       tzinfo (~> 1.1)
       zeitwerk (~> 2.2, >= 2.2.2)
     concurrent-ruby (1.1.8)
-    i18n (1.8.9)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     minitest (5.14.4)
     multi_xml (0.6.0)
-    nokogiri (1.11.1-x86_64-darwin)
+    nokogiri (1.11.3-x86_64-darwin)
       racc (~> 1.4)
     racc (1.5.2)
     rake (13.0.1)

data/README.md

@@ -6,120 +6,121 @@ https://rubygems.org/gems/yol_qy_weixin
 
 [![Gem Version](https://badge.fury.io/rb/yol_qy_weixin.svg)](http://badge.fury.io/rb/yol_qy_weixin)
 
-**企业号对应多个管理组，请前往 `设置` => `权限管理` 任意创建一个管理组，在管理组最下角即可获取 CorpID Secret**
-
 **有问题请及时提issue**
 
 ```ruby
-gem "qy_wechat_api", git: "https://github.com/lanrion/qy_wechat_api.git"
+gem "yol_qy_weixin", git: "https://github.com/luojie2019/yol_qy_weixin.git"
 ```
 
 # 配置
 
-## jsticket、suite_token存储方案
-如果你是在Rails框架下，默认情况下直接使用Rails.cache，如果你想独立cache，请配置如下：
+## 安装依赖Installation
+
+Add this line to your application's Gemfile:
+
 ```ruby
-QyWechatApi.configure do |config|
-  config.cache_store = YourCustomCacheStore
-end
+gem 'yol_qy_weixin'
 ```
-cache_store按照Rails.cache的接口实现，强烈建议使用ActiveSupport::Cache
+## 配置 corpid secret
 
-## 日志配置
-如果你是在Rails框架下，默认情况下直接使用Rails.logger，如果你想独立cache，请配置如下：
 ```ruby
-QyWechatApi.configure do |config|
-  config.logger = YourCustomLogger
-end
-```
-logger按照Rails.logger的接口实现，强烈建议使用ActiveSupport::Logger
+# 目录
 
-## Token 存储方案（TODO: 待重构直接使用cache_store）
+file: your_project/config/qy_weixin.yml
 
-### 对象存储
-如果你是单个企业号，建议使用这个方案，无需任何配置即可使用。
+.your_project/
+├── app
+├── bin
+├── config
+│   ├── redis.yml
+│   ├── database.yml
+│   ├── qy_weixin.yml
+```
 
-### Redis 存储
-```ruby
-redis = Redis.new(host: "127.0.0.1", port: "6379")
+```yml
+defaults: &defaults
+  corpid: '1**'
+  secret: '2**'
+
+development: &development
+  <<: *defaults
 
-namespace = "qy_wechat_api:redis_storage"
+test:
+  <<: *defaults
 
-# cleanup keys in the current namespace when restart server everytime.
-exist_keys = redis.keys("#{namespace}:*")
-exist_keys.each{|key|redis.del(key)}
+production:
+  corpid: <%= ENV.fetch('QY_WEIXIN_CORPID') { '1**'' } %>
+  secret: <%= ENV.fetch('QY_WEIXIN_SECRET') { '2**'' } %>
+```
 
-redis_with_ns = Redis::Namespace.new("#{namespace}", redis: redis)
+**说明：考虑access_token需要缓存，redis配置请参考官方文档 https://github.com/redis/redis-rb/blob/master/README.md**
 
-QyWechatApi.configure do |config|
-  config.redis = redis_with_ns
-end
+## 读取配置
+```ruby
+# 读取qy_weixin.yml配置
+qy_weixin_config = YAML::load(ERB.new(File.read("#{Rails.root}/config/qy_weixin.yml")).result)[Rails.env]
 ```
+如果你是在Rails框架下，也可以使用Settingslogic读取yml配置：
+```ruby
+# 引用gem
+gem 'settingslogic', '2.0.9'
 
-# API基本用法
+# your_project/app/settings/weixin_setting.rb
+class WeixinSetting < Settingslogic
+  source "#{Rails.root}/config/weixin.yml"
+  namespace Rails.env
+end
 
-请务必结合：http://qydev.weixin.qq.com/wiki/index.php 理解以下API参数使用。
+corpid = WeixinSetting.corpid
+corp_secret = WeixinSetting.secret
+```
 
-## 初始化
+## 实例对象
 
 ```ruby
-group_client = QyWechatApi::Client.new(corpid, corpsecret)
+# 目录 file: your_project/config/initializers/qy_weixin.rb
 
-# 为了确保用户输入的corpid, corpsecret是准确的，请务必执行：
-group_client.is_valid?
+QyWexinClient = YolQyWeixin::Client.new(
+  corpid: qy_weixin_config["corpid"],
+  secret: qy_weixin_config["secret"],
+  redis: RedisClient
+)
 ```
 
-如果需要使用通过第三方应用 **获取企业号access_token** API 获取的 access_token
-做如下处理：
+**说明：RedisClient为redis实例，如果没有配置可传nil，建议使用redis，考虑到access_token获取次数限制；**
+
+# 基本用法
+
+如果需要获取的 access_token
 
 ```ruby
-options = {access_token: "access_token"}
-# redis_key 也可定制
-group_client = QyWechatApi::Client.new(corpid, corpsecret, options)
+access_token = QyWexinClient.get_access_token
+# 返回参考企业微信官方文档：https://work.weixin.qq.com/api/doc/90000/90135/91039
 ```
 
 ## 部门
 
 ```ruby
-group_client.department.create(name, parent_id, order=nil, id=nil)
-group_client.department.update(id, name, parent_id, order=nil)
-group_client.department.delete(id)
-group_client.department.list
+待补充，有需要可提issue到git：https://github.com/luojie2019/yol_qy_weixin.git
 ```
 
 ## 成员
 
 ```ruby
-# 创建成员
-group_client.user.create(user_id, name, options={})
-
-# 更新成员
-group_client.user.update(user_id, options={})
+# 获取成员信息
+access_token = QyWexinClient.get_user_info(open_id)
+# 返回参考企业微信官方文档：https://open.work.weixin.qq.com/api/doc/90000/90135/90196
 
-# 删除成员
-group_client.user.delete(user_id)
-
-# 批量删除成员
-group_client.user.batch_delete(user_ids)
-
-# 获取成员
-group_client.user.get(user_id)
-
-# 获取部门成员
-group_client.user.simple_list(department_id, fetch_child=nil, status=nil)
+# 获取反问用户信息
+access_token = QyWexinClient.get_user_id(code)
+# 返回参考企业微信官方文档：https://open.work.weixin.qq.com/api/doc/90000/90135/91707
+```
 
-# 获取部门成员(详情)
-group_client.user.full_list(department_id, fetch_child=nil, status=nil)
 
-# 邀请成员关注
-group_client.user.send_invitation(user_id, tips=nil)
+---
 
-# userid转换成openid接口(企业支付需要使用到)
-group_client.covert_to_open_id(user_id, agent_id="")
 
-# openid转换成userid接口
-group_client.covert_to_user_id(open_id)
-```
+后续功能实现还待优化，有需要可提issue到git：https://github.com/luojie2019/yol_qy_weixin.git
 
 ## 标签
 

data/lib/yol_qy_weixin/client.rb

@@ -8,7 +8,9 @@ module YolQyWeixin
     include Connection::Qrcode
     include Connection::Template
     include Connection::User
-
+    include Connection::Department
+    include Connection::Message
+    
     attr_accessor :corpid, :secret, :redis
 
     def initialize(options = {})
@@ -17,4 +19,4 @@ module YolQyWeixin
       @redis  = options[:redis]  || YolQyWeixin.configuration.redis
     end
   end
-end
+end

data/lib/yol_qy_weixin/connections/base.rb

@@ -18,26 +18,22 @@ module YolQyWeixin
       end
 
       def get_access_token
-        # access_token = redis.find("access_token_#{appid}")
-
-        # if access_token.nil?
-        #   access_token_res = get_token(corpid, secret)
-
-        #   # TODO:
-        #   access_token     = JSON.parse(access_token_res)["access_token"] rescue nil
-
-        #   if access_token.nil?
-        #     raise Exception.new("Weixin access token authorize false, appid: #{appid},
-        #                          appsecret: #{appsecret}, access_token_res: #{access_token_res.to_s}")
-        #   else
-        #     redis.save("access_token_#{appid}", access_token)
-        #     redis.expire("access_token_#{appid}", 7200)
-        #   end
-        # end
-
-        # access_token
-        access_token_res = get_token(corpid, secret)
-        access_token     = access_token_res["access_token"] rescue nil
+        if redis.nil?
+          access_token_res = get_token(corpid, secret)
+          access_token = access_token_res["access_token"] rescue nil
+        else
+          access_token = redis.get("qywx_access_token")
+          if access_token.nil?
+            access_token_res = get_token(corpid, secret)
+            access_token = access_token_res["access_token"] rescue nil
+            if access_token.nil?
+              raise Exception.new("QyWeixin access token authorize false, corpid: #{corpid}")
+            else
+              redis.set("qywx_access_token", access_token)
+              redis.expire("qywx_access_token", 7200)
+            end
+          end
+        end
         access_token
       end
 

data/lib/yol_qy_weixin/connections/department.rb

@@ -0,0 +1,17 @@
+module YolQyWeixin
+  module Connection
+    module Department
+      def department_list(department_id=0)
+        http_get(department_list_url(department_id))
+      end
+
+
+      
+      private
+
+      def department_list_url(department_id)
+        "https://qyapi.weixin.qq.com/cgi-bin/department/list?access_token=#{get_access_token}&id=#{department_id}"
+      end
+    end
+  end
+end

data/lib/yol_qy_weixin/connections/message.rb

@@ -0,0 +1,15 @@
+module YolQyWeixin
+  module Connection
+    module Message
+      def send_message(body)
+        http_post(send_url, body)
+      end
+
+      private
+
+      def send_url
+        "https://qyapi.weixin.qq.com/cgi-bin/message/send?access_token=#{get_access_token}&debug=1"
+      end
+    end
+  end
+end

data/lib/yol_qy_weixin/connections/user.rb

@@ -1,12 +1,28 @@
 module YolQyWeixin
   module Connection
     module User
+      def get_users_by_department(department_id, fetch_child=0)
+        http_get(get_users_by_department_url(department_id, fetch_child))
+      end
+
+      def get_user_id(code)
+        http_get(user_info_url(open_id))
+      end
+
       def get_user_info(open_id)
         http_get(user_info_url(open_id))
       end
 
       private
 
+      def get_users_by_department_url(department_id, fetch_child)
+        "https://qyapi.weixin.qq.com/cgi-bin/user/simplelist?access_token=#{get_access_token}&department_id=#{department_id}&fetch_child=#{fetch_child}"
+      end
+
+      def user_id_url(code)
+        "https://qyapi.weixin.qq.com/cgi-bin/user/getuserinfo?access_token=#{get_access_token}&code=#{code}"
+      end
+
       def user_info_url(open_id)
         "https://qyapi.weixin.qq.com/cgi-bin/user/get?access_token=#{get_access_token}&userid=#{open_id}"
       end

data/lib/yol_qy_weixin/version.rb

@@ -1,3 +1,3 @@
 module YolQyWeixin
-  VERSION = "0.0.3"
+  VERSION = "0.0.8"
 end

data/yol_qy_weixin.gemspec

@@ -6,11 +6,11 @@ require 'yol_qy_weixin/version'
 Gem::Specification.new do |spec|
   spec.name          = "yol_qy_weixin"
   spec.version       = YolQyWeixin::VERSION
-  spec.authors       = ["cjl"]
-  spec.email         = ["chenjialiang@yeezon.com"]
+  spec.authors       = ["luojie2019"]
+  spec.email         = ["luojie@yolanda.hk"]
   spec.summary       = %q{Shop middleware for Weixin.}
   spec.description   = ""
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/luojie2019/yol_qy_weixin"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yol_qy_weixin
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.8
 platform: ruby
 authors:
-- cjl
+- luojie2019
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-10 00:00:00.000000000 Z
+date: 2021-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -82,23 +82,23 @@ dependencies:
         version: '0'
 description: ''
 email:
-- chenjialiang@yeezon.com
+- luojie@yolanda.hk
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".DS_Store"
 - ".gitignore"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/.DS_Store
 - lib/yol_qy_weixin.rb
 - lib/yol_qy_weixin/client.rb
 - lib/yol_qy_weixin/connection.rb
 - lib/yol_qy_weixin/connections/base.rb
+- lib/yol_qy_weixin/connections/department.rb
+- lib/yol_qy_weixin/connections/message.rb
 - lib/yol_qy_weixin/connections/qrcode.rb
 - lib/yol_qy_weixin/connections/template.rb
 - lib/yol_qy_weixin/connections/user.rb
@@ -109,7 +109,7 @@ files:
 - lib/yol_qy_weixin/models/message.rb
 - lib/yol_qy_weixin/version.rb
 - yol_qy_weixin.gemspec
-homepage: ''
+homepage: https://github.com/luojie2019/yol_qy_weixin
 licenses:
 - MIT
 metadata: {}