wechat-api 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8586728146eb49d713757e2a324ef9607ddf1098355e8347c35a5b8acd34c392
-  data.tar.gz: b6d7f195acf180b876802a1c52516ac96a085e35bbd10612ad68a87023ffc049
+  metadata.gz: 3af5535d32a85e57f6ed8f517cb17cbd0e8941e42610bc467a0cdb4a4936f411
+  data.tar.gz: 5de42166d01da0ea3047cc53f87864e85c4454a753b351f62d2c5d4ee64d0871
 SHA512:
-  metadata.gz: 07a8e8d9ac1157d77196a895c282011cc248fa9dbc4e3932de24037461fef6fbb3284869a97f3f01d585d77b1a3a7c0509ae2396e07571e19f5d4bf0cc74e0c2
-  data.tar.gz: 6a182e5b2058d6aa8bc8c8260e06f53f6f0e86ba7ebbf5bf414a6a212a8d12b61e1cbfe2143a759a1a222989008875a840b13c3fa0df79a203ba2b151aeec16a
+  metadata.gz: d77173f5c03d1bf1bf345a947238b5fa6966de3f67a8ff596670c904b1c9e726856d160be9c30a6c14f8e1ec4e21297a357fdf6fc080bb48b496f9a86db36758
+  data.tar.gz: 608d72719242789c965ae36b3f875806ddfc7d719fc54f4060c6a9b0d9a77ba424ddae1d4713731aafa88bf1dc0da8b1a491274c2834f63f2e41bc0c826fc3ee

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
     #
@@ -32,6 +35,23 @@ module Wechat
         res = get 'ticket/getticket', type: :jsapi
         res['ticket']
       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
 end

data/lib/wechat/api/version.rb

@@ -2,6 +2,6 @@
 module Wechat
   #
   module Api
-    VERSION = '0.3.0'.freeze
+    VERSION = '0.4.0'.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,7 +13,6 @@ 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"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wechat-api
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ryan Wong
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-25 00:00:00.000000000 Z
+date: 2021-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -143,7 +143,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/rake_spec.yml"
 - ".gitignore"
 - ".rspec"
 - Gemfile
@@ -153,6 +152,7 @@ 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
@@ -162,6 +162,8 @@ files:
 - lib/wechat/qy/message.rb
 - spec/spec_helper.rb
 - spec/wechat/api/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:
@@ -189,3 +191,5 @@ summary: Wechat API wrapper
 test_files:
 - spec/spec_helper.rb
 - spec/wechat/api/client_spec.rb
+- spec/wechat/api/js_ticket_spec.rb
+- spec/wechat/api/util_spec.rb

data/.github/workflows/rake_spec.yml

@@ -1,20 +0,0 @@
-name: Ruby
-
-on: [push]
-
-jobs:
-  build:
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v1
-    - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
-      with:
-        ruby-version: 2.6.x
-    - name: Build and test with Rake
-      run: |
-        gem install bundler
-        bundle install --jobs 4 --retry 3
-        bundle exec rake