easy_wechat 0.1.0 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7364b15bfaffdfbd425ee3da00578995dc16dbddabc922e51bd369766524a311
-  data.tar.gz: 8b356a8c3e57f5ce4e1a9d1f16b8a30d751476428f763aae57681b18ad8db2bb
+  metadata.gz: ccc93ec4d83d3f2b3b45a514b9297b76ee395fbe8aebbceef0387cd4a422d491
+  data.tar.gz: 9a89ebd838cb835625acb977c1145ef2edfb62250de62adbfa22527e15a5bd97
 SHA512:
-  metadata.gz: 709aa701cff058d7ccf341442d27fab92c6840d160da6f79e30cf5115896fcc1952067b3cdc22fab4b9e87bb9ebcbe85c20f4c9d522b7fc2f4775b478c7dfc81
-  data.tar.gz: b9715e4797ed0fed1b6b8d5bffcd36d943affd89157cb22296f8d173d21aa3a652e5f28fefc5b384df66e53ceb5831950c93e93a98a4c506285dfbd46e11610e
+  metadata.gz: 24929f3e1b1ed83e6f57fc167a4c2aa76404b968e6c73f64cf42b99124b35d185ef67d59ba5cee23fcc7a0fe40bc2e1790bfe354c16fb8e06eaee433aa4d7397
+  data.tar.gz: aa1b2c8ae2679b0b3d080c8389e71d562275e612f0bebc617b59f323ad051e3e823745db403ab9d15a4175fc6e21a99adfb62f280b4e78864f9cec50da73fea6

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    easy_wechat (0.1.0)
+    easy_wechat (0.1.6)
       activesupport
+      http-form_data
       httpx
 
 GEM
@@ -18,7 +19,8 @@ GEM
     concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
     http-2-next (0.4.3)
-    httpx (0.15.1)
+    http-form_data (2.3.0)
+    httpx (0.15.3)
       http-2-next (>= 0.4.1)
       timers
     i18n (1.8.10)

data/README.md

@@ -22,7 +22,27 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```
+rails g easy_wechat:install
+
+EasyWechat.configure do |config|
+  config.appid = ENV.fetch("APPID") || ""
+  config.app_secret = ENV.fetch("APP_SECRET") || ""
+end
+
+client = EasyWechat::Client.new
+client.token
+client.batchget_material
+client.uploadimg(media)
+client.add_news(articles)
+client.get_user_summary(begin_date, end_date)
+client.get_user_cumulate(begin_date, end_date)
+```
+
+## FAQ
+1. 微信api，请求方式有问题，也会报错，所以要注意请求方式
+2. 先搞清楚你的appid对应的公众号是什么，并且搞清楚你是什么类型的，查看接口权限是否获得，否则有可能会有类似48001的权限未开通错误
+3. 调用api之前，请确保ip已经加入到服务器白名单
 
 ## Development
 

data/easy_wechat.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["42up"]
   spec.email         = ["foobar@v2up.com"]
 
-  spec.summary       = "easy wechat sdk"
-  spec.description   = "easy wechat sdk"
+  spec.summary       = "An unofficial easy wechat sdk"
+  spec.description   = "An unofficial easy wechat sdk"
   spec.homepage      = "https://github.com/42up/easy_wechat"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "httpx"
   spec.add_dependency "activesupport"
+  spec.add_dependency "http-form_data"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"

data/lib/easy_wechat.rb

@@ -1,7 +1,32 @@
 require "easy_wechat/version"
+require "easy_wechat/client"
+require "easy_wechat/configuration"
+
+require "httpx"
 
 module EasyWechat
   class Error < StandardError; end
-  # Your code goes here...
-  puts "foo"
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def app_id
+      configuration.app_id
+    end
+
+    def app_secret
+      configuration.app_secret
+    end
+  end
 end

data/lib/easy_wechat/client.rb

@@ -0,0 +1,107 @@
+require "httpx"
+require "http/form_data"
+require "json"
+require "active_support"
+
+module EasyWechat
+  class Client
+    TOKEN_URL = "https://api.weixin.qq.com/cgi-bin/token"
+    BATCHGET_MATERIAL_URL = "https://api.weixin.qq.com/cgi-bin/material/batchget_material"
+    UPLOADIMG_URL = "https://api.weixin.qq.com/cgi-bin/media/uploadimg"
+    ADD_NEWS_URL = "https://api.weixin.qq.com/cgi-bin/material/add_news"
+    GET_USER_SUMMARY_URL = "https://api.weixin.qq.com/datacube/getusersummary"
+    GET_USER_CUMULATE_URL = "https://api.weixin.qq.com/datacube/getusercumulate"
+    GET_TICKET_URL = "https://api.weixin.qq.com/cgi-bin/ticket/getticket"
+
+    def initialize
+    end
+
+    def access_token
+      @access_token ||= token["access_token"]
+    end
+
+    def get_user_summary(begin_date, end_date)
+      payload = { begin_date: begin_date, end_date: end_date }
+
+      resp = HTTPX.post(GET_USER_SUMMARY_URL, params: { access_token: access_token }, json: payload)
+
+      r = ::JSON.parse(resp.body, quirks_mode: true)
+      yield r if block_given?
+      r
+    end
+
+    def get_user_cumulate(begin_date, end_date)
+      payload = { begin_date: begin_date, end_date: end_date }
+
+      resp = HTTPX.post(GET_USER_CUMULATE_URL, params: { access_token: access_token }, json: payload)
+
+      r = ::JSON.parse(resp.body, quirks_mode: true)
+      yield r if block_given?
+      r
+    end
+
+    # 获取access_token
+    # https://developers.weixin.qq.com/doc/offiaccount/Basic_Information/Get_access_token.html
+    def token
+      resp = HTTPX.get(TOKEN_URL, params: {
+                                    appid: EasyWechat.app_id,
+                                    secret: EasyWechat.app_secret,
+                                    grant_type: "client_credential",
+                                  })
+
+      r = ::JSON.parse(resp.body, quirks_mode: true)
+      yield r if block_given?
+      r
+    end
+
+    # 新增永久图文素材
+    # https://developers.weixin.qq.com/doc/offiaccount/Asset_Management/Adding_Permanent_Assets.html
+    def add_news(articles)
+      payload = { articles: articles }
+
+      resp = HTTPX.post(ADD_NEWS_URL, params: { access_token: access_token }, json: payload)
+
+      r = ::JSON.parse(resp.body, quirks_mode: true)
+      yield r if block_given?
+      r
+    end
+
+    def get_ticket(type)
+      resp = HTTPX.get(GET_TICKET_URL, params: { access_token: access_token, type: type })
+
+      r = ::JSON.parse(resp.body, quirks_mode: true)
+      yield r if block_given?
+      r
+    end
+
+    # 获取永久素材的列表
+    # https://developers.weixin.qq.com/doc/offiaccount/Asset_Management/Get_materials_list.html
+    def batchget_material(type = "image", offset = 0, count = 20)
+      # TODO: 检查参数完整性
+      # TODO: 检查参数合法性
+      payload = { type: type, offset: offset, count: count }
+
+      resp = HTTPX.post(BATCHGET_MATERIAL_URL, params: { access_token: access_token }, json: payload)
+
+      r = ::JSON.parse(resp.body, quirks_mode: true)
+      yield r if block_given?
+      r
+    end
+
+    # 上传图文消息内的图片获取URL
+    # https://developers.weixin.qq.com/doc/offiaccount/Asset_Management/Adding_Permanent_Assets.html
+    def uploadimg(media)
+      # https://honeyryderchuck.gitlab.io/httpx/wiki/Multipart-Uploads.html#notes
+      file = media.is_a?(String) ? HTTP::FormData::File.new(media) : meida
+      resp = HTTPX.plugin(:multipart).post(UPLOADIMG_URL, params: { access_token: access_token }, form: { media: file })
+
+      r = ::JSON.parse(resp.body, quirks_mode: true)
+      yield r if block_given?
+      r
+    end
+
+    def menu_create
+      raise NotImplementedError
+    end
+  end
+end

data/lib/easy_wechat/configuration.rb

@@ -0,0 +1,10 @@
+module EasyWechat
+  class Configuration
+    attr_accessor :app_id, :app_secret
+
+    def initialize
+      @app_id = ""
+      @app_secret = ""
+    end
+  end
+end

data/lib/easy_wechat/version.rb

@@ -1,3 +1,3 @@
 module EasyWechat
-  VERSION = "0.1.0"
+  VERSION = "0.1.6"
 end

data/lib/generators/easy_wechat/install_generator.rb

@@ -0,0 +1,20 @@
+module EasyWechat
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "EasyWechat installation: initializer"
+      source_root File.expand_path("../../templates", __FILE__)
+
+      def install
+        puts "==> generate initializer file ..."
+        copy_initializer
+        puts "Done!"
+      end
+
+      private
+
+      def copy_initializer
+        template "initializer.rb", "config/initializers/easy_wechat.rb"
+      end
+    end
+  end
+end

data/lib/generators/templates/initializer.rb

@@ -0,0 +1,4 @@
+EasyWechat.configure do |config|
+  # config.appid = ENV.fetch("APPID") || ""
+  # config.app_secret = ENV.fetch("APP_SECRET") || ""
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_wechat
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.6
 platform: ruby
 authors:
 - 42up
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-28 00:00:00.000000000 Z
+date: 2021-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpx
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: http-form_data
+  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
@@ -94,7 +108,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: easy wechat sdk
+description: An unofficial easy wechat sdk
 email:
 - foobar@v2up.com
 executables: []
@@ -113,7 +127,11 @@ files:
 - bin/setup
 - easy_wechat.gemspec
 - lib/easy_wechat.rb
+- lib/easy_wechat/client.rb
+- lib/easy_wechat/configuration.rb
 - lib/easy_wechat/version.rb
+- lib/generators/easy_wechat/install_generator.rb
+- lib/generators/templates/initializer.rb
 homepage: https://github.com/42up/easy_wechat
 licenses:
 - MIT
@@ -139,5 +157,5 @@ requirements: []
 rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
-summary: easy wechat sdk
+summary: An unofficial easy wechat sdk
 test_files: []