rest-core 0.0.1

data/test/test_default.rb

@@ -0,0 +1,27 @@
+
+if respond_to?(:require_relative, true)
+  require_relative 'common'
+else
+  require File.dirname(__FILE__) + '/common'
+end
+
+describe RestGraph do
+  should 'honor default attributes' do
+    RestGraph.members.reject{ |name|
+      name.to_s =~ /method$|handler$|detector$/ }.each{ |name|
+        RestGraph.new.send(name).should ==
+        RestGraph.new.send("default_#{name}")
+    }
+  end
+
+  should 'use module to override default attributes' do
+    klass = RestGraph.dup
+    klass.send(:include, Module.new do
+      def default_app_id
+        '1829'
+      end
+    end)
+
+    klass.new.app_id.should == '1829'
+  end
+end

data/test/test_error.rb

@@ -0,0 +1,66 @@
+
+if respond_to?(:require_relative, true)
+  require_relative 'common'
+else
+  require File.dirname(__FILE__) + '/common'
+end
+
+describe RestGraph::Error do
+  after do
+    WebMock.reset!
+    RR.verify
+  end
+
+  should 'have the right ancestors' do
+    RestGraph::Error::AccessToken       .should < RestGraph::Error
+
+    RestGraph::Error::InvalidAccessToken.should <
+      RestGraph::Error::AccessToken
+
+    RestGraph::Error::MissingAccessToken.should <
+      RestGraph::Error::AccessToken
+  end
+
+  def error2env hash
+    {RestCore::RESPONSE_BODY => hash,
+     RestCore::REQUEST_PATH  => '/' ,
+     RestCore::REQUEST_QUERY => {}}
+  end
+
+  should 'parse right' do
+    %w[OAuthInvalidTokenException OAuthException].each{ |type|
+      RestGraph::Error.call(error2env('error' => {'type' => type})).
+        should.kind_of?(RestGraph::Error::InvalidAccessToken)
+    }
+
+    RestGraph::Error.call(error2env('error'=>{'type'=>'QueryParseException',
+                                    'message'=>'An active access token..'})).
+      should.kind_of?(RestGraph::Error::MissingAccessToken)
+
+    RestGraph::Error.call(error2env('error'=>{'type'=>'QueryParseException',
+                                    'message'=>'Oh active access token..'})).
+      should.not.kind_of?(RestGraph::Error::MissingAccessToken)
+
+    RestGraph::Error.call(error2env('error_code' => 190)).
+      should.kind_of?(RestGraph::Error::InvalidAccessToken)
+
+    RestGraph::Error.call(error2env('error_code' => 104)).
+      should.kind_of?(RestGraph::Error::MissingAccessToken)
+
+    RestGraph::Error.call(error2env('error_code' => 999)).
+      should.not.kind_of?(RestGraph::Error::AccessToken)
+
+    error = RestGraph::Error.call(error2env(['not a hash']))
+    error.should.not.kind_of?(RestGraph::Error::AccessToken)
+    error.should    .kind_of?(RestGraph::Error)
+  end
+
+  should 'nuke cache upon errors' do
+    stub_request(:get, 'https://graph.facebook.com/me').
+      to_return(:body => '{"error":"wrong"}').times(2)
+
+    rg = RestGraph.new(:cache => {}, :error_handler => lambda{|env|env})
+    rg.get('me'); rg.get('me')
+    rg.cache.values.should == []
+  end
+end

data/test/test_handler.rb

@@ -0,0 +1,87 @@
+
+if respond_to?(:require_relative, true)
+  require_relative 'common'
+else
+  require File.dirname(__FILE__) + '/common'
+end
+
+describe RestGraph do
+  after do
+    WebMock.reset!
+    RR.verify
+  end
+
+  describe 'log method' do
+    should 'log whenever doing network request' do
+      stub_request(:get, 'https://graph.facebook.com/me').
+        to_return(:body => '{}')
+
+      logger = []
+      rg = RestGraph.new(:log_method => lambda{ |s| logger << [s] })
+      rg.get('me')
+
+      logger.size.should == 1
+    end
+  end
+
+  describe 'with Graph API' do
+    before do
+      @id    = lambda{ |env| env }
+      @error = '{"error":{"type":"Exception","message":"(#2500)"}}'
+      @error_hash = RestCore::JsonDecode.json_decode(@error)
+
+      stub_request(:get, 'https://graph.facebook.com/me').
+        to_return(:body => @error)
+    end
+
+    should 'call error_handler if error occurred' do
+      RestGraph.new(:error_handler => @id).get('me').should == @error_hash
+    end
+
+    should 'raise ::RestGraph::Error in default error_handler' do
+      begin
+        RestGraph.new.get('me')
+      rescue ::RestGraph::Error => e
+        e.error  .should == @error_hash
+        e.message.should ==
+          "#{@error_hash.inspect} from https://graph.facebook.com/me"
+      end
+    end
+  end
+
+  describe 'with FQL API' do
+    # Example of an actual response (without newline)
+    # {"error_code":603,"error_msg":"Unknown table: bad_table",
+    #  "request_args":[{"key":"method","value":"fql.query"},
+    #                  {"key":"format","value":"json"},
+    #                  {"key":"query","value":
+    #                     "SELECT name FROM bad_table WHERE uid=12345"}]}
+    before do
+      @id             = lambda{ |env| env }
+      @fql_error      = '{"error_code":603,"error_msg":"Unknown table: bad"}'
+      @fql_error_hash = RestCore::JsonDecode.json_decode(@fql_error)
+
+      @bad_fql_query  = 'SELECT name FROM bad_table WHERE uid="12345"'
+      bad_fql_request = "https://api.facebook.com/method/fql.query?" \
+                        "format=json&query=#{CGI.escape(@bad_fql_query)}"
+
+      stub_request(:get, bad_fql_request).to_return(:body => @fql_error)
+    end
+
+    should 'call error_handler if error occurred' do
+      RestGraph.new(:error_handler => @id).fql(@bad_fql_query).
+        should == @fql_error_hash
+    end
+
+    should 'raise ::RestGraph::Error in default error_handler' do
+      begin
+        RestGraph.new.fql(@bad_fql_query)
+      rescue ::RestGraph::Error => e
+        e.error  .should == @fql_error_hash
+        e.message.should.start_with?(
+          "#{@fql_error_hash.inspect} from "          \
+          "https://api.facebook.com/method/fql.query?")
+      end
+    end
+  end
+end

data/test/test_misc.rb

@@ -0,0 +1,75 @@
+
+if respond_to?(:require_relative, true)
+  require_relative 'common'
+else
+  require File.dirname(__FILE__) + '/common'
+end
+
+describe RestGraph do
+  after do
+    WebMock.reset!
+    RR.verify
+  end
+
+  should 'return true in authorized? if there is an access_token' do
+    RestGraph.new(:access_token => '1').authorized?.should == true
+    RestGraph.new(:access_token => nil).authorized?.should == false
+  end
+
+  should 'treat oauth_token as access_token as well' do
+    rg = RestGraph.new
+    hate_facebook = 'why the hell two different name?'
+    rg.data['oauth_token'] = hate_facebook
+    rg.authorized?.should == true
+    rg.access_token       == hate_facebook
+  end
+
+  should 'build correct headers' do
+    rg = RestGraph.new(:accept => 'text/html',
+                       :lang   => 'zh-tw')
+
+    headers = rg.ask.call(rg.send(:build_env))[RestCore::REQUEST_HEADERS]
+    headers['Accept'         ].should == 'text/html'
+    headers['Accept-Language'].should == 'zh-tw'
+  end
+
+  should 'build empty query string' do
+    rg = RestGraph.new
+    (rg.ask.call(rg.send(:build_env))[RestCore::REQUEST_QUERY] || {}).
+      should == {}
+  end
+
+  should 'create access_token in query string' do
+    rg = RestGraph.new(:access_token => 'token')
+    (rg.ask.call(rg.send(:build_env))[RestCore::REQUEST_QUERY] || {}).
+      should == {'access_token' => 'token'}
+  end
+
+  should 'build correct query string' do
+    rg = RestGraph.new(:access_token => 'token')
+    TestHelper.normalize_url(rg.url('', :message => 'hi!!')).
+      should == "#{rg.site}?access_token=token&message=hi%21%21"
+
+    rg.access_token = nil
+    TestHelper.normalize_url(rg.url('', :message => 'hi!!',
+                                        :subject => '(&oh&)')).
+      should == "#{rg.site}?message=hi%21%21&subject=%28%26oh%26%29"
+  end
+
+  should 'auto decode json' do
+    rg = RestGraph.new(:auto_decode => true)
+    stub_request(:get, rg.site).to_return(:body => '[]')
+    rg.get('').should ==  []
+  end
+
+  should 'not auto decode json' do
+    rg = RestGraph.new(:auto_decode => false)
+    stub_request(:get, rg.site).to_return(:body => '[]')
+    rg.get('').should == '[]'
+  end
+
+  should 'give attributes' do
+    RestGraph.new(:auto_decode => false).attributes.keys.map(&:to_s).sort.
+      should == RestGraph.members.map(&:to_s).sort
+  end
+end

data/test/test_oauth.rb

@@ -0,0 +1,42 @@
+
+if respond_to?(:require_relative, true)
+  require_relative 'common'
+else
+  require File.dirname(__FILE__) + '/common'
+end
+
+describe RestGraph do
+  before do
+    @rg  = RestGraph.new(:app_id => '29', :secret => '18')
+    @uri = 'http://zzz.tw'
+  end
+
+  after do
+    WebMock.reset!
+  end
+
+  should 'return correct oauth url' do
+    TestHelper.normalize_url(@rg.authorize_url(:redirect_uri => @uri)).
+    should == 'https://graph.facebook.com/oauth/authorize?' \
+              'client_id=29&redirect_uri=http%3A%2F%2Fzzz.tw'
+  end
+
+  should 'do authorizing and parse result and save it in data' do
+    stub_request(:get, 'https://graph.facebook.com/oauth/access_token?' \
+                       'client_id=29&client_secret=18&code=zzz&'        \
+                       'redirect_uri=http%3A%2F%2Fzzz.tw').
+      to_return(:body => 'access_token=baken&expires=2918')
+
+    result = {'access_token' => 'baken', 'expires' => '2918'}
+
+    @rg.authorize!(:redirect_uri => @uri, :code => 'zzz').
+             should == result
+    @rg.data.should == result
+  end
+
+  should 'not append access_token in authorize_url even presented' do
+    RestGraph.new(:access_token => 'do not use me').authorize_url.
+      should == 'https://graph.facebook.com/oauth/authorize'
+  end
+
+end

data/test/test_oauth1_header.rb

@@ -0,0 +1,46 @@
+
+if respond_to?(:require_relative, true)
+  require_relative 'common'
+else
+  require File.dirname(__FILE__) + '/common'
+end
+
+describe RestCore::Oauth1Header do
+  before do
+    @env = {RestCore::REQUEST_METHOD => :post,
+            RestCore::REQUEST_PATH   =>
+              'https://api.twitter.com/oauth/request_token'}
+
+    callback =
+    'http://localhost:3005/the_dance/process_callback?service_provider_id=11'
+
+    @oauth_params =
+      {'oauth_callback'     => callback                                     ,
+       'oauth_consumer_key' => 'GDdmIQH6jhtmLUypg82g'                       ,
+       'oauth_nonce'        => 'QP70eNmVz8jvdPevU3oJD2AfF7R7odC2XJcn4XlZJqk',
+       'oauth_timestamp'    => '1272323042'                                 ,
+       'oauth_version'      => '1.0'                                        ,
+       'oauth_signature_method' => 'HMAC-SHA1'}
+
+    @auth = RestCore::Oauth1Header.new(RestCore::Ask.new,
+      nil, nil, nil,
+      'GDdmIQH6jhtmLUypg82g',
+      'MCD8BKwGdgPHvAuvgvz4EQpqDAtx89grbuNMRd7Eh98')
+  end
+
+  should 'have correct base_string' do
+    @auth.base_string(@env, @oauth_params).should.equal(
+      'POST&https%3A%2F%2Fapi.twitter.com%2Foauth%2Frequest_token&' \
+      'oauth_callback%3Dhttp%253A%252F%252Flocalhost%253A3005%252F' \
+      'the_dance%252Fprocess_callback%253Fservice_provider_id%253D' \
+      '11%26oauth_consumer_key%3DGDdmIQH6jhtmLUypg82g%26oauth_nonc' \
+      'e%3DQP70eNmVz8jvdPevU3oJD2AfF7R7odC2XJcn4XlZJqk%26oauth_sig' \
+      'nature_method%3DHMAC-SHA1%26oauth_timestamp%3D1272323042%26' \
+      'oauth_version%3D1.0')
+  end
+
+  should 'have correct signature' do
+    @auth.signature(@env, @oauth_params).should.equal(
+      '8wUi7m5HFQy76nowoCThusfgB+Q=')
+  end
+end

data/test/test_old.rb

@@ -0,0 +1,116 @@
+
+if respond_to?(:require_relative, true)
+  require_relative 'common'
+else
+  require File.dirname(__FILE__) + '/common'
+end
+
+describe RestGraph do
+  after do
+    WebMock.reset!
+    RR.verify
+  end
+
+  should 'do fql query with/without access_token' do
+    fql = 'SELECT name FROM likes where id="123"'
+    query = "format=json&query=#{CGI.escape(fql)}"
+    stub_request(:get, "https://api.facebook.com/method/fql.query?#{query}").
+      to_return(:body => '[]')
+
+    RestGraph.new.fql(fql).should == []
+
+    token = 'token'.reverse
+    stub_request(:get, "https://api.facebook.com/method/fql.query?#{query}" \
+      "&access_token=#{token}").
+      to_return(:body => '[]')
+
+    RestGraph.new(:access_token => token).fql(fql).should == []
+  end
+
+  should 'do fql.mutilquery correctly' do
+    f0 = 'SELECT display_name FROM application WHERE app_id="233082465238"'
+    f1 = 'SELECT display_name FROM application WHERE app_id="110225210740"'
+    f0q, f1q = "\"#{f0.gsub('"', '\\"')}\"", "\"#{f1.gsub('"', '\\"')}\""
+    q = "format=json&queries=#{CGI.escape("{\"f0\":#{f0q},\"f1\":#{f1q}}")}"
+    p = "format=json&queries=#{CGI.escape("{\"f1\":#{f1q},\"f0\":#{f0q}}")}"
+
+    stub_multi = lambda{
+      stub_request(:get,
+        "https://api.facebook.com/method/fql.multiquery?#{q}").
+        to_return(:body => '[]')
+
+      stub_request(:get,
+        "https://api.facebook.com/method/fql.multiquery?#{p}").
+        to_return(:body => '[]')
+    }
+
+    stub_multi.call
+    RestGraph.new.fql_multi(:f0 => f0, :f1 => f1).should == []
+  end
+
+  should 'cache fake post in fql' do
+    query = 'select name from user where uid = 4'
+    body  = '[{"name":"Mark Zuckerberg"}]'
+    stub_request(:post,
+      'https://api.facebook.com/method/fql.query?format=json').
+      with(:body => {:query => query}).
+      to_return(:body => body)
+
+    RestGraph.new(:cache => (cache = {})).fql(query, {}, :post => true).
+      first['name']   .should == 'Mark Zuckerberg'
+    cache.size        .should == 1
+    cache.values.first.should == body
+
+    WebMock.reset! # should hit the cache
+
+    RestGraph.new(:cache => cache).fql(query, {}, :post => true).
+      first['name']   .should == 'Mark Zuckerberg'
+    cache.size        .should == 1
+    cache.values.first.should == body
+
+    # query changed
+    should.raise(WebMock::NetConnectNotAllowedError) do
+      RestGraph.new(:cache => cache).fql(query.upcase, {}, :post => true)
+    end
+
+    # cache should work for normal get
+    RestGraph.new(:cache => cache).fql(query).
+      first['name']   .should == 'Mark Zuckerberg'
+    cache.size        .should == 1
+    cache.values.first.should == body
+  end
+
+  should 'do facebook old rest api' do
+    body = 'hate facebook inconsistent'
+    stub_request(:get,
+      'https://api.facebook.com/method/notes.create?format=json').
+      to_return(:body => body)
+
+    RestGraph.new.old_rest('notes.create', {}, :auto_decode => false).
+      should == body
+  end
+
+  should 'exchange sessions for access token' do
+    stub_request(:post,
+      'https://graph.facebook.com/oauth/exchange_sessions?'     \
+              'type=client_cred&client_id=id&client_secret=di&' \
+              'sessions=bad%20bed').
+      to_return(:body => '[{"access_token":"bogus"}]')
+
+    RestGraph.new(:app_id => 'id',
+                  :secret => 'di').
+      exchange_sessions(:sessions => 'bad bed').
+      first['access_token'].should == 'bogus'
+  end
+
+  should 'use an secret access_token' do
+    stub_request(:get,
+      'https://api.facebook.com/method/admin.getAppProperties?' \
+      'access_token=123%7Cs&format=json&properties=app_id'
+    ).to_return(:body => '{"app_id":"123"}')
+
+    RestGraph.new(:app_id => '123', :secret => 's').
+      secret_old_rest('admin.getAppProperties', :properties => 'app_id').
+      should == {'app_id' => '123'}
+  end
+end