mp_weixin 0.1.0

data/lib/mp_weixin/config.rb

@@ -0,0 +1,36 @@
+module MpWeixin
+  module Config
+
+    def self.app_id= (val)
+      @@app_id = val
+    end
+
+    def self.app_id
+      @@app_id
+    end
+
+    def self.app_secret= (val)
+      @@app_secret = val
+    end
+
+    def self.app_secret
+      @@app_secret
+    end
+
+    def self.url= (val)
+      @@url = val
+    end
+
+    def self.url
+      @@url
+    end
+
+    def self.token= (val)
+      @@token = val
+    end
+
+    def self.token
+      @@token
+    end
+  end
+end

data/lib/mp_weixin/error.rb

@@ -0,0 +1,27 @@
+require 'multi_json'
+require 'rack'
+
+module MpWeixin
+  class Error < StandardError
+    attr_reader :response, :code, :description
+
+    # standard error values include:
+    # :invalid_request, :invalid_client, :invalid_token, :invalid_grant, :unsupported_grant_type, :invalid_scope
+    def initialize(response)
+      response.error = self
+      @response = response
+
+      message = []
+
+      if response.parsed.is_a?(Hash)
+        @code = response.parsed['error']
+        @description = response.parsed['error_description']
+        message << "#{@code}: #{@description}"
+      end
+
+      message << response.body
+
+      super(message.join("\n"))
+    end
+  end
+end

data/lib/mp_weixin/interface/base.rb

@@ -0,0 +1,43 @@
+module MpWeixin
+  module Interface
+
+    # The Base class of API
+    class Base
+      def initialize(client)
+        @client = client
+      end
+
+      def default_request_params
+        access_token = @client.token.token
+        #request_params = {"oauth_consumer_key" => self.id, "access_token" => access_token, "openid" => params["openid"], "oauth_version" => "2.a", "scope" => "all"}
+        # {"appid" => @client.id, "access_token" => access_token}
+        {"access_token" => access_token}
+      end
+
+      def request(verb, path, opts={}, &block)
+        unless @client.is_authorized?
+          raise "I can't find a valid access_token. Forgot to get it or expired?"
+        end
+
+        opts[:params] ||= {}
+        #opts[:params].merge!(default_request_params)
+        opts = ActiveSupport::HashWithIndifferentAccess.new(opts)
+
+        response = @client.token.request(verb, path, opts, &block)
+        if response.error
+          raise Error.new(response)
+        end
+        response
+      end
+
+      def get(path, opts={}, &block)
+        request(:get, path, opts, &block)
+      end
+
+      def post(path, opts={}, &block)
+        request(:post, path, opts, &block)
+      end
+    end
+
+  end
+end

data/lib/mp_weixin/interface/group.rb

@@ -0,0 +1,92 @@
+# encoding: utf-8
+module MpWeixin
+  module Interface
+
+    # 分组管理
+    #
+    # 开发者可以使用接口，对公众平台的分组进行查询、创建、修改操作，也可以使用接口在需要时移动用户到某个分组。
+    class Group < Base
+
+      # 创建分组:
+      #
+      # 一个公众账号，最多支持创建500个分组。 接口调用请求说明
+      #
+      #    http请求方式: POST（请使用https协议）
+      #    https://api.weixin.qq.com/cgi-bin/groups/create?access_token=ACCESS_TOKEN
+      #    POST数据格式：json
+      #    POST数据例子：{"group":{"name":"test"}}
+      #
+      # @see http://mp.weixin.qq.com/wiki/index.php?title=%E5%88%86%E7%BB%84%E7%AE%A1%E7%90%86%E6%8E%A5%E5%8F%A3#.E5.88.9B.E5.BB.BA.E5.88.86.E7.BB.84
+      def create(arg = nil)
+        if arg.present?
+          opts = arg.is_a?(Hash) ? arg : {group: {name: arg}}
+          # JSON.generate(user_message.protocol_params, :ascii_only => true)
+          opts_json = JSON.generate(opts, :ascii_only => false)
+
+          post '/cgi-bin/groups/create', :body => opts_json, :params => default_request_params
+        end
+      end
+
+      # 查询所有分组
+      #
+      #    http请求方式: GET（请使用https协议）
+      #    https://api.weixin.qq.com/cgi-bin/groups/get?access_token=ACCESS_TOKEN
+      #
+      # @see http://mp.weixin.qq.com/wiki/index.php?title=%E5%88%86%E7%BB%84%E7%AE%A1%E7%90%86%E6%8E%A5%E5%8F%A3#.E6.9F.A5.E8.AF.A2.E6.89.80.E6.9C.89.E5.88.86.E7.BB.84
+      def get_groups(opts = {})
+        get '/cgi-bin/groups/get', :params => opts.merge(default_request_params)
+      end
+
+      # 查询用户所在分组
+      #
+      # 通过用户的OpenID查询其所在的GroupID。 接口调用请求说明
+      #
+      #    http请求方式: POST（请使用https协议）
+      #    https://api.weixin.qq.com/cgi-bin/groups/getid?access_token=ACCESS_TOKEN
+      #    POST数据格式：json
+      #    POST数据例子：{"openid":"od8XIjsmk6QdVTETa9jLtGWA6KBc"}
+      #
+      # @see http://mp.weixin.qq.com/wiki/index.php?title=%E5%88%86%E7%BB%84%E7%AE%A1%E7%90%86%E6%8E%A5%E5%8F%A3#.E6.9F.A5.E8.AF.A2.E7.94.A8.E6.88.B7.E6.89.80.E5.9C.A8.E5.88.86.E7.BB.84
+      def getid(opts = {})
+        # JSON.generate(user_message.protocol_params, :ascii_only => true)
+        opts_json = JSON.generate(opts, :ascii_only => false) if opts.is_a?(Hash)
+
+        post '/cgi-bin/groups/getid', :body => opts_json, :params => default_request_params
+      end
+
+      # 修改分组名
+      #
+      # 接口调用请求说明
+      #
+      #    http请求方式: POST（请使用https协议）
+      #    https://api.weixin.qq.com/cgi-bin/groups/update?access_token=ACCESS_TOKEN
+      #    POST数据格式：json
+      #    POST数据例子：{"group":{"id":108,"name":"test2_modify2"}}
+      #
+      # @see http://mp.weixin.qq.com/wiki/index.php?title=%E5%88%86%E7%BB%84%E7%AE%A1%E7%90%86%E6%8E%A5%E5%8F%A3#.E4.BF.AE.E6.94.B9.E5.88.86.E7.BB.84.E5.90.8D
+      def update(opts = {})
+        # JSON.generate(user_message.protocol_params, :ascii_only => true)
+        opts_json = JSON.generate(opts, :ascii_only => false) if opts.is_a?(Hash)
+
+        post '/cgi-bin/groups/update', :body => opts_json, :params => default_request_params
+      end
+
+      # 移动用户分组
+      #
+      # 接口调用请求说明
+      #
+      #    http请求方式: POST（请使用https协议）
+      #    https://api.weixin.qq.com/cgi-bin/groups/members/update?access_token=ACCESS_TOKEN
+      #    POST数据格式：json
+      #    POST数据例子：{"openid":"oDF3iYx0ro3_7jD4HFRDfrjdCM58","to_groupid":108}
+      #
+      # @see http://mp.weixin.qq.com/wiki/index.php?title=%E5%88%86%E7%BB%84%E7%AE%A1%E7%90%86%E6%8E%A5%E5%8F%A3#.E4.BF.AE.E6.94.B9.E5.88.86.E7.BB.84.E5.90.8D
+      def update_memgers(opts = {})
+        # JSON.generate(user_message.protocol_params, :ascii_only => true)
+        opts_json = JSON.generate(opts, :ascii_only => false) if opts.is_a?(Hash)
+
+        post '/cgi-bin/groups/members/update', :body => opts_json, :params => default_request_params
+      end
+    end
+  end
+end

data/lib/mp_weixin/interface/menu.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+module MpWeixin
+  module Interface
+
+    # 自定义菜单
+    class Menu < Base
+
+      # 自定义菜单创建接口:
+      #
+      # 一个公众账号，最多支持创建500个分组。 接口调用请求说明
+      #
+      #    {
+      #      "button":[
+      #      {
+      #         "type":"click",
+      #         "name":"今日歌曲",
+      #         "key":"V1001_TODAY_MUSIC"
+      #      },
+      #      {
+      #         "type":"click",
+      #         "name":"歌手简介",
+      #         "key":"V1001_TODAY_SINGER"
+      #      },
+      #      {
+      #         "name":"菜单",
+      #         "sub_button":[
+      #         {
+      #             "type":"view",
+      #             "name":"搜索",
+      #             "url":"http://www.soso.com/"
+      #          },
+      #          {
+      #             "type":"view",
+      #             "name":"视频",
+      #             "url":"http://v.qq.com/"
+      #          },
+      #          {
+      #             "type":"click",
+      #             "name":"赞一下我们",
+      #             "key":"V1001_GOOD"
+      #          }]
+      #      }]
+      #    }
+      #
+      # @see http://mp.weixin.qq.com/wiki/index.php?title=%E8%87%AA%E5%AE%9A%E4%B9%89%E8%8F%9C%E5%8D%95%E5%88%9B%E5%BB%BA%E6%8E%A5%E5%8F%A3
+      def create(opts = nil)
+        # JSON.generate(user_message.protocol_params, :ascii_only => true)
+        opts_json = JSON.generate(opts, :ascii_only => false) if opts.is_a?(Hash)
+
+        post '/cgi-bin/menu/create', :body => opts_json, :params => default_request_params
+      end
+
+      # 自定义菜单查询接口
+      # http请求方式：GET
+      #   https://api.weixin.qq.com/cgi-bin/menu/get?access_token=ACCESS_TOKEN
+      # @see http://mp.weixin.qq.com/wiki/index.php?title=%E8%87%AA%E5%AE%9A%E4%B9%89%E8%8F%9C%E5%8D%95%E6%9F%A5%E8%AF%A2%E6%8E%A5%E5%8F%A3
+      def get_menus(opts = {})
+        get '/cgi-bin/menu/get', :params => opts.merge(default_request_params)
+      end
+
+      # 自定义菜单查询接口
+      # http请求方式：GET
+      #   https://api.weixin.qq.com/cgi-bin/menu/delete?access_token=ACCESS_TOKEN
+      # @see http://mp.weixin.qq.com/wiki/index.php?title=%E8%87%AA%E5%AE%9A%E4%B9%89%E8%8F%9C%E5%8D%95%E5%88%A0%E9%99%A4%E6%8E%A5%E5%8F%A3
+      def delete(opts = {})
+        get '/cgi-bin/menu/delete', :params => opts.merge(default_request_params)
+      end
+
+      # 自定义菜单事件推送
+      # 用户点击自定义菜单后，如果菜单按钮设置为click类型，则微信会把此次点击事件推送给开发者，注意view类型（跳转到URL）的菜单点击不会上报。
+    end
+  end
+end

data/lib/mp_weixin/interface/message.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+module MpWeixin
+  module Interface
+
+    # 发送消息
+    class Message < Base
+      # 发送客服消息
+      # 文本消息:
+      #
+      # {
+      #    "touser":"OPENID",
+      #    "msgtype":"text",
+      #    "text":
+      #    {
+      #         "content":"Hello World"
+      #    }
+      # }
+      #
+      # 发送图片消息:
+      # {
+      #    "touser":"OPENID",
+      #    "msgtype":"image",
+      #    "image":
+      #    {
+      #      "media_id":"MEDIA_ID"
+      #    }
+      # }
+      # etc
+      # @see http://mp.weixin.qq.com/wiki/index.php?title=%E5%8F%91%E9%80%81%E5%AE%A2%E6%9C%8D%E6%B6%88%E6%81%AF
+      def custom_send(opts = nil)
+        # JSON.generate(user_message.protocol_params, :ascii_only => true)
+        opts_json = JSON.generate(opts, :ascii_only => false) if opts.is_a?(Hash)
+
+        post '/cgi-bin/message/custom/send', :body => opts_json, :params => default_request_params
+      end
+    end
+  end
+end

data/lib/mp_weixin/interface/promotion.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+module MpWeixin
+  module Interface
+
+    # 推广支持 生成带参数的二维码
+    class Promotion < Base
+
+      # 创建二维码ticket:
+      #
+      # 临时二维码请求说明
+      # http请求方式: POST
+      # URL: https://api.weixin.qq.com/cgi-bin/qrcode/create?access_token=TOKEN
+      # POST数据格式：json
+      # POST数据例子：{"expire_seconds": 1800, "action_name": "QR_SCENE", "action_info": {"scene": {"scene_id": 123}}}
+      # 永久二维码请求说明
+      # http请求方式: POST
+      # URL: https://api.weixin.qq.com/cgi-bin/qrcode/create?access_token=TOKEN
+      # POST数据格式：json
+      # POST数据例子：{"action_name": "QR_LIMIT_SCENE", "action_info": {"scene": {"scene_id": 123}}}
+      # @see http://mp.weixin.qq.com/wiki/index.php?title=%E7%94%9F%E6%88%90%E5%B8%A6%E5%8F%82%E6%95%B0%E7%9A%84%E4%BA%8C%E7%BB%B4%E7%A0%81
+      def create(opts = nil)
+        # JSON.generate(user_message.protocol_params, :ascii_only => true)
+        opts_json = JSON.generate(opts, :ascii_only => false) if opts.is_a?(Hash)
+
+        # http://rubydoc.info/gems/faraday/0.5.3/Faraday/Request
+        post '/cgi-bin/qrcode/create', :body => opts_json, :params => default_request_params
+      end
+
+      # 自定义菜单查询接口
+      # HTTP GET请求（请使用https协议）
+      # https://mp.weixin.qq.com/cgi-bin/showqrcode?ticket=TICKET
+      # 提醒：TICKET记得进行UrlEncode
+
+      # @see http://mp.weixin.qq.com/wiki/index.php?title=%E7%94%9F%E6%88%90%E5%B8%A6%E5%8F%82%E6%95%B0%E7%9A%84%E4%BA%8C%E7%BB%B4%E7%A0%81
+      def showqrcode(arg = nil)
+        if arg.present?
+          opts = arg.is_a?(Hash) ? arg : {ticket: arg}
+
+          get '/cgi-bin/showqrcode', :params => opts.merge(default_request_params) do |req|
+            req.url 'https://mp.weixin.qq.com/cgi-bin/showqrcode', default_request_params
+            req
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/mp_weixin/interface/user.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+module MpWeixin
+  module Interface
+
+    # 获取用户基本信息 & 获取关注者列表
+    #
+    # 在关注者与公众号产生消息交互后，公众号可获得关注者的OpenID（加密后的微信号，每个用户对每个公众号的OpenID是唯一的。对于不同公众号，同一用户的openid不同）。公众号可通过本接口来根据OpenID获取用户基本信息，包括昵称、头像、性别、所在城市、语言和关注时间。
+    class User < Base
+
+      # 获取用户基本信息:
+      #
+      # 开发者可通过OpenID来获取用户基本信息。请使用https协议。
+      #
+      #    接口调用请求说明
+      #    http请求方式: GET
+      #    https://api.weixin.qq.com/cgi-bin/user/info?access_token=ACCESS_TOKEN&openid=OPENID
+      #
+      # @see http://mp.weixin.qq.com/wiki/index.php?title=%E8%8E%B7%E5%8F%96%E7%94%A8%E6%88%B7%E5%9F%BA%E6%9C%AC%E4%BF%A1%E6%81%AF
+      def info(opts = {})
+        get '/cgi-bin/user/info', :params => opts.merge(default_request_params)
+      end
+
+      # 获取关注者列表
+      #
+      # 公众号可通过本接口来获取帐号的关注者列表，关注者列表由一串OpenID（加密后的微信号，每个用户对每个公众号的OpenID是唯一的）组成。一次拉取调用最多拉取10000个关注者的OpenID，可以通过多次拉取的方式来满足需求。
+      #
+      #   http请求方式: GET（请使用https协议）
+      #   https://api.weixin.qq.com/cgi-bin/user/get?access_token=ACCESS_TOKEN&next_openid=NEXT_OPENID
+      #
+      # @see http://mp.weixin.qq.com/wiki/index.php?title=%E8%8E%B7%E5%8F%96%E5%85%B3%E6%B3%A8%E8%80%85%E5%88%97%E8%A1%A8
+      def get_users(opts = {})
+        get '/cgi-bin/user/get', :params => opts.merge(default_request_params)
+      end
+
+      # 网页授权获取用户基本信息
+      # [prefer](https://github.com/jhjguxin/open_weixin/)
+    end
+  end
+end

data/lib/mp_weixin/models/event.rb

@@ -0,0 +1,123 @@
+# encoding: utf-8
+module MpWeixin
+  # The MpWeixin::Message class
+  #
+  class Event
+    include ActiveModel::Model
+    attr_accessor :ToUserName, :FromUserName,
+                    :CreateTime, :MsgType
+
+    # Instantiate a new Message with a hash of attributes
+    #
+    # @param [Hash] attributes the attributes value
+    def initialize(attributes = nil)
+      # Dynamic attr_accessible
+      # maybe cause secret problem
+      singleton_class.class_eval do
+        attr_accessor *attributes.keys
+      end
+
+      super
+      @source = ActiveSupport::HashWithIndifferentAccess.new(attributes)
+    end
+
+    # same as @attributes CreateTime of an Message instance
+    #
+    # @return [Integer]
+    def create_time
+      self.CreateTime.to_i
+    end
+    # alias :CreateTime :create_time
+
+    # convert create_time to an Time instance
+    #
+    # @return [Time]
+    def created_at
+      Time.at create_time rescue nil
+    end
+
+    # initialize an ReplyMessage
+    # @msg_type [string] the MsgType of ReplyMessage
+    # @attributes [Hash] the attributes of ReplyMessage
+    # @return an instance of #{MsgType}ReplyMessage
+    def reply(msg_type, attributes)
+      if attributes.is_a?(Hash)
+        attributes = attributes.deep_symbolize_keys
+        attributes.reverse_merge!({
+          ToUserName: self.FromUserName,
+          FromUserName: self.ToUserName
+        })
+      end
+
+      case msg_type
+        when 'text'
+          MpWeixin::TextReplyMessage.new(attributes)
+        when 'image'
+          MpWeixin::ImageReplyMessage.new(attributes)
+        when 'voice'
+          MpWeixin::VoiceReplyMessage.new(attributes)
+        when 'video'
+          MpWeixin::VideoReplyMessage.new(attributes)
+        when 'music'
+          MpWeixin::MusicReplyMessage.new(attributes)
+        when 'news'
+          MpWeixin::NewsReplyMessage.new(attributes)
+        else
+          # raise 'Unknown Message data'
+      end
+    end
+
+    # initialize an TextReplyMessage
+    # @attributes [Hash] the attributes of TextReplyMessage
+    def reply_text_message(attributes)
+      reply("text", attributes)
+    end
+
+    # initialize an ImageReplyMessage
+    # @attributes [Hash] the attributes of ImageReplyMessage
+    def reply_image_message(attributes)
+      reply("image", attributes)
+    end
+
+    # initialize an VoiceReplyMessage
+    # @attributes [Hash] the attributes of VoiceReplyMessage
+    def reply_voice_message(attributes)
+      reply("voice", attributes)
+    end
+
+    # initialize an VideoReplyMessage
+    # @attributes [Hash] the attributes of VideoReplyMessage
+    def reply_video_message(attributes)
+      reply("video", attributes)
+    end
+
+    # initialize an MusicReplyMessage
+    # @attributes [Hash] the attributes of MusicReplyMessage
+    def reply_music_message(attributes)
+      reply("music", attributes)
+    end
+
+    # initialize an NewsReplyMessage
+    # @attributes [Hash] the attributes of NewsReplyMessage
+    def reply_news_message(attributes)
+      reply("news", attributes)
+    end
+
+    class << self
+      def from_xml(xml)
+        begin
+          hash = MultiXml.parse(xml)['xml']
+
+          message = case hash['MsgType']
+                      when 'event'
+                        Event.new(hash)
+                      else
+                        # raise 'Unknown Message data'
+                    end
+        rescue
+          logger.info('Unknown Message data #{xml}') if self.respond_to?(:logger)
+        end
+      end
+    end
+  end
+end