simple_wx 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3352241216ce336988e4fa27a330ba1d723e0558
+  data.tar.gz: e07e3618c8533fdf0afae69d27b08ea7b554f6a5
+SHA512:
+  metadata.gz: ca678fc595eef2f1424dd3b6b34c21d1577ff80c03b6e6300e22ddc5cb1798b97276fb7fd28c14c01d1853cac726164082233f1b0bdd78df712242e56c4575d2
+  data.tar.gz: cb8a81f1373d22ab77a7e5cbb38cfe9cb6a5d8a34218cccd6c3501486e653ac81c402d1beed8e8dd8cc04ca8c0a8c76461f07d17662f08c70dfae47dca026437

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/.idea

data/README.md

@@ -0,0 +1,22 @@
+## initializers/simple_wx.rb:
+```
+  WeixinSetting = YAML.load_file(File.join "#{Rails.root}", "config", "weixin.yml")[Rails.env || "development"]
+
+  module SimpleWx
+    @@weixin_config = YAML.load_file(File.join "#{Rails.root}", "config", "weixin.yml")[Rails.env || "development"]
+    @@logger = Rails.logger
+    @@redis  = Redis::Objects.redis
+  end
+```
+
+## config/weixin.yml:
+```
+  development:
+    app_id: app_id
+    app_secret: app_secret
+    serial_no: 微信号 (gh...)
+    token: token
+
+  production:
+    # ...
+```

data/config/initializers/simple_wx.rb.example

@@ -0,0 +1,5 @@
+module SimpleWx
+  @@weixin_config = YAML.load_file(File.join "#{Rails.root}", "config", "weixin.yml")[Rails.env || "development"]
+  @@logger = Rails.logger
+  @@redis  = Redis::Objects.redis
+end

data/lib/simple_wx/access_token.rb

@@ -0,0 +1,79 @@
+module SimpleWx
+  class AccessToken < Base
+
+    ### Usage
+    #
+    # ---------- class-methods ----------
+    #
+    # SimpleWx::AccessToken.access_token
+    # SimpleWx::AccessToken.server_ip
+    # SimpleWx::AccessToken.jsapi_ticket
+    #
+    # ---------- instance-methods -----------
+    #
+    # at = SimpleWx::AccessToken.new
+    # at.access_token
+    # at.server_ip
+    # if at.error.present?
+    #   ...
+    # end
+    #
+
+
+    def server_ip
+      url = "https://api.weixin.qq.com/cgi-bin/getcallbackip?access_token=#{access_token}"
+      response = RestClient.get url
+      response_json = errcode_check(JSON.parse(response))
+      @server_ip = response_json["ip_list"]
+    end
+
+    def access_token
+      SimpleWx.redis.exists("__weixin_access_token__") ? \
+      SimpleWx.redis.get("__weixin_access_token__") : get_new_token
+    end
+
+    def jsapi_ticket
+      SimpleWx.redis.exists("__jsapi_ticket__") ? \
+      SimpleWx.redis.get("__jsapi_ticket__") : get_new_jsapi_ticket
+    end
+
+    private
+
+    def get_new_jsapi_ticket
+      url = "https://api.weixin.qq.com/cgi-bin/ticket/getticket?access_token=#{access_token}&type=jsapi"
+      response = RestClient.get url
+      response_json = errcode_check(JSON.parse(response))
+      jsapi_ticket = response_json["ticket"]
+      if @error.blank?
+        SimpleWx.redis.multi do
+          SimpleWx.redis.set "__jsapi_ticket__", jsapi_ticket
+          SimpleWx.redis.expire "__jsapi_ticket__", 30.minutes.to_i
+        end
+      end
+      jsapi_ticket
+    end
+
+    def get_new_token
+      url = "https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=#{SimpleWx.weixin_config["app_id"]}&secret=#{SimpleWx.weixin_config["app_secret"]}"
+      response = RestClient.get url
+      response_json = errcode_check(JSON.parse(response))
+      access_token = response_json["access_token"]
+      if @error.blank?
+        SimpleWx.redis.multi do
+          SimpleWx.redis.set "__weixin_access_token__", access_token
+          SimpleWx.redis.expire "__weixin_access_token__", 30.minutes.to_i
+        end
+      end
+      access_token
+    end
+
+    def self.method_missing m
+      instance = self.new
+      if instance.public_methods(false).include? m.to_sym
+        return instance.send(m)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/simple_wx/base.rb

@@ -0,0 +1,37 @@
+module SimpleWx
+  class Base
+    attr_accessor :error, :raise_flag
+
+    def initialize options = {}
+      raise 'SimpleWx.weixin_config is blank.' if SimpleWx.weixin_config.blank?
+      @raise_flag = options[:raise_flag]
+      @log_flag = options[:log_flag]
+      @error = {}
+    end
+
+    protected
+
+    def errcode_check json, log_flag = nil
+
+      # 每次执行刷新 @error
+      # 根据 log_flag 打印日志
+      # 检查是否直接抛错
+
+      @error = {}
+      raise "Responsed nothing from Weixin" if json.nil? && @raise_flag
+      if json["errcode"].present? && json["errcode"].to_i != 0
+        SimpleWx.logger.error(json)
+        @error = json
+        raise "Weixin response json with errcode: #{json}" if @raise_flag
+      else
+        if log_flag
+          SimpleWx.logger.info("SimpleWxLog:#{self.class.name} -- #{log_flag} -- #{json}")
+        else
+          SimpleWx.logger.debug("SimpleWxLog:#{self.class.name} -- #{json}")
+        end
+      end
+      json
+    end
+
+  end
+end

data/lib/simple_wx/menu.rb

@@ -0,0 +1,73 @@
+module SimpleWx
+  class Menu < Base
+
+    ### Usage
+    #
+    # ---------- class-methods ----------
+    #
+    # SimpleWx::Menu.show
+    # SimpleWx::Menu.create(buttons)
+    # => true/false
+    # SimpleWx::Menu.delete
+    # => true/false
+    #
+    # ---------- instance-methods -----------
+    #
+    # menu = SimpleWx::Menu.new
+    # menu.show
+    #
+    # if menu.create(buttons)
+    #   ...
+    # else
+    #  p menu.error
+    # end
+    #
+    # menu.delete!
+    # when "errcode" existed in json of response, it will raise the error:
+    # => "Weixin response json with errcode: #{json}"
+    #
+
+    def initialize options = {}
+      @access_token = options[:access_token] || AccessToken.access_token
+    end
+
+    def show
+      url = "https://api.weixin.qq.com/cgi-bin/menu/get?access_token=#{@access_token}"
+      response = RestClient.get url
+      response_json = errcode_check(JSON.parse(response))
+      @menus = response_json["menu"]
+    end
+
+    def create menu_hash
+      url = "https://api.weixin.qq.com/cgi-bin/menu/create?access_token=#{@access_token}"
+      response = RestClient.post(url, JSON.generate({button: menu_hash}))
+      errcode_check(JSON.parse(response))
+      @error.blank?
+    end
+
+    def delete
+      url = "https://api.weixin.qq.com/cgi-bin/menu/delete?access_token=#{@access_token}"
+      response = RestClient.get url
+      errcode_check(JSON.parse(response))
+      @error.blank?
+    end
+
+    def create! menu_hash
+      @raise_flag ||= true
+      create menu_hash
+    end
+
+    def delete!
+      @raise_flag ||= true
+      delete
+    end
+
+    def self.method_missing m, *args
+      if instance_methods.include? m.to_sym
+        self.new.send(m, *args)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/simple_wx/message.rb

@@ -0,0 +1,59 @@
+module SimpleWx
+  class Message < Base
+    attr_accessor :openid, :json, :xml
+    def initialize options
+      @openid = options.delete(:openid)
+      @access_token = options.delete(:access_token) || AccessToken.access_token
+      @custom_msg_url = "https://api.weixin.qq.com/cgi-bin/message/custom/send?access_token=#{@access_token}"
+      @json = {}
+      @xml = {}
+    end
+
+    protected
+
+    def set_json
+      @json[:touser]  = @openid
+    end
+
+    def set_xml
+      @xml["ToUserName"]   = @openid
+      @xml["FromUserName"] = SimpleWx.weixin_config["serial_no"]
+      @xml["CreateTime"]   = Time.now.to_i.to_s
+    end
+
+    def send_json
+      set_json
+      response = RestClient.post(@custom_msg_url, JSON.generate(@json))
+      errcode_check(JSON.parse(response))
+    end
+
+    def send_json!
+      @raise_flag ||= true
+      send_json
+    end
+
+    def to_xml
+      set_xml
+      builder = Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
+        xml.xml do
+          recursively_xml xml, @xml
+        end
+      end
+      builder.to_xml
+    end
+
+    private
+
+    def recursively_xml builder, hsh
+      hsh.each do |k, v|
+        if v.is_a? Hash
+          builder.send(k) do
+            recursively_xml(builder, v)
+          end
+        else
+          builder.send(k, v)
+        end
+      end
+    end
+  end
+end

data/lib/simple_wx/messages/image_message.rb

@@ -0,0 +1,23 @@
+module SimpleWx
+  module Messages
+    class ImageMessage < Message
+      def initialize options
+        super
+        @media_id = options[:media_id]
+      end
+
+      def send_json
+        @json[:msgtype] = "image"
+        @json[:image] = {media_id: @media_id}
+        SimpleWx.logger.info("SimpleWxLog:#{self.class.name} -- #{@openid} -- #{json}")
+        super
+      end
+
+      def to_xml
+        @xml["MsgType"] = "image"
+        @xml["Image"] = { "MediaId" => @media_id }
+        super
+      end
+    end
+  end
+end

data/lib/simple_wx/messages/text_message.rb

@@ -0,0 +1,23 @@
+module SimpleWx
+  module Messages
+    class TextMessage < Message
+      def initialize options
+        super
+        @content = options[:content]
+      end
+
+      def send_json
+        @json[:msgtype] = "text"
+        @json[:text] = {content: @content}
+        SimpleWx.logger.info("SimpleWxLog:#{self.class.name} -- #{@openid} -- #{json}")
+        super
+      end
+
+      def to_xml
+        @xml["MsgType"] = "text"
+        @xml["Content"] = @content
+        super
+      end
+    end
+  end
+end

data/lib/simple_wx/o_auth.rb

@@ -0,0 +1,82 @@
+module SimpleWx
+  class OAuth < Base
+
+    ### Usage
+    #
+    # auth = SimpleWx::OAuth.new(code: "code")
+    #
+    # 调用 OAth2 的 access_token 接口, 返回结果信息
+    # result_json = auth.get_access_token
+    #
+    # auth 返回的基本参数会赋值给对象属性
+    # auth.access_token == result_json["access_token"]
+    # => true
+    #
+    # 检查 access_token 是否过期
+    # auth.access_token_valid?
+    # => true
+    #
+    # auth.expires_in
+    # => 7200
+    # sleep 7201
+    # auth.access_token_valid?
+    # => false
+    #
+    # 刷新access_token接口
+    # result_json = auth.refresh_token
+    # auth.access_token == result_json["access_token"]
+    # auth.access_token_valid?
+    # => true
+    #
+
+    attr_reader :code, :scope, :expires_in, :unionid, :result
+    attr_accessor :access_token, :refresh_token, :openid
+
+    def initialize options
+      @code = options[:code]
+    end
+
+    def get_access_token
+      url = "https://api.weixin.qq.com/sns/oauth2/access_token?appid=#{SimpleWx.weixin_config["app_id"]}&secret=#{SimpleWx.weixin_config["app_secret"]}&code=#{@code}&grant_type=authorization_code"
+      response = RestClient.get url
+      set_result(errcode_check(JSON.parse(response)))
+    end
+
+    def get_user_info
+      UserInfo.get_auth_info(o_auth: self)
+    end
+
+    def access_token_valid?
+      url = "https://api.weixin.qq.com/sns/auth?access_token=#{@access_token}&openid=#{@openid}"
+      response = RestClient.get url
+      errcode_check(JSON.parse(response))
+      @error.blank?
+    end
+
+    def refresh_token
+      url = "https://api.weixin.qq.com/sns/oauth2/refresh_token?appid=#{SimpleWx.weixin_config["app_id"]}&grant_type=refresh_token&refresh_token=#{@refresh_token}"
+      response = RestClient.get url
+      set_result(errcode_check(JSON.parse(response)))
+    end
+
+    def self.generate_auth_link url, state = "", scope = "snsapi_userinfo"
+      params = {
+        appid: SimpleWx.weixin_config["app_id"],
+        redirect_uri: url,
+        response_type: "code",
+        scope: scope,
+        state: state
+      }
+      "https://open.weixin.qq.com/connect/oauth2/authorize?#{params.to_query}#wechat_redirect"
+    end
+
+    private
+
+    def set_result result
+      result.each do |k, v|
+        instance_variable_set "@#{k}", v
+      end
+      @result = result
+    end
+  end
+end

data/lib/simple_wx/signaturer.rb

@@ -0,0 +1,31 @@
+module SimpleWx
+  class Signaturer < Base
+
+    ### Usage
+    #
+    # signer = SimpleWx::Signaturer.new timestamp: params[:timestamp], nonce: params[:nonce]
+    # if signer.sign params[:signature]
+    #   render text: params[:echostr]
+    # else
+    #   ...
+    # end
+
+    def initialize options = {}
+      @timestamp = options.fetch :timestamp
+      @nonce     = options.fetch :nonce
+      @token     = SimpleWx.weixin_config["token"] #TODO 没有就raise错误,用method_missing
+    end
+
+    def sign signture
+      @sort_array = [@timestamp, @nonce, @token].sort
+      signture == sha1_encrypt
+    end
+
+    private
+
+    def sha1_encrypt
+      encrypt_str = @sort_array.join
+      Digest::SHA1.hexdigest(encrypt_str)
+    end
+  end
+end

data/lib/simple_wx/user_info.rb

@@ -0,0 +1,49 @@
+module SimpleWx
+  class UserInfo < Base
+
+    ### Usage
+    #
+    # ---------- class-methods ----------
+    #
+    # instance_of_oauth = SimpleWx::OAuth.new("code")
+    # instance_of_oauth.get_access_token
+    # user_info_hsh = SimpleWx::UserInfo.get_auth_info(o_auth: instance_of_oauth)
+    #
+    # user_info_hsh = SimpleWx::UserInfo.get_basic_info(access_token: "token", openid: "openid")
+    #
+    # ---------- instance-methods -----------
+    #
+    # @user_info = SimpleWx::UserInfo.new(access_token: "token", openid: "openid")
+    # user_info_hsh = @user_info.get_basic_info
+    # if @user_info.error.present?
+    #   ...
+    # end
+    #
+
+    def initialize options
+      @openid = options[:openid]
+      @o_auth = options[:o_auth]
+      @access_token = options[:access_token] || AccessToken.access_token
+    end
+
+    def get_basic_info
+      url = "https://api.weixin.qq.com/cgi-bin/user/info?access_token=#{@access_token}&openid=#{@openid}&lang=zh_CN"
+      response = RestClient.get url
+      errcode_check(JSON.parse(response))
+    end
+
+    def get_auth_info
+      url = "https://api.weixin.qq.com/sns/userinfo?access_token=#{@o_auth.access_token}&openid=#{@o_auth.openid}&lang=zh_CN"
+      response = RestClient.get url
+      errcode_check(JSON.parse(response))
+    end
+
+    def self.method_missing m, hsh
+      if instance_methods.include? m.to_sym
+        self.new(hsh).send m
+      else
+        super
+      end
+    end
+  end
+end

data/lib/simple_wx/version.rb

@@ -0,0 +1,3 @@
+module SimpleWx
+  VERSION = "0.0.0"
+end

data/lib/simple_wx.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+require 'redis'
+require 'yell'
+
+module SimpleWx
+  @@weixin_config = {}
+  @@logger = Yell.new :datefile, 'simple_wx.log'
+  @@redis  = Redis.new(host: '127.0.0.1', port: '6379', db: '0')
+
+  def self.weixin_config
+    @@weixin_config
+  end
+
+  def self.logger
+    @@logger
+  end
+
+  def self.redis
+    @@redis
+  end
+end
+
+require 'simple_wx/base'
+require 'simple_wx/signaturer'
+require 'simple_wx/access_token'
+require 'simple_wx/menu'
+require 'simple_wx/user_info'
+require 'simple_wx/message'
+require 'simple_wx/messages/text_message'
+require 'simple_wx/messages/image_message'
+

data/simple_wx.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_wx/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_wx"
+  spec.version       = SimpleWx::VERSION
+  spec.authors       = ["Scott1743"]
+  spec.email         = ["512981271@qq.com"]
+  spec.summary       = ""
+  spec.description   = %q{Ruby Api for WeiXin}
+  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_dependency 'redis', '~> 3.2.1'
+  spec.add_dependency 'yell', '~> 2.0.0'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: simple_wx
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Scott1743
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+- !ruby/object:Gem::Dependency
+  name: yell
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Ruby Api for WeiXin
+email:
+- 512981271@qq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- README.md
+- config/initializers/simple_wx.rb.example
+- lib/simple_wx.rb
+- lib/simple_wx/access_token.rb
+- lib/simple_wx/base.rb
+- lib/simple_wx/menu.rb
+- lib/simple_wx/message.rb
+- lib/simple_wx/messages/image_message.rb
+- lib/simple_wx/messages/text_message.rb
+- lib/simple_wx/o_auth.rb
+- lib/simple_wx/signaturer.rb
+- lib/simple_wx/user_info.rb
+- lib/simple_wx/version.rb
+- simple_wx.gemspec
+homepage: 
+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: ''
+test_files: []