simple_wechat 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 591aedde5b021ee5731d6aedd92f03c2621e7c4a
+  data.tar.gz: 538ec9d8d5815e3c20369f13b4121927b7b4cbb8
+SHA512:
+  metadata.gz: 5df5d4e33cc32a02837a4e3f1e1bd15033568c575d6f182b9a7862783c89cd264b0ed30fc1d52c5ff7901b332348441ba5f99a7f47f174b8bc8ecd9511a8fdf4
+  data.tar.gz: edbd9f95b39606715251a4596a991174971118ee6e9f985bef06dee26b6b60418d7d9242c70d66d06989d1e5562531c888d0088e4753b325127f9d1c47f78c81

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/*.gem

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Yuan Cheung
+
+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,88 @@
+# SimpleWechat
+
+[![Build Status](https://travis-ci.org/zhangyuan/wechat.svg)](https://travis-ci.org/zhangyuan/wechat)
+
+Simple Wechat Api Wrapper.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_wechat'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wechat
+
+## Usage
+
+### Fetch access token
+
+```ruby
+client = SimpleWechat::Client.new("APPID", "APPSECRET")
+access_token = client.get_access_token  
+# access_token and expires_in are wrapped in access_token.
+```
+
+### Fetch jsapi ticket
+
+```ruby
+jsapi = SimpleWechat::JsApi.new
+ticket = jsapi.get_ticket("ACCESS_TOKEN")
+# ticket, errcode, errmsg, expires_in are wrapped in ticket.
+```
+
+### Get jsapi config
+
+```ruby
+ticket = "sM4AOVdWfPE4DxkXGEs8VMCPGGVi4C3VM0P37wVUCFvkVAy_90u5h9nbSlYy3-Sl-HhTdfl2fzFy1AOcHKP7qg"
+jsapi = SimpleWechat::JsApi.new
+config = jsapi.get_config(ticket, "http://wx.qq.com", "APPID", ["previewImage"])
+# now MultiJson.encode(config) can be passed into function wx.config() in javascript.
+```
+
+### OAuth
+
+OAuth part is borrowed from `wechat-auth_client` ( https://github.com/zhangyuan/wechat-auth_client ).
+
+> `REDIRECT_URL` should be configured in WeChat management system and route to callback action
+
+```ruby
+class SessionsController < ApplicationController
+  def auth
+    redirect_to auth_client.authorize_url(REDIRECT_URL, state)
+  end
+
+  def callback
+    if state == params[:state]
+      access_token = auth_client.get_token(params[:code])
+      # do something with access_token. 
+      # for example, call access_token.openid to get openid
+    end
+  end
+
+  private
+
+  def auth_client
+    @auth_client ||= SimpleWechat::Client.new(APP_ID, APP_SECRET).get_auth_client
+  end
+  
+  def state
+    session[:state] ||= SecureRandom.hex(3)
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/zhangyuan/wechat/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,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/simple_wechat.rb

@@ -0,0 +1,7 @@
+require "simple_wechat/version"
+require "simple_wechat/client"
+require "simple_wechat/jsapi"
+require "simple_wechat/auth_client"
+
+module SimpleWechat
+end

data/lib/simple_wechat/auth_client.rb

@@ -0,0 +1,40 @@
+require "cgi"
+
+module SimpleWechat
+  class AuthClient
+    class AccessToken
+      ATTRIBUTES = %w(access_token expires_in refresh_token openid scope errcode errmsg).freeze
+      attr_reader *ATTRIBUTES
+
+      def initialize(options = {})
+        ATTRIBUTES.each do |name|
+          instance_variable_set("@#{name}", options[name])
+        end
+      end
+    end
+
+    attr_reader :appid, :secret
+
+    def initialize(appid, secret)
+      @appid, @secret = appid, secret
+    end
+
+    def authorize_url(redirect_uri, state, options = {})
+      scope = options[:scope] ||= "snsapi_base"
+      "https://open.weixin.qq.com/connect/oauth2/authorize?appid=#{appid}&redirect_uri=#{CGI.escape redirect_uri}&response_type=code&scope=#{scope}&state=#{state}#wechat_redirect" 
+    end
+
+    def get_token(code)
+      response = connection.get("https://api.weixin.qq.com/sns/oauth2/access_token?appid=#{appid}&secret=#{secret}&code=#{code}&grant_type=authorization_code")
+      access_token = AccessToken.new MultiJson.load(response.body)
+    end
+
+    def connection
+      @connection ||= begin
+        conn = Faraday.new do |faraday|
+          faraday.adapter  Faraday.default_adapter
+        end 
+      end
+    end
+  end
+end

data/lib/simple_wechat/client.rb

@@ -0,0 +1,37 @@
+module SimpleWechat
+  class Client
+    class AccessToken
+      ATTRIBUTES = %W(access_token expires_in errcode errmsg).freeze
+      attr_reader *ATTRIBUTES
+
+      def initialize(options = {})
+        ATTRIBUTES.each do |name|
+          instance_variable_set("@#{name}", options[name])
+        end
+      end
+    end
+
+    attr_reader :appid, :secret
+
+    def initialize(appid, secret)
+      @appid, @secret = appid, secret  
+    end
+
+    def get_access_token
+      response = connection.get("https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=#{appid}&secret=#{secret}")
+      AccessToken.new MultiJson.load(response.body)
+    end
+
+    def get_auth_client
+      AuthClient.new(appid, secret)
+    end
+
+    def connection
+      @connection ||= begin
+                        conn = Faraday.new do |faraday|
+                          faraday.adapter  Faraday.default_adapter
+                        end
+                      end
+    end
+  end
+end

data/lib/simple_wechat/jsapi.rb

@@ -0,0 +1,52 @@
+module SimpleWechat
+  class JsApi
+    class Ticket
+      ATTRIBUTES = %W(errcode errmsg ticket expires_in).freeze
+      attr_reader *ATTRIBUTES
+
+      def initialize(options = {}) 
+        ATTRIBUTES.each do |name|
+          instance_variable_set("@#{name}", options[name])
+        end 
+      end 
+    end 
+
+    def get_ticket(access_token)
+      response = connection.get("https://api.weixin.qq.com/cgi-bin/ticket/getticket?access_token=#{access_token}&type=jsapi")
+      Ticket.new MultiJson.load(response.body)
+    end 
+
+    def sign(jsapi_ticket, noncestr, timestamp, url)
+      params = {
+        noncestr: noncestr,
+        timestamp: timestamp,
+        jsapi_ticket: jsapi_ticket,
+        url: url
+      }
+
+      text = params.keys.sort.map {|key| "#{key}=#{params[key]}"}.join('&')
+      
+      Digest::SHA1.hexdigest(text)
+    end
+
+    def get_config(jsapi_ticket, url, appid, api_list, options = {})
+      timestamp = (options[:timestamp] || Time.now).to_i
+      noncestr = options[:noncestr] || SecureRandom.hex(10)
+      signature = sign(jsapi_ticket, noncestr, timestamp, url)
+      {
+        appId: appid,
+        timestamp: timestamp,
+        signature: signature,
+        jsApiList: api_list
+      }
+    end
+
+    def connection
+      @connection ||= begin
+                        conn = Faraday.new do |faraday|
+                          faraday.adapter  Faraday.default_adapter
+                        end
+                      end
+    end
+  end 
+end

data/lib/simple_wechat/version.rb

@@ -0,0 +1,3 @@
+module SimpleWechat
+  VERSION = "0.0.1"
+end

data/simple_wechat.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_wechat/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_wechat"
+  spec.version       = SimpleWechat::VERSION
+  spec.authors       = ["Yuan Cheung"]
+  spec.email         = ["advanimal@gmail.com"]
+  spec.summary       = %q{Simple WeChat API wrapper}
+  spec.homepage      = "https://github.com/zhangyuan/wechat"
+  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_runtime_dependency "faraday", "~> 0.9"
+  spec.add_runtime_dependency "multi_json", "~> 1.2"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 1.18"
+end

data/spec/simple_wechat/auth_client_spec.rb

@@ -0,0 +1,52 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+RSpec.describe SimpleWechat::AuthClient do
+  it 'should generate authorize_url' do
+    client = SimpleWechat::Client.new("theappid", "thesecret").get_auth_client
+    authorize_url = client.authorize_url("http://example.com/wechat", "999")
+    expected_url = "https://open.weixin.qq.com/connect/oauth2/authorize?appid=theappid&redirect_uri=http%3A%2F%2Fexample.com%2Fwechat&response_type=code&scope=snsapi_base&state=999#wechat_redirect" 
+    expect(authorize_url).to eq(expected_url)
+  end
+
+  context "correct params" do
+    it 'should get token' do
+      client = SimpleWechat::AuthClient.new("theappid", "thesecret")
+      body = %q(
+      {
+        "access_token":"ACCESS_TOKEN",
+        "expires_in":7200,
+        "refresh_token":"REFRESH_TOKEN",
+        "openid":"OPENID",
+        "scope":"SCOPE"
+      }
+      )
+      stub_request(:get, "https://api.weixin.qq.com/sns/oauth2/access_token?appid=#{client.appid}&secret=#{client.secret}&code=thecode&grant_type=authorization_code").to_return(body: body)
+
+      access_token = client.get_token("thecode")
+      
+      expect(access_token.access_token).to eq("ACCESS_TOKEN")
+      expect(access_token.expires_in).to eq(7200)
+      expect(access_token.refresh_token).to eq("REFRESH_TOKEN")
+      expect(access_token.openid).to eq("OPENID")
+      expect(access_token.scope).to eq("SCOPE")
+    end
+  end
+
+  context "invalid params" do
+    it 'should get error' do
+      client = SimpleWechat::AuthClient.new("theappid", "thesecret")
+      body = %q(
+      {
+        "errcode": 40029,
+        "errmsg": "invalid code"
+      }
+      )
+      stub_request(:get, "https://api.weixin.qq.com/sns/oauth2/access_token?appid=#{client.appid}&secret=#{client.secret}&code=thecode&grant_type=authorization_code").to_return(body: body)
+
+      access_token = client.get_token("thecode")
+      
+      expect(access_token.errcode).to eq(40029)
+      expect(access_token.errmsg).to eq("invalid code")
+    end
+  end
+end

data/spec/simple_wechat/client_spec.rb

@@ -0,0 +1,32 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+describe "client" do
+  describe "access token" do
+    it "get access token" do
+      client = SimpleWechat::Client.new("APPID", "APPSECRET")
+
+      body = %Q({"access_token":"ACCESS_TOKEN", "expires_in":7200})
+      stub_request(:get, "https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=APPID&secret=APPSECRET").to_return(body: body)
+
+      access_token = client.get_access_token
+
+      expect(access_token).not_to be_nil
+      expect(access_token.access_token).to eq("ACCESS_TOKEN")
+      expect(access_token.expires_in).to eq(7200)
+    end
+
+    it "get error code and msg if get error from response" do
+      client = SimpleWechat::Client.new("APPID", "APPSECRET")
+
+      body = %Q({"errcode":40013,"errmsg":"invalid appid"})
+      stub_request(:get, "https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=APPID&secret=APPSECRET").to_return(body: body)
+
+      access_token = client.get_access_token
+
+      expect(access_token).not_to be_nil
+      expect(access_token.access_token).to be_nil
+      expect(access_token.errcode).to eq(40013)
+      expect(access_token.errmsg).to eq("invalid appid")
+    end
+  end
+end

data/spec/simple_wechat/jsapi_ticket_spec.rb

@@ -0,0 +1,40 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+describe 'jsapi ticket' do
+  it 'gets ticket by access token' do
+    body = %Q({"errcode":0,"errmsg":"ok","ticket":"bxLdikRXVbTPdHSM05e5u5sUoXNKd8-41ZO3MhKoyN5OfkWITDGgnr2fwJ0m9E8NYzWKVZvdVtaUgWvsdshFKA","expires_in":7200})
+
+    stub_request(:get, "https://api.weixin.qq.com/cgi-bin/ticket/getticket?access_token=ACCESS_TOKEN&type=jsapi").to_return(body: body)
+
+    jsapi = SimpleWechat::JsApi.new
+
+    ticket = jsapi.get_ticket("ACCESS_TOKEN")
+
+    expect(ticket).not_to be_nil
+    expect(ticket.errcode).to eq(0)
+    expect(ticket.errmsg).to eq("ok")
+    expect(ticket.ticket).to eq("bxLdikRXVbTPdHSM05e5u5sUoXNKd8-41ZO3MhKoyN5OfkWITDGgnr2fwJ0m9E8NYzWKVZvdVtaUgWvsdshFKA")
+    expect(ticket.expires_in).to eq(7200)
+  end
+
+  it "signs params with ticket" do
+    ticket = "sM4AOVdWfPE4DxkXGEs8VMCPGGVi4C3VM0P37wVUCFvkVAy_90u5h9nbSlYy3-Sl-HhTdfl2fzFy1AOcHKP7qg"
+    jsapi = SimpleWechat::JsApi.new
+
+    signature = jsapi.sign(ticket, "Wm3WZYTPz0wzccnW", "1414587457", "http://mp.weixin.qq.com")
+
+    expect(signature).to eq("f4d90daf4b3bca3078ab155816175ba34c443a7b")
+  end
+
+  it 'gets config' do
+    ticket = "sM4AOVdWfPE4DxkXGEs8VMCPGGVi4C3VM0P37wVUCFvkVAy_90u5h9nbSlYy3-Sl-HhTdfl2fzFy1AOcHKP7qg"
+    jsapi = SimpleWechat::JsApi.new
+
+    allow(Time).to receive(:now).and_return(Time.new(2010,1,1, 11, 00, 00, "+00:00"))
+    allow(SecureRandom).to receive(:hex).and_return("63828a411458c5455a4c")
+
+    config = jsapi.get_config(ticket, "http://wx.qq.com", "APPID", ["previewImage"])
+
+    expect(MultiJson.encode(config)).to eq(%Q({"appId":"APPID","timestamp":1262343600,"signature":"bac3e183806b8e69743c8583221fd7712dd93175","jsApiList":["previewImage"]}))
+    end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+
+require 'rubygems'
+require "bundler"
+require 'bundler/setup'
+
+Bundler.require
+
+require "faraday"
+require "multi_json"
+
+require 'webmock/rspec'

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: simple_wechat
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yuan Cheung
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !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: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+description: 
+email:
+- advanimal@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simple_wechat.rb
+- lib/simple_wechat/auth_client.rb
+- lib/simple_wechat/client.rb
+- lib/simple_wechat/jsapi.rb
+- lib/simple_wechat/version.rb
+- simple_wechat.gemspec
+- spec/simple_wechat/auth_client_spec.rb
+- spec/simple_wechat/client_spec.rb
+- spec/simple_wechat/jsapi_ticket_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/zhangyuan/wechat
+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: Simple WeChat API wrapper
+test_files:
+- spec/simple_wechat/auth_client_spec.rb
+- spec/simple_wechat/client_spec.rb
+- spec/simple_wechat/jsapi_ticket_spec.rb
+- spec/spec_helper.rb