facebook_dialog 0.0.3 → 0.0.4

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm: 
+  - 1.9.2
+  - 1.9.3
+

data/Gemfile

@@ -2,3 +2,12 @@ source 'http://rubygems.org'
 
 # Specify your gem's dependencies in facebook_dialog.gemspec
 gemspec
+
+platforms :ruby do
+  gem 'rb-readline'
+end
+
+group :development do
+  gem 'growl'
+end
+

data/Guardfile

@@ -0,0 +1,6 @@
+guard 'rspec', cli: "--colour" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/Rakefile

@@ -8,6 +8,8 @@ begin
   RSpec::Core::RakeTask.new do |t|
   end
 
+  task default: :spec
+
 rescue LoadError
   puts "RSpec is not installed"
 end

data/Readme.md

@@ -2,24 +2,32 @@
 
 A utility that makes it easy to integrate progressively enhanced facebook dialogs
 
-```@ruby
+[![Build Status](https://secure.travis-ci.org/EnlightSolutions/facebook_dialog.png)](http://travis-ci.org/enlightsolutions/facebook_dialog)
+
+This is available for Rails >= 3.0 and Ruby >= 1.9.2
+
+```ruby
   FacebookDialog.api_key = "<your app_id/api key>"
   
   #in a Rails View
-  <%= link_to "Share on Facebook" FacebookDialog::Feed.new({
+
+  <%- facebook_dialog = FacebookDialog::Feed.new({
       redirect_uri: "http://www.example.com",
       link: "http://www.example.com",
       name: "Want to know?",
       caption: "Something pretty awesome",
       description: "Zomg! You won't believe what I found on the web."
-    }), 
-    id: "share_on_facebook" %>
+  }) -%>
+
+  <%= link_to "Share on Facebook", facebook_dialog.url, id: "share_on_facebook" %>
+
+  #at the bottom of your page
 
   <%= facebook_js %>
   <%= javascript_tag do %>
     <%= fb_init_js %>
     $("#share_on_facebook").click(function(e){
-      FB.ui(<%==  Facebook::TopicShareUrl.new(resource).to_json %>); 
+      FB.ui(<%==  facebook_dialog.to_json %>); 
     });
   <%- end -%>
 ```

data/facebook_dialog.gemspec

@@ -17,9 +17,12 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency "rack"
   gem.add_dependency "activemodel"
+  gem.add_dependency "activesupport"
   gem.add_dependency "configatron"
   gem.add_dependency "rake"
 
   gem.add_development_dependency "rspec"
+  gem.add_development_dependency "guard-rspec"
+  gem.add_development_dependency "mocha"
 end
 

data/lib/facebook_dialog/dialog.rb

@@ -0,0 +1,54 @@
+module FacebookDialog
+  class Dialog
+    include ActiveModel::Serializers::JSON
+    self.include_root_in_json = false
+
+    class_attribute :defaults
+    class_attribute :resource_name
+    self.resource_name = nil
+    self.defaults = {}
+
+    def initialize(options = {})
+      @options = options
+      @options[:app_id] = FacebookDialog.api_key
+    end 
+
+    def self.base_uri
+      raise ResourceNameNotDefined if resource_name.nil?
+      "http://www.facebook.com/dialog/#{resource_name}/"
+    end
+
+    def url
+      "#{self.class.base_uri}?#{Rack::Utils.build_query(query)}"
+    end
+
+    def query
+      to_h.merge({ 
+        redirect_uri: @options[:redirect_uri] || @options[:link],
+        display: @options[:display] || "popup"
+      })
+    end
+
+    def serializable_hash(options = {})
+      to_h.merge({method: self.class.resource_name})
+    end
+
+    HTML_ONLY_KEYS = [:redirect_uri, :display]
+    def to_h
+      validate_options!
+      options = @options.merge(self.class.defaults)
+      options = options.reject{|key, value| HTML_ONLY_KEYS.include?(key) }
+      serialize_options(options)
+    end
+
+    protected
+    def validate_options!
+      FacebookDialog::Validators::Display.new(@options).validate
+    end
+
+    def serialize_options(options)
+      FacebookDialog::OptionSerialization.new(options).serialized_hash
+    end
+  end
+end
+

data/lib/facebook_dialog/feed.rb

@@ -1,10 +1,8 @@
 module FacebookDialog
-  class Feed
-    FACEBOOK_BASE_URL = "http://www.facebook.com/dialog/feed"
-    include ActiveModel::Serializers::JSON
-    self.include_root_in_json = false
+  class Feed < Dialog
+    self.resource_name = :feed
 
-    DEFAULTS = {
+    self.defaults = {
       display: "popup"
     }
 
@@ -22,31 +20,7 @@ module FacebookDialog
     #description	
     #properties	
     #actions	
-    #ref	
-    def initialize(options = {})
-      @options = options
-      @options[:app_id] = FacebookDialog.api_key
-    end
-
-    def url
-      "#{FACEBOOK_BASE_URL}?#{Rack::Utils.build_query(query)}"
-    end
-
-    def query
-      to_h.merge({ 
-        redirect_uri: @options[:redirect_uri] || @options[:link],
-        display: @options[:display] || "popup"
-      })
-    end
-
-    def serializable_hash(options = {})
-      to_h.merge({method: :feed})
-    end
-
-    HTML_ONLY_KEYS = [:redirect_uri, :display]
-    def to_h
-      @options.reject{|key, value| HTML_ONLY_KEYS.include?(key) }
-    end
+    #ref	 
   end
 end
 

data/lib/facebook_dialog/oauth.rb

@@ -0,0 +1,11 @@
+module FacebookDialog
+  class Oauth < Dialog
+    self.resource_name = :oauth
+
+    def initialize(options= {})
+      super
+      @options[:client_id] = @options.delete(:app_id)
+    end   
+  end
+end
+

data/lib/facebook_dialog/option_serialization.rb

@@ -0,0 +1,26 @@
+module FacebookDialog
+  class OptionSerialization
+    def initialize(options)
+      @options = options
+    end
+
+    def serialized_hash
+      @serialized_options = @options.dup
+      options_to_serialize.each do |option_key|
+        if @serialized_options[option_key] && @serialized_options[option_key].kind_of?(Array)
+          @serialized_options[option_key] = @serialized_options[option_key].map{|i| i.to_s}.join(",")
+        end
+      end
+
+      @serialized_options
+    end
+    protected
+    def options_to_serialize
+      [
+        :response_type,
+        :scope
+      ]
+    end
+  end
+end
+

data/lib/facebook_dialog/validators/display.rb

@@ -0,0 +1,37 @@
+module FacebookDialog
+  module Validators
+    class Display
+      def initialize(options = {})
+        @options = options
+        @value = options[:display]
+      end
+
+      def validate
+        validate_against_whitelist
+        validate_access_key
+      end
+
+      protected
+      def validate_against_whitelist
+        unless @value.nil? || whitelist.include?(@value.to_s)
+          raise error_to_raise, "#{@value} is not a valid display type"
+        end
+      end
+
+      def validate_access_key
+        if @value && @value == "wap" && @options[:access_key].nil?
+          raise error_to_raise, "You must specify an access key for wap displays"
+        end
+      end
+
+      def whitelist
+        FacebookDialog.display_modes
+      end
+
+      def error_to_raise
+        FacebookDialog::InvalidDisplay
+      end
+    end
+  end
+end
+

data/lib/facebook_dialog/validators.rb

@@ -0,0 +1,7 @@
+require "facebook_dialog/validators/display"
+
+module FacebookDialog
+  module Validators
+  end
+end
+

data/lib/facebook_dialog/version.rb

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

data/lib/facebook_dialog.rb

@@ -1,8 +1,14 @@
 require "rack/utils"
 require "active_model"
+require "active_support/core_ext/class"
 require "configatron"
 
 require "facebook_dialog/version"
+require "facebook_dialog/dialog"
+require "facebook_dialog/validators"
+require "facebook_dialog/option_serialization"
+
+require "facebook_dialog/oauth"
 require "facebook_dialog/feed"
 
 module FacebookDialog
@@ -13,6 +19,23 @@ module FacebookDialog
   def self.api_key=(api_key)
     configatron.facebook_dialog.api_key = api_key
   end
+
+  #set of available display modes from facebook
+  #if you specify wap, you must supply an access_token
+  def self.display_modes
+    [
+      "page", 
+      "popup", 
+      "iframe", 
+      "touch", 
+      "wap"
+    ]
+  end 
+
+
+  class ResourceNameNotDefined < Exception; end;
+  class InvalidDisplay < Exception; end;
 end
 
 require "facebook_dialog/railtie" if defined?(Rails)
+

data/spec/facebook_dialog/dialog_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe FacebookDialog::Dialog do
+  class DummyDialog < FacebookDialog::Dialog; end
+
+  it "includes the api key as an app id argument" do
+    FacebookDialog.api_key = "something"
+    FacebookDialog::Feed.new.url.should include("app_id=#{Rack::Utils.escape(FacebookDialog.api_key)}")
+  end
+  
+  it "raises an error when a resource name is not defined when getting base uri" do
+    lambda { DummyDialog.base_uri }.should raise_error(
+      FacebookDialog::ResourceNameNotDefined
+    )
+  end
+
+  it "validates the display" do
+    mock_validator = mock(:validate => nil)
+    FacebookDialog::Validators::Display.expects(:new).returns(mock_validator)
+
+    DummyDialog.new.to_h
+  end
+end

data/spec/facebook_dialog/feed_spec.rb

@@ -22,7 +22,7 @@ describe FacebookDialog::Feed do
   end
 
   its(:url) { should include(Rack::Utils.escape(redirect_uri)) }
-  its(:url) { should include(Rack::Utils.escape(title)) }
+  its(:url) { should include(Rack::Utils.escape(name)) }
   its(:url) { should include(Rack::Utils.escape(description)) }
   its(:url) { should include(Rack::Utils.escape(caption)) }
 

data/spec/facebook_dialog/oauth_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe FacebookDialog::Oauth do
+  let(:redirect_uri) { "http://www.example.com" }
+  let(:scope) { ["email", "offline_access"] }
+  let(:state) { "something_passed_through" }
+  let(:response_type) { "code" }
+  let(:display) { "popup" }
+
+  let(:options) do
+    {
+      redirect_uri: redirect_uri,
+      scope: scope,
+      state: state,
+      response_type: response_type,
+      display: display
+    }
+  end
+
+  subject { FacebookDialog::Oauth.new(options) }
+
+  its(:url) { should include("redirect_uri=#{Rack::Utils.escape(redirect_uri)}")}
+end
+

data/spec/facebook_dialog/option_serialization_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe FacebookDialog::OptionSerialization do
+  subject do
+    FacebookDialog::OptionSerialization.new({
+      response_type: [:code, :token],
+      scope: [:offline_access, :email]
+    })
+  end
+  it "breaks an array of response types into a comma delimited list" do
+    subject.serialized_hash[:response_type].should eql("code,token")
+  end
+
+  it "breaks an array of scopes into a comma delimited list" do
+    subject.serialized_hash[:scope].should eql("offline_access,email")
+  end
+end

data/spec/facebook_dialog/validators/display_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe FacebookDialog::Validators::Display do
+  subject { FacebookDialog::Validators::Display }
+  it "does not raise an error when I specify a valid display" do
+    lambda { subject.new({display: "popup"}).validate }.should_not raise_error
+  end
+
+  it "raises an error when an invalid display is specified" do
+    lambda { subject.new({display: "bogus"}).validate }.should raise_error FacebookDialog::InvalidDisplay
+  end
+  
+  it "raises an error when wap is specified without an access key" do
+    lambda { subject.new({display: "wap"}).validate }.should raise_error FacebookDialog::InvalidDisplay
+  end
+
+  it "does not raise an error when wap is specified along with an access key" do
+    lambda { subject.new({display: "wap", access_key: "blah"}).validate }.should_not raise_error
+  end
+end
+

data/spec/spec_helper.rb

@@ -1,3 +1,8 @@
 require 'rspec'
 require 'facebook_dialog'
+require 'mocha'
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: facebook_dialog
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-16 00:00:00.000000000Z
+date: 2011-12-20 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &2156166720 !ruby/object:Gem::Requirement
+  requirement: &2156417100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156166720
+  version_requirements: *2156417100
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &2156166140 !ruby/object:Gem::Requirement
+  requirement: &2156416260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156166140
+  version_requirements: *2156416260
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2156415640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156415640
 - !ruby/object:Gem::Dependency
   name: configatron
-  requirement: &2156165640 !ruby/object:Gem::Requirement
+  requirement: &2156414700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156165640
+  version_requirements: *2156414700
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2156165100 !ruby/object:Gem::Requirement
+  requirement: &2156414160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +65,32 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156165100
+  version_requirements: *2156414160
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156164600 !ruby/object:Gem::Requirement
+  requirement: &2156413280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156413280
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &2156412560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156412560
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &2156411920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +98,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156164600
+  version_requirements: *2156411920
 description: A utility for building progressively enhanced Facebook dialogs
 email:
 - dpickett@enlightsolutions.com
@@ -76,16 +109,27 @@ files:
 - .gitignore
 - .rspec
 - .rvmrc
+- .travis.yml
 - Gemfile
+- Guardfile
 - Rakefile
 - Readme.md
 - facebook_dialog.gemspec
 - lib/facebook_dialog.rb
+- lib/facebook_dialog/dialog.rb
 - lib/facebook_dialog/feed.rb
+- lib/facebook_dialog/oauth.rb
+- lib/facebook_dialog/option_serialization.rb
 - lib/facebook_dialog/railtie.rb
 - lib/facebook_dialog/script_helper.rb
+- lib/facebook_dialog/validators.rb
+- lib/facebook_dialog/validators/display.rb
 - lib/facebook_dialog/version.rb
+- spec/facebook_dialog/dialog_spec.rb
 - spec/facebook_dialog/feed_spec.rb
+- spec/facebook_dialog/oauth_spec.rb
+- spec/facebook_dialog/option_serialization_spec.rb
+- spec/facebook_dialog/validators/display_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses: []
@@ -101,7 +145,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4243053102014288206
+      hash: -1035554407844364285
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -110,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4243053102014288206
+      hash: -1035554407844364285
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.6
@@ -118,5 +162,9 @@ signing_key:
 specification_version: 3
 summary: Use ActiveModel serialization to keep html and javascript FB dialogs DRY
 test_files:
+- spec/facebook_dialog/dialog_spec.rb
 - spec/facebook_dialog/feed_spec.rb
+- spec/facebook_dialog/oauth_spec.rb
+- spec/facebook_dialog/option_serialization_spec.rb
+- spec/facebook_dialog/validators/display_spec.rb
 - spec/spec_helper.rb