easy_weixin 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9206ee70846db436d192ff9fb4c2764a1c48df5b
-  data.tar.gz: 72756ef2564b95fbe36f3015b4d712799b9d76da
+  metadata.gz: 0441570dd87ce9e4cf8311ed51603591805e773d
+  data.tar.gz: 4e1988ce9b0501884b545cf70cdea68584e5faec
 SHA512:
-  metadata.gz: 4d10ecaca75544322f6de133d2a891386bde6a73ad519c6893b5be721df2692051e7d77d0e352f484e00e7faaa17663c25123c7a429673fdaeb914d13fd422f0
-  data.tar.gz: 6d52b70b5ddde6433d2c240126731f000996254f174b5290655fa911ab70c3fd04f88b5f4d386211fd7364c7e6fd21eb5107737a0b39c1a6a2fd384bbd61a5a3
+  metadata.gz: be0eb93ce57ecd370ada2097c7927fece940d064a2688260147e5958aa4566ae536d1d8ebf0824dba3f1ecd20a0b34b3309421ed4b9d0f59f906f8bb7fe26b33
+  data.tar.gz: 5d6dc102a8bd1b199004f45e275ebf9761b292a08d0fd2db747e7e3ead87fe139f4048c4516830dcf19f22e3a3ff1c7212550d5dee7cb6a49a08970189e52f1f

data/README.md

@@ -1,37 +1,51 @@
 # EasyWeixin
 
-A Simple gem for weixin
+	A Simple gem for weixin
 
-## Installation
+# Installation
 
 	gem install easy_weixin
 
-## Usage
+### Rails use redis
 
-check_valid
+```
+EasyWeixin.configure do |config|
+	config.redis = Redis.new
+end
+```
 
-### check
+# Usage
 
-	timestamp = params[:timestamp]
-  nonce = params[:nonce]
-  signature = params[:signature]
-  echostr = params[:echostr]
-  token = 'xxxxx'
-  easy_weixin = EasyWeixin::Auth.new(token, timestamp, nonce, signature, echostr)  # => echostr or false
+### 验证
 
-### analysis xml
-	request_xml = Nokogiri::XML(request.body.read).to_s
-  msg = EasyWeixin.analysis_xml(request_xml)
+```
+easy_weixin = EasyWeixin::Auth.new(@token, @timestamp, @nonce, @signature, @echostr)
+easy_weixin.check_valid    # => echostr or false
+```
 
-### reply
+### 创建菜单
+
+```
+$client = EasyWeixin::Api.new(ENV["APPID"], ENV["APPSECRET"])
+$client.create_menu(data)
+```
+
+### 解析XML
+```
+request_xml = Nokogiri::XML(request.body.read).to_s
+msg = EasyWeixin::Response.analysis_xml(request_xml)
+```
+
+### 回复
 
 * ReplyText
 ```
 	EasyWeixin.text_msg(msg.ToUserName, msg.FromUserName, 'i am a text reply')
 ```
+
 * ReplyNews
 ```
-	msg = EasyWeixin::Message.factory(xml)
+	msg = EasyWeixin::Response.analysis_xml(request_xml)
 	if msg.Content == 'Hello2BizUser'
 		item1 = EasyWeixin::Item.new
 		item1.Title = 'title1'
@@ -42,14 +56,9 @@ check_valid
 		Articles = [item1, item2]
 		ArticleCount = Articles.size
 	end
-
-	EasyWeixin.news_msg(msg.ToUserName, msg.FromUserName, Articles, ArticleCount)
+	EasyWeixin::Response.news_msg(msg.ToUserName, msg.FromUserName, Articles, ArticleCount)
+```
+### 测试
+```
+rake test
 ```
-
-## Contributing
-
-1. Fork it ( http://github.com/<my-github-username>/easy_weixin/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request

data/Rakefile

@@ -1 +1,11 @@
-require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  # libs表示要添加到$LOAD_PATH(就是加载ruby文件的搜索路径)的文件夹
+  # 默认是"lib"，现在再添加"test"
+  t.libs << "test"
+  # 要运行的测试文件的特征。匹配以test_开头的所有文件
+  t.pattern = 'test/*.rb'
+  # 不输出测试文件的信息
+  t.verbose = false
+end

data/easy_weixin.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = EasyWeixin::VERSION
   spec.authors       = ["menghuanwd"]
   spec.email         = ["651019063@qq.com"]
-  spec.summary       = %q{easy to use weixin.}
-  spec.description   = %q{easy to use weixin.}
+  spec.summary       = %q{easy to use weixin public api.}
+  spec.description   = %q{create menu and reply message.}
   spec.homepage      = "https://github.com/menghuanwd/easy_weixin"
   spec.license       = "MIT"
 
@@ -22,4 +22,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "roxml"
   spec.add_development_dependency "multi_xml"
+  spec.add_development_dependency "faraday"
+  spec.add_development_dependency "typhoeus"
+  spec.add_development_dependency "redis"
+
 end

data/lib/easy_weixin.rb

@@ -1,40 +1,43 @@
 require 'multi_xml'
 require 'ostruct'
-require "easy_weixin/model"
+require 'redis'
+require 'roxml'
+require "easy_weixin/config"
 require "easy_weixin/auth"
+require "easy_weixin/menu"
+require "easy_weixin/response"
+require "easy_weixin/message"
+require "easy_weixin/api"
 require 'rack'
-require 'open-uri'
+require 'faraday'
+require 'typhoeus/adapters/faraday'
 
 module EasyWeixin
-  extend self
+  # extend self
 
-  def text_msg(from, to, content)
-    msg = TextReplyMessage.new
-    msg.ToUserName   = to
-    msg.FromUserName = from
-    msg.Content = content
-    msg.to_xml
-  end
+  # def text_msg(from, to, content)
+  #   msg = TextReplyMessage.new
+  #   msg.ToUserName   = to
+  #   msg.FromUserName = from
+  #   msg.Content = content
+  #   msg.to_xml
+  # end
+  #
+  # def news_msg(from, to, articles, articleCount=1)
+  #   msg = NewsReplyMessage.new
+  #   msg.ToUserName   = to
+  #   msg.FromUserName = from
+  #   unless articles.is_a?(Array)
+  #     articles = [articles]
+  #   end
+  #   msg.Articles = articles
+  #   msg.ArticleCount = articleCount
+  #   msg.to_xml
+  # end
+  #
+  # def analysis_xml(request_xml)
+  #   hash = MultiXml.parse(request_xml)['xml']
+  #   source = OpenStruct.new(hash)
+  # end
 
-  def news_msg(from, to, articles, articleCount=1)
-    msg = NewsReplyMessage.new
-    msg.ToUserName   = to
-    msg.FromUserName = from
-    unless articles.is_a?(Array)
-      articles = [articles]
-    end
-    msg.Articles = articles
-    msg.ArticleCount = articleCount
-    msg.to_xml
-  end
-
-  def analysis_xml(request_xml)
-    hash = MultiXml.parse(request_xml)['xml']
-    source = OpenStruct.new(hash)
-  end
-
-  def get_weixin_access_token(appid, appsecret)
-    url = "https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=#{appid}&secret=#{appsecret}"
-    JSON.parse(open(url).read)["access_token"]
-  end
 end

data/lib/easy_weixin/api.rb

@@ -0,0 +1,86 @@
+# 接入API
+
+module EasyWeixin
+	class Api
+		include Menu
+
+		def initialize(app_id, app_secret)
+			@app_id = app_id
+			@app_secret = app_secret
+			@redis_key = "weixin_access_token_#{app_id}"
+			@grant_type = 'client_credential'
+			@weixin_api_url = 'https://api.weixin.qq.com'
+		end
+
+		# 获取access_token，如果启用redis则使用redis记录，如果没启用就每次进行一次查询。
+    def get_access_token
+    	if EasyWeixin.weixin_redis
+      	access_token = weixin_redis.get(@redis_key)
+
+      	if access_token
+      		access_token
+      	else
+      		refresh_token
+      	end
+
+      else
+      	get_access_token_http
+      end
+    end
+
+    def get_access_token_http
+    	conn = Faraday.new(url: "https://api.weixin.qq.com") do |faraday|
+	      faraday.request :url_encoded
+	      faraday.adapter :typhoeus
+	    end
+      response = conn.get("cgi-bin/token", authenticate_headers)
+
+      token_hash = JSON.parse(response.body)
+
+			access_token = token_hash["access_token"]
+    end
+
+    def refresh_token
+    	get_access_token_http
+
+			conn = Faraday.new(url: "https://api.weixin.qq.com") do |faraday|
+	      faraday.request :url_encoded
+	      faraday.adapter :typhoeus
+	    end
+      response = conn.get("cgi-bin/token", authenticate_headers)
+      token_hash = JSON.parse(response.body)
+
+			access_token = token_hash["access_token"]
+			expires_in = token_hash["expires_in"]
+
+			weixin_redis.set(@redis_key, access_token)
+			weixin_redis.expire(@redis_key, expires_in - 5)
+
+			token_hash["access_token"]
+    end
+
+		def authenticate_headers
+      {grant_type: @grant_type, appid: @app_id, secret: @app_secret}
+    end
+
+    def weixin_redis
+      EasyWeixin.weixin_redis
+    end
+
+    private
+
+    	def http_post(url, data)
+    		conn = Faraday.new(url: @weixin_api_url) do |faraday|
+		      faraday.request :url_encoded
+		      faraday.adapter :typhoeus
+		    end
+	      response = conn.post do |req|
+	      	req.url url
+	      	req.params['access_token'] = get_access_token
+	      	req.headers['Content-Type'] = 'application/json'
+	      	req.body = data
+	      end
+    	end
+
+	end
+end

data/lib/easy_weixin/auth.rb

@@ -21,4 +21,4 @@ module EasyWeixin
 			end
 		end
 	end
-end
+end

data/lib/easy_weixin/config.rb

@@ -0,0 +1,25 @@
+module EasyWeixin
+	class << self
+
+		attr_accessor :config
+
+		def configure
+			yield self.config ||= Config.new
+		end
+
+		def weixin_redis
+			# use add log
+			return nil if EasyWeixin.config.nil?
+			EasyWeixin.config.redis
+		end
+
+	end
+
+	class Config
+		attr_accessor :redis
+	end
+end
+
+# EasyWeixin.configure do |config|
+# 	config.redis = Redis.new
+# end

data/lib/easy_weixin/menu.rb

@@ -0,0 +1,11 @@
+module EasyWeixin
+	module Menu
+
+		# 自定义菜单创建接口
+    # https://api.weixin.qq.com/cgi-bin/menu/create?access_token=ACCESS_TOKEN
+    def create_menu(data)
+      http_post('cgi-bin/menu/create', data)
+    end
+
+	end
+end

data/lib/easy_weixin/{model.rb → message.rb}

@@ -1,20 +1,14 @@
-require 'multi_xml'
-require 'ostruct'
-require 'roxml'
-
 module EasyWeixin
 	class Message
-		attr_accessor :ToUserName, :FromUserName, :CreateTime
 
-		def initialize
-			@ToUserName = ToUserName
-			@FromUserName = FromUserName
-			@CreateTime = CreateTime
-		end
+    include Response
+
+		# attr_accessor :ToUserName, :FromUserName, :CreateTime
 
-		def self.factory(xml)
-			hash = MultiXml.parse(xml)['xml']
-			source = OpenStruct.new(hash)
+		def initialize(to,from,time)
+			@ToUserName = to
+			@FromUserName = from
+			@CreateTime = time
 		end
 
 	end
@@ -70,4 +64,4 @@ module EasyWeixin
   end
 
 
-end
+end

data/lib/easy_weixin/response.rb

@@ -0,0 +1,32 @@
+module EasyWeixin
+  module Response
+    extend self
+
+    # 创建文本信息
+    def text_msg(from, to, content)
+      msg = TextReplyMessage.new
+      msg.ToUserName   = to
+      msg.FromUserName = from
+      msg.Content = content
+      msg.to_xml
+    end
+
+    def news_msg(from, to, articles, articleCount=1)
+      msg = NewsReplyMessage.new
+      msg.ToUserName   = to
+      msg.FromUserName = from
+      unless articles.is_a?(Array)
+        articles = [articles]
+      end
+      msg.Articles = articles
+      msg.ArticleCount = articleCount
+      msg.to_xml
+    end
+
+    def analysis_xml(request_xml)
+      hash = MultiXml.parse(request_xml)['xml']
+      source = OpenStruct.new(hash)
+    end
+    
+  end
+end

data/lib/easy_weixin/version.rb

@@ -1,3 +1,3 @@
 module EasyWeixin
-  VERSION = "0.0.9"
+  VERSION = "0.1.0"
 end

data/test/menu.json

@@ -0,0 +1,54 @@
+{
+    "button": [
+        {
+            "name": "美女如云",
+            "sub_button": [
+                {
+                    "type": "view",
+                    "name": "性感美女",
+                    "url": "http://wap.guyifeng.pw/photos?photo_category_id=1"
+                },
+                {
+                    "type": "view",
+                    "name": "小清新",
+                    "url": "http://wap.guyifeng.pw/photos?photo_category_id=2"
+                },
+                {
+                    "type": "view",
+                    "name": "甜素纯",
+                    "url": "http://wap.guyifeng.pw/photos?photo_category_id=5"
+                },
+                {
+                    "type": "view",
+                    "name": "清纯",
+                    "url": "http://wap.guyifeng.pw/photos?photo_category_id=6"
+                },
+                {
+                    "type": "view",
+                    "name": "嫩萝莉",
+                    "url": "http://wap.guyifeng.pw/photos?photo_category_id=11"
+                }
+            ]
+        },
+        {
+            "name": "来个人",
+            "sub_button": [
+                {
+                    "type": "click",
+                    "name": "男人",
+                    "key": "boy"
+                },
+                {
+                    "type": "click",
+                    "name": "女人",
+                    "key": "girl"
+                }
+            ]
+        },
+        {
+            "name": "来个笑话",
+            "type": "click",
+            "key": "joke"
+        }
+    ]
+}

data/test/test_auth.rb

@@ -0,0 +1,19 @@
+require 'minitest/autorun'
+require 'easy_weixin'
+
+describe "EasyWeixin" do
+
+  before do
+    @token = 'dave'
+    @timestamp = Time.now.to_i.to_s
+    @nonce = '123456'
+    @signature = Digest::SHA1.hexdigest( [@token, @timestamp, @nonce].sort.join )
+    @echostr = 'caishu'
+  end
+
+  it 'function check_valid' do
+    easy_weixin = EasyWeixin::Auth.new(@token, @timestamp, @nonce, @signature, @echostr)
+    easy_weixin.check_valid.must_equal @echostr
+  end
+
+end

data/test/test_get_access_token.rb

@@ -0,0 +1,13 @@
+require 'minitest/autorun'
+require 'easy_weixin'
+
+describe 'AccessToken' do
+  before do
+    @client = EasyWeixin::Api.new('wx61e7c4dba13cc83e', 'bfdffb358e437f3149bbbfed7e7c8ccd')
+  end
+
+  it 'ssss' do
+    puts @client.get_access_token
+    # @client.get_access_token.must_equal "OHAI!"
+  end
+end

data/test/test_menu.rb

@@ -0,0 +1,13 @@
+require 'minitest/autorun'
+require 'easy_weixin'
+
+describe 'AccessToken' do
+  before do
+    @client = EasyWeixin::Api.new('wx61e7c4dba13cc83e', 'bfdffb358e437f3149bbbfed7e7c8ccd')
+  end
+
+  it 'menu' do
+    data = File.open(File.expand_path('../menu.json',__FILE__)).read
+    puts @client.create_menu(data).body
+  end
+end

data/test/test_response.rb

@@ -0,0 +1,44 @@
+require 'minitest/autorun'
+require 'easy_weixin'
+require File.expand_path('../test_xml',__FILE__)
+
+describe "EasyWeixin" do
+
+  describe "subscribe" do
+    it 'subscribe' do
+
+      msg = EasyWeixin::Response.analysis_xml($subscribe_xml)
+
+      puts easy_weixin = EasyWeixin::Response.text_msg(msg.ToUserName, msg.FromUserName, 'Hi 欢迎来到顾益峰的个人微信频道,能来到这里的，都是我的朋友，都是一家人，这里你可以很放松！回复joke，听个笑话.回复girl，会显示我的五个女性朋友.回复boy，会显示我的五个男性朋友,回复其他内容，有你意想不到的内容喔~')
+    end
+  end
+
+  describe "text" do
+    it 'text' do
+
+      msg = EasyWeixin::Response.analysis_xml($text_xml)
+
+      puts easy_weixin = EasyWeixin::Response.text_msg(msg.ToUserName, msg.FromUserName, '我只是一个回复')
+    end
+  end
+
+  describe "news" do
+    it 'news' do
+      msg = EasyWeixin::Response.analysis_xml($text_xml)
+      if msg.Content == 'Hello2BizUser'
+        item1 = EasyWeixin::Item.new
+        item1.Title = 'title1'
+        item1.Description = 'blah'
+        item2 = EasyWeixin::Item.new
+        item2.Title = 'title2'
+        item2.Description = 'blah blah'
+        Articles = [item1, item2]
+        ArticleCount = Articles.size
+      end
+
+      puts EasyWeixin::Response.news_msg(msg.ToUserName, msg.FromUserName, Articles, ArticleCount)
+    end
+  end
+
+
+end

data/{spec → test}/test_xml.rb

@@ -14,4 +14,4 @@ $subscribe_xml = '<?xml version="1.0"?>
 	<MsgType><![CDATA[event]]></MsgType>
 	<Event><![CDATA[subscribe]]></Event>
 	<EventKey><![CDATA[]]></EventKey>
-</xml>'
+</xml>'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_weixin
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - menghuanwd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-18 00:00:00.000000000 Z
+date: 2015-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,7 +66,49 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: easy to use weixin.
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: create menu and reply message.
 email:
 - 651019063@qq.com
 executables: []
@@ -81,12 +123,19 @@ files:
 - Rakefile
 - easy_weixin.gemspec
 - lib/easy_weixin.rb
+- lib/easy_weixin/api.rb
 - lib/easy_weixin/auth.rb
-- lib/easy_weixin/model.rb
+- lib/easy_weixin/config.rb
+- lib/easy_weixin/menu.rb
+- lib/easy_weixin/message.rb
+- lib/easy_weixin/response.rb
 - lib/easy_weixin/version.rb
-- spec/auth_spec.rb
-- spec/reply_spec.rb
-- spec/test_xml.rb
+- test/menu.json
+- test/test_auth.rb
+- test/test_get_access_token.rb
+- test/test_menu.rb
+- test/test_response.rb
+- test/test_xml.rb
 homepage: https://github.com/menghuanwd/easy_weixin
 licenses:
 - MIT
@@ -110,8 +159,11 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: easy to use weixin.
+summary: easy to use weixin public api.
 test_files:
-- spec/auth_spec.rb
-- spec/reply_spec.rb
-- spec/test_xml.rb
+- test/menu.json
+- test/test_auth.rb
+- test/test_get_access_token.rb
+- test/test_menu.rb
+- test/test_response.rb
+- test/test_xml.rb

data/spec/auth_spec.rb

@@ -1,20 +0,0 @@
-require 'rspec'
-require 'digest/sha1'
-require 'easy_weixin/auth'
-describe "Weixin::Middleware" do
-
-	before(:all) do
-		@token = 'dave'
-		@timestamp = Time.now.to_i.to_s
-		@nonce = '123456'
-		@signature = Digest::SHA1.hexdigest( [@token, @timestamp, @nonce].sort.join )
-		@echostr = 'caishu'
-	end
-
-
-	it 'function check_valid' do
-		easy_weixin = EasyWeixin::Auth.new(@token, @timestamp, @nonce, @signature, @echostr)
-		easy_weixin.check_valid.should == @echostr
-	end
-
-end

data/spec/reply_spec.rb

@@ -1,54 +0,0 @@
-require 'rspec'
-require 'digest/sha1'
-require 'easy_weixin/model'
-require 'easy_weixin'
-require File.expand_path('../test_xml',__FILE__)
-
-describe "Weixin::Message" do
-	it 'is a text message' do
-		puts msg = EasyWeixin.analysis_xml($subscribe_xml)
-
-	  	case msg.MsgType
-		when 'text'
-		  # TextMessage.new(hash)
-		  puts EasyWeixin.text_msg(msg.ToUserName, msg.FromUserName, '我只是一个回复')
-		when 'image'
-		  # ImageMessage.new(hash)
-		when 'location'
-		  # LocationMessage.new(hash)
-		when 'link'
-		  # LinkMessage.new(hash)
-		when 'event'
-			if msg.Event == "subscribe"
-				puts EasyWeixin.text_msg(msg.ToUserName, msg.FromUserName, 'Hi 欢迎来到顾益峰的个人微信频道,能来到这里的，都是我的朋友，都是一家人，这里你可以很放松！回复joke，听个笑话.回复girl，会显示我的五个女性朋友.回复boy，会显示我的五个男性朋友,回复其他内容，有你意想不到的内容喔~')
-			else
-				puts EasyWeixin.text_msg(msg.ToUserName, msg.FromUserName, '你确定？')
-			end
-		when 'voice'
-		  # VoiceMessage.new(hash)
-		when 'video'
-		  # VideoMessage.new(hash)
-		else
-		  raise 'Unknown Message'
-		end
-	  
-	end
-
-	it 'is a news' do
-		puts msg = EasyWeixin::Message.factory($text_xml)
-
-		if msg.Content == 'Hello2BizUser'
-			item1 = EasyWeixin::Item.new
-			item1.Title = 'title1'
-			item1.Description = 'blah'
-			item2 = EasyWeixin::Item.new
-			item2.Title = 'title2'
-			item2.Description = 'blah blah'
-			Articles = [item1, item2]
-			ArticleCount = Articles.size
-		end
-
-    puts EasyWeixin.news_msg(msg.ToUserName, msg.FromUserName, Articles, ArticleCount)
-	end
-
-end