doesfacebook 0.6.0 → 1.0.0.pre1

data/lib/doesfacebook/application.rb

@@ -0,0 +1,46 @@
+# AWEXOME LABS
+# DoesFacebook 
+#
+# Application -- representation of a single Facebook Application, defined on the
+#  developers portal at developers.facebook.com.
+#
+# Fields used in configuration match Facebook's API keys for the corresponding
+# setting whenever possible. For reference, review the Graph API doc for Application:
+# https://developers.facebook.com/docs/reference/api/application/
+#
+
+module DoesFacebook
+
+  class Application
+
+    # Define settable configuration keys for each application:
+    attr_accessor :id, :secret, :namespace, :canvas_url, :secure_canvas_url
+
+    # Prepare with a predefined configuration:
+    def initialize(opts={})
+      update_options(opts)
+    end
+
+    # Bulk set configuration options for this application
+    def update_options(opts={})
+      opts.each do |key, val|
+        self.send("#{key}=", val)
+      end
+    end
+
+    # Error in the case of an unknown key being configured:
+    def method_missing(meth, *args, &block)
+      if meth.to_s =~ /\=$/
+        key_name = meth.to_s.gsub(/\=$/,"")
+        raise DoesFacebook::ConfigurationError.new("Unknown configuration key `#{key_name}` cannot be set for Facebook applications.")
+      end
+      super
+    end
+
+    # Return true if this application supports SSL/HTTPS:
+    def supports_ssl?
+      !secure_canvas_url.nil?
+    end
+
+  end # Application
+end # DoesFacebook

data/lib/doesfacebook/configuration.rb

@@ -0,0 +1,58 @@
+# AWEXOME LABS
+# DoesFacebook : Configuration
+
+module DoesFacebook
+
+  class Configuration
+
+    # Configurable options:
+    attr_accessor :applications, :app_selector
+
+    # Declare defaults on load:
+    def initialize
+      @applications = Array.new
+      @app_selector = Proc.new() do |request, apps|
+        apps.find do |a|
+          callback_path = request.ssl? && a.supports_ssl? ? a.secure_canvas_url : a.canvas_url
+          request.url.match(/^#{callback_path}.*/)
+        end
+      end
+    end
+
+    # If an unknown settings is configured, notify the user:
+    def method_missing(meth, *args, &block)
+      if meth.to_s =~ /\=$/
+        key_name = meth.to_s.gsub(/\=$/,"")
+        raise DoesFacebook::ConfigurationError.new("Unknown configuration `#{key_name}` cannot be set for DoesFacebook.")
+      end
+      super
+    end
+
+    # Add an application definition:
+    def add_application(app)
+      app = DoesFacebook::Application.new(app) if app.is_a?(Hash)
+      @applications << app
+    end
+
+    # Determine the current app given an incoming request:
+    def current_application(request)
+      app_selector.call(request, applications)
+    end
+
+  end # Configuration
+
+
+  # Provide an accessor to the gem configuration:
+  class << self
+    attr_accessor :configuration
+  end
+
+  # Yield the configuration to host:
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  DoesFacebook.configuration = Configuration.new
+
+end # DoesFacebook

data/lib/doesfacebook/controller_extensions.rb

@@ -0,0 +1,98 @@
+# AWEXOME LABS
+# DoesFacebook
+#
+# ControllerExtensions - convenience methods and filters injected into controllers
+#  which enact DoesFacebook
+#
+
+module DoesFacebook
+  module ControllerExtensions
+    
+    protected
+
+    def fb_app
+      @fb_app ||= DoesFacebook.configuration.current_application(request)
+    end
+
+    def url_for_canvas(opts={})
+      canvas_root = if request.ssl? && fb_app.supports_ssl?
+        "https://apps.facebook.com/#{fb_app.namespace}/"
+      else
+        "http://apps.facebook.com/#{fb_app.namespace}/"
+      end
+      case opts
+        when String
+          opts =~ /:\/\// ? opts : File.join(canvas_root, opts)
+        when Hash
+          opts.merge(:only_path=>true)
+          File.join(canvas_root, url_for(opts))
+      end
+    end
+
+    def redirect_to_canvas(opts={})
+      @facebook_redirect_url = url_for_canvas(opts)
+      Rails.logger.info "Canvas Redirect to #{@facebook_redirect_url}"
+      begin
+        render :partial=>"facebook/redirect"
+      rescue ActionView::MissingTemplate => e
+        logger.info "Pretty Redirect Partial facebook/redirect Not Found. Using Unformatted Text."
+        render :text=>%{
+          Redirecting you to <a href="#{@facebook_redirect_url}">#{@facebook_redirect_url}</a>...
+          <script type="text/javascript"> top.location.href = "#{@facebook_redirect_url}"; </script>
+        }.html_safe
+      end
+    end
+
+
+
+    private
+
+    # Captures a signed_request parameter and manipulates the session to allow for
+    # a signed_request to be passed from iframe request to iframe request
+    # def sessionify_signed_request
+    #   if request_parameter = request.params["signed_request"]
+    #     session[:signed_request] = request_parameter
+    #     logger.info "  Facebook Signed Request received. Stored/updated in session."
+    #   else
+    #     params["signed_request"] = session[:signed_request]
+    #     logger.info "  No Facebook Signed Request received. Loaded, if present, from session."
+    #   end
+    # end
+    
+    # Ensures, using configuration options, that the request was signed by Facebook
+    def validate_signed_request
+      if request_parameter = request.params["signed_request"]
+        encoded_signature, encoded_data = request_parameter.split(".")
+        decoded_signature = base64_url_decode(encoded_signature)
+        digested = OpenSSL::HMAC.digest("sha256", fb_app.secret, encoded_data)
+        if valid = (digested == decoded_signature)
+          Rails.logger.info "  Facebook Signed Request Valid."
+        else
+          Rails.logger.info "  Facebook Signed Request is not Valid. Ensure request is from Facebook and correct Facebook app has been selected."
+          raise DoesFacebook::RequestSignatureInvalidError.new()
+        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
+      Rails.logger.info "  Facebook application \"#{fb_app.namespace}\" configuration in use for this 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))
+        Rails.logger.info "  Facebook Parameters: #{fbparams.inspect}"
+      end
+    end
+    
+    
+    # Base64 URL Decode method
+    # see http://developers.facebook.com/docs/authentication/canvas 
+    def base64_url_decode(str)
+      "#{str}==".tr("-_", "+/").unpack("m")[0]
+    end
+    
+  end # ControllerExtensions
+end # DoesFacebook

data/lib/doesfacebook/error.rb

@@ -0,0 +1,37 @@
+# AWEXOME LABS
+# DoesFacebook 
+#
+# Error -- represent individual configuration and runtime errors specific to
+#  the Facebook application or DoesFacebook
+#
+
+module DoesFacebook
+  
+  class Error < StandardError
+    def initialize(message="DoesFacebook Runtime Error")
+      super
+    end
+  end # Error
+
+  
+  class ConfigurationError < Error
+    def initialize(message="DoesFacebook Configuration Error")
+      super
+    end
+  end # ConfigurationError
+
+
+  class MiddlewareError < Error
+    def initialize(message="DoesFacebook Runtime Error")
+      super
+    end
+  end # MiddlewareError
+
+  class RequestSignatureInvalidError < Error
+    def initialize(message="Signed Request from Facebook is not valid.")
+      super
+    end
+  end # MiddlewareError
+
+
+end # DoesFacebook

data/lib/doesfacebook.rb

@@ -1,79 +1,60 @@
 # AWEXOME LABS
 # DoesFacebook
 
-require 'doesfacebook'
-require 'rails'
-require 'action_controller'
-
-require 'doesfacebook/config'
-require 'doesfacebook/filters'
-require 'doesfacebook/controls'
-require 'doesfacebook/session'
-require 'doesfacebook/middleware'
-
-require 'generators/doesfacebook/config/config_generator'
+require "doesfacebook"
+require "rails"
+require "action_controller"
+
+require "doesfacebook/configuration"
+require "doesfacebook/error"
+require "doesfacebook/application"
+require "doesfacebook/controller_extensions"
+require "helpers/does_facebook_helper"
+# require "doesfacebook/session"
+require "doesfacebook/middleware"
+require "generators/doesfacebook/config/config_generator"
 
 module DoesFacebook
 
-  # Create a Rails Engine
+  # Add configuration and features to Rails as an Engine:
   class Engine < Rails::Engine
-    # engine_name :doesfacebook
-  end
-  
-  # Create a Railtie for Rack, config injection
-  class Railtie < Rails::Railtie
     initializer "doesfacebook.init" do |app|
       app.middleware.use DoesFacebook::Middleware
     end
+
+    initializer "doesfacebook.static_assets" do |app|
+      app.middleware.use ::ActionDispatch::Static, "#{root}/public"
+    end
+
+    paths["app/helpers"] << "lib/helpers"
   end
-  
-  # Return the current working version of DoesFacebook from VERSION file:
+
+  # Return the current version of the gem:
   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
+
+    # Call this method within your controller to enable Facebook actions:
     def self.does_facebook(opts={})
-      self.instance_eval do 
-        include DoesFacebook::Config
-        include DoesFacebook::Controls
-        include DoesFacebook::Filters
-        prepend_before_filter :parse_signed_request, :validate_signed_request
-        prepend_before_filter :sessionify_signed_request unless opts[:session]==false
+      self.instance_eval do
+        include DoesFacebook::ControllerExtensions
         helper :does_facebook
-      
-        protected
-        attr_reader :fbparams
-      end
-    end
-    
-  end
-end # ActionController
+        prepend_before_filter :validate_signed_request, opts
+        prepend_before_filter :parse_signed_request, opts
+        #prepend_before_filter :sessionify_signed_request unless opts[:session]==false
 
-
-module ActionMailer
-  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
-        helper :does_facebook
-      
         protected
         attr_reader :fbparams
       end
     end
-    
+
   end
-end # ActionMailer
+end # ActionController
 
 

data/lib/generators/doesfacebook/config/config_generator.rb

@@ -8,14 +8,14 @@ module DoesFacebook
   module Generators
     class ConfigGenerator < ::Rails::Generators::Base
       
-      desc "Creates a boilerplate DoesFacebook configuration file at config/doesfacebook.yml"
+      desc "Creates a boilerplate DoesFacebook config/initializer at config/initializers/doesfacebook.rb"
       
       source_root File.expand_path("../templates", __FILE__)
       
       def create_config_file
-        template "doesfacebook.yml", File.join("config","doesfacebook.yml")
+        template "doesfacebook.rb", File.join("config/initializers","doesfacebook.rb")
       end
 
     end
   end #Generators
-end #DoesFacebook
+end #DoesFacebook

data/lib/generators/doesfacebook/config/templates/doesfacebook.rb

@@ -0,0 +1,33 @@
+# AWEXOME LABS
+# DoesFacebook Configuration File
+#
+# Use this initializer to declare logical Facebook applications your
+# Rails app will harness. 
+#
+# You can specify any number of applications statically, from a dynamic
+# source such as your database, or from elsewhere.
+#
+
+DoesFacebook.configure do |config|
+
+  # Add each Facebook Application (defined in your Developer Dashboard
+  # at developers.facebook.com) here, like so:
+  config.add_application(
+    id: 123456789012345,
+    secret: "abcdefghijklmnopqrstuvwxyzABCDEF"
+    namespace: "your_app_namespace",
+    canvas_url: "http://your.dev.server.com/and/path",
+    secure_canvas_url: "https://secure.dev.server"
+  )
+
+  # You may specify the method by which DoesFacebook selects the app
+  # configuration for each request with a lambda or Proc. This example 
+  # uses canvas_url, but you can make this distinction however you wish:
+  # config.app_selector = Proc.new() do |request, apps|
+  #   apps.find do |a|
+  #     callback_path = request.ssl? && a.supports_ssl? ? a.secure_canvas_url : a.canvas_url
+  #     request.url.match(/^#{callback_path}.*/)
+  #   end
+  # end
+
+end

data/lib/helpers/does_facebook_helper.rb

@@ -0,0 +1,70 @@
+# AWEXOME LABS
+# DoesFacebook
+#
+# DoesFacebookHelper - add helpers to 
+
+module DoesFacebookHelper
+  
+  # Return a reference to the current Facebook Application config:
+  def fb_app
+    @fb_app
+  end
+
+  # Return the current application id to the view
+  def app_id
+    fb_app.id
+  end
+  
+  # Return the current app namespace:
+  def app_namespace
+    fb_app.namespace
+  end
+  
+  # Return the full canvas URL:
+  def app_canvas_url
+    "#{request.ssl? ? "https://" : "http://"}apps.facebook.com/#{app_namespace}"
+  end
+  
+  # Generate a URL that points within the Facebook canvas
+  def url_for_canvas(url_opts={})
+    controller.send(:url_for_canvas, url_opts)
+  end
+
+  # Generate a link that points within the Facebook canvas
+  def link_to_canvas(text, url_opts={}, html_opts={})
+    content_tag("a", text, html_opts.merge(:rev=>"canvas", :href=>url_for_canvas(url_opts), :target=>"_top"), false)
+  end
+
+  # Display a user's Facebook profile photo
+  def profile_pic(facebook_id, opts={})
+    type = opts.delete(:type) || "square" # <= Valid types: square, small, normal, large
+    opts = {:class=>"profile-pic", :border=>0}.merge(opts)
+    image_tag("//graph.facebook.com/#{facebook_id}/picture?type=#{type}", opts)
+  end
+  
+
+  # Insert properly-formed FB.init() call with fb-root doc element. Yields a block which
+  # can be used to inject further FB initialization JavaScript within fbAsyncInit
+  def fb_init(init_opts={}, &block)
+    init_opts = {appId: app_id, channelUrl: "/channel.html", status: true, cookie: true, xfbml: false}.merge(init_opts)
+    injection = """<!-- Facebook JS SDK -->
+    <div id=\"fb-root\"></div>
+    <script>
+      window.fbAsyncInit = function() {
+        FB.init(#{init_opts.to_json});"""
+    injection += capture(&block) if block_given?
+    injection += """
+      };
+      (function(d){
+         var js, id = 'facebook-jssdk', ref = d.getElementsByTagName('script')[0];
+         if (d.getElementById(id)) {return;}
+         js = d.createElement('script'); js.id = id; js.async = true;
+         js.src = \"//connect.facebook.net/en_US/all.js\";
+         ref.parentNode.insertBefore(js, ref);
+       }(document));
+    </script>"""
+    return injection.html_safe
+  end
+  
+  
+end

data/public/channel.html

@@ -0,0 +1,2 @@
+<script src="//connect.facebook.net/en_US/all.js"></script>
+<!-- DoesFacebook: Facebook Channel File: https://developers.facebook.com/docs/reference/javascript/ -->

metadata

@@ -1,59 +1,128 @@
 --- !ruby/object:Gem::Specification
 name: doesfacebook
 version: !ruby/object:Gem::Version
-  version: 0.6.0
-  prerelease: 
+  version: 1.0.0.pre1
+  prerelease: 6
 platform: ruby
 authors:
-- mccolin
+- Awexome Labs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-11 00:00:00.000000000Z
+date: 2013-05-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2154459220 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.1'
   type: :development
   prerelease: false
-  version_requirements: *2154459220
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2154458600 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.1
+        version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *2154458600
-description: Paper-thin Facebook validation and signed request parsing Rails plugin
-email: info@awexomelabs.com
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+description: Lightweight gem enables your Rails application to quickly and simply
+  integrate with Facebook
+email: engineering@awexomelabs.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE
 - README.rdoc
 files:
-- app/helpers/does_facebook_helper.rb
+- CHANGELOG.rdoc
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- ROADMAP.rdoc
+- Rakefile
+- VERSION
+- doesfacebook.gemspec
 - lib/doesfacebook.rb
-- lib/doesfacebook/config.rb
-- lib/doesfacebook/controls.rb
-- lib/doesfacebook/filters.rb
+- lib/doesfacebook/application.rb
+- lib/doesfacebook/configuration.rb
+- lib/doesfacebook/controller_extensions.rb
+- lib/doesfacebook/error.rb
 - lib/doesfacebook/middleware.rb
 - lib/doesfacebook/session.rb
 - lib/generators/doesfacebook/config/config_generator.rb
-- lib/generators/doesfacebook/config/templates/doesfacebook.yml
-- LICENSE
-- README.rdoc
-homepage: http://awexomelabs.com/
-licenses: []
+- lib/generators/doesfacebook/config/templates/doesfacebook.rb
+- lib/helpers/does_facebook_helper.rb
+- public/channel.html
+homepage: http://github.com/awexome/doesfacebook
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -64,16 +133,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2444230836581017084
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Paper-thin Facebook validation and signed request parsing Rails plugin
+summary: Lightweight gem enables your Rails application to quickly and simply integrate
+  with Facebook
 test_files: []