rplatform-rails 0.0.2

data/lib/rplatform_rails/view_extensions.rb

@@ -0,0 +1,93 @@
+# AUTHORS:
+# - Curtis Edmond (www.okwithfailure.com)
+# thanks to matt for rfacebook
+# - Matt Pizzimenti (www.livelearncode.com)
+
+# LICENSE:
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+# 
+# Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 
+# Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+# 
+# Neither the name of the original author nor the names of contributors
+# may be used to endorse or promote products derived from this software
+# without specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+module RPlatform
+  module Rails
+    module ViewExtensions
+      
+      # returns true if the user is viewing the canvas
+      def self.shit
+        p 'AAIIEEE'
+      end
+      
+      def in_facebook_canvas?
+        @controller.in_facebook_canvas?
+      end
+      
+      # returns true if the user is in an iframe
+      def in_facebook_frame?
+        @controller.in_facebook_frame?
+      end
+      
+      # returns true if the render is using mock ajax
+      def in_mock_ajax?
+        @controller.in_mock_ajax?
+      end
+      
+      # returns true if the render is using mock ajax
+      def in_ajax?
+        @controller.in_ajax?
+      end
+      
+      # returns the current fb_sig_params (only if they validated properly)
+      def fbparams
+        @controller.fbparams
+      end
+      
+      # returns the current user's Facebook session (an instance of FacebookWebSession)
+      def fbsession
+        @controller.fbsession
+      end
+      
+      # overrides the path_to_image method to ensure that all images are written
+      # with absolute paths
+      def image_path(*params)
+        path = super(*params)
+        if ((in_facebook_canvas? or in_mock_ajax? or in_ajax?) and !(/(\w+)(\:\/\/)([\w0-9\.]+)([\:0-9]*)(.*)/.match(path)))
+          path = "#{request.protocol}#{request.host_with_port}#{path}"
+        end
+        return path
+      end
+      
+      # Aliases to path_to_image for Rails 1.0 backwards compatibility
+      # def image_path(*params)
+      #   path_to_image(*params)
+      # end
+      
+      # renders the RFacebook debug panel
+      def facebook_debug_panel(options={}) # :nodoc:
+        RAILS_DEFAULT_LOGGER.info "** RFACEBOOK DEPRECATION WARNING: 'facebook_debug_panel' is deprecated in ActionViews"
+        return @controller.facebook_debug_panel(options)
+      end
+      
+    end
+  end
+end

data/tasks/all.rake

@@ -0,0 +1,176 @@
+# AUTHORS:
+# - Matt Pizzimenti (www.livelearncode.com)
+# - Evan Weaver (http://blog.evanweaver.com)
+
+# LICENSE:
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+# 
+# Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 
+# Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+# 
+# Neither the name of the original author nor the names of contributors
+# may be used to endorse or promote products derived from this software
+# without specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+# Rake tasks modified from Evan Weaver's article
+# http://blog.evanweaver.com/articles/2007/07/13/developing-a-facebook-app-locally
+
+namespace "facebook" do
+
+  ######################################################################################
+  ######################################################################################
+  desc "Sets up the RFacebook Rails Plugin.  Right now, this simply copies facebook.yml into your config directory."
+  task "setup" do
+    
+    filename = "#{RAILS_ROOT}/config/facebook.yml"
+    puts "======================================================"
+    puts "Setting up RFacebook on Rails Plugin"
+    
+    ###### Install sample facebook.yml
+    file = File.new(filename, "w")
+    file <<
+"
+development:
+  facebook:
+    key: YOUR_API_KEY_HERE
+    secret: YOUR_API_SECRET_HERE
+    canvas_path: /yourfbAppName/
+    callback_path: /path/to/your/fbcallback/
+    tunnel:
+      username: yourLoginName
+      host: www.yourexternaldomain.com
+      port: 1234
+      local_port: 5678
+  bebo:
+    key: YOUR_API_KEY_HERE
+    secret: YOUR_API_SECRET_HERE
+    canvas_path: /yourbeboAppName/
+    callback_path: /path/to/your/bebocallback/
+    tunnel:
+      username: yourLoginName
+      host: www.yourexternaldomain.com
+      port: 1234
+      local_port: 5678
+
+test:
+  facebook:
+    key: YOUR_API_KEY_HERE
+    secret: YOUR_API_SECRET_HERE
+    canvas_path: /yourfbAppName/
+    callback_path: /path/to/your/fbcallback/
+    tunnel:
+      username: yourLoginName
+      host: www.yourexternaldomain.com
+      port: 1234
+      local_port: 5678
+  bebo:
+    key: YOUR_API_KEY_HERE
+    secret: YOUR_API_SECRET_HERE
+    canvas_path: /yourbeboAppName/
+    callback_path: /path/to/your/bebocallback/
+    tunnel:
+      username: yourLoginName
+      host: www.yourexternaldomain.com
+      port: 1234
+      local_port: 5678
+
+production:
+  facebook:
+    key: YOUR_API_KEY_HERE
+    secret: YOUR_API_SECRET_HERE
+    canvas_path: /yourfbAppName/
+    callback_path: /path/to/your/fbcallback/
+    tunnel:
+      username: yourLoginName
+      host: www.yourexternaldomain.com
+      port: 1234
+      local_port: 5678
+  bebo:
+    key: YOUR_API_KEY_HERE
+    secret: YOUR_API_SECRET_HERE
+    canvas_path: /yourbeboAppName/
+    callback_path: /path/to/your/bebocallback/
+    tunnel:
+      username: yourLoginName
+      host: www.yourexternaldomain.com
+      port: 1234
+      local_port: 5678
+"
+    file.close_write
+    puts "  [1] Created config/facebook.yml <-- BE SURE TO CHANGE THE API KEY AND SECRET"
+    
+    ###### Finished
+    puts "Done."
+    puts "======================================================"
+  end
+  
+  
+  namespace "tunnel" do
+
+    ######################################################################################
+    ######################################################################################
+    ## TODO: let this take in a network, like "facebook" or "bebo"
+    desc "Start a reverse tunnel to develop from localhost. Please ensure that you have a properly configured config/facebook.yml file."
+    task "start" => "environment" do
+      puts FACEBOOK.inspect
+      remoteUsername = FACEBOOK['facebook']['tunnel']['username']
+      remoteHost = FACEBOOK['facebook']['tunnel']['host']
+      remotePort = FACEBOOK['facebook']['tunnel']['port']
+      localPort = FACEBOOK['facebook']['tunnel']['local_port']
+      sshPort = FACEBOOK['facebook']['tunnel']['ssh_port'] || "22"
+      
+      puts "======================================================"
+      puts "Tunneling #{remoteHost}:#{remotePort} to 0.0.0.0:#{localPort}"
+            
+      puts
+      puts "NOTES:"
+      puts "* ensure that you have Rails running on your local machine at port #{localPort}"
+      puts "* once logged in to the tunnel, you can visit http://#{remoteHost}:#{remotePort} to view your site"
+      puts "* use ctrl-c to quit the tunnel"
+      puts "* if you have problems creating the tunnel, you may need to add the following to /etc/ssh/sshd_config on your server:"
+      puts "
+GatewayPorts clientspecified
+
+"
+      puts "* if you have problems with #{remoteHost} timing out your ssh connection, add the following lines to your '~/.ssh/config' file:"
+      puts "
+Host #{remoteHost}
+  ServerAliveInterval 120
+
+"
+      puts "======================================================"
+      exec "ssh -p #{sshPort} -nNT -g -R *:#{remotePort}:0.0.0.0:#{localPort} #{remoteUsername}@#{remoteHost}"
+    end
+    
+    ######################################################################################
+    ######################################################################################
+    desc "Check if reverse tunnel is running"
+    task "status" => "environment" do    
+      sshPort = FACEBOOK['tunnel']['ssh_port'] || "22"
+      if `ssh -p #{sshPort} #{FACEBOOK['tunnel']['username']}@#{FACEBOOK['tunnel']['host']} netstat -an | 
+          egrep "tcp.*:#{FACEBOOK['tunnel']['port']}.*LISTEN" | wc`.to_i > 0
+        puts "Tunnel still running"
+      else
+        puts "Tunnel is down"
+      end
+    end
+  end
+
+
+end

data/templates/debug_panel.rhtml

@@ -0,0 +1,220 @@
+<style type="text/css">
+
+.RFacebook .environment
+	{
+		padding: 30px;
+        
+		background: #F7F7F7;
+		border-bottom: 1px solid #B7B7B7;
+	}
+
+.RFacebook .environment a
+	{
+		color: #3F5A95;
+	}
+
+.RFacebook .environment table
+	{
+		margin: 0px auto 5px auto;
+		width: 100%;
+		
+		border-collapse: collapse;
+	}
+
+.RFacebook .environment td
+	{
+		padding: 5px;
+		padding-left: 10px;
+		border-width: 1px 0px 1px 0px;
+    
+		border-color: #ccc;
+		border-style: solid;
+		font-size: 0.9em;
+	}
+
+.RFacebook .environment td.value
+	{
+		width: 100%;
+    
+		color: #777;
+	}
+
+.RFacebook .environment td.header
+	{
+		padding-top: 10px;
+		padding-left: 0px;
+		border-top-width: 0px;
+		
+		font-weight: bold;
+		font-size: 1.3em;
+	}
+
+.RFacebook .environment h1
+	{
+		margin: 0px 0px 5px 0px;
+		padding: 0px;
+    
+		color: #3F5A95;
+		font-size: 1.6em;
+	}
+
+.RFacebook .environment p
+	{
+		padding: 5px;
+		margin: 0px 0px 20px 0px;
+    
+		color: #777;
+	}
+  
+.RFacebook .error
+	{
+		color: red;
+		margin: 0px;
+		padding: 2px;
+		color: #FF9A8D;
+		background-color: #900;
+	}
+
+.RFacebook .valid
+	{
+		margin: 0px;
+		padding: 2px;
+		color: #B2FE8C;
+		background-color: #06B012;
+	}
+
+.RFacebook table.details
+	{
+		border-collapse: collapse;
+		width: auto;
+	}
+
+.RFacebook table.details td
+	{
+		border: none;
+		padding: 0px;
+		color: #777;
+	}
+
+.RFacebook table.details td.value
+	{
+		width: 100%;
+		padding-left: 10px;
+		color: black;
+	}
+
+.RFacebook .backtrace
+	{
+		border-collapse: collapse;
+		background-color: #3B5998;
+		color: white;
+	}
+
+.RFacebook .backtrace
+	{
+		padding: 30px;
+		background: #3B5998;
+	}
+
+.RFacebook .backtrace h1
+	{
+		margin: 0px 0px 5px 0px;
+		padding: 0px;
+    
+		color: white;
+		font-size: 1.6em;
+	}
+
+/*
+.RFacebook table.backtrace td
+	{
+		padding: 10px 2px 10px 2px;
+		border-width: 1px 0px 1px 0px;
+		
+		border-style: solid;
+		border-color: #ccc;
+	}
+*/
+
+.RFacebook .backtrace div.summary
+	{
+		font-size: 1.2em;
+		padding: 2px;
+		color: white;
+	}
+	
+.RFacebook .backtrace div.rawsummary
+	{
+		font-size: 0.7em;
+		color: #6D84B4;
+		padding-left: 5px;
+	}
+
+.RFacebook ul
+	{
+		margin: 0px;
+		padding: 0px;
+		list-style-type: none;
+	}
+
+.RFacebook ul li
+	{
+		list-style-type: none;
+		padding: 5px;
+	}
+
+</style>
+
+<div class="RFacebook">
+	
+	<div class="environment">
+  
+		<h1>RFacebook <span style="font-weight: normal; color: #777">environment information</span></h1>
+		<p>
+			This shows you at a glance the information that RFacebook has populated
+			for you.
+			<br/>
+			More information at <a href="http://rfacebook.rubyforge.org">rfacebook.rubyforge.org</a>.
+			Please report RFacebook bugs <a href="http://rubyforge.org/tracker/?func=add&group_id=3607&atid=13796">here</a>.
+			
+		</p>
+  
+		<table>
+  
+			<!-- ####################### ActionController ####################### -->
+			<tr>
+				<td colspan="3" class="header"><%= self.class %></td>
+			</tr>
+			
+			<% facebook_status_manager.each_status_check do |statusCheck| %>
+				<tr>
+					<td class="title"><%= statusCheck.title %></td>
+					<td class="rstatus">
+						<% if statusCheck.valid? %>
+							<span class="valid">OK</span>
+						<% else %>
+							<span class="error">PROBLEM</span>
+						<% end %>
+					</td>
+					<td class="value">
+						<% if statusCheck.message.is_a? String %>
+							<%= statusCheck.message %>
+						<% elsif statusCheck.message.is_a? Hash %>
+							<table class="details">
+								<% statusCheck.message.each do |k,v| %>
+									<tr>
+										<td><%= k %></td>
+										<td class="value"><%= v %></td>
+									</tr>
+								<% end %>
+							</table>
+						<% end %>
+					</td>
+				</tr>
+			<% end %>
+		
+		
+		</table>
+  
+	</div>
+</div>