wechat-adapter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dbe7b615dc12a98bdf144643ffd9a7f5178b7f10
+  data.tar.gz: 827227a345b0ee939f99be0044a0e987d88d087f
+SHA512:
+  metadata.gz: 334bdfb49fb251899d547ff59f2e18327bab65ed0ab0f2aa191fc6420be6d0223a2e56e31248583de9b7cc399d3b84feb1dc4a08b2a887f87abc1bb1d1746047
+  data.tar.gz: 6291907a4c85f9d3c8201b7fccb9fafda56ba08634d2787e036b859d88be837d6d635656bb72b5a209ef8ac51ed7fee0c6474e341f96872021e99da99ef22363

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,22 @@
+*.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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - "2.0.0"
+  - "2.1.0"
+
+script: 'bundle exec rake'

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wechat-adapter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Lu, Jun
+
+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,41 @@
+# Wechat::Adapter
+
+[![Build Status](https://travis-ci.org/luj1985/wechat-adapter.svg?branch=master)](https://travis-ci.org/luj1985/wechat-adapter)
+[![Gem Version](https://badge.fury.io/rb/wechat-adapter.svg)](http://badge.fury.io/rb/wechat-adapter)
+[![Coverage Status](https://coveralls.io/repos/luj1985/wechat-adapter/badge.png)](https://coveralls.io/r/luj1985/wechat-adapter)
+
+A wrapper for Tencent Wechat JSON API, currently only "menu" operation are tested, others should work also.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'wechat-adapter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wechat-adapter
+
+## Usage
+
+```ruby
+require 'wechat/adapter'
+
+appid = "wxb3fae34df644fbf7"
+appsecret = "d0aae6a89949c8c789068397f9e1c59c"
+api = WechatAPI.new(appid, appsecret)
+
+api.get 'menu/get'
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/wechat-adapter/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'documentation']
+end
+
+task :default => :spec

data/lib/wechat/adapter/version.rb

@@ -0,0 +1,5 @@
+module Wechat
+  module Adapter
+    VERSION = "0.0.1"
+  end
+end

data/lib/wechat/adapter/wechatapi.rb

@@ -0,0 +1,70 @@
+require 'restclient'
+
+module Wechat
+  module Adapter
+    class TokenExpiredError < StandardError; end
+
+    class ResponseError < StandardError
+      attr_reader :error_code
+      def initialize(code, message)
+        error_code = code
+        super "#{code} (#{message})"
+      end
+    end
+
+    class WechatAPI
+      def initialize appid, appsecret, base = 'https://api.weixin.qq.com/cgi-bin'
+        @appid, @appsecret, @base = appid, appsecret, base
+      end
+
+      def handle_err_response values
+        code = values["errcode"]
+        return if code == 0
+        raise TokenExpiredError if [42001, 40014].include? code
+        raise ResponseError.new(code, values['errmsg'])
+      end
+
+      def raw_json_request method, path, params = {}, payload = nil
+        params[:access_token] = @access_token if @access_token
+        url = "#{@base}/#{path}"
+
+        response = ::RestClient::Request.execute(
+          :method => method, 
+          :url => url, 
+          :headers => { :params => params }, 
+          :payload => (payload.to_json if payload),
+          :content_type => :json)
+
+        values = JSON.parse(response.body)
+        values["errcode"] ? handle_err_response(values) : values
+      end
+
+      def json_request *args, &block
+        begin
+          aquire_access_token unless @access_token
+          response = raw_json_request *args, &block
+        rescue TokenExpiredError
+          aquire_access_token
+          retry
+        end
+      end
+
+      def aquire_access_token
+        values = raw_json_request :get, 'token', { 
+          :grant_type => 'client_credential',
+          :appid => @appid,
+          :secret => @appsecret
+        }
+        @access_token = values["access_token"]
+      end
+
+      def post path, options = {}, payload = nil
+        json_request(:post, path, options, payload)
+      end
+
+      def get path, options = {}
+        json_request(:get, path, options)
+      end
+    end
+  end
+end

data/lib/wechat/adapter.rb

@@ -0,0 +1,8 @@
+require "wechat/adapter/version"
+require "wechat/adapter/wechatapi"
+
+module Wechat
+  module Adapter
+    # Your code goes here...
+  end
+end

data/spec/adapter_spec.rb

@@ -0,0 +1,111 @@
+require_relative 'spec_helper'
+
+describe Wechat::Adapter do
+  access_token = "jDBx_Q_ClVPDCxgcqdzVdf4GqiWlW3xhxphm2VIszvpsPKVZextLULiZKWX5OMAozhW6kxvBB7Z7DKiv5qRF6A"
+  appid = "wxb3fae34df644fbf7"
+  appsecret = "d0aae6a89949c8c789068397f9e1c59c"
+  base_url = "https://api.weixin.qq.com/cgi-bin"
+  wechat_menu = {
+    :button => [
+      { :type => "click", :name => "今日歌曲", :key  => "V1001_TODAY_MUSIC", :sub_button => [] }, 
+      { :type => "click", :name => "歌手简介", :key  => "V1001_TODAY_SINGER", :sub_button => [] }, 
+      { :name => "菜单", :sub_button => [
+        { :type => "view", :name => "搜索",  :url => "http://www.soso.com/", :sub_button => [] }, 
+        { :type => "view", :name => "视频",  :url => "http://v.qq.com/", :sub_button => [] }, 
+        { :type => "click", :name => "赞一下我们", :key => "V1001_GOOD", :sub_button => []
+      }]
+    }]
+  }
+
+  let (:client) { RestClient::Request = double }
+  let (:app) { Wechat::Adapter::WechatAPI.new(appid, appsecret, base_url)}
+  
+  it "should be able to get access token" do
+
+    access_token_response = double
+    allow(access_token_response).to receive(:body).and_return({ :access_token => access_token, :expires_in => 7200}.to_json)
+    allow(client).to receive(:execute) { access_token_response }
+    expect(app.aquire_access_token).to eq(access_token)
+  end
+
+  it "should be able to get menu token" do
+    access_token_response = double
+    allow(access_token_response).to receive(:body).and_return({:access_token => access_token, :expires_in => 7200}.to_json)
+    
+    menu_get_response = double
+    allow(menu_get_response).to receive(:body).and_return({:menu => wechat_menu}.to_json)
+
+    access_token_retrieve_method = double
+    expect(access_token_retrieve_method).to receive(:invoke).once
+
+    menu_retrieve_method = double
+    expect(menu_retrieve_method).to receive(:invoke).exactly(10).times
+
+    allow(client).to receive(:execute) do |args|
+      case args[:url]
+      when "https://api.weixin.qq.com/cgi-bin/token" then
+        expect(args[:method]).to eq(:get)
+        params = args[:headers][:params]
+        expect(params[:grant_type]).to eq("client_credential")
+        expect(params[:appid]).to eq(appid)
+        expect(params[:secret]).to eq(appsecret)
+        access_token_retrieve_method.send(:invoke)
+        access_token_response
+      when "https://api.weixin.qq.com/cgi-bin/menu/get" then
+        expect(args[:method]).to eq(:get)
+        params = args[:headers][:params]
+        expect(params[:access_token]).to eq(access_token)
+        menu_retrieve_method.send(:invoke)
+        menu_get_response
+      else fail
+      end
+    end
+
+    10.times {
+      app.get 'menu/get'
+    }
+  end
+
+  it "should be able to delete menu" do
+    access_token_response = double
+    allow(access_token_response).to receive(:body).and_return({:access_token => access_token, :expires_in => 7200}.to_json)
+    
+    menu_delete_response = double
+    allow(menu_delete_response).to receive(:body).and_return({:errcode => 0, :errmsg => "ok"}.to_json)
+
+    allow(client).to receive(:execute) do |args|
+      case args[:url]
+      when "https://api.weixin.qq.com/cgi-bin/token" then access_token_response
+      when "https://api.weixin.qq.com/cgi-bin/menu/delete" then
+        expect(args[:method]).to eq(:get)
+        params = args[:headers][:params]
+        expect(params[:access_token]).to eq(access_token)
+        menu_delete_response
+      else fail
+      end
+    end
+    app.get 'menu/delete'
+  end
+
+  it "should be able to create menu" do
+    access_token_response = double
+    allow(access_token_response).to receive(:body).and_return({:access_token => access_token, :expires_in => 7200}.to_json)
+    
+    menu_create_response = double
+    allow(menu_create_response).to receive(:body).and_return({:errcode => 0, :errmsg => "ok"}.to_json)
+
+    allow(client).to receive(:execute) do |args|
+      case args[:url]
+      when "https://api.weixin.qq.com/cgi-bin/token" then access_token_response
+      when "https://api.weixin.qq.com/cgi-bin/menu/create" then
+        expect(args[:method]).to eq(:post)
+        params = args[:headers][:params]
+        expect(params[:access_token]).to eq(access_token)
+        expect(args[:payload]).to eq(wechat_menu.to_json)
+        menu_create_response
+      else fail
+      end
+    end
+    app.post 'menu/create', {}, wechat_menu
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'wechat/adapter'

data/wechat-adapter.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wechat/adapter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wechat-adapter"
+  spec.version       = Wechat::Adapter::VERSION
+  spec.authors       = ["Lu, Jun"]
+  spec.email         = ["luj1985@gmail.com"]
+  spec.summary       = "Communicate with Tencent wechat API"
+  spec.description   = "Use HTTP protocol to communicate with wechat API"
+  spec.homepage      = "http://github.com/luj1985/wechat-adapter"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rest-client"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-mocks"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: wechat-adapter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Lu, Jun
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: rspec-mocks
+  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: Use HTTP protocol to communicate with wechat API
+email:
+- luj1985@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/wechat/adapter.rb
+- lib/wechat/adapter/version.rb
+- lib/wechat/adapter/wechatapi.rb
+- spec/adapter_spec.rb
+- spec/spec_helper.rb
+- wechat-adapter.gemspec
+homepage: http://github.com/luj1985/wechat-adapter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Communicate with Tencent wechat API
+test_files:
+- spec/adapter_spec.rb
+- spec/spec_helper.rb