wechat-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 15ac3fb9d0cc42e4c68c0ec5735ebecc931fb5e2
+  data.tar.gz: 12e850d08d683026d0fd835210e3a098316fe7bc
+SHA512:
+  metadata.gz: 40bd671ea3f24e6de3ca06c838fadbb0314f53eaab1fc8b8fbcec3fb5a9439fae97ef2875ac865d08ccdd1d51a9d70fff46ff2fba0faf6db41565dea84ee5192
+  data.tar.gz: ed62e611850637e810d75c21ffdc2ca9a4da40cf17bb79c94286628210dd236bb411b38971557ed9954f8b79028ba90a427d7416bb410a93e4dfbe19d146ec6b

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+pkg

data/.rspec

@@ -0,0 +1 @@
+--color --format doc

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - ruby-head
+  - 2.1.0
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,9 @@
+source 'http://ruby.taobao.org'
+# Specify your gem's dependencies in ucpaas.gemspec
+gemspec
+
+group :development do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'rspec-its'
+end

data/Guardfile

@@ -0,0 +1,11 @@
+guard 'rspec', cmd: "bundle exec rspec" do
+  # watch /lib/ files
+  watch(%r{^lib/(.+).rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+ 
+  # watch /spec/ files
+  watch(%r{^spec/(.+).rb$}) do |m|
+    "spec/#{m[1]}.rb"
+  end
+end

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/wechat-api.rb

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

data/lib/wechat/api.rb

@@ -0,0 +1,8 @@
+require 'wechat/api/client'
+
+#
+module Wechat
+  #
+  module Api
+  end
+end

data/lib/wechat/api/client.rb

@@ -0,0 +1,124 @@
+require 'multi_json'
+require 'wechat/api/message'
+require 'wechat/api/user'
+require 'wechat/api/util'
+require 'faraday'
+require 'logger'
+
+module Wechat
+  module Api
+    #
+    class ResponseError < StandardError; end
+    class AccessTokenExpiredError < ResponseError; end
+    #
+    class Client
+      include Message
+      include User
+      include Util
+
+      API_BASE = 'https://api.weixin.qq.com/cgi-bin/'
+
+      attr_reader :app_id, :secret
+      attr_accessor :logger
+
+      def initialize(app_id, secret)
+        @app_id, @secret = app_id, secret
+        @logger = Logger.new(STDOUT)
+        @token_file = File.join('/tmp', "wechat-api-#{app_id}")
+      end
+
+      def access_token
+        @access_token ||= begin
+          token = MultiJson.load(File.read(@token_file))
+          token['access_token']
+        rescue
+          refresh
+        end
+      end
+
+      def refresh
+        logger.debug { 'refresh token' }
+        url = format('%stoken', API_BASE)
+        resp = connection.get(url, token_params)
+        response = MultiJson.load(resp.body)
+        return handle_error(response) if response['errcode']
+        token = response['access_token']
+        File.open(@token_file, 'w') { |f| f.write(resp.body) } if token
+        token
+      end
+
+      def get(uri, params = {})
+        with_access_token(uri, params) do |url, params_with_token|
+          debug_request do
+            connection.get do |req|
+              req.url url, params_with_token
+              req.headers[:accept] = 'application/json'
+              req.headers[:content_type] = 'application/json'
+            end
+          end
+        end
+      end
+
+      def post(uri, data = {})
+        with_access_token(uri, {}) do |url, params|
+          debug_request do
+            connection.post do |req|
+              req.url url, params
+              req.headers[:accept] = 'application/json'
+              req.headers[:content_type] = 'application/json'
+              req.body = MultiJson.dump(data)
+            end
+          end
+        end
+      end
+
+      def with_access_token(uri, params, tried = 2)
+        url = format('%s%s', API_BASE, uri)
+        begin
+          resp = yield(url, params.merge(access_token: access_token))
+          response = MultiJson.load(resp.body)
+          handle_error(response)
+        rescue AccessTokenExpiredError => e
+          refresh
+          retry unless (tried -= 1).zero?
+          raise e
+        end
+      end
+
+      private
+
+      def debug_request
+        response = yield
+        logger.debug { response }
+        response
+      end
+
+      def handle_error(response)
+        case response['errcode']
+        when 0, nil
+          response
+        when 40_001, 42_001, 40_014
+          fail AccessTokenExpiredError, response
+        else
+          fail ResponseError, response
+        end
+      end
+
+      def token_params
+        {
+          grant_type: 'client_credential',
+          appid: app_id,
+          secret: secret
+        }
+      end
+
+      def connection
+        @connection ||= begin
+          Faraday.new do |faraday|
+            faraday.adapter Faraday.default_adapter
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wechat/api/message.rb

@@ -0,0 +1,16 @@
+module Wechat
+  module Api
+    #
+    module Message
+      def send_template(tmp_id, openid, url, data = {})
+        params = {
+          touser: openid,
+          template_id: tmp_id,
+          url: url,
+          data: data
+        }
+        post 'message/template/send', params
+      end
+    end
+  end
+end

data/lib/wechat/api/user.rb

@@ -0,0 +1,10 @@
+module Wechat
+  module Api
+    #
+    module User
+      def user_info(openid, lang = 'zh_CN')
+        get 'user/info', openid: openid, lang: lang
+      end
+    end
+  end
+end

data/lib/wechat/api/util.rb

@@ -0,0 +1,32 @@
+module Wechat
+  module Api
+    #
+    module Util
+      def create_qrcode_temp(scene_id, expire_seconds = 60_480)
+        params = {
+          action_name: 'QR_SCENE',
+          expire_seconds: expire_seconds,
+          action_info: {
+            scene: {
+              scene_id: scene_id
+            }
+          }
+        }
+        post 'qrcode/create', params
+      end
+
+      def create_qrcode(scene_str)
+        params = {
+          action_name: 'QR_LIMIT_STR_SCENE',
+          action_info: {
+            scene: {
+              scene_str: scene_str
+            }
+          }
+        }
+
+        post 'qrcode/create', params
+      end
+    end
+  end
+end

data/lib/wechat/api/version.rb

@@ -0,0 +1,7 @@
+#
+module Wechat
+  #
+  module Api
+    VERSION = '0.1.0'
+  end
+end

data/spec/spec_helper.rb

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

data/spec/wechat/api/client_spec.rb

@@ -0,0 +1,53 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+RSpec.describe Wechat::Api::Client do
+  subject { described_class.new('APPID', 'APPSECRET') }
+
+  before do
+    subject.logger.level = Logger::DEBUG
+  end
+
+  it :refresh do
+    token_body = '{"access_token":"ACCESS_TOKEN","expires_in":7200}'
+    stub_request(:get, /token/).to_return(body: token_body)
+    expect(subject.refresh).not_to be_nil
+  end
+
+  it :refresh_error do
+    token_body = '{"errcode": 40013}'
+    stub_request(:get, /token/).to_return(body: token_body)
+    expect { subject.refresh }.to raise_error(Wechat::Api::ResponseError)
+  end
+
+  it :refresh_token_error do
+    token_body = '{"errcode": 40001}'
+    stub_request(:get, /token/).to_return(body: token_body)
+    expect { subject.refresh }
+      .to raise_error(Wechat::Api::AccessTokenExpiredError)
+  end
+
+  it :access_token do
+    token_body = '{"access_token":"ACCESS_TOKEN","expires_in":7200}'
+    expect(File).to receive(:read).and_return(token_body)
+    expect(subject.access_token).to eq('ACCESS_TOKEN')
+  end
+
+  it :get_twice do
+    expect(subject).to receive(:access_token).twice.and_return('Token')
+    expect(subject).to receive(:refresh).and_return('Token')
+    stub_request(:get, /some/)
+      .with(query: { access_token: 'Token' })
+      .to_return(body: '{"errcode": 40001}').then
+      .to_return(body: '{}')
+    subject.get 'some'
+  end
+
+  it :post do
+    expect(subject).to receive(:access_token).and_return('Token')
+    stub_request(:post, /some/)
+      .with(query: { access_token: 'Token' })
+      .to_return(body: '{}')
+
+    subject.post 'some', '{}'
+  end
+end

data/wechat-api.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/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wechat-api"
+  spec.version       = Wechat::Api::VERSION
+  spec.authors       = ["Ryan Wong"]
+  spec.email         = ["lazing@gmail.com"]
+  spec.summary       = %q{Wechat API wrapper}
+  spec.homepage      = "https://github.com/lazing/wechat-api"
+  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"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 1.18"
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: wechat-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryan Wong
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-24 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: pry
+  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: '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:
+- lazing@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- Rakefile
+- lib/wechat-api.rb
+- lib/wechat/api.rb
+- lib/wechat/api/client.rb
+- lib/wechat/api/message.rb
+- lib/wechat/api/user.rb
+- lib/wechat/api/util.rb
+- lib/wechat/api/version.rb
+- spec/spec_helper.rb
+- spec/wechat/api/client_spec.rb
+- wechat-api.gemspec
+homepage: https://github.com/lazing/wechat-api
+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: Wechat API wrapper
+test_files:
+- spec/spec_helper.rb
+- spec/wechat/api/client_spec.rb
+has_rdoc: