weichat_rails 0.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 567fea986c06c08dcff0a914cb84576178277f74
-  data.tar.gz: b9f6efb6e7fefb6f515beef9919f53e9d63dd9d9
+SHA256:
+  metadata.gz: 6947568df2f6ecc2e476ce76782c0bb8aa8fb0c258e23c7650961ffed0537286
+  data.tar.gz: d2a55100220b51f4b564f8d713877d3e3e47efdd4260cbc48e3845840f27b8db
 SHA512:
-  metadata.gz: a821a2b69becf59201034457e40c8048e580581c5aaa98882dc1c8adf6402c85cbcd58f8e8004378358060060e5d02d77d55bd303dd88c4e62aa93a265518566
-  data.tar.gz: b56494932247b5cf9096df3ba426a64b31c8f9f036da578c23c2b259247fc23d1e08d16c4c243bc199fffacc1701dcff45abd84237b79c00966a5868472ee00b
+  metadata.gz: a6d8b90c02ef4cb79d4ddb91123b9150fae916fed3ad6916fce707c682112a62cbb650b63fc90dfea43bfd6c03ebf8da73a4bced3d7e3e820e062176ac46e997
+  data.tar.gz: 53f50eb90fc4ed1e93db47dfe4b83a8230761e2cebabf8e022d8658a47a6d87bca33c362b9b7c0de06cb4bfecabbe36bc84d053ce05e9f933c602435678181fd

data/.gitignore

@@ -16,3 +16,5 @@ test/tmp
 test/version_tmp
 tmp
 *.swp
+Session.vim
+*.swo

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+rails6

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.0.0

data/README.md

@@ -1,6 +1,6 @@
 # WeichatRails
 
-TODO: Write a gem description
+Used to manage all the public wechat.
 
 ## Installation
 

data/lib/weichat_rails/access_token.rb

@@ -2,7 +2,6 @@ module WeichatRails
   class AccessToken
     attr_reader :client, :appid, :secret
 
-    CacheScope = "#{Rails.application.class.parent_name}_access_token"
     def initialize(client, appid, secret)
       @appid = appid
       @secret = secret
@@ -11,7 +10,7 @@ module WeichatRails
 
     #store token in rails.cache
     def token
-      Rails.cache.fetch("#{CacheScope}#{appid}",expires_in: 7200) do
+      WeichatRails.config.cache.fetch(appid,expires_in: 7200) do
         data = client.get("token", params:{grant_type: "client_credential", appid: appid, secret: secret})
         valid_token(data)
       end
@@ -19,7 +18,7 @@ module WeichatRails
 
     #delete the cache
     def refresh
-      Rails.cache.delete("#{CacheScope}#{appid}")
+      WeichatRails.config.cache.delete(appid)
     end
 
     private

data/lib/weichat_rails/api.rb

@@ -5,22 +5,60 @@ class WeichatRails::Api
   attr_reader :access_token, :client
 
   API_BASE = "https://api.weixin.qq.com/cgi-bin/"
-  FILE_BASE = "http://file.api.weixin.qq.com/cgi-bin/"
+  #FILE_BASE = "http://file.api.weixin.qq.com/cgi-bin/"
   KEFU_BASE = "https://api.weixin.qq.com/customservice/"
+  MP_BASE = 'https://mp.weixin.qq.com/cgi-bin/'
   #https://api.weixin.qq.com/cgi-bin/customservice/getkflist?access_token=ACCESS_TOKEN
 
-  def initialize appid, secret
-    @client = WeichatRails::Client.new(API_BASE)
+  def initialize appid, secret,timeout = 20,skip_verify_ssl = true
+    @client = WeichatRails::Client.new(API_BASE,timeout,skip_verify_ssl)
     @access_token = WeichatRails::AccessToken.new(@client, appid, secret)
   end
 
-  def users
-    get("user/get")
+  def callbackip
+    get 'getcallbackip'
   end
 
-  def user openid
-    get("user/info", params:{openid: openid})
+  def groups
+    get 'groups/get'
   end
+  alias_method :group_get,:groups
+
+  def group_create(group_name)
+    post 'groups/create', JSON.generate(group: { name: group_name })
+  end
+
+  def group_update(groupid, new_group_name)
+    post 'groups/update', JSON.generate(group: { id: groupid, name: new_group_name })
+  end
+  alias_method :group_name_update,:group_update
+
+  def group_delete(groupid)
+    post 'groups/delete', JSON.generate(group: { id: groupid })
+  end
+
+  def users(nextid = nil)
+    params = { params: { next_openid: nextid } } if nextid.present?
+    get('user/get', params || {})
+  end
+
+  def user(openid)
+    get 'user/info', params: { openid: openid }
+  end
+
+  def user_group(openid)
+    post 'groups/getid', JSON.generate(openid: openid)
+  end
+  alias_method :group_user_id,:user_group
+
+  def user_change_group(openid, to_groupid)
+    post 'groups/members/update', JSON.generate(openid: openid, to_groupid: to_groupid)
+  end
+
+  def user_update_remark(openid, remark)
+    post 'user/info/updateremark', JSON.generate(openid: openid, remark: remark)
+  end
+
 
   def menu
     get("menu/get")
@@ -34,22 +72,9 @@ class WeichatRails::Api
     get("customservice/getkflist")
   end
 
-  def group_get
-    get("groups/get")
-  end
-
-  def group_user_id openid
-    json_str = JSON.generate({openid: openid})
-    post("groups/getid", json_str)
-  end
-
-  def group_update openid, to_groupid
-    json_str = JSON.generate({openid: openid,to_groupid: to_groupid})
-    post("groups/members/update", json_str)
-  end
 
   def get_duokefu_records time,pageindex
-    json_str = JSON.generate({starttime: time.beginning_of_day.to_i,endtime: time.end_of_day.to_i,pagesize: 20,pageindex: pageindex})
+    json_str = JSON.generate({starttime: time.beginning_of_day.to_i,endtime: time.end_of_day.to_i,pagesize: 10,pageindex: pageindex})
     post("msgrecord/getrecord",json_str,base: KEFU_BASE)
   end
 
@@ -67,18 +92,82 @@ class WeichatRails::Api
   end
 
   #返回媒体文件
-  def media media_id
-    get "media/get", params:{media_id: media_id}, base: FILE_BASE, as: :file
+  #def media media_id
+  #  get "media/get", params:{media_id: media_id}, base: FILE_BASE, as: :file
+  #end
+
+  #def media_create type, file
+  #  post "media/upload", {upload:{media: file}}, params:{type: type}, base: FILE_BASE
+  #end
+
+  def media(media_id)
+    get 'media/get', params: { media_id: media_id }, as: :file
   end
 
-  def media_create type, file
-    post "media/upload", {upload:{media: file}}, params:{type: type}, base: FILE_BASE
+  def media_create(type, file)
+    post_file 'media/upload', file, params: { type: type }
   end
 
-  def custom_message_send message
-    post "message/custom/send", message.to_json, content_type: :json
+  def material(media_id)
+    get 'material/get', params: { media_id: media_id }, as: :file
   end
 
+  def material_count
+    get 'material/get_materialcount'
+  end
+
+  def material_list(type, offset, count)
+    post 'material/batchget_material', JSON.generate(type: type, offset: offset, count: count)
+  end
+
+  def material_add(type, file)
+    post_file 'material/add_material', file, params: { type: type }
+  end
+
+  def material_delete(media_id)
+    post 'material/del_material', media_id: media_id
+  end
+
+  def custom_message_send(message)
+    post 'message/custom/send', message.to_json, content_type: :json
+  end
+
+  def template_message_send(message)
+    post 'message/template/send', message.to_json, content_type: :json
+  end
+
+  def qrcode(ticket)
+    client.get 'showqrcode', params: { ticket: ticket }, base: MP_BASE, as: :file
+  end
+
+  def qrcode_create_scene(scene_id, expire_seconds = 604800)
+    post 'qrcode/create', JSON.generate(expire_seconds: expire_seconds,
+                                        action_name: 'QR_SCENE',
+                                        action_info: { scene: { scene_id: scene_id } })
+  end
+
+  def qrcode_create_limit_scene(scene_id_or_str)
+    case scene_id_or_str
+    when Fixnum
+      post 'qrcode/create', JSON.generate(action_name: 'QR_LIMIT_SCENE',
+                                          action_info: { scene: { scene_id: scene_id_or_str } })
+    else
+      post 'qrcode/create', JSON.generate(action_name: 'QR_LIMIT_STR_SCENE',
+                                          action_info: { scene: { scene_str: scene_id_or_str } })
+    end
+  end
+
+  # http://mp.weixin.qq.com/wiki/17/c0f37d5704f0b64713d5d2c37b468d75.html
+  # 第二步：通过code换取网页授权access_token
+  def web_access_token(code)
+    params = {
+      appid: access_token.appid,
+      secret: access_token.secret,
+      code: code,
+      grant_type: 'authorization_code'
+    }
+    get 'access_token', params: params, base: OAUTH2_BASE
+  end
 
   protected
   def get path, headers={}
@@ -89,6 +178,12 @@ class WeichatRails::Api
     with_access_token(headers[:params]){|params| client.post path, payload, headers.merge(params: params)}
   end
 
+  def post_file(path, file, headers = {})
+    with_access_token(headers[:params]) do |params|
+      client.post_file path, file, headers.merge(params: params)
+    end
+  end
+
   def with_access_token params={}, tries=2
     begin
       params ||= {}

data/lib/weichat_rails/auto_generate_secret_key.rb

@@ -1,3 +1,4 @@
+require 'active_support/concern'
 module WeichatRails
   module AutoGenerateSecretKey
     extend ActiveSupport::Concern

data/lib/weichat_rails/client.rb

@@ -1,33 +1,54 @@
-require 'rest_client'
+require 'http'
+require 'tempfile'
+require 'active_support/core_ext/object/blank'
 
 module WeichatRails
   class Client
 
-    attr_reader :base
+    attr_reader :base,:ssl_context
 
-    def initialize(base)
+    def initialize(base, timeout, skip_verify_ssl)
       @base = base
+      HTTP.timeout(:global, write: timeout, connect: timeout, read: timeout)
+      @ssl_context = OpenSSL::SSL::SSLContext.new
+      @ssl_context.verify_mode = OpenSSL::SSL::VERIFY_NONE if skip_verify_ssl
     end
 
-    def get path, header={}
-      request(path, header) do |url, _header|
-        RestClient.get(url, _header)
+    def get(path, get_header = {})
+      request(path, get_header) do |url, header|
+        params = header.delete(:params)
+        HTTP.headers(header).get(url, params: params, ssl_context: ssl_context)
       end
     end
 
-    def post path, payload, header = {}
-      request(path, header) do |url, _header|
-        RestClient.post(url, payload, _header)
+    def post(path, payload, post_header = {})
+      request(path, post_header) do |url, header|
+        params = header.delete(:params)
+        HTTP.headers(header).post(url, params: params, body: payload, ssl_context: ssl_context)
       end
     end
 
+    def post_file(path, file, post_header = {})
+      request(path, post_header) do |url, header|
+        params = header.delete(:params)
+        HTTP.headers(header)
+        .post(url, params: params,
+              form: { media: HTTP::FormData::File.new(file),
+                      hack: 'X' }, # Existing here for http-form_data 1.0.1 handle single param improperly
+                      ssl_context: ssl_context)
+      end
+    end
+
+
+
+
     def request path, header={}, &block
       url = "#{header.delete(:base) || self.base}#{path}"
       as = header.delete(:as)
-      header.merge!(:accept => :json)
+      header.merge!('Accept' => 'application/json')
       response = yield(url, header)
 
-      raise "Request not OK, response code #{response.code}" if response.code != 200
+      raise "Request not OK, response status #{response.status}" if response.status != 200
       parse_response(response, as || :json) do |parse_as, data|
         break data unless (parse_as == :json && data["errcode"].present?)
         #break data if (parse_as != :json || data["errcode"].blank?)
@@ -38,12 +59,8 @@ module WeichatRails
         when 0 # for request didn't expect results
           [true,data]
 
-        when 42001, 40014 #42001: access_token超时, 40014:不合法的access_token
+        when 42001, 40014,40001,48001 #42001: access_token超时, 40014:不合法的access_token
           raise AccessTokenExpiredError
-
-        when 1613189120 # for wx duokefu' msg code
-          [true,data]
-
         else
           raise ResponseError.new(data['errcode'], data['errmsg'])
         end
@@ -67,7 +84,7 @@ module WeichatRails
         data = file
 
       when :json
-        data = JSON.parse(response.body)
+        data = JSON.parse response.body.to_s.gsub(/[\u0000-\u001f]+/, '')
 
       else
         data = response.body

data/lib/weichat_rails/message.rb

@@ -1,31 +1,34 @@
+#require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/hash/slice'
+require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/hash/keys'
+require 'active_support/core_ext/hash/conversions'
+
 module WeichatRails
   class Message
-
-    JSON_KEY_MAP = {
-      "ToUserName" => "touser",
-      "MediaId" => "media_id",
-      "ThumbMediaId" => "thumb_media_id"
-    }
-
     class << self
       def from_hash msg_hash
         self.new(msg_hash)
       end
 
       def to to_user
-        self.new(:ToUserName=>to_user, :CreateTime=>Time.now.to_i)
+        new(:ToUserName=>to_user, :CreateTime=>Time.now.to_i)
       end
     end
 
     class ArticleBuilder
       attr_reader :items
-      delegate :count, to: :items
+      #delegate :count, to: :items
       def initialize
         @items=Array.new
       end
 
-      def item title="title", description=nil, pic_url=nil, url=nil
-        items << {:Title=> title, :Description=> description, :PicUrl=> pic_url, :Url=> url}
+      def count
+        items.length
+      end
+
+      def item title:"title", description:nil, pic_url:nil, url:nil
+        items << {:Title=> title, :Description=> description, :PicUrl=> pic_url, :Url=> url}.reject { |_k, v| v.nil? }
       end
     end
 
@@ -48,7 +51,7 @@ module WeichatRails
       when :text
         message_hash[:Content]
 
-      when :image, :voice, :video
+      when :image, :voice, :video, :shortvideo
         WeichatRails.api.media(message_hash[:MediaId])
 
       when :location
@@ -61,18 +64,26 @@ module WeichatRails
       end
     end
 
-    #add wechat_user for load wechat_user in proc callback
-    #def wechat_user user
-    #  update(:wechat_user=>user)
-    #end
     def kefu msg_type
       update(:MsgType => msg_type)
     end
 
+    def transfer_customer_service
+      update(MsgType: 'transfer_customer_service')
+    end
+
     def to openid
       update(:ToUserName=>openid)
     end
 
+    def agent_id(agentid)
+      update(AgentId: agentid)
+    end
+
+
+    def success
+      update(MsgType: 'success')
+    end
     def text content
       update(:MsgType=>"text", :Content=>content)
     end
@@ -102,32 +113,48 @@ module WeichatRails
         items = article.items
       else
         items = collection.collect do |item|
-         camelize_hash_keys(item.symbolize_keys.slice(:title, :description, :pic_url, :url))
+         item.symbolize_keys.slice(:title, :description, :pic_url, :url).reject { |_k,v| v.nil?  }
         end
       end
 
-      update(:MsgType=>"news", :ArticleCount=> items.count,
-        :Articles=> items.collect{|item| camelize_hash_keys(item)})
+      update(:MsgType=>"news", :ArticleCount=> items.count,:Articles=> items.collect{|item| camelize_hash_keys(item)})
+    end
+
+    def template(opts = {})
+      template_fields = camelize_hash_keys(opts.symbolize_keys.slice(:template_id, :topcolor, :url, :data))
+      update(MsgType: 'template', Template: template_fields)
     end
 
     def to_xml
       message_hash.to_xml(root: "xml", children: "item", skip_instruct: true, skip_types: true)
     end
 
+    TO_JSON_KEY_MAP = {
+      'ToUserName' => 'touser',
+      'MediaId' => 'media_id',
+      'ThumbMediaId' => 'thumb_media_id',
+      'TemplateId' => 'template_id'
+    }
+
+    TO_JSON_ALLOWED = %w(touser msgtype content image voice video music news articles template agentid)
+
     def to_json
       json_hash = deep_recursive(message_hash) do |key, value|
         key = key.to_s
-        [(JSON_KEY_MAP[key] || key.downcase), value]
+        [(TO_JSON_KEY_MAP[key] || key.downcase), value]
       end
 
-      json_hash.slice!("touser", "msgtype", "content", "image", "voice", "video", "music", "news", "articles").to_hash
-      case json_hash["msgtype"]
-      when "text"
-        json_hash["text"] = {"content" => json_hash.delete("content")}
-      when "news"
-        json_hash["news"] = {"articles" => json_hash.delete("articles")}
+      json_hash = json_hash.select { |k, _v| TO_JSON_ALLOWED.include? k }
+      case json_hash['msgtype']
+      when 'text'
+        json_hash['text'] = { 'content' => json_hash.delete('content') }
+      when 'news'
+        json_hash['news'] = { 'articles' => json_hash.delete('articles') }
+      when 'template'
+        json_hash.merge! json_hash['template']
       end
       JSON.generate(json_hash)
+
     end
 
     def save_to! model_class

data/lib/weichat_rails/responder.rb

@@ -3,10 +3,16 @@ module WeichatRails
     extend ActiveSupport::Concern
 
     included do
-      self.before_filter :init_wechat_or_token#, only: [:show, :create]
-      self.skip_before_filter :verify_authenticity_token
-      self.before_filter :verify_signature, only: [:show, :create]
-      #delegate :wehcat, to: :class
+      # Rails 5 API mode won't define verify_authenticity_token
+      if defined?(:skip_before_action)
+        before_action :init_wechat_or_token
+        skip_before_action :verify_authenticity_token unless defined?(:verify_authenticity_token)
+        before_action :verify_signature, only: [:show, :create]
+      else
+        before_filter :init_wechat_or_token
+        skip_before_filter :verify_authenticity_token
+        before_filter :verify_signature, only: [:show, :create]
+      end
     end
 
     attr_accessor :wechat, :token,:wechat_user
@@ -18,25 +24,25 @@ module WeichatRails
       #on :text do |res,content|
       #
       #end
-      def on message_type, with: nil, respond: nil, &block
-        raise "Unknow message type" unless message_type.in? [:text, :image, :voice, :video, :location, :link, :event, :fallback]
-        config=respond.nil? ? {} : {:respond=>respond}
-        config.merge!(:proc=>block) if block_given?
-
-        if (with.present? && !message_type.in?([:text, :event]))
-          raise "Only text and event message can take :with parameters"
-        else
-          config.merge!(:with=>with) if with.present?
-        end
-
-        responders(message_type) << config
-        return config
-      end
+      #def on message_type, with: nil, respond: nil, &block
+      #  raise "Unknow message type" unless message_type.in? [:text, :image, :voice, :video, :location, :link, :event, :fallback]
+      #  config=respond.nil? ? {} : {:respond=>respond}
+      #  config.merge!(:proc=>block) if block_given?
+
+      #  if (with.present? && !message_type.in?([:text, :event]))
+      #    raise "Only text and event message can take :with parameters"
+      #  else
+      #    config.merge!(:with=>with) if with.present?
+      #  end
+
+      #  responders(message_type) << config
+      #  return config
+      #end
 
-      def responders type
-        @responders ||= Hash.new
-        @responders[type] ||= Array.new
-      end
+      #def responders type
+      #  @responders ||= Hash.new
+      #  @responders[type] ||= Array.new
+      #end
 
 
       #指定的过滤方法，默认不使用指定的匹配方法,如为true,
@@ -52,29 +58,29 @@ module WeichatRails
       #事件类型：subscribe(订阅)、unsubscribe(取消订阅),SCAN(关注后扫描)，LOCATION（上报地理位置）,CLICK(自定义菜单事件),VIEW(点击菜单跳转链接时的事件推送)
       def responder_for message, &block
         message_type = message[:MsgType].to_sym
-        responders = responders(message_type)
-        if use_matcher?
-          responder = {:method => :find_matcher}
-          case message_type
-          when :text
-            yield(responder,message[:Content])
-          when :event
-            yield(responder,message[:Event],message[:EventKey])
-          when :image,:voice,:shortvideo
-            yield(responder,'MEDIA',picurl: message[:PicUrl],media_id: message[:MediaId])
-          else
-            yield(responder)
-          end
+        #responders = responders(message_type)
+        #if use_matcher?
+        responder = {:method => :find_matcher}
+        case message_type
+        when :text
+          yield(responder,message[:Content])
+        when :event
+          yield(responder,message[:Event],message[:EventKey])
+        when :image,:voice,:shortvideo
+          yield(responder,'MEDIA',picurl: message[:PicUrl],media_id: message[:MediaId])
         else
-          case message_type
-          when :text
-            yield(* match_responders(responders, message[:Content]))
-          when :event
-            yield(* match_responders(responders, message[:Event]))
-          else
-            yield(responders.first)
-          end
+          yield(responder)
         end
+        #else
+        #  case message_type
+        #  when :text
+        #    yield(* match_responders(responders, message[:Content]))
+        #  when :event
+        #    yield(* match_responders(responders, message[:Event]))
+        #  else
+        #    yield(responders.first)
+        #  end
+        #end
       end
 
       private
@@ -84,24 +90,25 @@ module WeichatRails
       #value : 请求内容
       #优先返回具有with值的on规则
       #注：使用on定义的规则只适用于直接在控制器中写死的规则，属于类级别，不适用于后台配置类型,如果responders[msg_type]为空的情况下不产生任何内容
-      def match_responders responders, value
-        mat = responders.inject({scoped:nil, general:nil}) do |matched, responder|
-          condition = responder[:with]
-
-          if condition.nil?
-            matched[:general] ||= [responder, value]
-            next matched
-          end
-
-          if condition.is_a? Regexp
-            matched[:scoped] ||= [responder] + $~.captures if(value =~ condition)
-          else
-            matched[:scoped] ||= [responder, value] if(value == condition)
-          end
-          matched
-        end
-        return mat[:scoped] || mat[:general]
-      end
+      #def match_responders responders, value
+      #  mat = responders.inject({scoped:nil, general:nil}) do |matched, responder|
+      #    condition = responder[:with]
+
+      #    if condition.nil?
+      #      matched[:general] ||= [responder, value]
+      #      next matched
+      #    end
+
+      #    if condition.is_a? Regexp
+      #      matched[:scoped] ||= [responder] + $~.captures if(value =~ condition)
+      #    else
+      #      matched[:scoped] ||= [responder, value] if(value == condition)
+      #    end
+      #    matched
+      #  end
+      #  return mat[:scoped] || mat[:general]
+      #end
+
     end
 
 
@@ -147,7 +154,7 @@ module WeichatRails
 
 
     #def wechat_model
-      #@wechat_model || WeichatRails.config.public_account_class.constantize
+    #@wechat_model || WeichatRails.config.public_account_class.constantize
     #end
 
     #TODO init wechat , wechat_user,token from database

data/lib/weichat_rails/version.rb

@@ -1,3 +1,3 @@
 module WeichatRails
-  VERSION = "0.1.0"
+  VERSION = "2.0.0"
 end