facebook_dialog 0.0.4 → 0.0.5

data/Readme.md

@@ -23,7 +23,7 @@ This is available for Rails >= 3.0 and Ruby >= 1.9.2
 
   #at the bottom of your page
 
-  <%= facebook_js %>
+  <%= fb_js %>
   <%= javascript_tag do %>
     <%= fb_init_js %>
     $("#share_on_facebook").click(function(e){
@@ -32,3 +32,36 @@ This is available for Rails >= 3.0 and Ruby >= 1.9.2
   <%- end -%>
 ```
 
+Use with OmniAuth
+==
+
+We've created a convenience mechanism for you to use FacebookDialog with [omniauth-facebook](https://github.com/mkdynamic/omniauth-facebook).
+
+```ruby
+  <%= link_to "Sign In w/ Facebook", FacebookDialog::OmniAuth.dialog.url %>
+```
+
+*NOTE*: omniauth-facebook must be loaded prior to facebook_dialog for this to work.
+
+*NOTE*: You must set OmniAuth.config.full_host or a redirect_uri in each invocation for this to work properly. In order to obtain the data we need without coupling to request context, we do some neat/hacky things with Rack.
+
+In an initializer like config/initializers/omniauth.rb:
+
+```ruby
+  OmniAuth.full_host = "http://example.com"
+```
+
+Alternatively, we provide you 
+
+```ruby
+    <%= link_to "Sign In With Facebook", FacebookDialog::OmniAuth.dialog({
+      display: "popup",
+      redirect_uri: fb_callback_url
+    }).url%>
+```
+
+fb_callback_url is a convenience method provided by facebook_dialog
+
+Without one of these approaches, your OAuth dialog will not work!
+
+Per Facebook's documentation "The OAuth Dialog should not be called directly from the JavaScript SDK. Rather, use FB.login for this purpose." Thus, this helper should only be used for server side implementations to start.

data/facebook_dialog.gemspec

@@ -24,5 +24,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "rspec"
   gem.add_development_dependency "guard-rspec"
   gem.add_development_dependency "mocha"
+  gem.add_development_dependency "omniauth-facebook"
 end
 

data/lib/facebook_dialog/oauth.rb

@@ -6,6 +6,10 @@ module FacebookDialog
       super
       @options[:client_id] = @options.delete(:app_id)
     end   
+
+    def scope
+      @options[:scope]
+    end
   end
 end
 

data/lib/facebook_dialog/omni_auth.rb

@@ -0,0 +1,33 @@
+module FacebookDialog
+  module OmniAuth
+    def self.dialog(additional_options = {})
+      options = authorize_params.merge(additional_options) 
+      options[:redirect_uri] ||= hacked_app.callback_url
+      FacebookDialog::Oauth.new(options.merge(authorize_params))
+    end 
+
+    protected
+    def self.authorize_params
+      hacked_app.authorize_params.merge(hacked_app.client.auth_code.authorize_params)
+    end
+
+    def self.hacked_app
+      @hacked_app ||= OmniAuthHack.new(MockRack.new)
+    end
+
+    class MockRack
+      def call(env)
+        [200, {}, []]
+      end
+    end
+
+    class OmniAuthHack < ::OmniAuth::Strategies::Facebook
+      option :name, "facebook"
+      protected
+      def request
+        @env = Rack::MockRequest.env_for("", {"rack.session" => {}})
+        super
+      end
+    end
+  end
+end

data/lib/facebook_dialog/omni_auth_helper.rb

@@ -0,0 +1,11 @@
+module FacebookDialog
+  module OmniAuthHelper
+    #this is a convenience method we add to decouple dialogs from controller/request context
+    def fb_callback_url
+      uri = URI.parse(request.url.gsub(/\?.*$/,''))
+      uri.path = "/auth/facebook/callback"
+      uri.query = nil
+      uri.to_s
+    end
+  end
+end

data/lib/facebook_dialog/railtie.rb

@@ -4,6 +4,10 @@ module FacebookDialog
   class Railtie < Rails::Railtie
     ActiveSupport.on_load(:action_controller) do
       helper FacebookDialog::ScriptHelper
+      if FacebookDialog.omniauth_enabled?
+        require "facebook_dialog/omni_auth_helper"
+        helper FacebookDialog::OmniAuthHelper
+      end
     end
   end
 end

data/lib/facebook_dialog/script_helper.rb

@@ -1,16 +1,17 @@
 module FacebookDialog
   module ScriptHelper
-    def facebook_js
+    def fb_js
       content_tag(:div, "", id: "fb-root") +
       javascript_include_tag('http://connect.facebook.net/en_US/all.js')
     end
 
-    def fb_init_js
-      "FB.init({
-        appId: '#{FacebookDialog.api_key}',
+    def fb_init_js(options = {})
+      default_options = {
+        appId: FacebookDialog.api_key,
         status: true,
         cookies: true
-      });".html_safe
+      }
+      "FB.init(#{options.merge(default_options).to_json.html_safe});".html_safe
     end
   end
 end

data/lib/facebook_dialog/version.rb

@@ -1,4 +1,4 @@
 module FacebookDialog
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end
 

data/lib/facebook_dialog.rb

@@ -32,10 +32,15 @@ module FacebookDialog
     ]
   end 
 
+  def self.omniauth_enabled?
+    defined?(::OmniAuth) && defined?(::OmniAuth::Strategies::Facebook)
+  end
+
 
   class ResourceNameNotDefined < Exception; end;
   class InvalidDisplay < Exception; end;
 end
 
+require "facebook_dialog/omni_auth" if FacebookDialog.omniauth_enabled?
 require "facebook_dialog/railtie" if defined?(Rails)
 

data/spec/facebook_dialog/omni_auth_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe FacebookDialog::OmniAuth do
+  before do
+    FacebookDialog.api_key = "blah"
+  end
+
+  subject { FacebookDialog::OmniAuth.dialog }
+
+  its(:url) { should include "client_id=#{Rack::Utils.escape(FacebookDialog.api_key)}" }
+  its(:url) { should match(/redirect_uri=[^\&]/) }
+end
+

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require 'rspec'
+require 'omniauth-facebook'
 require 'facebook_dialog'
 require 'mocha'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: facebook_dialog
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-20 00:00:00.000000000Z
+date: 2011-12-29 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &2156417100 !ruby/object:Gem::Requirement
+  requirement: &2151909900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156417100
+  version_requirements: *2151909900
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &2156416260 !ruby/object:Gem::Requirement
+  requirement: &2151908580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156416260
+  version_requirements: *2151908580
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2156415640 !ruby/object:Gem::Requirement
+  requirement: &2151907580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156415640
+  version_requirements: *2151907580
 - !ruby/object:Gem::Dependency
   name: configatron
-  requirement: &2156414700 !ruby/object:Gem::Requirement
+  requirement: &2151905200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156414700
+  version_requirements: *2151905200
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2156414160 !ruby/object:Gem::Requirement
+  requirement: &2151903900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156414160
+  version_requirements: *2151903900
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156413280 !ruby/object:Gem::Requirement
+  requirement: &2151902860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156413280
+  version_requirements: *2151902860
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &2156412560 !ruby/object:Gem::Requirement
+  requirement: &2151901720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156412560
+  version_requirements: *2151901720
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2156411920 !ruby/object:Gem::Requirement
+  requirement: &2151897040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +98,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156411920
+  version_requirements: *2151897040
+- !ruby/object:Gem::Dependency
+  name: omniauth-facebook
+  requirement: &2151896280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2151896280
 description: A utility for building progressively enhanced Facebook dialogs
 email:
 - dpickett@enlightsolutions.com
@@ -119,6 +130,8 @@ files:
 - lib/facebook_dialog/dialog.rb
 - lib/facebook_dialog/feed.rb
 - lib/facebook_dialog/oauth.rb
+- lib/facebook_dialog/omni_auth.rb
+- lib/facebook_dialog/omni_auth_helper.rb
 - lib/facebook_dialog/option_serialization.rb
 - lib/facebook_dialog/railtie.rb
 - lib/facebook_dialog/script_helper.rb
@@ -128,6 +141,7 @@ files:
 - spec/facebook_dialog/dialog_spec.rb
 - spec/facebook_dialog/feed_spec.rb
 - spec/facebook_dialog/oauth_spec.rb
+- spec/facebook_dialog/omni_auth_spec.rb
 - spec/facebook_dialog/option_serialization_spec.rb
 - spec/facebook_dialog/validators/display_spec.rb
 - spec/spec_helper.rb
@@ -145,7 +159,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1035554407844364285
+      hash: -145623593344422603
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -154,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1035554407844364285
+      hash: -145623593344422603
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.6
@@ -165,6 +179,7 @@ test_files:
 - spec/facebook_dialog/dialog_spec.rb
 - spec/facebook_dialog/feed_spec.rb
 - spec/facebook_dialog/oauth_spec.rb
+- spec/facebook_dialog/omni_auth_spec.rb
 - spec/facebook_dialog/option_serialization_spec.rb
 - spec/facebook_dialog/validators/display_spec.rb
 - spec/spec_helper.rb