weixin_authorize_superayi 1.6.4

data/lib/weixin_authorize/token/redis_store.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+module WeixinAuthorize
+  module Token
+    class RedisStore < Store
+
+      def valid?
+       weixin_redis.del(client.redis_key)
+       super
+      end
+
+      def token_expired?
+        weixin_redis.hvals(client.redis_key).empty?
+      end
+
+      def refresh_token
+        super
+        weixin_redis.hmset(
+          client.redis_key, "access_token",
+          client.access_token, "expired_at",
+          client.expired_at
+        )
+        weixin_redis.expireat(client.redis_key, client.expired_at.to_i)
+      end
+
+      def access_token
+        super
+        client.access_token = weixin_redis.hget(client.redis_key, "access_token")
+        client.expired_at   = weixin_redis.hget(client.redis_key, "expired_at")
+        client.access_token
+      end
+
+      def weixin_redis
+        WeixinAuthorize.weixin_redis
+      end
+    end
+  end
+
+end

data/lib/weixin_authorize/token/store.rb

@@ -0,0 +1,72 @@
+# encoding: utf-8
+module WeixinAuthorize
+  module Token
+    class Store
+
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def self.init_with(client)
+        if WeixinAuthorize.weixin_redis.nil?
+          ObjectStore.new(client)
+        else
+          RedisStore.new(client)
+        end
+      end
+
+      def valid?
+        authenticate["valid"]
+      end
+
+      def authenticate
+        auth_result = http_get_access_token
+        auth = false
+        if auth_result.is_ok?
+          set_access_token(auth_result.result)
+          auth = true
+        end
+        {"valid" => auth, "handler" => auth_result}
+      end
+
+      def refresh_token
+        handle_valid_exception
+        set_access_token
+      end
+
+      def access_token
+        refresh_token if token_expired?
+      end
+
+      def token_expired?
+        raise NotImplementedError, "Subclasses must implement a token_expired? method"
+      end
+
+      def set_access_token(access_token_infos=nil)
+        token_infos = access_token_infos || http_get_access_token.result
+        client.access_token = token_infos["access_token"]
+        client.expired_at = WeixinAuthorize.calculate_expire(token_infos["expires_in"])
+      end
+
+      def http_get_access_token
+        WeixinAuthorize.http_get_without_token("/token", authenticate_headers)
+      end
+
+      def authenticate_headers
+        {grant_type: GRANT_TYPE, appid: client.app_id, secret: client.app_secret}
+      end
+
+      private
+
+        def handle_valid_exception
+          auth_result = authenticate
+          if !auth_result["valid"]
+            result_handler = auth_result["handler"]
+            raise ValidAccessTokenException, result_handler.full_error_message
+          end
+        end
+    end
+  end
+end

data/lib/weixin_authorize/version.rb

@@ -0,0 +1,3 @@
+module WeixinAuthorize
+  VERSION = "1.6.4"
+end

data/lib/weixin_authorize.rb

@@ -0,0 +1,97 @@
+require "rest-client"
+require "carrierwave"
+if defined? Yajl
+  require 'yajl/json_gem'
+else
+  require "json"
+end
+require "erb"
+
+require "weixin_authorize/carrierwave/weixin_uploader"
+require "weixin_authorize/config"
+require "weixin_authorize/handler"
+require "weixin_authorize/api"
+require "weixin_authorize/client"
+
+module WeixinAuthorize
+
+  # token store
+  module Token
+    autoload(:Store,       "weixin_authorize/token/store")
+    autoload(:ObjectStore, "weixin_authorize/token/object_store")
+    autoload(:RedisStore,  "weixin_authorize/token/redis_store")
+  end
+
+  module JsTicket
+    autoload(:Store,       "weixin_authorize/js_ticket/store")
+    autoload(:ObjectStore, "weixin_authorize/js_ticket/object_store")
+    autoload(:RedisStore,  "weixin_authorize/js_ticket/redis_store")
+  end
+
+  OK_MSG  = "ok".freeze
+  OK_CODE = 0.freeze
+  GRANT_TYPE = "client_credential".freeze
+  # 用于标记endpoint可以直接使用url作为完整请求API
+  CUSTOM_ENDPOINT = "custom_endpoint".freeze
+
+  class << self
+
+    def http_get_without_token(url, url_params={}, endpoint="plain")
+      get_api_url = endpoint_url(endpoint, url)
+      load_json(resource(get_api_url).get(params: url_params))
+    end
+
+    def http_post_without_token(url, post_body={}, url_params={}, endpoint="plain")
+      post_api_url = endpoint_url(endpoint, url)
+      # to json if invoke "plain"
+      if endpoint == "plain" || endpoint == CUSTOM_ENDPOINT
+        post_body = JSON.dump(post_body)
+      end
+      load_json(resource(post_api_url).post(post_body, params: url_params))
+    end
+
+    def resource(url)
+      RestClient::Resource.new(url, rest_client_options)
+    end
+
+    # return hash
+    def load_json(string)
+      result_hash = JSON.parse(string.force_encoding("UTF-8").gsub(/[\u0011-\u001F]/, ""))
+      code   = result_hash.delete("errcode")
+      en_msg = result_hash.delete("errmsg")
+      ResultHandler.new(code, en_msg, result_hash)
+    end
+
+    def endpoint_url(endpoint, url)
+      # 此处为了应对第三方开发者如果自助对接接口时，URL不规范的情况下，可以直接使用URL当为endpoint
+      return url if endpoint == CUSTOM_ENDPOINT
+      send("#{endpoint}_endpoint") + url
+    end
+
+    def plain_endpoint
+      "#{api_endpoint}/cgi-bin"
+    end
+
+    def api_endpoint
+      "https://api.weixin.qq.com"
+    end
+
+    def file_endpoint
+      "http://file.api.weixin.qq.com/cgi-bin"
+    end
+
+    def mp_endpoint(url)
+      "https://mp.weixin.qq.com/cgi-bin#{url}"
+    end
+
+    def open_endpoint(url)
+      "https://open.weixin.qq.com#{url}"
+    end
+
+    def calculate_expire(expires_in)
+      Time.now.to_i + expires_in.to_i - key_expired.to_i
+    end
+
+  end
+
+end

data/spec/1_fetch_access_token_spec.rb

@@ -0,0 +1,43 @@
+# NOTE: the rspec should be test alonely.
+describe WeixinAuthorize::Client do
+  describe "#get access_token" do
+    it "return a access_token nil value before authenticate" do
+      expect($client.access_token).to eq(nil)
+    end
+
+    it "appid and appsecret shoud be valid" do
+      valid_info = $client.is_valid?
+      expect(valid_info).to eq(true)
+    end
+
+    it "return the same access_token in the same thing twice" do
+      access_token_1 = $client.get_access_token
+      sleep 5
+      access_token_2 = $client.get_access_token
+      expect(access_token_1).to eq(access_token_2)
+    end
+
+    it "return errorcode and errormsg when appid or appsecret is invalid" do
+      $client_1  = WeixinAuthorize::Client.new("appid", "app_secret")
+      valid_info = $client_1.is_valid?
+      expect(valid_info).to eq(false)
+    end
+
+    it "#get_access_token should raise error if app_secret or appid is invalid" do
+      $client_2 = WeixinAuthorize::Client.new("appid_2", "app_secret_2")
+      expect{$client_2.get_access_token}.to raise_error(RuntimeError)
+    end
+
+    it "#token_expired return the different access_token after token is expired" do
+      token_1 = $client.get_access_token
+      if WeixinAuthorize.weixin_redis.nil?
+        $client.expired_at = Time.now.to_i - 7300
+      else
+        WeixinAuthorize.weixin_redis.del($client.redis_key)
+      end
+      token_2 = $client.get_access_token
+      expect(token_1).to_not eq(token_2)
+    end
+
+  end
+end

data/spec/2_fetch_jsticket_spec.rb

@@ -0,0 +1,10 @@
+describe WeixinAuthorize::Client do
+  describe "#get jsticket" do
+    it "return the same jsticket in the same thing twice" do
+      js_ticket_1 = $client.get_jsticket
+      sleep 5
+      js_ticket_2 = $client.get_jsticket
+      expect(js_ticket_1).to eq(js_ticket_2)
+    end
+  end
+end

data/spec/api/custom_spec.rb

@@ -0,0 +1,71 @@
+describe WeixinAuthorize::Api::Custom do
+  let(:text_message) do
+    "text Custom message"
+  end
+
+  let(:image_path) do
+    "#{File.dirname(__FILE__)}/medias/ruby-logo.jpg"
+  end
+
+  let(:image_file) do
+    File.new(image_path)
+  end
+
+  it "#send_text_custom" do
+    response = $client.send_text_custom(ENV["OPENID"], text_message)
+    expect(response.code).to eq(WeixinAuthorize::OK_CODE)
+  end
+
+  it "#send_news_custom" do
+    articles = [{
+                  "title" => "Happy Day",
+                  "description" => "Is Really A Happy Day",
+                  "url"   => "http://www.baidu.com",
+                  "picurl" => "http://www.baidu.com/img/bdlogo.gif"
+                },
+                {
+                  "title" => "Happy Day",
+                  "description" => "Is Really A Happy Day",
+                  "url"  => "http://www.baidu.com",
+                  "picurl"=> "http://www.baidu.com/img/bdlogo.gif"
+                }]
+    response = $client.send_news_custom(ENV["OPENID"], articles)
+    expect(response.code).to eq(WeixinAuthorize::OK_CODE)
+  end
+
+  it "#send_image_custom" do
+    image = $client.upload_media(image_file, "image")
+    media_id = image.result["media_id"]
+    response = $client.send_image_custom(ENV["OPENID"], media_id)
+    expect(response.code).to eq(WeixinAuthorize::OK_CODE)
+  end
+
+  it "#send_video_custom" do
+    pending("The test must have a media_id")
+  end
+
+  it "#send_mpnews_custom" do
+    pending("The test must have a media_id")
+  end
+
+  it "#send_music_custom" do
+    pending("The test must have a media_id")
+  end
+
+  it "#send_voice_custom" do
+    pending("The test must have a media_id")
+  end
+
+  it "#get_custom_msg_record" do
+    option = {pageindex: 1, pagesize: 10}
+    response = $client.get_custom_msg_record(Time.now - 10.days, Time.now, option)
+    expect(response.code).to eq(WeixinAuthorize::OK_CODE)
+    expect(response.result.keys).to eq(["recordlist", "retcode"])
+  end
+
+  it "#create_kf_session" do
+    response = $client.create_kf_session("test1@test", ENV["APPID"], "test kfsession")
+    expect(response.code).to eq(WeixinAuthorize::OK_CODE)
+  end
+
+end

data/spec/api/groups_spec.rb

@@ -0,0 +1,74 @@
+describe WeixinAuthorize::Api::Groups do
+
+  let(:group_name) do
+    "test group_name"
+  end
+
+  let(:group_name_2) do
+    "test group_name_2"
+  end
+
+  let(:groups) do
+    $client.groups
+  end
+
+  let(:last_group_id) do
+    groups.result["groups"][-1]["id"]
+  end
+
+  it "#delete all group step by step" do
+    group_ids = groups.result["groups"].collect{|group|group["id"]}
+    group_ids.each do |group_id|
+      res = $client.delete_group(group_id)
+      if res.code.to_s != "45009"
+        expect(res.code).to eq(WeixinAuthorize::OK_CODE)
+      end
+    end
+  end
+
+  it "create a group" do
+    response = $client.create_group(group_name)
+    if response.code == WeixinAuthorize::OK_CODE
+      expect(response.result["group"]["name"]).to eq(group_name)
+    else
+      expect(response.code).to eq(-1)
+      puts "WEIXIN says: system error"
+    end
+  end
+
+  it "get groups" do
+    expect(groups.result["groups"][-1]["name"]).to eq(group_name)
+  end
+
+  it "#get_group_for ENV['OPENID']" do
+    group = $client.get_group_for(ENV["OPENID"])
+    expect(group.result.keys).to eq(["groupid"])
+  end
+
+  it "#update_group_name" do
+    response = $client.create_group(group_name)
+    if response.code != WeixinAuthorize::OK_CODE
+      expect(response.code).to eq(-1)
+      puts "WEIXIN says: system error"
+    else
+      expect(response.result["group"]["name"]).to eq(group_name)
+      response = $client.update_group_name(response.result["group"]["id"], group_name_2)
+      expect(response.code).to eq(WeixinAuthorize::OK_CODE)
+      groups = $client.groups
+      expect(groups.result["groups"][-1]["name"]).to eq(group_name_2)
+    end
+  end
+
+  it "#update_group_for_openid" do
+    $client.update_group_for_openid(ENV["OPENID"], last_group_id)
+    group = $client.get_group_for(ENV["OPENID"])
+    expect(group.result["groupid"]).to eq(last_group_id)
+    $client.update_group_for_openid(ENV["OPENID"], 0)
+  end
+
+  it "#batch update group for openids" do
+    res = $client.batch_update_group_for_openids([ENV["OPENID"]], last_group_id)
+    expect(res.code).to eq(WeixinAuthorize::OK_CODE)
+  end
+
+end

data/spec/api/mass_spec.rb

@@ -0,0 +1,70 @@
+require "spec_helper"
+
+describe WeixinAuthorize::Api::Mass do
+
+  let(:image_jpg_path) do
+    "#{File.dirname(__FILE__)}/medias/ruby-logo.jpg"
+  end
+
+  let(:news_media_1) do
+    {
+      "thumb_media_id" => "",
+      "author" => "lanrion",
+      "title"  => "Happy Day",
+      "content_source_url" => "www.qq.com",
+      "content" => "content",
+      "digest"  => "digest"
+    }
+  end
+
+  let(:image_media_id) do
+    # Get image media_id
+    image_media = $client.upload_media(image_jpg_path, "image")
+    media_id    = image_media.result["media_id"]
+    media_id
+  end
+
+  let(:mass_media_id) do
+    media       = {"thumb_media_id" => image_media_id}
+    news_media  = news_media_1.merge(media)
+
+    # upload news media
+    response = $client.upload_mass_news([news_media])
+    mass_media_id = response.result["media_id"]
+    mass_media_id
+  end
+
+  it "#upload_mass_news" do
+    media       = {"thumb_media_id" => image_media_id}
+    news_media  = news_media_1.merge(media)
+
+    # upload news media
+    response = $client.upload_mass_news([news_media])
+    expect(response.code).to eq(WeixinAuthorize::OK_CODE)
+    expect(response.result.keys).to eq(["type", "media_id", "created_at"])
+  end
+
+  it "#mass_with_group with mpnews" do
+    response = $client.mass_with_group("1", "mass_group_text", "text")
+    expect(response.code).to eq(WeixinAuthorize::OK_CODE)
+  end
+
+  it "#mass_with_groug send to all" do
+    response = $client.mass_with_group("1", "mass_group_text_to_all", "text", true)
+    expect(response.code).to eq(WeixinAuthorize::OK_CODE)
+  end
+
+  it "#mass_with_openids with mpnews and can delete message" do
+    response = $client.mass_with_openids([ENV["OPENID"]], mass_media_id)
+    expect(response.code).to eq(WeixinAuthorize::OK_CODE)
+    expect(response.result.keys).to eq(["msg_id"])
+    delete_res = $client.mass_delete_with_msgid(response.result["msg_id"])
+    expect(delete_res.code).to eq(WeixinAuthorize::OK_CODE)
+  end
+
+  it "#mass_preview can preview by openid" do
+    response = $client.mass_preview(ENV["OPENID"], "mass_text", "text")
+    expect(response.code).to eq(WeixinAuthorize::OK_CODE)
+  end
+
+end

data/spec/api/media_spec.rb

@@ -0,0 +1,82 @@
+describe WeixinAuthorize::Api::Media do
+
+  let(:image_jpg_path) do
+    "#{File.dirname(__FILE__)}/medias/ruby-logo.jpg"
+  end
+
+  let(:image_ico_path) do
+    "#{File.dirname(__FILE__)}/medias/favicon.ico"
+  end
+
+  let(:image_jpg_file) do
+    File.new(image_jpg_path)
+  end
+
+  let(:image_ico_file) do
+    File.new(image_ico_path)
+  end
+
+  let(:remote_png_path) do
+    "https://ruby-china-files.b0.upaiyun.com/photo/5982eaaa64f467d9dbda03ad4f40ea27.png"
+  end
+
+  let(:remote_jpg_path) do
+    "http://g.hiphotos.baidu.com/baike/c0%3Dbaike80%2C5%2C5%2C80%2C26/sign=ce55457e4334970a537e187df4a3baad/03087bf40ad162d99455ef4d13dfa9ec8b13632762d0ed14.jpg"
+  end
+
+  it "can upload a jpg image and get url" do
+    response = $client.upload_image(image_jpg_file)
+    expect(response.code).to eq(WeixinAuthorize::OK_CODE)
+    expect(response.result.keys).to eq(["url"])
+  end
+
+  it "can upload a png image and get url" do
+    response = $client.upload_image(remote_png_path)
+    expect(response.code).to eq(WeixinAuthorize::OK_CODE)
+    expect(response.result.keys).to eq(["url"])
+  end
+
+  it "can upload a jpg File image" do
+    response = $client.upload_media(image_jpg_file, "image")
+    expect(response.code).to eq(WeixinAuthorize::OK_CODE)
+    expect(response.result.keys).to eq(["type", "media_id", "created_at"])
+  end
+
+  it "can upload a ico File image" do
+    response = $client.upload_media(image_ico_file, "image")
+    expect(response.code).to eq(WeixinAuthorize::OK_CODE)
+    expect(response.result.keys).to eq(["type", "media_id", "created_at"])
+  end
+
+  it "can upload a local image" do
+    response = $client.upload_media(image_jpg_path, "image")
+    expect(response.code).to eq(WeixinAuthorize::OK_CODE)
+    expect(response.result.keys).to eq(["type", "media_id", "created_at"])
+  end
+
+  it "can upload a local ico image" do
+    response = $client.upload_media(image_ico_path, "image")
+    expect(response.code).to eq(WeixinAuthorize::OK_CODE)
+    expect(response.result.keys).to eq(["type", "media_id", "created_at"])
+  end
+
+  it "can upload a remote png image" do
+    response = $client.upload_media(remote_png_path, "image")
+    expect(response.code).to eq(WeixinAuthorize::OK_CODE)
+    expect(response.result.keys).to eq(["type", "media_id", "created_at"])
+  end
+
+  it "can upload a remote jpg image" do
+    response = $client.upload_media(remote_jpg_path, "image")
+    expect(response.code).to eq(WeixinAuthorize::OK_CODE)
+    expect(response.result.keys).to eq(["type", "media_id", "created_at"])
+  end
+
+  it "#download_media_url return a String url" do
+    image = $client.upload_media(image_ico_path, "image")
+    media_id = image.result["media_id"]
+    image_url = $client.download_media_url(media_id)
+    expect(image_url.class).to eq(String)
+  end
+
+end

data/spec/api/menu_spec.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+describe WeixinAuthorize::Api::Menu do
+
+  it "can create a menu" do
+    menu = '{"button":[{"type":"click","name":"今日歌曲","key":"V1001_TODAY_MUSIC"},{"type":"click","name":"歌手简介","key":"V1001_TODAY_SINGER"},{"name":"菜单","sub_button":[{"type":"view","name":"搜索","url":"http://www.soso.com/"},{"type":"view","name":"视频","url":"http://v.qq.com/"},{"type":"click","name":"赞一下我们","key":"V1001_GOOD"}]}]}'
+    response = $client.create_menu(JSON.load(menu)) # or Json string
+    expect(response.code).to eq(WeixinAuthorize::OK_CODE)
+  end
+
+  it "can't create a menu if invalid button size" do
+    menu = '{"button":[]}'
+    response = $client.create_menu(menu)
+    expect(response.code).not_to eq(WeixinAuthorize::OK_CODE)
+  end
+
+  it "can get a weixin Menu info" do
+    menu_info = $client.menu
+    expect(menu_info.result.keys[0]).to eq("menu")
+    expect(menu_info.code).to eq(WeixinAuthorize::OK_CODE)
+  end
+
+  it "can delete weixin Menu" do
+    response = $client.delete_menu
+    expect(response.code).to eq(WeixinAuthorize::OK_CODE)
+  end
+end

data/spec/api/qrcode_spec.rb

@@ -0,0 +1,22 @@
+describe WeixinAuthorize::Api::Qrcode do
+
+  it "#create_qr_scene" do
+    response = $client.create_qr_scene("123")
+    expect(response.code).to eq(WeixinAuthorize::OK_CODE)
+    expect(response.result.keys).to eq(["ticket", "expire_seconds", "url"])
+    expect(response.result["expire_seconds"]).to eq(1800)
+  end
+
+  it "#create_qr_limit_scene" do
+    response = $client.create_qr_limit_scene(scene_id: 1234, scene_str: "wechat")
+    expect(response.code).to eq(WeixinAuthorize::OK_CODE)
+    expect(response.result.keys).to eq(["ticket", "url"])
+  end
+
+  it "#return_qr_url" do
+    response = $client.create_qr_limit_scene(scene_id: 1234, scene_str: "wechat")
+    qr_url = $client.qr_code_url(response.result["ticket"])
+    expect(response.code).to eq(WeixinAuthorize::OK_CODE)
+    expect(qr_url).to match(/(\S+\.(com|net|org|edu|gov)(\/\S+)?)/)
+  end
+end

data/spec/api/template_spec.rb

@@ -0,0 +1,40 @@
+describe WeixinAuthorize::Api::Template do
+  # {{first.DATA}}
+  # 项目名称：{{class.DATA}}
+  # 时间：{{time.DATA}}
+  # 地点：{{add.DATA}}
+  # {{remark.DATA}}
+  it "can send template msg" do
+    url = "http://www.baidu.com"
+    data = {
+      first: {
+        value: "报名结果通知",
+        color: "#173277"
+      },
+      class: {
+        value: "领导与管理课程培训/人格测评",
+        color: "#173177"
+      },
+      time: {
+        value: "11月6日—11月7日（周三—周五)",
+        color: "#274177"
+      },
+      add: {
+        value: "F302室",
+        color: "#274377"
+      },
+      remark: {
+        value: "您可点击【详情】查看详细信息。",
+        color: "#274377"
+      }
+    }
+    msg_result = $client.send_template_msg(
+      ENV["OPENID"],
+      ENV["TEMPLATE_ID"],
+      url,
+      "#173177",
+      data
+    )
+    expect(msg_result.code).to eq(WeixinAuthorize::OK_CODE)
+  end
+end

data/spec/api/user_spec.rb

@@ -0,0 +1,26 @@
+describe WeixinAuthorize::Api::User do
+  it "can get a weixin User info" do
+    user_info = $client.user(ENV["OPENID"])
+    expect(user_info.code).to eq(WeixinAuthorize::OK_CODE)
+    expect(user_info.result["openid"]).to eq(ENV["OPENID"])
+  end
+
+  it "can get followers infos" do
+    valid_info = $client.is_valid?
+    expect(valid_info).to eq(true)
+    followers = $client.followers
+    expect(followers.code).to eq(WeixinAuthorize::OK_CODE)
+    expect(followers.result.keys).to eq(["total", "count", "data", "next_openid"])
+
+    valid_info = $client.is_valid?
+    expect(valid_info).to eq(true)
+    followers = $client.followers
+    expect(followers.code).to eq(WeixinAuthorize::OK_CODE)
+    expect(followers.result.keys).to eq(["total", "count", "data", "next_openid"])
+  end
+
+  it "can update user remark" do
+    user_info = $client.update_remark(ENV["OPENID"], "dylan")
+    expect(user_info.code).to eq(WeixinAuthorize::OK_CODE)
+  end
+end