qy_wechat_api 1.0.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 14663e1a3e66b15083a41484dab4a2cef0282d05
+  data.tar.gz: 6906d10cfc13429cc508e496022d622524b51c17
+SHA512:
+  metadata.gz: de9fe4bdcd7f1ad3c514876da2b746adcf0489f1de3c3ab7ffd3719dc66e7133617f0796cc8210560a8a70a9795be1db2402b269db7a92c2de2a73155d719b27
+  data.tar.gz: 99a2f042b72834f8dd5251d97e8f0f27f0d6bafbf8364e7cf63a378b0071f91f15b6b4f0f65e9eff176d0cd6ee0d970a59317c694a53c26365c9fe8bd37b9e4d

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.DS_Store

data/.rspec

@@ -0,0 +1 @@
+--format documentation --color spec --drb

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+group :test, :development do
+  gem 'rspec', '~> 3.1.0'
+  gem "redis-namespace", "~> 1.4.1"
+  gem "rake", "~> 0.9.6"
+  gem 'simplecov', '~> 0.7.1', :require => false
+  gem "codeclimate-test-reporter", require: nil
+  gem 'coveralls', require: false
+  # For debugger
+  gem "pry-rails", "~> 0.3.2"
+
+  gem "pry-debugger", "~> 0.2.2"
+end
+
+# Specify your gem's dependencies in qy_wechat_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 lanrion
+
+MIT License
+
+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,120 @@
+**企业号对应多个管理组，请前往 `设置` => `权限管理` 任意创建一个管理组，在管理组最下角即可获取 CorpID Secret**
+
+**有问题请及时提issue**
+
+```ruby
+gem "qy_wechat_api", git: "https://github.com/lanrion/qy_wechat_api.git"
+```
+
+# token 存储方案
+
+## 对象存储
+如果你是单个企业号，建议使用这个方案，无需任何配置即可使用。
+
+## Redis 存储
+```ruby
+redis = Redis.new(host: "127.0.0.1", port: "6379")
+
+namespace = "qy_wechat_api:redis_storage"
+
+# cleanup keys in the current namespace when restart server everytime.
+exist_keys = redis.keys("#{namespace}:*")
+exist_keys.each{|key|redis.del(key)}
+
+redis_with_ns = Redis::Namespace.new("#{namespace}", redis: redis)
+
+QyWechatApi.configure do |config|
+  config.redis = redis_with_ns
+end
+```
+
+## 自定义存储方案
+TODO...
+
+# API基本用法
+
+请务必结合：http://qydev.weixin.qq.com/wiki/index.php 理解以下API参数使用。
+
+## 初始化
+
+```ruby
+group_client = QyWechatApi::Client.new(corpid, corpsecret)
+# 为了确保用户输入的corpid, corpsecret是准确的，请务必执行：
+group_client.is_valid?
+```
+
+## 部门
+
+```ruby
+group_client.department.create(name, parent_id, order=nil)
+group_client.department.update(id, name, parent_id, order=nil)
+group_client.department.delete(id)
+group_client.department.list
+```
+
+## 成员
+
+```ruby
+group_client.user.create(user_id, name, options={})
+group_client.user.update(user_id, options={})
+group_client.user.delete(user_id)
+group_client.user.get(user_id)
+group_client.user.simple_list(department_id, fetch_child=nil, status=nil)
+```
+
+## 标签
+
+```ruby
+group_client.tag.create(name)
+group_client.tag.update(id, name)
+group_client.tag.delete(id)
+group_client.tag.get(id)
+group_client.tag.add_tag_users(id, user_ids)
+group_client.tag.delete_tag_users(id, user_ids)
+group_client.tag.list
+```
+
+## 自定义菜单
+
+menu_json的生成方法请参考:
+https://github.com/lanrion/weixin_rails_middleware/wiki/DIY-menu
+
+```ruby
+group_client.menu.create(menu_json, app_id)
+group_client.menu.delete(app_id)
+group_client.menu.get(app_id)
+```
+
+## Oauth2用法
+
+先要配置你应用的 可信域名 `2458023e.ngrok.com`
+state 为开发者自定义参数，可选
+
+```ruby
+# 生成授权url
+group_client.oauth.authorize_url("http://2458023e.ngrok.com", "state")
+
+# 获取code后，获取用户信息
+# app_id: 跳转链接时所在的企业应用ID
+group_client.oauth.get_user_info("code", "app_id")
+```
+
+## 发送消息
+
+```ruby
+  # params: (users, parties, tags, agent_id, content, safe=0)
+  # users, parties, tags 如果是多个用户，传数组，如果是全部，则直接传 "@all"
+  group_client.message.send_text("@all", "@all", "@all", app_id, text_message)
+```
+**其他发送消息方法请查看 api/message.rb**
+
+## 上传多媒体文件
+```ruby
+# params: media, media_type
+group_client.media.upload(image_jpg_file, "image")
+
+# 获取下载链接
+# 返回一个URL，请开发者自行使用此url下载
+group_client.media.get_media_by_id(media_id)
+```
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/qy_wechat_api.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require "rest-client"
+require "carrierwave"
+require 'yajl/json_gem'
+
+require "qy_wechat_api/carrierwave/qy_wechat_api_uploader"
+require "qy_wechat_api/config"
+require "qy_wechat_api/client"
+require "qy_wechat_api/handler"
+require "qy_wechat_api/api"
+
+module QyWechatApi
+
+  # Storage
+  autoload(:Storage,       "qy_wechat_api/storage/storage")
+  autoload(:ObjectStorage, "qy_wechat_api/storage/object_storage")
+  autoload(:RedisStorage,  "qy_wechat_api/storage/redis_storage")
+
+  ENDPOINT_URL = "https://qyapi.weixin.qq.com/cgi-bin"
+  OK_MSG     = "ok".freeze
+  OK_CODE    = 0.freeze
+
+  class << self
+
+    def http_get_without_token(url, params={})
+      get_api_url = ENDPOINT_URL + url
+      load_json(RestClient.get(get_api_url, params: params))
+    end
+
+    def http_post_without_token(url, payload={}, params={})
+      post_api_url = ENDPOINT_URL + url
+      payload = JSON.dump(payload) if !payload[:media].is_a?(File)
+      load_json(RestClient.post(post_api_url, payload, params: params))
+    end
+
+    # return hash
+    def load_json(string)
+      result_hash = JSON.parse(string)
+      code   = result_hash.delete("errcode")
+      en_msg = result_hash.delete("errmsg")
+      ResultHandler.new(code, en_msg, result_hash)
+    end
+
+    def open_endpoint(url)
+      "https://open.weixin.qq.com#{url}"
+    end
+
+  end
+end

data/lib/qy_wechat_api/api.rb

@@ -0,0 +1,8 @@
+require "qy_wechat_api/api/base"
+require "qy_wechat_api/api/department"
+require "qy_wechat_api/api/media"
+require "qy_wechat_api/api/message"
+require "qy_wechat_api/api/tag"
+require "qy_wechat_api/api/user"
+require "qy_wechat_api/api/menu"
+require "qy_wechat_api/api/oauth"

data/lib/qy_wechat_api/api/base.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+module QyWechatApi
+  module Api
+    class Base
+      attr_accessor :access_token, :corp_id
+
+      def initialize(access_token, corp_id=nil)
+        @access_token = access_token
+        @corp_id = corp_id
+      end
+
+      private
+        def http_get(url, params={})
+          request_url = "#{base_url}/#{url}"
+          params = params.merge({access_token: access_token})
+          QyWechatApi.http_get_without_token(request_url, params )
+        end
+
+        def http_post(url, payload={}, params={})
+          request_url = "#{base_url}/#{url}"
+          params = params.merge({access_token: access_token})
+          QyWechatApi.http_post_without_token(request_url, payload, params)
+        end
+
+        def base_url
+          ""
+        end
+
+    end
+  end
+end

data/lib/qy_wechat_api/api/department.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+module QyWechatApi
+  module Api
+    class Department < Base
+
+      # name  是 部门名称。长度限制为1~64个字符
+      # parentid  是 父亲部门id。根部门id为1
+      # order 否 在父部门中的次序。从1开始，数字越大排序越靠后
+      def create(name, parent_id, order=nil)
+        payload = {name: name}
+        payload[:parentid] = parent_id
+        payload[:order] = order if not order.nil?
+        http_post("create", payload)
+      end
+
+      # id 是 部门id
+      # name  否 更新的部门名称。长度限制为0~64个字符。修改部门名称时指定该参数
+      # parentid  否 父亲部门id。根部门id为1
+      # order 否 在父部门中的次序。从1开始，数字越大排序越靠后
+      def update(id, name=nil, parent_id=nil, order=nil)
+        payload = {id: id}
+        payload[:name] = name if not name.nil?
+        payload[:parentid] = parent_id if not parent_id.nil?
+        payload[:order] = order if not order.nil?
+        http_post("update", payload)
+      end
+
+      def delete(id)
+        http_get("delete", id: id)
+      end
+
+      def list
+        http_get("list")
+      end
+
+      private
+
+        def base_url
+          "/department"
+        end
+
+    end
+  end
+end

data/lib/qy_wechat_api/api/media.rb

@@ -0,0 +1,83 @@
+# encoding: utf-8
+
+module QyWechatApi
+  module Api
+    class Media < Base
+
+      # 媒体文件类型，分别有图片（image）、语音（voice）、视频（video），普通文件(file)
+      # media: 支持传路径或者文件实例
+      def upload(media, media_type)
+        file = process_file(media)
+        http_post("upload", {media: file}, {type: media_type})
+      end
+
+      # 返回一个URL，请开发者自行使用此url下载
+      def get_media_by_id(media_id)
+        http_get("get", {media_id: media_id})
+      end
+
+      private
+
+        def base_url
+          "/media"
+        end
+
+        def process_file(media)
+          return media if media.is_a?(File) && jpep?(media)
+
+          media_url = media
+          uploader  = QyWechatApiUploader.new
+
+          if http?(media_url) # remote
+            uploader.download!(media_url.to_s)
+          else # local
+            media_file = media.is_a?(File) ? media : File.new(media_url)
+            uploader.cache!(media_file)
+          end
+          file = process_media(uploader)
+          CarrierWave.clean_cached_files! # clear last one day cache
+          file
+        end
+
+        def process_media(uploader)
+          uploader = covert(uploader)
+          uploader.file.to_file
+        end
+
+        # JUST ONLY FOR JPG IMAGE
+        def covert(uploader)
+          # image process
+          unless (uploader.file.content_type =~ /image/).nil?
+            if !jpep?(uploader.file)
+              require "mini_magick"
+              # covert to jpeg
+              image = MiniMagick::Image.open(uploader.path)
+              image.format("jpg")
+              uploader.cache!(File.open(image.path))
+              image.destroy! # remove /tmp from MinMagick generate
+            end
+          end
+          uploader
+        end
+
+        def http?(uri)
+          return false if !uri.is_a?(String)
+          uri = URI.parse(uri)
+          uri.scheme =~ /^https?$/
+        end
+
+        def jpep?(file)
+          content_type = if file.respond_to?(:content_type)
+              file.content_type
+            else
+              content_type(file.path)
+            end
+          !(content_type =~ /jpeg/).nil?
+        end
+
+        def content_type(media_path)
+          MIME::Types.type_for(media_path).first.content_type
+        end
+    end
+  end
+end

data/lib/qy_wechat_api/api/menu.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+module QyWechatApi
+  module Api
+    class Menu < Base
+
+      def create(menu, agent_id)
+        menu = JSON.load(menu) if menu.is_a?(String)
+        http_post("create", menu, {agentid: agent_id})
+      end
+
+      def delete(agent_id)
+        http_get("delete", {agentid: agent_id})
+      end
+
+      def get(agent_id)
+        http_get("get", {agentid: agent_id})
+      end
+
+      private
+
+        def base_url
+          "/menu"
+        end
+
+    end
+  end
+end