koala 0.9.0 → 1.0.0

data/examples/oauth_playground/lib/oauth_playground.rb

@@ -1,187 +0,0 @@
-APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
-
-require 'rubygems'
-require 'sinatra'
-require 'erb'
-
-class OAuthPlayground < Sinatra::Application
-  
-  set :root, APP_ROOT  
-
-  include Koala
-
-  layout :layout
-
-  get "/" do
-    @app_data = FACEBOOK_INFO.merge("callback_url" => "#{request.scheme}://#{request.host}/")
-    @oauth = Facebook::OAuth.new(@app_data["app_id"], @app_data["secret_key"], @app_data["callback_url"])
-    
-    # get authentication info
-    set_facebook_cookies 
-    set_oauth_data
-    set_access_token
-    
-    unless (@permissions = params[:permissions]) && @permissions.length > 0
-      @active_permissions = (get_active_permissions || {}).inject([]) do |active, perm| 
-        # collect our active permissions
-        active << perm[0].to_sym if perm[1] == 1
-        active
-      end
-      @fetched_permissions = true
-    else
-      @active_permissions = @permissions.collect {|p| p.to_sym}
-    end
-        
-    @available_permissions = [
-      {:name => "User Activity", :perms => ACTIVITY_PERMISSIONS},
-      {:name => "User Info", :perms => USER_PERMISSIONS},
-      {:name => "Friend Info", :perms => FRIEND_PERMISSIONS}
-    ]
-  
-    erb :index
-  end
-  
-  get "/subscriptions" do
-    # validate that this is a valid response
-    # it will automatically render the result of the verification
-    # e.g. either the challenge phrase or false
-    subscription = Facebook::RealtimeUpdates.meet_challenge(params) do |verification_token|
-      token_parts = verification_token.split("|")
-      expected = Digest::MD5.hexdigest("#{token_parts.first}~koala")
-      logger.info "expected: #{expected}"
-      logger.info "got: #{token_parts.last}"
-      # determine if this is a valid token -- that is, if the send part is a properly encoding of the first
-      expected == token_parts.last
-    end
-  end
-  
-  helpers do
-    def logger
-      LOGGER
-    end 
-  end
-
-  # helpers
-
-  # set up our understanding of the user's session
-  
-  def set_access_token
-    # get the access token from wherever we can
-    @access_token ||= (set_oauth_data && @oauth_access_token) || (set_facebook_cookies && @cookie_access_token)
-  end
-  
-  def set_oauth_data
-    unless @oauth_access_token
-      if (@code = params[:code]) && @raw_access_response = @oauth.send(:fetch_token_string, {:code => @code, :redirect_uri => @app_data["callback_url"]})
-        parsed = @oauth.send(:parse_access_token, @raw_access_response)
-        @oauth_access_token = parsed["access_token"]
-        @expiration = parsed["expires"] || "Does not expire (offline)"
-      end
-    end
-    
-    @oauth_access_token
-  end
-  
-  def set_facebook_cookies
-    unless @facebook_cookies
-      if @facebook_cookies = @oauth.get_user_from_cookie(request.cookies)
-        @cookie_access_token = @facebook_cookies["access_token"]
-      end
-    end
-    
-    @facebook_cookies
-  end
-  
-  def set_uid
-    # get the OAuth data, including fetching the access token, if available and necessary
-    # e.g. if we have an OAuth token and no cookie data    
-    unless @uid 
-      if @facebook_cookies
-        @uid = @facebook_cookies["uid"]
-      elsif token = set_access_token
-        # we have to fetch the info
-        @graph = Facebook::GraphAPI.new(token)
-        result = @graph.get_object("me")
-        @uid = result["id"]
-      end
-    end
-    @uid
-  end
-  
-  # fetch the active permissions about the user    
-  def get_active_permissions
-    set_access_token
-    if @access_token && !@permissions && set_uid
-      # if we don't have permissions set but have an access token
-      # grab the user's info
-      @rest = Facebook::RestAPI.new(@access_token)      
-      result = @rest.fql_query("select #{all_permissions.join(",")} from permissions where uid = #{@uid.to_s}")
-      result.first
-    end  
-  end
-  
-  # list of permissions
-
-  def all_permissions
-    ACTIVITY_PERMISSIONS + USER_PERMISSIONS + FRIEND_PERMISSIONS
-  end
-  
-  ACTIVITY_PERMISSIONS = [
-    :publish_stream, # Enables your application to post content, comments, and likes to a user's stream and to the streams of the user's friends, without prompting the user each time.
-    :create_event, # Enables your application to create and modify events on the user's behalf
-    :rsvp_event, # Enables your application to RSVP to events on the user's behalf
-    :sms, # Enables your application to send messages to the user and respond to messages from the user via text message
-    :offline_access # Enables your application to perform authorized requests on behalf of the user at any time. By default, most access tokens expire after a short time period to ensure applications only make requests on behalf of the user when the are actively using the application. This permission makes the access token returned by our OAuth endpoint long-lived.
-  ]
-
-  USER_PERMISSIONS = [
-    :email, # Provides access to the user's primary email address in the email property. Do not spam users. Your use of email must comply both with Facebook policies and with the CAN-SPAM Act.
-    :read_insights, # Provides read access to the Insights data for pages, applications, and domains the user owns.
-    :read_stream, # Provides access to all the posts in the user's News Feed and enables your application to perform searches against the user's News Feed
-    :user_about_me, # Provides access to the "About Me" section of the profile in the about property
-    :user_activities, # Provides access to the user's list of activities as the activities connection
-    :user_birthday, # Provides access to the full birthday with year as the birthday_date property
-    :user_education_history, # Provides access to education history as the education property
-    :user_events, # Provides access to the list of events the user is attending as the events connection
-    :user_groups, # Provides access to the list of groups the user is a member of as the groups connection
-    :user_hometown, # Provides access to the user's hometown in the hometown property
-    :user_interests, # Provides access to the user's list of interests as the interests connection
-    :user_likes, # Provides access to the list of all of the pages the user has liked as the likes connection
-    :user_location, # Provides access to the user's current location as the current_location property
-    :user_notes, # Provides access to the user's notes as the notes connection
-    :user_online_presence, # Provides access to the user's online/offline presence
-    :user_photo_video_tags, # Provides access to the photos the user has been tagged in as the photos connection
-    :user_photos, # Provides access to the photos the user has uploaded
-    :user_relationships, # Provides access to the user's family and personal relationships and relationship status
-    :user_religion_politics, # Provides access to the user's religious and political affiliations
-    :user_status, # Provides access to the user's most recent status message
-    :user_videos, # Provides access to the videos the user has uploaded
-    :user_website, # Provides access to the user's web site URL
-    :user_work_history # Provides access to work history as the work property
-  ]
-  
-  FRIEND_PERMISSIONS = [
-    :read_friendlists, # Provides read access to the user's friend lists
-    :read_requests, # Provides read access to the user's friend requests
-    :friends_about_me, # Provides access to the "About Me" section of the profile in the about property
-    :friends_activities, # Provides access to the user's list of activities as the activities connection
-    :friends_birthday, # Provides access to the full birthday with year as the birthday_date property
-    :friends_education_history, # Provides access to education history as the education property
-    :friends_events, # Provides access to the list of events the user is attending as the events connection
-    :friends_groups, # Provides access to the list of groups the user is a member of as the groups connection
-    :friends_hometown, # Provides access to the user's hometown in the hometown property
-    :friends_interests, # Provides access to the user's list of interests as the interests connection
-    :friends_likes, # Provides access to the list of all of the pages the user has liked as the likes connection
-    :friends_location, # Provides access to the user's current location as the current_location property
-    :friends_notes, # Provides access to the user's notes as the notes connection
-    :friends_online_presence, # Provides access to the user's online/offline presence
-    :friends_photo_video_tags, # Provides access to the photos the user has been tagged in as the photos connection
-    :friends_photos, # Provides access to the photos the user has uploaded
-    :friends_relationships, # Provides access to the user's family and personal relationships and relationship status
-    :friends_religion_politics, # Provides access to the user's religious and political affiliations
-    :friends_status, # Provides access to the user's most recent status message
-    :friends_videos, # Provides access to the videos the user has uploaded
-    :friends_website, # Provides access to the user's web site URL
-    :friends_work_history # Provides access to work history as the work property
-  ]
-end

data/examples/oauth_playground/readme.md

@@ -1,8 +0,0 @@
-A simple OAuth Playground chock full of the info you need to test your OAuth-based Facebook application.
-
-To Do's
-=======
-
-* Extend the permissions controls to cover all available permissions
-* Make expiration dates human-readable
-* Let people plug in their own app (updating the app's connect properties through setAppProperties)

data/examples/oauth_playground/spec/oauth_playground_spec.rb

@@ -1,35 +0,0 @@
-require 'spec_helper'
-require 'ruby-debug'
-
-describe 'OAuthPlayground' do
-  before :each do
-    @hydra = Typhoeus::Hydra.hydra
-  end
-  
-  after :each do 
-    @hydra.clear_stubs
-  end
-  
-  it 'should load the index' do
-    get '/'
-    last_response.should be_ok
-  end
-
-=begin  
-  # unfortunately, this fails when you pass the get method a param named code!
-  # fixing this will require some mucking around in Rack::Test
-  
-  it "should make a request to Facebook's OAuth server when passed a code" do 
-    test_string = Regexp.new("The time is #{Time.now.to_i}")
-
-    # stub out the request and make sure it's returned
-    @hydra.stub("https://#{Koala::Facebook::GRAPH_SERVER}/oauth/access_token", "get").and_return(test_string)
-    
-    get "/", {"code" => "foo_bar"}
-
-    # make sure the body includes the request string
-    last_response.body.should =~ test_string
-  end
-=end
-end
-

data/examples/oauth_playground/spec/spec_helper.rb

@@ -1,36 +0,0 @@
-require 'rubygems'
-require 'sinatra'
-require 'rack/test'
-require 'typhoeus'
-require 'koala'
-
-require File.join(File.dirname(__FILE__), '..', 'lib', 'oauth_playground.rb')
-require File.join(File.dirname(__FILE__), '..', 'lib', 'load_facebook.rb')
-
-OAuthPlayground.set(
-  :environment => :test,
-  :run => false,
-  :raise_errors => true,
-  :logging => false
-)
-
-module TestHelper
-  
-  def app
-    # change to your app class if using the 'classy' style
-    OAuthPlayground
-  end
-  
-  def body
-    last_response.body
-  end
-  
-  def status
-    last_response.status
-  end
-  
-  include Rack::Test::Methods
-
-end
-
-include TestHelper

data/examples/oauth_playground/views/index.erb

@@ -1,206 +0,0 @@
-<div id="header">
-	<h1>Facebook OAuth Playground</h1>
-	<h4>Powered by <a href="http://github.com/arsduo/koala" target="_blank">Koala</a></h2>
-	<h4>For novelty use only.  Remember, the application's secret key is public.</h4>
-</div>
-
-<style>
-	#header { 
-		text-align: center; 
-	} 
-	
-	h1, h2, h3, h4 { margin: 0; }
-
-	.section {
-		border: 1px solid black;
-		padding: 10px;
-		-moz-border-radius: 9px;
-		-webkit-border-radius: 9px;
-		margin-bottom: 10px;
-		width: 100%;
-	}
-	
-	#contents {
-		border: 2px solid #CCC;
-		border-width: 2px 0;
-		background-color: #EEE;
-		padding: 14px 3px 8px 8px;
-	}
-	
-	#configurationInfo {
-		float:left;
-		margin-right: 2.5%;
-		width: 25%;
-	}
-	
-	#configurationInfo .section {
-		background-color: #CCC;
-	}
-	
-	#permissions .header {
-		margin-bottom: 5px;
-	}
-	
-	#permissions .list {
-		height: 380px;
-		overflow: auto;
-	}
-	
-	#generatedInfo {
-		float: left;
-		width: 70%;
-	}
-	
-	#generatedInfo .section {
-		border-color: gray;
-		background: #DDD;
-		overflow: auto;
-	}
-	
-	.clearFloat {
-		height: 1px;
-		height: 0px;
-		clear: both;
-		overflow: hidden;
-	}
-	
-	ul, li { margin: 0; padding: 0; list-style: none; }
-	ul { margin: 12px 0; }
-
-	.code {
-		font-family: Courier, fixed;
-		font-size: 1.15em;
-		width: 100%;
-	}
-	
-	.explanation {
-		font-size: 0.9em;
-	}
-	
-	.datumName {
-		font-weight: bold;
-	}
-	
-	.permissionType {
-		font-style: italic;
-	}
-</style>
-	
-</style>
-
-<div id="contents">
-
-	<div id="configurationInfo">
-		<div id="fbApp" class="section">
-			<h3>Facebook App Info</h3>
-			<ul>
-				<% @app_data.each_pair do |key, value| %>
-					<li><span class="datumName"><%= key %>:</span> <%= value %></li>
-				<% end %>
-			</ul>
-		</div>
-		
-		<div id="permissions" class="section">
-			<form method="get">
-				<div class="header">
-					<h3>Permissions</h3>
-					<input type="submit" value="Update permissions" />
-					<a href="/">Reset Selection</a>
-					<div class="explanation">Choose permissions for the OAuth URL and the fb:login button.</div>
-					<% if @fetched_permissions %>
-						<div class="permissionType">Showing currently-active permissions</div>
-						<div class="explanation">(These were fetched by Koala as the page loaded!)</div>
-					<% else %>
-						<div class="permissionType">Showing selected permissions</div>
-					<% end %>
-				</div>
-		
-				<div class="list">
-					<% @available_permissions.each do |permissions| %>
-						<h4><%= permissions[:name] %> Permissions</h4>
-						<ul>
-							<% permissions[:perms].each do |p| %>
-								<li>
-									<input type="checkbox" id="permission<%= p %>" name="permissions[]" value="<%= p %>" <%= @active_permissions.include?(p) ? "checked='checked'" : "" %> />
-									<label for="permission<%= p %>"><%= p %></a> (<a href="#" onclick="FB.api({method: 'auth.revokeExtendedPermission', perm: '<%= p %>'}, function(response) { alert(response) }); return false;">revoke</a>)
-								</li>
-							<% end %>
-						</ul>
-					<% end %>
-				</div>
-			</form>
-		</div>
-	</div>
-
-	<div id="generatedInfo">		
-		<div id="oauthURLs" class="section">
-			<h3>OAuth URLs</h3>
-			<ul>
-				<li><span class="datumName">Generate a code:</span> <a href="<%= @oauth.url_for_oauth_code(:permissions => @permissions) %>"><%=  @oauth.url_for_oauth_code(:permissions => @permissions) %></a></li>
-				<li><span class="datumName">OAuth code:</span> <%= @code || "click on the link above" %></li>
-				<li>
-					<span class="datumName">Access token:</span> <%= @oauth_access_token || "click on the link above" %>
-					<% if @oauth_access_token %><div class="explanation">This was fetched by Koala as the page loaded!</div><% end %>
-				</li>
-				<li><span class="datumName">Expiration:</span> <%= @expiration || "click on the link above" %></li>
-				<li><span class="datumName">Raw access response:</span> <%= @raw_access_response || "click on the link above" %></li>
-				<li><span class="datumName">URL for access code:</span>
-					<% if @code %>
-						<a href="<%= @oauth.url_for_access_token(@code) %>"><%= @oauth.url_for_access_token(@code) %></a>
-					<% else %>
-						click on the link above
-					<% end %>
-				</li>
-			</ul>
-		</div>
-
-		<div id="jsLogin" class="section">
-			<h3>Javascript Login (e.g. Facebook Connect)</h3>
-			<p>
-				<fb:login-button onlogin="location.reload()" perms="<%= (@permissions || []).join(",") %>"></fb:login-button>
-				<% if @permissions %>
-					and prompt for <%= @permissions.join(", ") %>
-				<% end %>
-				<% if @facebook_cookies %>
-					<div class="logout">
-						<a href="#" onclick="FB.logout(function() { location.reload() }); return false;">Logout</a>
-					</div>
-				<% end %>
-			</p>
-		</div>
-
-		<div id="cookieInfo" class="section">
-			<h3>Cookie info</h3>
-			<ul>
-				<% if @facebook_cookies %>
-					<% @facebook_cookies.each_pair do |key, value| %>
-						<li><span class="datumName"><%= key %>:</span> <%= value %></li>
-					<% end %>
-				<% else %>
-					<li>You're not signed in via Javascript.  Login below.</li>
-				<% end %>
-				<li><span class="datumName">Raw hash</span>: 
-					<div class="code"><%= request.cookies.inspect %></div>
-				</li>
-			</ul>
-		</div>
-
-		<div id="koala" class="section">
-			<h3>Koala</h3>
-			<ul>
-				<li><span class="datumName">GraphAPI:</span>
-					<div class="code"><%= @access_token ? "@graph = Koala::Facebook::GraphAPI.new(\"#{@access_token}\")" : "sign in above" %></div>
-				</li>
-				<li><span class="datumName">OAuth:</span> 
-					<div class="code">@oauth = Koala::Facebook::OAuth.new(<%= @app_data["app_id"] %>, "<%= @app_data["secret_key"] %>", "<%= @app_data["callback_url"] %>")</div>
-				</li>
-			</ul>
-		</div>
-	</div>
-
-	<div class="clearFloat">&nbsp;</div>
-</div>
-
-<center>
-	<h5>Check out the playground's code at <a href="http://github.com/arsduo/oauth_playground">http://github.com/arsduo/oauth_playground</a>!</h5>
-</center>

data/examples/oauth_playground/views/layout.erb

@@ -1,39 +0,0 @@
-<html>
-<head>
-	<title>Facebook OAuth Playground</title>
-	<meta name="description" content="Making it easier to play with Facebook's new Graph API and OAuth authentication."></meta>
-	<style>
-		body {
-			font-family: verdana, arial, sans-serif;
-			font-size: 12px;
-			margin: 0px;
-		}
-	</style>
-</head>
-<body>
-
-<script type="text/javascript">
-
-  var _gaq = _gaq || [];
-  _gaq.push(['_setAccount', 'UA-16395421-1']);
-  _gaq.push(['_trackPageview']);
-
-  (function() {
-    var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
-    ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
-    var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
-  })();
-
-</script>
-	
-<%= yield %>		
-		
-<div id="fb-root"></div>
-<script src="http://connect.facebook.net/en_US/all.js"></script>
-<script>
-	FB.init({ appId: <%= @app_data["app_id"] %>, cookie: true, status: true, xfbml: true });
-</script>
-
-</body>
-
-</html>

data/init.rb

@@ -1,2 +0,0 @@
-# init.rb
-require 'koala'

data/spec/koala/api_base_tests.rb

@@ -1,95 +0,0 @@
-class ApiBaseTests < Test::Unit::TestCase
-  describe "Koala API base class" do
-    before(:each) do
-      @service = Koala::Facebook::API.new  
-    end
-    
-    it "should not include an access token if none was given" do
-      Koala.should_receive(:make_request).with(
-        anything,
-        hash_not_including('access_token' => 1),
-        anything,
-        anything
-      ).and_return(Koala::Response.new(200, "", ""))
-      
-      @service.api('anything')
-    end
-    
-    it "should include an access token if given" do
-      token = 'adfadf'
-      service = Koala::Facebook::API.new token
-      
-      Koala.should_receive(:make_request).with(
-        anything,
-        hash_including('access_token' => token),
-        anything,
-        anything
-      ).and_return(Koala::Response.new(200, "", ""))
-      
-      service.api('anything')
-    end
-    
-    it "should get the attribute of a Koala::Response given by the http_component parameter" do
-      http_component = :method_name
-      
-      response = mock('Mock KoalaResponse', :body => '', :status => 200)
-      response.should_receive(http_component).and_return('')
-      
-      Koala.stub(:make_request).and_return(response)
-      
-      @service.api('anything', 'get', {}, :http_component => http_component)
-    end
-    
-    it "should return the body of the request as JSON if no http_component is given" do
-      response = stub('response', :body => 'body', :status => 200)
-      Koala.stub(:make_request).and_return(response)
-      
-      json_body = mock('JSON body')
-      JSON.stub(:parse).and_return([json_body])
-      
-      @service.api('anything').should == json_body
-    end
-    
-    it "should execute a block with the response body if passed one" do
-      body = '{}'
-      Koala.stub(:make_request).and_return(Koala::Response.new(200, body, {}))
-      
-      yield_test = mock('Yield Tester')
-      yield_test.should_receive(:pass)
-      
-      @service.api('anything') do |arg| 
-        yield_test.pass
-        arg.should == JSON.parse(body)
-      end
-    end
-    
-    it "should raise an API error if the HTTP response code is greater than or equal to 500" do
-      Koala.stub(:make_request).and_return(Koala::Response.new(500, 'response body', {}))
-      
-      lambda { @service.api('anything') }.should raise_exception(Koala::Facebook::APIError)
-    end
-    
-    it "should handle rogue true/false as responses" do
-      Koala.should_receive(:make_request).and_return(Koala::Response.new(200, 'true', {}))
-      @service.api('anything').should be_true
-      
-      Koala.should_receive(:make_request).and_return(Koala::Response.new(200, 'false', {}))
-      @service.api('anything').should be_false
-    end
-    
-    describe "with regard to leading slashes" do 
-      it "should add a leading / to the path if not present" do
-        path = "anything"
-        Koala.should_receive(:make_request).with("/#{path}", anything, anything, anything).and_return(Koala::Response.new(200, 'true', {}))
-        @service.api(path)      
-      end
-    
-      it "shouldn't change the path if a leading / is present" do
-        path = "/anything"
-        Koala.should_receive(:make_request).with(path, anything, anything, anything).and_return(Koala::Response.new(200, 'true', {}))
-        @service.api(path)              
-      end
-    end
-    
-  end
-end

data/spec/koala/graph_and_rest_api/graph_and_rest_api_no_token_tests.rb

@@ -1,10 +0,0 @@
-class GraphAndRestAPINoTokenTests < Test::Unit::TestCase
-  describe "Koala GraphAndRestAPI without an access token" do
-    before(:each) do
-      @api = Koala::Facebook::GraphAndRestAPI.new
-    end
-    
-    it_should_behave_like "Koala RestAPI without an access token"
-    it_should_behave_like "Koala GraphAPI without an access token"
-  end
-end

data/spec/koala/graph_and_rest_api/graph_and_rest_api_with_token_tests.rb

@@ -1,11 +0,0 @@
-class GraphAndRestAPIWithTokenTests < Test::Unit::TestCase
-  describe "Koala GraphAndRestAPI without an access token" do
-    it_should_behave_like "live testing examples"
-    it_should_behave_like "Koala RestAPI with an access token"
-    it_should_behave_like "Koala GraphAPI with an access token"
-    
-    before(:each) do
-      @api = Koala::Facebook::GraphAndRestAPI.new(@token)
-    end
-  end
-end