wechat-core 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 652dce668279af5ec743b29fc94dda40144596ec
-  data.tar.gz: b06e70285eea750ae85dd147d55d4d94ebc69d98
+  metadata.gz: 1fb64c38de72269f3964193557840d1a082e8338
+  data.tar.gz: a2f81055f5a1f6958a9b0b3d9ccf560dff71b3b4
 SHA512:
-  metadata.gz: 8ab34f8906dc3028c66c342145d6777a7355567935274e4e964f0f878580613feebd631054d9c07aa5b840f0ecf7b162be93108d3cb726e142ef65fdf25bca1e
-  data.tar.gz: bed85f1de53c1c9112fe0793ef808f9475c8e91b436de09ea312d9253ea46b343f23403d7e5029383cf89d016d11935cdb883afc26da29c76a176c36c8bfc744
+  metadata.gz: f38dd883d10e79b7c9f5e5c5f9a3d351b8c89cf933c6184c49e3a4473411d90e4c27b7d3073f923eeeca5b55b1552378fc2f51aa34466bae1339d56166f95cd2
+  data.tar.gz: '09791946ee19d6e59acb26c305ca2c9c73652613277dff4ec79d17beb9d2324914922acee6b939069fbdf2a56300797a454854f469e8a9513cbaa32cfd188092'

data/CHANGELOG.md

@@ -28,3 +28,10 @@
 3. Improve the Follower Profile wrapper class for the HTTP request
 4. Improve the Server Address wrapper class for the HTTP request
 5. Improve the Tiny Link wrapper class for the HTTP request
+
+## v0.4.2
+1. Improve the Access Token wrapper class for the HTTP request
+2. Improve the Follower wrapper class for the HTTP request
+3. Improve the Follower Profile wrapper class for the HTTP request
+4. Improve the Server Address wrapper class for the HTTP request
+5. Improve the Tiny Link wrapper class for the HTTP request

data/Gemfile.lock

@@ -8,32 +8,32 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.0.0.1)
+    activesupport (5.0.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    concurrent-ruby (1.0.2)
-    diff-lcs (1.2.5)
-    httpclient (2.8.2.4)
-    i18n (0.7.0)
-    minitest (5.9.1)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    httpclient (2.8.3)
+    i18n (0.8.1)
+    minitest (5.10.1)
     rake (10.5.0)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.4)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.1)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
-    thread_safe (0.3.5)
-    tzinfo (1.2.2)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
       thread_safe (~> 0.1)
 
 PLATFORMS
@@ -46,4 +46,4 @@ DEPENDENCIES
   wechat-core!
 
 BUNDLED WITH
-   1.12.5
+   1.13.6

data/README.md

@@ -1,6 +1,8 @@
 # Wechat::Core 微信核心库
 
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/wechat-core/frames)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](http://opensource.org/licenses/MIT)
+
 [![Gem Version](https://badge.fury.io/rb/wechat-core.svg)](https://badge.fury.io/rb/wechat-core)
 [![Dependency Status](https://gemnasium.com/badges/github.com/topbitdu/wechat-core.svg)](https://gemnasium.com/github.com/topbitdu/wechat-core)
 

data/ROADMAP.md

@@ -29,6 +29,13 @@
 4. Improve the Server Address wrapper class for the HTTP request
 5. Improve the Tiny Link wrapper class for the HTTP request
 
+## v0.4.2
+1. Improve the Access Token wrapper class for the HTTP request
+2. Improve the Follower wrapper class for the HTTP request
+3. Improve the Follower Profile wrapper class for the HTTP request
+4. Improve the Server Address wrapper class for the HTTP request
+5. Improve the Tiny Link wrapper class for the HTTP request
+
 ## v1.0
 1. Improve the Follower & Follower Profile wrapper class to support the Keyword Arguments
 2. Removed the depreated classes and methods

data/lib/wechat/core/access_token.rb

@@ -1,9 +1,13 @@
 require 'jsonclient'
 
+##
+# Access Token 是访问令牌的远程调用封装类。
+
 class Wechat::Core::AccessToken
 
   extend Wechat::Core::Common
 
+  ##
   # 获取 Access Token
   # http://mp.weixin.qq.com/wiki/11/0e4b294685f817b95cbed85ba5e82b8f.html
   #
@@ -23,6 +27,7 @@ class Wechat::Core::AccessToken
     message.body
   end
 
+  ##
   # 获取 Access Token
   # http://mp.weixin.qq.com/wiki/11/0e4b294685f817b95cbed85ba5e82b8f.html
   #
@@ -37,19 +42,12 @@ class Wechat::Core::AccessToken
     assert_present! :app_id,     app_id
     assert_present! :app_secret, app_secret
 
-    #message = ::JSONClient.new.get 'https://api.weixin.qq.com/cgi-bin/token',
-    #  {
-    #    grant_type: 'client_credential',
-    #    appid:      app_id,     # Rails.application.secrets.wechat_app_id,
-    #    secret:     app_secret, # Rails.application.secrets.wechat_app_secret
-    #  }
-    message = get_json 'https://api.weixin.qq.com/cgi-bin/token', body:
+    get_json 'https://api.weixin.qq.com/cgi-bin/token', body:
       {
         grant_type: 'client_credential',
         appid:      app_id,     # Rails.application.secrets.wechat_app_id,
         secret:     app_secret, # Rails.application.secrets.wechat_app_secret
       }
-    message.body
   end
 
   class << self

data/lib/wechat/core/common.rb

@@ -142,16 +142,25 @@ module Wechat::Core::Common
       9001036 => '查询起始值begin不合法'
     }
 
+  ##
+  # 判断给定的参数 value 是否为空，如果为空，则抛出 ArgumentError 异常。参数名为 name 。例如：
+  # assert_present! :access_token, access_token
   def assert_present!(name, value)
     raise ArgumentError.new("The #{name} argument is required.") if value.blank?
   end
 
+  ##
+  # 向链接 link 发出 GET 请求，参数为 body 指定的 Hash。返回的数据结构必须为 JSON 格式。如：
+  # get_json 'https://api.product.com/path/resources.json', body: { page: 2, per_page: 5 }
   def get_json(link, body: {})
     assert_present! :link, link
     message = JSONClient.new.get link, body
     message.body
   end
 
+  ##
+  # 向链接 link 发出 GET 请求，参数为 body 指定的 Hash。返回的数据结构必须为 JSON 格式。如：
+  # post_json 'https://api.product.com/path/resources.json', body: { name: 'Some Name' }
   def post_json(link, body: {})
     assert_present! :link, link
     message = JSONClient.new.post link, body

data/lib/wechat/core/follower.rb

@@ -1,7 +1,11 @@
+##
+# Follower 是关注者概要信息的远程调用封装类。
+
 class Wechat::Core::Follower
 
   extend Wechat::Core::Common
 
+  ##
   # 获取关注者列表
   # http://mp.weixin.qq.com/wiki/0/d0e07720fc711c02a3eab6ec33054804.html
   #
@@ -19,8 +23,7 @@ class Wechat::Core::Follower
     options = { access_token: access_token }
     options[:next_openid] = next_open_id if next_open_id.present?
 
-    message = get_json 'https://api.weixin.qq.com/cgi-bin/user/get', body: options
-    message.body
+    get_json 'https://api.weixin.qq.com/cgi-bin/user/get', body: options
   end
 
 end

data/lib/wechat/core/follower_profile.rb

@@ -1,7 +1,11 @@
+##
+# Follower Profile 是关注者画像的远程调用封装类。
+
 class Wechat::Core::FollowerProfile
 
   extend Wechat::Core::Common
 
+  ##
   # 批量获取用户基本信息
   # http://mp.weixin.qq.com/wiki/14/bb5031008f1494a59c6f71fa0f319c66.html#.E6.89.B9.E9.87.8F.E8.8E.B7.E5.8F.96.E7.94.A8.E6.88.B7.E5.9F.BA.E6.9C.AC.E4.BF.A1.E6.81.AF
   # 最多支持一次拉取100条。
@@ -20,7 +24,7 @@ class Wechat::Core::FollowerProfile
   #       country:        <COUNTRY_NAME>,
   #       headimgurl:     <HEAD_IMAGE_LINK>,
   #       subscribe_time: <SUBSCRIBE_TIME>,
-  #       unionid:        <UNION_ID>, 
+  #       unionid:        <UNION_ID>,
   #       remark:         <REMARK>,
   #       groupid:        <GROUP_ID>
   #     }
@@ -32,14 +36,17 @@ class Wechat::Core::FollowerProfile
     assert_present! :open_ids,     open_ids
 
     followers = open_ids.map { |open_id| { openid: open_id, lang: language } }
-    message   = post_json "https://api.weixin.qq.com/cgi-bin/user/info/batchget?access_token=#{access_token}", body: { user_list: followers }
-    message.body
+    post_json "https://api.weixin.qq.com/cgi-bin/user/info/batchget?access_token=#{access_token}", body:
+      {
+        user_list: followers
+      }
 
   end
 
+  ##
   # 获取用户基本信息(UnionID机制)
   # http://mp.weixin.qq.com/wiki/14/bb5031008f1494a59c6f71fa0f319c66.html#.E8.8E.B7.E5.8F.96.E7.94.A8.E6.88.B7.E5.9F.BA.E6.9C.AC.E4.BF.A1.E6.81.AF.EF.BC.88.E5.8C.85.E6.8B.ACUnionID.E6.9C.BA.E5.88.B6.EF.BC.89
-  # 一次拉取调用最多拉取10000个关注者的OpenID，可以通过多次拉取的方式来满足需求。 
+  # 一次拉取调用最多拉取10000个关注者的OpenID，可以通过多次拉取的方式来满足需求。
   #
   # Return hash format if success:
   # {
@@ -56,18 +63,17 @@ class Wechat::Core::FollowerProfile
   #   remark:         <REMARK>,
   #   groupid:        <GROUP_ID>
   # }
-  def self.load(access_token, open_id, language: 'zh_CN')
+  def self.load(access_token, open_id, language: Wechat::Core::Common::LANGUAGE_SIMPLIFIED_CHINESE)
 
     assert_present! :access_token, access_token
     assert_present! :open_id,      open_id
 
-    message = get_json 'https://api.weixin.qq.com/cgi-bin/user/info', body:
+    get_json 'https://api.weixin.qq.com/cgi-bin/user/info', body:
       {
         access_token: access_token,
         openid:       open_id,
         lang:         language
       }
-    message.body
   end
 
 end

data/lib/wechat/core/server_address.rb

@@ -1,7 +1,11 @@
+##
+# Server Address 是服务器地址的远程调用封装类。
+
 class Wechat::Core::ServerAddress
 
   extend Wechat::Core::Common
 
+  ##
   # 获取微信服务器IP地址
   # http://mp.weixin.qq.com/wiki/0/2ad4b6bfd29f30f71d39616c2a0fcedc.html
   #
@@ -11,8 +15,8 @@ class Wechat::Core::ServerAddress
 
     assert_present! :access_token, access_token
 
-    message = get_json 'https://api.weixin.qq.com/cgi-bin/getcallbackip', body: { access_token: access_token }
-    message.body
+    get_json 'https://api.weixin.qq.com/cgi-bin/getcallbackip', body: { access_token: access_token }
+
   end
 
 end

data/lib/wechat/core/tiny_link.rb

@@ -1,7 +1,11 @@
+##
+# Tiny Link 是短链接的远程调用封装类。
+
 class Wechat::Core::TinyLink
 
   extend Wechat::Core::Common
 
+  ##
   # 长链接转短链接接口
   # http://mp.weixin.qq.com/wiki/10/165c9b15eddcfbd8699ac12b0bd89ae6.html
   #
@@ -23,12 +27,11 @@ class Wechat::Core::TinyLink
     assert_present! :access_token, access_token
     assert_present! :link,         link
 
-    message = post_json "https://api.weixin.qq.com/cgi-bin/shorturl?access_token=#{access_token}", body:
+    post_json "https://api.weixin.qq.com/cgi-bin/shorturl?access_token=#{access_token}", body:
       {
         action:   'long2short',
         long_url: link
       }
-    message.body
   end
 
 end

data/lib/wechat/core/version.rb

@@ -1,5 +1,5 @@
 module Wechat
   module Core
-    VERSION = '0.4.1'.freeze
+    VERSION = '0.4.2'.freeze
   end
 end

data/wechat-core.gemspec

@@ -31,6 +31,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec',   '~> 3.0'
 
   spec.add_dependency 'activesupport', '>= 4.2'
-  spec.add_dependency 'httpclient', '>= 2.8'
+  spec.add_dependency 'httpclient',    '>= 2.8'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wechat-core
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Topbit Du
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-24 00:00:00.000000000 Z
+date: 2017-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler