qy_wechat_api 1.0.0.beta1

data/lib/qy_wechat_api/handler/result_handler.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+module QyWechatApi
+
+  class ResultHandler
+
+    attr_accessor :code, :cn_msg, :en_msg, :result
+
+    def initialize(code, en_msg, result={})
+      @code   = code   || OK_CODE
+      @en_msg = en_msg || OK_MSG
+      @cn_msg = GLOBAL_CODES[@code.to_i]
+      @result = package_result(result)
+    end
+
+    # This method is to valid the current request if is true or is false
+    def is_ok?
+      code == OK_CODE
+    end
+    alias_method :ok?, :is_ok?
+
+    # e.g.:
+    # 45009: api freq out of limit(接口调用超过限制)
+    def full_message
+      "#{code}: #{en_msg}(#{cn_msg})."
+    end
+    alias_method :full_messages, :full_message
+
+    def full_error_message
+      full_message if !is_ok?
+    end
+    alias_method :full_error_messages, :full_error_message
+    alias_method :errors, :full_error_message
+
+    private
+
+      # if define Rails constant
+      # result = QyWechatApi::ResultHandler.new("0", "success", {:ok => "true"})
+      # result.result["ok"] #=> true
+      # result.result[:ok] #=> true
+      # result.result['ok'] #=> true
+      def package_result(result)
+        if defined?(Rails)
+          ActiveSupport::HashWithIndifferentAccess.new(result)
+        else
+          result
+        end
+      end
+
+  end
+
+end

data/lib/qy_wechat_api/storage/object_storage.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+module QyWechatApi
+  class ObjectStorage < Storage
+    def valid?
+      super
+    end
+
+    def token_expired?
+      # 如果当前token过期时间小于现在的时间，则重新获取一次
+      client.expired_at <= Time.now.to_i
+    end
+
+    def refresh_token
+      super
+    end
+
+    def access_token
+      super
+      client.access_token
+    end
+  end
+
+end

data/lib/qy_wechat_api/storage/redis_storage.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+module QyWechatApi
+  class RedisStorage < Storage
+    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-10) # 提前10秒超时
+    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
+  end
+
+end

data/lib/qy_wechat_api/storage/storage.rb

@@ -0,0 +1,75 @@
+# encoding: utf-8
+
+module QyWechatApi
+  class Storage
+
+    attr_accessor :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def self.init_with(client)
+      if QyWechatApi.weixin_redis.nil?
+        ObjectStorage.new(client)
+      else
+        RedisStorage.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_for_client(auth_result.result)
+        auth = true
+      end
+      {"valid" => auth, "handler" => auth_result}
+    end
+
+    def refresh_token
+      handle_valid_exception
+      set_access_token_for_client
+    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_for_client(access_token_infos=nil)
+      token_infos = access_token_infos || http_get_access_token.result
+      client.access_token = token_infos["access_token"]
+      client.expired_at   = Time.now.to_i + token_infos["expires_in"].to_i
+    end
+
+    def http_get_access_token
+      QyWechatApi.http_get_without_token("/gettoken", authenticate_headers)
+    end
+
+    def authenticate_headers
+      {corpid: client.corp_id, corpsecret: client.group_secret}
+    end
+
+    private
+
+      def handle_valid_exception
+        auth_result = authenticate
+        if !auth_result["valid"]
+          result_handler = auth_result["handler"]
+          raise Errors::ValidAccessTokenException, result_handler.full_error_message
+        end
+      end
+
+      def weixin_redis
+        QyWechatApi.weixin_redis
+      end
+  end
+end

data/lib/qy_wechat_api/version.rb

@@ -0,0 +1,3 @@
+module QyWechatApi
+  VERSION = "1.0.0.beta1"
+end

data/qy_wechat_api.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'qy_wechat_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "qy_wechat_api"
+  spec.version       = QyWechatApi::VERSION
+  spec.authors       = ["lanrion"]
+  spec.email         = ["huaitao-deng@foxmail.com"]
+  spec.summary       = %q{企业微信高级API Ruby版本}
+  spec.description   = %q{企业微信高级API Ruby版本}
+  spec.homepage      = "https://github.com/lanrion/qy_wechat_api"
+  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 "rest-client", ">= 1.6.7"
+    # A streaming JSON parsing and encoding library for Ruby (C bindings to yajl)
+  # https://github.com/brianmario/yajl-ruby
+  spec.add_dependency "yajl-ruby", "~> 1.2.0"
+
+  spec.add_dependency "carrierwave", "~> 0.10.0"
+  spec.add_dependency 'mini_magick', '~> 3.7.0'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/spec/api/media_spec.rb

@@ -0,0 +1,72 @@
+require "spec_helper"
+
+describe QyWechatApi::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/user/big_avatar/273.jpg"
+  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 File image" do
+    response = $client.media.upload(image_jpg_file, "image")
+    expect(response.code).to eq(QyWechatApi::OK_CODE)
+    expect(response.result.keys).to eq(["type", "media_id", "created_at"])
+  end
+
+  it "can upload a ico File image" do
+    response = $client.media.upload(image_ico_file, "image")
+    expect(response.code).to eq(QyWechatApi::OK_CODE)
+    expect(response.result.keys).to eq(["type", "media_id", "created_at"])
+  end
+
+  it "can upload a local image" do
+    response = $client.media.upload(image_jpg_path, "image")
+    expect(response.code).to eq(QyWechatApi::OK_CODE)
+    expect(response.result.keys).to eq(["type", "media_id", "created_at"])
+  end
+
+  it "can upload a local ico image" do
+    response = $client.media.upload(image_ico_path, "image")
+    expect(response.code).to eq(QyWechatApi::OK_CODE)
+    expect(response.result.keys).to eq(["type", "media_id", "created_at"])
+  end
+
+  it "can upload a remote png image" do
+    response = $client.media.upload(remote_png_path, "image")
+    expect(response.code).to eq(QyWechatApi::OK_CODE)
+    expect(response.result.keys).to eq(["type", "media_id", "created_at"])
+  end
+
+  it "can upload a remote jpg image" do
+    response = $client.media.upload(remote_jpg_path, "image")
+    expect(response.code).to eq(QyWechatApi::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.media.upload(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,60 @@
+require "spec_helper"
+
+describe QyWechatApi::Api::Menu do
+  let(:menu_string) do
+    '{
+      "button": [
+        {
+          "name": "扫码",
+          "sub_button": [
+            {
+              "type": "scancode_waitmsg",
+              "name": "扫码带提示",
+              "key": "rselfmenu_0_0",
+              "sub_button": [ ]
+            },
+            {
+              "type": "scancode_push",
+              "name": "扫码推事件",
+              "key": "rselfmenu_0_1",
+              "sub_button": [ ]
+            }
+          ]
+        },
+        {
+          "name": "发图",
+          "sub_button": [
+            {
+              "type": "pic_sysphoto",
+              "name": "系统拍照发图",
+              "key": "rselfmenu_1_0",
+              "sub_button": [ ]
+             },
+            {
+              "type": "pic_photo_or_album",
+              "name": "拍照或者相册发图",
+              "key": "rselfmenu_1_1",
+              "sub_button": [ ]
+            },
+            {
+              "type": "pic_weixin",
+              "name": "微信相册发图",
+              "key": "rselfmenu_1_2",
+              "sub_button": [ ]
+            }
+          ]
+        },
+        {
+          "name": "发送位置",
+          "type": "location_select",
+          "key": "rselfmenu_2_0"
+        }
+      ]
+    }'
+  end
+
+  it "#create" do
+    response = $client.menu.create(menu_string, 1)
+    expect(response.code).to eq(QyWechatApi::OK_CODE)
+  end
+end

data/spec/api/message_spec.rb

@@ -0,0 +1,50 @@
+require "spec_helper"
+describe QyWechatApi::Api::Message do
+  let(:text_message) do
+    "text 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_message" do
+    response = $client.message.send_text("@all", "@all", "@all", 1, text_message)
+    expect(response.code).to eq(QyWechatApi::OK_CODE)
+  end
+
+  it "#send_image_message" do
+    response = $client.media.upload(image_path, "image").result
+    response = $client.message.send_image("@all", "@all", "@all", 1, response["media_id"])
+    expect(response.code).to eq(QyWechatApi::OK_CODE)
+  end
+
+
+  it "#send_news" 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.message.send_news("@all", "@all", "@all", 1, articles)
+    expect(response.code).to eq(QyWechatApi::OK_CODE)
+  end
+
+  it "#send_file" do
+    response = $client.media.upload(image_path, "image").result
+    response = $client.message.send_file("@all", "@all", "@all", 1, response["media_id"])
+    expect(response.code).to eq(QyWechatApi::OK_CODE)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,115 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require "redis-namespace"
+require "redis"
+
+require "qy_wechat_api"
+require "pry-rails"
+corpid = "wxb9ce1d023fe6eb69"
+corpsecret = "UOofFIah4PVLmkG8xMH3lpDxj6NTnQSKMrFt-HubiPB4kjB09EmTVcUjgNeermps"
+
+
+# Comment to test for ClientStorage
+redis = Redis.new(:host => "127.0.0.1",:port => "6379")
+
+namespace = "qy_wechat_api:redis_storage"
+
+# cleanup keys in the current namespace when restart server everytime.
+exist_keys = redis.keys("#{namespace}:*")
+exist_keys.each{|key|redis.del(key)}
+
+redis_with_ns = Redis::Namespace.new("#{namespace}", :redis => redis)
+
+QyWechatApi.configure do |config|
+  config.redis = redis_with_ns
+end
+
+$client = QyWechatApi::Client.new(corpid, corpsecret)
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end