wechat-api 0.2.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6d5004c2f463eb0b4f3bdbdc7011e9bc1424c8de
-  data.tar.gz: 7e1e9ff5632c305ee2e3589085c7a0912b44dbff
+SHA256:
+  metadata.gz: 761fc67b404a0484aa97ed60b2c77f915c9c39ec3f9d57c37fed05049ac4dbad
+  data.tar.gz: addbff9065f1cd426bf13bc7a1cb56a6b4b598be49342ae204847af2f7873359
 SHA512:
-  metadata.gz: ecf554acceb4735dd74191f9b461b84c8314a7b3401d43e6e481af9dd3e4707099551725421f354013e2afd0ac1c0a16d9e192a4180b956063779329aead4529
-  data.tar.gz: 5cd2529274cac2084aa95c2de52f01d36411d103d3cf38c80b3572929105d562b3617ef9bd825e6300da6168f6ef6424968d7cfded809ac15e082bde14b6f4a8
+  metadata.gz: e88647dfffae7e124d68126675ff03c86f3a8b6dfaa7fc3d17834d99f4a027898ebf3fe45ed6f18ec237a5b54203cc02a0fcd38008abb481b8c1bc2eb98fd738
+  data.tar.gz: 65815dfb44f9b412242f651e0a567cd4e7cb8d66a9550c594fc843b03cc005d41feafd19248f4789c70ccbe942e744b9941137c253ddbb5899ef9d60b541ce42

data/.gitignore

@@ -1,2 +1,3 @@
 Gemfile.lock
 pkg
+.DS_Store

data/Gemfile

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

data/README.md

@@ -4,8 +4,7 @@ https://github.com/lazing/wechat-api
 
 用于微信 api 调用（非服务端推送信息）的处理。
 
-[![Circle CI](https://circleci.com/gh/lazing/wechat-api.svg?style=svg)](https://circleci.com/gh/lazing/wechat-api)
-[![Gem Version](https://badge.fury.io/rb/wechat-api.svg)](http://badge.fury.io/rb/ucpaas)
+[![Gem Version](https://badge.fury.io/rb/wechat-api.svg)](http://badge.fury.io/rb/wechat-api)
 
 常见的应用场景如：
 * 获取关注用户

data/lib/wechat-api.rb

@@ -1,3 +1,2 @@
 require 'wechat/api'
-require 'wechat/pay'
 require 'wechat/qy'

data/lib/wechat/api.rb

@@ -4,5 +4,18 @@ require 'wechat/api/client'
 module Wechat
   #
   module Api
+    class Error < StandardError; end
+    
+    def self.client(appid = 'origin_id')
+      var = "@_client_#{appid}"
+      if instance_variable_defined?(var)
+        instance_variable_get(var)
+      elsif block_given?
+        c = yield(Client)
+        instance_variable_set var, c
+      else
+        raise Error, :not_initialized
+      end
+    end
   end
 end

data/lib/wechat/api/client.rb

@@ -2,6 +2,7 @@ require 'multi_json'
 require 'wechat/api/message'
 require 'wechat/api/user'
 require 'wechat/api/util'
+require 'wechat/api/js_ticket'
 require 'faraday'
 require 'logger'
 
@@ -18,12 +19,13 @@ module Wechat
 
       API_BASE = 'https://api.weixin.qq.com/cgi-bin/'
 
-      attr_reader :app_id, :secret
-      attr_accessor :logger
+      attr_reader :app_id, :secret, :ticket
+      attr_accessor :logger, :site
 
       def initialize(app_id, secret)
         @app_id, @secret = app_id, secret
         @logger = Logger.new(STDOUT)
+        @ticket = JsTicket.new self
         @token_file = File.join('/tmp', "wechat-api-#{app_id}")
       end
 
@@ -37,10 +39,11 @@ module Wechat
       end
 
       def refresh
-        url = format('%stoken', API_BASE)
+        url = format('%stoken', base_url)
         resp = connection.get(url, token_params)
         response = MultiJson.load(resp.body)
         return handle_error(response) if response['errcode']
+
         @access_token = response['access_token']
         File.open(@token_file, 'w') { |f| f.write(resp.body) } if @access_token
         @access_token
@@ -72,9 +75,11 @@ module Wechat
       end
 
       def with_access_token(uri, params, tried = 2)
-        url = format('%s%s', API_BASE, uri)
+        url = format('%s%s', base_url, uri)
         begin
           resp = yield(url, params.merge(access_token: access_token))
+          raise ResponseError, resp unless resp.success?
+
           response = MultiJson.load(resp.body)
           handle_error(response)
         rescue AccessTokenExpiredError => e
@@ -86,6 +91,10 @@ module Wechat
 
       private
 
+      def base_url
+        site || API_BASE
+      end
+
       def debug_request
         response = yield
         logger.debug { response }
@@ -97,9 +106,9 @@ module Wechat
         when 0, nil
           response
         when 40_001, 42_001, 40_014
-          fail AccessTokenExpiredError, response
+          raise AccessTokenExpiredError, response
         else
-          fail ResponseError, response
+          raise ResponseError, response
         end
       end
 

data/lib/wechat/api/js_ticket.rb

@@ -0,0 +1,22 @@
+module Wechat
+  module Api
+
+    class JsTicket
+      attr_reader :client, :ticket, :expires_at
+      def initialize(client)
+        @client = client
+      end
+
+      def refresh
+        js = client.js_ticket
+        @ticket = js['ticket']
+        @expires_at = DateTime.now + Rational(js['expires_in'].to_i, 3600 * 24)
+        self
+      end
+
+      def expired?
+        expires_at.nil? || DateTime.now > expires_at
+      end
+    end
+  end
+end

data/lib/wechat/api/util.rb

@@ -1,3 +1,6 @@
+require 'securerandom'
+require 'digest/sha1'
+
 module Wechat
   module Api
     #
@@ -29,8 +32,24 @@ module Wechat
       end
 
       def js_ticket
-        res = get 'ticket/getticket', type: :jsapi
-        res['ticket']
+        get 'ticket/getticket', type: :jsapi
+      end
+
+      def sign(params)
+        str = params.to_a.sort.map { |p| p.join('=') }.join('&')
+        logger.debug { "to_sign: #{str}" }
+        Digest::SHA1.hexdigest str
+      end
+
+      def js_config(url: nil)
+        r = ticket.tap { |j| j.refresh if j.expired? }.ticket
+        nonce = SecureRandom.hex
+        timestamp = Time.now.to_i
+        signature = sign(noncestr: nonce, timestamp: timestamp, jsapi_ticket: r, url: url)
+        {
+          appId: app_id, timestamp: timestamp, nonceStr: nonce,
+          signature: signature
+        }.tap { |hash| logger.debug { "js_config: #{hash}, url: #{url}" } }
       end
     end
   end

data/lib/wechat/api/version.rb

@@ -2,6 +2,6 @@
 module Wechat
   #
   module Api
-    VERSION = '0.2.0'
+    VERSION = '0.4.2'.freeze
   end
 end

data/spec/wechat/api/js_ticket_spec.rb

@@ -0,0 +1,18 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+RSpec.describe Wechat::Api::JsTicket do
+
+  let(:client) { double(:client) }
+  subject do
+    Wechat::Api::JsTicket.new client
+  end
+
+  it :refresh do
+    allow(client).to receive(:js_ticket).and_return('expires_in'=> 7200, 'ticket'=> 'bxLdikRXVbTPdHSM05e5u5sUoXNKd8-41ZO3MhKoyN5OfkWITDGgnr2fwJ0m9E8NYzWKVZvdVtaUgWvsdshFKA')
+    subject.refresh
+    expect(subject.ticket).not_to be_nil
+    should_not be_expired
+    expect(subject.expires_at).to be_a(Date)
+  end
+
+end

data/spec/wechat/api/util_spec.rb

@@ -0,0 +1,19 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+RSpec.describe Wechat::Api::Util do
+  subject { Wechat::Api::Client.new('APPID', 'APPSECRET') }
+
+  before do
+    subject.logger.level = Logger::DEBUG
+  end
+
+  it :js_config do
+    allow(SecureRandom).to receive(:hex).and_return('Wm3WZYTPz0wzccnW')
+    allow_any_instance_of(Time).to receive(:to_i).and_return(1414587457)
+    allow(subject).to receive(:js_ticket).and_return('expires_in' => 7200, 'ticket' => 'sM4AOVdWfPE4DxkXGEs8VMCPGGVi4C3VM0P37wVUCFvkVAy_90u5h9nbSlYy3-Sl-HhTdfl2fzFy1AOcHKP7qg')
+    js = subject.js_config(url: 'http://mp.weixin.qq.com?params=value')
+    expect(js).not_to be_nil
+    expect(js).to include(signature: '0f9de62fce790f9a083d5c99e95740ceb90c27ed')
+    expect(js).to have_key :appId
+  end
+end

data/wechat-api.gemspec

@@ -13,18 +13,19 @@ Gem::Specification.new do |spec|
   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 "rest-client", ">= 1.7.0"
-  spec.add_runtime_dependency "multi_json", ">= 1.2"
-  spec.add_runtime_dependency 'gyoku', '>= 1.0.0'
-  spec.add_runtime_dependency 'nori'
-  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"
+  spec.add_runtime_dependency 'faraday', '~> 1.0'
+  spec.add_runtime_dependency 'multi_json', '~> 1.0'
+  spec.add_runtime_dependency 'oj', '~>3.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.0'
+  spec.add_development_dependency 'guard', '~> 2.0'
+  spec.add_development_dependency 'guard-rspec', '~> 4.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-its', '~> 1.0'
+  spec.add_development_dependency 'webmock', '~> 3.0'
+  
 end

metadata

@@ -1,156 +1,156 @@
 --- !ruby/object:Gem::Specification
 name: wechat-api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Ryan Wong
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-02-13 00:00:00.000000000 Z
+date: 2021-01-21 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'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: gyoku
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :runtime
+        version: '1.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: nori
+  name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: '2.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.18'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.18'
-description: 
+        version: '3.0'
+description:
 email:
 - lazing@gmail.com
 executables: []
@@ -159,7 +159,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Gemfile
 - Guardfile
 - README.md
@@ -167,25 +166,24 @@ files:
 - lib/wechat-api.rb
 - lib/wechat/api.rb
 - lib/wechat/api/client.rb
+- lib/wechat/api/js_ticket.rb
 - lib/wechat/api/message.rb
 - lib/wechat/api/user.rb
 - lib/wechat/api/util.rb
 - lib/wechat/api/version.rb
-- lib/wechat/pay.rb
-- lib/wechat/pay/client.rb
-- lib/wechat/pay/redpack.rb
 - lib/wechat/qy.rb
 - lib/wechat/qy/client.rb
 - lib/wechat/qy/message.rb
 - spec/spec_helper.rb
 - spec/wechat/api/client_spec.rb
-- spec/wechat/pay/client_spec.rb
+- spec/wechat/api/js_ticket_spec.rb
+- spec/wechat/api/util_spec.rb
 - wechat-api.gemspec
 homepage: https://github.com/lazing/wechat-api
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -200,13 +198,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: Wechat API wrapper
 test_files:
 - spec/spec_helper.rb
 - spec/wechat/api/client_spec.rb
-- spec/wechat/pay/client_spec.rb
-has_rdoc: 
+- spec/wechat/api/js_ticket_spec.rb
+- spec/wechat/api/util_spec.rb

data/.travis.yml

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

data/lib/wechat/pay.rb

@@ -1,7 +0,0 @@
-require 'wechat/pay/client'
-
-module Wechat
-  #
-  module Pay
-  end
-end

data/lib/wechat/pay/client.rb

@@ -1,116 +0,0 @@
-require 'rest-client'
-require 'logger'
-require 'multi_json'
-require 'openssl'
-require 'nori'
-require 'gyoku'
-
-require 'wechat/pay/redpack'
-
-module Wechat
-  module Pay
-    class PayError < StandardError; end
-    class NoAuthError < PayError; end
-    class NotEnoughError < PayError; end
-    class TimeLimitedError < PayError; end
-    class MoneyLimitedError < PayError; end
-
-    #
-    class Client
-      include Redpack
-      BASE_URL = 'https://api.mch.weixin.qq.com'
-      REQUIRED_OPTS = %w(key password cert sign_key).map(&:to_sym).freeze
-      ERRORS = {
-        'NO_AUTH' => NoAuthError,
-        'NOTENOUGH' => NotEnoughError,
-        'TIME_LIMITED' => TimeLimitedError,
-        'MONEY_LIMITED' => MoneyLimitedError
-      }
-
-      attr_accessor :logger
-
-      def initialize(mch_id, wxappid, opts = {})
-        @mch_id = mch_id
-        @wxappid = wxappid
-        @opts = Hash[opts.map { |k, v| [k.to_sym, v] }]
-        unless (REQUIRED_OPTS - @opts.keys).empty?
-          fail format('%s required', REQUIRED_OPTS.join(','))
-        end
-        @logger = Logger.new(STDOUT)
-        rsa_setup
-        @parser = Nori.new
-      end
-
-      def post(path, params)
-        merged_params = merge(params)
-        logger.debug { merged_params }
-        resp = resource(path).post(xml(sign(merged_params)))
-        handle(resp)
-      rescue RestClient::ExceptionWithResponse => err
-        raise PayError, err.response
-      end
-
-      private
-
-      def handle(resp)
-        response = parser.parse(resp)
-        check(response)
-        response
-      end
-
-      def check(r)
-        return if r['xml']['result_code'] == 'SUCCESS'
-        handle_error(r['xml']['err_code'], r)
-      end
-
-      def handle_error(error_code, response)
-        fail ERRORS[error_code] || PayError, response.inspect
-      end
-
-      def rsa_setup
-        @rsa_key = OpenSSL::PKey::RSA.new @opts[:key], @opts[:password]
-        @rsa_cert = OpenSSL::X509::Certificate.new @opts[:cert]
-      rescue StandardError => e
-        logger.error { e.inspect }
-      end
-
-      def resource(path)
-        RestClient.log = logger
-        RestClient::Resource.new\
-          [BASE_URL, path].join,
-          ssl_client_key: @rsa_key,
-          ssl_client_cert: @rsa_cert,
-          verify_ssl: OpenSSL::SSL::VERIFY_NONE
-      end
-
-      def xml(hash)
-        Gyoku.xml({ xml: hash }, key_converter: :none)
-      end
-
-      def sign(params)
-        ordered = trim_and_sort(params)
-        keystr = format('key=%s', @opts[:sign_key])
-        origin =
-          ordered.map { |k, v| [k, v].join('=') }.push(keystr).join('&')
-        sign = Digest::MD5.hexdigest(origin).upcase
-        logger.debug { format('origin: %s, sign: %s', origin, sign) }
-        params.merge(sign: sign)
-      end
-
-      def trim_and_sort(params)
-        params.delete_if { |_k, v| v.blank? }
-        Hash[params.sort]
-      end
-
-      def merge(params)
-        params.reverse_merge\
-          mch_id: @mch_id,
-          nonce_str: nonce_str
-      end
-
-      def nonce_str
-        SecureRandom.hex
-      end
-    end
-  end
-end

data/lib/wechat/pay/redpack.rb

@@ -1,39 +0,0 @@
-require 'securerandom'
-
-module Wechat
-  module Pay
-    #
-    module Redpack
-      def redpack(transaction_id, openid, params = {})
-        post\
-          '/mmpaymkttransfers/sendredpack',
-          params.merge(
-            mch_billno: tran_id(transaction_id),
-            wxappid: @wxappid, re_openid: openid
-          )
-      end
-
-      def group_redpack(transaction_id, openid, params = {})
-        post\
-          '/mmpaymkttransfers/sendgroupredpack',
-          params.merge(
-            mch_billno: tran_id(transaction_id),
-            wxappid: @wxappid, re_openid: openid
-          )
-      end
-
-      def redpack_info(transaction_id)
-        post\
-          '/mmpaymkttransfers/gethbinfo',
-          mch_billno: tran_id(transaction_id),
-          bill_type: 'MCHT', appid: @wxappid
-      end
-
-      private
-
-      def tran_id(origin)
-        format('%s%s', @mch_id, origin)
-      end
-    end
-  end
-end

data/spec/wechat/pay/client_spec.rb

@@ -1,24 +0,0 @@
-require File.expand_path('../../../spec_helper', __FILE__)
-
-RSpec.describe Wechat::Pay::Client do
-  subject do
-    described_class.new\
-      'mch_id', 'wxappid',
-      key: 'key', password: 'password', cert: 'cert',
-      sign_key: 'sign_key'
-  end
-
-  it :trim_and_sort do
-    expect(
-      subject.send(:trim_and_sort, b: 2, c: 3, a: 1).values
-    ).to start_with(1)
-  end
-
-  it :sign do
-    expect(subject.send(:sign, b: 2, a: 1)).to have_key(:sign)
-  end
-
-  it :xml do
-    expect(subject.send(:xml, b_1: 2, a: 1)).to match(/xml/)
-  end
-end