doesfacebook 0.3.3

data/LICENSE

@@ -0,0 +1,20 @@
+
+Copyright (C) 2011 by Awexome Labs, LLC
+
+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

@@ -0,0 +1,85 @@
+= DoesFacebook
+
+The Awexome Labs rails plugin for handling Facebook application credentials and authentication. 
+Also provides helpers and convenience methods for canvas applications.
+
+You may also be interested in accessing content on the Facebook Open Graph. For that, consider
+this gem's brother from the same mother, DoesOpenGraph
+
+
+== Installation
+
+To install the gem, do the usual:
+
+  gem install doesfacebook
+  
+If you plan on using DoesFacebook in a project with a Gemfile:
+
+  gem "doesfacebook", ">=0.3.2"
+  
+You can live on the edge, too, if you like:
+
+  gem "doesfacebook", ">=0.3.2", :git=>"git://github.com/awexome/doesfacebook.git"
+
+
+== Configuration
+
+You configure DoesFacebook in much the same way you'll configure other Facebook integration
+helper plugins. Add a "doesfacebook.yml" file to you config/ directory with the a config for
+each environment in the following format:
+
+  development:
+    app_id: 1234567890
+    api_key: 1234567890abcdefghijklmnopqrsttuv
+    secret_key: 1234567890abcdefghijklmnopqrsttuv
+    canvas_name: your_canvas_name
+    callback_url: http://your.dev.server.com/and/path
+
+These parameters relate to settings in the Facebook Developers application configuration panel,
+and should be easy to copy and paste in as you need for each application.
+
+
+== Usage
+
+To parse requests, add the following declaration to your controller:
+
+  does_facebook
+
+Now, with each incoming request, DoesFacebook will parse the signed_request_parameter against your
+application's keys, as described at http://developers.facebook.com/docs/authentication/signed_request
+
+This allows your application to verify requests from Facebook, properly handle Facebook POSTs via
+canvas and within page tabs.
+
+You also get helpers for your views that will make many aspects of developing on the Facebook platform
+easier:
+
+  app_id
+  => The current application's id, parsed from doesfacebook.yml
+
+  app_callback_url
+  => The current application's callback URL, parsed from doesfacebook.yml
+
+  app_canvas_name
+  => The current application's canvas shortname, parsed from doesfacebook.yml
+
+  app_canvas_url
+  => The full URL to the application canvas (e.g., http://apps.facebook.com/your_canvas_name)
+
+  url_for_canvas(url_opts={})
+  => Like the standard url_for, but ensures the endpoint is in the Facebook canvas
+
+  link_to_canvas(text, url_opts={}, html_opts={})
+  => Use as you would the regular link_to helper; generates links to the canvas and properly
+     targets the link to "_top"
+
+Other helpers and useful shortcuts being added regularly.
+
+
+
+
+
+== Copyright
+
+Copyright 2011 Awexome Labs, LLC http://awexomelabs.com
+

data/app/helpers/does_facebook_helper.rb

@@ -0,0 +1,47 @@
+# AWEXOME LABS
+# DoesFacebook
+#
+# DoesFacebookHelper - add helpers to 
+
+module DoesFacebookHelper
+  
+  # Return the current application id to the view
+  def app_id
+    controller.send(:facebook_config)[:app_id]
+  end
+  
+  # Return the current app callback URL
+  def app_callback_url
+    controller.send(:facebook_config)[:callback_url]
+  end
+  
+  # Return the current app canvas name:
+  def app_canvas_name
+    controller.send(:facebook_config)[:canvas_name]
+  end
+  
+  # Return the full canvas URL:
+  def app_canvas_url
+    "http://apps.facebook.com/#{controller.send(:facebook_config)[:canvas_name]}"
+  end
+  
+  # Generate a URL that points within the Facebook canvas
+  def url_for_canvas(url_opts={})
+    canvas_name = controller.send(:facebook_config)["canvas_name"]
+    canvas_root = File.join("http://apps.facebook.com", canvas_name)
+    if url_opts.is_a?(Hash)
+      return File.join(canvas_root, url_for(url_opts))
+    elsif url_opts.include?("://")
+      return url_opts
+    else
+      return File.join(canvas_root, url_opts)
+    end
+  end
+
+  # Generate a link that stays within the Facebook canvas
+  def link_to_canvas(text, url_opts={}, html_opts={})
+    url = url_for_canvas(url_opts)
+    content_tag("a", text, html_opts.merge(:rel=>"canvas", :href=>url, :target=>"_top"), false)
+  end
+  
+end

data/config/doesfacebook.yml.example

@@ -0,0 +1,25 @@
+# AWEXOME LABS
+# Beyond12
+#
+# Example Facebook Configuration File
+
+development:
+  app_id: 1234567890
+  api_key: 1234567890abcdefghijklmnopqrsttuv
+  secret_key: 1234567890abcdefghijklmnopqrsttuv
+  canvas_name: your_canvas_name
+  callback_url: http://your.dev.server.com/and/path
+  
+staging:
+  app_id: 1234567890
+  api_key: 1234567890abcdefghijklmnopqrsttuv
+  secret_key: 1234567890abcdefghijklmnopqrsttuv
+  canvas_name: your_canvas_name
+  callback_url: http://your.dev.server.com/and/path
+  
+production:
+  app_id: 1234567890
+  api_key: 1234567890abcdefghijklmnopqrsttuv
+  secret_key: 1234567890abcdefghijklmnopqrsttuv
+  canvas_name: your_canvas_name
+  callback_url: http://your.dev.server.com/and/path

data/lib/doesfacebook.rb

@@ -0,0 +1,49 @@
+# AWEXOME LABS
+# DoesFacebook
+
+require 'doesfacebook'
+require 'rails'
+require 'action_controller'
+
+require 'doesfacebook/config'
+require 'doesfacebook/filters'
+require 'doesfacebook/controls'
+require 'doesfacebook/session'
+
+module DoesFacebook
+
+  # Create a Rails Engine
+  class Engine < Rails::Engine
+    # engine_name :doesfacebook
+  end
+  
+  # Return the current working version of DoFacebook from VERSION file:
+  def self.version
+    @@version ||= File.open(File.join(File.dirname(__FILE__), "..", "VERSION"), "r").read
+  end
+  
+end # DoesFacebook
+
+
+module ActionController
+  class Base
+    
+    # Call this method within your controller to parse configuration and enabled
+    # session validation and parsing
+    def self.does_facebook
+      self.instance_eval do 
+        include DoesFacebook::Config
+        include DoesFacebook::Controls
+        include DoesFacebook::Filters
+        prepend_before_filter :parse_signed_request
+        prepend_before_filter :validate_signed_request
+        helper :does_facebook
+      
+        protected
+        attr_reader :fbparams
+      end
+    end
+    
+  end
+end # ActionController
+

data/lib/doesfacebook/config.rb

@@ -0,0 +1,24 @@
+# AWEXOME LABS
+# DoesFacebook Config
+
+module DoesFacebook
+  module Config
+    
+    protected
+    
+    # Access the Facebook-specific configuration for the given environment:
+    def facebook_config
+      @@facebook_config ||= HashWithIndifferentAccess.new(all_facebook_config[Rails.env])
+    end
+    
+    # Load configuration from YAML file for all environments:
+    def all_facebook_config
+      config_file = File.join(Rails.root, "config", "doesfacebook.yml")
+      if File.exist?(config_file)
+        return @@all_facebook_config ||= YAML.load(File.open( config_file ))
+      end
+    end
+        
+  end
+end # DoesFacebook
+

data/lib/doesfacebook/controls.rb

@@ -0,0 +1,24 @@
+# AWEXOME LABS
+# DoesFacebook
+#
+# Controls - convenience methods for injection into controllers
+
+module DoesFacebook
+  module Controls
+    
+    # Exception Classes:
+    class MalformedUrlOptions < Exception; end
+    
+    
+    protected
+    
+    # Mechanism for redirecting within the Facebook canvas:
+    def redirect_to_canvas(opts={})
+      raise MalformedUrlOptions.new("Options passed to `redirect_to_canvas` must be a URL options Hash") unless opts.is_a?(Hash)
+      dest = File.join("http://apps.facebook.com/", facebook_config[:canvas_name], url_for(opts.merge(:only_path=>true))) 
+      logger.info "Canvas Redirect to #{opts.inspect}=>#{dest}"
+      redirect_to dest
+    end
+    
+  end # Controls
+end # DoesFacebook

data/lib/doesfacebook/filters.rb

@@ -0,0 +1,56 @@
+# AWEXOME LABS
+# DoesFacebook
+#
+# Filters - before and after filters for controller that process Facebook behavior
+
+module DoesFacebook
+  module Filters
+    
+    protected
+    
+    # Ensures, using configuration options, that the request was signed by Facebook
+    def validate_signed_request
+      if request_parameter = request.params["signed_request"]
+        if app_secret = facebook_config["secret_key"]
+          encoded_signature, encoded_data = request_parameter.split(".")
+          decoded_signature = base64_url_decode(encoded_signature)
+          digested = OpenSSL::HMAC.digest("sha256", app_secret, encoded_data)
+          valid = (digested == decoded_signature)
+          if valid
+            logger.info "DoFacebook: Signed Request Valid."
+          else
+            logger.info "DoFacebook: Invalid Signed Request. Ensure request from Facebook."
+            raise "DoFacebook: Invalid Signed Request. Ensure request from Facebook."
+          end
+        end
+      end
+    end
+
+    
+    # If present, parses data from the signed request and inserts it into the fbparams
+    # object for use during requests
+    def parse_signed_request
+      if request_parameter = request.params["signed_request"]
+        encoded_signature, encoded_data = request_parameter.split(".")
+        decoded_signature = base64_url_decode(encoded_signature)
+        decoded_data = base64_url_decode(encoded_data)
+        @fbparams = HashWithIndifferentAccess.new(JSON.parse(decoded_data).merge({
+          "signature"=>encoded_signature,
+          "data"=>encoded_data 
+        }))
+        logger.info "  Facebook Parameters: #{fbparams.inspect}"
+      end
+    end
+      
+      
+    
+    private
+    
+    # Base64 URL Decode method
+    # see http://developers.facebook.com/docs/authentication/canvas 
+    def base64_url_decode(str)
+      "#{str}==".tr("-_", "+/").unpack("m")[0]
+    end
+    
+  end
+end # DoesFacebook

data/lib/doesfacebook/session.rb

@@ -0,0 +1,9 @@
+# AWEXOME LABS
+# DoesFacebook
+#
+# Session - app and user session container
+
+module DoesFacebook
+  class Session
+  end  
+end # DoesFacebook

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: doesfacebook
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.3.3
+platform: ruby
+authors: 
+- mccolin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-12 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.1
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+description: Paper-thin Facebook validation and signed request parsing Rails plugin
+email: info@awexomelabs.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- app/helpers/does_facebook_helper.rb
+- config/doesfacebook.yml.example
+- lib/doesfacebook.rb
+- lib/doesfacebook/config.rb
+- lib/doesfacebook/controls.rb
+- lib/doesfacebook/filters.rb
+- lib/doesfacebook/session.rb
+- LICENSE
+- README.rdoc
+has_rdoc: true
+homepage: http://awexomelabs.com/
+licenses: []
+
+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: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Paper-thin Facebook validation and signed request parsing Rails plugin
+test_files: []
+