mrflip-frankie 0.3.0

data/CHANGELOG

@@ -0,0 +1,11 @@
+v0.3.0  Updated to work with Sinatra 0.9.x and facebooker 1.0.2, thanks to mjfreshyfresh
+
+v0.2.5.	Bugfix for fb_url_for helper method
+
+v0.2.4.	Add fb_url_for helper method to create link URL's that have proper Facebook application reference included
+
+v0.2.3.	Correct README and fix Sinatra version dependency in gem
+
+v0.2.2.	Updated to deal with session change in Sinatra, plus misc bug fixes with Facebooker integration
+
+v0.2.0.	Converted codebase to become Ruby Gem

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Ron Evans
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest

@@ -0,0 +1,9 @@
+bin/tunnel
+CHANGELOG
+lib/frankie.rb
+LICENSE
+Manifest
+Rakefile
+README.rdoc
+test/frankie_test.rb
+test/helper.rb

data/README.rdoc

@@ -0,0 +1,79 @@
+= 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!

data/Rakefile

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'echoe'
+
+task :default => :test
+ 
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files += ["README.rdoc"]
+  rd.rdoc_files += Dir.glob("lib/**/*.rb")
+  rd.rdoc_dir = 'doc'
+end
+ 
+Rake::TestTask.new do |t|
+  ENV['SINATRA_ENV'] = 'test'
+  t.pattern = File.dirname(__FILE__) + "/test/*_test.rb"
+end
+ 
+Echoe.new("frankie") do |p|
+  p.author = "Ron Evans"
+  p.summary = "Easy creation of Facebook applications in Ruby using plugin for Sinatra web framework that integrates with Facebooker gem."
+  p.url = "http://facethesinatra.com/"
+  p.dependencies = ["sinatra >=0.2.2", "facebooker >=0.9.5"]
+  p.install_message = "*** Frankie was installed ***"
+  p.include_rakefile = true
+end
+

data/bin/tunnel

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+host, remote_port, local_port = ARGV
+raise 'You must specify at least a hostname - i.e. tunnel myhost.com' unless host
+remote_port ||= 10000
+local_port  ||= 4567
+puts "Tunneling #{host}:#{remote_port} to 0.0.0.0:#{local_port}"
+begin
+  exec "autossh -M 48484 -nNT -g -R *:#{remote_port}:0.0.0.0:#{local_port} #{host}"
+rescue
+  raise "Tunnel failed to start. Do you have autossh installed?"
+end

data/frankie.gemspec

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{frankie}
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ron Evans"]
+  s.date = %q{2009-09-03}
+  s.default_executable = %q{tunnel}
+  s.description = %q{Easy creation of Facebook applications in Ruby using plugin for Sinatra web framework that integrates with Facebooker gem.}
+  s.email = %q{}
+  s.executables = ["tunnel"]
+  s.extra_rdoc_files = ["bin/tunnel", "CHANGELOG", "lib/frankie.rb", "LICENSE", "README.rdoc"]
+  s.files = ["bin/tunnel", "CHANGELOG", "lib/frankie.rb", "LICENSE", "Manifest", "Rakefile", "README.rdoc", "test/frankie_test.rb", "test/helper.rb", "frankie.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://facethesinatra.com/}
+  s.post_install_message = %q{*** Frankie was installed ***}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Frankie", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{frankie}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Easy creation of Facebook applications in Ruby using plugin for Sinatra web framework that integrates with Facebooker gem.}
+  s.test_files = ["test/frankie_test.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<sinatra>, [">= 0.2.2"])
+      s.add_runtime_dependency(%q<facebooker>, [">= 0.9.5"])
+    else
+      s.add_dependency(%q<sinatra>, [">= 0.2.2"])
+      s.add_dependency(%q<facebooker>, [">= 0.9.5"])
+    end
+  else
+    s.add_dependency(%q<sinatra>, [">= 0.2.2"])
+    s.add_dependency(%q<facebooker>, [">= 0.9.5"])
+  end
+end

data/lib/frankie.rb

@@ -0,0 +1,195 @@
+# frankie - a plugin for sinatra that integrates with the facebooker gem
+#
+# written by Ron Evans (http://www.deadprogrammersociety.com)
+#
+# based on merb_facebooker (http://github.com/vanpelt/merb_facebooker)
+# and the Rails classes in Facebooker (http://facebooker.rubyforge.org/) from Mike Mangino, Shane Vitarana, & Chad Fowler
+#
+
+require 'sinatra'
+
+module Frankie
+
+  module Loader
+
+    require 'yaml'
+    require 'uri'
+
+    def load_facebook_config(file, env=:development)
+      if File.exist?(file)
+        yaml = YAML.load_file(file)[env.to_s]
+        ENV['FACEBOOK_API_KEY'] = yaml['api_key']
+        ENV['FACEBOOK_SECRET_KEY'] = yaml['secret_key']
+        ENV['FACEBOOKER_RELATIVE_URL_ROOT'] = yaml['canvas_page_name']
+      end
+    end
+
+  end
+
+  module EventContext
+
+    # pin it to newer version of Facebooker
+    # gem 'mmangino-facebooker', '>=1.0.2'
+    require 'facebooker'
+
+    def facebook_session
+      @facebook_session
+    end
+
+    def facebook_session_parameters
+      {:fb_sig_session_key=>params["fb_sig_session_key"]}
+    end
+
+    def set_facebook_session
+      session_set = session_already_secured? || secure_with_token! || secure_with_facebook_params!
+      if session_set
+        capture_facebook_friends_if_available!
+        Facebooker::Session.current = facebook_session
+      end
+      session_set
+    end
+
+    def facebook_params
+      @facebook_params ||= verified_facebook_params
+    end
+
+    private
+
+    def session_already_secured?
+      (@facebook_session = session[:facebook_session]) && session[:facebook_session].secured?
+    end
+
+    def secure_with_token!
+      if params['auth_token']
+        @facebook_session = new_facebook_session
+        @facebook_session.auth_token = params['auth_token']
+        @facebook_session.secure!
+        session[:facebook_session] = @facebook_session
+      end
+    end
+
+    def secure_with_facebook_params!
+      return unless request_is_for_a_facebook_canvas?
+      if ['user', 'session_key'].all? {|element| facebook_params[element]}
+        @facebook_session = new_facebook_session
+        @facebook_session.secure_with!(facebook_params['session_key'], facebook_params['user'], facebook_params['expires'], facebook_params['ss'])
+        session[:facebook_session] = @facebook_session
+      end
+    end
+
+    def create_new_facebook_session_and_redirect!
+      session[:facebook_session] = new_facebook_session
+      throw :halt, do_redirect(session[:facebook_session].login_url) unless @installation_required
+    end
+
+    def new_facebook_session
+      Facebooker::Session.create(Facebooker::Session.api_key, Facebooker::Session.secret_key)
+    end
+
+    def capture_facebook_friends_if_available!
+      return unless request_is_for_a_facebook_canvas?
+      if friends = facebook_params['friends']
+        facebook_session.user.friends = friends.map do |friend_uid|
+          Facebooker::User.new(friend_uid, facebook_session)
+        end
+      end
+    end
+
+    def blank?(value)
+      (value == '0' || value.nil? || value == '')
+    end
+
+    def verified_facebook_params
+      facebook_sig_params = params.inject({}) do |collection, pair|
+        collection[pair.first.sub(/^fb_sig_/, '')] = pair.last if pair.first[0,7] == 'fb_sig_'
+        collection
+      end
+      verify_signature(facebook_sig_params, params['fb_sig'])
+      facebook_sig_params.inject(Hash.new) do |collection, pair|
+        collection[pair.first] = facebook_parameter_conversions[pair.first].call(pair.last)
+        collection
+      end
+    end
+
+    # 48.hours.ago in sinatra
+    def earliest_valid_session
+      now = Time.now
+      now -= (60 * 60 * 48)
+      now
+    end
+
+    def verify_signature(facebook_sig_params,expected_signature)
+      return true if expected_signature.nil?
+      raw_string = facebook_sig_params.map{ |*args| args.join('=') }.sort.join
+      actual_sig = Digest::MD5.hexdigest([raw_string, Facebooker::Session.secret_key].join)
+      raise Facebooker::Session::IncorrectSignature if actual_sig != expected_signature
+      raise Facebooker::Session::SignatureTooOld if Time.at(facebook_sig_params['time'].to_f) < earliest_valid_session
+      true
+    end
+
+    def facebook_parameter_conversions
+      @facebook_parameter_conversions ||= Hash.new do |hash, key|
+        lambda{|value| value}
+      end.merge(
+        'time' => lambda{|value| Time.at(value.to_f)},
+        'in_canvas' => lambda{|value| !blank?(value)},
+        'added' => lambda{|value| !blank?(value)},
+        'expires' => lambda{|value| blank?(value) ? nil : Time.at(value.to_f)},
+        'friends' => lambda{|value| value.split(/,/)}
+      )
+    end
+
+    def do_redirect(*args)
+      if request_is_for_a_facebook_canvas?
+        fbml_redirect_tag(args[0])
+      else
+        redirect args[0]
+      end
+    end
+
+    def fbml_redirect_tag(url)
+      "<fb:redirect url=\"#{url}\" />"
+    end
+
+    def request_is_for_a_facebook_canvas?
+      return false if (params["fb_sig_in_canvas"].nil? && params["fb_sig_in_iframe"].nil?)
+      (params["fb_sig_in_canvas"] == "1") || (params["fb_sig_in_iframe"] == '1')
+    end
+
+    def application_is_installed?
+      facebook_params['added']
+    end
+
+    def ensure_authenticated_to_facebook
+      set_facebook_session || create_new_facebook_session_and_redirect!
+    end
+
+    def ensure_application_is_installed_by_facebook_user
+      @installation_required = true
+      authenticated_and_installed = ensure_authenticated_to_facebook && application_is_installed?
+      application_is_not_installed_by_facebook_user unless authenticated_and_installed
+      authenticated_and_installed
+    end
+
+    def application_is_not_installed_by_facebook_user
+      throw :halt, do_redirect(session[:facebook_session].install_url)
+    end
+
+    def set_fbml_format
+      params['format']="fbml" if request_is_for_a_facebook_canvas?
+    end
+
+    def fb_url_for(url)
+      url = "" if url == "/"
+      url = URI.escape(url)
+      return url if !request_is_for_a_facebook_canvas?
+      "http://apps.facebook.com/#{ENV['FACEBOOKER_RELATIVE_URL_ROOT']}/#{url}"
+    end
+
+  end
+
+end
+
+# extend sinatra with frankie methods, changed to work with Sinatra 0.9.x
+Sinatra::Default.send(:include, Frankie::EventContext)
+include Frankie::Loader

data/test/frankie_test.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/helper'
+
+context "frankie" do
+  it "should be a placeholder for a real test" do
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'sinatra'
+require File.dirname(__FILE__) + '/../lib/frankie'
+require 'sinatra/test/spec'

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: mrflip-frankie
+version: !ruby/object:Gem::Version 
+  version: 0.3.0
+platform: ruby
+authors: 
+- Ron Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-03 00:00:00 -07:00
+default_executable: tunnel
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: facebooker
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.5
+    version: 
+description: Easy creation of Facebook applications in Ruby using plugin for Sinatra web framework that integrates with Facebooker gem.
+email: ""
+executables: 
+- tunnel
+extensions: []
+
+extra_rdoc_files: 
+- bin/tunnel
+- CHANGELOG
+- lib/frankie.rb
+- LICENSE
+- README.rdoc
+files: 
+- bin/tunnel
+- CHANGELOG
+- lib/frankie.rb
+- LICENSE
+- Manifest
+- Rakefile
+- README.rdoc
+- test/frankie_test.rb
+- test/helper.rb
+- frankie.gemspec
+has_rdoc: true
+homepage: http://facethesinatra.com/
+post_install_message: "*** Frankie was installed ***"
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Frankie
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: frankie
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Easy creation of Facebook applications in Ruby using plugin for Sinatra web framework that integrates with Facebooker gem.
+test_files: 
+- test/frankie_test.rb