jsmestad-frankie 0.4.2 → 0.5.0

data/README.textile

@@ -0,0 +1,81 @@
+h1. Frankie
+
+h2. Sinatra Meets Facebook(er)
+
+Frankie is a Facebooker wrapper for Sinatra (http://www.sinatrarb.com)
+
+Maintained by Justin Smestad (http://www.evalcode.com). This version is not backwards compatible with anything prior to Sinatra 0.9. Original version by Ron Evans has support for older versions of Sinatra and 'classic-style' applications.
+
+Frankie is based on merb_facebooker by Chris Van Pelt.
+
+h2. Sample Application
+
+	require 'rubygems'
+	require 'frankie'
+
+  module MyApp < Sinatra::Base
+    register Sinatra::Frankie
+
+    configure do
+      set_option :sessions, true
+      load_facebook_config File.dirname(__FILE_) + "/config/facebooker.yml", Sinatra::Application.environment
+    end
+
+    ## facebooker helpers
+    before do
+      ensure_authenticated_to_facebook
+      ensure_application_is_installed_by_facebook_user
+    end
+
+
+	  ## the site
+	  get '/' do
+	    body "Hello #{session[:facebook_session].user.name} and welcome to frankie!"
+	  end
+  end
+
+
+h2. Using Frankie
+
+* Install the frankie gem (which will install both Sinatra and Facebooker if you do not already have them)
+	sudo gem install frankie
+
+* Create the application directories for your new app
+	mkdir myapp
+	cd myapp
+	mkdir config
+
+* Put your facebooker.yml file into the /lib/<application_name>/config directory, and set the values to your information. Here is a simple example of the file:
+
+	development:
+	 api_key: apikeyhere 
+	 secret_key: secretkeyhere
+	 canvas_page_name: yourcanvashere    
+	 callback_url: http://localhost:4567
+	test:
+	 api_key: apikeyhere 
+	 secret_key: secretkeyhere
+	 canvas_page_name: yourcanvashere    
+	 callback_url: http://localhost:4567
+	production:
+	 api_key: apikeyhere 
+	 secret_key: secretkeyhere
+	 canvas_page_name: yourcanvashere    
+	 callback_url: http://yourrealserver.com
+
+
+* Make sure you have setup your Facebook application on the facebook site. Google "setup new facebook application" if you are unsure how to do this. I recommend starting with an IFrame application. A more advanced and cooler approach uses a tunneling script, which is included with Frankie. You do need to have "autossh" installed in order to use it, as well as a publicly addressable server. From a command prompt type tunnel <host> <remote_port> <local_port> like this:
+
+	tunnel app.myhost.com 10000 4567
+
+You will also need to make sure your server's /etc/ssh/sshd_config contains the following line:
+
+	GatewayPorts clientspecified
+
+Thanks to the many people like Evan Weaver, Blake Mizerany, and whoever else that have provided the code used in this tunneling script.
+
+* Create your application, based on the sample above, and then run it:
+ruby sample.rb
+
+* Test your app by going to http://apps.facebook.com/yourappname
+

data/VERSION

@@ -1 +1 @@
-0.4.2
+0.5.0

data/frankie.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{frankie}
-  s.version = "0.4.2"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ron Evans", "Justin Smestad"]
-  s.date = %q{2009-06-25}
+  s.date = %q{2009-06-26}
   s.default_executable = %q{tunnel}
   s.email = %q{justin.smestad@gmail.com}
   s.executables = ["tunnel"]
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+     "README.textile"
   ]
   s.files = [
     ".DS_Store",
@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
      "CHANGELOG",
      "LICENSE",
      "Manifest",
-     "README.rdoc",
+     "README.textile",
      "Rakefile",
      "VERSION",
      "bin/tunnel",

data/lib/frankie.rb

@@ -180,7 +180,10 @@ module Sinatra
         "http://apps.facebook.com/#{ENV['FACEBOOKER_RELATIVE_URL_ROOT']}/#{url}"
       end
     end
+
+    def self.registered(app)
+      app.register Loader
+      app.helpers Helpers
+    end
   end
-  register Frankie::Loader
-  helpers Frankie::Helpers
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jsmestad-frankie
 version: !ruby/object:Gem::Version 
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors: 
 - Ron Evans
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-25 00:00:00 -07:00
+date: 2009-06-26 00:00:00 -07:00
 default_executable: tunnel
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,14 +41,14 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.textile
 files: 
 - .DS_Store
 - .gitignore
 - CHANGELOG
 - LICENSE
 - Manifest
-- README.rdoc
+- README.textile
 - Rakefile
 - VERSION
 - bin/tunnel

data/README.rdoc

@@ -1,79 +0,0 @@
-= Frankie
-
-Frankie (http://facethesinatra.com) is a plugin for the Sinatra web framework (http://sinatrarb.com) that allows you to easily create a Facebook application by using the Facebooker gem.
-
-Written by Ron Evans (http://www.deadprogrammersociety.com)
-
-Based on merb_facebooker (http://github.com/vanpelt/merb_facebooker) by Chris Van Pelt, which was based on
-the Rails classes in Facebooker (http://facebooker.rubyforge.org/) by Mike Mangino, Shane Vitarana, & Chad Fowler
-
-2/20/2009 - Now updated to Sinatra 0.9 and facebooker thanks to mjfreshyfresh.
-
-Thanks, everyone!
-
-= Here is a very simple example application:
-
-	require 'rubygems'
-	require 'frankie'
-
-	configure do
-	  set_option :sessions, true
-	  load_facebook_config "./config/facebooker.yml", Sinatra.env
-	end
-
-	## facebooker helpers
-	before do
-	  ensure_authenticated_to_facebook
-	  ensure_application_is_installed_by_facebook_user
-	end
-
-	## the site
-	get '/' do
-	  body "<h1>Hello #{session[:facebook_session].user.name} and welcome to frankie!</h1>"
-	end
-
-
-= How to use frankie
-- Install the frankie gem (which will install both Sinatra and Facebooker if you do not already have them)
-	sudo gem install frankie
-
-- Create the application directories for your new app
-	mkdir myapp
-	cd myapp
-	mkdir config
-
-- Put your facebooker.yml file into the /myapp/config directory, and set the values to your information. Here is a simple example of the file:
-
-	development:
-	 api_key: apikeyhere 
-	 secret_key: secretkeyhere
-	 canvas_page_name: yourcanvashere    
-	 callback_url: http://localhost:4567
-	test:
-	 api_key: apikeyhere 
-	 secret_key: secretkeyhere
-	 canvas_page_name: yourcanvashere    
-	 callback_url: http://localhost:4567
-	production:
-	 api_key: apikeyhere 
-	 secret_key: secretkeyhere
-	 canvas_page_name: yourcanvashere    
-	 callback_url: http://yourrealserver.com
-
-
-- Make sure you have setup your Facebook application on the facebook site. Google "setup new facebook application" if you are unsure how to do this. I recommend starting with an IFrame application. A more advanced and cooler approach uses a tunneling script, which is included with Frankie. You do need to have "autossh" installed in order to use it, as well as a publicly addressable server. From a command prompt type tunnel <host> <remote_port> <local_port> like this:
-
-	tunnel app.myhost.com 10000 4567
-
-You will also need to make sure your server's /etc/ssh/sshd_config contains the following line:
-
-	GatewayPorts clientspecified
-
-Thanks to the many people like Evan Weaver, Blake Mizerany, and whoever else that have provided the code used in this tunneling script.
-
-- Create your application, based on the sample above, and then run it:
-ruby sample.rb
-
-- Test your app by going to http://apps.facebook.com/yourappname
-
-Have fun!