facebook_registration 1.0.3 → 1.0.4

data/CHANGELOG.rdoc

@@ -12,4 +12,9 @@
 
 === 1.0.3 / 2011-09-07
 
-* Missing MIT-LICENSE added.
+* Missing MIT-LICENSE added.
+
+=== 1.0.4 / 2011-12-27
+
+* Enabling to work with Rails3.
+* Adding Test Cases.

data/README.rdoc

@@ -13,14 +13,12 @@ facebook_registration is a ruby library for displaying new Facebook Registration
 
 
 === Using Gem in Rails
-Once you installed the gem, you will need to configure your Facebook app in config/facebooker.yml.
-
-You can copy facebooker.yml file which one is already available in this Root directory.
+In previous versions, we must specify our FB app keys in a YAML file. But in this version we can directly specify the APP-ID, Secret key etc within the app whenever needed like below:
 
 
 === Initializing Registration Form
 
-  <%= init_fb_registration %>
+  <%= init_fb_registration('YOUR-FACEBOOK-APP-ID') %>
 
 
 === Displaying Facebook Registration Form
@@ -50,7 +48,7 @@ For more form field specifications refer these urls:
   
   So in our case, you can parse the Facebook profile informations in the action fb_registration as follows:
   
-  FacebookRegistration::SignedRequest.parse(params["signed_request"])
+  FacebookRegistration::SignedRequest.parse(params["signed_request"], 'YOUR-FACEBOOK-SECRET-KEY')
   
   it will return the output as follows:
   

data/facebook_registration.gemspec

@@ -2,22 +2,22 @@
 
 Gem::Specification.new do |s|
   s.name = %q{facebook_registration}
-  s.version = "1.0.3"
+  s.version = "1.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Veerasundaravel Thirugnanasundaram"]
-  s.date = %q{2011-09-07}
+  s.date = %q{2011-12-27}
   s.description = %q{facebook_registration is a ruby library for displaying new Facebook Registration form and to parse to signed_request[http://developers.facebook.com/docs/plugins/registration].}
   s.email = ["veerasundaravel@gmail.com"]
   s.extra_rdoc_files = ["CHANGELOG.rdoc", "README.rdoc", ]
-  s.files = ["CHANGELOG.rdoc", "README.rdoc", "MIT-LICENSE", "facebook_registration.gemspec", "facebooker.yml", "lib/facebook_registration.rb", "lib/helpers/helpers.rb", "lib/rails/signed_request.rb"]
+  s.files = ["CHANGELOG.rdoc", "README.rdoc", "MIT-LICENSE", "facebook_registration.gemspec", "lib/facebook_registration.rb", "lib/helpers/helpers.rb", "lib/rails/signed_request.rb", "test/test_fb_registration.rb", "test/test_fb_registration_helper.rb"]
   s.homepage = %q{http://veerasundaravel.wordpress.com/2011/01/27/facebook-registration-plugin-in-rails/}
   s.rdoc_options = ["--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{facebook_registration}
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{facebook_registration is a ruby library for displaying new Facebook Registration form and to parse to signed_request[http://developers.facebook.com/docs/plugins/registration]. by Veerasundaravel Thirugnanasundaram}
-  s.test_files = []
+  s.test_files = ["test/test_fb_registration.rb", "test/test_fb_registration_helper.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/lib/facebook_registration.rb

@@ -1,32 +1,2 @@
-module FacebookRegistration
-@facebook_configuration = {}
-  @raw_facebook_configuration = {}
-  @current_adapter = nil
-  @set_asset_host_to_callback_url = true
-  @path_prefix = nil
-  @use_curl    = false
-
-  class << self
-
-    def load_configuration(facebook_yaml_file)
-      return false unless File.exist?(facebook_yaml_file)
-      @raw_facebook_configuration = YAML.load(ERB.new(File.read(facebook_yaml_file)).result)
-      if defined? RAILS_ENV
-        @raw_facebook_configuration = @raw_facebook_configuration[RAILS_ENV]
-      end
-      @raw_facebook_configuration
-    end
-
-    def facebook_config
-      @facebook_configuration
-    end
-  end
-end
-
-facebook_config = "#{RAILS_ROOT}/config/facebooker.yml"
-FACEBOOK_CONFIG = FacebookRegistration.load_configuration(facebook_config)
-
-if defined? Rails
-  require 'helpers/helpers'
-  require 'rails/signed_request'
-end
+require 'helpers/helpers'
+require 'rails/signed_request'

data/lib/helpers/helpers.rb

@@ -1,4 +1,4 @@
-module FacebookRegistration
+module FacebookRegistrationHelper
   def self.included(base)
     base.send :include, InstanceMethods
   end
@@ -7,9 +7,9 @@ module FacebookRegistration
   module InstanceMethods
   DefaultValues = {"fields" =>"name,email,password", "redirect-uri"=>"http://localhost:3000/fb_registration", "fb_only" => false, "width" => "100%", "height" => nil, "onvalidate" =>nil}
   
-  def init_fb_registration
-    raise "Must set Application ID for initializing" unless defined?(FACEBOOK_CONFIG) && FACEBOOK_CONFIG["app_id"]
-    "<div id=\"fb-root\"></div> \n <script src=\"http://connect.facebook.net/en_US/all.js#appId=#{FACEBOOK_CONFIG["app_id"]}&xfbml=1\"></script> \n <script src=\"http://code.jquery.com/jquery-1.4.4.min.js\"></script>"
+  def init_fb_registration(app_id=nil)
+    raise "Must set Application ID for initializing" unless app_id
+    "<div id=\"fb-root\"></div> \n <script src=\"http://connect.facebook.net/en_US/all.js#appId=#{app_id}&xfbml=1\"></script> \n <script src=\"http://code.jquery.com/jquery-1.4.4.min.js\"></script>"
   end
   
   def fb_registration_form(options={})
@@ -26,5 +26,5 @@ end
 
 end
 
-ActionView::Base.send(:include, FacebookRegistration) if defined?(ActionView::Base)
+ActionView::Base.send(:include, FacebookRegistrationHelper) if defined?(ActionView::Base)
 

data/lib/rails/signed_request.rb

@@ -4,40 +4,37 @@ require 'base64'
 require 'yajl'
 
 module FacebookRegistration
-class SignedRequest
-      def self.parse(params)
-        if params.is_a?(Hash)
-	  signed_request = params.delete('signed_request')
-        else
-	  signed_request  = params
-	end
-	
-        unless signed_request
-          raise "Missing signed_request param"
-        end
-
-        signature, signed_params = signed_request.split('.')
-
-        unless signed_request_is_valid?(FACEBOOK_CONFIG['secret_key'], signature, signed_params)
-          raise "Invalid signature"
-        end
-
-        signed_params = Yajl::Parser.new.parse(base64_url_decode(signed_params))
-
-	return signed_params
+  class SignedRequest
+    def self.parse(params, secret_key=nil)
+      if params.is_a?(Hash)
+        signed_request = (params.delete('signed_request') || params.delete(:signed_request))
+      else
+        signed_request  = params
       end
+      unless signed_request
+        raise "Missing signed_request param"
+      end
+			unless secret_key
+				raise "Missing Facebook secret key"
+			end
+      signature, signed_params = signed_request.split('.')
+      unless signed_request_is_valid?(secret_key, signature, signed_params)
+        raise "Invalid signature"
+      end
+      signed_params = Yajl::Parser.new.parse(base64_url_decode(signed_params))
+      return signed_params
+    end
 
-      private
-
-        def self.signed_request_is_valid?(secret, signature, params)
-          signature = base64_url_decode(signature)
-          expected_signature = OpenSSL::HMAC.digest('SHA256', secret, params.tr("-_", "+/"))
-          return signature == expected_signature
-        end
+    private
+    def self.signed_request_is_valid?(secret_key, signature, params)
+      signature = base64_url_decode(signature)
+      expected_signature = OpenSSL::HMAC.digest('SHA256', secret_key, params.to_s.tr("-_", "+/"))
+      return signature == expected_signature
+    end
 
-        def self.base64_url_decode(str)
-          str = str + "=" * (6 - str.size % 6) unless str.size % 6 == 0
-          return Base64.decode64(str.tr("-_", "+/"))
-        end
+    def self.base64_url_decode(str)
+      str = str + "=" * (6 - str.size % 6) unless str.size % 6 == 0
+      return Base64.decode64(str.tr("-_", "+/"))
     end
-end
+  end
+end

data/test/test_fb_registration.rb

@@ -0,0 +1,37 @@
+require 'test/unit'
+require 'facebook_registration'
+
+class FacebookRegistrationSignedRequestTest < Test::Unit::TestCase
+  def test_signed_request_is_initialized
+		assert FacebookRegistration::SignedRequest
+  end
+	
+	def test_parse_should_raise_error_for_missing_secret_key
+		begin
+      FacebookRegistration::SignedRequest.parse({:signed_request => "vlXgu64BQGFSQrY0ZcJBZASMvYvTHu9GQ0YM9rjPSso.eyJhbGdvcml0aG0iOiJITUFDLVNIQTI1NiIsIjAiOiJwYXlsb2FkIn0"})
+    rescue Exception => e
+    assert_equal "Missing Facebook secret key", e.message
+    end
+	end
+	
+	def test_parse_should_raise_error_for_missing_signed_request
+		#Testing for missing value
+		begin
+      FacebookRegistration::SignedRequest.parse({:invalid_key => "some-dummy-data"}, 'valid-secret-key')
+    rescue Exception => e
+			assert_equal "Missing signed_request param", e.message
+		end
+		
+		#Testing for invalid key
+		begin
+      FacebookRegistration::SignedRequest.parse({:signed_request => "some-dummy-data"}, 'valid-secret-key')
+    rescue Exception => e
+			assert_equal "Invalid signature", e.message
+    end
+	end
+	
+	# TODO - Missing Success TestCases
+	# We need some valid signed_request parameter from facebook to test the remaining functionalities.
+	# So here we test only failure test cases.
+	
+end

data/test/test_fb_registration_helper.rb

@@ -0,0 +1,51 @@
+require 'test/unit'
+require 'facebook_registration'
+include FacebookRegistrationHelper
+
+class FacebookRegistrationTest < Test::Unit::TestCase
+  def test_default_values_is_defined
+    assert defined? DefaultValues
+  end
+  
+  def test_default_values_assignment
+    assert_equal "name,email,password",  DefaultValues["fields"]
+    assert_equal "http://localhost:3000/fb_registration",  DefaultValues["redirect-uri"]
+    assert_equal false,  DefaultValues["fb_only"]
+  end
+  
+  def test_init_fb_registration_should_raise_error
+    begin
+      init_fb_registration
+    rescue Exception => e
+    assert_equal "Must set Application ID for initializing", e.message
+    end
+  end
+  
+  def test_init_fb_registration_should_not_through_error_for_valid_input
+    assert init_fb_registration('some-api-key')
+  end
+  
+  def test_init_fb_registration_should_return_fb_scripts
+    fb_scripts = init_fb_registration('some-api-key')
+    assert_match /<div id="fb-root"><\/div>/, fb_scripts
+    assert_match /http:\/\/connect.facebook.net\/en_US\/all.js#appId=some-api-key/, fb_scripts
+  end
+  
+  def test_fb_registration_form_should_return_fb_registration_tags
+    form_text = fb_registration_form
+    assert_match /<fb:registration/, form_text
+    assert_match /<\/fb:registration>/, form_text
+  end
+  
+  def test_fb_registration_form_should_use_default_values
+    form_text = fb_registration_form
+    assert_match /fields = "#{DefaultValues["fields"]}"/, form_text
+    assert_match /fb_only = "#{DefaultValues["fb_only"]}"/, form_text
+  end
+  
+  def test_fb_registration_form_should_use_passed_values_instead_of_default_values
+    form_text = fb_registration_form("redirect-uri" => "http://test.localhost.com/fb_signup", "fb_only" => true)
+    assert_match /fb_only = "true"/, form_text
+    assert_match /redirect-uri = "http:\/\/test.localhost.com\/fb_signup"/, form_text
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: facebook_registration
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 31
   prerelease: 
   segments: 
   - 1
   - 0
-  - 3
-  version: 1.0.3
+  - 4
+  version: 1.0.4
 platform: ruby
 authors: 
 - Veerasundaravel Thirugnanasundaram
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-07 00:00:00 +05:30
+date: 2011-12-27 00:00:00 +05:30
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -49,10 +49,11 @@ files:
 - README.rdoc
 - MIT-LICENSE
 - facebook_registration.gemspec
-- facebooker.yml
 - lib/facebook_registration.rb
 - lib/helpers/helpers.rb
 - lib/rails/signed_request.rb
+- test/test_fb_registration.rb
+- test/test_fb_registration_helper.rb
 has_rdoc: true
 homepage: http://veerasundaravel.wordpress.com/2011/01/27/facebook-registration-plugin-in-rails/
 licenses: []
@@ -88,5 +89,6 @@ rubygems_version: 1.4.2
 signing_key: 
 specification_version: 1
 summary: facebook_registration is a ruby library for displaying new Facebook Registration form and to parse to signed_request[http://developers.facebook.com/docs/plugins/registration]. by Veerasundaravel Thirugnanasundaram
-test_files: []
-
+test_files: 
+- test/test_fb_registration.rb
+- test/test_fb_registration_helper.rb

data/facebooker.yml

@@ -1,14 +0,0 @@
-development:
-  app_id: xxxxxxxxxxxxxxx
-  api_key: xxxxxxxxxxxxxxx 
-  secret_key: xxxxxxxxxxxxxxx
-  
-production:
-  app_id: xxxxxxxxxxxxxxx
-  api_key: xxxxxxxxxxxxxxx
-  secret_key: xxxxxxxxxxxxxxx
-      
-test:
-  app_id: xxxxxxxxxxxxxxx
-  api_key: xxxxxxxxxxxxxxx
-  secret_key: xxxxxxxxxxxxxxx