RubyGems - eukaliptus - Versions diffs - 0.7.1 - Mend

eukaliptus 0.7.1

Files changed (20) hide show

data/.gitignore +44 -0
data/Gemfile +8 -0
data/LICENSE.txt +20 -0
data/README.rdoc +56 -0
data/Rakefile +16 -0
data/eukaliptus.gemspec +23 -0
data/lib/eukaliptus.rb +3 -0
data/lib/eukaliptus/koala.rb +17 -0
data/lib/eukaliptus/middleware.rb +66 -0
data/lib/eukaliptus/railtie.rb +41 -0
data/lib/eukaliptus/request.rb +13 -0
data/lib/eukaliptus/version.rb +3 -0
data/lib/eukaliptus/view_helpers/facebook_helpers.rb +173 -0
data/lib/generators/eukaliptus/config_generator.rb +18 -0
data/lib/generators/templates/facebook.yml +16 -0
data/lib/tasks/facebook.rake +19 -0
data/test/test_eukaliptus.rb +7 -0
data/test/test_helper.rb +22 -0
data/test/view_helpers/facebook_helpers_test.rb +10 -0
metadata +88 -0

data/.gitignore ADDED Viewed

@@ -0,0 +1,44 @@
+Gemfile.lock
+# rcov generated
+coverage
+# rdoc generated
+rdoc
+# yard generated
+doc
+.yardoc
+# bundler
+.bundle
+# jeweler generated
+pkg
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore:
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+#
+# For TextMate
+#*.tmproj
+#tmtags
+#
+# For emacs:
+#*~
+#\#*
+#.\#*
+#
+# For vim:
+#*.swp

data/Gemfile ADDED Viewed

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+gem 'koala'
+group :development do
+  gem "minitest", ">= 0", :platforms => :ruby_18
+  gem "bundler", "~> 1.0.0"
+end

data/LICENSE.txt ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Season Advertising S.L., Victor Castell
+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/README.rdoc ADDED Viewed

@@ -0,0 +1,56 @@
+= Eukaliptus
+Eukaliptus is a set of helpers to help you build Facebook applications, fan pages tabs or integrate Facebook in your web site.
+It generates the necessary JS code to perform requests to Eukaliptus Rack middleware that fixes cookies security problems related with running iframe applications inside facebook. It is also useful for Facebook connect apps.
+With Eukaliptus and Koala it's very easy to build-up a rock solid Facebook connect application with JS authentication that works in all browsers in less that 5 minutes.
+It will be a key component of our next product Eukaliptus Core.
+We provide integration with two authentication methods out of the box, Koala Facebook library, see https://github.com/arsduo/koala and the combination of Omniauth + Devise.
+== Installation (Rails)
+Require it in your Gemfile
+    gem 'eukaliptus', :git => 'git://github.com/seasonlabs/eukaliptus.git'
+Update your bundle
+    $ bundle install
+Run the generator
+    $ rails generate eukaliptus:config
+Go to http://www.facebook.com/developers/createapp.php and create a new Facebook app, configure it and then fill up the file  config/facebook.yml with the details of you newly created app.
+You are now ready to begin using Eukaliptus.
+== Requirements
+jQuery library for the front-end.
+Your rails application must be using jQuery as it will be the default JS library for Rails from 3.1+.
+== Getting started
+Just behind the <body> tag in your application.html.erb write:
+    <%= fb_login %>
+This generates the necessary JS code to perform request to Eukaliptus that fixes cookies security problems involved in running iframe applications in Safari and IE6+
+Then you can place a link anywhere in your code that gives the user the chance to login with Facebook:
+    <%= link_to "Log in with Facebook", "#", :onclick => "login('/redirect/path');" %>
+== Helpers
+Al helpers are namespaced with fb_ prefix you can find the documentation in  this file lib/eukaliptus/view_helpers/facebook_helpers.rb
+== Copyright
+Copyright (c) 2011 Season Advertising S.L. http://www.season.es
+See LICENSE.txt for further details.

data/Rakefile ADDED Viewed

@@ -0,0 +1,16 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+require 'rubygems'
+require 'rake/testtask'
+require 'rake/rdoctask'
+task :default => :test
+desc 'Test the typus plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/eukaliptus.gemspec ADDED Viewed

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "eukaliptus/version"
+Gem::Specification.new do |s|
+  s.name        = "eukaliptus"
+  s.version     = Eukaliptus::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["season", "victorcoder"]
+  s.email       = ["victorcoder@gmail.com"]
+  s.homepage    = "http://github.com/seasonlabs/eukaliptus"
+  s.summary     = %q{Eukaliptus Facebook API Helpers}
+  s.description = %q{Eukaliptus is a set of helpers and bug fixes for browsers to help you build Facebook iframe applications or user fan tabs.}
+  s.license     = "MIT"
+  s.rubyforge_project = "eukaliptus"
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.add_dependency 'koala', '~> 1.0.0'
+end

data/lib/eukaliptus.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module Eukaliptus
+  require 'eukaliptus/railtie' if defined?(Rails)
+end

data/lib/eukaliptus/koala.rb ADDED Viewed

@@ -0,0 +1,17 @@
+# config/initializers/koala.rb
+# Monkey-patch in Facebook config so Koala knows to
+# automatically use Facebook settings from here if none are given
+Koala::Facebook::OAuth.class_eval do
+  def initialize_with_default_settings(*args)
+    case args.size
+      when 0, 1
+        raise "application id and/or secret are not specified in the config" unless Facebook::APP_ID && Facebook::SECRET
+        initialize_without_default_settings(Facebook::APP_ID.to_s, Facebook::SECRET.to_s, args.first)
+      when 2, 3
+        initialize_without_default_settings(*args)
+    end
+  end
+  alias_method_chain :initialize, :default_settings
+end

data/lib/eukaliptus/middleware.rb ADDED Viewed

@@ -0,0 +1,66 @@
+module Eukaliptus
+  class Middleware
+    def initialize(app, options = {})
+      @app, @options = app, options
+    end
+    def call(env)
+      @request = Request.new(env)
+      # Catch and convert POST from facebook
+      if @request.facebook?
+        env["facebook.original_method"] = env["REQUEST_METHOD"]
+        env["REQUEST_METHOD"] = 'GET'
+      end
+      status, headers, body = @app.call(env)
+      @response = Rack::Response.new body, status, headers
+      # Fixes IE security bug
+      @response.header["P3P"] = 'CP="IDC DSP COR ADM DEVi TAIi PSA PSD IVAi IVDi CONi HIS OUR IND CNT"'
+      if env['PATH_INFO'] == '/cookie_fix'
+        cookie_fix(env)
+      else
+        @response.finish
+      end
+    end
+    # Get POST params and process it to build up the cookie for FB
+    # authentication. Then prepare the response for redirection and
+    # breaks the request workflow setting the cookie at the same time.
+    # This way Safari and other browsers with extra iframe security
+    # gets the cookie set too.
+    def cookie_fix(env)
+      params = @request.params
+      if params['_session_id']
+        session = ActiveSupport::JSON.decode(params['_session_id'])
+        unless (@request.cookies['fbs_' + Facebook::APP_ID.to_s].present?)
+          session = session.map { |key, value| key.to_s + "=" + value.to_s }.join("&")
+          @response.set_cookie('fbs_' + Facebook::APP_ID.to_s, session)
+        end
+      end
+      @response.headers.delete "Content-Type"
+      @response.headers.delete "Content-Length"
+      @response.headers.delete "X-Cascade"
+      if defined?(OmniAuth) and defined?(Devise)
+        mappings = Devise.mappings[:user]
+        if mappings.controllers.has_key? :omniauth_callbacks
+          path = [mappings.path, 'auth', :facebook.to_s, 'callback'].join('/')
+          @response.redirect(path  + "?redirect_to=#{params['redirect_to']}")
+        else
+          @response.redirect('/' + "?redirect_to=#{params['redirect_to']}")
+        end
+      else
+        @response.redirect((params['redirect_to'] ? params['redirect_to'] : '/'))
+      end
+      [302, @response.headers, ['Cookie Setted']]
+    end
+  end
+end

data/lib/eukaliptus/railtie.rb ADDED Viewed

@@ -0,0 +1,41 @@
+require 'rails'
+require 'koala'
+require 'eukaliptus/request'
+require 'eukaliptus/middleware'
+module Facebook
+end
+module Eukaliptus
+  class Railtie < Rails::Railtie
+    # Load rake tasks
+    rake_tasks do
+      load File.join(File.dirname(__FILE__), '../tasks/facebook.rake')
+    end
+    initializer "eukaliptus.middleware", :after => :after_initialize do |app|
+      #ActionView::Base.send :include, Helper
+      app.middleware.use Eukaliptus::Middleware
+    end
+    initializer "eukaliptus.koala" do |app|
+      config_file = Rails.root.join("config/facebook.yml")
+      if config_file.file?
+        CONFIG = YAML.load_file(config_file)[Rails.env]
+        Facebook::APP_ID = CONFIG['app_id']
+        Facebook::SECRET = CONFIG['secret_key']
+        Facebook::CANVAS = CONFIG['canvas']
+      end
+      require 'eukaliptus/koala'
+    end
+    initializer "eukaliptus.action_view" do |app|
+      ActiveSupport.on_load :action_view do
+        require 'eukaliptus/view_helpers/facebook_helpers'
+        include Eukaliptus::FacebookHelpers
+      end
+    end
+  end
+end

data/lib/eukaliptus/request.rb ADDED Viewed

@@ -0,0 +1,13 @@
+require 'rack/request'
+# Extend Rack::Request to add some helpers for FB
+class Request < ::Rack::Request
+  def params
+    rack_input = env["rack.input"].read
+    @params ||= Rack::Utils.parse_query(rack_input, "&")
+  end
+  def facebook?
+    params["signed_request"].present?
+  end
+end

data/lib/eukaliptus/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module Eukaliptus
+  VERSION = "0.7.1"
+end

data/lib/eukaliptus/view_helpers/facebook_helpers.rb ADDED Viewed

@@ -0,0 +1,173 @@
+module Eukaliptus
+  module FacebookHelpers
+    # Renders the HTML + JS that enables the app to log in to Facebook using
+    # the Javascript method.
+    #
+    # Accepts the permissions that your application needs to work.
+    #
+    # Use it one time in your layout header or use it in several app places
+    # to ask the user for different permissions depending on the context, page, etc.
+    def fb_login(perms = %w{email publish_stream})
+      js = <<-DATA
+<div id="fb-root"></div>
+<script type="text/javascript">
+    window.fbAsyncInit = function() {
+      FB.init({
+          appId: '#{Facebook::APP_ID.to_s}',
+          status: true,
+          cookie: true,
+          xfbml: true
+      });
+      FB.Canvas.setAutoResize(100);
+    };
+    (function() {
+      var e = document.createElement('script'); e.async = true;
+      e.src = document.location.protocol +
+      '//connect.facebook.net/es_ES/all.js';
+      document.getElementById('fb-root').appendChild(e);
+    }());
+    var login = function(targetUrl, perms) {
+      if (perms == null) {
+        perms = "#{perms.join(',')}"
+      }
+      FB.login(function(response) {
+        if (response.session) {
+            fixSession(JSON.stringify(response.session), targetUrl);
+        } else {
+            //pending to do when not logged in
+        }
+      }, {perms: perms});
+    }
+  function fixSession(fbSession, targetUrl) {
+    $("body").prepend('<form id="fixSession"></form>');
+    var f = $('form')[0];
+    f.method = 'POST';
+    f.action = "/cookie_fix";
+        var m = document.createElement('input');
+        m.setAttribute('type', 'hidden');
+        m.setAttribute('name', '_session_id');
+        m.setAttribute('value', fbSession);
+        f.appendChild(m);
+        m = document.createElement('input');
+        m.setAttribute('type', 'hidden');
+        m.setAttribute('name', 'redirect_to');
+        m.setAttribute('value', targetUrl);
+        f.appendChild(m);
+    f.submit();
+  }
+</script>
+      DATA
+      js.html_safe
+    end
+    # Function to create a new FB.ui dialog link
+    def fb_ui(name, options ={})
+      callback = options.delete(:callback)
+      callback.gsub!('"', "'")
+      data = "FB.ui(#{options.to_json.gsub('"', "'")}, #{callback});"
+      link_to(name, '#', :onclick => data.html_safe)
+    end
+    # Create a new wall post
+    # You can use it directly in your templates or call it from inside your helpers:
+    #
+    # module MyHelper
+    #   def post_something_to_wall(something)
+    #     fb_post_to_wall('Publish this great thing to wall!', :name => Something.name)
+    #   end
+    # end
+    #
+    # The options are the same than in Facebook feed post passed as Hash
+    # see: http://developers.facebook.com/docs/reference/javascript/FB.ui/
+    #
+    # :callback
+    # JS callback function to do somethink with the data
+    def fb_post_to_wall(name = 'Post to wall', options = {})
+      options = {
+        :method => 'feed',
+        :callback => 'function(response) {}'
+      }.merge(options)
+      fb_ui name, options
+    end
+    # Options
+    #
+    # :id
+    # Required. The ID or username of the target user to add as a friend.
+    #
+    # :callback
+    # JS callback function to do somethink with the data
+    def fb_add_friend(name = 'Add as a friend', options = {})
+      options = {
+        :method => 'friends',
+        :callback => 'function(response) {}'
+      }.merge(options)
+      fb_ui name, options
+    end
+    # Options
+    #
+    # :message
+    # The request the receiving user will see. It appears as a question posed by the sending user.
+    # The maximum length is 255 characters.
+    #
+    # :to
+    # A user ID or username. Must be a friend of the sender.
+    # If this is specified, the user will not have a choice of recipients.
+    # If this is omitted, the user will see a friend selector and will be able to select a maximum of 50 recipients.
+    #
+    # :data
+    # Optional, additional data you may pass for tracking. This will be stored as part of the request objects created.
+    #
+    # :title
+    # Optional, the title for the friend selector dialog. Maximum length is 50 characters.
+    #
+    # :callback
+    # JS callback function to do somethink with the data
+    def fb_app_request(name = 'Invite to use this application', options = {})
+      options = {
+        :method => 'apprequests',
+        :message => 'Invite your friends to use your app!',
+        :callback => 'function(response) {}'
+      }.merge(options)
+      fb_ui name, options
+    end
+    # Options
+    #
+    # :credits_purchase
+    # Whether it is a Credits purchase dialog or not
+    #
+    # :order_info
+    # The internal key of the item you are selling.
+    # IT's required in case credits_purchase is false and should only be meaningful to you.
+    #
+    # :dev_purchase_params
+    # More developer parameters. For details, read http://developers.facebook.com/docs/creditsapi/
+    #
+    # :callback
+    # JS callback function to do somethink with the data
+    def fb_pay(name = 'Buy credits', options = {})
+      options = {
+        :method => 'pay',
+        :callback => 'function(response) {}'
+      }.merge(options)
+      fb_ui name, options
+    end
+  end
+end

data/lib/generators/eukaliptus/config_generator.rb ADDED Viewed

@@ -0,0 +1,18 @@
+module Eukaliptus
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+      desc <<-MSG
+Description:
+  Creates configuration files and stores them in `config`.
+      MSG
+      def generate_config
+        template "facebook.yml", "config/facebook.yml"
+      end
+    end
+  end
+end

data/lib/generators/templates/facebook.yml ADDED Viewed

@@ -0,0 +1,16 @@
+development: &FACEBOOK_BASE
+  api_key:
+  secret_key:
+  app_id:
+  host: http://localhost:3000
+  canvas: http://apps.facebook.com/
+test:
+  <<: *FACEBOOK_BASE
+production:
+  api_key:
+  secret_key:
+  app_id:
+  host:
+  canvas: http://apps.facebook.com/

data/lib/tasks/facebook.rake ADDED Viewed

@@ -0,0 +1,19 @@
+namespace :facebook do
+  desc "List fake users"
+  task :list_fake_users => :environment do
+    puts connect_to_facebook.list
+  end
+  desc "Create fake user"
+  task :create_fake_user => :environment do
+    connect_to_facebook.create(true, 'publish_stream')
+  end
+end
+def connect_to_facebook
+  oauth = Koala::Facebook::OAuth.new
+  options = { :app_access_token => oauth.get_app_access_token, :app_id => Facebook::APP_ID}
+  Koala::Facebook::TestUsers.new(options)
+end

data/test/test_eukaliptus.rb ADDED Viewed

@@ -0,0 +1,7 @@
+require 'test_helper'
+class TestEukaliptus < MiniTest::Unit::TestCase
+  def test_eukaliptus_headers
+    skip "Test P3p header"
+  end
+end

data/test/test_helper.rb ADDED Viewed

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'minitest/unit'
+require 'minitest/spec'
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'eukaliptus'
+class MiniTest::Unit::TestCase
+end
+MiniTest::Unit.autorun

data/test/view_helpers/facebook_helpers_test.rb ADDED Viewed

@@ -0,0 +1,10 @@
+require 'test_helper'
+describe "Eukaliptus::FacebookHelpersTest" do
+  describe "when asked about a helper" do
+    it "must respond positively" do
+      assert true
+    end
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: eukaliptus
+version: !ruby/object:Gem::Version
+  prerelease:
+  version: 0.7.1
+platform: ruby
+authors:
+- season
+- victorcoder
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2011-06-11 00:00:00 +02:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: koala
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id001
+description: Eukaliptus is a set of helpers and bug fixes for browsers to help you build Facebook iframe applications or user fan tabs.
+email:
+- victorcoder@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- eukaliptus.gemspec
+- lib/eukaliptus.rb
+- lib/eukaliptus/koala.rb
+- lib/eukaliptus/middleware.rb
+- lib/eukaliptus/railtie.rb
+- lib/eukaliptus/request.rb
+- lib/eukaliptus/version.rb
+- lib/eukaliptus/view_helpers/facebook_helpers.rb
+- lib/generators/eukaliptus/config_generator.rb
+- lib/generators/templates/facebook.yml
+- lib/tasks/facebook.rake
+- test/test_eukaliptus.rb
+- test/test_helper.rb
+- test/view_helpers/facebook_helpers_test.rb
+has_rdoc: true
+homepage: http://github.com/seasonlabs/eukaliptus
+licenses:
+- MIT
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+requirements: []
+rubyforge_project: eukaliptus
+rubygems_version: 1.6.1
+signing_key:
+specification_version: 3
+summary: Eukaliptus Facebook API Helpers
+test_files:
+- test/test_eukaliptus.rb
+- test/test_helper.rb
+- test/view_helpers/facebook_helpers_test.rb