motion-wechat 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a409062ddf8847ec76ba44d7ae20f22a348dd64
-  data.tar.gz: 05889ac31ada26aeff34b322394079af15225937
+  metadata.gz: a19b83c93b6167b56d74f08b976f73c5156af0f7
+  data.tar.gz: 8cbb139358b5a526d01faa0f29bedb8556a4268b
 SHA512:
-  metadata.gz: 0dc82eb924adcabbb06435befe515d61abcc3d5f8d83f90ee66e4e7a626ee90329f4385f88fed4bb9e30a2b3b6e40d7daa78a36131a0b418643a2e4085b04322
-  data.tar.gz: af65871c625af76f838d17f8dbcc745ffa1cc544364fefa59773365d955ad2673a69abd2f85d7976870f26765f1b3c19388ee8ec9939ff7ef7b5aa273be75d08
+  metadata.gz: a9eed5cd35a4eedb2e812f4f99b0eb033ffe5e93a70105b5081e7de0d90f9cbe90959417351c303c4d1bd88e8a471d7748b1c6bf9364273de299c7fd4c2f1149
+  data.tar.gz: 4f99a7c8c256c55415292459e0b40253fa7c44ba9fa76dd17e40d1bd7105033c7fa829c887359d1e7b40f7fa413120247f6573a7f50814d6475e6abc1fd43eba

data/README.md

@@ -24,6 +24,12 @@ Then setup configuration in your Rakefile:
 MotionWechat::Config.setup(app, 'app_key', 'app_secret')
 ```
 
+Then register app in your `app_delegate.rb`
+```ruby
+MotionWechat::API.instance.registerApp @key
+```
+
+
 Usage
 ==========
 
@@ -34,8 +40,41 @@ MotionWechat::API.instance.send_webpage "http://www.rubymotion.com", \
   title: "Ruby Motion", description: "Awesome way to write ios/osx app"
 ```
 
+Wechat Authorization:
+
+#### 1. authorize, this will direct user to wechat app
+```ruby
+MotionWechat::API.instance.authorize
+```
+
+#### 2. then make sure you have weixin delegate set up in `app_delegate.rb`
+```ruby
+def application(application, handleOpenURL:url)
+  WXApi.handleOpenURL(url, delegate:self)
+end
+
+def application(application, openURL:url, sourceApplication:sourceApplication, annotation:annotation)
+  WXApi.handleOpenURL(url, delegate:self)
+end
+```
+
+#### 3. set up `onResp` in `app_delegate.rb`. this is when it comes back from wexin app
+```ruby
+def onResp(resp)
+  if resp.is_a? SendAuthResp
+    # token lang country code
+    MotionWechat::API.instance.registerClient resp.code
+    MotionWechat::API.instance.get_user_info do |info|
+      p info
+    end
+  end
+end
+```
+
+
 ## TODO
 - delegate helpers, i.e. `WXApi.handleOpenURL(url, delegate:self)`
+- state & key validating in `application(application, handleOpenURL:url)`
 
 ## Contributions
 

data/lib/motion-wechat.rb

@@ -2,6 +2,8 @@ unless defined?(Motion::Project::Config)
   raise "This file must be required within a RubyMotion project Rakefile."
 end
 
+require 'afmotion'
+require 'bubble-wrap/core'
 require_relative 'motion-wechat/config'
 
 Motion::Project::App.setup do |app|
@@ -11,4 +13,9 @@ Motion::Project::App.setup do |app|
 
   app.vendor_project 'vendor/SDKExport', :static
 
+  app.pods ||= Motion::Project::CocoaPods.new(app)
+  app.pods do
+	  pod 'AFNetworking'
+	end
+
 end

data/lib/motion-wechat/access_token.rb

@@ -0,0 +1,86 @@
+module MotionWechat
+  class AccessToken
+    attr_reader :client, :token, :expires_in, :openid, :params
+    attr_accessor :options, :refresh_token
+
+    class << self
+
+      # Initializes an AccessToken from a Hash
+      #
+      # Example:
+      #   MotionWechat::AccessToken.from_hash @client, {}
+      #
+      # Arguments:
+      #   client: (MotionWechat::Client)
+      #   hash: (Hash)
+      #
+      def from_hash(client, hash)
+        new(client, hash.delete('access_token') || hash.delete(:access_token), hash)
+      end
+
+    end
+
+    # Initalize an AccessToken
+    #
+    # Example:
+    #   MotionWechat::AccessToken.new @client, 'token', {}
+    #
+    # Arguments:
+    #   client: (MotionWechat::Client)
+    #   token: (String)
+    #   hash: (Hash)
+    #
+    def initialize(client, token, opts = {})
+      @client = client
+      @token = token.to_s
+      [:refresh_token, :expires_in, :openid].each do |arg|
+        instance_variable_set("@#{arg}", opts.delete(arg) || opts.delete(arg.to_s))
+      end
+      @expires_in ||= opts.delete('expires')
+      @expires_at ||= Time.now.to_i + @expires_in.to_i
+      @params = opts
+    end
+
+    # Get information using access token
+    #
+    # Example:
+    #   @token.get "/sns/userinfo", { |res| ... }
+    #
+    # Arguments:
+    #   path: (String)
+    #   opts: (hash)
+    #
+    def get(path, opts = {}, &block)
+      @client.get path, opts.merge({access_token: @token}), &block
+    end
+
+    # Get user information
+    #
+    # Example:
+    #   @token.get_user_info { |info| ... }
+    #
+    def get_user_info(&block)
+      get "/sns/userinfo", openid: @openid do |info|
+        block.call oauth2_wrapp(info)
+      end
+    end
+
+    private
+
+    # Wrap with OAuth2 structure
+    def oauth2_wrapp(info)
+      {
+        uid: @openid,
+        provider: "weixin",
+        info: {
+          image: info['headimgurl'],
+          nickname: info['nickname'],
+          name: info['nickname']
+        },
+        extra: info
+      }
+    end
+
+  end
+
+end

data/lib/motion-wechat/api.rb

@@ -2,13 +2,80 @@ module MotionWechat
   module API
 
     InvalidMediaObject = Class.new StandardError
+    InvalidClientError = Class.new ArgumentError
+
     def wx; WXApi; end
 
-    # initialize weixin API using key and secret
+    # Initialize weixin API using key and secret
+    #
+    # Example:
+    #   MtionWechat::API.new 'key', 'secret'
+    #
+    # Arguments:
+    #   key: (String)
+    #   secret: (String)
+    #   options: (Hash)
+    #
     def initialize(key, secret, options={})
       @key    = key
       @secret = secret
-      WXApi.registerApp(@key)
+    end
+
+    # Register weixin app, usually put in `app_delegate.rb`
+    #
+    # Example:
+    #   MotionWechat::API.instance.registerApp
+    #
+    def registerApp
+      WXApi.registerApp @key
+    end
+
+    # Register client
+    #
+    # Example:
+    #   MotionWechat::API.instance.registerClient "code"
+    #
+    # Arguments:
+    #   code: (String)
+    #
+    def registerClient(code)
+      @client ||= MotionWechat::Client.new @key, @secret, code
+    end
+
+    # Get user information
+    #
+    # Example:
+    #   MotionWechat::API.instance.get_user_info { |info| ... }
+    #
+    def get_user_info(&block)
+      raise InvalidClientError if @client.nil?
+      if @token.nil?
+        @client.get_token do |token|
+          @token = token
+          @token.get_user_info { |info| block.call info }
+        end
+      else
+        @token.get_user_info { |info| block.call info }
+      end
+    end
+
+    # Sends authorization request
+    #
+    # Example:
+    #   MotionWechat::API.instance.authorize
+    #
+    # Arguments:
+    #   opts: (Hash), state: "myapp"
+    #
+    def authorize(opts={})
+      options = {
+        scope: "snsapi_userinfo",
+        state: "motion-wechat-app"
+      }.merge(opts)
+      req = SendAuthReq.alloc.init
+      req.scope = options[:scope]
+      req.state = options[:state]
+      WXApi.sendReq(req)
     end
 
     # Returns singleton instance of MotionWechat
@@ -20,6 +87,11 @@ module MotionWechat
       @instance ||= new config["key"], config["secret"]
     end
 
+    # Returns info_plist_key of MotionWechat
+    #
+    # Example:
+    #   MotionWechat::API.config
+    #
     def self.config
       NSBundle.mainBundle.objectForInfoDictionaryKey MotionWechat::Config.info_plist_key
     end

data/lib/motion-wechat/client.rb

@@ -0,0 +1,75 @@
+module MotionWechat
+  class Client
+    attr_reader :id, :secret, :site
+    attr_accessor :options
+
+    # Instantiate a new OAuth 2.0 client using the Client ID
+    # and Client Secret registered to your application.
+    #
+    # Example:
+    #   MtionWechat::Client.new 'key', 'secret', 'code', {}
+    #
+    # Arguments:
+    #   key: (String)
+    #   secret: (String)
+    #   code: (String)
+    #   options: (Hash)
+    #
+    def initialize(client_id, client_secret, code, options = {})
+      opts      = options.dup
+      @id       = client_id
+      @secret   = client_secret
+      @code     = code
+      @site     = opts[:site] || "https://api.weixin.qq.com"
+      @options  = {
+        token_url: '/sns/oauth2/access_token'
+      }.merge(opts)
+    end
+
+    # Returns token url to get access token
+    #
+    # Example:
+    #   @client.token_url
+    #
+    def token_url
+      @site + @options[:token_url]
+    end
+
+    # Returns token url to get access token
+    #
+    # Example:
+    #   @client.get_token do |token|
+    #     p token
+    #   end
+    #
+    def get_token(&block)
+      params = "appid=#{@id}&secret=#{@secret}&code=#{@code}&grant_type=authorization_code"
+      AFMotion::HTTP.get(token_url + "?" + params) do |res|
+        hash  = to_hash res.body.to_s
+        token = AccessToken.from_hash self, hash
+        block.call token
+      end
+    end
+
+    # Request information
+    #
+    # Example:
+    #   @client.get '/sns/userinfo', openid: "openid" do |info|
+    #     p info
+    #   end
+    #
+    def get(path, opts = {}, &block)
+      AFMotion::HTTP.get(@site + path, opts) do |res|
+        hash = to_hash res.body.to_s
+        block.call hash
+      end
+    end
+
+    private
+
+    def to_hash(string)
+      BW::JSON.parse string.dataUsingEncoding(NSString.defaultCStringEncoding)
+    end
+
+  end
+end

data/lib/motion-wechat/config.rb

@@ -2,9 +2,8 @@ module MotionWechat
   module Config
     extend self
 
-    def info_plist_key
-      "WechatConfig"
-    end
+    def info_plist_key; "WechatConfig"; end
+    def key; @key; end
 
     # Setup wechat information to rubymotion app, i.e. key, secret...
     #
@@ -20,13 +19,11 @@ module MotionWechat
     #   Wechat key:     (String)
     #   Wechat secret:  (String)
     #   other options:  (Hash)
-    def setup(app, key, secret, opts={})
-      options = {
-        key: key,
-        secret: secret
-      }.merge(opts)
+    def setup(app, key, secret)
+      @key = key
+      @secret = secret
 
-      app.info_plist[info_plist_key] = options.select { |k| k == :key || k == :secret }
+      app.info_plist[info_plist_key] = { key: @key, secret: @secret }
 
       bundle_url_types = [
           { 'CFBundleURLName'    => "weixin",
@@ -34,8 +31,8 @@ module MotionWechat
         ]
 
       app.info_plist['CFBundleURLTypes'] ||= []
-      app.info_plist['CFBundleURLTypes'] << bundle_url_types
-      
+      app.info_plist['CFBundleURLTypes'] += bundle_url_types
+
     end
 
   end

data/lib/motion-wechat/version.rb

@@ -1,3 +1,3 @@
 module MotionWechat
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/spec/motion-wechat/access_token_spec.rb

@@ -0,0 +1,69 @@
+describe MotionWechat::AccessToken do
+  extend WebStub::SpecHelpers
+
+  before do
+    disable_network_access!
+    hash = {
+      access_token: "access_token",
+      expires_in:7200,
+      refresh_token:"refresh_token",
+      openid:"openid",
+      scope:"snsapi_userinfo"
+    }
+    @client = MotionWechat::Client.new "appid", "appsecret", "code"
+    @token  = MotionWechat::AccessToken.from_hash @client, hash
+  end
+
+  it "should get client, token and expires" do
+    @token.client.should.be.kind_of MotionWechat::Client
+    @token.token.should == "access_token"
+    @token.expires_in.should == 7200
+    @token.openid.should == "openid"
+  end
+
+  context "get info" do
+
+    before do
+      @res = File.read NSBundle.mainBundle.resourcePath.stringByAppendingPathComponent("user.json")
+      @url = "https://api.weixin.qq.com/sns/userinfo?access_token=access_token&openid=openid"
+    end
+
+    it "gets user info using get" do
+      stub_request(:get, @url).
+              to_return(json: @res)
+      @res = nil
+
+      @token.get("/sns/userinfo", openid: "openid") do |info|
+        @info = info
+        resume
+      end
+
+      wait_max 1.0 do
+        @info.should.be.kind_of Hash
+        @info["nickname"].should == "monkey"
+      end
+    end
+
+    it "gets user info using get" do
+      stub_request(:get, @url).
+              to_return(json: @res)
+      @res = nil
+
+      @token.get_user_info do |info|
+        @info = info
+        resume
+      end
+
+      wait_max 1.0 do
+        @info.should.be.kind_of Hash
+        @info[:uid].should == "openid"
+        @info[:provider].should == "weixin"
+        @info[:info][:image].should == "http://wx.qlogo.cn/mmopen/0"
+        @info[:info][:nickname].should == "monkey"
+      end
+    end
+
+  end
+
+
+end

data/spec/motion-wechat/api_spec.rb

@@ -4,7 +4,7 @@ describe MotionWechat::API do
     WXApi.stub!(:registerApp) do |key|
       key.should == "app_key"
     end
-    MotionWechat::API.instance
+    MotionWechat::API.instance.registerApp
   end
 
   it "should return WXApi as wx" do
@@ -15,6 +15,14 @@ describe MotionWechat::API do
 
     before { @mv = MotionWechat::API.instance }
 
+    it "sends auth message" do
+      WXApi.stub!(:sendReq) do |req|
+        req.should.be.kind_of(SendAuthReq)
+      end
+
+      @mv.authorize
+    end
+
     it 'sends web page url' do
       WXApi.stub!(:sendReq) do |req|
         req.should.be.kind_of(SendMessageToWXReq)
@@ -23,7 +31,7 @@ describe MotionWechat::API do
         req.message.mediaObject.webpageUrl.should == "http://www.motion-wechat.com"
       end
 
-      MotionWechat::API.instance.send_webpage "http://www.motion-wechat.com", \
+      @mv.send_webpage "http://www.motion-wechat.com", \
         title: "title", description: "description"
     end
 
@@ -33,7 +41,7 @@ describe MotionWechat::API do
         req.message.mediaObject.videoUrl.should == "http://www.youtube.com/1"
       end
 
-      MotionWechat::API.instance.send_video "http://www.youtube.com/1", \
+      @mv.send_video "http://www.youtube.com/1", \
         title: "title", description: "description"
     end
 
@@ -43,7 +51,7 @@ describe MotionWechat::API do
         req.message.mediaObject.musicUrl.should == "http://www.pandora.com/1"
       end
 
-      MotionWechat::API.instance.send_music "http://www.pandora.com/1", \
+      @mv.send_music "http://www.pandora.com/1", \
         title: "title", description: "description"
     end
 
@@ -52,7 +60,7 @@ describe MotionWechat::API do
         req.message.mediaObject.should.be.kind_of(WXImageObject)
       end
 
-      MotionWechat::API.instance.send_image NSData.dataWithContentsOfFile("dummy"), \
+      @mv.send_image NSData.dataWithContentsOfFile("dummy"), \
         title: "title", description: "description"
     end
 
@@ -62,7 +70,7 @@ describe MotionWechat::API do
         req.text.should == "hello"
       end
 
-      MotionWechat::API.instance.send_text "hello"
+      @mv.send_text "hello"
     end
 
     describe "Scene type" do
@@ -73,7 +81,7 @@ describe MotionWechat::API do
           req.scene.should == WXSceneSession
         end
 
-        MotionWechat::API.instance.send_webpage "http://www.motion-wechat.com", \
+        @mv.send_webpage "http://www.motion-wechat.com", \
           title: "title", description: "description"
       end
 
@@ -83,7 +91,7 @@ describe MotionWechat::API do
           req.scene.should == WXSceneTimeline
         end
 
-        MotionWechat::API.instance.send_webpage "http://www.motion-wechat.com", \
+        @mv.send_webpage "http://www.motion-wechat.com", \
           title: "title", description: "description", scene: WXSceneTimeline
       end
 

data/spec/motion-wechat/client_spec.rb

@@ -0,0 +1,70 @@
+describe MotionWechat::Client do
+  extend WebStub::SpecHelpers
+
+  before do
+    disable_network_access!
+    @client = MotionWechat::Client.new "appid", "appsecret", "code"
+  end
+
+  it "should get id, secret and site" do
+    @client.id.should == "appid"
+    @client.secret.should == "appsecret"
+    @client.site == "https://api.weixin.qq.com"
+  end
+
+  it "should get token url" do
+    @client.token_url.should == "https://api.weixin.qq.com/sns/oauth2/access_token"
+  end
+
+  context "access token" do
+
+    before do
+      @res = File.read NSBundle.mainBundle.resourcePath.stringByAppendingPathComponent("token.json")
+      @url = "https://api.weixin.qq.com/sns/oauth2/access_token" + \
+        "?appid=appid&secret=appsecret&code=code&grant_type=authorization_code"
+    end
+
+    it "gets token" do
+      stub_request(:get, @url).
+              to_return(json: @res)
+      @res = nil
+
+      @client.get_token do |token|
+        @token = token
+        resume
+      end
+
+      wait_max 1.0 do
+        @token.should.be.kind_of MotionWechat::AccessToken
+      end
+    end
+
+  end
+
+  context "get info" do
+
+    before do
+      @res = File.read NSBundle.mainBundle.resourcePath.stringByAppendingPathComponent("user.json")
+      @url = "https://api.weixin.qq.com/sns/user_info?access_token=token&openid=openid"
+    end
+
+    it "gets user info" do
+      stub_request(:get, @url).
+              to_return(json: @res)
+      @res = nil
+
+      @client.get("/sns/user_info", access_token: "token", openid: "openid") do |info|
+        @info = info
+        resume
+      end
+
+      wait_max 1.0 do
+        @info.should.be.kind_of Hash
+        @info["nickname"].should == "monkey"
+      end
+    end
+
+  end
+
+
+end

metadata

@@ -1,27 +1,59 @@
 --- !ruby/object:Gem::Specification
 name: motion-wechat
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Qi He
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-11 00:00:00.000000000 Z
-dependencies: []
+date: 2014-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: afmotion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+- !ruby/object:Gem::Dependency
+  name: bubble-wrap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.0
 description: Rubymotion gem to easily use WeChatSDK
 email: qhe@heyook.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/motion-wechat/access_token.rb
 - lib/motion-wechat/api.rb
+- lib/motion-wechat/client.rb
 - lib/motion-wechat/config.rb
 - lib/motion-wechat/version.rb
 - lib/motion-wechat.rb
 - README.md
+- spec/motion-wechat/access_token_spec.rb
 - spec/motion-wechat/api_spec.rb
+- spec/motion-wechat/client_spec.rb
 - spec/motion-wechat/config_spec.rb
 homepage: http://github.com/he9qi/motion-wechat
 licenses:
@@ -48,5 +80,7 @@ signing_key:
 specification_version: 4
 summary: Rubymotion wrapper for WeChatSDK
 test_files:
+- spec/motion-wechat/access_token_spec.rb
 - spec/motion-wechat/api_spec.rb
+- spec/motion-wechat/client_spec.rb
 - spec/motion-wechat/config_spec.rb